Struct ComplexFn 

pub struct ComplexFn;

Builds a complex number text value from real and imaginary coefficients.

Returns canonical text such as 3+4i or -2j.

Remarks

• real_num and i_num are numerically coerced.
• suffix may be "i", "j", empty text, or omitted; empty/omitted defaults to i.
• Any other suffix returns #VALUE!.

Examples

title: "Build with default suffix"
formula: "=COMPLEX(3,4)"
expected: "3+4i"

title: "Build with j suffix"
formula: "=COMPLEX(0,-1,\"j\")"
expected: "-j"

related:
  - IMREAL
  - IMAGINARY
  - IMSUM
faq:
  - q: "Which suffix values are valid in `COMPLEX`?"
    a: "Only suffixes i or j are accepted (empty or omitted defaults to i); other suffix strings return `#VALUE!`."

Trait Implementations

impl Debug for ComplexFn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Function for ComplexFn

[formualizer-docgen:schema:start] Name: COMPLEX Type: ComplexFn Min args: 2 Max args: variadic Variadic: true Signature: COMPLEX(arg1: any@scalar, arg2: any@scalar, arg3…: any@scalar) Arg schema: arg1{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg3{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false} Caps: PURE [formualizer-docgen:schema:end]

fn caps(&self) -> FnCaps

Capability flags for this function

fn name(&self) -> &'static str

fn min_args(&self) -> usize

fn variadic(&self) -> bool

fn arg_schema(&self) -> &'static [ArgSchema]

fn eval<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

The unified evaluation path.

fn namespace(&self) -> &'static str

fn volatile(&self) -> bool

fn aliases(&self) -> &'static [&'static str]

Optional list of additional alias names (case-insensitive) that should resolve to this function. Default: empty slice. Implementors can override to expose legacy names. Returned slice must have ’static lifetime (typically a static array reference).

fn function_salt(&self) -> u64

fn eval_reference<'a, 'b, 'c>( &self, _args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Option<Result<ReferenceType, ExcelError>>

Optional reference result path. Only called by the interpreter/engine when the callsite expects a reference (e.g., range combinators, by-ref argument positions, or spill sources).

fn dispatch<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

Dispatch to the unified evaluation path with automatic argument validation.