Enum rulinalg::norm::Lp

source · [−]

pub enum Lp<T: Float> {
    Infinity,
    Integer(i32),
    Float(T),
}

Expand description

The Lp norm

The Lp norm computes the pth root of the sum of elements to the pth power.

The Lp norm requires p to be greater than or equal 1.

We use an enum for this norm to allow us to explicitly handle special cases at compile time. For example, we have an Infinity variant which handles the special case when the Lp norm is a supremum over absolute values. The Integer variant gives us a performance boost when p is an integer.

You should avoid matching directly against this enum as it is likely to grow.

Variants

`Infinity`

The L-infinity norm (supremum)

`Integer(i32)`

The Lp norm where p is an integer

`Float(T)`

The Lp norm where p is a float

Trait Implementations

source

impl<T: Debug + Float> Debug for Lp<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T: Float, M: BaseMatrix<T>> MatrixNorm<T, M> for Lp<T>

source

fn norm(&self, m: &M) -> T

Computes the matrix norm.

source

impl<T: Float> VectorNorm<T> for Lp<T>

source

fn norm(&self, v: &Vector<T>) -> T

Computes the vector norm.

Auto Trait Implementations

impl<T> RefUnwindSafe for Lp<T>where
T: RefUnwindSafe,

impl<T> Send for Lp<T>where
T: Send,

impl<T> Sync for Lp<T>where
T: Sync,

impl<T> Unpin for Lp<T>where
T: Unpin,

impl<T> UnwindSafe for Lp<T>where
T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

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

Performs the conversion.

source

impl<U, T> VectorMetric<T> for Uwhere
U: VectorNorm<T>,
T: Copy + Sub<T, Output = T>,

source

fn metric(&self, v1: &Vector<T>, v2: &Vector<T>) -> T

Computes the metric distance between two vectors.

Enum rulinalg::norm::Lp

Variants

`Infinity`

`Integer(i32)`

`Float(T)`

Trait Implementations

impl<T: Debug + Float> Debug for Lp<T>

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

impl<T: Float, M: BaseMatrix<T>> MatrixNorm<T, M> for Lp<T>

fn norm(&self, m: &M) -> T

impl<T: Float> VectorNorm<T> for Lp<T>

fn norm(&self, v: &Vector<T>) -> T

Auto Trait Implementations

impl<T> RefUnwindSafe for Lp<T>where
T: RefUnwindSafe,

impl<T> Send for Lp<T>where
T: Send,

impl<T> Sync for Lp<T>where
T: Sync,

impl<T> Unpin for Lp<T>where
T: Unpin,

impl<T> UnwindSafe for Lp<T>where
T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

impl<U, T> VectorMetric<T> for Uwhere
U: VectorNorm<T>,
T: Copy + Sub<T, Output = T>,

fn metric(&self, v1: &Vector<T>, v2: &Vector<T>) -> T

Enum rulinalg::norm::Lp

Variants

Infinity

Integer(i32)

Float(T)

Trait Implementations

impl<T: Debug + Float> Debug for Lp<T>

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

impl<T: Float, M: BaseMatrix<T>> MatrixNorm<T, M> for Lp<T>

fn norm(&self, m: &M) -> T

impl<T: Float> VectorNorm<T> for Lp<T>

fn norm(&self, v: &Vector<T>) -> T

Auto Trait Implementations

impl<T> RefUnwindSafe for Lp<T>where T: RefUnwindSafe,

impl<T> Send for Lp<T>where T: Send,

impl<T> Sync for Lp<T>where T: Sync,

impl<T> Unpin for Lp<T>where T: Unpin,

impl<T> UnwindSafe for Lp<T>where T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

impl<U, T> VectorMetric<T> for Uwhere U: VectorNorm<T>, T: Copy + Sub<T, Output = T>,

fn metric(&self, v1: &Vector<T>, v2: &Vector<T>) -> T

`Infinity`

`Integer(i32)`

`Float(T)`

impl<T> RefUnwindSafe for Lp<T>where
T: RefUnwindSafe,

impl<T> Send for Lp<T>where
T: Send,

impl<T> Sync for Lp<T>where
T: Sync,

impl<T> Unpin for Lp<T>where
T: Unpin,

impl<T> UnwindSafe for Lp<T>where
T: UnwindSafe,

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

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

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

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

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

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

impl<U, T> VectorMetric<T> for Uwhere
U: VectorNorm<T>,
T: Copy + Sub<T, Output = T>,