test/src/math/cosf_test.cpp

//===-- Unittests for cosf ------------------------------------------------===//
//
// 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 "src/math/cosf.h"
#include "test/src/math/sdcomp26094.h"
#include "utils/CPP/Array.h"
#include "utils/FPUtil/BitPatterns.h"
#include "utils/FPUtil/ClassificationFunctions.h"
#include "utils/FPUtil/FloatOperations.h"
#include "utils/FPUtil/FloatProperties.h"
#include "utils/MPFRWrapper/MPFRUtils.h"
#include "utils/UnitTest/Test.h"
#include <math.h>

#include <errno.h>
#include <stdint.h>

using __llvm_libc::fputil::isNegativeQuietNaN;
using __llvm_libc::fputil::isQuietNaN;
using __llvm_libc::fputil::valueAsBits;
using __llvm_libc::fputil::valueFromBits;

using BitPatterns = __llvm_libc::fputil::BitPatterns<float>;

using __llvm_libc::testing::sdcomp26094Values;

namespace mpfr = __llvm_libc::testing::mpfr;

TEST(LlvmLibcCosfTest, SpecialNumbers) {
  errno = 0;

  EXPECT_TRUE(
      isQuietNaN(__llvm_libc::cosf(valueFromBits(BitPatterns::aQuietNaN))));
  EXPECT_EQ(errno, 0);

  EXPECT_TRUE(isNegativeQuietNaN(
      __llvm_libc::cosf(valueFromBits(BitPatterns::aNegativeQuietNaN))));
  EXPECT_EQ(errno, 0);

  EXPECT_TRUE(isQuietNaN(
      __llvm_libc::cosf(valueFromBits(BitPatterns::aSignallingNaN))));
  EXPECT_EQ(errno, 0);

  EXPECT_TRUE(isNegativeQuietNaN(
      __llvm_libc::cosf(valueFromBits(BitPatterns::aNegativeSignallingNaN))));
  EXPECT_EQ(errno, 0);

  EXPECT_EQ(BitPatterns::one,
            valueAsBits(__llvm_libc::cosf(valueFromBits(BitPatterns::zero))));
  EXPECT_EQ(errno, 0);

  EXPECT_EQ(BitPatterns::one, valueAsBits(__llvm_libc::cosf(
                                  valueFromBits(BitPatterns::negZero))));
  EXPECT_EQ(errno, 0);

  errno = 0;
  EXPECT_TRUE(isQuietNaN(__llvm_libc::cosf(valueFromBits(BitPatterns::inf))));
  EXPECT_EQ(errno, EDOM);

  errno = 0;
  EXPECT_TRUE(
      isQuietNaN(__llvm_libc::cosf(valueFromBits(BitPatterns::negInf))));
  EXPECT_EQ(errno, EDOM);
}

TEST(LlvmLibcCosfTest, InFloatRange) {
  constexpr uint32_t count = 1000000;
  constexpr uint32_t step = UINT32_MAX / count;
  for (uint32_t i = 0, v = 0; i <= count; ++i, v += step) {
    float x = valueFromBits(v);
    if (isnan(x) || isinf(x))
      continue;
    ASSERT_MPFR_MATCH(mpfr::Operation::Cos, x, __llvm_libc::cosf(x), 1.0);
  }
}

// For small values, cos(x) is 1.
TEST(LlvmLibcCosfTest, SmallValues) {
  float x = valueFromBits(0x17800000U);
  float result = __llvm_libc::cosf(x);
  EXPECT_MPFR_MATCH(mpfr::Operation::Cos, x, result, 1.0);
  EXPECT_EQ(BitPatterns::one, valueAsBits(result));

  x = valueFromBits(0x0040000U);
  result = __llvm_libc::cosf(x);
  EXPECT_MPFR_MATCH(mpfr::Operation::Cos, x, result, 1.0);
  EXPECT_EQ(BitPatterns::one, valueAsBits(result));
}

// SDCOMP-26094: check cosf in the cases for which the range reducer
// returns values furthest beyond its nominal upper bound of pi/4.
TEST(LlvmLibcCosfTest, SDCOMP_26094) {
  for (uint32_t v : sdcomp26094Values) {
    float x = valueFromBits(v);
    ASSERT_MPFR_MATCH(mpfr::Operation::Cos, x, __llvm_libc::cosf(x), 1.0);
  }
}