Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.functions.NumericFunction

Modifier and Type	Class and Description
private static interface	NumericFunction.OneDoubleIf
private static interface	NumericFunction.TwoDoubleIf

Field Summary

Modifier and Type	Field and Description
public static final Function	ABS
public static final Function	ACOS
public static final Function	ACOSH
public static final Function	ASIN
public static final Function	ASINH
public static final Function	ATAN
public static final Function	ATAN2
public static final Function	ATANH
public static final Function	CEILING
public static final Function	COMBIN
public static final Function	COS
public static final Function	COSH
public static final Function	DEGREES
public static final Function	DOLLAR
public static final Function	EVEN
public static final Function	EXP
public static final Function	FACT
public static final Function	FLOOR
public static final Function	INT
public static final Function	LN
public static final Function	LOG
public static final Function	LOG10
private static final double	LOG_10_TO_BASE_e
public static final Function	MOD
public static final Function	ODD
private static final long	PARITY_MASK
public static final Function	PI
pack-priv static final NumberEval	PI_EVAL
public static final Function	POISSON
public static final Function	POWER
public static final Function	RADIANS
public static final Function	RAND
public static final Function	ROUND
public static final Function	ROUNDDOWN
public static final Function	ROUNDUP
public static final Function	SIGN
public static final Function	SIN
public static final Function	SINH
public static final Function	SQRT
public static final Function	TAN
public static final Function	TANH
private static final double	TEN
public static final Function	TRUNC
private static final double	ZERO

Constructor Summary

Access	Constructor and Description
public	NumericFunction()

Method Summary

Modifier and Type	Method and Description
public static void	checkValue(double result)
protected abstract double	eval(ValueEval[] args, int srcCellRow, int srcCellCol)
public final ValueEval	evaluate(ValueEval[] the evaluated function arguments. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null`. args, int row index of the cell containing the formula under evaluation srcCellRow, int column index of the cell containing the formula under evaluation srcCellCol) Implements org.apache.poi.ss.formula.functions.Function.evaluate.
private static ValueEval	evaluateDollar(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
private static double	evaluateEven(double d)
private static double	evaluateOdd(double d)
private static ValueEval	evaluatePI(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
private static ValueEval	evaluateRand(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
private static ValueEval	evaluateTrunc(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
private static Function	oneDouble(NumericFunction.OneDoubleIf doubleFun)
protected static double	singleOperandEvaluate(ValueEval arg, int srcRowIndex, int srcColumnIndex)
private static Function	twoDouble(NumericFunction.TwoDoubleIf doubleFun)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ABS	back to summary
public static final Function ABS

ACOS	back to summary
public static final Function ACOS

ACOSH	back to summary
public static final Function ACOSH

ASIN	back to summary
public static final Function ASIN

ASINH	back to summary
public static final Function ASINH

ATAN	back to summary
public static final Function ATAN

ATAN2	back to summary
public static final Function ATAN2

ATANH	back to summary
public static final Function ATANH

CEILING	back to summary
public static final Function CEILING

COMBIN	back to summary
public static final Function COMBIN

COS	back to summary
public static final Function COS

COSH	back to summary
public static final Function COSH

DEGREES	back to summary
public static final Function DEGREES

DOLLAR	back to summary
public static final Function DOLLAR

EVEN	back to summary
public static final Function EVEN

EXP	back to summary
public static final Function EXP

FACT	back to summary
public static final Function FACT

FLOOR	back to summary
public static final Function FLOOR

INT	back to summary
public static final Function INT

LN	back to summary
public static final Function LN

LOG	back to summary
public static final Function LOG

LOG10	back to summary
public static final Function LOG10

LOG_10_TO_BASE_e	back to summary
private static final double LOG_10_TO_BASE_e

MOD	back to summary
public static final Function MOD

ODD	back to summary
public static final Function ODD

PARITY_MASK	back to summary
private static final long PARITY_MASK

PI	back to summary
public static final Function PI

PI_EVAL	back to summary
pack-priv static final NumberEval PI_EVAL

POISSON	back to summary
public static final Function POISSON

POWER	back to summary
public static final Function POWER

RADIANS	back to summary
public static final Function RADIANS

RAND	back to summary
public static final Function RAND

ROUND	back to summary
public static final Function ROUND

ROUNDDOWN	back to summary
public static final Function ROUNDDOWN

ROUNDUP	back to summary
public static final Function ROUNDUP

SIGN	back to summary
public static final Function SIGN

SIN	back to summary
public static final Function SIN

SINH	back to summary
public static final Function SINH

SQRT	back to summary
public static final Function SQRT

TAN	back to summary
public static final Function TAN

TANH	back to summary
public static final Function TANH

TEN	back to summary
private static final double TEN

TRUNC	back to summary
public static final Function TRUNC

ZERO	back to summary
private static final double ZERO

Constructor Detail

NumericFunction	back to summary
public NumericFunction()

Method Detail

checkValue	back to summary
public static void checkValue(double result) throws EvaluationException Exceptions EvaluationException: (#NUM!) if `result` is `NaN` or `Infinity`

eval	back to summary
protected abstract double eval(ValueEval[] args, int srcCellRow, int srcCellCol) throws EvaluationException

evaluate back to summary

public final ValueEval evaluate(ValueEval[] args, int srcCellRow, int srcCellCol)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Parameters

args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcCellRow:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

row index of the cell containing the formula under evaluation

srcCellCol:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

The evaluated result, possibly an ErrorEval, never null

Note

- Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double#NaN be sure to translate the result to ErrorEval#NUM_ERROR.

Annotations

@Override

evaluateDollar	back to summary
private static ValueEval evaluateDollar(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

evaluateEven	back to summary
private static double evaluateEven(double d)

evaluateOdd	back to summary
private static double evaluateOdd(double d)

evaluatePI	back to summary
private static ValueEval evaluatePI(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

evaluateRand	back to summary
private static ValueEval evaluateRand(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

evaluateTrunc	back to summary
private static ValueEval evaluateTrunc(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

oneDouble	back to summary
private static Function oneDouble(NumericFunction.OneDoubleIf doubleFun)

singleOperandEvaluate	back to summary
protected static double singleOperandEvaluate(ValueEval arg, int srcRowIndex, int srcColumnIndex) throws EvaluationException

twoDouble	back to summary
private static Function twoDouble(NumericFunction.TwoDoubleIf doubleFun)

public abstract Class NumericFunction

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface NumericFunction.OneDoubleIf

Method Summary

Method Detail

private Interface NumericFunction.TwoDoubleIf

Method Summary

Method Detail