Struct Dual

pub struct Dual { /* private fields */ }

A dual number data type supporting first order derivatives.

Implementations

impl Dual

pub fn new(real: f64, vars: Vec<String>) -> Self

Constructs a new Dual.

• vars should be unique; duplicates will be removed by the IndexSet.

Gradient values for each of the provided vars is set to 1.0_f64.

Examples

let x = Dual::new(2.5, vec!["x".to_string()]);
// x: <Dual: 2.5, (x), [1.0]>

pub fn try_new( real: f64, vars: Vec<String>, dual: Vec<f64>, ) -> Result<Self, PyErr>

Constructs a new Dual.

• vars should be unique; duplicates will be removed by the IndexSet.
• dual can be empty; if so each gradient with respect to each vars is set to 1.0_f64.

try_new should be used instead of new when gradient values other than 1.0_f64 are to be initialised.

Errors

If the length of dual and of vars are not the same after parsing.

Examples

let x = Dual::try_new(2.5, vec!["x".to_string()], vec![4.2]).unwrap();
// x: <Dual: 2.5, (x), [4.2]>

pub fn new_from<T: Vars>(other: &T, real: f64, vars: Vec<String>) -> Self

Construct a new Dual cloning the vars Arc pointer from another.

Examples

let x = Dual::try_new(2.5, vec!["x".to_string(), "y".to_string()], vec![1.0, 0.0]).unwrap();
let y1 = Dual::new_from(&x, 1.5, vec!["y".to_string()]);

This is semantically the same as:

let y2 = Dual::new(1.5, vec!["y".to_string()]).to_new_vars(x.vars(), None);
assert_eq!(y1, y2);

pub fn try_new_from<T: Vars>( other: &T, real: f64, vars: Vec<String>, dual: Vec<f64>, ) -> Result<Self, PyErr>

Construct a new Dual cloning the vars Arc pointer from another.

Examples

let x = Dual::try_new(2.5, vec!["x".to_string(), "y".to_string()], vec![1.0, 0.0]).unwrap();
let y1 = Dual::try_new_from(&x, 1.5, vec!["y".to_string()], vec![3.2]).unwrap();

This is semantically the same as:

let y2 = Dual::try_new(1.5, vec!["y".to_string()], vec![3.2]).unwrap().to_new_vars(x.vars(), None);
assert_eq!(y1, y2);

pub fn clone_from<T: Vars>(other: &T, real: f64, dual: Array1<f64>) -> Self

Construct a new Dual cloning the vars Arc pointer from another.

pub fn real(&self) -> f64

Get the real component value of the struct.

impl Dual

pub fn __getnewargs__(&self) -> PyResult<(f64, Vec<String>, Vec<f64>)>

Trait Implementations

impl Add<&Dual> for &Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Dual> for &f64

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Dual> for Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Dual> for f64

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&f64> for &Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&f64> for Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Dual> for &Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Dual> for &f64

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Dual> for f64

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for &Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Dual

type Output = Dual

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Dual

fn clone(&self) -> Dual

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dual

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

Formats the value using the given formatter.

impl Default for Dual

fn default() -> Dual

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Dual

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<&Dual> for &Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Dual> for &f64

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Dual> for Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Dual> for f64

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&f64> for &Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&f64> for Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Dual> for &Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Dual> for &f64

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Dual> for f64

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for &Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Dual

type Output = Dual

The resulting type after applying the / operator.

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

Performs the / operation.

impl Element for Dual

const IS_COPY: bool = false

Flag that indicates whether this type is trivially copyable.

