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

public class Imaginary extends Fixed1ArgFunction implements FreeRefFunction
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 Details

  • Constructor Details

    • Imaginary

      public Imaginary()
  • Method Details

    • evaluate

      public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval inumberVE)
      Description copied from interface: Function1Arg
      Specified by:
      evaluate in interface Function1Arg
    • evaluate

      public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)
      Specified by:
      evaluate in interface FreeRefFunction
      Parameters:
      args - the pre-evaluated arguments for this function. args is never null, 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).