summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@googlemail.com>2012-07-07 14:29:45 +0200
committerRalf Gommers <ralf.gommers@googlemail.com>2012-07-07 14:29:45 +0200
commit5df8f24ba2ccf97b0fabd60d3f215be8f03a08bc (patch)
tree56cd744f0366f9a124f8730f86dbf2808d3f80a5 /doc
parent3b9a0fea12ae89fe6ce745d9af0beb3df17260b8 (diff)
downloadnumpy-5df8f24ba2ccf97b0fabd60d3f215be8f03a08bc.tar.gz
DOC: merge wiki docs - edits under doc/.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/dev/gitwash/development_setup.rst7
-rw-r--r--doc/source/reference/index.rst2
-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.rst2
6 files changed, 51 insertions, 18 deletions
diff --git a/doc/source/dev/gitwash/development_setup.rst b/doc/source/dev/gitwash/development_setup.rst
index 489a2e75d..0cff3c214 100644
--- a/doc/source/dev/gitwash/development_setup.rst
+++ b/doc/source/dev/gitwash/development_setup.rst
@@ -38,8 +38,8 @@ Create your own forked copy of NumPy_
.. image:: forking_button.png
- Now, after a short pause and some 'Hardcore forking action', you
- should find yourself at the home page for your own forked copy of NumPy_.
+ After a short pause, you should find yourself at the home page for
+ your own forked copy of NumPy_.
.. include:: git_links.inc
@@ -49,7 +49,7 @@ Create your own forked copy of NumPy_
Set up your fork
################
-First you follow the instructions for :ref:`forking`.
+First you follow the instructions for :ref:`forking`.
Overview
========
@@ -110,4 +110,3 @@ Just for your own satisfaction, show yourself that you now have a new
origin git@github.com:your-user-name/numpy.git (push)
.. include:: git_links.inc
-
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 2e881542e..f5d0bddd7 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -20,7 +20,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..551dce77b 100644
--- a/doc/source/reference/routines.statistics.rst
+++ b/doc/source/reference/routines.statistics.rst
@@ -12,8 +12,8 @@ Extremal values
amin
amax
- nanmax
nanmin
+ nanmax
ptp
Averages and variances