Collaboration diagram for PhpOffice\PhpSpreadsheet\Calculation\Engineering:

Static Public Member Functions
static	parseComplex ($complexNumber)
	parseComplex. More...

static	BESSELI ($x, $ord)
	BESSELI. More...

static	BESSELJ ($x, $ord)
	BESSELJ. More...

static	BESSELK ($x, $ord)
	BESSELK. More...

static	BESSELY ($x, $ord)
	BESSELY. More...

static	BINTODEC ($x)
	BINTODEC. More...

static	BINTOHEX ($x, $places=null)
	BINTOHEX. More...

static	BINTOOCT ($x, $places=null)
	BINTOOCT. More...

static	DECTOBIN ($x, $places=null)
	DECTOBIN. More...

static	DECTOHEX ($x, $places=null)
	DECTOHEX. More...

static	DECTOOCT ($x, $places=null)
	DECTOOCT. More...

static	HEXTOBIN ($x, $places=null)
	HEXTOBIN. More...

static	HEXTODEC ($x)
	HEXTODEC. More...

static	HEXTOOCT ($x, $places=null)
	HEXTOOCT. More...

static	OCTTOBIN ($x, $places=null)
	OCTTOBIN. More...

static	OCTTODEC ($x)
	OCTTODEC. More...

static	OCTTOHEX ($x, $places=null)
	OCTTOHEX. More...

static	COMPLEX ($realNumber=0.0, $imaginary=0.0, $suffix='i')
	COMPLEX. More...

static	IMAGINARY ($complexNumber)
	IMAGINARY. More...

static	IMREAL ($complexNumber)
	IMREAL. More...

static	IMABS ($complexNumber)
	IMABS. More...

static	IMARGUMENT ($complexNumber)
	IMARGUMENT. More...

static	IMCONJUGATE ($complexNumber)
	IMCONJUGATE. More...

static	IMCOS ($complexNumber)
	IMCOS. More...

static	IMCOSH ($complexNumber)
	IMCOSH. More...

static	IMCOT ($complexNumber)
	IMCOT. More...

static	IMCSC ($complexNumber)
	IMCSC. More...

static	IMCSCH ($complexNumber)
	IMCSCH. More...

static	IMSIN ($complexNumber)
	IMSIN. More...

static	IMSINH ($complexNumber)
	IMSINH. More...

static	IMSEC ($complexNumber)
	IMSEC. More...

static	IMSECH ($complexNumber)
	IMSECH. More...

static	IMTAN ($complexNumber)
	IMTAN. More...

static	IMSQRT ($complexNumber)
	IMSQRT. More...

static	IMLN ($complexNumber)
	IMLN. More...

static	IMLOG10 ($complexNumber)
	IMLOG10. More...

static	IMLOG2 ($complexNumber)
	IMLOG2. More...

static	IMEXP ($complexNumber)
	IMEXP. More...

static	IMPOWER ($complexNumber, $realNumber)
	IMPOWER. More...

static	IMDIV ($complexDividend, $complexDivisor)
	IMDIV. More...

static	IMSUB ($complexNumber1, $complexNumber2)
	IMSUB. More...

static	IMSUM (... $complexNumbers)
	IMSUM. More...

static	IMPRODUCT (... $complexNumbers)
	IMPRODUCT. More...

static	DELTA ($a, $b=0)
	DELTA. More...

static	GESTEP ($number, $step=0)
	GESTEP. More...

static	BITAND ($number1, $number2)
	BITAND. More...

static	BITOR ($number1, $number2)
	BITOR. More...

static	BITXOR ($number1, $number2)
	BITXOR. More...

static	BITLSHIFT ($number, $shiftAmount)
	BITLSHIFT. More...

static	BITRSHIFT ($number, $shiftAmount)
	BITRSHIFT. More...

static	ERF ($lower, $upper=null)
	ERF. More...

static	ERFPRECISE ($limit)
	ERFPRECISE. More...

static	ERFC ($x)
	ERFC. More...

static	getConversionGroups ()
	getConversionGroups Returns a list of the different conversion groups for UOM conversions. More...

static	getConversionGroupUnits ($category=null)
	getConversionGroupUnits Returns an array of units of measure, for a specified conversion group, or for all groups. More...

