Struct Layout

pub struct Layout<D = Ix2> { /* private fields */ }

Implementations

impl<D> Layout<D>

where D: Dimension,

pub fn new(dim: D) -> Self

where D: RemoveAxis,

pub fn from_dim(dim: D) -> Result<Self, ShapeError>

pub fn from_shape<Sh>(shape: Sh) -> Self

where D: RemoveAxis, Sh: ShapeBuilder<Dim = D>,

pub fn with_shape<E, Sh>(self, shape: Sh) -> Layout<E>

where E: RemoveAxis, Sh: ShapeBuilder<Dim = E>,

pub fn as_slice(&self) -> &[usize]

pub fn as_mut_slice(&mut self) -> &mut [usize]

pub fn dim(&self) -> D

pub fn features(&self) -> Features

pub fn into_dimensionality<E>(self, dim: E) -> Result<Layout<E>, ShapeError>

where E: Dimension,

pub fn ndim(&self) -> usize

pub fn pattern(&self) -> D::Pattern

where D: Copy,

Trait Implementations

impl<D> Borrow<D> for Layout<D>

where D: Dimension,

fn borrow(&self) -> &D

Immutably borrows from an owned value.

impl<D> Borrow<Features> for Layout<D>

where D: Dimension,

fn borrow(&self) -> &Features

Immutably borrows from an owned value.

impl<D: Clone> Clone for Layout<D>

fn clone(&self) -> Layout<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for Layout<D>

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

Formats the value using the given formatter.

impl<D: Default> Default for Layout<D>

fn default() -> Layout<D>

Returns the “default value” for a type.

impl<'de, D> Deserialize<'de> for Layout<D>

where D: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: Hash> Hash for Layout<D>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<D: Ord> Ord for Layout<D>

fn cmp(&self, other: &Layout<D>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<D> PartialEq<D> for Layout<D>

where D: Dimension,

fn eq(&self, other: &D) -> 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<D> PartialEq<Features> for Layout<D>

where D: Dimension,

fn eq(&self, other: &Features) -> 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<D: PartialEq> PartialEq for Layout<D>

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

fn partial_cmp(&self, other: &Layout<D>) -> 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<D> Serialize for Layout<D>

where D: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<D: Copy> Copy for Layout<D>

impl<D: Eq> Eq for Layout<D>

impl<D> StructuralPartialEq for Layout<D>