MathFunctionCalculator (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

public class MathFunctionCalculator
extends Object

Constructor Summary

Constructors
Constructor and Description

MathFunctionCalculator()

Constructors
Constructor and Description
`MathFunctionCalculator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Ptg`	`calcAbs(Ptg[] operands)` ABS Returns the absolute value of a number
`protected static Ptg`	`calcAcos(Ptg[] operands)` ACOS Returns the arccosine of a number
`protected static Ptg`	`calcAcosh(Ptg[] operands)` ACOSH Returns the inverse hyperbolic cosine of a number
`protected static Ptg`	`calcAsin(Ptg[] operands)` ASIN Returns the arcsine of a number
`protected static Ptg`	`calcAsinh(Ptg[] operands)` ASINH Returns the inverse hyperbolic sine of a number
`protected static Ptg`	`calcAtan(Ptg[] operands)` ATAN Returns the arctangent of a number
`protected static Ptg`	`calcAtan2(Ptg[] operands)` ATAN2 Returns the arctangent from x- and y- coordinates
`protected static Ptg`	`calcAtanh(Ptg[] operands)` ATANH Returns the inverse hyperbolic tangent of a number
`protected static Ptg`	`calcCeiling(Ptg[] operands)` CEILING Rounds a number to the nearest multiple of significance; This takes 2 values, first the number to round, next the value of signifigance.
`protected static Ptg`	`calcCombin(Ptg[] operands)` COMBIN Returns the number of combinations for a given number of objects
`protected static Ptg`	`calcCos(Ptg[] operands)` COS Returns the cosine of a number
`protected static Ptg`	`calcCosh(Ptg[] operands)` COSH Returns the hyperbolic cosine of a number
`protected static Ptg`	`calcDegrees(Ptg[] operands)` DEGREES Converts radians to degrees
`protected static Ptg`	`calcEven(Ptg[] operands)` EVEN Rounds a number up to the nearest even integer
`protected static Ptg`	`calcExp(Ptg[] operands)` EXP Returns e raised to the power of number.
`protected static Ptg`	`calcFact(Ptg[] operands)` FACT Returns the factorial of a number
`protected static Ptg`	`calcFactDouble(Ptg[] operands)` FACTDOUBLE Returns the double factorial of a number Example !!6 = 642 !!7 = 753*1;
`protected static Ptg`	`calcFloor(Ptg[] operands)` FLOOR Rounds a number down, toward zero.
`protected static Ptg`	`calcGCD(Ptg[] operands)` GCD Returns the greatest common divisor TODO: Finish!
`protected static Ptg`	`calcInt(Ptg[] operands)` INT Rounds a number down to the nearest integer
`protected static Ptg`	`calcLCM(Ptg[] operands)` LCM Returns the least common multiple
`protected static Ptg`	`calcLn(Ptg[] operands)` LN Returns the natural logarithm of a number
`protected static Ptg`	`calcLog(Ptg[] operands)` LOG Returns the logarithm of a number to a specified base
`protected static Ptg`	`calcLog10(Ptg[] operands)` LOG10 Returns the base-10 logarithm of a number
`protected static Ptg`	`calcMMult(Ptg[] operands)` MMULT Returns the matrix product of two arrays: The number of columns in array1 must be the same as the number of rows in array2, and both arrays must contain only numbers.
`protected static Ptg`	`calcMod(Ptg[] operands)` MOD Returns the remainder from division
`protected static Ptg`	`calcMRound(Ptg[] operands)` MROUND Returns a number rounded to the desired multiple
`protected static Ptg`	`calcMultinomial(Ptg[] operands)` MULTINOMIAL Returns the multinomial of a set of numbers
`protected static Ptg`	`calcOdd(Ptg[] operands)` ODD Rounds a number up to the nearest odd integer
`protected static Ptg`	`calcPi(Ptg[] operands)` PI Returns the value of Pi
`protected static Ptg`	`calcPower(Ptg[] operands)` POWER Returns the result of a number raised to a power
`protected static Ptg`	`calcProduct(Ptg[] operands)` PRODUCT Multiplies its arguments NOTE: we gotta deal with ranges/refs/numbers here
`protected static Ptg`	`calcQuotient(Ptg[] operands)` QUOTIENT Returns the integer portion of a division
`protected static Ptg`	`calcRadians(Ptg[] operands)` RADIANS Converts degrees to radians
`protected static Ptg`	`calcRand(Ptg[] operands)` RAND Returns a random number between 0 and 1
`protected static Ptg`	`calcRandBetween(Ptg[] operands)` RANDBETWEEN Returns a random number between the numbers you specify
`protected static Ptg`	`calcRoman(Ptg[] operands)` ROMAN Converts an Arabic numeral to Roman, as text This one is a trip!
`protected static Ptg`	`calcRound(Ptg[] operands)` ROUND Rounds a number to a specified number of digits This one is kind of nasty.
`protected static Ptg`	`calcRoundDown(Ptg[] operands)` ROUNDDOWN Rounds a number down, toward zero.
`protected static Ptg`	`calcRoundUp(Ptg[] operands)` ROUNDUP Rounds a number up, away from zero
`protected static Ptg`	`calcSign(Ptg[] operands)` SIGN Returns the sign of a number return 1 if positive, -1 if negative, or 0 if 0;
`protected static Ptg`	`calcSin(Ptg[] operands)` SIN Returns the sine of the given angle
`protected static Ptg`	`calcSinh(Ptg[] operands)` SINH Returns the hyperbolic sine of a number
`protected static Ptg`	`calcSqrt(Ptg[] operands)` SQRT Returns a positive square root
`protected static Ptg`	`calcSqrtPi(Ptg[] operands)` SQRTPI Returns the square root of (number * PI)
`protected static Ptg`	`calcSum(Ptg[] operands)` SUM Adds all the numbers in a range of cells.
`protected static Ptg`	`calcSumif(Ptg[] operands)` SUMIF Adds the cells specified by a given criteria You use the SUMIF function to sum the values in a range that meet criteria that you specify.
`protected static Ptg`	`calcSumIfS(Ptg[] operands)` SUMIFS Adds the cells in a range (range: Two or more cells on a sheet.
`protected static Ptg`	`calcSumproduct(Ptg[] operands)` SUMPRODUCT Returns the sum of the products of corresponding array components
`protected static Ptg`	`calcTan(Ptg[] operands)` TAN Returns the tangent of a number
`protected static Ptg`	`calcTanh(Ptg[] operands)` TANH Returns the hyperbolic tangent of a number
`protected static Ptg`	`calcTrunc(Ptg[] operands)` TRUNC Truncates a number to an integer
`static long`	`factorial(long n)`

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

- Constructor Detail
  - MathFunctionCalculator
```
public MathFunctionCalculator()
```
- Method Detail
  - calcSum
```
protected static Ptg calcSum(Ptg[] operands)
                      throws CalculationException
```
    SUM Adds all the numbers in a range of cells. Ignores non-number fields Usage@ SUM(number1,number2, ...) Return@ PtgNumber
    
    Throws:
    
    CalculationException
  - calcAbs
```
protected static Ptg calcAbs(Ptg[] operands)
```
    ABS Returns the absolute value of a number
  - calcAcos
```
protected static Ptg calcAcos(Ptg[] operands)
```
    ACOS Returns the arccosine of a number
  - calcAcosh
```
protected static Ptg calcAcosh(Ptg[] operands)
```
    ACOSH Returns the inverse hyperbolic cosine of a number
  - calcAsin
```
protected static Ptg calcAsin(Ptg[] operands)
```
    ASIN Returns the arcsine of a number
  - calcAsinh
```
protected static Ptg calcAsinh(Ptg[] operands)
```
    ASINH Returns the inverse hyperbolic sine of a number
  - calcAtan
```
protected static Ptg calcAtan(Ptg[] operands)
```
    ATAN Returns the arctangent of a number
  - calcAtan2
```
protected static Ptg calcAtan2(Ptg[] operands)
                        throws CalculationException
```
    ATAN2 Returns the arctangent from x- and y- coordinates
    
    Throws:
    
    CalculationException
  - calcAtanh
```
protected static Ptg calcAtanh(Ptg[] operands)
```
    ATANH Returns the inverse hyperbolic tangent of a number
  - calcCeiling
```
protected static Ptg calcCeiling(Ptg[] operands)
                          throws CalculationException
```
    CEILING Rounds a number to the nearest multiple of significance; This takes 2 values, first the number to round, next the value of signifigance. Ick. This is pretty intensive, so maybe a better way?
    
    Throws:
    
    CalculationException
  - calcCombin
```
protected static Ptg calcCombin(Ptg[] operands)
                         throws CalculationException
```
    COMBIN Returns the number of combinations for a given number of objects
    
    Throws:
    
    CalculationException
  - calcCos
```
protected static Ptg calcCos(Ptg[] operands)
```
    COS Returns the cosine of a number
  - calcCosh
```
protected static Ptg calcCosh(Ptg[] operands)
```
    COSH Returns the hyperbolic cosine of a number
  - calcDegrees
```
protected static Ptg calcDegrees(Ptg[] operands)
```
    DEGREES Converts radians to degrees
  - calcEven
```
protected static Ptg calcEven(Ptg[] operands)
```
    EVEN Rounds a number up to the nearest even integer
  - calcExp
```
protected static Ptg calcExp(Ptg[] operands)
```
    EXP Returns e raised to the power of number. The constant e equals 2.71828182845904, the base of the natural logarithm. Example EXP(2) equals e2, or 7.389056
  - calcFact
```
protected static Ptg calcFact(Ptg[] operands)
```
    FACT Returns the factorial of a number
  - calcFactDouble
```
protected static Ptg calcFactDouble(Ptg[] operands)
```
    FACTDOUBLE Returns the double factorial of a number Example !!6 = 6*4*2 !!7 = 7*5*3*1;
  - calcFloor
```
protected static Ptg calcFloor(Ptg[] operands)
                        throws CalculationException
```
    FLOOR Rounds a number down, toward zero. Works just like Celing with two operands See comment above for celing for more info.
    
    Throws:
    
    CalculationException
  - calcGCD
```
protected static Ptg calcGCD(Ptg[] operands)
```
    GCD Returns the greatest common divisor TODO: Finish!
  - calcInt
```
protected static Ptg calcInt(Ptg[] operands)
```
    INT Rounds a number down to the nearest integer
  - calcLCM
```
protected static Ptg calcLCM(Ptg[] operands)
```
    LCM Returns the least common multiple
  - calcLn
```
protected static Ptg calcLn(Ptg[] operands)
```
    LN Returns the natural logarithm of a number
  - calcLog
```
protected static Ptg calcLog(Ptg[] operands)
                      throws CalculationException
```
    LOG Returns the logarithm of a number to a specified base
    
    Throws:
    
    CalculationException
  - calcLog10
```
protected static Ptg calcLog10(Ptg[] operands)
```
    LOG10 Returns the base-10 logarithm of a number
  - calcMMult
```
protected static Ptg calcMMult(Ptg[] operands)
```
    MMULT Returns the matrix product of two arrays: The number of columns in array1 must be the same as the number of rows in array2, and both arrays must contain only numbers. MMULT returns the #VALUE! error when: Any cells are empty or contain text. The number of columns in array1 is different from the number of rows in array2.
  - calcMod
```
protected static Ptg calcMod(Ptg[] operands)
                      throws CalculationException
```
    MOD Returns the remainder from division
    
    Throws:
    
    CalculationException
  - calcMRound
```
protected static Ptg calcMRound(Ptg[] operands)
```
    MROUND Returns a number rounded to the desired multiple
  - calcMultinomial
```
protected static Ptg calcMultinomial(Ptg[] operands)
```
    MULTINOMIAL Returns the multinomial of a set of numbers
  - calcOdd
```
protected static Ptg calcOdd(Ptg[] operands)
```
    ODD Rounds a number up to the nearest odd integer
  - calcPi
```
protected static Ptg calcPi(Ptg[] operands)
```
    PI Returns the value of Pi
  - calcPower
```
protected static Ptg calcPower(Ptg[] operands)
                        throws CalculationException
```
    POWER Returns the result of a number raised to a power
    
    Throws:
    
    CalculationException
  - calcProduct
```
protected static Ptg calcProduct(Ptg[] operands)
                          throws CalculationException
```
    PRODUCT Multiplies its arguments NOTE: we gotta deal with ranges/refs/numbers here
    
    Throws:
    
    CalculationException
  - calcQuotient
```
protected static Ptg calcQuotient(Ptg[] operands)
```
    QUOTIENT Returns the integer portion of a division
  - calcRadians
```
protected static Ptg calcRadians(Ptg[] operands)
```
    RADIANS Converts degrees to radians
  - calcRand
```
protected static Ptg calcRand(Ptg[] operands)
```
    RAND Returns a random number between 0 and 1
  - calcRandBetween
```
protected static Ptg calcRandBetween(Ptg[] operands)
```
    RANDBETWEEN Returns a random number between the numbers you specify
  - calcRoman
```
protected static Ptg calcRoman(Ptg[] operands)
```
    ROMAN Converts an Arabic numeral to Roman, as text This one is a trip!
  - calcRound
```
protected static Ptg calcRound(Ptg[] operands)
                        throws CalculationException
```
    ROUND Rounds a number to a specified number of digits This one is kind of nasty. 3 cases of rounding. If the rounding is a positive integer this is the number of digits to round to. If negative, round up past the decimal, if 0, give an integer
    
    Throws:
    
    CalculationException
  - calcRoundDown
```
protected static Ptg calcRoundDown(Ptg[] operands)
                            throws CalculationException
```
    ROUNDDOWN Rounds a number down, toward zero. Acts much like round above
    
    Throws:
    
    CalculationException
  - calcRoundUp
```
protected static Ptg calcRoundUp(Ptg[] operands)
                          throws CalculationException
```
    ROUNDUP Rounds a number up, away from zero
    
    Throws:
    
    CalculationException
  - calcSign
```
protected static Ptg calcSign(Ptg[] operands)
```
    SIGN Returns the sign of a number return 1 if positive, -1 if negative, or 0 if 0;
  - calcSin
```
protected static Ptg calcSin(Ptg[] operands)
```
    SIN Returns the sine of the given angle
  - calcSinh
```
protected static Ptg calcSinh(Ptg[] operands)
```
    SINH Returns the hyperbolic sine of a number
  - calcSqrt
```
protected static Ptg calcSqrt(Ptg[] operands)
```
    SQRT Returns a positive square root
  - calcSqrtPi
```
protected static Ptg calcSqrtPi(Ptg[] operands)
```
    SQRTPI Returns the square root of (number * PI)
  - calcSumif
```
protected static Ptg calcSumif(Ptg[] operands)
```
    SUMIF Adds the cells specified by a given criteria You use the SUMIF function to sum the values in a range that meet criteria that you specify. For example, suppose that in a column that contains numbers, you want to sum only the values that are larger than 5. You can use the following formula: =SUMIF(B2:B25,">5") you can apply the criteria to one range and sum the corresponding values in a different range. For example, the formula =SUMIF(B2:B5, "John", C2:C5) sums only the values in the range C2:C5, where the corresponding cells in the range B2:B5 equal "John." range Required. The range of cells that you want evaluated by criteria. Cells in each range must be numbers or names, arrays, or references that contain numbers. Blank and text values are ignored. criteria Required. The criteria in the form of a number, expression, a cell reference, text, or a function that defines which cells will be added. For example, criteria can be expressed as 32, ">32", B5, 32, "32", "apples", or TODAY(). Important Any text criteria or any criteria that includes logical or mathematical symbols must be enclosed in double quotation marks ("). If the criteria is numeric, double quotation marks are not required. sum_range Optional. The actual cells to add, if you want to add cells other than those specified in the range argument. If the sum_range argument is omitted, Excel adds the cells that are specified in the range argument (the same cells to which the criteria is applied). The sum_range argument does not have to be the same size and shape as the range argument. The actual cells that are added are determined by using theupper leftmost cell in the sum_range argument as the beginning cell, and then including cells that correspond in size and shape to the range argument. For example:If range is And sum_range is Then the actual cells are A1:A5 B1:B5 B1:B5 A1:A5 B1:B3 B1:B5 A1:B4 C1:D4 C1:D4 A1:B4 C1:C2 C1:D4 You can use the wildcard characters — the question mark (?) and asterisk (*) — as the criteria argument. A question mark matches any single character; an asterisk matches any sequence of characters. If you want to find an actual question mark or asterisk, type a tilde (~) preceding the character.
  - calcSumIfS
```
protected static Ptg calcSumIfS(Ptg[] operands)
```
    SUMIFS Adds the cells in a range (range: Two or more cells on a sheet. The cells in a range can be adjacent or nonadjacent.) that meet multiple criteria sum_range Required. One or more cells to sum, including numbers or names, ranges, or cell references (cell reference: The set of coordinates that a cell occupies on a worksheet. For example, the reference of the cell that appears at the intersection of column B and row 3 is B3.) that contain numbers. Blank and text values are ignored. criteria_range1 Required. The first range in which to evaluate the associated criteria. criteria1 Required. The criteria in the form of a number, expression, cell reference, or text that define which cells in the criteria_range1 argument will be added. For example, criteria can be expressed as 32, ">32", B4, "apples", or "32." criteria_range2, criteria2, … Optional. Additional ranges and their associated criteria. Up to 127 range/criteria pairs are allowed.
    
    Parameters:
    
    operands -
    
    Returns:
  - calcSumproduct
```
protected static Ptg calcSumproduct(Ptg[] operands)
```
    SUMPRODUCT Returns the sum of the products of corresponding array components
  - calcTan
```
protected static Ptg calcTan(Ptg[] operands)
```
    TAN Returns the tangent of a number
  - calcTanh
```
protected static Ptg calcTanh(Ptg[] operands)
```
    TANH Returns the hyperbolic tangent of a number
  - calcTrunc
```
protected static Ptg calcTrunc(Ptg[] operands)
```
    TRUNC Truncates a number to an integer
  - factorial
```
public static long factorial(long n)
```

Class MathFunctionCalculator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MathFunctionCalculator

Method Detail

calcSum

calcAbs

calcAcos

calcAcosh

calcAsin

calcAsinh

calcAtan

calcAtan2

calcAtanh

calcCeiling

calcCombin

calcCos

calcCosh

calcDegrees

calcEven

calcExp

calcFact

calcFactDouble

calcFloor

calcGCD

calcInt

calcLCM

calcLn

calcLog

calcLog10

calcMMult

calcMod

calcMRound

calcMultinomial

calcOdd

calcPi

calcPower

calcProduct

calcQuotient

calcRadians

calcRand

calcRandBetween

calcRoman

calcRound

calcRoundDown

calcRoundUp

calcSign

calcSin

calcSinh

calcSqrt

calcSqrtPi

calcSumif

calcSumIfS

calcSumproduct

calcTan

calcTanh

calcTrunc

factorial