Struct metatensor::TensorBlock

#[repr(transparent)]
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 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 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( data: impl Array, 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.

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