Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace string function name matching with enums where possible #369

Merged
merged 1 commit into from
Dec 26, 2024
Merged

Replace string function name matching with enums where possible #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions crates/libm-test/src/gen/random.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use rand::{Rng, SeedableRng};
use rand_chacha::ChaCha8Rng;

use super::CachedInput;
use crate::{CheckCtx, GenerateInput};
use crate::{BaseName, CheckCtx, GenerateInput};

const SEED: [u8; 32] = *b"3.141592653589793238462643383279";

Expand Down Expand Up @@ -110,7 +110,6 @@ pub fn get_test_cases<RustArgs>(ctx: &CheckCtx) -> impl Iterator<Item = RustArgs
where
CachedInput: GenerateInput<RustArgs>,
{
let inputs =
if ctx.fn_name == "jn" || ctx.fn_name == "jnf" { &TEST_CASES_JN } else { &TEST_CASES };
let inputs = if ctx.base_name == BaseName::Jn { &TEST_CASES_JN } else { &TEST_CASES };
inputs.get_cases()
}
100 changes: 44 additions & 56 deletions crates/libm-test/src/precision.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use core::f32;
use CheckBasis::{Mpfr, Musl};
use Identifier as Id;

use crate::{CheckBasis, CheckCtx, Float, Identifier, Int, TestResult};
use crate::{BaseName, CheckBasis, CheckCtx, Float, Identifier, Int, TestResult};

