Class Complex
java.lang.Object
org.apache.poi.ss.formula.functions.Complex
- All Implemented Interfaces:
FreeRefFunction,Function,Function2Arg,Function3Arg
Implementation for Excel COMPLEX () function.
Syntax:
COMPLEX (real_num,i_num,suffix )
Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J". Using uppercase results in the #VALUE! error value. All functions that accept two or more complex numbers require that all suffixes match.
real_num The real coefficient of the complex number. If this argument is nonnumeric, this function returns the #VALUE! error value.
i_num The imaginary coefficient of the complex number. If this argument is nonnumeric, this function returns the #VALUE! error value.
suffix The suffix for the imaginary component of the complex number.
- If omitted, suffix is assumed to be "i".
- If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.
- Author:
- cedric dot walter @ gmail dot com
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final FreeRefFunctionstatic final String -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
instance
-
DEFAULT_SUFFIX
- See Also:
-
SUPPORTED_SUFFIX
- See Also:
-
-
Constructor Details
-
Complex
public Complex()
-
-
Method Details
-
evaluate
Description copied from interface:Function2Arg- Specified by:
evaluatein interfaceFunction2Arg
-
evaluate
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval real_num, ValueEval i_num, ValueEval suffix) Description copied from interface:Function3Arg- Specified by:
evaluatein interfaceFunction3Arg
-
evaluate
- Specified by:
evaluatein interfaceFreeRefFunction- Parameters:
args- the pre-evaluated arguments for this function. args is nevernull, nor are any of its elements.ec- primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.- Returns:
- never
null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).
-
evaluate
- Specified by:
evaluatein interfaceFunction- Parameters:
args- the evaluated function arguments. Empty values are represented withBlankEvalorMissingArgEval, nevernull.srcRowIndex- row index of the cell containing the formula under evaluationsrcColumnIndex- column index of the cell containing the formula under evaluation- Returns:
- The evaluated result, possibly an
ErrorEval, nevernull. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate toDouble.NaNbe sure to translate the result toErrorEval.NUM_ERROR.
-