static	getConversionGroupUnitDetails ($category=null)
	getConversionGroupUnitDetails. More...

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

static	getBinaryConversionMultipliers ()
	getBinaryConversionMultipliers. More...

static	CONVERTUOM ($value, $fromUOM, $toUOM)
	CONVERTUOM. More...

Data Fields
const	EULER = 2.71828182845904523536
	EULER. More...

Detailed Description

Deprecated:: 1.18.0

Definition at line 12 of file Engineering.php.

Member Function Documentation

◆ BESSELI()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BESSELI	(	$x,
		$ord
	)

static

BESSELI.

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

Excel Function: BESSELI(x,ord)

1.17.0

See also: Use the BESSELI() method in the Engineering class instead

Parameters

float	$x	The value at which to evaluate the function. If x is nonnumeric, BESSELI returns the #VALUE! error value.
int	$ord	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.

Returns: float|string Result, or a string containing an error

Definition at line 66 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\BesselI\BESSELI().

     {
         return Engineering\BesselI::BESSELI($x, $ord);
     }

Here is the call graph for this function:

◆ BESSELJ()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BESSELJ	(	$x,
		$ord
	)

static

BESSELJ.

Returns the Bessel function

Excel Function: BESSELJ(x,ord)

1.17.0

See also: Use the BESSELJ() method in the Engineering class instead

Parameters

float	$x	The value at which to evaluate the function. If x is nonnumeric, BESSELJ returns the #VALUE! error value.
int	$ord	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.

Returns: float|string Result, or a string containing an error

Definition at line 91 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\BesselJ\BESSELJ().

     {
         return Engineering\BesselJ::BESSELJ($x, $ord);
     }

Here is the call graph for this function:

◆ BESSELK()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BESSELK	(	$x,
		$ord
	)

static

BESSELK.

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

Excel Function: BESSELK(x,ord)

1.17.0

See also: Use the BESSELK() method in the Engineering class instead

Parameters

float	$x	The value at which to evaluate the function. If x is nonnumeric, BESSELK returns the #VALUE! error value.
int	$ord	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.

Returns: float|string Result, or a string containing an error

Definition at line 117 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\BesselK\BESSELK().

     {
         return Engineering\BesselK::BESSELK($x, $ord);
     }

Here is the call graph for this function:

◆ BESSELY()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BESSELY	(	$x,
		$ord
	)

static

BESSELY.

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

Excel Function: BESSELY(x,ord)

1.17.0

See also: Use the BESSELY() method in the Engineering class instead

Parameters

float	$x	The value at which to evaluate the function. If x is nonnumeric, BESSELY returns the #VALUE! error value.
int	$ord	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.

Returns: float|string Result, or a string containing an error

Definition at line 142 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\BesselY\BESSELY().

     {
         return Engineering\BesselY::BESSELY($x, $ord);
     }

Here is the call graph for this function:

◆ BINTODEC()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BINTODEC ( $x )

static

BINTODEC.

Return a binary value as decimal.

Excel Function: BIN2DEC(x)

1.17.0

See also: Use the toDecimal() method in the Engineering class instead

Parameters

mixed $x 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.

Returns: string

Definition at line 168 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertBinary\toDecimal().

     {
         return Engineering\ConvertBinary::toDecimal($x);
     }

Here is the call graph for this function:

◆ BINTOHEX()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BINTOHEX	(	$x,
		$places = `null`
	)

static

BINTOHEX.

Return a binary value as hex.

Excel Function: BIN2HEX(x[,places])

1.17.0

See also: Use the toHex() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 200 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertBinary\toHex().

     {
         return Engineering\ConvertBinary::toHex($x, $places);
     }

Here is the call graph for this function:

◆ BINTOOCT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BINTOOCT	(	$x,
		$places = `null`
	)

static

BINTOOCT.

Return a binary value as octal.

Excel Function: BIN2OCT(x[,places])

1.17.0

See also: Use the toOctal() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 232 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertBinary\toOctal().

     {
         return Engineering\ConvertBinary::toOctal($x, $places);
     }

Here is the call graph for this function:

