Enum SpecialError 

pub enum SpecialError {
    ComputationError(String),
    DomainError(String),
    ValueError(String),
    NotImplementedError(String),
    ConvergenceError(String),
    OverflowError(String),
    GpuNotAvailable(String),
    CoreError(CoreError),
}

Error types for special function computations

This enum provides detailed error information for different failure modes that can occur during special function computations. Each variant includes contextual information to help users understand and resolve issues.

Variants

ComputationError(String)

Generic computation error for unexpected failures

Used when a computation fails for reasons not covered by more specific error types. Often indicates internal algorithmic issues or unexpected edge cases.

Examples

• Numerical integration failure
• Memory allocation failure during computation
• Internal algorithm assertion failure

DomainError(String)

Mathematical domain error - input outside the valid mathematical domain

Thrown when function arguments are outside the mathematical domain where the function is defined. This follows mathematical conventions strictly.

Examples

• gamma(-1) - gamma function undefined at negative integers
• sqrt(-1) for real-valued square root
• log(0) or log(negative) for real logarithm
• asin(2) - arcsine undefined outside [-1, 1]

ValueError(String)

Input validation error for invalid parameter values

Used for parameter validation failures where inputs don’t meet function requirements (but may be mathematically valid elsewhere).

Examples

• Negative array dimensions
• Invalid tolerance parameters (e.g., negative tolerance)
• Array shape mismatches
• Invalid enumeration values

NotImplementedError(String)

Feature or function not yet implemented

Indicates that a requested feature exists in the API but hasn’t been implemented yet. This is used during development phases.

Examples

• Complex number support for certain functions
• Specific algorithm variants
• Platform-specific optimizations

ConvergenceError(String)

Iterative algorithm convergence failure

Thrown when iterative algorithms fail to converge within specified tolerances or iteration limits. Often indicates numerical instability or inappropriate algorithm parameters.

Examples

• Newton-Raphson method divergence
• Series expansion truncation errors
• Root-finding algorithm failure
• Integration quadrature non-convergence

OverflowError(String)

Numerical overflow - result too large to represent

Occurs when mathematical operations produce results that exceed the representable range of floating-point numbers (typically > 1.8e308 for f64).

Examples

• gamma(1000) - extremely large gamma function values
• exp(1000) - exponential overflow
• Factorial of large numbers
• Product operations with many large terms

GpuNotAvailable(String)

GPU acceleration unavailable, computation falls back to CPU

Indicates that GPU computation was requested but is not available. This is often a non-fatal error where computation continues on CPU, but can be used to inform users about performance implications.

Examples

• No GPU hardware available
• GPU drivers not installed
• CUDA/OpenCL runtime unavailable
• GPU memory exhaustion

CoreError(CoreError)

Error propagated from scirs2-core dependency

Wraps errors from the core SciRS2 infrastructure. These typically relate to low-level operations like SIMD, parallel processing, or hardware acceleration.

Trait Implementations

impl Debug for SpecialError

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

Formats the value using the given formatter.

impl Display for SpecialError

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

Formats the value using the given formatter.

impl Error for SpecialError

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 From<CoreError> for SpecialError

fn from(source: CoreError) -> Self

Converts to this type from the input type.

impl From<Error> for SpecialError

Convert from standard library IO errors

Automatically converts std::io::Error into SpecialError::ComputationError for handling file I/O failures during computation or data loading.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ParseFloatError> for SpecialError

Convert from standard library float parsing errors

Automatically converts ParseFloatError into SpecialError::ValueError for seamless error propagation when parsing numerical input.

fn from(err: ParseFloatError) -> Self

Converts to this type from the input type.