xref: /aosp_15_r20/external/llvm-libc/test/src/math/sincosf_test.cpp (revision 71db0c75aadcf003ffe3238005f61d7618a3fead)

//===-- Unittests for sincosf ---------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "hdr/math_macros.h"
#include "src/__support/FPUtil/FPBits.h"
#include "src/errno/libc_errno.h"
#include "src/math/sincosf.h"
#include "test/UnitTest/FPMatcher.h"
#include "test/UnitTest/Test.h"
#include "test/src/math/sdcomp26094.h"
#include "utils/MPFRWrapper/MPFRUtils.h"

#include <stdint.h>

using LlvmLibcSinCosfTest = LIBC_NAMESPACE::testing::FPTest<float>;

using LIBC_NAMESPACE::testing::SDCOMP26094_VALUES;

namespace mpfr = LIBC_NAMESPACE::testing::mpfr;

TEST_F(LlvmLibcSinCosfTest, SpecialNumbers) {
  LIBC_NAMESPACE::libc_errno = 0;
  float sin, cos;

  LIBC_NAMESPACE::sincosf(aNaN, &sin, &cos);
  EXPECT_FP_EQ(aNaN, cos);
  EXPECT_FP_EQ(aNaN, sin);
  EXPECT_MATH_ERRNO(0);

  LIBC_NAMESPACE::sincosf(0.0f, &sin, &cos);
  EXPECT_FP_EQ(1.0f, cos);
  EXPECT_FP_EQ(0.0f, sin);
  EXPECT_MATH_ERRNO(0);

  LIBC_NAMESPACE::sincosf(-0.0f, &sin, &cos);
  EXPECT_FP_EQ(1.0f, cos);
  EXPECT_FP_EQ(-0.0f, sin);
  EXPECT_MATH_ERRNO(0);

  LIBC_NAMESPACE::sincosf(inf, &sin, &cos);
  EXPECT_FP_EQ(aNaN, cos);
  EXPECT_FP_EQ(aNaN, sin);
  EXPECT_MATH_ERRNO(EDOM);

  LIBC_NAMESPACE::sincosf(neg_inf, &sin, &cos);
  EXPECT_FP_EQ(aNaN, cos);
  EXPECT_FP_EQ(aNaN, sin);
  EXPECT_MATH_ERRNO(EDOM);
}

#define EXPECT_SINCOS_MATCH_ALL_ROUNDING(input)                                \
  {                                                                            \
    float sin, cos;                                                            \
    namespace mpfr = LIBC_NAMESPACE::testing::mpfr;                            \
                                                                               \
    mpfr::ForceRoundingMode __r1(mpfr::RoundingMode::Nearest);                 \
    if (__r1.success) {                                                        \
      LIBC_NAMESPACE::sincosf(input, &sin, &cos);                              \
      EXPECT_MPFR_MATCH(mpfr::Operation::Sin, input, sin, 0.5,                 \
                        mpfr::RoundingMode::Nearest);                          \
      EXPECT_MPFR_MATCH(mpfr::Operation::Cos, input, cos, 0.5,                 \
                        mpfr::RoundingMode::Nearest);                          \
    }                                                                          \
                                                                               \
    mpfr::ForceRoundingMode __r2(mpfr::RoundingMode::Upward);                  \
    if (__r2.success) {                                                        \
      LIBC_NAMESPACE::sincosf(input, &sin, &cos);                              \
      EXPECT_MPFR_MATCH(mpfr::Operation::Sin, input, sin, 0.5,                 \
                        mpfr::RoundingMode::Upward);                           \
      EXPECT_MPFR_MATCH(mpfr::Operation::Cos, input, cos, 0.5,                 \
                        mpfr::RoundingMode::Upward);                           \
    }                                                                          \
                                                                               \
    mpfr::ForceRoundingMode __r3(mpfr::RoundingMode::Downward);                \
    if (__r3.success) {                                                        \
      LIBC_NAMESPACE::sincosf(input, &sin, &cos);                              \
      EXPECT_MPFR_MATCH(mpfr::Operation::Sin, input, sin, 0.5,                 \
                        mpfr::RoundingMode::Downward);                         \
      EXPECT_MPFR_MATCH(mpfr::Operation::Cos, input, cos, 0.5,                 \
                        mpfr::RoundingMode::Downward);                         \
    }                                                                          \
                                                                               \
    mpfr::ForceRoundingMode __r4(mpfr::RoundingMode::TowardZero);              \
    if (__r4.success) {                                                        \
      LIBC_NAMESPACE::sincosf(input, &sin, &cos);                              \
      EXPECT_MPFR_MATCH(mpfr::Operation::Sin, input, sin, 0.5,                 \
                        mpfr::RoundingMode::TowardZero);                       \
      EXPECT_MPFR_MATCH(mpfr::Operation::Cos, input, cos, 0.5,                 \
                        mpfr::RoundingMode::TowardZero);                       \
    }                                                                          \
  }