◆ BITAND()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BITAND	(	$number1,
		$number2
	)

static

BITAND.

Returns the bitwise AND of two integer values.

Excel Function: BITAND(number1, number2)

1.17.0

See also: Use the BITAND() method in the Engineering class instead

Parameters

int	$number1
int	$number2

Returns: int|string

Definition at line 1174 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\BitWise\BITAND().

     {
         return Engineering\BitWise::BITAND($number1, $number2);
     }

Here is the call graph for this function:

◆ BITLSHIFT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BITLSHIFT	(	$number,
		$shiftAmount
	)

static

BITLSHIFT.

Returns the number value shifted left by shift_amount bits.

Excel Function: BITLSHIFT(number, shift_amount)

1.17.0

See also: Use the BITLSHIFT() method in the Engineering class instead

Parameters

int	$number
int	$shiftAmount

Returns: int|string

Definition at line 1240 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\BitWise\BITLSHIFT().

     {
         return Engineering\BitWise::BITLSHIFT($number, $shiftAmount);
     }

Here is the call graph for this function:

◆ BITOR()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BITOR	(	$number1,
		$number2
	)

static

BITOR.

Returns the bitwise OR of two integer values.

Excel Function: BITOR(number1, number2)

1.17.0

See also: Use the BITOR() method in the Engineering class instead

Parameters

int	$number1
int	$number2

Returns: int|string

Definition at line 1196 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\BitWise\BITOR().

     {
         return Engineering\BitWise::BITOR($number1, $number2);
     }

Here is the call graph for this function:

◆ BITRSHIFT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BITRSHIFT	(	$number,
		$shiftAmount
	)

static

BITRSHIFT.

Returns the number value shifted right by shift_amount bits.

Excel Function: BITRSHIFT(number, shift_amount)

1.17.0

See also: Use the BITRSHIFT() method in the Engineering class instead

Parameters

int	$number
int	$shiftAmount

Returns: int|string

Definition at line 1262 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\BitWise\BITRSHIFT().

     {
         return Engineering\BitWise::BITRSHIFT($number, $shiftAmount);
     }

Here is the call graph for this function:

◆ BITXOR()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::BITXOR	(	$number1,
		$number2
	)

static

BITXOR.

Returns the bitwise XOR of two integer values.

Excel Function: BITXOR(number1, number2)

1.17.0

See also: Use the BITXOR() method in the Engineering class instead

Parameters

int	$number1
int	$number2

Returns: int|string

Definition at line 1218 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\BitWise\BITXOR().

     {
         return Engineering\BitWise::BITXOR($number1, $number2);
     }

Here is the call graph for this function:

◆ COMPLEX()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::COMPLEX	(	$realNumber = `0.0`,
		$imaginary = `0.0`,
		$suffix = `'i'`
	)

static

COMPLEX.

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

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

1.18.0

See also: Use the COMPLEX() method in the Engineering class instead

Parameters

float	$realNumber	the real coefficient of the complex number
float	$imaginary	the imaginary coefficient of the complex number
string	$suffix	The suffix for the imaginary component of the complex number. If omitted, the suffix is assumed to be "i".

Returns: string

Definition at line 573 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\Complex\COMPLEX().

     {
         return Engineering\Complex::COMPLEX($realNumber, $imaginary, $suffix);
     }

Here is the call graph for this function:

◆ CONVERTUOM()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::CONVERTUOM	(	$value,
		$fromUOM,
		$toUOM
	)

static

CONVERTUOM.

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)

1.16.0

See also: Use the CONVERT() method in the ConvertUOM class instead

Parameters

float \| int	$value	the value in fromUOM to convert
string	$fromUOM	the units for value
string	$toUOM	the units for the result

Returns: float|string

Definition at line 1442 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertUOM\CONVERT().

     {
         return Engineering\ConvertUOM::CONVERT($value, $fromUOM, $toUOM);
     }

Here is the call graph for this function:

◆ DECTOBIN()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::DECTOBIN	(	$x,
		$places = `null`
	)

static

DECTOBIN.

Return a decimal value as binary.

Excel Function: DEC2BIN(x[,places])

1.17.0

