Trait ATanH 

pub trait ATanH: Sized {
    type Error: Error;

    // Required methods
    fn try_atanh(self) -> Result<Self, <Self as ATanH>::Error>;
    fn atanh(self) -> Self;
}

Trait for computing the inverse hyperbolic tangent of a number.

This trait defines methods for computing the inverse hyperbolic tangent of a number. It includes both a safe method that returns a Result and an unsafe method that directly returns the computed value.

Associated Types

• Error: The error type that is returned by the try_atanh method. This type must implement the std::error::Error trait.

Required Methods

• try_atanh: Computes the inverse hyperbolic tangent of self and returns a Result. If the computation is successful, it returns Ok with the computed value. If an error occurs, it returns Err with the associated error.

• atanh: Computes the inverse hyperbolic tangent of self and directly returns the computed value. In Debug mode this method may panic if the computation fails.

Required Associated Types

type Error: Error

The error type that is returned by the try_atanh method.

Required Methods

fn try_atanh(self) -> Result<Self, <Self as ATanH>::Error>

Computes the inverse hyperbolic tangent of self and returns a Result.

If the computation is successful, it returns Ok with the computed value. If an error occurs, it returns Err with the associated error.

Errors

This method returns an error if the computation fails. The error type is defined by the associated Error type.

fn atanh(self) -> Self

Computes and returns the inverse hyperbolic tangent of self.

In Debug mode this method may panic if the computation fails.

Panics

In Debug mode this method may panic if the computation fails. It is recommended to use the try_atanh method for safe computations.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl ATanH for f64

type Error = FunctionErrors<ATanHInputErrors<f64>, <f64 as RawScalarTrait>::ValidationErrors>

fn try_atanh(self) -> Result<Self, Self::Error>

fn atanh(self) -> Self

impl ATanH for Complex<f64>

type Error = FunctionErrors<ATanHInputErrors<Complex<f64>>, <Complex<f64> as RawScalarTrait>::ValidationErrors>

fn try_atanh(self) -> Result<Self, Self::Error>

fn atanh(self) -> Self

Implementors

impl<K: NumKernel> ATanH for ComplexValidated<K>

type Error = FunctionErrors<ATanHInputErrors<<<ComplexValidated<K> as TryNewValidated>::Policy as ValidationPolicy>::Value>, <<<ComplexValidated<K> as TryNewValidated>::Policy as ValidationPolicy>::Value as RawScalarTrait>::ValidationErrors>

impl<K: NumKernel> ATanH for RealValidated<K>

type Error = FunctionErrors<ATanHInputErrors<<<RealValidated<K> as TryNewValidated>::Policy as ValidationPolicy>::Value>, <<<RealValidated<K> as TryNewValidated>::Policy as ValidationPolicy>::Value as RawScalarTrait>::ValidationErrors>