Struct SignFn 

pub struct SignFn;

Trait Implementations

impl Debug for SignFn

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

Formats the value using the given formatter.

impl Function for SignFn

Returns the sign of a number as -1, 0, or 1.

Remarks

• Returns 1 for positive numbers.
• Returns -1 for negative numbers.
• Returns 0 when input is zero.

Examples

title: "Positive input"
formula: "=SIGN(12)"
expected: 1

title: "Negative input"
formula: "=SIGN(-12)"
expected: -1

related:
  - ABS
  - INT
  - IF
faq:
  - q: "Can SIGN return anything other than -1, 0, or 1?"
    a: "No. After numeric coercion, the output is always exactly -1, 0, or 1."

[formualizer-docgen:schema:start] Name: SIGN Type: SignFn Min args: 1 Max args: 1 Variadic: false Signature: SIGN(arg1: number@scalar) Arg schema: arg1{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberLenientText,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>], _: &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.