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
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

/*
Copyright 2017 Martin Buck
This file is part of rust-3d.
rust-3d is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
rust-3d is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with rust-3d.  If not, see <http://www.gnu.org/licenses/>.
*/

//! NonNegative, a wrapper for a f64 value, ensuring it is always >= 0

use std::fmt;
use std::ops::{Add, AddAssign, Mul, MulAssign, Div, DivAssign};
use std::hash::{Hash, Hasher};

use prelude::*;

#[derive (Debug, PartialEq, PartialOrd, Clone, Copy)]
/// NonNegative, a wrapper for a f64 value, ensuring it is always >= 0
pub struct NonNegative {
    val: f64
}

impl NonNegative {
    /// Creates a new NonNegative if input >= 0, fails otherwise
    pub fn new(val: f64) -> Result<NonNegative> {
        if val >= 0.0 {
            return Ok(NonNegative {val});
        }
        Err(ErrorKind::NumberInWrongRange)
    }
    /// Creates a new NonNegative with value 0
    pub fn zero() -> NonNegative {
        NonNegative {val: 0.0}
    }
    /// Creates a new NonNegative with value 1
    pub fn one() -> NonNegative {
        NonNegative {val : 1.0}
    }
    /// Returns the wrapped value
    pub fn get(&self) -> f64 {
        self.val
    }
    /// Returns the square root
    pub fn sqrt(&self) -> NonNegative {
        NonNegative{val: self.val.sqrt()}
    }
}

impl From<Positive> for NonNegative {
    fn from(x: Positive) -> Self {
        NonNegative {val: x.get() }
    }
}

impl Eq for NonNegative {}

impl Hash for NonNegative {
    fn hash<H: Hasher>(&self, state: &mut H) {
        (self.val as u64).hash(state);
    }
}

impl Add for NonNegative {
    type Output = NonNegative;

    fn add(self, other: NonNegative) -> NonNegative {
        NonNegative {val: self.val + other.val}
    }
}

impl Add<Positive> for NonNegative {
    type Output = NonNegative;

    fn add(self, other: Positive) -> NonNegative {
        NonNegative {val: self.val + other.get()}
    }
}

impl AddAssign for NonNegative {
    fn add_assign(&mut self, other: NonNegative) {
        self.val += other.val;
    }
}

impl AddAssign<Positive> for NonNegative {
    fn add_assign(&mut self, other: Positive) {
        self.val += other.get();
    }
}

impl Mul for NonNegative {
    type Output = NonNegative;

    fn mul(self, other: NonNegative) -> NonNegative {
        NonNegative {val: self.val * other.val}
    }
}

impl Mul<Positive> for NonNegative {
    type Output = NonNegative;

    fn mul(self, other: Positive) -> NonNegative {
        NonNegative {val: self.val * other.get()}
    }
}

impl MulAssign for NonNegative {
    fn mul_assign(&mut self, other: NonNegative) {
        self.val *= other.val;
    }
}

impl MulAssign<Positive> for NonNegative {
    fn mul_assign(&mut self, other: Positive) {
        self.val *= other.get();
    }
}

impl Div for NonNegative {
    type Output = NonNegative;

    fn div(self, other: NonNegative) -> NonNegative {
        NonNegative {val: self.val / other.val}
    }
}

impl Div<Positive> for NonNegative {
    type Output = NonNegative;

    fn div(self, other: Positive) -> NonNegative {
        NonNegative {val: self.val / other.get()}
    }
}

impl DivAssign for NonNegative {
    fn div_assign(&mut self, other: NonNegative) {
        self.val /= other.val;
    }
}

impl DivAssign<Positive> for NonNegative {
    fn div_assign(&mut self, other: Positive) {
        self.val /= other.get();
    }
}

impl Default for NonNegative {
    fn default() -> Self {
        Self::zero()
    }
}

impl fmt::Display for NonNegative {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.val)
    }
}