LogarithmComplexErrors

Type Alias LogarithmComplexErrors 

Source
pub type LogarithmComplexErrors<RawComplex> = FunctionErrors<LogarithmComplexInputErrors<RawComplex>, <RawComplex as RawScalarTrait>::ValidationErrors>;
Expand description

Errors that can occur when computing the logarithm of a complex number.

This enum represents the possible errors that can occur when computing the logarithm of a complex number. It includes errors for invalid input values and other validation errors.

§Type Parameters

  • RawComplex: A type that implements the RawComplexTrait trait. This type parameter is used to specify the numeric type for the computation and its associated raw error type <RawComplex as RawScalarTrait>::ValidationErrors.

§Variants

  • Input: Indicates that the input value is invalid. This variant includes the source error that occurred during validation.
  • Output: Indicates that the output value is invalid. This variant includes the source error that occurred during validation.

Aliased Type§

pub enum LogarithmComplexErrors<RawComplex> {
    Input {
        source: LogarithmComplexInputErrors<RawComplex>,
    },
    Output {
        source: <RawComplex as RawScalarTrait>::ValidationErrors,
    },
}

Variants§

§

Input

Error due to invalid input values.

This variant is returned when initial validation of the function’s arguments fails according to the defined validation policy (e.g., StrictFinitePolicy) or due to domain-specific constraints (e.g., negative input to a real logarithm).

Fields

§source: LogarithmComplexInputErrors<RawComplex>

The source error that occurred during input validation. This provides specific details about why the input was considered invalid.

§

Output

Error due to the computed output failing validation.

This variant is returned if the result of the computation, even from valid inputs, fails validation according to the defined policy. This typically means the result was non-finite (NaN or Infinity) or otherwise did not meet the criteria for a valid output.

Fields

§source: <RawComplex as RawScalarTrait>::ValidationErrors

The source error that occurred during output validation. This provides specific details about why the computed output was considered invalid.