Struct ContractOptions 

pub struct ContractOptions { /* private fields */ }

Options for tensor train contraction.

Examples

use tensor4all_core::SvdTruncationPolicy;
use tensor4all_itensorlike::ContractOptions;

let opts = ContractOptions::fit()
    .with_svd_policy(SvdTruncationPolicy::new(1e-8))
    .with_max_rank(50)
    .with_nsweeps(3);

assert_eq!(opts.max_rank(), Some(50));
assert_eq!(opts.svd_policy(), Some(SvdTruncationPolicy::new(1e-8)));
assert_eq!(opts.nhalfsweeps(), 6);

Implementations

impl ContractOptions

pub fn zipup() -> Self

Create options for zipup contraction.

pub fn fit() -> Self

Create options for fit contraction.

pub fn naive() -> Self

Create options for naive contraction.

pub fn with_max_rank(self, max_rank: usize) -> Self

Set the maximum retained bond dimension.

pub fn with_svd_policy(self, policy: SvdTruncationPolicy) -> Self

Set the explicit SVD truncation policy.

pub fn with_nhalfsweeps(self, nhalfsweeps: usize) -> Self

Set number of half-sweeps for fit contraction.

pub fn with_nsweeps(self, nsweeps: usize) -> Self

Set number of full sweeps.

A full sweep is two half-sweeps.

pub fn method(&self) -> ContractMethod

Get the contraction method.

pub fn max_rank(&self) -> Option<usize>

Get the maximum retained bond dimension.

pub fn svd_policy(&self) -> Option<SvdTruncationPolicy>

Get the SVD truncation policy override.

pub fn nhalfsweeps(&self) -> usize

Get number of half-sweeps.

Trait Implementations

impl Clone for ContractOptions

fn clone(&self) -> ContractOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractOptions

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

Formats the value using the given formatter.

impl Default for ContractOptions

fn default() -> Self

Returns the “default value” for a type.