Type Alias TensorRank0 

pub type TensorRank0 = f64;

A tensor of rank 0 (a scalar).

Trait Implementations

impl Add<Quantity> for TensorRank0

type Output = Quantity

The resulting type after applying the + operator.

fn add(self, quantity: Quantity<Dimensionless>) -> Self::Output

Performs the + operation.

impl AssertEq for TensorRank0

fn eq(a: Self, b: TensorRank0) -> Result<(), AssertionError>

fn eq_within_tols( tols: &Assert, a: Self, b: TensorRank0, ) -> Result<(), AssertionError>

impl AssertFd for TensorRank0

fn eq_within_fd_tol( tols: &Assert, a: Self, b: TensorRank0, ) -> Result<(), AssertionError>

impl<U> Div<Quantity<U>> for TensorRank0

where U: UnitInv,

type Output = Quantity<<U as UnitInv>::Output>

The resulting type after applying the / operator.

fn div(self, quantity: Quantity<U>) -> Self::Output

Performs the / operation.

impl Erase for TensorRank0

type Erased = f64

The tensor with its configurations and unit discarded.

fn erase(&self) -> &Self

Views the tensor with its configurations and unit discarded.

impl FiniteDifference for TensorRank0

fn error_fd( &self, comparator: &Self, epsilon: TensorRank0, ) -> Option<(bool, usize)>

impl From<Vector> for TensorRank0

fn from(_vector: Vector) -> Self

Converts to this type from the input type.

impl Hessian for TensorRank0

fn quadratic_form(&self, vector: &Vector) -> TensorRank0

The quadratic form of the Hessian with a vector.

fn entry(&self, _row: usize, _column: usize) -> TensorRank0

The entry at the given (row, column) position.

fn fill_into(self, _square_matrix: &mut SquareMatrix)

Fills the Hessian into a square matrix.

fn retain_from(self, _retained: &[bool]) -> SquareMatrix

Return only the retained indices.

impl HessianBlock for TensorRank0

fn entry(&self, _row: usize, _column: usize) -> TensorRank0

The entry of the block at the given row and column within it.

fn height(&self) -> usize

The number of rows the block occupies.

fn width(&self) -> usize

The number of columns the block occupies.

fn fill_into_block<M>(&self, matrix: &mut M, row: usize, column: usize)

where M: IndexMut<usize, Output = Vector>,

Fills the block into a matrix at the given row and column offsets.

impl Jacobian for TensorRank0

fn fill_into(&self, _vector: &mut Vector)

Fills the Jacobian into a vector.

fn fill_into_chained(self, _other: Vector, _vector: &mut Vector)

Fills the Jacobian chained with a vector into another vector.

fn retain_from(self, _retained: &[bool]) -> Vector

Return only the retained indices.

fn zero_out(&mut self, _indices: &[usize])

Zero out the specified indices.

impl<V> Mul<&Quantity<V>> for TensorRank0

type Output = Quantity<V>

The resulting type after applying the * operator.

fn mul(self, quantity: &Quantity<V>) -> Self::Output

Performs the * operation.

impl<V> Mul<&Quantity<V>> for &TensorRank0

type Output = Quantity<V>

The resulting type after applying the * operator.

fn mul(self, quantity: &Quantity<V>) -> Self::Output

Performs the * operation.

impl<U> Mul<Quantity<U>> for TensorRank0

type Output = Quantity<U>

The resulting type after applying the * operator.

fn mul(self, quantity: Quantity<U>) -> Self::Output

Performs the * operation.

impl Mul<Quantity> for &TensorRank0

Scaling a bare scalar by a dimensionless quantity leaves it bare.

type Output = f64

The resulting type after applying the * operator.

fn mul(self, quantity: Quantity<Dimensionless>) -> Self::Output

Performs the * operation.

impl PartialEq<Quantity> for TensorRank0

fn eq(&self, quantity: &Quantity<Dimensionless>) -> 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<Quantity> for TensorRank0

fn partial_cmp(&self, quantity: &Quantity<Dimensionless>) -> 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 Solution for TensorRank0

fn decrement_from(&mut self, _other: &Vector)

Decrements the solution from another vector.

fn decrement_from_chained(&mut self, _other: &mut Vector, _vector: &Vector)

Decrements the solution chained with a vector from another vector.

fn decrement_from_retained(&mut self, _retained: &[bool], _other: &Vector)

Decrements the solution from another vector on retained entries.

impl Sub<&Vector> for TensorRank0

type Output = f64

The resulting type after applying the - operator.

fn sub(self, _vector: &Vector) -> Self::Output

Performs the - operation.

impl Sub<Quantity> for TensorRank0

type Output = Quantity

The resulting type after applying the - operator.

fn sub(self, quantity: Quantity<Dimensionless>) -> Self::Output

Performs the - operation.

impl Sub<Vector> for TensorRank0

type Output = f64

The resulting type after applying the - operator.

fn sub(self, _vector: Vector) -> Self::Output

Performs the - operation.

impl Tensor for TensorRank0

type Item = f64

The type of item encountered when iterating over the tensor.

type Unit = Dimensionless

The physical unit the tensor carries.

fn error_count_zero( &self, tol_abs: TensorRank0, tol_rel: TensorRank0, ) -> Option<usize>

Returns number of nonzero entries given absolute and relative tolerances.

fn error_count( &self, other: &Self, tol_abs: TensorRank0, tol_rel: TensorRank0, ) -> Option<usize>

Returns number of different entries given absolute and relative tolerances.

fn full_contraction(&self, tensor_rank_0: &Self) -> TensorRank0

Returns the full contraction with another tensor.

fn is_zero(&self) -> bool

Checks whether the tensor is the zero tensor.

fn iter(&self) -> impl Iterator<Item = &Self::Item>

Returns an iterator.

fn iter_mut(&mut self) -> impl Iterator<Item = &mut Self::Item>

Returns an iterator that allows modifying each value.

fn len(&self) -> usize

Returns the number of elements, also referred to as the ‘length’.

fn norm_inf(&self) -> Quantity<Dimensionless>

Returns the infinity norm.

fn norm_l1(&self) -> Quantity<Dimensionless>

Returns the L1 (Manhattan) norm.

fn norm_p_sum(&self, p: TensorRank0) -> TensorRank0

Returns the sum of p-th powers of absolute values (used internally by norm_p).

fn size(&self) -> usize

Returns the total number of entries.

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

Returns the positive difference of the two tensors.

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

Returns the relative difference of the two tensors.

fn norm(&self) -> Quantity<Self::Unit>

Returns the tensor norm.

fn norm_p(&self, p: TensorRank0) -> Quantity<Self::Unit>

Returns the Minkowski (Lp) norm.

fn norm_squared(&self) -> Quantity<Square<Self::Unit>>

where Self::Unit: UnitMul<Self::Unit>,

Returns the tensor norm squared, which carries the square of its unit.

fn normalize(&mut self)

Normalizes the tensor in place.

impl TensorArray for TensorRank0

type Array = f64

The type of array corresponding to the tensor.

type Item = f64

The type of item encountered when iterating over the tensor.

fn as_array(&self) -> Self::Array

Returns the tensor as an array.

fn identity() -> Self

Returns the identity tensor.

fn zero() -> Self

Returns the zero tensor.