Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[libc][math] Implementation of sinpi, correctly rounded to all modes #137953

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.

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

nspheric
Copy link

@nspheric nspheric commented Apr 30, 2025

This is the implementation of sinpi using double-double arithmetic, correctly rounded to all modes.
This is for the fast pass version though.

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the libc label Apr 30, 2025
@llvmbot
Copy link
Member

llvmbot commented Apr 30, 2025

@llvm/pr-subscribers-libc

Author: None (nspheric)

Changes

This is the implementation of sinpi using double-double arithmetic, correctly rounded for all modes.


Full diff: https://github.com/llvm/llvm-project/pull/137953.diff

3 Files Affected:

  • (added) libc/src/math/generic/sinpi.cpp (+95)
  • (added) libc/test/math/smoke/sinpi_test.cpp (+47)
  • (added) libc/test/src/math/sinpi_test.cpp (+87)
diff --git a/libc/src/math/generic/sinpi.cpp b/libc/src/math/generic/sinpi.cpp
new file mode 100644
index 0000000000000..31aa5f105617c
--- /dev/null
+++ b/libc/src/math/generic/sinpi.cpp
@@ -0,0 +1,95 @@
+#include "src/math/sinpi.h"
+#include "sincos_eval.h"
+#include "src/__support/FPUtil/BasicOperations.h"
+#include "src/__support/FPUtil/FEnvImpl.h"
+#include "src/__support/FPUtil/FPBits.h"
+#include "src/__support/FPUtil/multiply_add.h"
+#include "src/__support/common.h"
+#include "src/__support/macros/config.h"
+#include "src/__support/FPUtil/double_double.h"
+#include "src/__support/FPUtil/generic/mul.h"
+#include "src/__support/FPUtil/nearest_integer.h"
+#include "src/math/pow.h"
+//#include "range_reduction_double_nofma.h"
+//#include "src/__support/FPUtil/multiply_add.h"
+//#include "src/math/generic/range_reduction_double_common.h"
+#include <iostream>
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(double, sinpi, (double x)) {
+  // Given x * pi = y - (k * (pi/128)) 
+  // find y and k such that
+  // y = x * pi - (k * pi/128) = x * pi - kpi/128
+  // k = round(x, 128)
+
+  using FPBits = typename fputil::FPBits<double>;
+  using DoubleDouble = fputil::DoubleDouble;
+
+  FPBits xbits(x);
+
+  double k = fputil::nearest_integer(x * 128);
+  int  k_int = static_cast<int>(k);
+
+  std::cout << "k" << k << std::endl;
+
+  double yk = x - k/128;
+
+  DoubleDouble yy = fputil::exact_mult(yk, 3.141592653589793115997963468544185161590576171875);
+  yy.lo = fputil::multiply_add(yk, 1.2246467991473532071737640294583966046256921246776e-16, yy.lo);
+
+  uint64_t abs_u = xbits.uintval();
+
+  uint64_t x_abs = abs_u & 0xFFFFFFFFFFFFFFFF;
+
+  if (LIBC_UNLIKELY(x_abs == 0U))
+    return x;
+  if (x_abs >= 0x4330000000000000) {
+    if (xbits.is_nan())
+      return x;
+    if (xbits.is_inf()) {
+      fputil::set_errno_if_required(EDOM);
+      fputil::raise_except_if_required(FE_INVALID);
+      return FPBits::quiet_nan().get_val();
+    }
+    return FPBits::zero(xbits.sign()).get_val();
+  }
+
+  DoubleDouble sin_y, cos_y;
+
+  [[maybe_unused]] double err = generic::sincos_eval(yy, sin_y, cos_y);
+  DoubleDouble sin_k = SIN_K_PI_OVER_128[k_int & 255];
+  DoubleDouble cos_k = SIN_K_PI_OVER_128[(k_int + 64) & 255];
+
+  std::cout << "sin_k: " << sin_k.hi << std::endl;
+  std::cout << "sin_klo: " << sin_k.lo << std::endl;
+  std::cout << "sin_y: " << sin_y.hi << std::endl;
+  std::cout << "cos_y: " << cos_y.hi << std::endl;
+  std::cout << "sin_y.lo: " << sin_y.lo << std::endl;
+  std::cout << "cos_y.o: " << cos_y.lo << std::endl;
+
+  double cosm1_y = cos_y.hi - 1.0;
+  DoubleDouble sin_y_cos_k = fputil::quick_mult(sin_y, cos_k);
+
+  std::cout << "cosm1" << cosm1_y << std::endl;
+  DoubleDouble cosm1_yy;
+  cosm1_yy.hi = cosm1_y;
+  cosm1_yy.lo = 0.0;
+
+  DoubleDouble cos_y_sin_k = fputil::quick_mult(cos_y, sin_k);
+  DoubleDouble rr = fputil::exact_add<false>(sin_y_cos_k.hi, cos_y_sin_k.hi);
+
+  std::cout << "r.hi:" << rr.hi << std::endl;
+  std::cout << "r.lo" << rr.lo << std::endl;
+
+  rr.lo += sin_y_cos_k.lo + cos_y_sin_k.lo;
+
+  std::cout << "rrlo2: " << rr.lo << std::endl;  
+  std::cout << "cos_y_sin_k:" << cos_y_sin_k.hi << std::endl;
+  std::cout << "siny*cosk.lo:" << sin_y_cos_k.lo << std::endl;
+  std::cout << "rrhi + rrlo + sink.hi " << rr.hi + rr.lo + sin_k.hi + sin_k.lo << std::endl;
+  std::cout << "rrhi + rrlo " << rr.hi + rr.lo << std::endl;
+
+  return rr.hi + rr.lo;
+ }
+} // namespace LIBC_NAMESPACE_DE
diff --git a/libc/test/math/smoke/sinpi_test.cpp b/libc/test/math/smoke/sinpi_test.cpp
new file mode 100644
index 0000000000000..2b39189a365d4
--- /dev/null
+++ b/libc/test/math/smoke/sinpi_test.cpp
@@ -0,0 +1,47 @@
+//===-- Unittests for sinpi -----------------------------------------------===//
+//
+// 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/__support/FPUtil/cast.h"
+#include "src/errno/libc_errno.h"
+#include "src/math/sinpi.h"
+#include "test/UnitTest/FPMatcher.h"
+#include "test/UnitTest/Test.h"
+
+using LlvmLibcSinpiTest = LIBC_NAMESPACE::testing::FPTest<double>;
+/*
+TEST_F(LlvmLibcSinpiTest, SpecialNumbers) {
+  LIBC_NAMESPACE::libc_errno = 0;
+  EXPECT_FP_EQ(aNaN, LIBC_NAMESPACE::sinpi(aNaN));
+  EXPECT_MATH_ERRNO(0);
+  EXPECT_FP_EQ(zero, LIBC_NAMESPACE::sinpi(zero));
+  EXPECT_MATH_ERRNO(0);
+  EXPECT_FP_EQ(neg_zero, LIBC_NAMESPACE::sinpi(neg_zero));
+  EXPECT_MATH_ERRNO(0);
+  EXPECT_FP_EQ(aNaN, LIBC_NAMESPACE::sinpi(inf));
+  EXPECT_MATH_ERRNO(EDOM);
+  EXPECT_FP_EQ(aNaN, LIBC_NAMESPACE::sinpi(neg_inf));
+  EXPECT_MATH_ERRNO(EDOM);
+}
+TEST_F(LlvmLibcSinpiTest, Integers) {
+  EXPECT_FP_EQ(neg_zero, LIBC_NAMESPACE::sinpi(-0x1.0000000000003p52));
+  
+  ASSERT_FP_EQ(-1.0, LIBC_NAMESPACE::sinpi(4499003037990983.5));
+  EXPECT_FP_EQ(neg_zero, LIBC_NAMESPACE::sinpi(-0x1.0000000000005p52));
+  EXPECT_FP_EQ(neg_zero, LIBC_NAMESPACE::sinpi(-0x1.0000000000006p52));
+  EXPECT_FP_EQ(zero, LIBC_NAMESPACE::sinpi(0x1.0p1020));
+  EXPECT_FP_EQ(zero, LIBC_NAMESPACE::sinpi(0x1.0000000000003p52));
+  EXPECT_FP_EQ(zero, LIBC_NAMESPACE::sinpi(0x1.0000000000005p52));
+  EXPECT_FP_EQ(zero, LIBC_NAMESPACE::sinpi(0x1.0000000000006p52));
+}
+*/
+
+TEST_F(LlvmLibcSinpiTest, Integers) {
+  //ASSERT_FP_EQ(zero, LIBC_NAMESPACE::sinpi(4503563146482784.00000000000000000000000000000000000000000000000000));
+
+  ASSERT_FP_EQ(-1.0, LIBC_NAMESPACE::sinpi(4499003037990983.50000000000000000000000000000000000000000000000000));
+}
diff --git a/libc/test/src/math/sinpi_test.cpp b/libc/test/src/math/sinpi_test.cpp
new file mode 100644
index 0000000000000..47cc397c25734
--- /dev/null
+++ b/libc/test/src/math/sinpi_test.cpp
@@ -0,0 +1,87 @@
+//===-- Exhaustive test for sinpif16 --------------------------------------===//
+//
+// 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/sinpi.h"
+#include "test/UnitTest/FPMatcher.h"
+#include "test/UnitTest/Test.h"
+#include "utils/MPFRWrapper/MPFRUtils.h"
+
+#include <iostream>
+
+using LlvmLibcSinpiTest = LIBC_NAMESPACE::testing::FPTest<double>;
+using namespace std;
+namespace mpfr = LIBC_NAMESPACE::testing::mpfr;
+
+using LIBC_NAMESPACE::testing::tlog;
+
+TEST_F(LlvmLibcSinpiTest, InDoubleRange) {
+  constexpr uint64_t COUNT = 1'234'51;
+  uint64_t START = LIBC_NAMESPACE::fputil::FPBits<double>(0x1.0p-50).uintval();
+  uint64_t STOP = LIBC_NAMESPACE::fputil::FPBits<double>(0x1.0p200).uintval();
+  uint64_t STEP = (STOP - START) / COUNT;
+
+  auto test = [&](mpfr::RoundingMode rounding_mode) {
+    mpfr::ForceRoundingMode __r(rounding_mode);
+    if (!__r.success)
+      return;
+
+    uint64_t fails = 0;
+    uint64_t count = 0;
+    uint64_t cc = 0;
+    double mx, mr = 0.0;
+    double tol = 2.0;
+
+    for (uint64_t i = 0, v = START; i <= COUNT; ++i, v += STEP) {
+      double x = FPBits(v).get_val();
+      if (FPBits(v).is_nan() || FPBits(v).is_inf())
+        continue;
+      LIBC_NAMESPACE::libc_errno = 0;
+      double result = LIBC_NAMESPACE::sinpi(x);
+      std::cout << "result: " << result << std::endl;
+      ++cc;
+      if (FPBits(result).is_nan() || FPBits(result).is_inf())
+        continue;
+
+      ++count;
+
+
+      if (!TEST_MPFR_MATCH_ROUNDING_SILENTLY(mpfr::Operation::Sinpi, x, result,
+                                             2.0, rounding_mode)) {
+        ++fails;
+        while (!TEST_MPFR_MATCH_ROUNDING_SILENTLY(mpfr::Operation::Sinpi, x,
+                                                  result, tol, rounding_mode)) {
+          mx = x;
+          mr = result;
+
+          if (tol > 1000.0)
+            break;
+
+          tol *= 2.0;
+        }
+      }
+    }
+    if (fails) {
+      tlog << " Sin failed: " << fails << "/" << count << "/" << cc
+           << " tests.\n";
+      tlog << "   Max ULPs is at most: " << static_cast<uint64_t>(tol) << ".\n";
+      EXPECT_MPFR_MATCH(mpfr::Operation::Sinpi, mx, mr, 2.0, rounding_mode);
+    }
+
+  };
+  tlog << " Test Rounding To Nearest...\n";
+  test(mpfr::RoundingMode::Nearest);
+
+  tlog << " Test Rounding Downward...\n";
+  test(mpfr::RoundingMode::Downward);
+
+  tlog << " Test Rounding Upward...\n";
+  test(mpfr::RoundingMode::Upward);
+
+  tlog << " Test Rounding Toward Zero...\n";
+  test(mpfr::RoundingMode::TowardZero);
+}

