Struct F2D

pub struct F2D(/* private fields */);

Representation of a 2D function

Implementations

impl F2D

pub fn derive(&self, var: char, order: usize) -> Self

Computes the nth-derivative

use ruut_functions::{f2d,F2D};
assert_eq!(f2d!("x+y^2").derive('y', 2), f2d!("2"));

pub fn gradient(&self) -> Vec<Self>

Computes the gradient

use ruut_functions::{f2d, F2D};
assert_eq!(f2d!("x+y^2").gradient(), vec![f2d!("1"), f2d!("2y")]);

pub fn hessian(&self) -> Vec<Vec<Self>>

Computes the hessian matrix

use ruut_functions::{f2d, F2D};
let f = f2d!("x^3+y^2");
let hessian = f.hessian();
assert_eq!(hessian, vec![vec![f2d!("6x"), f2d!("0")],
                         vec![f2d!("0"), f2d!("2")]]);

impl F2D

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

Evaluates function at (x,y)

impl F2D

pub fn set_par(&mut self, name: &str, val: f64)

Set param value by name

use ruut_functions::{f2d, F2D};

let mut f = f2d!("x+y[a]^2"); // Default value of param in 0
f.set_par("a", 6.9);
assert!(f.eval(4.20, 1.0) - 51.81 < 0.0001);
f.set_par("a", 1.2);
assert!(f.eval(4.20, 1.0) - 5.64 < 0.0001);

impl F2D

pub fn new(input: &str) -> Result<Self, ParsingError>

Creates a new function from a str

pub fn latex(&self) -> String

Returns a string in latex format

Trait Implementations

impl Add<F1D> for F2D

type Output = F2D

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<F2D> for F3D

type Output = F3D

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<F1D> for F2D

fn add_assign(&mut self, rhs: F1D)

Performs the += operation.

impl AddAssign<F2D> for F3D

fn add_assign(&mut self, rhs: F2D)

Performs the += operation.

impl Debug for F2D

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

Formats the value using the given formatter.

impl Display for F2D

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

Formats the value using the given formatter.

impl Div<F1D> for F2D

type Output = F2D

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<F2D> for F3D

type Output = F3D

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<F1D> for F2D

fn div_assign(&mut self, rhs: F1D)

Performs the /= operation.

impl DivAssign<F2D> for F3D

fn div_assign(&mut self, rhs: F2D)

Performs the /= operation.

impl From<F1D> for F2D

fn from(value: F1D) -> Self

Converts to this type from the input type.

impl From<F2D> for F3D

fn from(value: F2D) -> Self

Converts to this type from the input type.

impl Mul<F1D> for F2D

type Output = F2D

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<F2D> for F3D

type Output = F3D

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<F1D> for F2D

fn mul_assign(&mut self, rhs: F1D)

Performs the *= operation.

impl MulAssign<F2D> for F3D

fn mul_assign(&mut self, rhs: F2D)

Performs the *= operation.

impl PartialEq for F2D

fn eq(&self, other: &F2D) -> 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 Sub<F1D> for F2D

type Output = F2D

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<F2D> for F3D

type Output = F3D

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<F1D> for F2D

fn sub_assign(&mut self, rhs: F1D)

Performs the -= operation.

impl SubAssign<F2D> for F3D

fn sub_assign(&mut self, rhs: F2D)

Performs the -= operation.

impl StructuralPartialEq for F2D