Struct FloorFn 

pub struct FloorFn;

Trait Implementations

impl Debug for FloorFn

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

Formats the value using the given formatter.

impl Function for FloorFn

Rounds a number down to the nearest multiple of a significance.

This implementation defaults significance to 1 and normalizes negative significance to positive.

Remarks

• If significance is omitted, 1 is used.
• significance = 0 returns #DIV/0!.
• Negative significance is treated as its absolute value in this fallback behavior.

Examples

title: "Round down to the nearest multiple"
formula: "=FLOOR(5.9,2)"
expected: 4

title: "Round a negative number to a lower multiple"
formula: "=FLOOR(-5.9,2)"
expected: -6

related:
  - FLOOR.MATH
  - CEILING
  - ROUNDDOWN
faq:
  - q: "Why does FLOOR move negative values farther from zero?"
    a: "FLOOR rounds down to a lower multiple, which is more negative for negative inputs."

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