Struct Function

pub struct Function { /* private fields */ }

Implementations

impl Function

pub fn elementary(&self) -> Elementary

Returns the Elementary absraction of the Function instance

pub fn set_function(&mut self, element: Elementary)

Sets the function to represent the provided Elementary abstraction

pub fn differentiate(&mut self)

Turns self into the derivative of self

i.e. f(x) ⟹ f’(x)

Example:

let mut function = Function::from("cosh(x)");

// take derivative
function.differentiate();
// cosh(x)' = sinh(x)
// sinh(0) = 0
assert_eq!(function.call(0.), 0.);

Do also note that differentiating a function will not simplify the result. This is to make sure that this method can never fail, but it does also mean that there are instances where the resulting derivative will return NaN for certain values.

pub fn as_taylor_expansion(&mut self, order: u8, a: f64) -> Result<(), Error>

Turns the given Function instance into a Taylor series expansion centered around the value of a.

If the conversion fails, an Error::ExpansionError is returned.

pub fn get_taylor_expansion( &self, order: u8, a: f64, ) -> Result<SeriesExpansion, Error>

Returns a Taylor expansion of the provided order of the function centered around the provided value a.

pub fn get_maclaurin_expansion( &self, order: u8, ) -> Result<SeriesExpansion, Error>

Returns a Maclaurin expansion of the provided order.

impl Function

pub fn call(&self, x: f64) -> f64

Trait Implementations

impl Add<&mut Function> for Function

type Output = Function

The resulting type after applying the + operator.

fn add(self, rhs: &mut Self) -> Self::Output

Performs the + operation.

impl Add for Function

type Output = Function

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Function

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Default for Function

fn default() -> Self

The default() method returns the unit function f(x) = x, returning the independant variable for each input value.

impl Div<&mut Function> for Function

type Output = Function

The resulting type after applying the / operator.

fn div(self, rhs: &mut Self) -> Self::Output

Performs the / operation.

impl Div for Function

type Output = Function

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign for Function

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<&SeriesExpansion> for Function

fn from(value: &SeriesExpansion) -> Self

Converts to this type from the input type.

impl<'a> From<&'a String> for Function

fn from(value: &'a String) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Function

A Function instance can be parsed from any string type using the from method.

Example:

let func = Function::from("sin(ln(x))");

assert_eq!(func.call(1.), 0.);
// ...or using the nightly feature
// assert_eq!(func(1.), 0.);

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<Elementary> for Function

fn from(value: Elementary) -> Self

Converts to this type from the input type.

impl From<SeriesExpansion> for Function

A Function instance can be obtained from a SeriesExpansion instance using the from method.

Example:

// create the Function instance
let func = Function::from("sin(x)");

// Get the SeriesExpansion
// In this instance we're creating a Taylor expansion of order 5 centered around 0
let expansion = func.get_taylor_expansion(5, 0.);

// Convert the SeriesExpansion into a Function using the from method
let func_expansion = Function::from(expansion);
// Note that this could also be done using the get_function method:
// let func_expansion = expansion.get_function()
//
// ... or using the as_taylor_expansion method to convert the original Function instance into a
// Taylor expansion without creating the SeriesExpansion instance seperatly:
// func.as_taylor_expansion()

fn from(value: SeriesExpansion) -> Self

Converts to this type from the input type.

impl From<String> for Function

fn from(value: String) -> Self

Converts to this type from the input type.

impl Integrate for Function

See Integrate for usage and examples.

fn integrate(&self) -> Integral

Method will return an instance of Integral that can be taylored to specific usecases.

fn evaluate_integral(&self, lower_bound: f64, upper_bound: f64) -> f64

Method will return the value of the definite integral of the function evaluated from the provided lower and upper bound.

impl Mul<&mut Function> for Function

type Output = Function

The resulting type after applying the * operator.

fn mul(self, rhs: &mut Self) -> Self::Output

Performs the * operation.

impl Mul for Function

type Output = Function

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign for Function

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Sub for Function

type Output = Function

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Function

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.