Struct RealInterval 

pub struct RealInterval { /* private fields */ }

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

Implementations

impl RealInterval

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

Creates an interval from two validated bounds without rechecking order.

pub fn try_new(min: f64, max: f64) -> Result<RealInterval, 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);

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

Validates that an existing interval remains ordered.

Errors

Returns the same error variants as Self::try_new.

pub const fn min(&self) -> Real

Returns the lower bound.

pub const fn max(&self) -> Real

Returns the upper bound.

pub const fn width(&self) -> f64

Returns the interval width, max - min.

pub const fn midpoint(&self) -> Real

Returns the midpoint of the interval.

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

Returns true when value lies inside the closed interval.

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

Clamps value into the interval.

pub const fn is_degenerate(&self) -> bool

Returns true when the interval has zero width.

Trait Implementations

impl Clone for RealInterval

fn clone(&self) -> RealInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealInterval

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

Formats the value using the given formatter.

impl Display for RealInterval

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

Formats the value using the given formatter.

impl PartialEq for RealInterval

fn eq(&self, other: &RealInterval) -> 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 Copy for RealInterval

impl StructuralPartialEq for RealInterval