Struct TensorBlock 

pub struct TensorBlock { /* private fields */ }

A single block, containing both values & optionally gradients of these values w.r.t. any relevant quantity.

Implementations

impl TensorBlock

pub unsafe fn from_raw(ptr: *mut mts_block_t) -> TensorBlock

Create a new TensorBlock from a raw pointer.

This function takes ownership of the pointer, and will call mts_block_free on it when the TensorBlock goes out of scope.

Safety

The pointer must be non-null and point to a owned block, not a reference to a block from inside a TensorMap.

pub fn into_raw(block: TensorBlock) -> *mut mts_block_t

Extract the underlying raw pointer.

The pointer should be passed back to TensorBlock::from_raw or [crate::c_api::mts_block_free] to release the memory corresponding to this TensorBlock.

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

Get the underlying raw pointer.

After a call, this TensorBlock is still managing the corresponding memory. To fully release the pointer, use TensorBlock::into_raw.

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

Get the underlying (mutable) raw pointer

After a call, this TensorBlock is still managing the corresponding memory. To fully release the pointer, use TensorBlock::into_raw.

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

Get a non mutable reference to this block

pub fn as_ref_mut(&mut self) -> TensorBlockRefMut<'_>

Get a non mutable reference to this block

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(&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 new( values: impl Into<MtsArray>, samples: &Labels, components: &[Labels], properties: &Labels, ) -> Result<TensorBlock, Error>

Create a new TensorBlock containing the given data, described by the samples, components, and properties labels. The block is initialized without any gradients.

pub fn add_gradient( &mut self, parameter: &str, gradient: TensorBlock, ) -> Result<(), Error>

Add a gradient with respect to parameter to this block.

The property of the gradient should match the ones of this block. The components of the gradients must contain at least the same entries as the value components, and can prepend other components.

pub fn load(path: impl AsRef<Path>) -> Result<TensorBlock, Error>

Load a TensorBlock from the file at path

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

pub fn load_buffer(buffer: &[u8]) -> Result<TensorBlock, Error>

Load a TensorBlock from an in-memory buffer

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

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 Debug for TensorBlock

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

Formats the value using the given formatter.

impl Drop for TensorBlock

fn drop(&mut self)

Executes the destructor for this type.

impl Send for TensorBlock

impl Sync for TensorBlock