Skip to main content

Layout

Struct Layout 

Source
pub struct Layout<T> { /* private fields */ }
Expand description

A validated layout for Matrix or MatrixMut.

This type guarantees the following invariants:

  • self.nrows() * self.ncols() does not exceed usize::MAX.
  • self.nrows() * self.ncols() * std::mem::size_of::<T>() does not exceed isize::MAX.

Implementations§

Source§

impl<T> Layout<T>

Source

pub const fn new(nrows: usize, ncols: usize) -> Result<Self, LayoutError>

Construct a new Layout, validating the following:

  • nrows * ncols does not exceed usize::MAX.
  • nrows * ncols * std::mem::size_of::<T>() does not exceed isize::MAX (the maximum addressable byte span).
Source

pub fn num_elements(&self) -> usize

Return the product self.nrows() * self.ncols().

Source

pub fn nrows(&self) -> usize

Return the number of rows.

Source

pub fn ncols(&self) -> usize

Return the number of columns.

Source

pub fn rebind<U>(&self) -> Result<Layout<U>, LayoutError>

Rebind the element type to U.

§Errors

Returns an error if the rebound layout’s byte size would exceed isize::MAX.

Source

pub fn transpose(&self) -> Layout<T>

Swap the rows and columns.

Trait Implementations§

Source§

impl<T> Clone for Layout<T>

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<T> Copy for Layout<T>

Source§

impl<T> Debug for Layout<T>

Source§

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

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

impl<T> Eq for Layout<T>

Source§

impl<T> From<Layout<T>> for Layout<T>

Source§

fn from(layout: Layout<T>) -> Self

Converts to this type from the input type.
Source§

impl<T> PartialEq for Layout<T>

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

Auto Trait Implementations§

§

impl<T> Freeze for Layout<T>
where PhantomData<fn() -> T>: Freeze,

§

impl<T> RefUnwindSafe for Layout<T>
where PhantomData<fn() -> T>: RefUnwindSafe,

§

impl<T> Send for Layout<T>
where PhantomData<fn() -> T>: Send,

§

impl<T> Sync for Layout<T>
where PhantomData<fn() -> T>: Sync,

§

impl<T> Unpin for Layout<T>
where PhantomData<fn() -> T>: Unpin,

§

impl<T> UnsafeUnpin for Layout<T>
where PhantomData<fn() -> T>: UnsafeUnpin,

§

impl<T> UnwindSafe for Layout<T>
where PhantomData<fn() -> T>: UnwindSafe,

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> AsyncFriendly for T
where T: Send + Sync + '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
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.

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V