TEST_F(LlvmLibcSinCosfTest, InFloatRange) {
  constexpr uint32_t COUNT = 1'001;
  constexpr uint32_t STEP = UINT32_MAX / COUNT;
  for (uint32_t i = 0, v = 0; i <= COUNT; ++i, v += STEP) {
    float x = FPBits(v).get_val();
    if (FPBits(v).is_nan() || FPBits(v).is_inf())
      continue;

    EXPECT_SINCOS_MATCH_ALL_ROUNDING(x);
    EXPECT_SINCOS_MATCH_ALL_ROUNDING(-x);
  }
}

// For hard to round inputs.
TEST_F(LlvmLibcSinCosfTest, SpecialValues) {
  constexpr int N = 43;
  constexpr uint32_t INPUTS[N] = {
      0x3b56'37f5U, // x = 0x1.ac6feap-9f
      0x3f06'0a92U, // x = pi/6
      0x3f3a'dc51U, // x = 0x1.75b8a2p-1f
      0x3f49'0fdbU, // x = pi/4
      0x3f86'0a92U, // x = pi/3
      0x3fa7'832aU, // x = 0x1.4f0654p+0f
      0x3fc9'0fdbU, // x = pi/2
      0x4017'1973U, // x = 0x1.2e32e6p+1f
      0x4049'0fdbU, // x = pi
      0x4096'cbe4U, // x = 0x1.2d97c8p+2f
      0x40c9'0fdbU, // x = 2*pi
      0x433b'7490U, // x = 0x1.76e92p+7f
      0x437c'e5f1U, // x = 0x1.f9cbe2p+7f
      0x4619'9998U, // x = 0x1.33333p+13f
      0x474d'246fU, // x = 0x1.9a48dep+15f
      0x4afd'ece4U, // x = 0x1.fbd9c8p+22f
      0x4c23'32e9U, // x = 0x1.4665d2p+25f
      0x50a3'e87fU, // x = 0x1.47d0fep+34f
      0x5239'47f6U, // x = 0x1.728fecp+37f
      0x53b1'46a6U, // x = 0x1.628d4cp+40f
      0x5532'5019U, // x = 0x1.64a032p+43f
      0x55ca'fb2aU, // x = 0x1.95f654p+44f
      0x588e'f060U, // x = 0x1.1de0cp+50f
      0x5922'aa80U, // x = 0x1.4555p+51f
      0x5aa4'542cU, // x = 0x1.48a858p+54f
      0x5c07'bcd0U, // x = 0x1.0f79ap+57f
      0x5ebc'fddeU, // x = 0x1.79fbbcp+62f
      0x5f18'b878U, // x = 0x1.3170fp+63f
      0x5fa6'eba7U, // x = 0x1.4dd74ep+64f
      0x6115'cb11U, // x = 0x1.2b9622p+67f
      0x61a4'0b40U, // x = 0x1.48168p+68f
      0x6386'134eU, // x = 0x1.0c269cp+72f
      0x6589'8498U, // x = 0x1.13093p+76f
      0x6600'0001U, // x = 0x1.000002p+77f
      0x664e'46e4U, // x = 0x1.9c8dc8p+77f
      0x66b0'14aaU, // x = 0x1.602954p+78f
      0x67a9'242bU, // x = 0x1.524856p+80f
      0x6a19'76f1U, // x = 0x1.32ede2p+85f
      0x6c55'da58U, // x = 0x1.abb4bp+89f
      0x6f79'be45U, // x = 0x1.f37c8ap+95f
      0x7276'69d4U, // x = 0x1.ecd3a8p+101f
      0x7758'4625U, // x = 0x1.b08c4ap+111f
      0x7bee'f5efU, // x = 0x1.ddebdep+120f
  };

  for (int i = 0; i < N; ++i) {
    float x = FPBits(INPUTS[i]).get_val();
    EXPECT_SINCOS_MATCH_ALL_ROUNDING(x);
    EXPECT_SINCOS_MATCH_ALL_ROUNDING(-x);
  }
}

// SDCOMP-26094: check sinf in the cases for which the range reducer
// returns values furthest beyond its nominal upper bound of pi/4.
TEST_F(LlvmLibcSinCosfTest, SDCOMP_26094) {
  for (uint32_t v : SDCOMP26094_VALUES) {
    float x = FPBits(v).get_val();
    EXPECT_SINCOS_MATCH_ALL_ROUNDING(x);
    EXPECT_SINCOS_MATCH_ALL_ROUNDING(-x);
  }
}