Struct ImArgumentFn 

pub struct ImArgumentFn;

Returns the argument (angle in radians) of a complex number.

The angle is measured from the positive real axis.

Remarks

• Inputs are coerced to complex-number text before parsing.
• Returns #DIV/0! for 0+0i, where the angle is undefined.
• Invalid complex text returns #NUM!.

Examples

title: "First-quadrant angle"
formula: "=IMARGUMENT(\"1+i\")"
expected: 0.7853981633974483

title: "Negative real axis"
formula: "=IMARGUMENT(\"-1\")"
expected: 3.141592653589793

related:
  - IMABS
  - IMLN
  - IMSQRT
faq:
  - q: "Why does `IMARGUMENT(0)` return `#DIV/0!`?"
    a: "The argument (angle) of `0+0i` is undefined, so the function returns `#DIV/0!`."

Trait Implementations

impl Debug for ImArgumentFn

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

Formats the value using the given formatter.

impl Function for ImArgumentFn

[formualizer-docgen:schema:start] Name: IMARGUMENT Type: ImArgumentFn Min args: 1 Max args: 1 Variadic: false Signature: IMARGUMENT(arg1: any@scalar) Arg schema: arg1{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 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 variadic(&self) -> bool

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.