Enum SimplexShapeError 

#[non_exhaustive]
pub enum SimplexShapeError {
    TooFewVertices {
        actual: usize,
    },
    TooManyVertices {
        actual: usize,
        dimension: usize,
    },
    DimensionMismatch {
        index: usize,
        expected: usize,
        actual: usize,
    },
    CostCountMismatch {
        vertices: usize,
        costs: usize,
    },
}

A proposed simplex has inconsistent point or cost dimensions.

New variants may be added in future releases. Include a fallback arm when matching errors; existing variants remain directly constructible. Exhaustive matching outside Basin is unsupported:

use basin::SimplexShapeError;

fn handle(error: SimplexShapeError) {
    match error {
        SimplexShapeError::TooFewVertices { .. }
        | SimplexShapeError::TooManyVertices { .. }
        | SimplexShapeError::DimensionMismatch { .. }
        | SimplexShapeError::CostCountMismatch { .. } => {}
    }
}

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.

TooFewVertices

A simplex requires at least two vertices.

Fields

actual: usize

Number of supplied vertices.

TooManyVertices

A simplex in dimension coordinates has at most dimension + 1 vertices.

Fields

actual: usize

Number of supplied vertices.

dimension: usize

Coordinate count of the first vertex.

DimensionMismatch

All vertices must have the same coordinate count.

Fields

index: usize

Index of the inconsistent vertex.

expected: usize

Coordinate count of the first vertex.

actual: usize

Coordinate count of the inconsistent vertex.

CostCountMismatch

Each vertex requires one cost.

Fields

vertices: usize

Number of supplied vertices.

costs: usize

Number of supplied costs.

Trait Implementations

impl Clone for SimplexShapeError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SimplexShapeError

impl Debug for SimplexShapeError

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

Formats the value using the given formatter.

impl Display for SimplexShapeError

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

Formats the value using the given formatter.

impl Eq for SimplexShapeError

impl Error for SimplexShapeError

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 SimplexShapeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SimplexShapeError