Skip to main content

Shape

Struct Shape

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

Implementations§

impl Shape

pub fn scalar() -> Self

pub fn is_scalar(&self) -> bool

pub fn rank(&self) -> usize

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

pub fn into_dims(self) -> Vec<usize>

pub fn dim(&self, dim: impl Dim) -> Result<usize>

pub fn element_count(&self) -> usize

pub fn is_contiguous(&self, stride: &[usize]) -> bool

pub fn extend(self, additional_dims: &[usize]) -> Self

pub fn broadcast_shape_binary_op( &self, rhs: &Self, op: &'static str, ) -> Result<Shape>

Check whether the two shapes are compatible for broadcast, and if it is the case return the broadcasted shape. This is to be used for binary pointwise ops. Copy from https://github.com/huggingface/candle

pub fn dim_coordinates(&self) -> DimCoordinates ⓘ

Returns an iterator over dimension coordinates.

This iterator yields the multi-dimensional coordinates (e.g., [i, j, k, ...]) of each element in the array, independent of the physical storage layout.

Example for shape = (2, 2): yields: [0, 0], [0, 1], [1, 0], [1, 1]

pub fn dims_coordinates<const N: usize>(&self) -> Result<DimNCoordinates<N>>

pub fn dim2_coordinates(&self) -> Result<DimNCoordinates<2>>

pub fn dim3_coordinates(&self) -> Result<DimNCoordinates<3>>

pub fn dim4_coordinates(&self) -> Result<DimNCoordinates<4>>

pub fn dim5_coordinates(&self) -> Result<DimNCoordinates<5>>

impl Shape

pub fn dims0(&self) -> Result<()>

impl Shape

pub fn dims1(&self) -> Result<usize>

impl Shape

pub fn dims2(&self) -> Result<(usize, usize)>

impl Shape

pub fn dims3(&self) -> Result<(usize, usize, usize)>

impl Shape

pub fn dims4(&self) -> Result<(usize, usize, usize, usize)>

impl Shape

pub fn dims5(&self) -> Result<(usize, usize, usize, usize, usize)>

Trait Implementations§

impl Clone for Shape

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

impl Debug for Shape

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

Formats the value using the given formatter. Read more

impl Display for Shape

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

Formats the value using the given formatter. Read more

impl From<&[usize]> for Shape

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

Converts to this type from the input type.

impl<const C: usize> From<&[usize; C]> for Shape

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

Converts to this type from the input type.

impl From<&Shape> for Shape

fn from(shape: &Shape) -> Self

Converts to this type from the input type.

impl From<&Vec<usize>> for Shape

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

Converts to this type from the input type.

impl From<()> for Shape

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<(usize,)> for Shape

fn from(d: (usize,)) -> Self

Converts to this type from the input type.

impl From<(usize, usize)> for Shape

fn from(d: (usize, usize)) -> Self

Converts to this type from the input type.

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

fn from(d: (usize, usize, usize)) -> Self

Converts to this type from the input type.

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

fn from(d: (usize, usize, usize, usize)) -> Self

Converts to this type from the input type.

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

fn from(d: (usize, usize, usize, usize, usize)) -> Self

Converts to this type from the input type.

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

fn from(d: (usize, usize, usize, usize, usize, usize)) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for Shape

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

Converts to this type from the input type.

impl From<usize> for Shape

fn from(d1: usize) -> Self

Converts to this type from the input type.

impl PartialEq for Shape

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.

impl TryInto<()> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<()>

Performs the conversion.

impl TryInto<(usize, usize)> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<(usize, usize)>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<(usize, usize, usize)>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<(usize, usize, usize, usize)>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<(usize, usize, usize, usize, usize)>

Performs the conversion.

impl TryInto<usize> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<usize>

Performs the conversion.

impl Eq for Shape

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§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V