Struct TensorExpression 

pub struct TensorExpression { /* private fields */ }

Implementations

impl TensorExpression

pub fn new<T: AsRef<str>>(input: T) -> Self

pub fn from_raw(indices: Vec<TensorIndex>, inner: NamedExpression) -> Self

pub fn indices(&self) -> &[TensorIndex]

pub fn dimensions(&self) -> Vec<IndexSize>

pub fn rank(&self) -> usize

pub fn generation_shape(&self) -> GenerationShape

pub fn tensor_strides(&self) -> Vec<usize>

Calculates the strides for each dimension of the tensor.

The stride for a dimension is the number of elements one must skip in the flattened array to move to the next element along that dimension. The strides are calculated such that the last dimension has a stride of 1, the second to last dimension has a stride equal to the size of the last dimension, and so on.

Examples

use qudit_expr::TensorExpression;

let mut tensor = TensorExpression::new("example() {[
        [
            [ 1, 0, 0, 0 ],
            [ 0, 1, 0, 0 ],
            [ 0, 0, 1, 0 ],
            [ 0, 0, 0, 1 ],
        ], [
            [ 1, 0, 0, 0 ],
            [ 0, 1, 0, 0 ],
            [ 0, 0, 0, 1 ],
            [ 0, 0, 1, 0 ],
        ]
    ]}");

assert_eq!(tensor.tensor_strides(), vec![16, 8, 4, 2, 1]);

pub fn reindex(&mut self, new_indices: Vec<TensorIndex>) -> &mut Self

pub fn permute( &mut self, perm: &[usize], redirection: Vec<IndexDirection>, ) -> &mut Self

pub fn stack_with_identity( &self, positions: &[usize], new_dim: usize, ) -> TensorExpression

pub fn partial_trace( &self, dimension_pairs: &[(usize, usize)], ) -> TensorExpression

pub fn substitute_parameters<S: AsRef<str>, C: AsRef<Expression>>( &self, variables: &[S], values: &[C], ) -> Self

replace all variables with values, new variables given in variables input

pub fn destruct( self, ) -> (String, Vec<String>, Vec<ComplexExpression>, Vec<TensorIndex>)

Methods from Deref<Target = NamedExpression>

pub fn name(&self) -> &str

pub fn set_name(&mut self, new_name: impl Into<String>)

pub fn set_variables(&mut self, new_variables: Vec<String>)

pub fn apply_element_permutation(&mut self, elem_perm: &[usize])

Trait Implementations

impl AsRef<NamedExpression> for TensorExpression

fn as_ref(&self) -> &NamedExpression

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TensorExpression

fn clone(&self) -> TensorExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TensorExpression

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

Formats the value using the given formatter.

impl Deref for TensorExpression

type Target = NamedExpression

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TensorExpression

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<BraExpression> for TensorExpression

fn from(value: BraExpression) -> Self

Converts to this type from the input type.

impl From<BraSystemExpression> for TensorExpression

fn from(value: BraSystemExpression) -> Self

Converts to this type from the input type.

impl From<IsometryExpression> for TensorExpression

fn from(value: IsometryExpression) -> Self

Converts to this type from the input type.

impl From<KetExpression> for TensorExpression

fn from(value: KetExpression) -> Self

Converts to this type from the input type.

impl From<KetSystemExpression> for TensorExpression

fn from(value: KetSystemExpression) -> Self

Converts to this type from the input type.

impl From<KrausOperatorsExpression> for TensorExpression

fn from(value: KrausOperatorsExpression) -> Self

Converts to this type from the input type.

impl From<TensorExpression> for NamedExpression

fn from(value: TensorExpression) -> Self

Converts to this type from the input type.

impl From<UnitaryExpression> for TensorExpression

fn from(value: UnitaryExpression) -> Self

Converts to this type from the input type.

impl From<UnitarySystemExpression> for TensorExpression

fn from(value: UnitarySystemExpression) -> Self

Converts to this type from the input type.

impl PartialEq for TensorExpression

fn eq(&self, other: &TensorExpression) -> 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 TryFrom<TensorExpression> for BraExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for BraSystemExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for IsometryExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for KetExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for KetSystemExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for KrausOperatorsExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for UnitaryExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TensorExpression> for UnitarySystemExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for TensorExpression

impl StructuralPartialEq for TensorExpression