See also: Use the toBinary() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 268 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertDecimal\toBinary().

     {
         return Engineering\ConvertDecimal::toBinary($x, $places);
     }

Here is the call graph for this function:

◆ DECTOHEX()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::DECTOHEX	(	$x,
		$places = `null`
	)

static

DECTOHEX.

Return a decimal value as hex.

Excel Function: DEC2HEX(x[,places])

1.17.0

See also: Use the toHex() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 304 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertDecimal\toHex().

     {
         return Engineering\ConvertDecimal::toHex($x, $places);
     }

Here is the call graph for this function:

◆ DECTOOCT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::DECTOOCT	(	$x,
		$places = `null`
	)

static

DECTOOCT.

Return an decimal value as octal.

Excel Function: DEC2OCT(x[,places])

1.17.0

See also: Use the toOctal() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 340 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertDecimal\toOctal().

     {
         return Engineering\ConvertDecimal::toOctal($x, $places);
     }

Here is the call graph for this function:

◆ DELTA()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::DELTA	(	$a,
		$b = `0`
	)

static

DELTA.

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])

1.17.0

See also: Use the DELTA() method in the Engineering class instead

Parameters

float	$a	the first number
float	$b	The second number. If omitted, b is assumed to be zero.

Returns: int|string (string in the event of an error)

Definition at line 1128 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\Compare\DELTA().

     {
         return Engineering\Compare::DELTA($a, $b);
     }

Here is the call graph for this function:

◆ ERF()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::ERF	(	$lower,
		$upper = `null`
	)

static

ERF.

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])

1.17.0

See also: Use the ERF() method in the Engineering class instead

Parameters

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

Returns: float|string

Definition at line 1290 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\Erf\ERF().

     {
         return Engineering\Erf::ERF($lower, $upper);
     }

Here is the call graph for this function:

◆ ERFC()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::ERFC ( $x )

static

ERFC.

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)

1.17.0

See also: Use the ERFC() method in the Engineering class instead

Parameters

float $x The lower bound for integrating ERFC

Returns: float|string

Definition at line 1337 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ErfC\ERFC().

     {
         return Engineering\ErfC::ERFC($x);
     }

Here is the call graph for this function:

◆ ERFPRECISE()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::ERFPRECISE ( $limit )

static

ERFPRECISE.

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

Excel Function: ERF.PRECISE(limit)

1.17.0

See also: Use the ERFPRECISE() method in the Engineering class instead

Parameters

float $limit bound for integrating ERF

Returns: float|string

Definition at line 1311 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\Erf\ERFPRECISE().

     {
         return Engineering\Erf::ERFPRECISE($limit);
     }

Here is the call graph for this function:

◆ GESTEP()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::GESTEP	(	$number,
		$step = `0`
	)

static

GESTEP.

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.

1.17.0

See also: Use the GESTEP() method in the Engineering class instead

Parameters

float	$number	the value to test against step
float	$step	The threshold value. If you omit a value for step, GESTEP uses zero.

Returns: int|string (string in the event of an error)

Definition at line 1152 of file Engineering.php.

References $step, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\Compare\GESTEP().

     {
         return Engineering\Compare::GESTEP($number, $step);
     }

Here is the call graph for this function:

◆ getBinaryConversionMultipliers()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::getBinaryConversionMultipliers ( )

static

getBinaryConversionMultipliers.

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

1.16.0

See also: Use the getBinaryConversionMultipliers() method in the ConvertUOM class instead

Returns: mixed[]

Definition at line 1417 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertUOM\getBinaryConversionMultipliers().

     {
         return Engineering\ConvertUOM::getBinaryConversionMultipliers();
     }

Here is the call graph for this function:

◆ getConversionGroups()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::getConversionGroups ( )

static

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

1.16.0

See also: Use the getConversionCategories() method in the Engineering class instead

Returns: array

Definition at line 1352 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertUOM\getConversionCategories().

     {
         return Engineering\ConvertUOM::getConversionCategories();
     }

Here is the call graph for this function:

◆ getConversionGroupUnitDetails()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::getConversionGroupUnitDetails ( $category = null )

static

getConversionGroupUnitDetails.

1.16.0

