Struct Variable

#[repr(C)]
pub struct Variable<T> { /* private fields */ }

Implementations

impl<T> Variable<T>

pub fn new() -> Variable<T>

pub fn id(&self) -> AtomicId

pub const fn is_expression(&self) -> bool

pub const fn is_initialized(&self) -> bool

pub fn name(&self) -> &str

pub fn op(&self) -> Option<&Op>

pub fn op_mut(&mut self) -> Option<&mut Op>

pub fn value(&self) -> Option<&T>

pub fn set(&mut self, value: T)

pub fn set_op(&mut self, op: impl Into<Op>)

pub fn with_id(self, id: AtomicId) -> Variable<T>

pub fn with_name(self, name: impl ToString) -> Variable<T>

pub fn with_op(self, op: impl Into<Op>) -> Variable<T>

pub fn with_value(self, value: T) -> Variable<T>

Trait Implementations

impl<'a, T> Add<&'a Variable<T>> for Variable<T>

where T: Copy + Default + Add<Output = T>,

type Output = Variable<T>

The resulting type after applying the + operator.

fn add( self, rhs: &'a Variable<T>, ) -> <Variable<T> as Add<&'a Variable<T>>>::Output

Performs the + operation.

impl<T> Add<T> for Variable<T>

where T: Copy + Default + Add<Output = T>,

type Output = Variable<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <Variable<T> as Add<T>>::Output

Performs the + operation.

impl<'a, T> Add<Variable<T>> for &'a Variable<T>

where T: Copy + Default + Add<Output = T>,

type Output = Variable<T>

The resulting type after applying the + operator.

fn add(self, rhs: Variable<T>) -> <&'a Variable<T> as Add<Variable<T>>>::Output

Performs the + operation.

impl<'a, T> Add for &'a Variable<T>

where T: Copy + Default + Add<Output = T>,

type Output = Variable<T>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Variable<T>) -> <&'a Variable<T> as Add>::Output

Performs the + operation.

impl<T> Add for Variable<T>

where T: Copy + Default + Add<Output = T>,

type Output = Variable<T>

The resulting type after applying the + operator.

fn add(self, rhs: Variable<T>) -> <Variable<T> as Add>::Output

Performs the + operation.

impl<T> Borrow<T> for Variable<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for Variable<T>

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

Mutably borrows from an owned value.

impl<T> Clone for Variable<T>

where T: Clone,

fn clone(&self) -> Variable<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Variable<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Variable<T>

where T: Default,

fn default() -> Variable<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Variable<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Variable<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Variable<T>

where T: Display,

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

Formats the value using the given formatter.

impl<'a, T> Div<&'a Variable<T>> for Variable<T>

where T: Copy + Default + Div<Output = T>,

type Output = Variable<T>

The resulting type after applying the / operator.

fn div( self, rhs: &'a Variable<T>, ) -> <Variable<T> as Div<&'a Variable<T>>>::Output

Performs the / operation.

impl<T> Div<T> for Variable<T>

where T: Copy + Default + Div<Output = T>,

type Output = Variable<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> <Variable<T> as Div<T>>::Output

Performs the / operation.

impl<'a, T> Div<Variable<T>> for &'a Variable<T>

where T: Copy + Default + Div<Output = T>,

type Output = Variable<T>

The resulting type after applying the / operator.

fn div(self, rhs: Variable<T>) -> <&'a Variable<T> as Div<Variable<T>>>::Output

Performs the / operation.

impl<'a, T> Div for &'a Variable<T>

where T: Copy + Default + Div<Output = T>,

type Output = Variable<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'a Variable<T>) -> <&'a Variable<T> as Div>::Output

Performs the / operation.

impl<T> Div for Variable<T>

where T: Copy + Default + Div<Output = T>,

type Output = Variable<T>

The resulting type after applying the / operator.

fn div(self, rhs: Variable<T>) -> <Variable<T> as Div>::Output

Performs the / operation.

impl<T> Eval for Variable<T>

where T: Copy + Default,

fn eval(&self) -> <Variable<T> as EvalOnce>::Output

impl<T> EvalMut for Variable<T>

where T: Default,

fn eval_mut(&mut self) -> <Variable<T> as EvalOnce>::Output

impl<T> EvalOnce for Variable<T>

where T: Default,

type Output = T

fn eval_once(self) -> <Variable<T> as EvalOnce>::Output

impl<T> Gradient<Variable<T>> for Variable<T>

where T: Num,

type Gradient = T

fn grad( &self, args: Variable<T>, ) -> <Variable<T> as Gradient<Variable<T>>>::Gradient

impl<T> Hash for Variable<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> Mul<&'a Variable<T>> for Variable<T>

where T: Copy + Default + Mul<Output = T>,

type Output = Variable<T>

The resulting type after applying the * operator.

fn mul( self, rhs: &'a Variable<T>, ) -> <Variable<T> as Mul<&'a Variable<T>>>::Output

Performs the * operation.

impl<T> Mul<T> for Variable<T>

where T: Copy + Default + Mul<Output = T>,

type Output = Variable<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <Variable<T> as Mul<T>>::Output

Performs the * operation.

impl<'a, T> Mul<Variable<T>> for &'a Variable<T>

where T: Copy + Default + Mul<Output = T>,

type Output = Variable<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Variable<T>) -> <&'a Variable<T> as Mul<Variable<T>>>::Output

Performs the * operation.

impl<'a, T> Mul for &'a Variable<T>

where T: Copy + Default + Mul<Output = T>,

type Output = Variable<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Variable<T>) -> <&'a Variable<T> as Mul>::Output

