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

/*
Copyright 2016 Martin Buck

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall
be included all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

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

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

use crate::{prelude::*, utils::hash_f64};

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

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

impl Eq for Positive {}

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

impl Add for Positive {
    type Output = Positive;

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

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

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

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

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

impl Mul for Positive {
    type Output = Positive;

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

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

impl Into<f64> for Positive {
    fn into(self) -> f64 {
        self.val
    }
}

impl AsRef<f64> for Positive {
    fn as_ref(&self) -> &f64 {
        &self.val
    }
}

impl Default for Positive {
    fn default() -> Self {
        Self::one()
    }
}

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