eryn/sibil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add doc tests for other Real methods

Browse source
This commit is contained in:
Eryn Wells 2017-04-15 11:01:29 -07:00
parent c46081c0c3
commit 1d7b3b9df1
1 changed files with 24 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

27
types/src/number/real.rs
View file

@ -13,7 +13,18 @@ pub enum Real {
} }
impl Real { impl Real {
/// Reduce a rational. /// Reduce a fraction to its lowest denominator. For non-Rational values,
/// this method returns an unmodified value.
///
/// # Examples
///
/// ```
/// use sibiltypes::number::Real;
///
/// assert_eq!(Real::Integer(12).reduce(), Real::Integer(12));
/// assert_eq!(Real::Rational(2, 4).reduce(), Real::Rational(1, 2));
/// assert_eq!(Real::Irrational(2.4).reduce(), Real::Irrational(2.4));
/// ```
pub fn reduce(self) -> Real { pub fn reduce(self) -> Real {
match self { match self {
Real::Rational(p, q) => { Real::Rational(p, q) => {
@ -25,6 +36,16 @@ impl Real {
} }
/// Promote a Real to the next highest type. /// Promote a Real to the next highest type.
///
/// # Examples
///
/// ```
/// use sibiltypes::number::Real;
///
/// assert_eq!(Real::Integer(5).promote_once(), Real::Rational(5, 1));
/// assert_eq!(Real::Rational(3, 5).promote_once(), Real::Irrational(0.6));
/// assert_eq!(Real::Irrational(5.65).promote_once(), Real::Irrational(5.65));
/// ```
pub fn promote_once(self) -> Real { pub fn promote_once(self) -> Real {
match self { match self {
Real::Integer(v) => Real::Rational(v, 1), Real::Integer(v) => Real::Rational(v, 1),
@ -38,11 +59,11 @@ impl Real {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use number::real::Real; /// use sibiltypes::number::Real;
/// ///
/// assert_eq!(Real::Integer(3).demote(), Real::Integer(3)); /// assert_eq!(Real::Integer(3).demote(), Real::Integer(3));
/// assert_eq!(Real::Rational(3, 1).demote(), Real::Integer(3)); /// assert_eq!(Real::Rational(3, 1).demote(), Real::Integer(3));
/// assert_eq!(Real::Irrational(3.2).demote(), Real::Rational(32, 100)); /// assert_eq!(Real::Irrational(3.2).demote(), Real::Rational(16, 5));
/// assert_eq!(Real::Irrational(3.0).demote(), Real::Integer(3)); /// assert_eq!(Real::Irrational(3.0).demote(), Real::Integer(3));
/// ``` /// ```
pub fn demote(self) -> Real { pub fn demote(self) -> Real {