Struct Tree 

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

Owned handle for a standalone math tree

Implementations

impl Tree

pub fn axes() -> (Self, Self, Self)

Returns an (x, y, z) tuple

pub fn as_ptr(&self) -> *const TreeOp

Returns a pointer to the inner TreeOp

This can be used as a strong (but not unique) identity.

pub fn ptr_eq(&self, other: &Self) -> bool

Shallow (pointer) equality check

pub fn remap_xyz(&self, x: Tree, y: Tree, z: Tree) -> Tree

Remaps the axes of the given tree

If the mapping is affine, then remap_affine should be preferred.

The remapping is lazy; it is not evaluated until the tree is imported into a Context.

pub fn remap_affine(&self, mat: Affine3<f64>) -> Tree

Performs an affine remapping of the given tree

The remapping is lazy; it is not evaluated until the tree is imported into a Context.

pub fn var(&self) -> Option<Var>

Returns the inner Var if this is an input tree, or None

pub fn deriv(&self, v: Var) -> Tree

Performs symbolic differentiation with respect to the given variable

pub fn pow(&self, n: i64) -> Self

Raises this tree to the power of an integer using exponentiation by squaring

impl Tree

See Context for documentation of these functions

pub fn x() -> Self

pub fn y() -> Self

pub fn z() -> Self

pub fn constant(f: f64) -> Self

pub fn square(&self) -> Self

pub fn floor(&self) -> Self

pub fn ceil(&self) -> Self

pub fn round(&self) -> Self

pub fn sqrt(&self) -> Self

pub fn max<T: Into<Tree>>(&self, other: T) -> Self

pub fn min<T: Into<Tree>>(&self, other: T) -> Self

pub fn compare<T: Into<Tree>>(&self, other: T) -> Self

pub fn modulo<T: Into<Tree>>(&self, other: T) -> Self

pub fn and<T: Into<Tree>>(&self, other: T) -> Self

pub fn or<T: Into<Tree>>(&self, other: T) -> Self

pub fn atan2<T: Into<Tree>>(&self, other: T) -> Self

pub fn neg(&self) -> Self

pub fn recip(&self) -> Self

pub fn sin(&self) -> Self

pub fn cos(&self) -> Self

pub fn tan(&self) -> Self

pub fn asin(&self) -> Self

pub fn acos(&self) -> Self

pub fn atan(&self) -> Self

pub fn exp(&self) -> Self

pub fn ln(&self) -> Self

pub fn not(&self) -> Self

pub fn abs(&self) -> Self

Trait Implementations

impl<A: Into<Tree>> Add<A> for Tree

type Output = Tree

The resulting type after applying the + operator.

fn add(self, other: A) -> Self

Performs the + operation.

impl Add<Tree> for f32

type Output = Tree

The resulting type after applying the + operator.

fn add(self, other: Tree) -> Tree

Performs the + operation.

impl Add<Tree> for f64

type Output = Tree

The resulting type after applying the + operator.

fn add(self, other: Tree) -> Tree

Performs the + operation.

impl<A: Into<Tree>> AddAssign<A> for Tree

fn add_assign(&mut self, other: A)

Performs the += operation.

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl Deref for Tree

type Target = TreeOp

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<A: Into<Tree>> Div<A> for Tree

type Output = Tree

The resulting type after applying the / operator.

fn div(self, other: A) -> Self

Performs the / operation.

impl Div<Tree> for f32

type Output = Tree

The resulting type after applying the / operator.

fn div(self, other: Tree) -> Tree

Performs the / operation.

impl Div<Tree> for f64

type Output = Tree

The resulting type after applying the / operator.

fn div(self, other: Tree) -> Tree

Performs the / operation.

impl<A: Into<Tree>> DivAssign<A> for Tree

fn div_assign(&mut self, other: A)

Performs the /= operation.

impl<'__facet> Facet<'__facet> for Tree

const VTABLE: &'static ValueVTable

Function pointers to perform various operations: print the full type name (with generic type parameters), use the Display implementation, the Debug implementation, build a default value, clone, etc.

const SHAPE: &'static Shape

The shape of this type

impl<F: MathFunction> From<Tree> for Shape<F>

Converts a Tree to a Shape with the default axes

fn from(t: Tree) -> Self

Converts to this type from the input type.

impl From<TreeOp> for Tree

fn from(t: TreeOp) -> Tree

Converts to this type from the input type.

impl From<Var> for Tree

fn from(v: Var) -> Tree

Converts to this type from the input type.

impl From<f32> for Tree

fn from(v: f32) -> Tree

Converts to this type from the input type.

impl From<f64> for Tree

fn from(v: f64) -> Tree

Converts to this type from the input type.

impl From<i32> for Tree

fn from(v: i32) -> Tree

Converts to this type from the input type.

impl<A: Into<Tree>> Mul<A> for Tree

type Output = Tree

The resulting type after applying the * operator.

fn mul(self, other: A) -> Self

Performs the * operation.

impl Mul<Tree> for f32

type Output = Tree

The resulting type after applying the * operator.

fn mul(self, other: Tree) -> Tree

Performs the * operation.

impl Mul<Tree> for f64

type Output = Tree

The resulting type after applying the * operator.

fn mul(self, other: Tree) -> Tree

Performs the * operation.

impl<A: Into<Tree>> MulAssign<A> for Tree

fn mul_assign(&mut self, other: A)

Performs the *= operation.

impl Neg for Tree

type Output = Tree

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Tree

fn eq(&self, other: &Self) -> 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<A: Into<Tree>> Sub<A> for Tree

type Output = Tree

The resulting type after applying the - operator.

fn sub(self, other: A) -> Self

Performs the - operation.

impl Sub<Tree> for f32

type Output = Tree

The resulting type after applying the - operator.

fn sub(self, other: Tree) -> Tree

Performs the - operation.

impl Sub<Tree> for f64

type Output = Tree

The resulting type after applying the - operator.

fn sub(self, other: Tree) -> Tree

Performs the - operation.

impl<A: Into<Tree>> SubAssign<A> for Tree

fn sub_assign(&mut self, other: A)

Performs the -= operation.

impl TryFrom<Tree> for Var

type Error = Error

The type returned in the event of a conversion error.

fn try_from(t: Tree) -> Result<Var, Error>

Performs the conversion.

impl Eq for Tree