StrictFinitePolicy

Struct StrictFinitePolicy 

Source
pub struct StrictFinitePolicy<ScalarType: Sized, const PRECISION: u32>(/* private fields */);
Expand description

A validation policy that checks for strict finiteness.

For floating-point types (ScalarType = f64, ScalarType = rug::Float), this policy ensures that the value is:

  • Not NaN (Not a Number).
  • Not positive or negative Infinity.
  • Not subnormal (for f64). While rug::Float maintains its specified precision rather than having distinct subnormal representation in the IEEE 754 sense, this policy will also reject rug::Float values that are classified as FpCategory::Subnormal (e.g., results of underflow that are tiny but not exactly zero).

For complex types (ScalarType = Complex<f64>, ScalarType = rug::Complex), this policy applies the strict finiteness check to both the real and imaginary parts.

This struct is a Zero-Sized Type (ZST) and uses PhantomData to associate with the ScalarType it validates.

Trait Implementations§

Source§

impl<const PRECISION: u32> ValidationPolicy for StrictFinitePolicy<Complex, PRECISION>

Ensures both the real and imaginary parts of a rug::Complex value are strictly finite.

This policy applies the StrictFinitePolicy<rug::Float> (which checks the underlying rug::Float) to both the real and imaginary components of the rug::Complex.

§Errors

Returns ErrorsValidationRawComplex<ErrorsValidationRawReal<rug::Float>> if either the real part, the imaginary part, or both parts fail the StrictFinitePolicy<RealRugStrictFinite<Precision>> checks.

Source§

type Value = Complex

The type of the value to be validated.
Source§

type Error = ErrorsValidationRawComplex<ErrorsValidationRawReal<Float>>

The type of the error returned if validation fails.
Source§

fn validate_ref(value: &Complex) -> Result<(), Self::Error>

Validates a value by reference. Read more
Source§

fn validate(v: Self::Value) -> Result<Self::Value, Self::Error>

Validates a value by consuming it. Read more
Source§

impl<const PRECISION: u32> ValidationPolicy for StrictFinitePolicy<Float, PRECISION>

Ensures the rug::Float value is strictly finite.

This policy checks if the underlying rug::Float value:

  • Is not NaN (Not a Number).
  • Is not positive nor negative Infinity.
  • Has the specified precision (equal to PRECISION).

Note: rug::Float does not have a direct concept of “subnormal” in the same way IEEE 754 floats do; it maintains its specified precision.

§Errors

Returns ErrorsValidationRawReal<rug::Float> if the value fails any of these checks.

Source§

type Value = Float

The type of the value to be validated.
Source§

type Error = ErrorsValidationRawReal<Float>

The type of the error returned if validation fails.
Source§

fn validate_ref(value: &Float) -> Result<(), Self::Error>

Validates a value by reference. Read more
Source§

fn validate(v: Self::Value) -> Result<Self::Value, Self::Error>

Validates a value by consuming it. Read more
Source§

impl<RawComplex: RawComplexTrait, const PRECISION: u32> ValidationPolicyComplex for StrictFinitePolicy<RawComplex, PRECISION>
where StrictFinitePolicy<RawComplex, PRECISION>: ValidationPolicy<Value = RawComplex, Error = <RawComplex as RawScalarTrait>::ValidationErrors>,

Source§

const PRECISION: u32 = PRECISION

Source§

impl<RawReal: RawRealTrait, const PRECISION: u32> ValidationPolicyReal for StrictFinitePolicy<RawReal, PRECISION>
where StrictFinitePolicy<RawReal, PRECISION>: ValidationPolicy<Value = RawReal, Error = <RawReal as RawScalarTrait>::ValidationErrors>,

Source§

const PRECISION: u32 = PRECISION

Source§

impl<RawReal: RawRealTrait, const PRECISION: u32> GuaranteesFiniteValues for StrictFinitePolicy<RawReal, PRECISION>
where StrictFinitePolicy<RawReal, PRECISION>: ValidationPolicyReal,

Auto Trait Implementations§

§

impl<ScalarType, const PRECISION: u32> Freeze for StrictFinitePolicy<ScalarType, PRECISION>

§

impl<ScalarType, const PRECISION: u32> RefUnwindSafe for StrictFinitePolicy<ScalarType, PRECISION>
where ScalarType: RefUnwindSafe,

§

impl<ScalarType, const PRECISION: u32> Send for StrictFinitePolicy<ScalarType, PRECISION>
where ScalarType: Send,

§

impl<ScalarType, const PRECISION: u32> Sync for StrictFinitePolicy<ScalarType, PRECISION>
where ScalarType: Sync,

§

impl<ScalarType, const PRECISION: u32> Unpin for StrictFinitePolicy<ScalarType, PRECISION>
where ScalarType: Unpin,

§

impl<ScalarType, const PRECISION: u32> UnwindSafe for StrictFinitePolicy<ScalarType, PRECISION>
where ScalarType: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.