Struct TruncateOptions 

pub struct TruncateOptions { /* private fields */ }

Options for tensor train truncation.

Truncation is explicitly SVD-based. Canonicalization remains the API for LU/CI-style forms; truncate itself only accepts SVD truncation controls.

Examples

use tensor4all_core::SvdTruncationPolicy;
use tensor4all_itensorlike::TruncateOptions;

let opts = TruncateOptions::svd()
    .with_svd_policy(SvdTruncationPolicy::new(1e-10))
    .with_max_rank(20)
    .with_site_range(0..4);

assert_eq!(opts.svd_policy(), Some(SvdTruncationPolicy::new(1e-10)));
assert_eq!(opts.max_rank(), Some(20));
assert_eq!(opts.site_range(), Some(0..4));

Implementations

impl TruncateOptions

pub fn svd() -> Self

Create options for SVD-based truncation.

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

Set the explicit SVD truncation policy.

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

Set the maximum retained bond dimension.

pub fn with_site_range(self, range: Range<usize>) -> Self

Set the site range for truncation.

The range is 0-indexed with exclusive end.

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

Get the SVD truncation policy override.

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

Get the maximum retained bond dimension.

pub fn site_range(&self) -> Option<Range<usize>>

Get the site range for truncation.

Trait Implementations

impl Clone for TruncateOptions

fn clone(&self) -> TruncateOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TruncateOptions

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

Formats the value using the given formatter.

impl Default for TruncateOptions

fn default() -> TruncateOptions

Returns the “default value” for a type.