Struct FloorMathFn 

pub struct FloorMathFn;

Trait Implementations

impl Debug for FloorMathFn

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

Formats the value using the given formatter.

impl Function for FloorMathFn

Rounds a number down to the nearest integer or multiple using FLOOR.MATH rules.

Remarks

• If significance is omitted (or passed as 0), the function uses 1.
• significance is treated as a positive magnitude.
• For negative numbers, non-zero mode rounds toward zero; otherwise it rounds away from zero.

Examples

title: "Default behavior for a positive number"
formula: "=FLOOR.MATH(24.3,5)"
expected: 20

title: "Use mode to round a negative number toward zero"
formula: "=FLOOR.MATH(-24.3,5,1)"
expected: -20

related:
  - FLOOR
  - CEILING.MATH
  - ROUNDDOWN
faq:
  - q: "How does mode affect negative numbers in FLOOR.MATH?"
    a: "With non-zero mode, negatives round toward zero; otherwise they round away from zero."

[formualizer-docgen:schema:start] Name: FLOOR.MATH Type: FloorMathFn Min args: 1 Max args: variadic Variadic: true Signature: FLOOR.MATH(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.