Struct TensorBlockRefMut 

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

Mutable reference to a TensorBlock

Implementations

impl<'a> TensorBlockRefMut<'a>

pub unsafe fn from_raw(ptr: *mut mts_block_t) -> TensorBlockRefMut<'a>

Create a new TensorBlockRefMut from the given raw mts_block_t

This is a VERY unsafe function, creating a lifetime out of thin air, and allowing mutable access to the mts_block_t. Make sure the lifetime is actually constrained by the lifetime of the owner of this mts_block_t; and that the owner is mutably borrowed by this TensorBlockRefMut.

pub fn as_ptr(&self) -> *const mts_block_t

Get the underlying raw pointer

pub fn as_mut_ptr(&mut self) -> *mut mts_block_t

Get the underlying (mutable) raw pointer

pub fn as_ref(&self) -> TensorBlockRef<'_>

Get a non mutable reference to this block

pub fn data_mut(&mut self) -> TensorBlockDataMut<'_>

Get all the data and metadata inside this TensorBlockRefMut as a struct with separate fields, to allow borrowing them separately.

pub fn device(&self) -> Result<DLDevice, Error>

Get the device on which the values of this block are stored.

pub fn dtype(&self) -> Result<DLDataType, Error>

Get the data type of the values of this block.

pub fn values_mut(&mut self) -> ArrayRefMut<'_>

Get a mutable reference to the values in this block

pub fn values(&self) -> ArrayRef<'_>

Get the array for the values in this block

pub fn samples(&self) -> Labels

Get the samples for this block

pub fn components(&self) -> Vec<Labels>

Get the components for this block

pub fn properties(&self) -> Labels

Get the properties for this block

pub fn gradient_mut(&mut self, parameter: &str) -> Option<TensorBlockRefMut<'_>>

Get a mutable reference to the data and metadata for the gradient with respect to the given parameter in this block, if it exists.

pub fn gradients_mut(&mut self) -> GradientsMutIter<'_>

Get an iterator over parameter/TensorBlockRefMut pairs for all gradients in this block

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), Error>

Save the given block to the file at path

This is a convenience function calling crate::io::save_block

pub fn save_buffer(&self, buffer: &mut Vec<u8>) -> Result<(), Error>

Save the given block to an in-memory buffer

This is a convenience function calling crate::io::save_block_buffer

Trait Implementations

impl<'a> Debug for TensorBlockRefMut<'a>

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

Formats the value using the given formatter.

impl Send for TensorBlockRefMut<'_>

impl Sync for TensorBlockRefMut<'_>