Struct zyx_core::view::View

pub struct View { /* private fields */ }

View holds shape of the tensor and allows for arbitrary number of movement ops (reshape, expand, pad, permute) to be executed as noops (without accessing the actual data).

Implementations

impl View

pub fn new(shape: Shape) -> Self

Create new view from shape

pub fn is_contiguous(&self) -> bool

Is this view contiguous? i. e. no padding, expands or permutes, only reshapes are allowed

pub fn is_padded(&self) -> bool

Is this view padded?

pub fn view_type(&self) -> ViewType

For cpu backend

pub fn iterate_contiguous<'a, T: Scalar>( &'a self, data: &'a [T] ) -> impl Iterator<Item = T> + 'a

Simple iteration

pub fn iterate_strided<'a, T: Scalar>( &'a self, data: &'a [T] ) -> impl Iterator<Item = T> + 'a

Iteration with expands and permutes

pub fn iterate_reshaped<'a, T: Scalar>( &'a self, data: &'a [T] ) -> impl Iterator<Item = T> + 'a

Iteration with expands, permutes and reshapes, but without padding

pub fn iterate_padded<'a, T: Scalar>( &'a self, data: &'a [T] ) -> impl Iterator<Item = T> + 'a

Iteration with expands, permutes, reshapes and padding

pub fn cidx(&self) -> Index

Access data called name with idx0-idx{rank} converted into self view. This is used by compiled backends. Returns padding condition and index. If padding condition == 0, padding value is applied, if padding condition is one, value is drawn from data.

pub fn numel(&self) -> usize

Number of elements in view with self.shape()

pub fn shape(&self) -> &Shape

Last shape of self.

pub fn strides(&self) -> &Shape

Last strides of self.

pub fn original_shape(&self) -> &Shape

Original (first) shape of self.

pub fn original_numel(&self) -> usize

Original number of elements of self.

pub fn expand(&self, shape: &Shape) -> Self

Expand self into shape

pub fn pad(&self, new_padding: &[(i64, i64)]) -> Self

Pad self by padding

pub fn reshape(&self, n_shape: &Shape) -> Self

Reshape self into shape

pub fn permute(&self, axes: &Axes) -> Self

Permute self by axes

Trait Implementations

impl Clone for View

fn clone(&self) -> View

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for View

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

Formats the value using the given formatter.

impl Ord for View

fn cmp(&self, other: &View) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for View

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for View

fn partial_cmp(&self, other: &View) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for View

impl StructuralPartialEq for View