AbsComplexErrors

Type Alias AbsComplexErrors 

Source
pub type AbsComplexErrors<RawComplex> = FunctionErrors<AbsInputErrors<RawComplex>, <<RawComplex as RawComplexTrait>::RawReal as RawScalarTrait>::ValidationErrors>;
Expand description

A type alias for FunctionErrors, specialized for errors that can occur during the computation of the absolute value (or modulus) of a complex number.

It combines input validation errors specific to the abs operation on complex numbers with potential validation errors of the resulting real number (the modulus).

§Generic Parameters

  • RawComplex: A type that implements RawComplexTrait. This defines:
    • The error type for the input complex number: AbsInputErrors<RawComplex>.
    • The raw error type for the output real number: <<RawComplex as RawComplexTrait>::RawReal as RawScalarTrait>::ValidationErrors.

§Variants

This type alias wraps FunctionErrors, which has the following variants:

  • Input { source: AbsInputErrors<RawComplex> }: Indicates that the input complex number provided for absolute value computation was invalid. The source field contains an AbsInputErrors detailing the specific input failure.
  • Output { source: <<RawComplex as RawComplexTrait>::RawReal as RawScalarTrait>::ValidationErrors }: Indicates that the computed absolute value (a real number) itself failed validation. This typically means the result of the norm() operation yielded a non-finite value. The source field contains the raw validation error for the output real number.

Aliased Type§

pub enum AbsComplexErrors<RawComplex> {
    Input {
        source: AbsInputErrors<RawComplex>,
    },
    Output {
        source: <<RawComplex as RawComplexTrait>::RawReal 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: AbsInputErrors<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 RawComplexTrait>::RawReal as RawScalarTrait>::ValidationErrors

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