Struct TensorIndex 

pub struct TensorIndex { /* private fields */ }

Represents an index of a tensor.

Indices in this format are associated with a direction, and as a result, an expected output or expected generation (input) shape and ordering. For example, a [super::network::QuditTensorNetwork] will store its output indices in this format because after evaluation, there will be an expected shape and ordering. The shape is determined by all the indices directions and sizes, and the ordering will be determined by the ids.

See Also

• [super::tensor::QuditTensor] - Tensor object capturing how tensors are generated.
• [super::network::QuditTensorNetwork] - Tensor network describing a desired calculation.

Implementations

impl TensorIndex

pub fn new( direction: IndexDirection, index_id: IndexId, index_size: IndexSize, ) -> Self

Creates a new TensorIndex instance.

Arguments

• direction - The direction of the tensor leg.
• index_id - A unique identifier for the index.
• index_size - The dimension or size of the index.

Returns

A new TensorIndex instance with the specified properties.

Examples

use qudit_expr::index::{IndexDirection, TensorIndex};

let idx = TensorIndex::new(IndexDirection::Input, 0, 2);
assert_eq!(idx.index_id(), 0);
assert_eq!(idx.index_size(), 2);
assert_eq!(idx.direction(), IndexDirection::Input);

pub fn direction(&self) -> IndexDirection

Returns the IndexDirection of the tensor leg.

Examples

use qudit_expr::index::{IndexDirection, TensorIndex};

let leg = TensorIndex::new(IndexDirection::Output, 1, 3);
assert_eq!(leg.direction(), IndexDirection::Output);

pub fn index_id(&self) -> IndexId

Returns the IndexId of the index associated with this leg.

Examples

use qudit_expr::index::{IndexDirection, TensorIndex};

let leg = TensorIndex::new(IndexDirection::Batch, 2, 4);
assert_eq!(leg.index_id(), 2);

pub fn index_size(&self) -> IndexSize

Returns the IndexSize of the index associated with this leg.

Examples

use qudit_expr::index::{IndexDirection, TensorIndex};

let leg = TensorIndex::new(IndexDirection::Input, 3, 5);
assert_eq!(leg.index_size(), 5);

Trait Implementations

impl Clone for TensorIndex

fn clone(&self) -> TensorIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TensorIndex

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

Formats the value using the given formatter.

impl Display for TensorIndex

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

Formats the value using the given formatter.

impl Hash for TensorIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TensorIndex

fn cmp(&self, other: &TensorIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TensorIndex

fn eq(&self, other: &TensorIndex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TensorIndex

fn partial_cmp(&self, other: &TensorIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TensorIndex

impl Eq for TensorIndex

impl StructuralPartialEq for TensorIndex