fn get_dtype(py: Python<'_>) -> Bound<'_, PyArrayDescr>

Returns the associated type descriptor (“dtype”) for the given element type.

fn clone_ref(&self, _py: Python<'_>) -> Self

Create a clone of the value while the GIL is guaranteed to be held.

fn vec_from_slice(py: Python<'_>, slc: &[Self]) -> Vec<Self>

Create an owned copy of the slice while the GIL is guaranteed to be held.

fn array_from_view<D>( py: Python<'_>, view: ArrayBase<ViewRepr<&Self>, D>, ) -> ArrayBase<OwnedRepr<Self>, D>

where D: Dimension,

Create an owned copy of the array while the GIL is guaranteed to be held.

impl From<&Dual> for Dual2

fn from(value: &Dual) -> Self

Converts to this type from the input type.

impl From<&Dual> for Number

fn from(value: &Dual) -> Self

Converts to this type from the input type.

impl From<&Dual> for f64

fn from(value: &Dual) -> Self

Converts to this type from the input type.

impl From<&Dual2> for Dual

fn from(value: &Dual2) -> Self

Converts to this type from the input type.

impl From<&Number> for Dual

fn from(value: &Number) -> Self

Converts to this type from the input type.

impl From<Dual> for Dual2

fn from(value: Dual) -> Self

Converts to this type from the input type.

impl From<Dual> for Number

fn from(value: Dual) -> Self

Converts to this type from the input type.

impl From<Dual> for f64

fn from(value: Dual) -> Self

Converts to this type from the input type.

impl From<Dual2> for Dual

fn from(value: Dual2) -> Self

Converts to this type from the input type.

impl From<Number> for Dual

fn from(value: Number) -> Self

Converts to this type from the input type.

impl From<f64> for Dual

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Gradient1 for Dual

fn dual(&self) -> &Array1<f64>

Get a reference to the Array containing the first order gradients.

fn gradient1(&self, vars: Vec<String>) -> Array1<f64>

Return a set of first order gradients ordered by the given vector.

impl<'py> IntoPyObject<'py> for Dual

type Target = Dual

The Python output type

type Output = Bound<'py, <Dual as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl MathFuncs for Dual

fn exp(&self) -> Self

Return the exponential of a value.

fn log(&self) -> Self

Return the natural logarithm of a value.

fn norm_cdf(&self) -> Self

Return the standard normal cumulative distribution function of a value.

fn inv_norm_cdf(&self) -> Self

Return the inverse standard normal cumulative distribution function of a value.

impl Mul<&Dual> for &Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Dual> for &f64

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Dual> for Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Dual> for f64

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for &Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Dual> for &Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Dual> for &f64

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Dual> for f64

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for &Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Dual

type Output = Dual

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for &Dual

type Output = Dual

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Dual

type Output = Dual

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Num for Dual

type FromStrRadixErr = String

fn from_str_radix( _src: &str, _radix: u32, ) -> Result<Self, Self::FromStrRadixErr>

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

impl One for Dual

fn one() -> Dual

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 PartialEq<Dual> for f64

fn eq(&self, other: &Dual) -> 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 PartialEq<f64> for Dual

fn eq(&self, other: &f64) -> 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 PartialEq for Dual

Measures value equivalence of Dual.

Returns true if:

• real components are equal: lhs.real == rhs.real.
• dual components are equal after aligning vars.

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

fn partial_cmp(&self, other: &Dual) -> 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 PartialOrd<f64> for Dual

fn partial_cmp(&self, other: &f64) -> 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 PartialOrd for Dual

Compares Dual by real component only.

fn partial_cmp(&self, other: &Dual) -> 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 Pow<&Dual> for &Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: &Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<&Dual> for &f64

type Output = Dual

The result after applying the operator.

fn pow(self, power: &Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<&Dual> for Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: &Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<&Dual> for f64

type Output = Dual

The result after applying the operator.

fn pow(self, power: &Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<&f64> for &Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: &f64) -> Self::Output

Returns self to the power rhs.

impl Pow<&f64> for Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: &f64) -> Self::Output

Returns self to the power rhs.

impl Pow<Dual> for &Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<Dual> for &f64

type Output = Dual

The result after applying the operator.

fn pow(self, power: Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<Dual> for Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<Dual> for f64

type Output = Dual

The result after applying the operator.

fn pow(self, power: Dual) -> Self::Output

Returns self to the power rhs.

impl Pow<f64> for &Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: f64) -> Self::Output

Returns self to the power rhs.

impl Pow<f64> for Dual

type Output = Dual

The result after applying the operator.

fn pow(self, power: f64) -> Self::Output

Returns self to the power rhs.

impl PyClass for Dual

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Dual

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Dual>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Dual> for PyClassImplCollector<Dual>

fn new_text_signature(self) -> Option<&'static str>

impl PyClass__add__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __add__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__eq__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __eq__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__ge__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __ge__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__gt__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __gt__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__le__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __le__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__lt__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __lt__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__mul__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __mul__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__pow__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __pow__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, arg1: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__radd__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __radd__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rmul__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __rmul__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rpow__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __rpow__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, arg1: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rsub__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __rsub__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__rtruediv__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __rtruediv__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__sub__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __sub__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__truediv__SlotFragment<Dual> for PyClassImplCollector<Dual>

unsafe fn __truediv__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a Dual

type Holder = Option<PyRef<'py, Dual>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut Dual

type Holder = Option<PyRefMut<'py, Dual>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Dual> for PyClassImplCollector<Dual>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Dual

const NAME: &'static str = "Dual"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Rem<&Dual> for &Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: &Dual) -> Self::Output

Performs the % operation.

impl Rem<&Dual> for &f64

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: &Dual) -> Self::Output

Performs the % operation.

impl Rem<&Dual> for Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: &Dual) -> Self::Output

Performs the % operation.

impl Rem<&Dual> for f64

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: &Dual) -> Self::Output

Performs the % operation.

impl Rem<&f64> for &Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: &f64) -> Self::Output

