Enum SvdTruncationOptionsError 

pub enum SvdTruncationOptionsError {
    ZeroMaxBondDim,
    InvalidThreshold(f64),
}

Error from validating optional SVD truncation options.

This is the shared typed error for the neutral validation seam reused by TreeTN truncation/contraction/fit, partition algebra and adaptive patching, and the low-level SVD entry points.

Examples

use tensor4all_core::SvdTruncationOptionsError;

assert_eq!(
    SvdTruncationOptionsError::ZeroMaxBondDim.to_string(),
    "max_bond_dim must be at least 1 when set"
);

Variants

ZeroMaxBondDim

max_bond_dim is present but zero.

InvalidThreshold(f64)

The SVD cutoff threshold is not finite or is negative.

Trait Implementations

impl Clone for SvdTruncationOptionsError

fn clone(&self) -> SvdTruncationOptionsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SvdTruncationOptionsError

impl Debug for SvdTruncationOptionsError

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

Formats the value using the given formatter.

impl Display for SvdTruncationOptionsError

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

Formats the value using the given formatter.

impl Error for SvdTruncationOptionsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for SvdTruncationOptionsError

fn eq(&self, other: &SvdTruncationOptionsError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SvdTruncationOptionsError