EngineeringCalculator (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.EngineeringCalculator

public class EngineeringCalculator
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static boolean DEBUG

Fields
Modifier and Type	Field and Description
`static boolean`	`DEBUG`

Constructor Summary

Constructors
Constructor and Description

EngineeringCalculator()

Constructors
Constructor and Description
`EngineeringCalculator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Ptg`	`calcBin2Dec(Ptg[] operands)` BIN2DEC Converts a binary number to decimal
`protected static Ptg`	`calcBin2Hex(Ptg[] operands)` BIN2HEX Converts a binary number to hexadecimal
`protected static Ptg`	`calcBin2Oct(Ptg[] operands)` BIN2OCT Converts a binary number to octal
`protected static Ptg`	`calcComplex(Ptg[] operands)` COMPLEX Converts real and imaginary coefficients into a complex number
`protected static Ptg`	`calcConvert(Ptg[] operands)`
`protected static Ptg`	`calcDec2Bin(Ptg[] operands)` DEC2BIN Converts a decimal number to binary
`protected static Ptg`	`calcDec2Hex(Ptg[] operands)` DEC2HEX Converts a decimal number to hexadecimal
`protected static Ptg`	`calcDec2Oct(Ptg[] operands)` DEC2OCT Converts a decimal number to octal
`protected static Ptg`	`calcDelta(Ptg[] operands)` DELTA Tests whether two values are equal
`protected static Ptg`	`calcErf(Ptg[] operands)` ERF Returns the error function integrated between lower_limit and upper_limit.
`protected static Ptg`	`calcGEStep(Ptg[] operands)` GESTEP Tests whether a number is greater than a threshold value
`protected static Ptg`	`calcHex2Bin(Ptg[] operands)` HEX2BIN Converts a hexadecimal number to binary
`protected static Ptg`	`calcHex2Dec(Ptg[] operands)` HEX2DEC Converts a hexadecimal number to decimal
`protected static Ptg`	`calcHex2Oct(Ptg[] operands)` HEX2OCT Converts a hexadecimal number to octal
`protected static Ptg`	`calcImAbs(Ptg[] operands)` IMABS Returns the absolute value (modulus) of a complex number
`protected static Ptg`	`calcImaginary(Ptg[] operands)` IMAGINARY Returns the imaginary coefficient of a complex number
`protected static Ptg`	`calcImArgument(Ptg[] operands)` IMARGUMENT Returns the argument theta, an angle expressed in radians
`protected static Ptg`	`calcImConjugate(Ptg[] operands)` IMCONJUGATE Returns the complex conjugate of a complex number
`protected static Ptg`	`calcImCos(Ptg[] operands)` IMCOS Returns the cosine of a complex number
`protected static Ptg`	`calcImDiv(Ptg[] operands)` IMDIV Returns the quotient of two complex numbers, defined as (deep breath): (r1 + i1j)/(r2 + i2j) == ( r1r2 + i1i2 + (r2i1 - r1i2)i ) / (r2^2 + i2^2)
`protected static Ptg`	`calcImExp(Ptg[] operands)` IMEXP Returns the exponential of a complex number
`protected static Ptg`	`calcImLn(Ptg[] operands)` IMLN Returns the natural logarithm of a complex number
`protected static Ptg`	`calcImLog10(Ptg[] operands)` IMLOG10 Returns the base-10 logarithm of a complex number
`protected static Ptg`	`calcImLog2(Ptg[] operands)` IMLOG2 Returns the base-2 logarithm of a complex number
`protected static Ptg`	`calcImPower(Ptg[] operands)` IMPOWER Returns a complex number raised to any power
`protected static Ptg`	`calcImProduct(Ptg[] operands)` IMPRODUCT Returns the product of two complex numbers
`protected static Ptg`	`calcImReal(Ptg[] operands)` IMREAL Returns the real coefficient of a complex number
`protected static Ptg`	`calcImSin(Ptg[] operands)` IMSIN Returns the sine of a complex number
`protected static Ptg`	`calcImSqrt(Ptg[] operands)` IMSQRT Returns the square root of a complex number
`protected static Ptg`	`calcImSub(Ptg[] operands)` IMSUB Returns the difference of two complex numbers
`protected static Ptg`	`calcImSum(Ptg[] operands)` IMSUM Returns the sum of complex numbers
`protected static Ptg`	`calcOct2Bin(Ptg[] operands)` OCT2BIN Converts an octal number to binary
`protected static Ptg`	`calcOct2Dec(Ptg[] operands)` OCT2DEC Converts an octal number to decimal
`protected static Ptg`	`calcOct2Hex(Ptg[] operands)` OCT2HEX Converts an octal number to hexadecimal
`static double`	`erf(double x)` Calculate the error function erf.
`static double`	`erfc(double x)` Calculate the remaining error function erfc.
`static boolean`	`hasConverged(double xn, double xo, double eps, int n, int max)` Indicate if an iterative algorithm has RELATIVE converged.
`static boolean`	`hasReachedAccuracy(double xn, double xo, double eps)` Indicate if xn and xo have the relative/absolute accuracy epsilon.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEBUG
```
public static boolean DEBUG
```
- Constructor Detail
  - EngineeringCalculator
```
public EngineeringCalculator()
```
- Method Detail
  - calcBin2Dec
```
protected static Ptg calcBin2Dec(Ptg[] operands)
```
    BIN2DEC Converts a binary number to decimal
  - calcBin2Hex
```
protected static Ptg calcBin2Hex(Ptg[] operands)
```
    BIN2HEX Converts a binary number to hexadecimal
  - calcBin2Oct
```
protected static Ptg calcBin2Oct(Ptg[] operands)
```
    BIN2OCT Converts a binary number to octal
  - calcComplex
```
protected static Ptg calcComplex(Ptg[] operands)
```
    COMPLEX Converts real and imaginary coefficients into a complex number
  - calcConvert
```
protected static Ptg calcConvert(Ptg[] operands)
```
  - calcDec2Bin
```
protected static Ptg calcDec2Bin(Ptg[] operands)
```
    DEC2BIN Converts a decimal number to binary
  - calcDec2Hex
```
protected static Ptg calcDec2Hex(Ptg[] operands)
```
    DEC2HEX Converts a decimal number to hexadecimal
  - calcDec2Oct
```
protected static Ptg calcDec2Oct(Ptg[] operands)
```
    DEC2OCT Converts a decimal number to octal
  - calcDelta
```
protected static Ptg calcDelta(Ptg[] operands)
```
    DELTA Tests whether two values are equal
  - calcErf
```
protected static Ptg calcErf(Ptg[] operands)
                      throws FunctionNotSupportedException
```
    ERF Returns the error function integrated between lower_limit and upper_limit. ERF(lower_limit,upper_limit) Lower_limit is the lower bound for integrating ERF. Upper_limit is the upper bound for integrating ERF. If omitted, ERF integrates between zero and lower_limit. With a single argument ERF returns the error function, defined as erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(-t*t) dt. If two arguments are supplied, they are the lower and upper limits of the integral. NOTE: Accuracy is not always to 9 digits NOTE: Version with two parameters is NOT supported
    
    Throws:
    
    FunctionNotSupportedException
  - erf
```
public static double erf(double x)
```
    Calculate the error function erf.
    
    Parameters:
    
    x - the argument
    
    Returns:
    
    the value erf(x)
  - erfc
```
public static double erfc(double x)
```
    Calculate the remaining error function erfc.
    
    Parameters:
    
    x - the argument
    
    Returns:
    
    the value erfc(x)
  - hasConverged
```
public static boolean hasConverged(double xn,
                                   double xo,
                                   double eps,
                                   int n,
                                   int max)
```
    Indicate if an iterative algorithm has RELATIVE converged.
    Note: HasConverged throws an ArithmeticException if more than max calls have been made. Choose hasReacherAccuracy if this is not desired.
    
    Parameters:
    
    xn - the actual argument x[n]
    
    xo - the older argument x[n-1]
    
    eps - the accuracy to reach
    
    n - the actual iteration counter
    
    max - the maximal number of iterations
    
    Returns:
    
    flag indicating if accuracy is reached.
  - hasReachedAccuracy
```
public static boolean hasReachedAccuracy(double xn,
                                         double xo,
                                         double eps)
```
    Indicate if xn and xo have the relative/absolute accuracy epsilon. In case that the true value is less than one this is based on the absolute difference, otherwise on the relative difference:
```
     2*|x[n]-x[n-1]|/|x[n]+x[n-1]| < eps 
 
```
    Parameters:
    
    xn - the actual argument x[n]
    
    xo - the older argument x[n-1]
    
    eps - accuracy to reach
    
    Returns:
    
    flag indicating if accuracy is reached.
  - calcGEStep
```
protected static Ptg calcGEStep(Ptg[] operands)
```
    GESTEP Tests whether a number is greater than a threshold value
  - calcHex2Bin
```
protected static Ptg calcHex2Bin(Ptg[] operands)
```
    HEX2BIN Converts a hexadecimal number to binary
  - calcHex2Dec
```
protected static Ptg calcHex2Dec(Ptg[] operands)
```
    HEX2DEC Converts a hexadecimal number to decimal
  - calcHex2Oct
```
protected static Ptg calcHex2Oct(Ptg[] operands)
```
    HEX2OCT Converts a hexadecimal number to octal
  - calcImAbs
```
protected static Ptg calcImAbs(Ptg[] operands)
```
    IMABS Returns the absolute value (modulus) of a complex number
  - calcImaginary
```
protected static Ptg calcImaginary(Ptg[] operands)
```
    IMAGINARY Returns the imaginary coefficient of a complex number
  - calcImArgument
```
protected static Ptg calcImArgument(Ptg[] operands)
```
    IMARGUMENT Returns the argument theta, an angle expressed in radians
  - calcImConjugate
```
protected static Ptg calcImConjugate(Ptg[] operands)
```
    IMCONJUGATE Returns the complex conjugate of a complex number
  - calcImCos
```
protected static Ptg calcImCos(Ptg[] operands)
```
    IMCOS Returns the cosine of a complex number
  - calcImDiv
```
protected static Ptg calcImDiv(Ptg[] operands)
```
    IMDIV Returns the quotient of two complex numbers, defined as (deep breath): (r1 + i1j)/(r2 + i2j) == ( r1r2 + i1i2 + (r2i1 - r1i2)i ) / (r2^2 + i2^2)
  - calcImExp
```
protected static Ptg calcImExp(Ptg[] operands)
```
    IMEXP Returns the exponential of a complex number
  - calcImLn
```
protected static Ptg calcImLn(Ptg[] operands)
```
    IMLN Returns the natural logarithm of a complex number
  - calcImLog10
```
protected static Ptg calcImLog10(Ptg[] operands)
```
    IMLOG10 Returns the base-10 logarithm of a complex number
  - calcImLog2
```
protected static Ptg calcImLog2(Ptg[] operands)
```
    IMLOG2 Returns the base-2 logarithm of a complex number
  - calcImPower
```
protected static Ptg calcImPower(Ptg[] operands)
```
    IMPOWER Returns a complex number raised to any power
  - calcImProduct
```
protected static Ptg calcImProduct(Ptg[] operands)
```
    IMPRODUCT Returns the product of two complex numbers
  - calcImReal
```
protected static Ptg calcImReal(Ptg[] operands)
```
    IMREAL Returns the real coefficient of a complex number
  - calcImSin
```
protected static Ptg calcImSin(Ptg[] operands)
```
    IMSIN Returns the sine of a complex number
  - calcImSqrt
```
protected static Ptg calcImSqrt(Ptg[] operands)
```
    IMSQRT Returns the square root of a complex number
  - calcImSub
```
protected static Ptg calcImSub(Ptg[] operands)
```
    IMSUB Returns the difference of two complex numbers
  - calcImSum
```
protected static Ptg calcImSum(Ptg[] operands)
```
    IMSUM Returns the sum of complex numbers
  - calcOct2Bin
```
protected static Ptg calcOct2Bin(Ptg[] operands)
```
    OCT2BIN Converts an octal number to binary
  - calcOct2Dec
```
protected static Ptg calcOct2Dec(Ptg[] operands)
```
    OCT2DEC Converts an octal number to decimal
  - calcOct2Hex
```
protected static Ptg calcOct2Hex(Ptg[] operands)
```
    OCT2HEX Converts an octal number to hexadecimal

Class EngineeringCalculator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

Constructor Detail

EngineeringCalculator

Method Detail

calcBin2Dec

calcBin2Hex

calcBin2Oct

calcComplex

calcConvert

calcDec2Bin

calcDec2Hex

calcDec2Oct

calcDelta

calcErf

erf

erfc

hasConverged

hasReachedAccuracy

calcGEStep

calcHex2Bin

calcHex2Dec

calcHex2Oct

calcImAbs

calcImaginary

calcImArgument

calcImConjugate

calcImCos

calcImDiv

calcImExp

calcImLn

calcImLog10

calcImLog2

calcImPower

calcImProduct

calcImReal

calcImSin

calcImSqrt

calcImSub

calcImSum

calcOct2Bin

calcOct2Dec

calcOct2Hex