Skip to main content

Shape

Struct Shape 

Source
pub struct Shape(/* private fields */);

Implementations§

Source§

impl Shape

Source

pub fn new(dims: impl Into<Arc<[usize]>>) -> Self

Source

pub fn size(&self) -> usize

Total number of elements implied by this shape. Uses saturating multiplication to avoid overflow in release builds.

Source

pub fn try_size(&self) -> Option<usize>

Checked total element count. Returns None on overflow.

Source

pub fn dimensions(&self) -> usize

Source

pub fn contains_dim(&self, dim: usize) -> bool

Source

pub fn dim_at(&self, index: usize) -> usize

Source

pub fn rank(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn is_scalar(&self) -> bool

Source

pub fn is_vector(&self) -> bool

Source

pub fn is_matrix(&self) -> bool

Source

pub fn is_tensor(&self) -> bool

Source

pub fn is_square(&self) -> bool

Source

pub fn iter(&self) -> impl Iterator<Item = &usize>

Source

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

Trait Implementations§

Source§

impl AsRef<[usize]> for Shape

Source§

fn as_ref(&self) -> &[usize]

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Shape

Source§

fn clone(&self) -> Shape

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Shape

Source§

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

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

impl Default for Shape

Source§

fn default() -> Shape

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

impl From<&[usize]> for Shape

Source§

fn from(dims: &[usize]) -> Self

Converts to this type from the input type.
Source§

impl From<&Shape> for Shape

Source§

fn from(shape: &Shape) -> Self

Converts to this type from the input type.
Source§

impl From<&Shape> for Strides

Source§

fn from(shape: &Shape) -> Self

Converts to this type from the input type.
Source§

impl From<(usize, usize)> for Shape

Source§

fn from(value: (usize, usize)) -> Shape

Converts to this type from the input type.
Source§

impl From<(usize, usize, usize)> for Shape

Source§

fn from(value: (usize, usize, usize)) -> Shape

Converts to this type from the input type.
Source§

impl From<(usize, usize, usize, usize)> for Shape

Source§

fn from(value: (usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.
Source§

impl From<(usize, usize, usize, usize, usize)> for Shape

Source§

fn from(value: (usize, usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.
Source§

impl From<(usize, usize, usize, usize, usize, usize)> for Shape

Source§

fn from(value: (usize, usize, usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.
Source§

impl From<(usize, usize, usize, usize, usize, usize, usize)> for Shape

Source§

fn from(value: (usize, usize, usize, usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.
Source§

impl From<(usize, usize, usize, usize, usize, usize, usize, usize)> for Shape

Source§

fn from( value: (usize, usize, usize, usize, usize, usize, usize, usize), ) -> Shape

Converts to this type from the input type.
Source§

impl From<Vec<i32>> for Shape

Source§

fn from(dims: Vec<i32>) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<usize>> for Shape

Source§

fn from(dims: Vec<usize>) -> Self

Converts to this type from the input type.
Source§

impl From<usize> for Shape

Source§

fn from(value: usize) -> Shape

Converts to this type from the input type.
Source§

impl Hash for Shape

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Shape

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Shape

Source§

impl StructuralPartialEq for Shape

Auto Trait Implementations§

§

impl Freeze for Shape

§

impl RefUnwindSafe for Shape

§

impl Send for Shape

§

impl Sync for Shape

§

impl Unpin for Shape

§

impl UnsafeUnpin for Shape

§

impl UnwindSafe for Shape

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
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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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 = Infallible

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

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

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.