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

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.

Field Summary

Modifier and Type	Field and Description
public static final FreeRefFunction	instance

Access	Constructor and Description
public	ImReal()

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

instance	back to summary
public static final FreeRefFunction instance

ImReal	back to summary
public ImReal()

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.