summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarten van Kerkwijk <mhvk@astro.utoronto.ca>2018-06-01 16:54:19 -0400
committerMarten van Kerkwijk <mhvk@astro.utoronto.ca>2018-07-17 17:07:15 -0400
commit472c7e9b41df6463b47d4ed2883e6c5571c9967f (patch)
tree2dfd0225198910e5ee371cf7b5e288a0870fadb7 /doc
parent8788119ff2a239621f2ad8bc0a3986c1dde542ea (diff)
downloadnumpy-472c7e9b41df6463b47d4ed2883e6c5571c9967f.tar.gz
DOC: Release notes for frozen dimensions.
Diffstat (limited to 'doc')
-rw-r--r--doc/release/1.16.0-notes.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/release/1.16.0-notes.rst b/doc/release/1.16.0-notes.rst
index ae21f4ffd..1fd4a17e6 100644
--- a/doc/release/1.16.0-notes.rst
+++ b/doc/release/1.16.0-notes.rst
@@ -62,6 +62,21 @@ behavior will be appending. This applied to: `LDFLAGS`, `F77FLAGS`,
`F90FLAGS`, `FREEFLAGS`, `FOPT`, `FDEBUG`, and `FFLAGS`. See gh-11525 for more
details.
+Generalized ufunc signatures now allow fixed-size dimensions
+------------------------------------------------------------
+By using a numerical value in the signature of a generalized ufunc, one can
+indicate that the given function requires input or output to have dimensions
+with the given size. E.g., the signature of a function that converts a polar
+angle to a two-dimensional cartesian unit vector would be ``()->(2)``; that
+for one that converts two spherical angles to a three-dimensional unit vector
+would be ``(),()->(3)``; and that for the cross product of two
+three-dimensional vectors would be ``(3),(3)->(3)``.
+
+Note that to the elementary function these dimensions are not treated any
+differently from variable ones indicated with a name starting with a letter;
+the loop still is passed the corresponding size, but it can now count on that
+size being equal to the fixed one given in the signature.
+
Changes
=======