Struct SvdOptions 

pub struct SvdOptions {
    pub max_rank: Option<usize>,
    pub policy: Option<SvdTruncationPolicy>,
    /* private fields */
}

Options for SVD decomposition with truncation control.

Examples

use tensor4all_core::svd::{SvdOptions, svd_with};
use tensor4all_core::{DynIndex, SvdTruncationPolicy, TensorDynLen};

let i = DynIndex::new_dyn(3);
let j = DynIndex::new_dyn(3);
let data: Vec<f64> = (0..9).map(|x| x as f64).collect();
let tensor = TensorDynLen::from_dense(vec![i.clone(), j.clone()], data).unwrap();

let opts = SvdOptions::new().with_policy(SvdTruncationPolicy::new(1e-10));
let (u, s, v) = svd_with::<f64>(&tensor, &[i.clone()], &opts).unwrap();

// U has left index + bond, S is diagonal bond x bond, V has right index + bond
assert_eq!(u.dims()[0], 3);
assert_eq!(s.dims().len(), 2);

Fields

max_rank: Option<usize>

Maximum retained rank after policy-based truncation.

policy: Option<SvdTruncationPolicy>

Per-call SVD truncation policy. If None, the global default policy is used.

Implementations

impl SvdOptions

pub fn new() -> Self

Create new SVD options with no overrides.

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

Set the maximum retained rank.

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

Set the SVD truncation policy override.

Trait Implementations

impl Clone for SvdOptions

fn clone(&self) -> SvdOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SvdOptions

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

Formats the value using the given formatter.

impl Default for SvdOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for SvdOptions