See also: Use the getConversionCategoryUnitDetails() method in the ConvertUOM class instead

Parameters

null | mixed $category

Returns: array

Definition at line 1385 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertUOM\getConversionCategoryUnitDetails().

     {
         return Engineering\ConvertUOM::getConversionCategoryUnitDetails($category);
     }

Here is the call graph for this function:

◆ getConversionGroupUnits()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::getConversionGroupUnits ( $category = null )

static

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

1.16.0

See also: Use the getConversionCategoryUnits() method in the ConvertUOM class instead

Parameters

null | mixed $category

Returns: array

Definition at line 1369 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertUOM\getConversionCategoryUnits().

     {
         return Engineering\ConvertUOM::getConversionCategoryUnits($category);
     }

Here is the call graph for this function:

◆ getConversionMultipliers()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::getConversionMultipliers ( )

static

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

1.16.0

See also: Use the getConversionMultipliers() method in the ConvertUOM class instead

Returns: mixed[]

Definition at line 1400 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertUOM\getConversionMultipliers().

     {
         return Engineering\ConvertUOM::getConversionMultipliers();
     }

Here is the call graph for this function:

◆ HEXTOBIN()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::HEXTOBIN	(	$x,
		$places = `null`
	)

static

HEXTOBIN.

Return a hex value as binary.

Excel Function: HEX2BIN(x[,places])

1.17.0

See also: Use the toBinary() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 376 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertHex\toBinary().

     {
         return Engineering\ConvertHex::toBinary($x, $places);
     }

Here is the call graph for this function:

◆ HEXTODEC()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::HEXTODEC ( $x )

static

HEXTODEC.

Return a hex value as decimal.

Excel Function: HEX2DEC(x)

1.17.0

See also: Use the toDecimal() method in the Engineering class instead

Parameters

mixed $x 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.

Returns: string

Definition at line 403 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertHex\toDecimal().

     {
         return Engineering\ConvertHex::toDecimal($x);
     }

Here is the call graph for this function:

◆ HEXTOOCT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::HEXTOOCT	(	$x,
		$places = `null`
	)

static

HEXTOOCT.

Return a hex value as octal.

Excel Function: HEX2OCT(x[,places])

1.17.0

See also: Use the toOctal() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 443 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertHex\toOctal().

     {
         return Engineering\ConvertHex::toOctal($x, $places);
     }

Here is the call graph for this function:

◆ IMABS()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMABS ( $complexNumber )

static

IMABS.

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

Excel Function: IMABS(complexNumber)

1.18.0

See also: Use the IMABS() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the absolute value

Returns: float|string

Definition at line 637 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMABS().

     {
         return ComplexFunctions::IMABS($complexNumber);
     }

Here is the call graph for this function:

◆ IMAGINARY()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMAGINARY ( $complexNumber )

static

IMAGINARY.

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

Excel Function: IMAGINARY(complexNumber)

1.18.0

See also: Use the IMAGINARY() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the imaginary coefficient

Returns: float|string

Definition at line 595 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\Complex\IMAGINARY().

     {
         return Engineering\Complex::IMAGINARY($complexNumber);
     }

Here is the call graph for this function:

◆ IMARGUMENT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMARGUMENT ( $complexNumber )

static

IMARGUMENT.

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)

1.18.0

See also: Use the IMARGUMENT() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the argument theta

Returns: float|string

Definition at line 659 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMARGUMENT().

     {
         return ComplexFunctions::IMARGUMENT($complexNumber);
     }

Here is the call graph for this function:

◆ IMCONJUGATE()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCONJUGATE ( $complexNumber )

static

IMCONJUGATE.

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

Excel Function: IMCONJUGATE(complexNumber)

1.18.0

See also: Use the IMARGUMENT() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the conjugate

Returns: string

Definition at line 680 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMCONJUGATE().

     {
         return ComplexFunctions::IMCONJUGATE($complexNumber);
     }

Here is the call graph for this function:

◆ IMCOS()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOS ( $complexNumber )

static

IMCOS.

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

Excel Function: IMCOS(complexNumber)

1.18.0

See also: Use the IMCOS() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the cosine

Returns: float|string

