Documentation

ComplexFunctions
in package

Application

Uses ArrayEnabled

Properties

$arrayArgumentHelper : ArrayArgumentHelper|null

Methods

IMABS() : array<string|int, mixed>|float|string: IMABS.
IMARGUMENT() : array<string|int, mixed>|float|string: IMARGUMENT.
IMCONJUGATE() : array<string|int, mixed>|string: IMCONJUGATE.
IMCOS() : array<string|int, mixed>|string: IMCOS.
IMCOSH() : array<string|int, mixed>|string: IMCOSH.
IMCOT() : array<string|int, mixed>|string: IMCOT.
IMCSC() : array<string|int, mixed>|string: IMCSC.
IMCSCH() : array<string|int, mixed>|string: IMCSCH.
IMEXP() : array<string|int, mixed>|string: IMEXP.
IMLN() : array<string|int, mixed>|string: IMLN.
IMLOG10() : array<string|int, mixed>|string: IMLOG10.
IMLOG2() : array<string|int, mixed>|string: IMLOG2.
IMPOWER() : array<string|int, mixed>|string: IMPOWER.
IMSEC() : array<string|int, mixed>|string: IMSEC.
IMSECH() : array<string|int, mixed>|string: IMSECH.
IMSIN() : array<string|int, mixed>|string: IMSIN.
IMSINH() : array<string|int, mixed>|string: IMSINH.
IMSQRT() : array<string|int, mixed>|string: IMSQRT.
IMTAN() : array<string|int, mixed>|string: IMTAN.
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

$arrayArgumentHelper


    private
    static    ArrayArgumentHelper|null
    $arrayArgumentHelper
     = null

IMABS()

IMABS.


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

Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format.

Excel Function: IMABS(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the absolute value Or can be an array of values

Return values

array<string|int, mixed>|float|string —

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

IMARGUMENT()

IMARGUMENT.


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

Returns the argument theta of a complex number, i.e. the angle in radians from the real axis to the representation of the number in polar coordinates.

Excel Function: IMARGUMENT(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the argument theta Or can be an array of values

Return values

array<string|int, mixed>|float|string —

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

IMCONJUGATE()

IMCONJUGATE.


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

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

Excel Function: IMCONJUGATE(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the conjugate 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

IMCOS()

IMCOS.


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

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

Excel Function: IMCOS(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the cosine 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

IMCOSH()

IMCOSH.


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

Returns the hyperbolic cosine of a complex number in x + yi or x + yj text format.

Excel Function: IMCOSH(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the hyperbolic cosine 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

IMCOT()

IMCOT.


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

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

Excel Function: IMCOT(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the cotangent 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

IMCSC()

IMCSC.


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

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

Excel Function: IMCSC(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the cosecant 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

IMCSCH()

IMCSCH.


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

Returns the hyperbolic cosecant of a complex number in x + yi or x + yj text format.

Excel Function: IMCSCH(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the hyperbolic cosecant 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

IMEXP()

IMEXP.


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

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

Excel Function: IMEXP(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the exponential 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

IMLN()

IMLN.


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

Returns the natural logarithm of a complex number in x + yi or x + yj text format.

Excel Function: IMLN(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the natural logarithm 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

IMLOG10()

IMLOG10.


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

Returns the common logarithm (base 10) of a complex number in x + yi or x + yj text format.

Excel Function: IMLOG10(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the common logarithm 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

IMLOG2()

IMLOG2.


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

Returns the base-2 logarithm of a complex number in x + yi or x + yj text format.

Excel Function: IMLOG2(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the base-2 logarithm 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

IMPOWER()

IMPOWER.


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

Returns a complex number in x + yi or x + yj text format raised to a power.

Excel Function: IMPOWER(complexNumber,realNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number you want to raise to a power Or can be an array of values
$realNumber : array<string|int, mixed>|float|int|string: the power to which you want to raise the complex number 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

IMSEC()

IMSEC.


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

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

Excel Function: IMSEC(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the secant 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

IMSECH()

IMSECH.


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

Returns the hyperbolic secant of a complex number in x + yi or x + yj text format.

Excel Function: IMSECH(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the hyperbolic secant 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

IMSIN()

IMSIN.


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

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

Excel Function: IMSIN(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the sine 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

IMSINH()

IMSINH.


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

Returns the hyperbolic sine of a complex number in x + yi or x + yj text format.

Excel Function: IMSINH(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the hyperbolic sine 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

IMSQRT()

IMSQRT.


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

Returns the square root of a complex number in x + yi or x + yj text format.

Excel Function: IMSQRT(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the square root 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

IMTAN()

IMTAN.


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

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

Excel Function: IMTAN(complexNumber)

Parameters

$complexNumber : array<string|int, mixed>|string: the complex number for which you want the tangent 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

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

ComplexFunctions in package Application Uses ArrayEnabled

Table of Contents

Properties

Methods

Properties

$arrayArgumentHelper

Methods

IMABS()

Parameters

Return values

IMARGUMENT()

Parameters

Return values

IMCONJUGATE()

Parameters

Return values

IMCOS()

Parameters

Return values

IMCOSH()

Parameters

Return values

IMCOT()

Parameters

Return values

IMCSC()

Parameters

Return values

IMCSCH()

Parameters

Return values

IMEXP()

Parameters

Return values

IMLN()

Parameters

Return values

IMLOG10()

Parameters

Return values

IMLOG2()

Parameters

Return values

IMPOWER()

Parameters

Return values

IMSEC()

Parameters

Return values

IMSECH()

Parameters

Return values

IMSIN()

Parameters

Return values

IMSINH()

Parameters

Return values

IMSQRT()

Parameters

Return values

IMTAN()

Parameters

Return values

evaluateArrayArguments()

Parameters

Return values

evaluateArrayArgumentsIgnore()

Parameters

Return values

evaluateArrayArgumentsSubset()

Parameters

Return values

evaluateArrayArgumentsSubsetFrom()

Parameters

Return values

evaluateSingleArgumentArray()

Parameters

Return values

initialiseHelper()

ComplexFunctions
in package

Application

Uses ArrayEnabled