Struct BoundPair

pub struct BoundPair<T> { /* private fields */ }

A BoundPair represents valid left and right Interval bounds

For Intervals containing finite bounds, the BoundPair construction ensures well-formed left and right bounds prior to Interval enum construction (e.g. left < right).

Implementations

impl<T> BoundPair<T>

where T: Copy + PartialOrd,

pub fn new(left: T, right: T) -> Option<BoundPair<T>>

Create a new Bound Pair with lower and upper bounds.

If the bounds are mal-formed, i.e. !(left < right), return None.

Examples

use intervals_general::bound_pair::BoundPair;
let bounds = BoundPair::new(1.0, 2.0).ok_or("invalid BoundPair")?;

Failures

use intervals_general::bound_pair::BoundPair;
assert_eq!(BoundPair::new(2, 1), None);
assert_eq!(BoundPair::new(2.0, 2.0), None);

pub fn left(&self) -> &T

Fetch an immutable reference to the left bound

Examples

use intervals_general::bound_pair::BoundPair;
let bounds = BoundPair::new(1.0, 2.0).ok_or("invalid BoundPair")?;
assert_eq!(*bounds.left(), 1.0);

pub fn right(&self) -> &T

Fetch an immutable reference to the right bound

Examples

use intervals_general::bound_pair::BoundPair;
let bounds = BoundPair::new(1.0, 2.0).ok_or("invalid BoundPair")?;
assert_eq!(*bounds.right(), 2.0);

Trait Implementations

impl<T: Clone> Clone for BoundPair<T>

fn clone(&self) -> BoundPair<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BoundPair<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for BoundPair<T>

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

impl<T> StructuralPartialEq for BoundPair<T>