Struct ContractionPath 

pub struct ContractionPath {
    pub nested: FxHashMap<TensorIndex, ContractionPath>,
    pub toplevel: SimplePath,
}

A (possibly nested) contraction path.

It specifies the overall contraction path to contract a tensor network, but also allows to specify additional contraction paths for each tensor, in order to deal with composite tensors that have to be contracted first.

Fields

nested: FxHashMap<TensorIndex, ContractionPath>

Nested contraction paths for composite tensors.

toplevel: SimplePath

The top-level contraction path for the tensor network itself.

Implementations

impl ContractionPath

pub fn nested( nested: Vec<(TensorIndex, ContractionPath)>, toplevel: Vec<(TensorIndex, TensorIndex)>, ) -> Self

Creates a contraction path with nested paths.

pub fn simple(path: SimplePath) -> Self

Creates a plain contraction path without nested paths.

Examples

let path: SimplePath = vec![(0, 1), (0, 2), (0, 3)];
let contraction_path = ContractionPath::simple(path.clone());
assert!(contraction_path.is_simple());
assert_eq!(contraction_path.toplevel, path);

pub fn single(a: TensorIndex, b: TensorIndex) -> Self

Creates a contraction path from a single contraction of two tensors.

Examples

let contraction_path = ContractionPath::single(0, 1);
assert!(contraction_path.is_simple());
assert_eq!(contraction_path.toplevel, vec![(0, 1)]);

pub fn len(&self) -> usize

The length of the contraction path, that is, the number of top-level contractions.

Examples

let contraction_path = ContractionPath::simple(vec![(0, 1), (0, 2), (0, 3)]);
assert_eq!(contraction_path.len(), 3);

pub fn is_empty(&self) -> bool

Whether there are any top-level contractions in this contraction path.

Examples

assert!(ContractionPath::default().is_empty());
assert!(!ContractionPath::simple(vec![(0, 1)]).is_empty());

pub fn is_simple(&self) -> bool

Returns whether this path has no nested paths.

Examples

let simple_path = path![(0, 1), (0, 2), (0, 3)];
assert!(simple_path.is_simple());
let nested_path = path![{(2, [(0, 2), (0, 1)])}, (0, 1), (0, 2)];
assert!(!nested_path.is_simple());

pub fn into_simple(self) -> SimplePath

Converts this path to its toplevel component.

Panics

• Panics when this path has nested components

Examples

let contractions = vec![(0, 1), (0, 2), (0, 3)];
let simple_path = ContractionPath::simple(contractions.clone());
assert_eq!(simple_path.into_simple(), contractions);

Trait Implementations

impl Clone for ContractionPath

fn clone(&self) -> ContractionPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractionPath

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

Formats the value using the given formatter.

impl Default for ContractionPath

fn default() -> ContractionPath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractionPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContractionPath

fn eq(&self, other: &ContractionPath) -> 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 Serialize for ContractionPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ContractionPath

impl StructuralPartialEq for ContractionPath