CosH

Trait CosH 

Source
pub trait CosH: Sized {
    type Error: Error;

    // Required methods
    fn try_cosh(self) -> Result<Self, <Self as CosH>::Error>;
    fn cosh(self) -> Self;
}
Expand description

Trait for computing the hyperbolic cosine of a number.

This trait defines methods for computing the hyperbolic cosine 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_cosh method. This type must implement the std::error::Error trait.

§Required Methods

  • try_cosh: Computes the hyperbolic cosine 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.

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

Required Associated Types§

Source

type Error: Error

The error type that is returned by the try_cosh method.

Required Methods§

Source

fn try_cosh(self) -> Result<Self, <Self as CosH>::Error>

Computes the hyperbolic cosine 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.

Source

fn cosh(self) -> Self

Computes and returns the hyperbolic cosine 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_cosh 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§

Source§

impl CosH for f64

Source§

impl CosH for Complex<f64>

Implementors§