summaryrefslogtreecommitdiff
path: root/doc/source/reference
diff options
context:
space:
mode:
authorAron Ahmadia <aron@ahmadia.net>2012-07-17 16:59:50 -0500
committerAron Ahmadia <aron@ahmadia.net>2012-07-17 16:59:50 -0500
commita419a3036aa8202d00eb6e857c79d66adc56bed0 (patch)
tree4a73e6fff2ee13b35c154c43bd7b58bb6c2af633 /doc/source/reference
parent7316499dd60baa7bb260875b79f7d22be491c986 (diff)
parent6c772fab57934d24b66638ea5001eb02d1662f5e (diff)
downloadnumpy-a419a3036aa8202d00eb6e857c79d66adc56bed0.tar.gz
Merge branch 'master' of https://github.com/numpy/numpy into patch-2
Diffstat (limited to 'doc/source/reference')
-rw-r--r--doc/source/reference/c-api.array.rst1
-rw-r--r--doc/source/reference/index.rst3
-rw-r--r--doc/source/reference/routines.matlib.rst27
-rw-r--r--doc/source/reference/routines.polynomials.rst27
-rw-r--r--doc/source/reference/routines.random.rst4
-rw-r--r--doc/source/reference/routines.statistics.rst7
6 files changed, 53 insertions, 16 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index 8736cbc3f..bf8077a69 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -289,6 +289,7 @@ From scratch
Fill the array pointed to by *obj* ---which must be a (subclass
of) bigndarray---with the contents of *val* (evaluated as a byte).
+ This macro calls memset, so obj must be contiguous.
.. cfunction:: PyObject* PyArray_Zeros(int nd, npy_intp* dims, PyArray_Descr* dtype, int fortran)
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 2e881542e..128339e16 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -7,6 +7,7 @@ NumPy Reference
:Release: |version|
:Date: |today|
+
.. module:: numpy
This reference manual details functions, modules, and objects
@@ -20,7 +21,7 @@ For learning how to use NumPy, see also :ref:`user`.
arrays
ufuncs
routines
- ctypes
+ ctypeslib
distutils
c-api
internals
diff --git a/doc/source/reference/routines.matlib.rst b/doc/source/reference/routines.matlib.rst
index 7f8a9eabb..a35eaec78 100644
--- a/doc/source/reference/routines.matlib.rst
+++ b/doc/source/reference/routines.matlib.rst
@@ -7,5 +7,30 @@ This module contains all functions in the :mod:`numpy` namespace, with
the following replacement functions that return :class:`matrices
<matrix>` instead of :class:`ndarrays <ndarray>`.
-.. automodule:: numpy.matlib
+.. currentmodule:: numpy
+
+Functions that are also in the numpy namespace and return matrices
+
+.. autosummary::
+
+ mat
+ matrix
+ asmatrix
+ bmat
+
+
+Replacement functions in `matlib`
+
+.. currentmodule:: numpy.matlib
+
+.. autosummary::
+ :toctree: generated/
+ empty
+ zeros
+ ones
+ eye
+ identity
+ repmat
+ rand
+ randn
diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst
index 3e9b2603f..e85d0549b 100644
--- a/doc/source/reference/routines.polynomials.rst
+++ b/doc/source/reference/routines.polynomials.rst
@@ -1,12 +1,22 @@
Polynomials
***********
-The polynomial package is newer and more complete than poly1d and the
-convenience classes are better behaved in the numpy environment. When
-backwards compatibility is not an issue it should be the package of choice.
-Note that the various routines in the polynomial package all deal with
-series whose coefficients go from degree zero upward, which is the reverse
-of the poly1d convention. The easy way to remember this is that indexes
+Polynomials in NumPy can be *created*, *manipulated*, and even *fitted* using
+the :doc:`routines.polynomials.classes`
+of the `numpy.polynomial` package, introduced in NumPy 1.4.
+
+Prior to NumPy 1.4, `numpy.poly1d` was the class of choice and it is still
+available in order to maintain backward compatibility.
+However, the newer Polynomial package is more complete than `numpy.poly1d`
+and its convenience classes are better behaved in the numpy environment.
+Therefore Polynomial is recommended for new coding.
+
+Transition notice
+-----------------
+The various routines in the Polynomial package all deal with
+series whose coefficients go from degree zero upward,
+which is the *reverse order* of the Poly1d convention.
+The easy way to remember this is that indexes
correspond to degree, i.e., coef[i] is the coefficient of the term of
degree i.
@@ -14,10 +24,9 @@ degree i.
.. toctree::
:maxdepth: 2
- routines.polynomials.poly1d
-
+ routines.polynomials.package
.. toctree::
:maxdepth: 2
- routines.polynomials.package
+ routines.polynomials.poly1d
diff --git a/doc/source/reference/routines.random.rst b/doc/source/reference/routines.random.rst
index 84765c035..c8b097d7d 100644
--- a/doc/source/reference/routines.random.rst
+++ b/doc/source/reference/routines.random.rst
@@ -37,7 +37,7 @@ Distributions
beta
binomial
chisquare
- mtrand.dirichlet
+ dirichlet
exponential
f
gamma
@@ -75,7 +75,7 @@ Random generator
.. autosummary::
:toctree: generated/
- mtrand.RandomState
+ RandomState
seed
get_state
set_state
diff --git a/doc/source/reference/routines.statistics.rst b/doc/source/reference/routines.statistics.rst
index b41b62839..c420705af 100644
--- a/doc/source/reference/routines.statistics.rst
+++ b/doc/source/reference/routines.statistics.rst
@@ -4,17 +4,18 @@ Statistics
.. currentmodule:: numpy
-Extremal values
----------------
+Order statistics
+----------------
.. autosummary::
:toctree: generated/
amin
amax
- nanmax
nanmin
+ nanmax
ptp
+ percentile
Averages and variances
----------------------