Struct ApplyOptions 

pub struct ApplyOptions {
    pub method: ContractionMethod,
    pub max_rank: Option<usize>,
    pub svd_policy: Option<SvdTruncationPolicy>,
    pub qr_rtol: Option<f64>,
    pub nfullsweeps: usize,
    pub convergence_tol: Option<f64>,
}

Options for apply_linear_operator.

Controls the contraction algorithm, truncation parameters, and iterative sweep settings.

Defaults

• method: ContractionMethod::Zipup (single-sweep, no iteration)
• max_rank: None (no rank limit)
• svd_policy: None (uses the SVD global default policy)
• qr_rtol: None (uses the QR global default tolerance)
• nfullsweeps: 1 (only used by Fit method)
• convergence_tol: None (only used by Fit method)

Examples

use tensor4all_treetn::ApplyOptions;
use tensor4all_core::SvdTruncationPolicy;

// Default: Zipup with no truncation
let opts = ApplyOptions::default();
assert_eq!(opts.max_rank, None);

// Zipup with rank and tolerance limits
let opts = ApplyOptions::zipup()
    .with_max_rank(50)
    .with_svd_policy(SvdTruncationPolicy::new(1e-8));
assert_eq!(opts.max_rank, Some(50));
assert_eq!(opts.svd_policy, Some(SvdTruncationPolicy::new(1e-8)));

// Fit method with sweep control
let opts = ApplyOptions::fit().with_nfullsweeps(3).with_max_rank(20);
assert_eq!(opts.nfullsweeps, 3);

// Naive contraction (exact, no truncation)
let opts = ApplyOptions::naive();
assert_eq!(opts.max_rank, None);

Fields

method: ContractionMethod

Contraction method to use.

max_rank: Option<usize>

Maximum bond dimension for truncation.

svd_policy: Option<SvdTruncationPolicy>

Explicit SVD truncation policy.

qr_rtol: Option<f64>

QR-specific relative tolerance.

nfullsweeps: usize

Number of full sweeps for Fit method.

A full sweep visits each edge twice (forward and backward) using an Euler tour.

convergence_tol: Option<f64>

Convergence tolerance for Fit method.

Implementations

impl ApplyOptions

pub fn zipup() -> Self

Create options with ZipUp method (default).

pub fn fit() -> Self

Create options with Fit method.

pub fn naive() -> Self

Create options with Naive method.

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

Set maximum bond dimension.

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

Set the SVD truncation policy.

pub fn with_qr_rtol(self, rtol: f64) -> Self

Set the QR-specific truncation tolerance.

pub fn with_nfullsweeps(self, nfullsweeps: usize) -> Self

Set number of full sweeps for Fit method.

Trait Implementations

impl Clone for ApplyOptions

fn clone(&self) -> ApplyOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApplyOptions

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

Formats the value using the given formatter.

impl Default for ApplyOptions

fn default() -> Self

Returns the “default value” for a type.