FM / doc

/usr/lib64/python2.6/site-packages/numpy/doc/

/usr/lib64/python2.6/site-packages/numpy/doc

Name	Size	Mode	Actions
basics.py	5181	0644	edit dl rm
basics.pyc	5338	0644	edit dl rm
basics.pyo	5338	0644	edit dl rm
broadcasting.py	5511	0644	edit dl rm
broadcasting.pyc	5674	0644	edit dl rm
broadcasting.pyo	5674	0644	edit dl rm
byteswapping.py	4783	0644	edit dl rm
byteswapping.pyc	4942	0644	edit dl rm
byteswapping.pyo	4942	0644	edit dl rm
constants.py	8906	0644	edit dl rm
constants.pyc	8158	0644	edit dl rm
constants.pyo	8158	0644	edit dl rm
creation.py	5425	0644	edit dl rm
creation.pyc	5584	0644	edit dl rm
creation.pyo	5584	0644	edit dl rm
glossary.py	10984	0644	edit dl rm
glossary.pyc	11143	0644	edit dl rm
glossary.pyo	11143	0644	edit dl rm
howtofind.py	94	0644	edit dl rm
howtofind.pyc	254	0644	edit dl rm
howtofind.pyo	254	0644	edit dl rm
indexing.py	14286	0644	edit dl rm
indexing.pyc	14445	0644	edit dl rm
indexing.pyo	14445	0644	edit dl rm
internals.py	9608	0644	edit dl rm
internals.pyc	9768	0644	edit dl rm
internals.pyo	9768	0644	edit dl rm
io.py	82	0644	edit dl rm
io.pyc	235	0644	edit dl rm
io.pyo	235	0644	edit dl rm
jargon.py	96	0644	edit dl rm
jargon.pyc	253	0644	edit dl rm
jargon.pyo	253	0644	edit dl rm
methods_vs_functions.py	130	0644	edit dl rm
methods_vs_functions.pyc	301	0644	edit dl rm
methods_vs_functions.pyo	301	0644	edit dl rm
misc.py	5725	0644	edit dl rm
misc.pyc	5880	0644	edit dl rm
misc.pyo	5880	0644	edit dl rm
performance.py	100	0644	edit dl rm
performance.pyc	262	0644	edit dl rm
performance.pyo	262	0644	edit dl rm
structured_arrays.py	7212	0644	edit dl rm
structured_arrays.pyc	7380	0644	edit dl rm
structured_arrays.pyo	7380	0644	edit dl rm
subclassing.py	20160	0644	edit dl rm
subclassing.pyc	20322	0644	edit dl rm
subclassing.pyo	20322	0644	edit dl rm
ufuncs.py	5520	0644	edit dl rm
ufuncs.pyc	5675	0644	edit dl rm
ufuncs.pyo	5675	0644	edit dl rm
__init__.py	464	0644	edit dl rm
__init__.pyc	755	0644	edit dl rm
__init__.pyo	755	0644	edit dl rm

Edit: /usr/lib64/python2.6/site-packages/numpy/doc/broadcasting.py (5511B)

