Documentation

Engineering

Tags
deprecated
1.18.0

Table of Contents

EULER  = 2.718281828459045
EULER.
BESSELI()  : array<string|int, mixed>|float|string
BESSELI.
BESSELJ()  : array<string|int, mixed>|float|string
BESSELJ.
BESSELK()  : array<string|int, mixed>|float|string
BESSELK.
BESSELY()  : array<string|int, mixed>|float|string
BESSELY.
BINTODEC()  : array<string|int, mixed>|string
BINTODEC.
BINTOHEX()  : array<string|int, mixed>|string
BINTOHEX.
BINTOOCT()  : array<string|int, mixed>|string
BINTOOCT.
BITAND()  : array<string|int, mixed>|int|string
BITAND.
BITLSHIFT()  : array<string|int, mixed>|float|int|string
BITLSHIFT.
BITOR()  : array<string|int, mixed>|int|string
BITOR.
BITRSHIFT()  : array<string|int, mixed>|float|int|string
BITRSHIFT.
BITXOR()  : array<string|int, mixed>|int|string
BITXOR.
COMPLEX()  : array<string|int, mixed>|string
COMPLEX.
CONVERTUOM()  : array<string|int, mixed>|float|string
CONVERTUOM.
DECTOBIN()  : array<string|int, mixed>|string
DECTOBIN.
DECTOHEX()  : array<string|int, mixed>|string
DECTOHEX.
DECTOOCT()  : array<string|int, mixed>|string
DECTOOCT.
DELTA()  : array<string|int, mixed>|int|string
DELTA.
ERF()  : array<string|int, mixed>|float|string
ERF.
ERFC()  : array<string|int, mixed>|float|string
ERFC.
ERFPRECISE()  : array<string|int, mixed>|float|string
ERFPRECISE.
GESTEP()  : array<string|int, mixed>|int|string
GESTEP.
getBinaryConversionMultipliers()  : array<string|int, mixed>
getBinaryConversionMultipliers.
getConversionGroups()  : array<string|int, mixed>
getConversionGroups Returns a list of the different conversion groups for UOM conversions.
getConversionGroupUnitDetails()  : array<string|int, mixed>
getConversionGroupUnitDetails.
getConversionGroupUnits()  : array<string|int, mixed>
getConversionGroupUnits Returns an array of units of measure, for a specified conversion group, or for all groups.
getConversionMultipliers()  : array<string|int, mixed>
getConversionMultipliers Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM().
HEXTOBIN()  : array<string|int, mixed>|string
HEXTOBIN.
HEXTODEC()  : array<string|int, mixed>|string
HEXTODEC.
HEXTOOCT()  : array<string|int, mixed>|string
HEXTOOCT.
IMABS()  : array<string|int, mixed>|float|string
IMABS.
IMAGINARY()  : array<string|int, mixed>|float|string
IMAGINARY.
IMARGUMENT()  : array<string|int, mixed>|float|string
IMARGUMENT.
IMCONJUGATE()  : array<string|int, mixed>|string
IMCONJUGATE.
IMCOS()  : array<string|int, mixed>|float|string
IMCOS.
IMCOSH()  : array<string|int, mixed>|float|string
IMCOSH.
IMCOT()  : array<string|int, mixed>|float|string
IMCOT.
IMCSC()  : array<string|int, mixed>|float|string
IMCSC.
IMCSCH()  : array<string|int, mixed>|float|string
IMCSCH.
IMDIV()  : array<string|int, mixed>|string
IMDIV.
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.
IMPRODUCT()  : string
IMPRODUCT.
IMREAL()  : array<string|int, mixed>|float|string
IMREAL.
IMSEC()  : array<string|int, mixed>|float|string
IMSEC.
IMSECH()  : array<string|int, mixed>|float|string
IMSECH.
IMSIN()  : array<string|int, mixed>|float|string
IMSIN.
IMSINH()  : array<string|int, mixed>|float|string
IMSINH.
IMSQRT()  : array<string|int, mixed>|string
IMSQRT.
IMSUB()  : array<string|int, mixed>|string
IMSUB.
IMSUM()  : string
IMSUM.
IMTAN()  : array<string|int, mixed>|float|string
IMTAN.
OCTTOBIN()  : array<string|int, mixed>|string
OCTTOBIN.
OCTTODEC()  : array<string|int, mixed>|string
OCTTODEC.
OCTTOHEX()  : array<string|int, mixed>|string
OCTTOHEX.
parseComplex()  : array<string|int, mixed>
parseComplex.

