Struct RealInterval

Source

pub struct RealInterval { /* private fields */ }

Expand description

A checked closed interval [min, max] over finite real values.

Implementations§

Source §

impl RealInterval

Source

pub const fn new(min: Real, max: Real) -> Self

Creates an interval from two validated bounds without rechecking order.

Source

pub fn try_new(min: f64, max: f64) -> Result<Self, RealError>

Creates an interval from finite min and max bounds.

§Errors

Returns RealError::NonFiniteValue when either bound is not finite, and RealError::InvalidInterval when min > max.

§Examples

use use_real::RealInterval;

let interval = RealInterval::try_new(-2.0, 6.0)?;
assert!((interval.width() - 8.0).abs() < 1.0e-12);

Examples found in repository ?

examples/basic_usage.rs (line 4)

3fn main() -> Result<(), use_real::RealError> {
4    let interval = RealInterval::try_new(-2.0, 6.0)?;
5    let value = Real::try_new(8.0)?;
6    let midpoint = interval.midpoint();
7    let clamped = interval.clamp(value);
8
9    assert!((midpoint.value() - 2.0).abs() < 1.0e-12);
10    assert_eq!(clamped, Real::try_new(6.0)?);
11    assert!(approx_eq(midpoint, Real::try_new(2.0)?, 1.0e-12)?);
12
13    Ok(())
14}

Source

pub fn validate(self) -> Result<Self, RealError>

Validates that an existing interval remains ordered.

§Errors

Returns the same error variants as Self::try_new.

Source

pub const fn min(&self) -> Real

Returns the lower bound.

Source

pub const fn max(&self) -> Real

Returns the upper bound.

Source

pub const fn width(&self) -> f64

Returns the interval width, max - min.

Source

pub const fn midpoint(&self) -> Real

Returns the midpoint of the interval.

Examples found in repository ?

examples/basic_usage.rs (line 6)

3fn main() -> Result<(), use_real::RealError> {
4    let interval = RealInterval::try_new(-2.0, 6.0)?;
5    let value = Real::try_new(8.0)?;
6    let midpoint = interval.midpoint();
7    let clamped = interval.clamp(value);
8
9    assert!((midpoint.value() - 2.0).abs() < 1.0e-12);
10    assert_eq!(clamped, Real::try_new(6.0)?);
11    assert!(approx_eq(midpoint, Real::try_new(2.0)?, 1.0e-12)?);
12
13    Ok(())
14}

Source

pub const fn contains(&self, value: Real) -> bool

Returns true when value lies inside the closed interval.

Source

pub const fn clamp(&self, value: Real) -> Real

Clamps value into the interval.

Examples found in repository ?

examples/basic_usage.rs (line 7)

3fn main() -> Result<(), use_real::RealError> {
4    let interval = RealInterval::try_new(-2.0, 6.0)?;
5    let value = Real::try_new(8.0)?;
6    let midpoint = interval.midpoint();
7    let clamped = interval.clamp(value);
8
9    assert!((midpoint.value() - 2.0).abs() < 1.0e-12);
10    assert_eq!(clamped, Real::try_new(6.0)?);
11    assert!(approx_eq(midpoint, Real::try_new(2.0)?, 1.0e-12)?);
12
13    Ok(())
14}