Docs For Class PHPExcel_Calculation_Engineering

PHPExcel_Calculation

# Class: PHPExcel_Calculation_Engineering

Source Location: /PHPExcel/Calculation/Engineering.php

### Class Overview

PHPExcel_Calculation_Engineering

#### Author(s):

#### Copyright:

- Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

### Methods

- BESSELI
- BESSELJ
- BESSELK
- BESSELY
- BINTODEC
- BINTOHEX
- BINTOOCT
- COMPLEX
- CONVERTUOM
- DECTOBIN
- DECTOHEX
- DECTOOCT
- DELTA
- ERF
- ERFC
- GESTEP
- getConversionGroups
- getConversionGroupUnitDetails
- getConversionGroupUnits
- getConversionMultipliers
- HEXTOBIN
- HEXTODEC
- HEXTOOCT
- IMABS
- IMAGINARY
- IMARGUMENT
- IMCONJUGATE
- IMCOS
- IMDIV
- IMEXP
- IMLN
- IMLOG2
- IMLOG10
- IMPOWER
- IMPRODUCT
- IMREAL
- IMSIN
- IMSQRT
- IMSUB
- IMSUM
- OCTTOBIN
- OCTTODEC
- OCTTOHEX
- _erfVal
- _parseComplex

### Class Details

[line 50]
PHPExcel_Calculation_Engineering

#### Tags:

copyright: | Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel)

[ Top ]

### Class Methods

### static method BESSELI [line 751]

`static int BESSELI( float $x, float $n)`

BESSELI

Returns the modified Bessel function, which is equivalent to the Bessel function evaluated for purely imaginary arguments

#### Tags:

access: | public

#### Parameters:

float | $x |
float | $n |

[ Top ]

### static method BESSELJ [line 794]

`static int BESSELJ( float $x, float $n)`

BESSELJ

Returns the Bessel function

#### Tags:

access: | public

#### Parameters:

float | $x |
float | $n |

[ Top ]

### static method BESSELK [line 873]

`static float BESSELK( float $x, float $ord)`

BESSELK

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

#### Tags:

access: | public

#### Parameters:

float | $x |
float | $ord |

[ Top ]

### static method BESSELY [line 951]

`static int BESSELY( float $x, $ord, float $n)`

BESSELY

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

#### Tags:

access: | public

#### Parameters:

float | $x |
float | $n |
| $ord |

[ Top ]

### static method BINTODEC [line 988]

`static string BINTODEC( string $x)`

BINTODEC

Return a binary value as Decimal.

#### Tags:

access: | public

#### Parameters:

string | $x |

[ Top ]

### static method BINTOHEX [line 1024]

`static string BINTOHEX( string $x, [ $places = null])`

BINTOHEX

Return a binary value as Hex.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method BINTOOCT [line 1062]

`static string BINTOOCT( string $x, [ $places = null])`

BINTOOCT

Return a binary value as Octal.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method COMPLEX [line 1350]

`static string COMPLEX( [float $realNumber = 0.0], [float $imaginary = 0.0], [string $suffix = 'i'])`

COMPLEX

returns a complex number of the form x + yi or x + yj.

#### Tags:

access: | public

#### Parameters:

float | $realNumber |
float | $imaginary |
string | $suffix |

[ Top ]

### static method CONVERTUOM [line 2092]

`static float CONVERTUOM( float $value, string $fromUOM, string $toUOM)`

CONVERTUOM

#### Tags:

access: | public

#### Parameters:

float | $value |
string | $fromUOM |
string | $toUOM |

[ Top ]

### static method DECTOBIN [line 1100]

`static string DECTOBIN( string $x, [ $places = null])`

DECTOBIN

Return an octal value as binary.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method DECTOHEX [line 1136]

`static string DECTOHEX( string $x, [ $places = null])`

DECTOHEX

Return an octal value as binary.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method DECTOOCT [line 1170]

`static string DECTOOCT( string $x, [ $places = null])`

DECTOOCT

Return an octal value as binary.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method DELTA [line 1889]

`static int DELTA( float $a, [float $b = 0])`

DELTA

Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.

#### Tags:

access: | public

#### Parameters:

float | $a |
float | $b |

[ Top ]

### static method ERF [line 1951]

`static int ERF( float $lower, [float $upper = null])`

ERF

Returns the error function integrated between lower_limit and upper_limit

#### Tags:

access: | public

#### Parameters:

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

[ Top ]

### static method ERFC [line 2013]

`static int ERFC( float $x)`

ERFC

Returns the complementary ERF function integrated between x and infinity

#### Tags:

access: | public

#### Parameters:

float | $x | The lower bound for integrating ERF

[ Top ]

### static method GESTEP [line 1906]

`static int GESTEP( float $number, [float $step = 0])`

GESTEP

