Struct ImSqrtFn 

pub struct ImSqrtFn;

Returns the principal square root of a complex number.

Computes the root in polar form and returns complex text.

Remarks

• Input is coerced to complex-number text before parsing.
• Returns the principal branch of the square root.
• Invalid complex text returns #NUM!.

Examples

title: "Square root of a negative real"
formula: "=IMSQRT(\"-4\")"
expected: "2i"

title: "Square root of a+bi"
formula: "=IMSQRT(\"3+4i\")"
expected: "2+i"

related:
  - IMPOWER
  - IMABS
  - IMARGUMENT
faq:
  - q: "Which square root does `IMSQRT` return for complex inputs?"
    a: "It returns the principal branch (half-angle polar form), matching spreadsheet-style principal-value behavior."

Trait Implementations

impl Debug for ImSqrtFn

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

Formats the value using the given formatter.

impl Function for ImSqrtFn

[formualizer-docgen:schema:start] Name: IMSQRT Type: ImSqrtFn Min args: 1 Max args: 1 Variadic: false Signature: IMSQRT(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.