Definition at line 701 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMCOS().

     {
         return ComplexFunctions::IMCOS($complexNumber);
     }

Here is the call graph for this function:

◆ IMCOSH()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOSH ( $complexNumber )

static

IMCOSH.

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

Excel Function: IMCOSH(complexNumber)

1.18.0

See also: Use the IMCOSH() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the hyperbolic cosine

Returns: float|string

Definition at line 722 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMCOSH().

     {
         return ComplexFunctions::IMCOSH($complexNumber);
     }

Here is the call graph for this function:

◆ IMCOT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOT ( $complexNumber )

static

IMCOT.

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

Excel Function: IMCOT(complexNumber)

1.18.0

See also: Use the IMCOT() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the cotangent

Returns: float|string

Definition at line 743 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMCOT().

     {
         return ComplexFunctions::IMCOT($complexNumber);
     }

Here is the call graph for this function:

◆ IMCSC()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCSC ( $complexNumber )

static

IMCSC.

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

Excel Function: IMCSC(complexNumber)

1.18.0

See also: Use the IMCSC() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the cosecant

Returns: float|string

Definition at line 764 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMCSC().

     {
         return ComplexFunctions::IMCSC($complexNumber);
     }

Here is the call graph for this function:

◆ IMCSCH()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCSCH ( $complexNumber )

static

IMCSCH.

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

Excel Function: IMCSCH(complexNumber)

1.18.0

See also: Use the IMCSCH() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the hyperbolic cosecant

Returns: float|string

Definition at line 785 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMCSCH().

     {
         return ComplexFunctions::IMCSCH($complexNumber);
     }

Here is the call graph for this function:

◆ IMDIV()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMDIV	(	$complexDividend,
		$complexDivisor
	)

static

IMDIV.

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

Excel Function: IMDIV(complexDividend,complexDivisor)

1.18.0

See also: Use the IMDIV() method in the Engineering class instead

Parameters

string	$complexDividend	the complex numerator or dividend
string	$complexDivisor	the complex denominator or divisor

Returns: string

Definition at line 1039 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexOperations\IMDIV().

     {
         return ComplexOperations::IMDIV($complexDividend, $complexDivisor);
     }

Here is the call graph for this function:

◆ IMEXP()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMEXP ( $complexNumber )

static

IMEXP.

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

Excel Function: IMEXP(complexNumber)

1.18.0

See also: Use the IMEXP() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the exponential

Returns: string

Definition at line 995 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMEXP().

     {
         return ComplexFunctions::IMEXP($complexNumber);
     }

Here is the call graph for this function:

◆ IMLN()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMLN ( $complexNumber )

static

IMLN.

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

Excel Function: IMLN(complexNumber)

1.18.0

See also: Use the IMLN() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the natural logarithm

Returns: string

Definition at line 932 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMLN().

     {
         return ComplexFunctions::IMLN($complexNumber);
     }

Here is the call graph for this function:

◆ IMLOG10()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMLOG10 ( $complexNumber )

static

IMLOG10.

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

Excel Function: IMLOG10(complexNumber)

1.18.0

See also: Use the IMLOG10() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the common logarithm

Returns: string

Definition at line 953 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMLOG10().

     {
         return ComplexFunctions::IMLOG10($complexNumber);
     }

Here is the call graph for this function:

◆ IMLOG2()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMLOG2 ( $complexNumber )

static

IMLOG2.

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

Excel Function: IMLOG2(complexNumber)

1.18.0

See also: Use the IMLOG2() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the base-2 logarithm

Returns: string

Definition at line 974 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMLOG2().

     {
         return ComplexFunctions::IMLOG2($complexNumber);
     }

Here is the call graph for this function:

◆ IMPOWER()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMPOWER	(	$complexNumber,
		$realNumber
	)

static

IMPOWER.

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

Excel Function: IMPOWER(complexNumber,realNumber)

1.18.0

See also: Use the IMPOWER() method in the Engineering class instead

Parameters

string	$complexNumber	the complex number you want to raise to a power
float	$realNumber	the power to which you want to raise the complex number

Returns: string

Definition at line 1017 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMPOWER().

     {
         return ComplexFunctions::IMPOWER($complexNumber, $realNumber);
     }

