Skip to main content

NormOptions

Struct NormOptions 

Source
#[non_exhaustive]
pub struct NormOptions { pub ord: NormOrd, pub axes: Option<AxisVec>, pub keep_dims: KeepDims, }
Expand description

Options for a norm.

axes are signed (-1 is the last axis) and normalized against the input rank; None reduces every axis.

§Examples

use tenferro_linalg::{KeepDims, NormOptions, NormOrd};
use tenferro_tensor::AxisVec;

let axes: AxisVec = [0, -1].into_iter().collect();
let options = NormOptions::default()
    .ord(NormOrd::Inf)
    .axes(Some(axes.clone()))
    .keep_dims(KeepDims::Yes);
assert_eq!(options.ord, NormOrd::Inf);
assert_eq!(options.axes, Some(axes));
assert_eq!(options.keep_dims, KeepDims::Yes);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§ord: NormOrd

The order of the norm.

§axes: Option<AxisVec>

Axes to reduce (signed); None reduces all axes.

§keep_dims: KeepDims

Whether reduced axes stay as size-one axes.

Implementations§

Source§

impl NormOptions

Source

pub fn ord(self, ord: NormOrd) -> Self

Return options with the requested order.

§Examples
use tenferro_linalg::{NormOptions, NormOrd};

assert_eq!(NormOptions::default().ord(NormOrd::Zero).ord, NormOrd::Zero);
Source

pub fn axes(self, axes: Option<AxisVec>) -> Self

Return options reducing the given signed axes (None reduces all).

§Examples
use tenferro_linalg::NormOptions;
use tenferro_tensor::AxisVec;

let axes: AxisVec = [1].into_iter().collect();
assert_eq!(NormOptions::default().axes(Some(axes.clone())).axes, Some(axes));
Source

pub fn keep_dims(self, keep_dims: KeepDims) -> Self

Return options with the requested size-one-axes convention.

§Examples
use tenferro_linalg::{KeepDims, NormOptions};

assert_eq!(NormOptions::default().keep_dims(KeepDims::Yes).keep_dims, KeepDims::Yes);

Trait Implementations§

Source§

impl Clone for NormOptions

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 Debug for NormOptions

Source§

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

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

impl Default for NormOptions

Source§

fn default() -> Self

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

impl PartialEq for NormOptions

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 NormOptions

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
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.