1 //===-- flang/unittests/Runtime/Numeric.cpp ---------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "flang/Runtime/numeric.h"
10 #include "gtest/gtest.h"
11 #include <cmath>
12 #include <limits>
13 
14 using namespace Fortran::runtime;
15 using Fortran::common::TypeCategory;
16 template <int KIND> using Int = CppTypeFor<TypeCategory::Integer, KIND>;
17 template <int KIND> using Real = CppTypeFor<TypeCategory::Real, KIND>;
18 
19 // Simple tests of numeric intrinsic functions using examples from Fortran 2018
20 
21 TEST(Numeric, Ceiling) {
22   EXPECT_EQ(RTNAME(Ceiling4_4)(Real<4>{3.7}), 4);
23   EXPECT_EQ(RTNAME(Ceiling8_8)(Real<8>{-3.7}), -3);
24   EXPECT_EQ(RTNAME(Ceiling4_1)(Real<4>{0}), 0);
25 }
26 
27 TEST(Numeric, Floor) {
28   EXPECT_EQ(RTNAME(Floor4_4)(Real<4>{3.7}), 3);
29   EXPECT_EQ(RTNAME(Floor8_8)(Real<8>{-3.7}), -4);
30   EXPECT_EQ(RTNAME(Floor4_1)(Real<4>{0}), 0);
31 }
32 
33 TEST(Numeric, Exponent) {
34   EXPECT_EQ(RTNAME(Exponent4_4)(Real<4>{0}), 0);
35   EXPECT_EQ(RTNAME(Exponent4_8)(Real<4>{1.0}), 1);
36   EXPECT_EQ(RTNAME(Exponent8_4)(Real<8>{4.1}), 3);
37   EXPECT_EQ(RTNAME(Exponent8_8)(std::numeric_limits<Real<8>>::infinity()),
38       std::numeric_limits<Int<8>>::max());
39   EXPECT_EQ(RTNAME(Exponent8_8)(std::numeric_limits<Real<8>>::quiet_NaN()),
40       std::numeric_limits<Int<8>>::max());
41 }
42 
43 TEST(Numeric, Fraction) {
44   EXPECT_EQ(RTNAME(Fraction4)(Real<4>{0}), 0);
45   EXPECT_EQ(RTNAME(Fraction8)(Real<8>{3.0}), 0.75);
46   EXPECT_TRUE(
47       std::isnan(RTNAME(Fraction4)(std::numeric_limits<Real<4>>::infinity())));
48   EXPECT_TRUE(
49       std::isnan(RTNAME(Fraction8)(std::numeric_limits<Real<8>>::quiet_NaN())));
50 }
51 
52 TEST(Numeric, IsNaN) {
53   EXPECT_FALSE(RTNAME(IsNaN4)(Real<4>{0}));
54   EXPECT_FALSE(RTNAME(IsNaN8)(std::numeric_limits<Real<8>>::infinity()));
55   EXPECT_TRUE(RTNAME(IsNaN8)(std::numeric_limits<Real<8>>::quiet_NaN()));
56 }
57 
58 TEST(Numeric, Mod) {
59   EXPECT_EQ(RTNAME(ModInteger1)(Int<1>{8}, Int<1>(5)), 3);
60   EXPECT_EQ(RTNAME(ModInteger4)(Int<4>{-8}, Int<4>(5)), -3);
61   EXPECT_EQ(RTNAME(ModInteger2)(Int<2>{8}, Int<2>(-5)), 3);
62   EXPECT_EQ(RTNAME(ModInteger8)(Int<8>{-8}, Int<8>(-5)), -3);
63   EXPECT_EQ(RTNAME(ModReal4)(Real<4>{8.0}, Real<4>(5.0)), 3.0);
64   EXPECT_EQ(RTNAME(ModReal4)(Real<4>{-8.0}, Real<4>(5.0)), -3.0);
65   EXPECT_EQ(RTNAME(ModReal8)(Real<8>{8.0}, Real<8>(-5.0)), 3.0);
66   EXPECT_EQ(RTNAME(ModReal8)(Real<8>{-8.0}, Real<8>(-5.0)), -3.0);
67 }
68 
69 TEST(Numeric, Modulo) {
70   EXPECT_EQ(RTNAME(ModuloInteger1)(Int<1>{8}, Int<1>(5)), 3);
71   EXPECT_EQ(RTNAME(ModuloInteger4)(Int<4>{-8}, Int<4>(5)), 2);
72   EXPECT_EQ(RTNAME(ModuloInteger2)(Int<2>{8}, Int<2>(-5)), -2);
73   EXPECT_EQ(RTNAME(ModuloInteger8)(Int<8>{-8}, Int<8>(-5)), -3);
74   EXPECT_EQ(RTNAME(ModuloReal4)(Real<4>{8.0}, Real<4>(5.0)), 3.0);
75   EXPECT_EQ(RTNAME(ModuloReal4)(Real<4>{-8.0}, Real<4>(5.0)), 2.0);
76   EXPECT_EQ(RTNAME(ModuloReal8)(Real<8>{8.0}, Real<8>(-5.0)), -2.0);
77   EXPECT_EQ(RTNAME(ModuloReal8)(Real<8>{-8.0}, Real<8>(-5.0)), -3.0);
78 }
79 
80 TEST(Numeric, Nearest) {
81   EXPECT_EQ(RTNAME(Nearest4)(Real<4>{0}, true),
82       std::numeric_limits<Real<4>>::denorm_min());
83   EXPECT_EQ(RTNAME(Nearest4)(Real<4>{3.0}, true),
84       Real<4>{3.0} + std::ldexp(Real<4>{1.0}, -22));
85   EXPECT_EQ(RTNAME(Nearest8)(Real<8>{1.0}, true),
86       Real<8>{1.0} + std::ldexp(Real<8>{1.0}, -52));
87   EXPECT_EQ(RTNAME(Nearest8)(Real<8>{1.0}, false),
88       Real<8>{1.0} - std::ldexp(Real<8>{1.0}, -52));
89 }
90 
91 TEST(Numeric, Nint) {
92   EXPECT_EQ(RTNAME(Nint4_4)(Real<4>{2.783}), 3);
93   EXPECT_EQ(RTNAME(Nint8_4)(Real<8>{-2.783}), -3);
94   EXPECT_EQ(RTNAME(Nint4_4)(Real<4>{2.5}), 3);
95   EXPECT_EQ(RTNAME(Nint8_4)(Real<8>{-2.5}), -3);
96   EXPECT_EQ(RTNAME(Nint8_8)(Real<8>{0}), 0);
97 }
98 
99 TEST(Numeric, RRSpacing) {
100   EXPECT_EQ(RTNAME(RRSpacing8)(Real<8>{0}), 0);
101   EXPECT_EQ(RTNAME(RRSpacing4)(Real<4>{-3.0}), 0.75 * (1 << 24));
102   EXPECT_EQ(RTNAME(RRSpacing8)(Real<8>{-3.0}), 0.75 * (std::int64_t{1} << 53));
103   EXPECT_TRUE(
104       std::isnan(RTNAME(RRSpacing4)(std::numeric_limits<Real<4>>::infinity())));
105   EXPECT_TRUE(std::isnan(
106       RTNAME(RRSpacing8)(std::numeric_limits<Real<8>>::quiet_NaN())));
107 }
108 
109 TEST(Numeric, Scale) {
110   EXPECT_EQ(RTNAME(Scale4)(Real<4>{0}, 0), 0);
111   EXPECT_EQ(RTNAME(Scale4)(Real<4>{1.0}, 0), 1.0);
112   EXPECT_EQ(RTNAME(Scale4)(Real<4>{1.0}, 1), 2.0);
113   EXPECT_EQ(RTNAME(Scale4)(Real<4>{1.0}, -1), 0.5);
114   EXPECT_TRUE(
115       std::isinf(RTNAME(Scale4)(std::numeric_limits<Real<4>>::infinity(), 1)));
116   EXPECT_TRUE(
117       std::isnan(RTNAME(Scale8)(std::numeric_limits<Real<8>>::quiet_NaN(), 1)));
118 }
119 
120 TEST(Numeric, SetExponent) {
121   EXPECT_EQ(RTNAME(SetExponent4)(Real<4>{0}, 0), 0);
122   EXPECT_EQ(RTNAME(SetExponent8)(Real<8>{0}, 666), 0);
123   EXPECT_EQ(RTNAME(SetExponent8)(Real<8>{3.0}, 0), 0.75);
124   EXPECT_EQ(RTNAME(SetExponent4)(Real<4>{1.0}, 0), 0.5);
125   EXPECT_EQ(RTNAME(SetExponent4)(Real<4>{1.0}, 1), 1.0);
126   EXPECT_EQ(RTNAME(SetExponent4)(Real<4>{1.0}, -1), 0.25);
127   EXPECT_TRUE(std::isnan(
128       RTNAME(SetExponent4)(std::numeric_limits<Real<4>>::infinity(), 1)));
129   EXPECT_TRUE(std::isnan(
130       RTNAME(SetExponent8)(std::numeric_limits<Real<8>>::quiet_NaN(), 1)));
131 }
132 
133 TEST(Numeric, Spacing) {
134   EXPECT_EQ(RTNAME(Spacing8)(Real<8>{0}), std::numeric_limits<Real<8>>::min());
135   EXPECT_EQ(RTNAME(Spacing4)(Real<4>{3.0}), std::ldexp(Real<4>{1.0}, -22));
136   EXPECT_TRUE(
137       std::isnan(RTNAME(Spacing4)(std::numeric_limits<Real<4>>::infinity())));
138   EXPECT_TRUE(
139       std::isnan(RTNAME(Spacing8)(std::numeric_limits<Real<8>>::quiet_NaN())));
140 }
141