Documentation

Complex
in package
Uses ArrayEnabled

Table of Contents

Properties

$arrayArgumentHelper  : ArrayArgumentHelper|null

Methods

COMPLEX()  : array<string|int, mixed>|string
COMPLEX.
IMAGINARY()  : array<string|int, mixed>|float|string
IMAGINARY.
IMREAL()  : array<string|int, mixed>|float|string
IMREAL.
evaluateArrayArguments()  : array<string|int, mixed>
Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument.
evaluateArrayArgumentsIgnore()  : array<string|int, mixed>
Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument except for the one specified by ignore.
evaluateArrayArgumentsSubset()  : array<string|int, mixed>
Handles array argument processing when the function accepts multiple arguments, but only the first few (up to limit) can be an array arguments.
evaluateArrayArgumentsSubsetFrom()  : array<string|int, mixed>
Handles array argument processing when the function accepts multiple arguments, but only the last few (from start) can be an array arguments.
evaluateSingleArgumentArray()  : array<string|int, mixed>
Handles array argument processing when the function accepts a single argument that can be an array argument.
initialiseHelper()  : void
testFalse()  : bool

Properties

Methods

COMPLEX()

COMPLEX.

public static COMPLEX([mixed $realNumber = 0.0 ][, mixed $imaginary = 0.0 ][, mixed $suffix = 'i' ]) : array<string|int, mixed>|string

Converts real and imaginary coefficients into a complex number of the form x +/- yi or x +/- yj.

Excel Function: COMPLEX(realNumber,imaginary[,suffix])

Parameters
$realNumber : mixed = 0.0

the real float coefficient of the complex number Or can be an array of values

$imaginary : mixed = 0.0

the imaginary float coefficient of the complex number Or can be an array of values

$suffix : mixed = 'i'

The character suffix for the imaginary component of the complex number. If omitted, the suffix is assumed to be "i". Or can be an array of values

Return values
array<string|int, mixed>|string

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

IMAGINARY()

IMAGINARY.

public static IMAGINARY(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|string

Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.

Excel Function: IMAGINARY(complexNumber)

Parameters
$complexNumber : array<string|int, mixed>|string

the complex number for which you want the imaginary coefficient Or can be an array of values

Return values
array<string|int, mixed>|float|string

(string if an error) If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

IMREAL()

IMREAL.

public static IMREAL(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|string

Returns the real coefficient of a complex number in x + yi or x + yj text format.

Excel Function: IMREAL(complexNumber)

Parameters
$complexNumber : array<string|int, mixed>|string

the complex number for which you want the real coefficient Or can be an array of values

Return values
array<string|int, mixed>|float|string

(string if an error) If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

evaluateArrayArguments()

Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument.

protected static evaluateArrayArguments(callable $method, mixed ...$arguments) : array<string|int, mixed>

Example use for: ROUND() or DATE().

Parameters
$method : callable
$arguments : mixed
Return values
array<string|int, mixed>

evaluateArrayArgumentsIgnore()

Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument except for the one specified by ignore.

protected static evaluateArrayArgumentsIgnore(callable $method, int $ignore, mixed ...$arguments) : array<string|int, mixed>

Example use for: HLOOKUP() and VLOOKUP(), where argument 1 is a matrix that needs to be treated as a database rather than as an array argument.

Parameters
$method : callable
$ignore : int
$arguments : mixed
Return values
array<string|int, mixed>

evaluateArrayArgumentsSubset()

Handles array argument processing when the function accepts multiple arguments, but only the first few (up to limit) can be an array arguments.

protected static evaluateArrayArgumentsSubset(callable $method, int $limit, mixed ...$arguments) : array<string|int, mixed>

Example use for: NETWORKDAYS() or CONCATENATE(), where the last argument is a matrix (or a series of values) that need to be treated as a such rather than as an array arguments.

Parameters
$method : callable
$limit : int
$arguments : mixed
Return values
array<string|int, mixed>

evaluateArrayArgumentsSubsetFrom()

Handles array argument processing when the function accepts multiple arguments, but only the last few (from start) can be an array arguments.

protected static evaluateArrayArgumentsSubsetFrom(callable $method, int $start, mixed ...$arguments) : array<string|int, mixed>

Example use for: Z.TEST() or INDEX(), where the first argument 1 is a matrix that needs to be treated as a dataset rather than as an array argument.

Parameters
$method : callable
$start : int
$arguments : mixed
Return values
array<string|int, mixed>

evaluateSingleArgumentArray()

Handles array argument processing when the function accepts a single argument that can be an array argument.

protected static evaluateSingleArgumentArray(callable $method, array<string|int, mixed> $values) : array<string|int, mixed>

Example use for: DAYOFMONTH() or FACT().

Parameters
$method : callable
$values : array<string|int, mixed>
Return values
array<string|int, mixed>

initialiseHelper()

private static initialiseHelper(array<string|int, mixed>|false $arguments) : void
Parameters
$arguments : array<string|int, mixed>|false

Can be changed to array for Php8.1+

testFalse()

private static testFalse(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

        
On this page

Search results