pub struct FrequencyFn;Expand description
Returns a vertical frequency distribution for numeric data across bin cutoffs.
FREQUENCY counts values into <= first bin, intermediate right-closed bins, and an overflow
bucket above the final bin.
§Remarks
- Returns an array with
bins + 1rows. - Bins are sorted before counting.
- If
bins_arrayhas no numeric values, result is a single count of all data points. - Non-numeric values in input ranges are ignored by statistical-collection rules.
§Examples
title: "Frequency buckets with two bins"
formula: "=FREQUENCY({1,2,3,4,5},{2,4})"
expected:
- [2]
- [2]
- [1]title: "Frequency with repeated values"
formula: "=FREQUENCY({1,1,2,2,3},{1,2})"
expected:
- [2]
- [2]
- [1]Trait Implementations§
Source§impl Debug for FrequencyFn
impl Debug for FrequencyFn
Source§impl Function for FrequencyFn
[formualizer-docgen:schema:start]
Name: FREQUENCY
Type: FrequencyFn
Min args: 2
Max args: 1
Variadic: false
Signature: FREQUENCY(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, NUMERIC_ONLY
[formualizer-docgen:schema:end]
impl Function for FrequencyFn
[formualizer-docgen:schema:start] Name: FREQUENCY Type: FrequencyFn Min args: 2 Max args: 1 Variadic: false Signature: FREQUENCY(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, NUMERIC_ONLY [formualizer-docgen:schema:end]
fn name(&self) -> &'static str
fn min_args(&self) -> usize
fn variadic(&self) -> bool
fn arg_schema(&self) -> &'static [ArgSchema]
Source§fn eval<'a, 'b, 'c>(
&self,
args: &'c [ArgumentHandle<'a, 'b>],
_ctx: &dyn FunctionContext<'b>,
) -> Result<CalcValue<'b>, ExcelError>
fn eval<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>
The unified evaluation path. Read more
fn namespace(&self) -> &'static str
fn volatile(&self) -> bool
Source§fn aliases(&self) -> &'static [&'static str]
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
Source§fn eval_reference<'a, 'b, 'c>(
&self,
_args: &'c [ArgumentHandle<'a, 'b>],
_ctx: &dyn FunctionContext<'b>,
) -> Option<Result<ReferenceType, ExcelError>>
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). Read more
Source§fn dispatch<'a, 'b, 'c>(
&self,
args: &'c [ArgumentHandle<'a, 'b>],
ctx: &dyn FunctionContext<'b>,
) -> Result<CalcValue<'b>, ExcelError>
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.
Auto Trait Implementations§
impl Freeze for FrequencyFn
impl RefUnwindSafe for FrequencyFn
impl Send for FrequencyFn
impl Sync for FrequencyFn
impl Unpin for FrequencyFn
impl UnsafeUnpin for FrequencyFn
impl UnwindSafe for FrequencyFn
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more