Struct Function 

#[non_exhaustive]
pub struct Function {
    pub name: &'static str,
    pub func: FnPointer,
    pub nb_args: Option<u8>,
}

Represents a mathematical function core infos.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: &'static str

The name of the function.

func: FnPointer

The function’s implementation.

nb_args: Option<u8>

The optional number of arguments the function accepts. If None, the function is variadic.

Implementations

impl Function

pub const fn new_static( name: &'static str, func: fn(&[f64]) -> f64, nb_args: Option<u8>, ) -> Self

Creates a new Function from static function components. Note that the fn pointer must be a function that takes a slice of f64 as argument and returns a f64. So make sure to wrap your function in a closure if it doesn’t match the signature. For convenience, you can use the crate::xprs_fn! macro.

Function needs a fn taking a slice because Rust variadics are not available yet.

pub fn new_dyn<T>(name: &'static str, func: T, nb_args: Option<u8>) -> Self

where T: Fn(&[f64]) -> f64 + Send + Sync + 'static,

Creates a new Function from dynamic function components. Note that the fn pointer must be a function that takes a slice of f64 as argument and returns a f64. So make sure to wrap your function in a closure if it doesn’t match the signature. For convenience, you can use the crate::xprs_fn! macro.

Function needs a fn taking a slice because Rust variadics are not available yet.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl From<Function> for Symbol

fn from(value: Function) -> Self

Converts to this type from the input type.

impl PartialEq for Function

fn eq(&self, other: &Function) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Function

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Function