honestintervals 0.2.0

Comprehensive, correctly rounding interval arithmetic library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

/// Interval parsing error enum.
#[derive(Debug)]
pub enum ParseIntervalError {
    /// The first character of the strict is anything other than `'<'`.
    MissingOpeningBracket,
    /// The first character of the strict is anything other than `'>'`.
    MissingClosingBracket,
    /// There are zero, one or more than two bounds between brackets.
    InvalidNumberOfBounds,
    /// There was an error while parsing a bound.
    BoundsParseError,
    /// Bounds do not satisfy interval criteria. See `interval::Interval::new` for details.
    InvalidBounds,
}

/// Represents the sign class of an interval.
///
/// See http://fab.cba.mit.edu/classes/S62.12/docs/Hickey_interval.pdf for details.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum SignClass {
    /// Contains both negative and positive numbers.
    Mixed,
    /// Contains only zero.
    Zero,
    /// Contains only positive numbers and maybe zero.
    Positive(bool),
    /// Contains only negative numbers and maybe zero.
    Negative(bool),
}

/// Interval struct.
///
/// Represents a set where each element `x` satisfies `lo <= x && x <= hi`.
#[derive(Clone, Debug)]
pub struct Interval<BOUND: PartialOrd> {
    /// Inclusive lower bound.
    pub lo: BOUND,
    /// Inclusive upper bound.
    pub hi: BOUND,
}