Returns 1 if number = step; returns 0 (zero) otherwise

#### Tags:

access: | public

#### Parameters:

float | $number |
float | $step |

[ Top ]

### static method getConversionGroups [line 2031]

`static array getConversionGroups( )`

getConversionGroups

#### Tags:

access: | public

[ Top ]

### static method getConversionGroupUnitDetails [line 2061]

`static array getConversionGroupUnitDetails( [ $group = NULL])`

getConversionGroupUnitDetails

#### Tags:

access: | public

#### Parameters:

| $group |

[ Top ]

### static method getConversionGroupUnits [line 2045]

`static array getConversionGroupUnits( [ $group = NULL])`

getConversionGroupUnits

#### Tags:

access: | public

#### Parameters:

| $group |

[ Top ]

### static method getConversionMultipliers [line 2079]

`static array getConversionMultipliers( )`

getConversionGroups

#### Tags:

access: | public

[ Top ]

### static method HEXTOBIN [line 1204]

`static string HEXTOBIN( string $x, [ $places = null])`

HEXTOBIN

Return a hex value as binary.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method HEXTODEC [line 1229]

`static string HEXTODEC( string $x)`

HEXTODEC

Return a hex value as octal.

#### Tags:

access: | public

#### Parameters:

string | $x |

[ Top ]

### static method HEXTOOCT [line 1251]

`static string HEXTOOCT( string $x, [ $places = null])`

HEXTOOCT

Return a hex value as octal.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method IMABS [line 1428]

`static real IMABS( string $complexNumber)`

IMABS

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMAGINARY [line 1390]

`static real IMAGINARY( string $complexNumber)`

IMAGINARY

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMARGUMENT [line 1447]

`static string IMARGUMENT( string $complexNumber)`

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.

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMCONJUGATE [line 1481]

`static string IMCONJUGATE( string $complexNumber)`

IMCONJUGATE

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMCOS [line 1506]

`static string IMCOS( string $complexNumber)`

IMCOS

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMDIV [line 1733]

`static real IMDIV( string $complexDividend, string $complexDivisor)`

IMDIV

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

#### Tags:

access: | public

#### Parameters:

string | $complexDividend |
string | $complexDivisor |

[ Top ]

### static method IMEXP [line 1666]

`static string IMEXP( string $complexNumber)`

IMEXP

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMLN [line 1583]

`static string IMLN( string $complexNumber)`

IMLN

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMLOG2 [line 1640]

`static string IMLOG2( string $complexNumber)`

IMLOG2

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMLOG10 [line 1614]

`static string IMLOG10( string $complexNumber)`

IMLOG10

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMPOWER [line 1698]

`static string IMPOWER( string $complexNumber, $realNumber)`

IMPOWER

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |
| $realNumber |

[ Top ]

### static method IMPRODUCT [line 1853]

`static real IMPRODUCT( array 0)`

IMPRODUCT

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

#### Tags:

access: | public

#### Parameters:

array | 0 | of mixed Data Series

[ Top ]

### static method IMREAL [line 1409]

`static real IMREAL( string $complexNumber)`

IMREAL

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMSIN [line 1530]

`static string IMSIN( string $complexNumber)`

IMSIN

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMSQRT [line 1554]

`static string IMSQRT( string $complexNumber)`

IMSQRT

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber |

[ Top ]

### static method IMSUB [line 1781]

`static real IMSUB( string $complexNumber1, string $complexNumber2)`

IMSUB

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

#### Tags:

access: | public

#### Parameters:

string | $complexNumber1 |
string | $complexNumber2 |

[ Top ]

### static method IMSUM [line 1817]

`static real IMSUM( array 0)`

IMSUM

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

#### Tags:

access: | public

#### Parameters:

array | 0 | of mixed Data Series

[ Top ]

### static method OCTTOBIN [line 1276]

`static string OCTTOBIN( string $x, [ $places = null])`

OCTTOBIN

Return an octal value as binary.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method OCTTODEC [line 1301]

`static string OCTTODEC( string $x)`

OCTTODEC

Return an octal value as binary.

#### Tags:

access: | public

#### Parameters:

string | $x |

[ Top ]

### static method OCTTOHEX [line 1323]

`static string OCTTOHEX( string $x, [ $places = null])`

OCTTOHEX

Return an octal value as hex.

#### Tags:

access: | public

#### Parameters:

string | $x |
| $places |

[ Top ]

### static method _erfVal [line 1919]

`static void _erfVal( $x)`

#### Tags:

access: | public

#### Parameters:

| $x |

[ Top ]

### static method _parseComplex [line 673]

`static void _parseComplex( $complexNumber)`

#### Tags:

access: | public

#### Parameters:

| $complexNumber |

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:30:31 -0800 by phpDocumentor 1.4.3