summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2020-11-25 10:54:58 -0700
committerCharles Harris <charlesr.harris@gmail.com>2020-11-25 12:11:06 -0700
commited49df0e1177aa31f0751f0e11acba470663023b (patch)
tree79f40381df87b811c41631f021bbb16103144856 /doc
parent24a470494ebf452931ae9b7bf94689dfcca1fff0 (diff)
downloadnumpy-ed49df0e1177aa31f0751f0e11acba470663023b.tar.gz
DOC: Add release note for gh-16161.
Diffstat (limited to 'doc')
-rw-r--r--doc/release/upcoming_changes/16161.change.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/16161.change.rst b/doc/release/upcoming_changes/16161.change.rst
new file mode 100644
index 000000000..7eafdfda0
--- /dev/null
+++ b/doc/release/upcoming_changes/16161.change.rst
@@ -0,0 +1,44 @@
+Changed behavior of ``divmod(1., 0.)`` and related functions
+------------------------------------------------------------
+The changes also assure that different compiler versions have the same behavior
+for nan or inf usages in these operations. This was previously compiler
+dependent, we now force the invalid and divide by zero flags, making the
+results the same across compilers. For example, gcc-5, gcc-8, or gcc-9 now
+result in the same behavior. The changes are tabulated below:
+
+.. list-table:: Summary of New Behavior
+ :widths: auto
+ :header-rows: 1
+
+ * - Operator
+ - Old Warning
+ - New Warning
+ - Old Result
+ - New Result
+ - Works on MacOS
+ * - np.divmod(1.0, 0.0)
+ - Invalid
+ - Invalid and Dividebyzero
+ - nan, nan
+ - inf, nan
+ - Yes
+ * - np.fmod(1.0, 0.0)
+ - Invalid
+ - Invalid
+ - nan
+ - nan
+ - No? Yes
+ * - np.floor_divide(1.0, 0.0)
+ - Invalid
+ - Dividebyzero
+ - nan
+ - inf
+ - Yes
+ * - np.remainder(1.0, 0.0)
+ - Invalid
+ - Invalid
+ - nan
+ - nan
+ - Yes
+
+