Here is the call graph for this function:

◆ IMPRODUCT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMPRODUCT ( $complexNumbers )

static

IMPRODUCT.

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

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

1.18.0

See also: Use the IMPRODUCT() method in the Engineering class instead

Parameters

string ...$complexNumbers Series of complex numbers to multiply

Returns: string

Definition at line 1103 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexOperations\IMPRODUCT().

     {
         return ComplexOperations::IMPRODUCT(...$complexNumbers);
     }

Here is the call graph for this function:

◆ IMREAL()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMREAL ( $complexNumber )

static

IMREAL.

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

Excel Function: IMREAL(complexNumber)

1.18.0

See also: Use the IMREAL() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the real coefficient

Returns: float|string

Definition at line 616 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\Complex\IMREAL().

     {
         return Engineering\Complex::IMREAL($complexNumber);
     }

Here is the call graph for this function:

◆ IMSEC()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSEC ( $complexNumber )

static

IMSEC.

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

Excel Function: IMSEC(complexNumber)

1.18.0

See also: Use the IMSEC() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the secant

Returns: float|string

Definition at line 848 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMSEC().

     {
         return ComplexFunctions::IMSEC($complexNumber);
     }

Here is the call graph for this function:

◆ IMSECH()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSECH ( $complexNumber )

static

IMSECH.

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

Excel Function: IMSECH(complexNumber)

1.18.0

See also: Use the IMSECH() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the hyperbolic secant

Returns: float|string

Definition at line 869 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMSECH().

     {
         return ComplexFunctions::IMSECH($complexNumber);
     }

Here is the call graph for this function:

◆ IMSIN()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSIN ( $complexNumber )

static

IMSIN.

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

Excel Function: IMSIN(complexNumber)

1.18.0

See also: Use the IMSIN() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the sine

Returns: float|string

Definition at line 806 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMSIN().

     {
         return ComplexFunctions::IMSIN($complexNumber);
     }

Here is the call graph for this function:

◆ IMSINH()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSINH ( $complexNumber )

static

IMSINH.

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

Excel Function: IMSINH(complexNumber)

1.18.0

See also: Use the IMSINH() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the hyperbolic sine

Returns: float|string

Definition at line 827 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMSINH().

     {
         return ComplexFunctions::IMSINH($complexNumber);
     }

Here is the call graph for this function:

◆ IMSQRT()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSQRT ( $complexNumber )

static

IMSQRT.

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

Excel Function: IMSQRT(complexNumber)

1.18.0

See also: Use the IMSQRT() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the square root

Returns: string

Definition at line 911 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMSQRT().

     {
         return ComplexFunctions::IMSQRT($complexNumber);
     }

Here is the call graph for this function:

◆ IMSUB()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSUB	(	$complexNumber1,
		$complexNumber2
	)

static

IMSUB.

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

Excel Function: IMSUB(complexNumber1,complexNumber2)

1.18.0

See also: Use the IMSUB() method in the Engineering class instead

Parameters

string	$complexNumber1	the complex number from which to subtract complexNumber2
string	$complexNumber2	the complex number to subtract from complexNumber1

Returns: string

Definition at line 1061 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexOperations\IMSUB().

     {
         return ComplexOperations::IMSUB($complexNumber1, $complexNumber2);
     }

Here is the call graph for this function:

◆ IMSUM()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSUM ( $complexNumbers )

static

IMSUM.

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

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

1.18.0

See also: Use the IMSUM() method in the Engineering class instead

Parameters

string ...$complexNumbers Series of complex numbers to add

Returns: string

Definition at line 1082 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexOperations\IMSUM().

     {
         return ComplexOperations::IMSUM(...$complexNumbers);
     }

Here is the call graph for this function:

◆ IMTAN()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMTAN ( $complexNumber )

static

IMTAN.

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

Excel Function: IMTAN(complexNumber)

1.18.0

See also: Use the IMTAN() method in the Engineering class instead

Parameters

string $complexNumber the complex number for which you want the tangent

Returns: float|string

Definition at line 890 of file Engineering.php.

References PhpOffice\PhpSpreadsheet\Calculation\Engineering\ComplexFunctions\IMTAN().

     {
         return ComplexFunctions::IMTAN($complexNumber);
     }

