org.apache.poi.ss.formula.functions

## Class ImReal

- java.lang.Object
- - org.apache.poi.ss.formula.functions.Fixed1ArgFunction
  - - org.apache.poi.ss.formula.functions.ImReal

- All Implemented Interfaces:
    FreeRefFunction, Function, Function1Arg

      public class ImReal
      extends Fixed1ArgFunction
      implements FreeRefFunction

  Implementation for Excel ImReal() function.

  Syntax:
  ImReal (Inumber)

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

  Inumber A complex number for which you want the real coefficient.

  Remarks

  - If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.
  - Use COMPLEX to convert real and imaginary coefficients into a complex number.
  Author:
    cedric dot walter @ gmail dot com

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static FreeRefFunction` | `instance`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ImReal()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `ValueEval` | `evaluate(int srcRowIndex, int srcColumnIndex, ValueEval inumberVE)` see `Function.evaluate(ValueEval[], int, int)`
    `ValueEval` | `evaluate(ValueEval[] args, OperationEvaluationContext ec)`

    - ### Methods inherited from class org.apache.poi.ss.formula.functions.Fixed1ArgFunction

      `evaluate`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### instance

          public static final FreeRefFunction instance

  - ### Constructor Detail

    - #### ImReal

          public ImReal()

  - ### Method Detail

    - #### evaluate

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

      Description copied from interface: `Function1Arg`
      see `Function.evaluate(ValueEval[], int, int)`
      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).

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.