system/coreutils
system/coreutils
1
0
Fork 0
mirror of https://github.com/uutils/coreutils synced 2024-10-15 12:24:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

numfmt: fix doctest and spell check

Browse source
This commit is contained in:
Terts Diepraam 2021-06-20 11:50:14 +02:00
parent eaa93e9c27
commit 5ac0274c13
2 changed files with 22 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/uu/numfmt/src/format.rs
View file

@ -131,25 +131,32 @@ fn transform_from(s: &str, opts: &Unit) -> Result<f64> {
remove_suffix(i, suffix, opts).map(|n| if n < 0.0 { -n.abs().ceil() } else { n.ceil() })
}
/// Divide numerator by denominator, with ceiling.
/// Divide numerator by denominator, with rounding.
///
/// If the result of the division is less than 10.0, truncate the result
/// to the next highest tenth.
/// If the result of the division is less than 10.0, round to one decimal point.
///
/// Otherwise, truncate the result to the next highest whole number.
/// Otherwise, round to an integer.
///
/// # Examples:
///
/// ```
/// use uu_numfmt::format::div_ceil;
/// use uu_numfmt::format::div_round;
/// use uu_numfmt::options::RoundMethod;
///
/// assert_eq!(div_ceil(1.01, 1.0), 1.1);
/// assert_eq!(div_ceil(999.1, 1000.), 1.0);
/// assert_eq!(div_ceil(1001., 10.), 101.);
/// assert_eq!(div_ceil(9991., 10.), 1000.);
/// assert_eq!(div_ceil(-12.34, 1.0), -13.0);
/// assert_eq!(div_ceil(1000.0, -3.14), -319.0);
/// assert_eq!(div_ceil(-271828.0, -271.0), 1004.0);
/// // Rounding methods:
/// assert_eq!(div_round(1.01, 1.0, RoundMethod::FromZero), 1.1);
/// assert_eq!(div_round(1.01, 1.0, RoundMethod::TowardsZero), 1.0);
/// assert_eq!(div_round(1.01, 1.0, RoundMethod::Up), 1.1);
/// assert_eq!(div_round(1.01, 1.0, RoundMethod::Down), 1.0);
/// assert_eq!(div_round(1.01, 1.0, RoundMethod::Nearest), 1.0);
///
/// // Division:
/// assert_eq!(div_round(999.1, 1000.0, RoundMethod::FromZero), 1.0);
/// assert_eq!(div_round(1001., 10., RoundMethod::FromZero), 101.);
/// assert_eq!(div_round(9991., 10., RoundMethod::FromZero), 1000.);
/// assert_eq!(div_round(-12.34, 1.0, RoundMethod::FromZero), -13.0);
/// assert_eq!(div_round(1000.0, -3.14, RoundMethod::FromZero), -319.0);
/// assert_eq!(div_round(-271828.0, -271.0, RoundMethod::FromZero), 1004.0);
/// ```
pub fn div_round(n: f64, d: f64, method: RoundMethod) -> f64 {
let v = n / d;

4
src/uu/numfmt/src/numfmt.rs
View file

@ -5,6 +5,8 @@
// * For the full copyright and license information, please view the LICENSE
// * file that was distributed with this source code.
// spell-checker:ignore N'th M'th
#[macro_use]
extern crate uucore;
@ -16,7 +18,7 @@ use std::io::{BufRead, Write};
use uucore::ranges::Range;
pub mod format;
mod options;
pub mod options;
mod units;
static ABOUT: &str = "Convert numbers from/to human-readable strings";