candle_core::shape

Struct Shape

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

Implementations§

impl Shape

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

pub fn rank(&self) -> usize

The rank is the number of dimensions, 0 for a scalar value, 1 for a vector, etc.

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

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

The dimensions as a slice of usize.

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

The dimension size for a specified dimension index.

pub fn elem_count(&self) -> usize

The total number of elements, this is the product of all dimension sizes.

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

Returns true if the strides are C contiguous (aka row major).

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

Returns true if the strides are Fortran contiguous (aka column major).

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

Modifies the shape by adding a list of additional dimensions at the end of the existing dimensions.

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.

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 copy 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 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<()> for Shape

fn from(_: ()) -> 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 From<(usize, usize)> for Shape

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(d12345: (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(d123456: (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<(), Self::Error>

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), Self::Error>

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), Self::Error>

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), Self::Error>

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), Self::Error>

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, Self::Error>

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 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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

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

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

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

Compare self to key and return true if they are equal.

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> IntoEither for T

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

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<S> ShapeWithOneHole for S
where S: Into<Shape>,

fn into_shape(self, _el_count: usize) -> Result<Shape, Error>

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

impl<T> ErasedDestructor for T
where T: 'static,