Skip to content

Commit

Permalink
Resolve clippy errors in libm tests and check this in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
tgross35 committed Nov 2, 2024
1 parent af009cc commit 4cd303d
Show file tree
Hide file tree
Showing 10 changed files with 65 additions and 83 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,10 @@ jobs:
cargo generate-lockfile && ./ci/run-docker.sh ${{ matrix.target }}
- name: Clippy
run: |
# Tests and utilities can't build on no_std targets
if: "!contains(matrix.target, 'thumb')"
# Run clippy on `libm`
cargo clippy --target "${{ matrix.target }}" --package libm
run: cargo clippy --target "${{ matrix.target }}" --package libm --all-targets


builtins:
Expand Down
6 changes: 2 additions & 4 deletions src/math/ceil.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ pub fn ceil(x: f64) -> f64 {

#[cfg(test)]
mod tests {
use core::f64::*;

use super::*;

#[test]
Expand All @@ -48,8 +46,8 @@ mod tests {
#[test]
fn spec_tests() {
// Not Asserted: that the current rounding mode has no effect.
assert!(ceil(NAN).is_nan());
for f in [0.0, -0.0, INFINITY, NEG_INFINITY].iter().copied() {
assert!(ceil(f64::NAN).is_nan());
for f in [0.0, -0.0, f64::INFINITY, f64::NEG_INFINITY].iter().copied() {
assert_eq!(ceil(f), f);
}
}
Expand Down
6 changes: 2 additions & 4 deletions src/math/ceilf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ pub fn ceilf(x: f32) -> f32 {
#[cfg(not(target_arch = "powerpc64"))]
#[cfg(test)]
mod tests {
use core::f32::*;

use super::*;

#[test]
Expand All @@ -56,8 +54,8 @@ mod tests {
#[test]
fn spec_tests() {
// Not Asserted: that the current rounding mode has no effect.
assert!(ceilf(NAN).is_nan());
for f in [0.0, -0.0, INFINITY, NEG_INFINITY].iter().copied() {
assert!(ceilf(f32::NAN).is_nan());
for f in [0.0, -0.0, f32::INFINITY, f32::NEG_INFINITY].iter().copied() {
assert_eq!(ceilf(f), f);
}
}
Expand Down
8 changes: 3 additions & 5 deletions src/math/fabs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pub fn fabs(x: f64) -> f64 {

#[cfg(test)]
mod tests {
use core::f64::*;

use super::*;

#[test]
Expand All @@ -27,12 +25,12 @@ mod tests {
/// The spec: https://en.cppreference.com/w/cpp/numeric/math/fabs
#[test]
fn spec_tests() {
assert!(fabs(NAN).is_nan());
assert!(fabs(f64::NAN).is_nan());
for f in [0.0, -0.0].iter().copied() {
assert_eq!(fabs(f), 0.0);
}
for f in [INFINITY, NEG_INFINITY].iter().copied() {
assert_eq!(fabs(f), INFINITY);
for f in [f64::INFINITY, f64::NEG_INFINITY].iter().copied() {
assert_eq!(fabs(f), f64::INFINITY);
}
}
}
8 changes: 3 additions & 5 deletions src/math/fabsf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ pub fn fabsf(x: f32) -> f32 {
#[cfg(not(target_arch = "powerpc64"))]
#[cfg(test)]
mod tests {
use core::f32::*;

use super::*;

#[test]
Expand All @@ -29,12 +27,12 @@ mod tests {
/// The spec: https://en.cppreference.com/w/cpp/numeric/math/fabs
#[test]
fn spec_tests() {
assert!(fabsf(NAN).is_nan());
assert!(fabsf(f32::NAN).is_nan());
for f in [0.0, -0.0].iter().copied() {
assert_eq!(fabsf(f), 0.0);
}
for f in [INFINITY, NEG_INFINITY].iter().copied() {
assert_eq!(fabsf(f), INFINITY);
for f in [f32::INFINITY, f32::NEG_INFINITY].iter().copied() {
assert_eq!(fabsf(f), f32::INFINITY);
}
}
}
6 changes: 2 additions & 4 deletions src/math/floor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ pub fn floor(x: f64) -> f64 {

#[cfg(test)]
mod tests {
use core::f64::*;

use super::*;

#[test]
Expand All @@ -47,8 +45,8 @@ mod tests {
#[test]
fn spec_tests() {
// Not Asserted: that the current rounding mode has no effect.
assert!(floor(NAN).is_nan());
for f in [0.0, -0.0, INFINITY, NEG_INFINITY].iter().copied() {
assert!(floor(f64::NAN).is_nan());
for f in [0.0, -0.0, f64::INFINITY, f64::NEG_INFINITY].iter().copied() {
assert_eq!(floor(f), f);
}
}
Expand Down
6 changes: 2 additions & 4 deletions src/math/floorf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ pub fn floorf(x: f32) -> f32 {
#[cfg(not(target_arch = "powerpc64"))]
#[cfg(test)]
mod tests {
use core::f32::*;

use super::*;

#[test]
Expand All @@ -57,8 +55,8 @@ mod tests {
#[test]
fn spec_tests() {
// Not Asserted: that the current rounding mode has no effect.
assert!(floorf(NAN).is_nan());
for f in [0.0, -0.0, INFINITY, NEG_INFINITY].iter().copied() {
assert!(floorf(f32::NAN).is_nan());
for f in [0.0, -0.0, f32::INFINITY, f32::NEG_INFINITY].iter().copied() {
assert_eq!(floorf(f), f);
}
}
Expand Down
85 changes: 40 additions & 45 deletions src/math/pow.rs
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,6 @@ mod tests {
extern crate core;

use self::core::f64::consts::{E, PI};
use self::core::f64::{EPSILON, INFINITY, MAX, MIN, MIN_POSITIVE, NAN, NEG_INFINITY};
use super::pow;

const POS_ZERO: &[f64] = &[0.0];
Expand All @@ -407,15 +406,15 @@ mod tests {
const NEG_ONE: &[f64] = &[-1.0];
const POS_FLOATS: &[f64] = &[99.0 / 70.0, E, PI];
const NEG_FLOATS: &[f64] = &[-99.0 / 70.0, -E, -PI];
const POS_SMALL_FLOATS: &[f64] = &[(1.0 / 2.0), MIN_POSITIVE, EPSILON];
const NEG_SMALL_FLOATS: &[f64] = &[-(1.0 / 2.0), -MIN_POSITIVE, -EPSILON];
const POS_EVENS: &[f64] = &[2.0, 6.0, 8.0, 10.0, 22.0, 100.0, MAX];
const NEG_EVENS: &[f64] = &[MIN, -100.0, -22.0, -10.0, -8.0, -6.0, -2.0];
const POS_SMALL_FLOATS: &[f64] = &[(1.0 / 2.0), f64::MIN_POSITIVE, f64::EPSILON];
const NEG_SMALL_FLOATS: &[f64] = &[-(1.0 / 2.0), -f64::MIN_POSITIVE, -f64::EPSILON];
const POS_EVENS: &[f64] = &[2.0, 6.0, 8.0, 10.0, 22.0, 100.0, f64::MAX];
const NEG_EVENS: &[f64] = &[f64::MIN, -100.0, -22.0, -10.0, -8.0, -6.0, -2.0];
const POS_ODDS: &[f64] = &[3.0, 7.0];
const NEG_ODDS: &[f64] = &[-7.0, -3.0];
const NANS: &[f64] = &[NAN];
const POS_INF: &[f64] = &[INFINITY];
const NEG_INF: &[f64] = &[NEG_INFINITY];
const NANS: &[f64] = &[f64::NAN];
const POS_INF: &[f64] = &[f64::INFINITY];
const NEG_INF: &[f64] = &[f64::NEG_INFINITY];

const ALL: &[&[f64]] = &[
POS_ZERO,
Expand Down Expand Up @@ -492,83 +491,83 @@ mod tests {
#[test]
fn nan_inputs() {
// NAN as the base:
// (NAN ^ anything *but 0* should be NAN)
test_sets_as_exponent(NAN, &ALL[2..], NAN);
// (f64::NAN ^ anything *but 0* should be f64::NAN)
test_sets_as_exponent(f64::NAN, &ALL[2..], f64::NAN);

// NAN as the exponent:
// (anything *but 1* ^ NAN should be NAN)
test_sets_as_base(&ALL[..(ALL.len() - 2)], NAN, NAN);
// f64::NAN as the exponent:
// (anything *but 1* ^ f64::NAN should be f64::NAN)
test_sets_as_base(&ALL[..(ALL.len() - 2)], f64::NAN, f64::NAN);
}

#[test]
fn infinity_as_base() {
// Positive Infinity as the base:
// (+Infinity ^ positive anything but 0 and NAN should be +Infinity)
test_sets_as_exponent(INFINITY, &POS[1..], INFINITY);
// (+Infinity ^ positive anything but 0 and f64::NAN should be +Infinity)
test_sets_as_exponent(f64::INFINITY, &POS[1..], f64::INFINITY);

// (+Infinity ^ negative anything except 0 and NAN should be 0.0)
test_sets_as_exponent(INFINITY, &NEG[1..], 0.0);
// (+Infinity ^ negative anything except 0 and f64::NAN should be 0.0)
test_sets_as_exponent(f64::INFINITY, &NEG[1..], 0.0);

// Negative Infinity as the base:
// (-Infinity ^ positive odd ints should be -Infinity)
test_sets_as_exponent(NEG_INFINITY, &[POS_ODDS], NEG_INFINITY);
test_sets_as_exponent(f64::NEG_INFINITY, &[POS_ODDS], f64::NEG_INFINITY);

// (-Infinity ^ anything but odd ints should be == -0 ^ (-anything))
// We can lump in pos/neg odd ints here because they don't seem to
// cause panics (div by zero) in release mode (I think).
test_sets(ALL, &|v: f64| pow(NEG_INFINITY, v), &|v: f64| pow(-0.0, -v));
test_sets(ALL, &|v: f64| pow(f64::NEG_INFINITY, v), &|v: f64| pow(-0.0, -v));
}

#[test]
fn infinity_as_exponent() {
// Positive/Negative base greater than 1:
// (pos/neg > 1 ^ Infinity should be Infinity - note this excludes NAN as the base)
test_sets_as_base(&ALL[5..(ALL.len() - 2)], INFINITY, INFINITY);
// (pos/neg > 1 ^ Infinity should be Infinity - note this excludes f64::NAN as the base)
test_sets_as_base(&ALL[5..(ALL.len() - 2)], f64::INFINITY, f64::INFINITY);

// (pos/neg > 1 ^ -Infinity should be 0.0)
test_sets_as_base(&ALL[5..ALL.len() - 2], NEG_INFINITY, 0.0);
test_sets_as_base(&ALL[5..ALL.len() - 2], f64::NEG_INFINITY, 0.0);

// Positive/Negative base less than 1:
let base_below_one = &[POS_ZERO, NEG_ZERO, NEG_SMALL_FLOATS, POS_SMALL_FLOATS];

// (pos/neg < 1 ^ Infinity should be 0.0 - this also excludes NAN as the base)
test_sets_as_base(base_below_one, INFINITY, 0.0);
// (pos/neg < 1 ^ Infinity should be 0.0 - this also excludes f64::NAN as the base)
test_sets_as_base(base_below_one, f64::INFINITY, 0.0);

// (pos/neg < 1 ^ -Infinity should be Infinity)
test_sets_as_base(base_below_one, NEG_INFINITY, INFINITY);
test_sets_as_base(base_below_one, f64::NEG_INFINITY, f64::INFINITY);

// Positive/Negative 1 as the base:
// (pos/neg 1 ^ Infinity should be 1)
test_sets_as_base(&[NEG_ONE, POS_ONE], INFINITY, 1.0);
test_sets_as_base(&[NEG_ONE, POS_ONE], f64::INFINITY, 1.0);

// (pos/neg 1 ^ -Infinity should be 1)
test_sets_as_base(&[NEG_ONE, POS_ONE], NEG_INFINITY, 1.0);
test_sets_as_base(&[NEG_ONE, POS_ONE], f64::NEG_INFINITY, 1.0);
}

#[test]
fn zero_as_base() {
// Positive Zero as the base:
// (+0 ^ anything positive but 0 and NAN should be +0)
// (+0 ^ anything positive but 0 and f64::NAN should be +0)
test_sets_as_exponent(0.0, &POS[1..], 0.0);

// (+0 ^ anything negative but 0 and NAN should be Infinity)
// (+0 ^ anything negative but 0 and f64::NAN should be Infinity)
// (this should panic because we're dividing by zero)
test_sets_as_exponent(0.0, &NEG[1..], INFINITY);
test_sets_as_exponent(0.0, &NEG[1..], f64::INFINITY);

// Negative Zero as the base:
// (-0 ^ anything positive but 0, NAN, and odd ints should be +0)
// (-0 ^ anything positive but 0, f64::NAN, and odd ints should be +0)
test_sets_as_exponent(-0.0, &POS[3..], 0.0);

// (-0 ^ anything negative but 0, NAN, and odd ints should be Infinity)
// (-0 ^ anything negative but 0, f64::NAN, and odd ints should be Infinity)
// (should panic because of divide by zero)
test_sets_as_exponent(-0.0, &NEG[3..], INFINITY);
test_sets_as_exponent(-0.0, &NEG[3..], f64::INFINITY);

// (-0 ^ positive odd ints should be -0)
test_sets_as_exponent(-0.0, &[POS_ODDS], -0.0);

// (-0 ^ negative odd ints should be -Infinity)
// (should panic because of divide by zero)
test_sets_as_exponent(-0.0, &[NEG_ODDS], NEG_INFINITY);
test_sets_as_exponent(-0.0, &[NEG_ODDS], f64::NEG_INFINITY);
}

#[test]
Expand All @@ -583,21 +582,17 @@ mod tests {

// Factoring -1 out:
// (negative anything ^ integer should be (-1 ^ integer) * (positive anything ^ integer))
(&[POS_ZERO, NEG_ZERO, POS_ONE, NEG_ONE, POS_EVENS, NEG_EVENS]).iter().for_each(
|int_set| {
int_set.iter().for_each(|int| {
test_sets(ALL, &|v: f64| pow(-v, *int), &|v: f64| {
pow(-1.0, *int) * pow(v, *int)
});
})
},
);
[POS_ZERO, NEG_ZERO, POS_ONE, NEG_ONE, POS_EVENS, NEG_EVENS].iter().for_each(|int_set| {
int_set.iter().for_each(|int| {
test_sets(ALL, &|v: f64| pow(-v, *int), &|v: f64| pow(-1.0, *int) * pow(v, *int));
})
});

// Negative base (imaginary results):
// (-anything except 0 and Infinity ^ non-integer should be NAN)
(&NEG[1..(NEG.len() - 1)]).iter().for_each(|set| {
NEG[1..(NEG.len() - 1)].iter().for_each(|set| {
set.iter().for_each(|val| {
test_sets(&ALL[3..7], &|v: f64| pow(*val, v), &|_| NAN);
test_sets(&ALL[3..7], &|v: f64| pow(*val, v), &|_| f64::NAN);
})
});
}
Expand Down
9 changes: 4 additions & 5 deletions src/math/sqrt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,6 @@ pub fn sqrt(x: f64) -> f64 {

#[cfg(test)]
mod tests {
use core::f64::*;

use super::*;

#[test]
Expand All @@ -239,15 +237,16 @@ mod tests {
fn spec_tests() {
// Not Asserted: FE_INVALID exception is raised if argument is negative.
assert!(sqrt(-1.0).is_nan());
assert!(sqrt(NAN).is_nan());
for f in [0.0, -0.0, INFINITY].iter().copied() {
assert!(sqrt(f64::NAN).is_nan());
for f in [0.0, -0.0, f64::INFINITY].iter().copied() {
assert_eq!(sqrt(f), f);
}
}

#[test]
#[allow(clippy::approx_constant)]
fn conformance_tests() {
let values = [3.14159265359, 10000.0, f64::from_bits(0x0000000f), INFINITY];
let values = [3.14159265359, 10000.0, f64::from_bits(0x0000000f), f64::INFINITY];
let results = [
4610661241675116657u64,
4636737291354636288u64,
Expand Down
9 changes: 4 additions & 5 deletions src/math/sqrtf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,6 @@ pub fn sqrtf(x: f32) -> f32 {
#[cfg(not(target_arch = "powerpc64"))]
#[cfg(test)]
mod tests {
use core::f32::*;

use super::*;

#[test]
Expand All @@ -125,15 +123,16 @@ mod tests {
fn spec_tests() {
// Not Asserted: FE_INVALID exception is raised if argument is negative.
assert!(sqrtf(-1.0).is_nan());
assert!(sqrtf(NAN).is_nan());
for f in [0.0, -0.0, INFINITY].iter().copied() {
assert!(sqrtf(f32::NAN).is_nan());
for f in [0.0, -0.0, f32::INFINITY].iter().copied() {
assert_eq!(sqrtf(f), f);
}
}

#[test]
#[allow(clippy::approx_constant)]
fn conformance_tests() {
let values = [3.14159265359f32, 10000.0f32, f32::from_bits(0x0000000f), INFINITY];
let values = [3.14159265359f32, 10000.0f32, f32::from_bits(0x0000000f), f32::INFINITY];
let results = [1071833029u32, 1120403456u32, 456082799u32, 2139095040u32];

for i in 0..values.len() {
Expand Down

0 comments on commit 4cd303d

Please sign in to comment.