Performs the % operation.

impl Rem<&f64> for Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: &f64) -> Self::Output

Performs the % operation.

impl Rem<Dual> for &Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: Dual) -> Self::Output

Performs the % operation.

impl Rem<Dual> for &f64

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: Dual) -> Self::Output

Performs the % operation.

impl Rem<Dual> for f64

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: Dual) -> Self::Output

Performs the % operation.

impl Rem<f64> for &Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: f64) -> Self::Output

Performs the % operation.

impl Rem<f64> for Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: f64) -> Self::Output

Performs the % operation.

impl Rem for Dual

type Output = Dual

The resulting type after applying the % operator.

fn rem(self, rhs: Dual) -> Self::Output

Performs the % operation.

impl Serialize for Dual

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Signed for Dual

Sign for Dual is evaluated in terms of the real component.

fn abs(&self) -> Self

Determine the absolute value of Dual.

If real is negative the returned Dual will negate both its real value and dual.

This behaviour is undefined at zero. The derivative of the `abs` function is not defined there and care needs to be taken when implying gradients.

fn abs_sub(&self, other: &Self) -> Self

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl Sub<&Dual> for &Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Dual> for &f64

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Dual> for Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Dual> for f64

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&f64> for &Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&f64> for Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Dual> for &Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Dual> for &f64

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Dual> for f64

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for &Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Dual

type Output = Dual

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sum for Dual

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Dual>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Vars for Dual

fn vars(&self) -> &Arc<IndexSet<String>>

Get a reference to the Arc pointer for the IndexSet containing the struct’s variables.

fn to_new_vars( &self, arc_vars: &Arc<IndexSet<String>>, state: Option<VarsRelationship>, ) -> Self

Construct a new Dual with vars set as the given Arc pointer and gradients shuffled in memory.

Examples

let x = Dual::new(1.5, vec!["x".to_string()]);
let xy = Dual::new(2.5, vec!["x".to_string(), "y".to_string()]);
let x_y = x.to_new_vars(xy.vars(), None);
// x_y: <Dual: 1.5, (x, y), [1.0, 0.0]>
assert_eq!(x_y, Dual::try_new(1.5, vec!["x".to_string(), "y".to_string()], vec![1.0, 0.0]).unwrap());

fn vars_cmp(&self, arc_vars: &Arc<IndexSet<String>>) -> VarsRelationship

Compare the vars on a Dual with a given Arc pointer.

fn to_union_vars( &self, other: &Self, state: Option<VarsRelationship>, ) -> (Self, Self)

where Self: Sized,

Construct a tuple of 2 Self types whose vars are linked by an Arc pointer.

fn to_combined_vars(&self, other: &Self) -> (Self, Self)

where Self: Sized,

Construct a tuple of 2 Self types whose vars are linked by the explicit union of their own variables.

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

Compare if two Dual structs share the same vars by Arc pointer equivalence.

impl Zero for Dual

fn zero() -> Dual

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 DerefToPyAny for Dual

impl NumberOps<Dual> for Dual