Enum FloatingZoneError 

#[non_exhaustive]
pub enum FloatingZoneError<E> {
    InvalidLocalDimension {
        site: usize,
    },
    StartingPointLength {
        expected: usize,
        actual: usize,
    },
    StartingCoordinate {
        site: usize,
        coordinate: usize,
        dimension: usize,
    },
    InvalidInitialError {
        value: f64,
    },
    InvalidTolerance {
        value: f64,
    },
    AllocationSizeOverflow {
        site: usize,
    },
    Evaluation(E),
}

Invalid search inputs or an error from a floating-zone evaluator.

floating_zone_walk_with_initial_error validates the supplied starting residual before evaluating any candidate. Callback failures retain their original type in Self::Evaluation.

Examples

use tensor4all_core::{floating_zone_walk_with_initial_error, FloatingZoneError};
let result = floating_zone_walk_with_initial_error::<_, std::convert::Infallible>(
    &[2], &vec![], 0.0, 0, 1.0, |_, _| unreachable!(),
);
assert_eq!(result, Err(FloatingZoneError::StartingPointLength {
    expected: 1, actual: 0,
}));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidLocalDimension

A site’s local dimension is zero.

Fields

site: usize

Position of the invalid site.

StartingPointLength

The starting point has the wrong number of coordinates.

Fields

expected: usize

Number of local dimensions.

actual: usize

Number of supplied coordinates.

StartingCoordinate

A starting coordinate is outside its site’s local dimension.

Fields

site: usize

Position of the invalid site.

coordinate: usize

Supplied coordinate.

dimension: usize

Exclusive upper bound for the coordinate.

InvalidInitialError

The supplied starting error is negative or nonfinite.

Fields

value: f64

Supplied starting error.

InvalidTolerance

The stopping tolerance is negative or NaN.

Fields

value: f64

Supplied stopping tolerance; positive infinity is permitted.

AllocationSizeOverflow

The coordinate scan’s vector storage cannot be represented.

Fields

site: usize

Position of the site whose candidate batch is too large.

Evaluation(E)

The error-magnitude callback failed.

Trait Implementations

impl<E: Debug> Debug for FloatingZoneError<E>

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

Formats the value using the given formatter.

impl<E> Display for FloatingZoneError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E> Error for FloatingZoneError<E>

where E: Error + 'static, Self: Debug + Display,

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<E: PartialEq> PartialEq for FloatingZoneError<E>

fn eq(&self, other: &FloatingZoneError<E>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<E: PartialEq> StructuralPartialEq for FloatingZoneError<E>