Type Alias ArgErrors 

pub type ArgErrors<RawComplex> = FunctionErrors<ArgInputErrors<RawComplex>, <<RawComplex as RawComplexTrait>::RawReal as RawScalarTrait>::ValidationErrors>;

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

This type represents the possible failures when calling Arg::try_arg().

Generic Parameters

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

Variants

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

• Input { source: ArgInputErrors<RawComplex> }: Indicates that the input complex number was invalid for argument computation. This could be due to failing initial validation (e.g., containing NaN or Infinity) or because the input was zero (for which the argument is undefined). The source field provides more specific details via ArgInputErrors.

• Output { source: <<RawComplex as RawComplexTrait>::RawReal as RawScalarTrait>::ValidationErrors }: Indicates that the computed argument (a real number) failed validation. This typically means the result of the atan2 or equivalent operation yielded a non-finite value (NaN or Infinity), which is unexpected if the input was valid and non-zero. The source field provides the raw validation error for the output real number.

Aliased Type

pub enum ArgErrors<RawComplex> {
    Input {
        source: ArgInputErrors<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: ArgInputErrors<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.