Class Imaginary
java.lang.Object
org.apache.poi.ss.formula.functions.Fixed1ArgFunction
org.apache.poi.ss.formula.functions.Imaginary
- All Implemented Interfaces:
FreeRefFunction
,Function
,Function1Arg
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
- Use COMPLEX to convert real and imaginary coefficients into a complex number.
- Author:
- cedric dot walter @ gmail dot com
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class org.apache.poi.ss.formula.functions.Fixed1ArgFunction
evaluate
-
Field Details
-
instance
-
GROUP1_REAL_SIGN_REGEX
- See Also:
-
GROUP2_REAL_INTEGER_OR_DOUBLE_REGEX
- See Also:
-
GROUP3_IMAGINARY_SIGN_REGEX
- See Also:
-
GROUP4_IMAGINARY_INTEGER_OR_DOUBLE_REGEX
- See Also:
-
GROUP5_IMAGINARY_GROUP_REGEX
- See Also:
-
COMPLEX_NUMBER_PATTERN
-
GROUP1_REAL_SIGN
public static final int GROUP1_REAL_SIGN- See Also:
-
GROUP2_IMAGINARY_INTEGER_OR_DOUBLE
public static final int GROUP2_IMAGINARY_INTEGER_OR_DOUBLE- See Also:
-
GROUP3_IMAGINARY_SIGN
public static final int GROUP3_IMAGINARY_SIGN- See Also:
-
GROUP4_IMAGINARY_INTEGER_OR_DOUBLE
public static final int GROUP4_IMAGINARY_INTEGER_OR_DOUBLE- See Also:
-
-
Constructor Details
-
Imaginary
public Imaginary()
-
-
Method Details
-
evaluate
Description copied from interface:Function1Arg
- Specified by:
evaluate
in interfaceFunction1Arg
-
evaluate
- Specified by:
evaluate
in 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).
-