Struct PositiveRealScalar 

pub struct PositiveRealScalar<RealType: RealScalar>(/* private fields */);

Type-safe wrapper for strictly positive real scalar values.

PositiveRealScalar<T> guarantees that wrapped values are strictly greater than zero. Zero is not valid for this type. For values that can be zero, use NonNegativeRealScalar.

Mathematical Definition

PositiveRealScalar<T> = { x ∈ T : x > 0 }

This is the set of positive real numbers ℝ⁺, which excludes zero.

Use Cases

• Lengths and distances that cannot be zero
• Positive tolerances
• Scaling factors that must be positive
• Any quantity that is mathematically required to be > 0

Examples

Basic Usage

use num_valid::scalars::{PositiveRealScalar, ErrorsPositiveRealScalar};
use try_create::TryNew;

// Valid positive values
let length = PositiveRealScalar::try_new(2.5_f64).unwrap();
let tiny = PositiveRealScalar::try_new(f64::MIN_POSITIVE).unwrap();

// Zero is NOT positive
assert!(matches!(
    PositiveRealScalar::try_new(0.0_f64),
    Err(ErrorsPositiveRealScalar::ZeroValue { .. })
));

// Negative values rejected
assert!(matches!(
    PositiveRealScalar::try_new(-1.0_f64),
    Err(ErrorsPositiveRealScalar::NegativeValue { .. })
));

Difference from NonNegativeRealScalar

use num_valid::scalars::{PositiveRealScalar, NonNegativeRealScalar};
use try_create::TryNew;

// Zero is INVALID for PositiveRealScalar (x > 0)
assert!(PositiveRealScalar::try_new(0.0_f64).is_err());

// Zero is VALID for NonNegativeRealScalar (x ≥ 0)
assert!(NonNegativeRealScalar::try_new(0.0_f64).is_ok());

Implementations

impl<RealType: RealScalar> PositiveRealScalar<RealType>

pub fn into_inner(self) -> RealType

Consumes the struct and returns the inner value.

Trait Implementations

impl<RealType: RealScalar> AsRef<RealType> for PositiveRealScalar<RealType>

fn as_ref(&self) -> &RealType

Converts this type into a shared reference of the (usually inferred) input type.

impl<RealType: Clone + RealScalar> Clone for PositiveRealScalar<RealType>

fn clone(&self) -> PositiveRealScalar<RealType>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<RealType: Debug + RealScalar> Debug for PositiveRealScalar<RealType>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, RealType> Deserialize<'de> for PositiveRealScalar<RealType>

where RealType: for<'a> Deserialize<'a> + RealScalar,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<RealType> Display for PositiveRealScalar<RealType>

where RealType: Display + RealScalar,

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<RealType: RealScalar> IntoInner for PositiveRealScalar<RealType>

fn into_inner(self) -> Self::InnerType

Consumes the struct and returns the inner value.

type InnerType = RealType

The type of the inner value that will be extracted.

impl<RealType: PartialEq + RealScalar> PartialEq for PositiveRealScalar<RealType>

fn eq(&self, other: &PositiveRealScalar<RealType>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<RealType: PartialOrd + RealScalar> PartialOrd for PositiveRealScalar<RealType>

fn partial_cmp(&self, other: &PositiveRealScalar<RealType>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<RealType> Serialize for PositiveRealScalar<RealType>

where RealType: Serialize + RealScalar,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<RealType: RealScalar> TryNew for PositiveRealScalar<RealType>

fn try_new(value: RealType) -> Result<Self, Self::Error>

Attempts to create a PositiveRealScalar from a value.

Errors

• ErrorsPositiveRealScalar::NegativeValue: If the input is negative (< 0).
• ErrorsPositiveRealScalar::ZeroValue: If the input is zero.

Panics (Debug Mode Only)

In debug builds, panics if the input is not finite (NaN or infinity).

Examples

use num_valid::scalars::{PositiveRealScalar, ErrorsPositiveRealScalar};
use try_create::TryNew;

// Positive value succeeds
assert!(PositiveRealScalar::try_new(1.0_f64).is_ok());

// Zero fails
assert!(matches!(
    PositiveRealScalar::try_new(0.0_f64),
    Err(ErrorsPositiveRealScalar::ZeroValue { .. })
));

// Negative fails
assert!(matches!(
    PositiveRealScalar::try_new(-1.0_f64),
    Err(ErrorsPositiveRealScalar::NegativeValue { value: v, .. }) if v == -1.0
));

type Error = ErrorsPositiveRealScalar<RealType>

The error type that can be returned by the try_new method.

impl<RealType: RealScalar> StructuralPartialEq for PositiveRealScalar<RealType>