Enum ATanHInputErrors 

pub enum ATanHInputErrors<RawScalar: RawScalarTrait> {
    OutOfDomain {
        value: RawScalar,
        backtrace: Backtrace,
    },
    InvalidArgument {
        source: <RawScalar as RawScalarTrait>::ValidationErrors,
    },
}

Errors that can occur during the computation of the inverse hyperbolic tangent.

This enum handles issues related to invalid input arguments, such as NaN or\ninfinity, as determined by the validation policy (e.g., StrictFinitePolicy).\nIt also includes domain errors specific to atanh, which is defined for -1 < x < 1\nfor real numbers and for complex numbers z where z != ±1.

Type Parameters

• RawScalar: The numeric type (e.g., f64, Complex<f64>), implementing RawScalarTrait.\n <RawScalar as RawScalarTrait>::ValidationErrors provides details of validation failures.

Variants

• InvalidArgument: Input is invalid (e.g., NaN, infinity). Wraps <RawScalar as RawScalarTrait>::ValidationErrors.\n- DomainError: Input is outside the function’s domain (e.g., |x| >= 1 for real atanh).

Variants

OutOfDomain

The input value is outside the mathematical domain of the function.

For example, for real acosh(x), x must be >= 1. For real atanh(x), |x| must be < 1. For complex versions, this refers to values on the branch cuts if they are explicitly excluded.

Fields

value: RawScalar

backtrace: Backtrace

InvalidArgument

The input argument is invalid (e.g., NaN or infinity).

This error is raised if the input value fails the validation (using the chosen implementation of ValidationPolicy). It contains the underlying error from the validation mechanism.

Fields

source: <RawScalar as RawScalarTrait>::ValidationErrors

The source error that occurred during validation.

Trait Implementations

impl<RawScalar: Debug + RawScalarTrait> Debug for ATanHInputErrors<RawScalar>

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

Formats the value using the given formatter.

impl<RawScalar: RawScalarTrait> Display for ATanHInputErrors<RawScalar>

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

Formats the value using the given formatter.

impl<RawScalar: RawScalarTrait> Error for ATanHInputErrors<RawScalar>

where <RawScalar as RawScalarTrait>::ValidationErrors: Error + 'static, Self: Debug + Display,

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

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

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

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

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

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