Struct LinsolveOptions 

pub struct LinsolveOptions { /* private fields */ }

Options for the linear solver.

Solves (a₀ + a₁ * A) * x = b using DMRG-like sweeps with local GMRES.

Examples

use tensor4all_core::SvdTruncationPolicy;
use tensor4all_itensorlike::LinsolveOptions;

let opts = LinsolveOptions::new(5)
    .with_svd_policy(SvdTruncationPolicy::new(1e-10))
    .with_max_rank(64)
    .with_krylov_tol(1e-8)
    .with_coefficients(1.0, -1.0);

assert_eq!(opts.max_rank(), Some(64));
assert_eq!(opts.svd_policy(), Some(SvdTruncationPolicy::new(1e-10)));
assert_eq!(opts.nhalfsweeps(), 10);

Implementations

impl LinsolveOptions

pub fn new(nsweeps: usize) -> Self

Create options with the specified number of full sweeps.

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_nhalfsweeps(self, nhalfsweeps: usize) -> Self

Set number of half-sweeps.

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

Set number of full sweeps.

pub fn with_krylov_tol(self, tol: f64) -> Self

Set GMRES tolerance.

pub fn with_krylov_maxiter(self, maxiter: usize) -> Self

Set maximum GMRES iterations per local solve.

pub fn with_krylov_dim(self, dim: usize) -> Self

Set Krylov subspace dimension (restart parameter).

pub fn with_coefficients(self, a0: f64, a1: f64) -> Self

Set coefficients a₀ and a₁ in (a₀ + a₁ * A) * x = b.

pub fn with_convergence_tol(self, tol: f64) -> Self

Set convergence tolerance for early termination.

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.

pub fn krylov_tol(&self) -> f64

Get GMRES tolerance.

pub fn krylov_maxiter(&self) -> usize

Get maximum GMRES iterations per local solve.

pub fn krylov_dim(&self) -> usize

Get Krylov subspace dimension.

pub fn coefficients(&self) -> (f64, f64)

Get coefficients (a0, a1).

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

Get convergence tolerance.

Trait Implementations

impl Clone for LinsolveOptions

fn clone(&self) -> LinsolveOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinsolveOptions

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

Formats the value using the given formatter.

impl Default for LinsolveOptions

fn default() -> Self

Returns the “default value” for a type.