Struct NamedTensor 

pub struct NamedTensor<T: Scalar> { /* private fields */ }

A tensor with optional names attached to each dimension.

Unnamed dimensions use None. Named dimensions must be unique within a single tensor.

Examples

let t = Tensor::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0], vec![2, 3]).unwrap();
let nt = NamedTensor::new(t, vec![Some("batch".into()), Some("feature".into())]).unwrap();
assert_eq!(nt.dim_index("batch").unwrap(), 0);
assert_eq!(nt.dim_index("feature").unwrap(), 1);

Implementations

impl<T: Scalar> NamedTensor<T>

pub fn new(tensor: Tensor<T>, names: Vec<Option<String>>) -> Result<Self>

Create a named tensor, validating that the number of names matches the tensor’s rank and that named dimensions are unique.

Errors

Returns CoreError::InvalidArgument if names.len() != tensor.ndim() or if duplicate dimension names are found.

pub fn from_tensor(tensor: Tensor<T>) -> Self

Wrap a tensor with all dimensions unnamed.

pub fn tensor(&self) -> &Tensor<T>

Borrow the inner tensor.

pub fn names(&self) -> &[Option<String>]

Get the dimension names.

pub fn into_tensor(self) -> Tensor<T>

Consume the wrapper and return the plain tensor.

pub fn dim_index(&self, name: &str) -> Result<usize>

Look up the axis index for a named dimension.

Errors

Returns CoreError::InvalidArgument if no dimension has the given name.

pub fn rename(&mut self, old: &str, new: &str) -> Result<()>

Rename a dimension from old to new.

Errors

Returns an error if old is not found or new already exists.

pub fn set_names(&mut self, names: Vec<Option<String>>) -> Result<()>

Replace all dimension names at once.

Errors

Returns an error if the length does not match the tensor rank.

pub fn align_to(&self, target_names: &[&str]) -> Result<NamedTensor<T>>

Reorder dimensions by name, producing a permuted copy.

Every named dimension in the current tensor must appear in target_names, and the lengths must match the tensor rank.

Errors

Returns an error if a name is not found or if the number of names does not match the rank.

pub fn select(&self, name: &str, index: usize) -> Result<NamedTensor<T>>

Select a single index along a named dimension, reducing the rank by one.

Errors

Returns an error if the name is not found or the index is out of bounds.

impl<T: Scalar + Float> NamedTensor<T>

pub fn sum_dim(&self, name: &str) -> Result<NamedTensor<T>>

Sum along a named dimension, removing it from the result.

Errors

Returns an error if the name is not found.

pub fn mean_dim(&self, name: &str) -> Result<NamedTensor<T>>

Mean along a named dimension, removing it from the result.

Errors

Returns an error if the name is not found.

Trait Implementations

impl<T: Clone + Scalar> Clone for NamedTensor<T>

fn clone(&self) -> NamedTensor<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Scalar> Debug for NamedTensor<T>

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

Formats the value using the given formatter.