Trait Log2 

pub trait Log2: Sized {
    type Error: Error;

    // Required methods
    fn try_log2(self) -> Result<Self, Self::Error>;
    fn log2(self) -> Self;
}

Trait for computing the base-2 logarithm 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_log2 method. This type must implement the std::error::Error trait.

Required Methods

• try_log2: Computes the base-2 logarithm 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.
• log2: Computes the base-2 logarithm of self and directly returns the computed value. This method may panic (in Debug mode) if the computation fails.

Required Associated Types

type Error: Error

The error type that is returned by the try_log2 method.

Required Methods

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

Computes the base-2 logarithm 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 Log2::Error type.

fn log2(self) -> Self

Computes the base-2 logarithm of self and directly returns the computed value.

This method may panic (in Debug mode) if the computation fails.

Panics

This method may panic (in Debug mode) if the computation fails. It is recommended to use the try_log2 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 Log2 for f64

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

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

fn log2(self) -> Self

impl Log2 for Complex<f64>

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

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

fn log2(self) -> Self

Implementors

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

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

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

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