Struct TensorViewMut 

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

A mutable view of an N-D array of f32 or f64 values that the view does not own.

It has the same data layout and the same layout rules as TensorView. Also, no two indices give the same value (there is no stride of 0 on an axis with more than one value), so each value can be changed through the view. The C callbacks of crate::ode_callbacks write their outputs through a TensorViewMut.

A TensorViewMut has the C layout of RawLayout. The C type of ptr is const uint8_t *: a C callback casts it to double * (or float *) to write the values.

Implementations

impl<'a> TensorViewMut<'a>

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

Make a mutable view of data, with a shape and strides (in bytes) that obey the layout rules, and no two indices that give the same value.

Errors

If the layout does not obey the rules.

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 during 'a, and nothing else can read or change it during 'a.

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

Make a mutable 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 as_view(&self) -> TensorView<'_>

A view of the same data, which borrows self.

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(&mut self) -> *mut u8

The pointer to the first value. It is valid during 'a.

pub fn dtype(&self) -> ScalarType

The scalar type of the values.

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

A reference to the value at index. TensorView::index gives the details.

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<&[T], DiffsolRtError>

The column at index. 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 index_mut<T: Scalar>( &mut self, index: impl AsRef<[usize]>, ) -> Result<&mut T, DiffsolRtError>

A mutable 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_mut<T: Scalar>( &mut self, index: &[usize], ) -> Result<&mut [T], DiffsolRtError>

The column at index, as one mutable slice of shape[0] values. 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.

Trait Implementations

impl<'a> Debug for TensorViewMut<'a>

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

Formats the value using the given formatter.