Skip to main content

NormOrd

Enum NormOrd 

Source
#[non_exhaustive]
pub enum NormOrd { Frobenius, Zero, Inf, NegInf, P(f64), }
Expand description

The order of a norm.

Each variant maps one to one onto the former Option<f64> argument: Frobenius is None, Zero is Some(0.0), Inf and NegInf are Some(+inf) and Some(-inf), and P(p) is Some(p) for a finite nonzero p. The meaning of P(p) depends on how many axes are reduced:

  • one axis (a vector norm): the entrywise p-norm;
  • two axes (a matrix norm): P(1.0) / P(-1.0) are the largest / smallest absolute column sum, P(2.0) / P(-2.0) the largest / smallest singular value, and any other p the entrywise p-norm of the matrix;
  • more axes: the entrywise p-norm over all reduced axes.

Zero counts the entries that are not equal to zero, not the entries with |x| > 0: a NaN counts as nonzero, +0.0 and -0.0 count as zero, and ±inf count as nonzero; for complex dtypes an entry is zero exactly when both components are zero. Inf / NegInf are the largest / smallest absolute entry (vector) or absolute row sum (matrix). Frobenius is the Euclidean norm of the reduced entries. P(p) with p == 0, an infinite p or a NaN p is rejected as an invalid argument; use Zero, Inf or NegInf instead.

§Examples

use tenferro_linalg::NormOrd;

assert_eq!(NormOrd::default(), NormOrd::Frobenius);
let spectral = NormOrd::P(2.0);
assert_eq!(spectral, NormOrd::P(2.0));

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Frobenius

The Euclidean (Frobenius) norm of the reduced entries.

§

Zero

The number of entries not equal to zero.

The predicate is x != 0, not |x| > 0: a NaN entry counts as nonzero, +0.0 and -0.0 count as zero, and ±inf count as nonzero. For complex dtypes an entry is zero exactly when both components are zero.

§

Inf

The largest absolute entry, or the largest absolute row sum.

§

NegInf

The smallest absolute entry, or the smallest absolute row sum.

§

P(f64)

The p-norm for a finite nonzero p.

Trait Implementations§

Source§

impl Clone for NormOrd

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NormOrd

Source§

impl Debug for NormOrd

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NormOrd

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for NormOrd

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NormOrd

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.