/// Type implementing [`IgnoreCase`].
pub struct SpecialCase;
Expand Down Expand Up @@ -106,25 +106,26 @@ impl MaybeOverride<(f32,)> for SpecialCase {
ctx: &CheckCtx,
) -> Option<TestResult> {
if ctx.basis == CheckBasis::Musl {
if ctx.fn_name == "expm1f" && input.0 > 80.0 && actual.is_infinite() {
if ctx.base_name == BaseName::Expm1 && input.0 > 80.0 && actual.is_infinite() {
// we return infinity but the number is representable
return XFAIL;
}

if ctx.fn_name == "sinhf" && input.0.abs() > 80.0 && actual.is_nan() {
if ctx.base_name == BaseName::Sinh && input.0.abs() > 80.0 && actual.is_nan() {
// we return some NaN that should be real values or infinite
// doesn't seem to happen on x86
return XFAIL;
}
}

if ctx.fn_name == "acoshf" && input.0 < -1.0 {
if ctx.base_name == BaseName::Acosh && input.0 < -1.0 {
// acoshf is undefined for x <= 1.0, but we return a random result at lower
// values.
return XFAIL;
}

if ctx.fn_name == "lgammaf" || ctx.fn_name == "lgammaf_r" && input.0 < 0.0 {
if ctx.base_name == BaseName::Lgamma || ctx.base_name == BaseName::LgammaR && input.0 < 0.0
{
// loggamma should not be defined for x < 0, yet we both return results
return XFAIL;
}
Expand All @@ -141,7 +142,7 @@ impl MaybeOverride<(f32,)> for SpecialCase {
// On MPFR for lgammaf_r, we set -1 as the integer result for negative infinity but MPFR
// sets +1
if ctx.basis == CheckBasis::Mpfr
&& ctx.fn_name == "lgammaf_r"
&& ctx.base_name == BaseName::LgammaR
&& input.0 == f32::NEG_INFINITY
&& actual.abs() == expected.abs()
{
Expand All @@ -161,13 +162,13 @@ impl MaybeOverride<(f64,)> for SpecialCase {
ctx: &CheckCtx,
) -> Option<TestResult> {
if ctx.basis == CheckBasis::Musl {
if cfg!(target_arch = "x86") && ctx.fn_name == "acosh" && input.0 < 1.0 {
if cfg!(target_arch = "x86") && ctx.base_name == BaseName::Acosh && input.0 < 1.0 {
// The function is undefined, both implementations return random results
return SKIP;
}

if cfg!(x86_no_sse)
&& ctx.fn_name == "ceil"
&& ctx.base_name == BaseName::Ceil
&& input.0 < 0.0
&& input.0 > -1.0
&& expected == F::ZERO
Expand All @@ -178,13 +179,14 @@ impl MaybeOverride<(f64,)> for SpecialCase {
}
}

if ctx.fn_name == "acosh" && input.0 < 1.0 {
if ctx.base_name == BaseName::Acosh && input.0 < 1.0 {
// The function is undefined for the inputs, musl and our libm both return
// random results.
return XFAIL;
}

if ctx.fn_name == "lgamma" || ctx.fn_name == "lgamma_r" && input.0 < 0.0 {
if ctx.base_name == BaseName::Lgamma || ctx.base_name == BaseName::LgammaR && input.0 < 0.0
{
// loggamma should not be defined for x < 0, yet we both return results
return XFAIL;
}
Expand All @@ -201,7 +203,7 @@ impl MaybeOverride<(f64,)> for SpecialCase {
// On MPFR for lgamma_r, we set -1 as the integer result for negative infinity but MPFR
// sets +1
if ctx.basis == CheckBasis::Mpfr
&& ctx.fn_name == "lgamma_r"
&& ctx.base_name == BaseName::LgammaR
&& input.0 == f64::NEG_INFINITY
&& actual.abs() == expected.abs()
{
Expand All @@ -214,7 +216,7 @@ impl MaybeOverride<(f64,)> for SpecialCase {

/// Check NaN bits if the function requires it
fn maybe_check_nan_bits<F: Float>(actual: F, expected: F, ctx: &CheckCtx) -> Option<TestResult> {
if !(ctx.base_name_str == "fabs" || ctx.base_name_str == "copysign") {
if !(ctx.base_name == BaseName::Fabs || ctx.base_name == BaseName::Copysign) {
return None;
}

Expand Down Expand Up @@ -270,24 +272,16 @@ fn maybe_skip_binop_nan<F1: Float, F2: Float>(
expected: F2,
ctx: &CheckCtx,
) -> Option<TestResult> {
match ctx.basis {
CheckBasis::Musl => {
if (ctx.base_name_str == "fmax" || ctx.base_name_str == "fmin")
&& (input.0.is_nan() || input.1.is_nan())
&& expected.is_nan()
{
XFAIL
} else {
None
}
}
CheckBasis::Mpfr => {
if ctx.base_name_str == "copysign" && input.1.is_nan() {
SKIP
} else {
None
}
match (&ctx.basis, ctx.base_name) {
(Musl, BaseName::Fmin | BaseName::Fmax)
if (input.0.is_nan() || input.1.is_nan()) && expected.is_nan() =>
{
XFAIL
}

(Mpfr, BaseName::Copysign) if input.1.is_nan() => SKIP,

_ => None,
}
}

Expand All @@ -299,20 +293,17 @@ impl MaybeOverride<(i32, f32)> for SpecialCase {
ulp: &mut u32,
ctx: &CheckCtx,
) -> Option<TestResult> {
match ctx.basis {
CheckBasis::Musl => bessel_prec_dropoff(input, ulp, ctx),
CheckBasis::Mpfr => {
// We return +0.0, MPFR returns -0.0
if ctx.fn_name == "jnf"
&& input.1 == f32::NEG_INFINITY
&& actual == F::ZERO
&& expected == F::ZERO
{
XFAIL
} else {
None
}
match (&ctx.basis, ctx.base_name) {
(Musl, _) => bessel_prec_dropoff(input, ulp, ctx),

// We return +0.0, MPFR returns -0.0
(Mpfr, BaseName::Jn)
if input.1 == f32::NEG_INFINITY && actual == F::ZERO && expected == F::ZERO =>
{
XFAIL
}

_ => None,
}
}
}
Expand All @@ -324,20 +315,17 @@ impl MaybeOverride<(i32, f64)> for SpecialCase {
ulp: &mut u32,
ctx: &CheckCtx,
) -> Option<TestResult> {
match ctx.basis {
CheckBasis::Musl => bessel_prec_dropoff(input, ulp, ctx),
CheckBasis::Mpfr => {
// We return +0.0, MPFR returns -0.0
if ctx.fn_name == "jn"
&& input.1 == f64::NEG_INFINITY
&& actual == F::ZERO
&& expected == F::ZERO
{
XFAIL
} else {
bessel_prec_dropoff(input, ulp, ctx)
}
match (&ctx.basis, ctx.base_name) {
(Musl, _) => bessel_prec_dropoff(input, ulp, ctx),

// We return +0.0, MPFR returns -0.0
(Mpfr, BaseName::Jn)
if input.1 == f64::NEG_INFINITY && actual == F::ZERO && expected == F::ZERO =>
{
XFAIL
}

_ => None,
}
}
}
Expand All @@ -348,7 +336,7 @@ fn bessel_prec_dropoff<F: Float>(
ulp: &mut u32,
ctx: &CheckCtx,
) -> Option<TestResult> {
if ctx.base_name_str == "jn" {
if ctx.base_name == BaseName::Jn {
if input.0 > 4000 {
return XFAIL;
} else if input.0 > 2000 {
Expand Down
3 changes: 0 additions & 3 deletions crates/libm-test/src/test_traits.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ pub struct CheckCtx {
pub base_name: BaseName,
/// Function name.
pub fn_name: &'static str,
/// Return the unsuffixed version of the function name.
pub base_name_str: &'static str,
/// Source of truth for tests.
pub basis: CheckBasis,
}
Expand All @@ -36,7 +34,6 @@ impl CheckCtx {
fn_ident,
fn_name: fn_ident.as_str(),
base_name: fn_ident.base_name(),
base_name_str: fn_ident.base_name().as_str(),
basis,
};
ret.ulp = crate::default_ulp(&ret);
Expand Down
Loading