"""
========================
Broadcasting over arrays
========================

The term broadcasting describes how numpy treats arrays with different
shapes during arithmetic operations. Subject to certain constraints,
the smaller array is "broadcast" across the larger array so that they
have compatible shapes. Broadcasting provides a means of vectorizing
array operations so that looping occurs in C instead of Python. It does
this without making needless copies of data and usually leads to
efficient algorithm implementations. There are, however, cases where
broadcasting is a bad idea because it leads to inefficient use of memory
that slows computation.

NumPy operations are usually done on pairs of arrays on an
element-by-element basis.  In the simplest case, the two arrays must
have exactly the same shape, as in the following example:

>>> a = np.array([1.0, 2.0, 3.0])
  >>> b = np.array([2.0, 2.0, 2.0])
  >>> a * b
  array([ 2.,  4.,  6.])

NumPy's broadcasting rule relaxes this constraint when the arrays'
shapes meet certain constraints. The simplest broadcasting example occurs
when an array and a scalar value are combined in an operation:

>>> a = np.array([1.0, 2.0, 3.0])
>>> b = 2.0
>>> a * b
array([ 2.,  4.,  6.])

The result is equivalent to the previous example where ``b`` was an array.
We can think of the scalar ``b`` being *stretched* during the arithmetic
operation into an array with the same shape as ``a``. The new elements in
``b`` are simply copies of the original scalar. The stretching analogy is
only conceptual.  NumPy is smart enough to use the original scalar value
without actually making copies, so that broadcasting operations are as
memory and computationally efficient as possible.

The code in the second example is more efficient than that in the first
because broadcasting moves less memory around during the multiplication
(``b`` is a scalar rather than an array).

General Broadcasting Rules
==========================
When operating on two arrays, NumPy compares their shapes element-wise.
It starts with the trailing dimensions, and works its way forward.  Two
dimensions are compatible when

1) they are equal, or
2) one of them is 1

If these conditions are not met, a
``ValueError: frames are not aligned`` exception is thrown, indicating that
the arrays have incompatible shapes. The size of the resulting array
is the maximum size along each dimension of the input arrays.

Arrays do not need to have the same *number* of dimensions.  For example,
if you have a ``256x256x3`` array of RGB values, and you want to scale
each color in the image by a different value, you can multiply the image
by a one-dimensional array with 3 values. Lining up the sizes of the
trailing axes of these arrays according to the broadcast rules, shows that
they are compatible::

Image  (3d array): 256 x 256 x 3
  Scale  (1d array):             3
  Result (3d array): 256 x 256 x 3

When either of the dimensions compared is one, the larger of the two is
used.  In other words, the smaller of two axes is stretched or "copied"
to match the other.

In the following example, both the ``A`` and ``B`` arrays have axes with
length one that are expanded to a larger size during the broadcast
operation::

A      (4d array):  8 x 1 x 6 x 1
  B      (3d array):      7 x 1 x 5
  Result (4d array):  8 x 7 x 6 x 5

Here are some more examples::

A      (2d array):  5 x 4
  B      (1d array):      1
  Result (2d array):  5 x 4

A      (2d array):  5 x 4
  B      (1d array):      4
  Result (2d array):  5 x 4

A      (3d array):  15 x 3 x 5
  B      (3d array):  15 x 1 x 5
  Result (3d array):  15 x 3 x 5

A      (3d array):  15 x 3 x 5
  B      (2d array):       3 x 5
  Result (3d array):  15 x 3 x 5

A      (3d array):  15 x 3 x 5
  B      (2d array):       3 x 1
  Result (3d array):  15 x 3 x 5

Here are examples of shapes that do not broadcast::

A      (1d array):  3
  B      (1d array):  4 # trailing dimensions do not match

A      (2d array):      2 x 1
  B      (3d array):  8 x 4 x 3 # second from last dimensions mismatched

An example of broadcasting in practice::

>>> x = np.arange(4)
 >>> xx = x.reshape(4,1)
 >>> y = np.ones(5)
 >>> z = np.ones((3,4))

>>> x.shape
 (4,)

>>> y.shape
 (5,)

>>> x + y
 <type 'exceptions.ValueError'>: shape mismatch: objects cannot be broadcast to a single shape

>>> xx.shape
 (4, 1)

>>> y.shape
 (5,)

>>> (xx + y).shape
 (4, 5)

>>> xx + y
 array([[ 1.,  1.,  1.,  1.,  1.],
        [ 2.,  2.,  2.,  2.,  2.],
        [ 3.,  3.,  3.,  3.,  3.],
        [ 4.,  4.,  4.,  4.,  4.]])

>>> x.shape
 (4,)

>>> z.shape
 (3, 4)

>>> (x + z).shape
 (3, 4)

>>> x + z
 array([[ 1.,  2.,  3.,  4.],
        [ 1.,  2.,  3.,  4.],
        [ 1.,  2.,  3.,  4.]])

Broadcasting provides a convenient way of taking the outer product (or
any other outer operation) of two arrays. The following example shows an
outer addition operation of two 1-d arrays::

>>> a = np.array([0.0, 10.0, 20.0, 30.0])
  >>> b = np.array([1.0, 2.0, 3.0])
  >>> a[:, np.newaxis] + b
  array([[  1.,   2.,   3.],
         [ 11.,  12.,  13.],
         [ 21.,  22.,  23.],
         [ 31.,  32.,  33.]])

Here the ``newaxis`` index operator inserts a new axis into ``a``,
making it a two-dimensional ``4x1`` array.  Combining the ``4x1`` array
with ``b``, which has shape ``(3,)``, yields a ``4x3`` array.

See `this article <http://www.scipy.org/EricsBroadcastingDoc>`_
for illustrations of broadcasting concepts.

"""

cmd: