pub type ReciprocalErrors<RawScalar> = FunctionErrors<ReciprocalInputErrors<RawScalar>, <RawScalar as RawScalarTrait>::ValidationErrors>;
Expand description
A type alias for FunctionErrors
, specialized for errors that can occur during
the computation of the reciprocal of a scalar number.
This type represents the possible failures when calling Reciprocal::try_reciprocal()
.
It is generic over RawScalar: RawScalarTrait
. This type alias wraps FunctionErrors
,
where the input error source is ReciprocalInputErrors<RawScalar>
and the output
error source is <RawScalar as RawScalarTrait>::ValidationErrors
.
§Variants
This type alias wraps FunctionErrors
, which has the following variants in this context:
-
Input { source: ReciprocalInputErrors<RawScalar> }
: Indicates that the input number was invalid for reciprocal computation. This could be due to failing initial validation (e.g., containing NaN or Infinity) or because the input was zero (division by zero). Thesource
field provides more specific details viaReciprocalInputErrors
. -
Output { source: <RawScalar as RawScalarTrait>::ValidationErrors }
: Indicates that the computed reciprocal value itself failed validation. This typically means the result of the reciprocal operation yielded a non-finite value (NaN or Infinity). Thesource
field provides details, usually an instance ofcrate::validation::ErrorsValidationRawReal
orcrate::validation::ErrorsValidationRawComplex
.
Aliased Type§
pub enum ReciprocalErrors<RawScalar> {
Input {
source: ReciprocalInputErrors<RawScalar>,
},
Output {
source: <RawScalar 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: ReciprocalInputErrors<RawScalar>
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: <RawScalar as RawScalarTrait>::ValidationErrors
The source error that occurred during output validation. This provides specific details about why the computed output was considered invalid.