Struct SplitOptions 

pub struct SplitOptions {
    pub form: CanonicalForm,
    pub final_sweep: bool,
    /* private fields */
}

Options for split operations.

Builder Pattern

use tensor4all_core::SvdTruncationPolicy;
use tensor4all_treetn::{CanonicalForm, SplitOptions};

let options = SplitOptions::default()
    .with_max_rank(50)
    .with_svd_policy(SvdTruncationPolicy::new(1e-10))
    .with_qr_rtol(1e-12)
    .with_final_sweep(true);

assert!(matches!(options.form, CanonicalForm::Unitary));
assert_eq!(options.max_rank(), Some(50));
assert_eq!(options.svd_policy(), Some(SvdTruncationPolicy::new(1e-10)));
assert_eq!(options.qr_rtol(), Some(1e-12));
assert!(options.final_sweep);

Fields

form: CanonicalForm

Canonical form / algorithm to use (SVD, QR, etc.)

final_sweep: bool

Whether to perform a final sweep for global bond dimension optimization

Implementations

impl SplitOptions

pub fn new() -> Self

Create options with default settings.

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

Create options with a maximum rank.

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

Set the SVD truncation policy used when form is unitary/SVD-based.

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

Set the QR-specific relative tolerance used when form is QR-based.

pub fn with_form(self, form: CanonicalForm) -> Self

Set the canonical form / algorithm.

pub fn with_final_sweep(self, final_sweep: bool) -> Self

Enable or disable final sweep for global optimization.

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

Get the SVD truncation policy.

pub fn qr_rtol(&self) -> Option<f64>

Get the QR-specific relative tolerance.

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

Get max_rank.

Trait Implementations

impl Clone for SplitOptions

fn clone(&self) -> SplitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitOptions

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

Formats the value using the given formatter.

impl Default for SplitOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for SplitOptions