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

Implementation for Excel IMAGINARY() function.

Syntax:
IMAGINARY (Inumber)

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

Inumber is a complex number for which you want the imaginary coefficient.

Remarks

Field Summary

Modifier and Type	Field and Description
public static final Pattern	COMPLEX_NUMBER_PATTERN
public static final int	GROUP1_REAL_SIGN
public static final String	GROUP1_REAL_SIGN_REGEX
public static final int	GROUP2_IMAGINARY_INTEGER_OR_DOUBLE
public static final String	GROUP2_REAL_INTEGER_OR_DOUBLE_REGEX
public static final int	GROUP3_IMAGINARY_SIGN
public static final String	GROUP3_IMAGINARY_SIGN_REGEX
public static final int	GROUP4_IMAGINARY_INTEGER_OR_DOUBLE
public static final String	GROUP4_IMAGINARY_INTEGER_OR_DOUBLE_REGEX
public static final String	GROUP5_IMAGINARY_GROUP_REGEX
public static final FreeRefFunction	instance

Access	Constructor and Description
public	Imaginary()

Modifier and Type	Method and Description
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval inumberVE) Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
public ValueEval	evaluate(ValueEval[] the pre-evaluated arguments for this function. args is never `null`, nor are any of its elements. args, OperationEvaluationContext primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals. ec) Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Inherited from org.apache.poi.ss.formula.functions.Fixed1ArgFunction:: evaluate

COMPLEX_NUMBER_PATTERN	back to summary
public static final Pattern COMPLEX_NUMBER_PATTERN

GROUP1_REAL_SIGN	back to summary
public static final int GROUP1_REAL_SIGN

GROUP1_REAL_SIGN_REGEX	back to summary
public static final String GROUP1_REAL_SIGN_REGEX

GROUP2_IMAGINARY_INTEGER_OR_DOUBLE	back to summary
public static final int GROUP2_IMAGINARY_INTEGER_OR_DOUBLE

GROUP2_REAL_INTEGER_OR_DOUBLE_REGEX	back to summary
public static final String GROUP2_REAL_INTEGER_OR_DOUBLE_REGEX

GROUP3_IMAGINARY_SIGN	back to summary
public static final int GROUP3_IMAGINARY_SIGN

GROUP3_IMAGINARY_SIGN_REGEX	back to summary
public static final String GROUP3_IMAGINARY_SIGN_REGEX

GROUP4_IMAGINARY_INTEGER_OR_DOUBLE	back to summary
public static final int GROUP4_IMAGINARY_INTEGER_OR_DOUBLE

GROUP4_IMAGINARY_INTEGER_OR_DOUBLE_REGEX	back to summary
public static final String GROUP4_IMAGINARY_INTEGER_OR_DOUBLE_REGEX

GROUP5_IMAGINARY_GROUP_REGEX	back to summary
public static final String GROUP5_IMAGINARY_GROUP_REGEX

instance	back to summary
public static final FreeRefFunction instance

Imaginary	back to summary
public Imaginary()

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval inumberVE) Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function1Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval inumberVE)

Annotations

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. Parameters args:ValueEval[] Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. the pre-evaluated arguments for this function. args is never `null`, nor are any of its elements. ec:OperationEvaluationContext Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals. Returns:ValueEval Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. never `null`. Possibly an instance of `ErrorEval` in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors). Annotations @Override

Parameters

args:ValueEval[]

the pre-evaluated arguments for this function. args is never null, nor are any of its elements.