@overmighty
Copy link
Member

Was this meant to be a draft PR?

@nspheric nspheric marked this pull request as draft April 30, 2025 15:48
@nspheric
Copy link
Author

Was this meant to be a draft PR?

yea. i just fixed it.

@nspheric nspheric marked this pull request as ready for review May 2, 2025 02:38
@nspheric nspheric changed the title [libc][math] Implementation of sinpi, correctly rounded for all modes [libc][math] Implementation of sinpi, correctly rounded to all modes May 2, 2025
@overmighty overmighty requested review from overmighty and lntue May 2, 2025 11:23
Comment on lines 2443 to 2449
- name: sinpi
standards:
- stdc
return_type: double
arguments:
- type: double
- name: sinpif16
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add sinpif? It's already implemented but missing in math.yaml for some reason.

Suggested change
- name: sinpi
standards:
- stdc
return_type: double
arguments:
- type: double
- name: sinpif16
- name: sinpi
standards:
- stdc
return_type: double
arguments:
- type: double
- name: sinpif
standards:
- stdc
return_type: float
arguments:
- type: float
- name: sinpif16

Comment on lines 500 to 502
HDRS
../sinpi.h
range_reduction_double_fma.h
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

range_reduction_double_fma.h is already part of the range_reduction_double header library.

Suggested change
HDRS
../sinpi.h
range_reduction_double_fma.h
HDRS
../sinpi.h

#include "src/math/pow.h"
// #include "src/__support/FPUtil/multiply_add.h"
// #include "src/math/generic/range_reduction_double_common.h"
#include <iostream>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this PR ready for review yet or not? There still are debug logs and the smoke test is mostly commented out.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the tests are not passing. almost done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants