Struct UserFunction 

pub struct UserFunction {
    pub weight: u16,
    pub name: String,
    pub description: String,
    pub body: Vec<UdfOp>,
    pub num_type: NumType,
}

A user-defined function

Fields

weight: u16

Weight (complexity) of this function

This field is part of the public API and is used when generating expressions that include user-defined functions.

name: String

Short name (single or few characters)

description: String

Description (for display)

This field is part of the public API for documentation and display purposes.

body: Vec<UdfOp>

The body of the function as a postfix expression Uses standard symbols plus special stack operations

num_type: NumType

Numeric type of result

This field is part of the public API for type inference when combining expressions that use user-defined functions.

Implementations

impl UserFunction

pub fn parse(spec: &str) -> Result<Self, String>

Parse a user-defined function from a definition string Format: “weight:name:description:formula” Example: “4:sinh:hyperbolic sine:E|r-2/”

pub fn stack_effect(&self) -> i32

Get the stack effect of this function (pushed - popped) For a unary function, this should be 0 (pop 1, push 1)

This method is part of the public API for library consumers who need to validate user-defined functions before use.

Trait Implementations

impl Clone for UserFunction

fn clone(&self) -> UserFunction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserFunction

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

Formats the value using the given formatter.