pub type SqrtRealErrors<RawReal> = FunctionErrors<SqrtRealInputErrors<RawReal>, <RawReal as RawScalarTrait>::ValidationErrors>;
Expand description
A type alias for FunctionErrors
, specialized for errors that can occur during
the computation of the square root of a real number.
This type represents the possible failures when calling Sqrt::try_sqrt()
on a real number.
§Generic Parameters
RawReal
: A type that implementsRawRealTrait
. This defines:- The raw error type for the input real number via
SqrtRealInputErrors<RawReal>
. - The raw error type for the output real number (the square root) also via
<RawReal as RawScalarTrait>::ValidationErrors
.
- The raw error type for the input real number via
§Variants
This type alias wraps FunctionErrors
, which has the following variants in this context:
-
Input { source: SqrtRealInputErrors<RawReal> }
: Indicates that the input real number was invalid for square root computation. This could be due to the number being negative or failing general validation checks (e.g., NaN, Infinity, subnormal). Thesource
field provides more specific details viaSqrtRealInputErrors
. -
Output { source: <RawReal as RawScalarTrait>::ValidationErrors }
: Indicates that the computed square root (which should be a real number) failed validation. This typically means the result of thesqrt
operation yielded a non-finite value (NaN or Infinity), which is unexpected if the input was valid (non-negative and finite).
Aliased Type§
pub enum SqrtRealErrors<RawReal> {
Input {
source: SqrtRealInputErrors<RawReal>,
},
Output {
source: <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: SqrtRealInputErrors<RawReal>
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: <RawReal as RawScalarTrait>::ValidationErrors
The source error that occurred during output validation. This provides specific details about why the computed output was considered invalid.