Struct TensorView 

pub struct TensorView<'a> { /* private fields */ }

A view of an N-D array of f32 or f64 values that the view does not own. The inputs of this crate are TensorView values.

A TensorView is small and Copy, and it is only on the stack: the shape and the strides are fixed-size arrays. It has the same data layout and the same layout rules as Tensor (strides in bytes, column-major order, lane axis last, adjacent values in each column). So a view of a row-major array is not possible: make a column-major (Fortran-ordered) copy first. The lifetime 'a is the lifetime of the data.

A TensorView has the C layout of RawLayout, so a C callback that gets a const TensorView * can read the fields ptr, dtype, ndim, shape and strides.

Implementations

impl<'a> TensorView<'a>

pub unsafe fn new( ptr: *const u8, shape: &[usize], strides: &[usize], dtype: ScalarType, ) -> Result<Self, DiffsolRtError>

Make a view of data, with a shape and strides (in bytes) that obey the layout rules. The Tensor docs give the data layout and the rules.

Errors

If the layout does not obey the layout rules: for example, the strides of a row-major array, more than MAX_NDIM axes, or data that is not aligned.

Safety

For each index in shape, ptr plus the byte offset from strides must point to a valid value of the type dtype. The data must stay valid, and must not change, during 'a.

pub unsafe fn new_col_major( ptr: *const u8, shape: &[usize], dtype: ScalarType, ) -> Self

Make a view of data with the shape shape in column-major (Fortran) order.

Panics

If shape does not have 1 to MAX_NDIM axes, or ptr is not aligned for dtype.

Safety

ptr must point to product(shape) valid, contiguous values of the type dtype. The data must stay valid, and must not change, during 'a.

pub fn from_slice<T: Scalar>(values: &'a [T], shape: &[usize]) -> Self

Make a view of values, with the shape shape in column-major (Fortran) order.

Panics

If the number of values is not the product of shape, or shape does not have 1 to MAX_NDIM axes.

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

The length of each axis.

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

The stride of each axis, in bytes. The Tensor docs give the data layout.

pub fn data_ptr(&self) -> *const u8

The pointer to the first value. It is valid during 'a, and the data must not be changed through it.

pub fn dtype(&self) -> ScalarType

The scalar type of the values.

pub fn index<T: Scalar>( &self, index: impl AsRef<[usize]>, ) -> Result<&'a T, DiffsolRtError>

A reference to the value at index, with one value for each axis. The scalar type must be T.

Panics

If index does not have one value for each axis, or a value is out of range.

pub fn column<T: Scalar>( &self, index: &[usize], ) -> Result<&'a [T], DiffsolRtError>

The column at index: the values [:, index[0], index[1], ...], as one slice of shape[0] values, with no copy. Tensor::column gives the details.

Panics

If index does not have one value for each axis after the first, or a value is out of range.

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

All the columns, in column-major order. Tensor::columns gives the details.

Trait Implementations

impl<'a> Clone for TensorView<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for TensorView<'a>

impl<'a> Debug for TensorView<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Tensor> for TensorView<'a>

fn from(tensor: &'a Tensor) -> Self

Converts to this type from the input type.