Constants

EULER

EULER.

public mixed EULER = 2.718281828459045
Tags
deprecated
1.18.0
see
Use

Engineering\Constants\EULER instead

Methods

BESSELI()

BESSELI.

public static BESSELI(float $x, int $ord) : array<string|int, mixed>|float|string

Returns the modified Bessel function In(x), which is equivalent to the Bessel function evaluated for purely imaginary arguments

Excel Function: BESSELI(x,ord)

Parameters
$x : float

The value at which to evaluate the function. If x is nonnumeric, BESSELI returns the #VALUE! error value.

$ord : int

The order of the Bessel function. If ord is not an integer, it is truncated. If $ord is nonnumeric, BESSELI returns the #VALUE! error value. If $ord < 0, BESSELI returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the BESSELI() method in the Engineering\BesselI class instead

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

Result, or a string containing an error

BESSELJ()

BESSELJ.

public static BESSELJ(float $x, int $ord) : array<string|int, mixed>|float|string

Returns the Bessel function

Excel Function: BESSELJ(x,ord)

Parameters
$x : float

The value at which to evaluate the function. If x is nonnumeric, BESSELJ returns the #VALUE! error value.

$ord : int

The order of the Bessel function. If n is not an integer, it is truncated. If $ord is nonnumeric, BESSELJ returns the #VALUE! error value. If $ord < 0, BESSELJ returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the BESSELJ() method in the Engineering\BesselJ class instead

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

Result, or a string containing an error

BESSELK()

BESSELK.

public static BESSELK(float $x, int $ord) : array<string|int, mixed>|float|string

Returns the modified Bessel function Kn(x), which is equivalent to the Bessel functions evaluated for purely imaginary arguments.

Excel Function: BESSELK(x,ord)

Parameters
$x : float

The value at which to evaluate the function. If x is nonnumeric, BESSELK returns the #VALUE! error value.

$ord : int

The order of the Bessel function. If n is not an integer, it is truncated. If $ord is nonnumeric, BESSELK returns the #VALUE! error value. If $ord < 0, BESSELK returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the BESSELK() method in the Engineering\BesselK class instead

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

Result, or a string containing an error

BESSELY()

BESSELY.

public static BESSELY(float $x, int $ord) : array<string|int, mixed>|float|string

Returns the Bessel function, which is also called the Weber function or the Neumann function.

Excel Function: BESSELY(x,ord)

Parameters
$x : float

The value at which to evaluate the function. If x is nonnumeric, BESSELY returns the #VALUE! error value.

$ord : int

The order of the Bessel function. If n is not an integer, it is truncated. If $ord is nonnumeric, BESSELY returns the #VALUE! error value. If $ord < 0, BESSELY returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the BESSELY() method in the Engineering\BesselY class instead

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

Result, or a string containing an error

BINTODEC()

BINTODEC.

public static BINTODEC(mixed $x) : array<string|int, mixed>|string

Return a binary value as decimal.

Excel Function: BIN2DEC(x)

Parameters
$x : mixed

The binary number (as a string) that you want to convert. The number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is not a valid binary number, or if number contains more than 10 characters (10 bits), BIN2DEC returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toDecimal() method in the Engineering\ConvertBinary class instead

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

BINTOHEX()

BINTOHEX.