Here is the call graph for this function:

◆ OCTTOBIN()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::OCTTOBIN	(	$x,
		$places = `null`
	)

static

OCTTOBIN.

Return an octal value as binary.

Excel Function: OCT2BIN(x[,places])

1.17.0

See also: Use the toBinary() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 485 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertOctal\toBinary().

     {
         return Engineering\ConvertOctal::toBinary($x, $places);
     }

Here is the call graph for this function:

◆ OCTTODEC()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::OCTTODEC ( $x )

static

OCTTODEC.

Return an octal value as decimal.

Excel Function: OCT2DEC(x)

1.17.0

See also: Use the toDecimal() method in the Engineering class instead

Parameters

mixed $x 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.

Returns: string

Definition at line 512 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertOctal\toDecimal().

     {
         return Engineering\ConvertOctal::toDecimal($x);
     }

Here is the call graph for this function:

◆ OCTTOHEX()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::OCTTOHEX	(	$x,
		$places = `null`
	)

static

OCTTOHEX.

Return an octal value as hex.

Excel Function: OCT2HEX(x[,places])

1.17.0

See also: Use the toHex() method in the Engineering class instead

Parameters

mixed	$x	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.
mixed	$places	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.

Returns: string

Definition at line 549 of file Engineering.php.

References $x, and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertOctal\toHex().

     {
         return Engineering\ConvertOctal::toHex($x, $places);
     }

Here is the call graph for this function:

◆ parseComplex()

static PhpOffice\PhpSpreadsheet\Calculation\Engineering::parseComplex ( $complexNumber )

static

parseComplex.

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

Deprecated:: 1.12.0 No longer used by internal code. Please use the class instead

Parameters

string $complexNumber The complex number

Returns: mixed[] Indexed on "real", "imaginary" and "suffix"

Definition at line 33 of file Engineering.php.

     {
         $complex = new Complex($complexNumber);
 
         return [
             'real' => $complex->getReal(),
             'imaginary' => $complex->getImaginary(),
             'suffix' => $complex->getSuffix(),
         ];
     }

Field Documentation

◆ EULER

const PhpOffice\PhpSpreadsheet\Calculation\Engineering::EULER = 2.71828182845904523536

EULER.

Deprecated:: 1.18.0

See also: Use Engineering instead

Definition at line 20 of file Engineering.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Calculation/Engineering.php

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ BESSELI()

◆ BESSELJ()

◆ BESSELK()

◆ BESSELY()

◆ BINTODEC()

◆ BINTOHEX()

◆ BINTOOCT()

◆ BITAND()

◆ BITLSHIFT()

◆ BITOR()

◆ BITRSHIFT()

◆ BITXOR()

◆ COMPLEX()

◆ CONVERTUOM()

◆ DECTOBIN()

◆ DECTOHEX()

◆ DECTOOCT()

◆ DELTA()

◆ ERF()

◆ ERFC()

◆ ERFPRECISE()

◆ GESTEP()

◆ getBinaryConversionMultipliers()

◆ getConversionGroups()

◆ getConversionGroupUnitDetails()

◆ getConversionGroupUnits()

◆ getConversionMultipliers()

◆ HEXTOBIN()

◆ HEXTODEC()

◆ HEXTOOCT()

◆ IMABS()

◆ IMAGINARY()

◆ IMARGUMENT()

◆ IMCONJUGATE()

◆ IMCOS()

◆ IMCOSH()

◆ IMCOT()

◆ IMCSC()

◆ IMCSCH()

◆ IMDIV()

◆ IMEXP()

◆ IMLN()

◆ IMLOG10()

◆ IMLOG2()

◆ IMPOWER()

◆ IMPRODUCT()

◆ IMREAL()

◆ IMSEC()

◆ IMSECH()

◆ IMSIN()

◆ IMSINH()

◆ IMSQRT()

◆ IMSUB()

◆ IMSUM()

◆ IMTAN()

◆ OCTTOBIN()

◆ OCTTODEC()

◆ OCTTOHEX()

◆ parseComplex()

Field Documentation

◆ EULER