Enum Function

Source
pub enum Function {
    OneD(_Function1D),
    TwoD(_Function2D),
    ThreeD(_Function3D),
}
Expand description

Functions of one, two and three variables

§Function

Functions can be created using the f! macro, and you can evaluate them like any rust function with the corresponding number of arguments, all of them f64’s.
As a bonus, you can also evaluate an n-sized Vector in an n-variable function, and it will work as intended.
They also save their expression as a string, which you can obtain as f.expression().
You can use the ddx!, ddy! and ddz! macros to take its derivative at a specific point, and use the integral! macro to evaluate its integral.
For taking its limit you can use the limit! macro, which returns a number.
Finally, you can make a VectorFunction out of a two or three-dimensional function using the grad! macro, which returns the gradient vector function.
Functions can also be cloned. Note: You may get a syntax error for using a Function as a function, but it will compile correctly.

§Examples

use vector_calculus::*;
let f:Function = f!(x, y, x*y); // Two variable function
let g:Function = f!(x, x.powi(2)); // Single variable function
assert_eq!(f(1., 2.), 2.);
assert_eq!(g(4.), 16.0);

Variants§

§

OneD(_Function1D)

§

TwoD(_Function2D)

§

ThreeD(_Function3D)

Implementations§

Source§

impl Function

Source

pub fn expression(&self) -> String

Returns the expression of a Function as a string

Trait Implementations§

Source§

impl Clone for Function

Source§

fn clone(&self) -> Function

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Fn(Vector) for Function

Source§

extern "rust-call" fn call(&self, args: (Vector,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl Fn(f64) for Function

Source§

extern "rust-call" fn call(&self, args: (f64,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl Fn(f64, f64) for Function

Source§

extern "rust-call" fn call(&self, args: (f64, f64)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl Fn(f64, f64, f64) for Function

Source§

extern "rust-call" fn call( &self, args: (f64, f64, f64), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnMut(Vector) for Function

Source§

extern "rust-call" fn call_mut( &mut self, args: (Vector,), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnMut(f64) for Function

Source§

extern "rust-call" fn call_mut( &mut self, args: (f64,), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnMut(f64, f64) for Function

Source§

extern "rust-call" fn call_mut( &mut self, args: (f64, f64), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnMut(f64, f64, f64) for Function

Source§

extern "rust-call" fn call_mut( &mut self, args: (f64, f64, f64), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnOnce(Vector) for Function

Source§

type Output = f64

The returned type after the call operator is used.
Source§

extern "rust-call" fn call_once(self, args: (Vector,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnOnce(f64) for Function

Source§

type Output = f64

The returned type after the call operator is used.
Source§

extern "rust-call" fn call_once(self, args: (f64,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnOnce(f64, f64) for Function

Source§

type Output = f64

The returned type after the call operator is used.
Source§

extern "rust-call" fn call_once( self, args: (f64, f64), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.
Source§

impl FnOnce(f64, f64, f64) for Function

Source§

type Output = f64

The returned type after the call operator is used.
Source§

extern "rust-call" fn call_once( self, args: (f64, f64, f64), ) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)
Performs the call operation.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V