Struct SumFn 

pub struct SumFn;

Trait Implementations

impl Debug for SumFn

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

Formats the value using the given formatter.

impl Function for SumFn

Adds numeric values across scalars and ranges.

SUM evaluates all arguments, coercing text to numbers where possible, and returns the total. Blank cells and logical values in ranges are ignored.

Remarks

• If any argument evaluates to an error, SUM propagates the first error it encounters.
• Unparseable text literals (e.g., "foo") will result in a #VALUE! error.

Examples

title: "Basic scalar addition"
formula: "=SUM(10, 20, 5)"
expected: 35

title: "Summing a range"
grid:
  A1: 10
  A2: 20
  A3: "N/A"
formula: "=SUM(A1:A3)"
expected: 30

related:
  - SUMIF
  - SUMIFS
  - SUMPRODUCT
  - AVERAGE
faq:
  - q: "Why does SUM return #VALUE! for some text arguments?"
    a: "Direct scalar text that cannot be parsed as a number raises #VALUE! during coercion."
  - q: "Do text and logical values inside ranges get added?"
    a: "No. In ranged inputs, only numeric cells contribute to the total."

[formualizer-docgen:schema:start] Name: SUM Type: SumFn Min args: 0 Max args: variadic Variadic: true Signature: SUM(arg1…: number@range) Arg schema: arg1{kinds=number,required=true,shape=range,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=false} Caps: PURE, REDUCTION, NUMERIC_ONLY, STREAM_OK, PARALLEL_ARGS [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>], ctx: &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.