Performs the * operation.

impl<T> Mul for Variable<T>

where T: Copy + Default + Mul<Output = T>,

type Output = Variable<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Variable<T>) -> <Variable<T> as Mul>::Output

Performs the * operation.

impl<'a, T> Neg for &'a Variable<T>

where T: Copy + Default + Neg<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn neg(self) -> <&'a Variable<T> as Neg>::Output

Performs the unary - operation.

impl<T> Neg for Variable<T>

where T: Copy + Default + Neg<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn neg(self) -> <Variable<T> as Neg>::Output

Performs the unary - operation.

impl<T> Not for Variable<T>

where T: Copy + Default + Not<Output = T>,

type Output = Variable<T>

The resulting type after applying the ! operator.

fn not(self) -> <Variable<T> as Not>::Output

Performs the unary ! operation.

impl<T> Num for Variable<T>

where T: Copy + Default + Num,

type FromStrRadixErr = <T as Num>::FromStrRadixErr

fn from_str_radix( str: &str, radix: u32, ) -> Result<Variable<T>, <Variable<T> as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<T> One for Variable<T>

where T: Copy + Default + One,

fn one() -> Variable<T>

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<T> Ord for Variable<T>

where T: Ord,

fn cmp(&self, other: &Variable<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Variable<T>

where T: PartialEq,

fn eq(&self, other: &Variable<T>) -> 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<T> PartialOrd for Variable<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &Variable<T>) -> 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<'a, T> Rem<&'a Variable<T>> for Variable<T>

where T: Copy + Default + Rem<Output = T>,

type Output = Variable<T>

The resulting type after applying the % operator.

fn rem( self, rhs: &'a Variable<T>, ) -> <Variable<T> as Rem<&'a Variable<T>>>::Output

Performs the % operation.

impl<T> Rem<T> for Variable<T>

where T: Copy + Default + Rem<Output = T>,

type Output = Variable<T>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> <Variable<T> as Rem<T>>::Output

Performs the % operation.

impl<'a, T> Rem<Variable<T>> for &'a Variable<T>

where T: Copy + Default + Rem<Output = T>,

type Output = Variable<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Variable<T>) -> <&'a Variable<T> as Rem<Variable<T>>>::Output

Performs the % operation.

impl<'a, T> Rem for &'a Variable<T>

where T: Copy + Default + Rem<Output = T>,

type Output = Variable<T>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Variable<T>) -> <&'a Variable<T> as Rem>::Output

Performs the % operation.

impl<T> Rem for Variable<T>

where T: Copy + Default + Rem<Output = T>,

type Output = Variable<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Variable<T>) -> <Variable<T> as Rem>::Output

Performs the % operation.

impl<T> Serialize for Variable<T>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, T> Sub<&'a Variable<T>> for Variable<T>

where T: Copy + Default + Sub<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn sub( self, rhs: &'a Variable<T>, ) -> <Variable<T> as Sub<&'a Variable<T>>>::Output

Performs the - operation.

impl<T> Sub<T> for Variable<T>

where T: Copy + Default + Sub<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> <Variable<T> as Sub<T>>::Output

Performs the - operation.

impl<'a, T> Sub<Variable<T>> for &'a Variable<T>

where T: Copy + Default + Sub<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Variable<T>) -> <&'a Variable<T> as Sub<Variable<T>>>::Output

Performs the - operation.

impl<'a, T> Sub for &'a Variable<T>

where T: Copy + Default + Sub<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Variable<T>) -> <&'a Variable<T> as Sub>::Output

Performs the - operation.

impl<T> Sub for Variable<T>

where T: Copy + Default + Sub<Output = T>,

type Output = Variable<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Variable<T>) -> <Variable<T> as Sub>::Output

Performs the - operation.

impl<T> Zero for Variable<T>

where T: Copy + Default + Zero,

fn zero() -> Variable<T>

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T> Eq for Variable<T>

where T: Eq,

impl<T> Send for Variable<T>

impl<T> StructuralPartialEq for Variable<T>

impl<T> Sync for Variable<T>