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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
//! # Round numbers and durations to a given factor
//!
//! This provides an implementation of rounding for various values, including
//! the the native number types and [`core::time::Duration`] (also known as
//! `std::time::Duration`).
//!
//! The [`Roundable`] trait adds the following functions to roundable values:
//!
//! * [`Roundable::try_round_to(factor, tie_strategy)`](Roundable::try_round_to())
//! (returns `None` on overflow)
//! * [`Roundable::round_to(factor, tie_strategy)`](Roundable::round_to())
//! (panics on overflow)
//!
//! ### Example
//!
//! ```rust
//! use roundable::{Roundable, Tie};
//!
//! assert!(310 == 314.round_to(10, Tie::Up));
//! assert!(300.0 == 314.1.round_to(100.0, Tie::Up));
//!
//! // To avoid panicking on overflow:
//! assert!(Some(260) == 255.try_round_to(10, Tie::Up));
//! assert!(None == 255u8.try_round_to(10, Tie::Up));
//! ```
//!
//! ## Tie strategies
//!
//! “Ties” are numbers exactly halfway between two round numbers, e.g. 0.5 when
//! rounding to the nearest whole number. Traditionally, ties are resolved by
//! picking the higher number, but there are other strategies. `Roundable` supports
//! the following rules:
//!
//! * [`Tie::Up`]: Round ties up (what most people consider correct).
//! * [`Tie::Down`]: Round ties down.
//! * [`Tie::TowardZero`]: Round ties toward zero.
//! * [`Tie::AwayFromZero`]: Round ties away from zero.
//! * [`Tie::TowardEven`]: Round ties toward the “even” number (see docs).
//! * [`Tie::TowardOdd`]: Round ties toward the “odd” number (see docs).
//!
//! ## Rounding `Duration`
//!
//! [`Duration`](core::time::Duration) can be rounded to a `Duration` factor,
//! just like a number type. For convenience, there are a number of
//! [constants](#constants) that can be used to make rounding `Duration` easier.
//!
//! ```rust
//! use roundable::{SECOND, MINUTE, Roundable, Tie};
//! use std::time::Duration;
//!
//! assert!(Duration::ZERO == Duration::from_millis(314).round_to(SECOND, Tie::Up));
//! assert!(MINUTE == Duration::from_millis(59_500).round_to(SECOND, Tie::Up));
//! ```
//!
//! ## `#![no_std]` by default
//!
//! You can use this crate with or without `std` and `alloc`. You do not need to
//! enable or disable features either way.
//!
//! ## Minimum supported Rust version
//!
//! Currently the minimum supported Rust version (MSRV) is **1.56.1**. Future
//! increases in the MSRV will require a major version bump.
// Lint configuration in Cargo.toml isn’t supported by cargo-geiger.
#![forbid(unsafe_code)]
#![no_std]
mod duration;
pub use duration::*;
mod float;
mod int;
/// How to handle a value that is exactly half, e.g. `5.round_to(10, ...)`.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Tie {
/// Round half up (what most people consider correct).
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(10 == 5.round_to(10, Tie::Up));
/// assert!(0 == (-5).round_to(10, Tie::Up));
///
/// // Other values are unaffected:
/// assert!(0 == 4.round_to(10, Tie::Up));
/// assert!(10 == 6.round_to(10, Tie::Up));
/// assert!(0 == (-4).round_to(10, Tie::Up));
/// assert!(-10 == (-6).round_to(10, Tie::Up));
/// ```
Up,
/// Round half down.
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(0 == 5.round_to(10, Tie::Down));
/// assert!(-10 == (-5).round_to(10, Tie::Down));
///
/// // Other values are unaffected:
/// assert!(0 == 4.round_to(10, Tie::Down));
/// assert!(10 == 6.round_to(10, Tie::Down));
/// assert!(0 == (-4).round_to(10, Tie::Down));
/// assert!(-10 == (-6).round_to(10, Tie::Down));
/// ```
Down,
/// Round half toward zero.
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(0 == 5.round_to(10, Tie::TowardZero));
/// assert!(0 == (-5).round_to(10, Tie::TowardZero));
///
/// // Other values are unaffected:
/// assert!(0 == 4.round_to(10, Tie::TowardZero));
/// assert!(10 == 6.round_to(10, Tie::TowardZero));
/// assert!(0 == (-4).round_to(10, Tie::TowardZero));
/// assert!(-10 == (-6).round_to(10, Tie::TowardZero));
/// ```
TowardZero,
/// Round half away from zero.
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(10 == 5.round_to(10, Tie::AwayFromZero));
/// assert!(-10 == (-5).round_to(10, Tie::AwayFromZero));
///
/// // Other values are unaffected:
/// assert!(0 == 4.round_to(10, Tie::AwayFromZero));
/// assert!(10 == 6.round_to(10, Tie::AwayFromZero));
/// assert!(0 == (-4).round_to(10, Tie::AwayFromZero));
/// assert!(-10 == (-6).round_to(10, Tie::AwayFromZero));
/// ```
AwayFromZero,
/// Round half toward even.
///
/// “Even” has a special meaning here since we only care about round values.
/// If we are rounding to the nearest 10, then 0 is even, 10 is odd, 20 is
/// even, and so on.
///
/// If we are rounding to whole numbers, then even and odd have the
/// conventional meaning.
///
/// In general, a multiple of factor _n_ is even if `(n / factor) % 2 == 0`.
///
/// ## Examples
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(20 == 15.round_to(10, Tie::TowardEven));
/// assert!(0 == 5.round_to(10, Tie::TowardEven));
/// assert!(0 == (-5).round_to(10, Tie::TowardEven));
/// assert!(-20 == (-15).round_to(10, Tie::TowardEven));
///
/// // Other values are unaffected:
/// assert!(0 == 4.round_to(10, Tie::TowardEven));
/// assert!(10 == 6.round_to(10, Tie::TowardEven));
/// assert!(0 == (-4).round_to(10, Tie::TowardEven));
/// assert!(-10 == (-6).round_to(10, Tie::TowardEven));
/// ```
TowardEven,
/// Round half toward odd.
///
/// “Odd” has a special meaning here since we only care about round values.
/// If we are rounding to the nearest 10, then 0 is even, 10 is odd, 20 is
/// even, and so on.
///
/// If we are rounding to whole numbers, then even and odd have the
/// conventional meaning.
///
/// In general, a multiple of factor _n_ is odd if `(n / factor) % 2 != 0`.
///
/// ## Examples
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(10 == 15.round_to(10, Tie::TowardOdd));
/// assert!(10 == 5.round_to(10, Tie::TowardOdd));
/// assert!(-10 == (-5).round_to(10, Tie::TowardOdd));
/// assert!(-10 == (-15).round_to(10, Tie::TowardOdd));
///
/// // Other values are unaffected:
/// assert!(0 == 4.round_to(10, Tie::TowardOdd));
/// assert!(10 == 6.round_to(10, Tie::TowardOdd));
/// assert!(0 == (-4).round_to(10, Tie::TowardOdd));
/// assert!(-10 == (-6).round_to(10, Tie::TowardOdd));
/// ```
TowardOdd,
}
/// Methods to round to an arbitrary factor.
///
/// For example, you might wish to round an integer to the nearest ten or
/// nearest hundred:
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(310 == 314.round_to(10, Tie::Up));
/// assert!(Some(300) == 314.try_round_to(100, Tie::Up));
/// ```
pub trait Roundable: Sized {
/// Round to the nearest `factor`. Panics if there is an overflow.
///
/// Ties (values exactly halfway between to round numbers) are handled
/// according to the second parameter. For traditional rounding use
/// [`Tie::Up`], which will cause ties to be resolved by choosing the higher
/// round number.
///
/// See [`Tie`] for other tie strategies.
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(315 == 314.round_to(5, Tie::Up));
/// assert!(-10 == (-15).round_to(10, Tie::Up));
/// ```
///
/// `255u8` can’t be rounded to the nearest 10 (which would be 260) because
/// 260 won’t fit in a `u8`:
///
/// ```rust,should_panic
/// # use roundable::{Roundable, Tie};
/// let _ = 255u8.round_to(10u8, Tie::Up);
/// ```
///
/// # Panics
///
/// Panics if `factor` is not positive, e.g. if it’s 0, or if rounding would
/// return a value that does not fit in the return type.
#[must_use]
fn round_to(self, factor: Self, tie: Tie) -> Self {
self.try_round_to(factor, tie)
.expect("overflow while rounding")
}
/// Round to the nearest `factor`. Returns `None` if there is an overflow.
///
/// Ties (values exactly halfway between to round numbers) are handled
/// according to the second parameter. For traditional rounding use
/// [`Tie::Up`], which will cause ties to be resolved by choosing the higher
/// round number.
///
/// See [`Tie`] for other tie strategies.
///
/// ```rust
/// use roundable::{Roundable, Tie};
///
/// assert!(Some(315) == 314.try_round_to(5, Tie::Up));
/// assert!(Some(-10) == (-15).try_round_to(10, Tie::Up));
/// ```
///
/// `255u8` can’t be rounded to the nearest 10 (which would be 260) because
/// 260 won’t fit in a `u8`:
///
/// ```rust
/// # use roundable::{Roundable, Tie};
/// assert!(None == 255u8.try_round_to(10, Tie::Up));
/// ```
///
/// # Panics
///
/// Panics if `factor` is not positive, e.g. if it’s 0.
#[must_use]
fn try_round_to(self, factor: Self, tie: Tie) -> Option<Self>;
}