bpo-45917: Add math.exp2() method - return 2 raised to the power of x (GH-29829)

Co-authored-by: Mark Dickinson <dickinsm@gmail.com>

diff --git a/Doc/library/math.rst b/Doc/library/math.rst
index 71186788a652af826b8f51e7c31e14b97c9c26e6..1ad60459e8d3774fde755ed0e721826b614bfe8a 100644 (file)
--- a/Doc/library/math.rst
+++ b/Doc/library/math.rst
@@ -356,6 +356,13 @@ Power and logarithmic functions
    or ``pow(math.e, x)``.
 
 
+.. function:: exp2(x)
+
+   Return *2* raised to the power *x*.
+
+   .. versionadded:: 3.11
+
+
 .. function:: expm1(x)
 
    Return *e* raised to the power *x*, minus 1.  Here *e* is the base of natural

diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 3b65921a92619688293c55f39569c778b002e6c7..8db26cd0126b3adc96ec702d62212425d660a499 100644 (file)
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -203,6 +203,8 @@ fractions
 
 math
 ----
+* Add :func:`math.exp2`: return 2 raised to the power of x.
+  (Contributed by Gideon Mitchell in :issue:`45917`.)
 
 * Add :func:`math.cbrt`: return the cube root of x.
   (Contributed by Ajith Ramachandran in :issue:`44357`.)

diff --git a/Lib/test/test_math.py b/Lib/test/test_math.py
index a9f1b1e11bcb39be61b846d86d5f084812abb1d6..a7df00f0fb101357d96eb2e0ce9183c09442586f 100644 (file)
--- a/Lib/test/test_math.py
+++ b/Lib/test/test_math.py
@@ -501,6 +501,17 @@ class MathTests(unittest.TestCase):
         self.assertTrue(math.isnan(math.exp(NAN)))
         self.assertRaises(OverflowError, math.exp, 1000000)
 
+    def testExp2(self):
+        self.assertRaises(TypeError, math.exp2)
+        self.ftest('exp2(-1)', math.exp2(-1), 0.5)
+        self.ftest('exp2(0)', math.exp2(0), 1)
+        self.ftest('exp2(1)', math.exp2(1), 2)
+        self.ftest('exp2(2.3)', math.exp2(2.3), 4.924577653379665)
+        self.assertEqual(math.exp2(INF), INF)
+        self.assertEqual(math.exp2(NINF), 0.)
+        self.assertTrue(math.isnan(math.exp2(NAN)))
+        self.assertRaises(OverflowError, math.exp2, 1000000)
+
     def testFabs(self):
         self.assertRaises(TypeError, math.fabs)
         self.ftest('fabs(-1)', math.fabs(-1), 1)

diff --git a/Misc/ACKS b/Misc/ACKS
index 204293fa50d9c050915c365f75cb436d45416938..94a82a07506220a034998865e7cc05d4cb063602 100644 (file)
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1191,6 +1191,7 @@ Julien Miotte
 Andrii V. Mishkovskyi
 Dom Mitchell
 Dustin J. Mitchell
+Gideon Mitchell
 Tim Mitchell
 Zubin Mithra
 Florian Mladitsch

diff --git a/Misc/NEWS.d/next/Library/2021-11-28-17-24-11.bpo-45917.J5TIrd.rst b/Misc/NEWS.d/next/Library/2021-11-28-17-24-11.bpo-45917.J5TIrd.rst
new file mode 100644 (file)
index 0000000..effd8da
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2021-11-28-17-24-11.bpo-45917.J5TIrd.rst
@@ -0,0 +1 @@
+Added :func:`math.exp2`:, which returns 2 raised to the power of x.

diff --git a/Modules/mathmodule.c b/Modules/mathmodule.c
index 67669f19bc28cb4d546b5298d839c77a9b76fdd7..64ce4e6a13fd59f1bbd18ec1fd0aa128df9615fc 100644 (file)
--- a/Modules/mathmodule.c
+++ b/Modules/mathmodule.c
@@ -1248,6 +1248,9 @@ FUNC1A(erfc, m_erfc,
 FUNC1(exp, exp, 1,
       "exp($module, x, /)\n--\n\n"
       "Return e raised to the power of x.")
+FUNC1(exp2, exp2, 1,
+      "exp2($module, x, /)\n--\n\n"
+      "Return 2 raised to the power of x.")
 FUNC1(expm1, expm1, 1,
       "expm1($module, x, /)\n--\n\n"
       "Return exp(x)-1.\n\n"
@@ -3564,6 +3567,7 @@ static PyMethodDef math_methods[] = {
     {"erf",             math_erf,       METH_O,         math_erf_doc},
     {"erfc",            math_erfc,      METH_O,         math_erfc_doc},
     {"exp",             math_exp,       METH_O,         math_exp_doc},
+    {"exp2",            math_exp2,      METH_O,         math_exp2_doc},
     {"expm1",           math_expm1,     METH_O,         math_expm1_doc},
     {"fabs",            math_fabs,      METH_O,         math_fabs_doc},
     MATH_FACTORIAL_METHODDEF