summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authortim cera <tcera@sjrwmd.com>2012-02-06 12:51:14 -0500
committerCharles Harris <charlesr.harris@gmail.com>2012-04-04 13:29:16 -0600
commit7270d9e6054e105c6c7ace66b443870a9e299b75 (patch)
treec293b21712e466b21e92d8efa1e86de79f52b998 /doc
parent313fe46046a7192cbdba2e679a104777301bc7cf (diff)
downloadnumpy-7270d9e6054e105c6c7ace66b443870a9e299b75.tar.gz
ENH: Add module containing functions for padding n-dimensional arrays.
The various padding functions are exposed as options to a public 'pad' function. Example: pad(a, 5, mode='mean') Current modes are 'constant', 'edge', 'linear_ramp', 'maximum', 'mean', 'median', 'minimum', 'reflect', 'symmetric', 'wrap', and <function> This commit includes unit tests and doctests and is based on feature request ticket #655.
Diffstat (limited to 'doc')
-rw-r--r--doc/release/2.0.0-notes.rst12
-rw-r--r--doc/source/reference/routines.padding.rst9
-rw-r--r--doc/source/reference/routines.rst45
3 files changed, 44 insertions, 22 deletions
diff --git a/doc/release/2.0.0-notes.rst b/doc/release/2.0.0-notes.rst
index e9fd7f90a..b25643364 100644
--- a/doc/release/2.0.0-notes.rst
+++ b/doc/release/2.0.0-notes.rst
@@ -129,6 +129,18 @@ Support for mask-based NA values in the polynomial package fits
The fitting functions recognize and remove masked data from the fit.
+Ability to pad rank-n arrays
+----------------------------
+
+A pad module containing functions for padding n-dimensional arrays has
+been added. The various private padding functions are exposed as options to
+a public 'pad' function. Example:
+
+pad(a, 5, mode='mean')
+
+Current modes are 'constant', 'edge', 'linear_ramp', 'maximum', 'mean',
+'median', 'minimum', 'reflect', 'symmetric', 'wrap', and <function>
+
New argument to searchsorted
----------------------------
diff --git a/doc/source/reference/routines.padding.rst b/doc/source/reference/routines.padding.rst
new file mode 100644
index 000000000..38706edea
--- /dev/null
+++ b/doc/source/reference/routines.padding.rst
@@ -0,0 +1,9 @@
+Padding Arrays
+==============
+
+.. currentmodule:: numpy
+
+.. autosummary::
+ :toctree: generated/
+
+ pad
diff --git a/doc/source/reference/routines.rst b/doc/source/reference/routines.rst
index 14b4f4d04..10d12330c 100644
--- a/doc/source/reference/routines.rst
+++ b/doc/source/reference/routines.rst
@@ -17,33 +17,34 @@ indentation.
routines.array-creation
routines.array-manipulation
- routines.indexing
+ routines.bitwise
+ routines.char
+ routines.ctypeslib
+ routines.datetime
routines.dtype
- routines.io
+ routines.dual
+ routines.emath
+ routines.err
routines.fft
+ routines.financial
+ routines.functional
+ routines.help
+ routines.indexing
+ routines.io
routines.linalg
- routines.random
- routines.sort
routines.logic
- routines.bitwise
- routines.statistics
- routines.math
- routines.functional
- routines.polynomials
- routines.datetime
- routines.financial
- routines.set
- routines.window
- routines.err
- routines.maskna
routines.ma
- routines.help
- routines.other
- routines.testing
- routines.emath
+ routines.maskna
+ routines.math
routines.matlib
- routines.dual
routines.numarray
routines.oldnumeric
- routines.ctypeslib
- routines.char
+ routines.other
+ routines.padding
+ routines.polynomials
+ routines.random
+ routines.set
+ routines.sort
+ routines.statistics
+ routines.testing
+ routines.window