Struct RandArrayFn 

pub struct RandArrayFn;

Trait Implementations

impl Debug for RandArrayFn

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

Formats the value using the given formatter.

impl Function for RandArrayFn

Generates a random spilled array of numbers.

RANDARRAY can return decimal values or whole numbers in a specified range.

Remarks

• Defaults: rows=1, columns=1, min=0, max=1, whole_number=FALSE.
• The function is non-deterministic and recalculates to new values.
• For whole numbers, values are generated in an inclusive integer range.
• rows <= 0, columns <= 0, or invalid integer bounds return #VALUE!.

Examples

title: "Generate a 2x3 decimal matrix"
formula: '=RANDARRAY(2,3)'
expected: "2x3 array of decimals in [0,1)"

title: "Generate six integer dice rolls"
formula: '=RANDARRAY(6,1,1,6,TRUE)'
expected: "6x1 array of integers from 1 to 6"

related:
  - SEQUENCE
  - SORT
  - UNIQUE
faq:
  - q: "Are RANDARRAY bounds inclusive?"
    a: "In whole_number mode, min and max are inclusive integer bounds; in decimal mode values are generated over the numeric interval from min toward max."
  - q: "Why does RANDARRAY recalculate on every recalc pass?"
    a: "RANDARRAY is volatile and non-deterministic by design, so its spilled results are regenerated each evaluation."

[formualizer-docgen:schema:start] Name: RANDARRAY Type: RandArrayFn Min args: 0 Max args: variadic Variadic: true Signature: RANDARRAY(arg1?: number@scalar, arg2?: number@scalar, arg3?: number@scalar, arg4?: number@scalar, arg5?…: logical@scalar) Arg schema: arg1{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg2{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg3{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg4{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg5{kinds=logical,required=false,shape=scalar,by_ref=false,coercion=Logical,max=None,repeating=None,default=true} Caps: none [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.