Struct GcdFn 

pub struct GcdFn;

Trait Implementations

impl Debug for GcdFn

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

Formats the value using the given formatter.

impl Function for GcdFn

Returns the greatest common divisor of one or more integers.

GCD truncates each argument toward zero before calculating the divisor.

Remarks

• Inputs must be between 0 and 9.99999999e9 after truncation, or #NUM! is returned.
• Negative values return #NUM!.
• Any argument error propagates immediately.

Examples

title: "Greatest common divisor of two numbers"
formula: "=GCD(24, 36)"
expected: 12

title: "Variadic and fractional arguments"
formula: "=GCD(18.9, 6, 30)"
expected: 6

title: "Negative values are invalid"
formula: "=GCD(-2, 4)"
expected: "#NUM!"

related:
  - LCM
  - MOD
  - QUOTIENT
faq:
  - q: "What happens to decimal inputs in GCD?"
    a: "Each argument is truncated toward zero before the divisor is computed."
  - q: "When does GCD return #NUM!?"
    a: "Negative values or values outside the supported bound return #NUM!."

[formualizer-docgen:schema:start] Name: GCD Type: GcdFn Min args: 1 Max args: variadic Variadic: true Signature: GCD(arg1: number@scalar, arg2…: number@scalar) Arg schema: arg1{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=false}; arg2{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 variadic(&self) -> bool

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 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.