public static BINTOHEX(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return a binary value as hex.

Excel Function: BIN2HEX(x[,places])

Parameters
$x : mixed

The binary number (as a string) that you want to convert. The number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is not a valid binary number, or if number contains more than 10 characters (10 bits), BIN2HEX returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, BIN2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, BIN2HEX returns the #VALUE! error value. If places is negative, BIN2HEX returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toHex() method in the Engineering\ConvertBinary class instead

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

BINTOOCT()

BINTOOCT.

public static BINTOOCT(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return a binary value as octal.

Excel Function: BIN2OCT(x[,places])

Parameters
$x : mixed

The binary number (as a string) that you want to convert. The number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is not a valid binary number, or if number contains more than 10 characters (10 bits), BIN2OCT returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, BIN2OCT uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, BIN2OCT returns the #VALUE! error value. If places is negative, BIN2OCT returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toOctal() method in the Engineering\ConvertBinary class instead

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

BITAND()

BITAND.

public static BITAND(int $number1, int $number2) : array<string|int, mixed>|int|string

Returns the bitwise AND of two integer values.

Excel Function: BITAND(number1, number2)

Parameters
$number1 : int
$number2 : int
Tags
Deprecated

1.17.0

see
Use

the BITAND() method in the Engineering\BitWise class instead

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

BITLSHIFT()

BITLSHIFT.

public static BITLSHIFT(int $number, int $shiftAmount) : array<string|int, mixed>|float|int|string

Returns the number value shifted left by shift_amount bits.

Excel Function: BITLSHIFT(number, shift_amount)

Parameters
$number : int
$shiftAmount : int
Tags
Deprecated

1.17.0

see
Use

the BITLSHIFT() method in the Engineering\BitWise class instead

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

BITOR()

BITOR.

public static BITOR(int $number1, int $number2) : array<string|int, mixed>|int|string

Returns the bitwise OR of two integer values.

Excel Function: BITOR(number1, number2)

Parameters
$number1 : int
$number2 : int
Tags
Deprecated

1.17.0

see
Use

the BITOR() method in the Engineering\BitWise class instead

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

BITRSHIFT()

BITRSHIFT.

public static BITRSHIFT(int $number, int $shiftAmount) : array<string|int, mixed>|float|int|string

Returns the number value shifted right by shift_amount bits.

Excel Function: BITRSHIFT(number, shift_amount)

Parameters
$number : int
$shiftAmount : int
Tags
Deprecated

1.17.0

see
Use

the BITRSHIFT() method in the Engineering\BitWise class instead

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

BITXOR()

BITXOR.

public static BITXOR(int $number1, int $number2) : array<string|int, mixed>|int|string

Returns the bitwise XOR of two integer values.

Excel Function: BITXOR(number1, number2)

Parameters
$number1 : int
$number2 : int
Tags
Deprecated

1.17.0

see
Use

the BITXOR() method in the Engineering\BitWise class instead

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

COMPLEX()

COMPLEX.

public static COMPLEX([array<string|int, mixed>|float $realNumber = 0.0 ][, array<string|int, mixed>|float $imaginary = 0.0 ][, array<string|int, mixed>|string $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 : array<string|int, mixed>|float = 0.0

the real coefficient of the complex number

$imaginary : array<string|int, mixed>|float = 0.0

the imaginary coefficient of the complex number

$suffix : array<string|int, mixed>|string = 'i'

The suffix for the imaginary component of the complex number. If omitted, the suffix is assumed to be "i".

Tags
Deprecated

1.18.0

see
Use

the COMPLEX() method in the Engineering\Complex class instead

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

CONVERTUOM()

CONVERTUOM.

public static CONVERTUOM(float|int $value, string $fromUOM, string $toUOM) : array<string|int, mixed>|float|string

Converts a number from one measurement system to another. For example, CONVERT can translate a table of distances in miles to a table of distances in kilometers.

Excel Function: CONVERT(value,fromUOM,toUOM)

Parameters
$value : float|int

the value in fromUOM to convert

$fromUOM : string

the units for value

$toUOM : string

the units for the result

Tags
Deprecated

1.16.0

see
Use

the CONVERT() method in the ConvertUOM class instead

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

DECTOBIN()

DECTOBIN.

public static DECTOBIN(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return a decimal value as binary.

Excel Function: DEC2BIN(x[,places])

Parameters
$x : mixed

The decimal integer you want to convert. If number is negative, valid place values are ignored and DEC2BIN returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number < -512 or if number > 511, DEC2BIN returns the #NUM! error value. If number is nonnumeric, DEC2BIN returns the #VALUE! error value. If DEC2BIN requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, DEC2BIN uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, DEC2BIN returns the #VALUE! error value. If places is zero or negative, DEC2BIN returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toBinary() method in the Engineering\ConvertDecimal class instead

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

DECTOHEX()

DECTOHEX.

public static DECTOHEX(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return a decimal value as hex.

Excel Function: DEC2HEX(x[,places])

Parameters
$x : mixed

The decimal integer you want to convert. If number is negative, places is ignored and DEC2HEX returns a 10-character (40-bit) hexadecimal number in which the most significant bit is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number < -549,755,813,888 or if number > 549,755,813,887, DEC2HEX returns the #NUM! error value. If number is nonnumeric, DEC2HEX returns the #VALUE! error value. If DEC2HEX requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, DEC2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, DEC2HEX returns the #VALUE! error value. If places is zero or negative, DEC2HEX returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toHex() method in the Engineering\ConvertDecimal class instead

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

DECTOOCT()

DECTOOCT.

public static DECTOOCT(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return an decimal value as octal.

Excel Function: DEC2OCT(x[,places])

Parameters
$x : mixed

The decimal integer you want to convert. If number is negative, places is ignored and DEC2OCT returns a 10-character (30-bit) octal number in which the most significant bit is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number < -536,870,912 or if number > 536,870,911, DEC2OCT returns the #NUM! error value. If number is nonnumeric, DEC2OCT returns the #VALUE! error value. If DEC2OCT requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, DEC2OCT uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, DEC2OCT returns the #VALUE! error value. If places is zero or negative, DEC2OCT returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toOctal() method in the Engineering\ConvertDecimal class instead

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

DELTA()

DELTA.

public static DELTA(float $a, float $b) : array<string|int, mixed>|int|string

Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise. Use this function to filter a set of values. For example, by summing several DELTA functions you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.

Excel Function: DELTA(a[,b])

Parameters
$a : float

the first number

$b : float

The second number. If omitted, b is assumed to be zero.

Tags
Deprecated

1.17.0

see
Use

the DELTA() method in the Engineering\Compare class instead

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

(string in the event of an error)

ERF()

ERF.

public static ERF(float $lower[, float $upper = null ]) : array<string|int, mixed>|float|string

Returns the error function integrated between the lower and upper bound arguments.

Note: In Excel 2007 or earlier, if you input a negative value for the upper or lower bound arguments, the function would return a #NUM! error. However, in Excel 2010, the function algorithm was improved, so that it can now calculate the function for both positive and negative ranges. PhpSpreadsheet follows Excel 2010 behaviour, and accepts negative arguments.

Excel Function: ERF(lower[,upper])

Parameters
$lower : float

lower bound for integrating ERF

$upper : float = null

upper bound for integrating ERF. If omitted, ERF integrates between zero and lower_limit

Tags
Deprecated

1.17.0

see
Use

the ERF() method in the Engineering\Erf class instead

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

ERFC()

ERFC.

public static ERFC(float $x) : array<string|int, mixed>|float|string

Returns the complementary ERF function integrated between x and infinity

Note: In Excel 2007 or earlier, if you input a negative value for the lower bound argument, the function would return a #NUM! error. However, in Excel 2010, the function algorithm was improved, so that it can now calculate the function for both positive and negative x values. PhpSpreadsheet follows Excel 2010 behaviour, and accepts nagative arguments.

Excel Function: ERFC(x)

Parameters
$x : float

The lower bound for integrating ERFC

Tags
Deprecated

1.17.0

see
Use

the ERFC() method in the Engineering\ErfC class instead

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

ERFPRECISE()

ERFPRECISE.

public static ERFPRECISE(float $limit) : array<string|int, mixed>|float|string

Returns the error function integrated between the lower and upper bound arguments.

Excel Function: ERF.PRECISE(limit)

Parameters
$limit : float

bound for integrating ERF

Tags
Deprecated

1.17.0

see
Use

the ERFPRECISE() method in the Engineering\Erf class instead

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

GESTEP()

GESTEP.

public static GESTEP(float $number, float $step) : array<string|int, mixed>|int|string

Excel Function: GESTEP(number[,step])

Returns 1 if number >= step; returns 0 (zero) otherwise Use this function to filter a set of values. For example, by summing several GESTEP functions you calculate the count of values that exceed a threshold.

Parameters
$number : float

the value to test against step

$step : float

The threshold value. If you omit a value for step, GESTEP uses zero.

Tags
Deprecated

1.17.0

see
Use

the GESTEP() method in the Engineering\Compare class instead

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

(string in the event of an error)

getBinaryConversionMultipliers()

getBinaryConversionMultipliers.

public static getBinaryConversionMultipliers() : array<string|int, mixed>

Returns an array of the additional Multiplier prefixes that can be used with Information Units of Measure in CONVERTUOM().

Tags
Deprecated

1.16.0

see
Use

the getBinaryConversionMultipliers() method in the ConvertUOM class instead

Return values
array<string|int, mixed>

getConversionGroups()

getConversionGroups Returns a list of the different conversion groups for UOM conversions.

public static getConversionGroups() : array<string|int, mixed>
Tags
Deprecated

1.16.0

see
Use

the getConversionCategories() method in the Engineering\ConvertUOM class instead

Return values
array<string|int, mixed>

getConversionGroupUnitDetails()

getConversionGroupUnitDetails.

public static getConversionGroupUnitDetails([null|mixed $category = null ]) : array<string|int, mixed>
Parameters
$category : null|mixed = null
Tags
Deprecated

1.16.0

see
Use

the getConversionCategoryUnitDetails() method in the ConvertUOM class instead

Return values
array<string|int, mixed>

getConversionGroupUnits()

getConversionGroupUnits Returns an array of units of measure, for a specified conversion group, or for all groups.

public static getConversionGroupUnits([null|mixed $category = null ]) : array<string|int, mixed>
Parameters
$category : null|mixed = null
Tags
Deprecated

1.16.0

see
Use

the getConversionCategoryUnits() method in the ConvertUOM class instead

Return values
array<string|int, mixed>

getConversionMultipliers()

getConversionMultipliers Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM().

public static getConversionMultipliers() : array<string|int, mixed>
Tags
Deprecated

1.16.0

see
Use

the getConversionMultipliers() method in the ConvertUOM class instead

Return values
array<string|int, mixed>

HEXTOBIN()

HEXTOBIN.

public static HEXTOBIN(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return a hex value as binary.

Excel Function: HEX2BIN(x[,places])

Parameters
$x : mixed

the hexadecimal number (as a string) that you want to convert. Number cannot contain more than 10 characters. The most significant bit of number is the sign bit (40th bit from the right). The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is negative, HEX2BIN ignores places and returns a 10-character binary number. If number is negative, it cannot be less than FFFFFFFE00, and if number is positive, it cannot be greater than 1FF. If number is not a valid hexadecimal number, HEX2BIN returns the #NUM! error value. If HEX2BIN requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, HEX2BIN uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, HEX2BIN returns the #VALUE! error value. If places is negative, HEX2BIN returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toBinary() method in the Engineering\ConvertHex class instead

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

HEXTODEC()

HEXTODEC.

public static HEXTODEC(mixed $x) : array<string|int, mixed>|string

Return a hex value as decimal.

Excel Function: HEX2DEC(x)

Parameters
$x : mixed

The hexadecimal number (as a string) that you want to convert. This number cannot contain more than 10 characters (40 bits). The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toDecimal() method in the Engineering\ConvertHex class instead

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

HEXTOOCT()

HEXTOOCT.

public static HEXTOOCT(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return a hex value as octal.

Excel Function: HEX2OCT(x[,places])

Parameters
$x : mixed

The hexadecimal number (as a string) that you want to convert. Number cannot contain more than 10 characters. The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is negative, HEX2OCT ignores places and returns a 10-character octal number. If number is negative, it cannot be less than FFE0000000, and if number is positive, it cannot be greater than 1FFFFFFF. If number is not a valid hexadecimal number, HEX2OCT returns the #NUM! error value. If HEX2OCT requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, HEX2OCT uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, HEX2OCT returns the #VALUE! error value. If places is negative, HEX2OCT returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toOctal() method in the Engineering\ConvertHex class instead

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

IMABS()

IMABS.

public static IMABS(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 : string

the complex number for which you want the absolute value

Tags
Deprecated

1.18.0

see
Use

the IMABS() method in the Engineering\ComplexFunctions class instead

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

IMAGINARY()

IMAGINARY.

public static IMAGINARY(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 : string

the complex number for which you want the imaginary coefficient

Tags
Deprecated

1.18.0

see
Use

the IMAGINARY() method in the Engineering\Complex class instead

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

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

Tags
Deprecated

1.18.0

see
Use

the IMARGUMENT() method in the Engineering\ComplexFunctions class instead

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

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

Tags
Deprecated

1.18.0

see
Use

the IMARGUMENT() method in the Engineering\ComplexFunctions class instead

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

IMCOS()

IMCOS.

public static IMCOS(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|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

Tags
Deprecated

1.18.0

see
Use

the IMCOS() method in the Engineering\ComplexFunctions class instead

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

IMCOSH()

IMCOSH.

public static IMCOSH(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|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

Tags
Deprecated

1.18.0

see
Use

the IMCOSH() method in the Engineering\ComplexFunctions class instead

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

IMCOT()

IMCOT.

public static IMCOT(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|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

Tags
Deprecated

1.18.0

see
Use

the IMCOT() method in the Engineering\ComplexFunctions class instead

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

IMCSC()

IMCSC.

public static IMCSC(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|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

Tags
Deprecated

1.18.0

see
Use

the IMCSC() method in the Engineering\ComplexFunctions class instead

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

IMCSCH()

IMCSCH.

public static IMCSCH(array<string|int, mixed>|string $complexNumber) : array<string|int, mixed>|float|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

Tags
Deprecated

1.18.0

see
Use

the IMCSCH() method in the Engineering\ComplexFunctions class instead

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

IMDIV()

IMDIV.

public static IMDIV(string $complexDividend, string $complexDivisor) : array<string|int, mixed>|string

Returns the quotient of two complex numbers in x + yi or x + yj text format.

Excel Function: IMDIV(complexDividend,complexDivisor)

Parameters
$complexDividend : string

the complex numerator or dividend

$complexDivisor : string

the complex denominator or divisor

Tags
Deprecated

1.18.0

see
Use

the IMDIV() method in the Engineering\ComplexOperations class instead

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

IMEXP()

IMEXP.

public static IMEXP(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 : string

the complex number for which you want the exponential

Tags
Deprecated

1.18.0

see
Use

the IMEXP() method in the Engineering\ComplexFunctions class instead

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

IMLN()

IMLN.

public static IMLN(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 : string

the complex number for which you want the natural logarithm

Tags
Deprecated

1.18.0

see
Use

the IMLN() method in the Engineering\ComplexFunctions class instead

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

IMLOG10()

IMLOG10.

public static IMLOG10(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 : string

the complex number for which you want the common logarithm

Tags
Deprecated

1.18.0

see
Use

the IMLOG10() method in the Engineering\ComplexFunctions class instead

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

IMLOG2()

IMLOG2.

public static IMLOG2(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 : string

the complex number for which you want the base-2 logarithm

Tags
Deprecated

1.18.0

see
Use

the IMLOG2() method in the Engineering\ComplexFunctions class instead

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

IMPOWER()

IMPOWER.

public static IMPOWER(string $complexNumber, float $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 : string

the complex number you want to raise to a power

$realNumber : float

the power to which you want to raise the complex number

Tags
Deprecated

1.18.0

see
Use

the IMPOWER() method in the Engineering\ComplexFunctions class instead

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

IMPRODUCT()

IMPRODUCT.

public static IMPRODUCT(string ...$complexNumbers) : string

Returns the product of two or more complex numbers in x + yi or x + yj text format.

Excel Function: IMPRODUCT(complexNumber[,complexNumber[,...]])

Parameters
$complexNumbers : string

Series of complex numbers to multiply

Tags
Deprecated

1.18.0

see
Use

the IMPRODUCT() method in the Engineering\ComplexOperations class instead

Return values
string

IMREAL()

IMREAL.

public static IMREAL(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 : string

the complex number for which you want the real coefficient

Tags
Deprecated

1.18.0

see
Use

the IMREAL() method in the Engineering\Complex class instead

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

IMSEC()

IMSEC.

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

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

Excel Function: IMSEC(complexNumber)

Parameters
$complexNumber : string

the complex number for which you want the secant

Tags
Deprecated

1.18.0

see
Use

the IMSEC() method in the Engineering\ComplexFunctions class instead

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

IMSECH()

IMSECH.

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

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

Excel Function: IMSECH(complexNumber)

Parameters
$complexNumber : string

the complex number for which you want the hyperbolic secant

Tags
Deprecated

1.18.0

see
Use

the IMSECH() method in the Engineering\ComplexFunctions class instead

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

IMSIN()

IMSIN.

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

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

Excel Function: IMSIN(complexNumber)

Parameters
$complexNumber : string

the complex number for which you want the sine

Tags
Deprecated

1.18.0

see
Use

the IMSIN() method in the Engineering\ComplexFunctions class instead

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

IMSINH()

IMSINH.

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

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

Excel Function: IMSINH(complexNumber)

Parameters
$complexNumber : string

the complex number for which you want the hyperbolic sine

Tags
Deprecated

1.18.0

see
Use

the IMSINH() method in the Engineering\ComplexFunctions class instead

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

IMSQRT()

IMSQRT.

public static IMSQRT(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 : string

the complex number for which you want the square root

Tags
Deprecated

1.18.0

see
Use

the IMSQRT() method in the Engineering\ComplexFunctions class instead

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

IMSUB()

IMSUB.

public static IMSUB(string $complexNumber1, string $complexNumber2) : array<string|int, mixed>|string

Returns the difference of two complex numbers in x + yi or x + yj text format.

Excel Function: IMSUB(complexNumber1,complexNumber2)

Parameters
$complexNumber1 : string

the complex number from which to subtract complexNumber2

$complexNumber2 : string

the complex number to subtract from complexNumber1

Tags
Deprecated

1.18.0

see
Use

the IMSUB() method in the Engineering\ComplexOperations class instead

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

IMSUM()

IMSUM.

public static IMSUM(string ...$complexNumbers) : string

Returns the sum of two or more complex numbers in x + yi or x + yj text format.

Excel Function: IMSUM(complexNumber[,complexNumber[,...]])

Parameters
$complexNumbers : string

Series of complex numbers to add

Tags
Deprecated

1.18.0

see
Use

the IMSUM() method in the Engineering\ComplexOperations class instead

Return values
string

IMTAN()

IMTAN.

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

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

Excel Function: IMTAN(complexNumber)

Parameters
$complexNumber : string

the complex number for which you want the tangent

Tags
Deprecated

1.18.0

see
Use

the IMTAN() method in the Engineering\ComplexFunctions class instead

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

OCTTOBIN()

OCTTOBIN.

public static OCTTOBIN(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return an octal value as binary.

Excel Function: OCT2BIN(x[,places])

Parameters
$x : mixed

The octal number you want to convert. Number may not contain more than 10 characters. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is negative, OCT2BIN ignores places and returns a 10-character binary number. If number is negative, it cannot be less than 7777777000, and if number is positive, it cannot be greater than 777. If number is not a valid octal number, OCT2BIN returns the #NUM! error value. If OCT2BIN requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, OCT2BIN uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, OCT2BIN returns the #VALUE! error value. If places is negative, OCT2BIN returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toBinary() method in the Engineering\ConvertOctal class instead

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

OCTTODEC()

OCTTODEC.

public static OCTTODEC(mixed $x) : array<string|int, mixed>|string

Return an octal value as decimal.

Excel Function: OCT2DEC(x)

Parameters
$x : mixed

The octal number you want to convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is not a valid octal number, OCT2DEC returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toDecimal() method in the Engineering\ConvertOctal class instead

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

OCTTOHEX()

OCTTOHEX.

public static OCTTOHEX(mixed $x[, mixed $places = null ]) : array<string|int, mixed>|string

Return an octal value as hex.

Excel Function: OCT2HEX(x[,places])

Parameters
$x : mixed

The octal number you want to convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation. If number is negative, OCT2HEX ignores places and returns a 10-character hexadecimal number. If number is not a valid octal number, OCT2HEX returns the #NUM! error value. If OCT2HEX requires more than places characters, it returns the #NUM! error value.

$places : mixed = null

The number of characters to use. If places is omitted, OCT2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros). If places is not an integer, it is truncated. If places is nonnumeric, OCT2HEX returns the #VALUE! error value. If places is negative, OCT2HEX returns the #NUM! error value.

Tags
Deprecated

1.17.0

see
Use

the toHex() method in the Engineering\ConvertOctal class instead

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

parseComplex()

parseComplex.

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

Parses a complex number into its real and imaginary parts, and an I or J suffix

Parameters
$complexNumber : string

The complex number

Tags
deprecated
1.12.0

No longer used by internal code. Please use the \Complex\Complex class instead

Return values
array<string|int, mixed>

Indexed on "real", "imaginary" and "suffix"

Search results