M X
d dl Zd dlZd dlZd dlZd dlZddlmZ d dlZ d dl
m c m Z
d dlmZ d dl
mZmZmZmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z d dl m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z, d dl-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3 d dl4m5Z5 d d lm6Z6 d d
l7m8Z8 d d l9m:Z: d d l;mZ>m?Z?m@Z@mAZBmCZD d d
l mEZF d dlGZGd dlHmIZImJZJ ejK e6jL d ZLg dZM eN eNd d eNd d eNd d eNd d eNd d eNd d eNd d eNd! d" eNd# d$ eNd% d& eNd' d( eNd) d* eNd+ d, -
ZOdd.ZP eLeP dd1 ZQdd2ZR eLeR dd3 ZS ed d4 ZTddd5d6ZU eLeU de jV d5d8 ZW ed dd9 ZXd: ZY eLeY d; ZZdd<Z[ eLe[ dd= Z\dd>Z] eLe] dd@ Z^dddAdBZ_ eLe_ dd/dAdC Z`ddDZa eLea d/dEe jV e jV fdF ZbddGZc eLec ddH ZAddIZd eLed ddJ ZedddKdLZf eLef dde!z dKdM ZgdN Zh eLeh dO ZiddPZj eLej ddR ZkdS Zl eLel dT ZmdU Zn eLen dV ZoddXZpdYZqdZr eq Zsd[r es Ztd\r et Zud]r eu Zvd^ Zwd_ Zxd` Zyda Zz ddbZ{ ed G dc dd Z| dddedfZ} eLe} dddedg Z~dddedhZ eLe ddWe jV e jV fddedi Z ed dj Z ed dk Z ed dl Z ed dm Zg dnZg doZdp Zdq Zdr Zds Z eLe dt Z ed du Zdv Z eLe dw Zdx Z eLe dy ZddzZ dd{Z eLe dd| Zdd}Z ddd~dZ eLe ddd~d Z ddd~dZ eLe ddd~d Z ddZd Zd ZdedefdZd ZddZd Zd Zd Zd Z dde j de j dedede j f
dZd Z dde j de j defdZddZ eLe dd Z eed rJ ddZej e_ ej e_ ej e_ ej e_ ej e_ dddddZ eLe dWd7ddd ZddZ eLe dd ZddZ eLe dd ZddZ eLe dd ZddZ eLe dd ZdS ) N )
set_module) transpose)ones
zeros_likearange concatenatearrayasarray
asanyarrayemptyndarraytakedotwhereintpintegerisscalarabsolute) piaddarctan2
frompyfunccos
less_equalsqrtsinmodexp not_equalsubtract)ravelnonzero partitionmeananysum) typecodes) overrides)
add_newdoc)diag)_place
add_docstringbincountnormalize_axis_index
_monotonicityinterpinterp_complex)_add_newdoc_ufunc) histogram histogramddnumpy)module)*select piecewise
trim_zeroscopyiterable
percentilediffgradientangleunwrap sort_complexdispfliprot90extractplace vectorizeasarray_chkfiniteaverager. digitizecovcorrcoefmsortmediansinchamminghanningbartlettblackmankaisertrapzi0r* r- meshgriddeleteinsertappendr1 add_newdoc_ufuncquantilec " t | | S N)
_inverted_cdfn quantiless k/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib64/python3.11/site-packages/numpy/lib/function_base.pyre I s }Q /J/J c | S r_ gamma_s rd re re J 5 rf )get_virtual_index fix_gammac | |z dz
S N rh ra s rd re re M s I
/B rf c : t | j dd| dk S )N ? ?r shape
default_valueconditioned_valuer _get_gamma_maskrv ri s rd re re N s' ?+ !1* $ $ $ rf c " t | | S r_ )_closest_observationra s rd re re U s /CADM0O 0O rf c | S r_ rh ri s rd re re W rl rf c & t | |dd S )Nr rq _compute_virtual_indexra s rd re re [ q)Q22 rf c | S r_ rh ri s rd re re ] rl rf c & t | |dd S )Nrt r ra s rd re re ` s q)S#66 rf c | S r_ rh ri s rd re re b rl rf c & t | |dd S Nr r ra s rd re re e r rf c | S r_ rh ri s rd re re g rl rf c | dz
|z S rp rh ra s rd re re n s A/B rf c | S r_ rh ri s rd re re o rl rf c & t | |dd S )NgUUUUUU?r ra s rd re re r q)Wg>> rf c | S r_ rh ri s rd re re t rl rf c & t | |dd S )Ng ?r ra s rd re re w r rf c | S r_ rh ri s rd re re y rl rf c p t j | dz
|z t j S rp )npfloorastyper ra s rd re re } s. rx
Ui 0! 0!!' rf c | S r_ rh ri s rd re re rl rf c p t j | dz
|z t j S rp )r ceilr r ra s rd re re s. rw
Ui 0! 0!!' rf c | S r_ rh ri s rd re re rl rf c r dt j | dz
|z t j | dz
|z z z S )Nrt rq )r r r ra s rd re re s< s!a%9,--'1q5I-../00 rf c @ t | j dd|dz dk S )Nrt rq r ru ry rj indexs rd re re s+ + !)q. (" (" (" rf c p t j | dz
|z t j S rp )r aroundr r ra s rd re re s. ry
Ui 0! 0!!' rf c | S r_ rh ri s rd re re rl rf )
inverted_cdfaveraged_inverted_cdfclosest_observationinterpolated_inverted_cdfhazenweibulllinearmedian_unbiasednormal_unbiasedlowerhighermidpointnearestc | fS r_ rh )mkaxess rd _rot90_dispatcherr
4Krf rq r rq c t | }t | dk rt d t | } |d |d k s't |d |d z
| j k rt d |d | j k s5|d | j k s#|d | j k s|d | j k r(t d || j |dz }|dk r
| dd S |dk r*t t | |d |d S t d| j }||d ||d c||d < ||d < |dk r$t t | |d | S t t | | |d S ) a
Rotate an array by 90 degrees in the plane specified by axes.
Rotation direction is from the first towards the second axis.
This means for a 2D array with the default `k` and `axes`, the
rotation will be counterclockwise.
Parameters
----------
m : array_like
Array of two or more dimensions.
k : integer
Number of times the array is rotated by 90 degrees.
axes : (2,) array_like
The array is rotated in the plane defined by the axes.
Axes must be different.
.. versionadded:: 1.12.0
Returns
-------
y : ndarray
A rotated view of `m`.
See Also
--------
flip : Reverse the order of elements in an array along the given axis.
fliplr : Flip an array horizontally.
flipud : Flip an array vertically.
Notes
-----
``rot90(m, k=1, axes=(1,0))`` is the reverse of
``rot90(m, k=1, axes=(0,1))``
``rot90(m, k=1, axes=(1,0))`` is equivalent to
``rot90(m, k=-1, axes=(0,1))``
Examples
--------
>>> m = np.array([[1,2],[3,4]], int)
>>> m
array([[1, 2],
[3, 4]])
>>> np.rot90(m)
array([[2, 4],
[1, 3]])
>>> np.rot90(m, 2)
array([[4, 3],
[2, 1]])
>>> m = np.arange(8).reshape((2,2,2))
>>> np.rot90(m, 1, (1,2))
array([[[1, 3],
[0, 2]],
[[5, 7],
[4, 6]]])
r zlen(axes) must be 2.r rq zAxes must be different.z*Axes={} out of range for array of ndim={}. N)
tuplelen
ValueErrorr r ndimformatrD r r )r r r axes_lists rd rE rE s x ;;D
4yyA~~/0001
A Aw$q'Xd1gQ&7 8 8AF B B2333 Q16T!Ww . . 7af Q16' 1 1E
VD!&
!
!# # # FAAvvt AvvDDG$$d1g...q!&!!I09$q'0B09$q'0B -YtAw47+ Avvaa))9555 Ia++T!W555rf c | fS r_ rh )r axiss rd _flip_dispatcherr r rf c X t | d st | } | t j ddd f| j z }nct j || j }t j dd g| j z }|D ]}t j ddd ||< t | }| | S )a
Reverse the order of elements in an array along the given axis.
The shape of the array is preserved, but the elements are reordered.
.. versionadded:: 1.12.0
Parameters
----------
m : array_like
Input array.
axis : None or int or tuple of ints, optional
Axis or axes along which to flip over. The default,
axis=None, will flip over all of the axes of the input array.
If axis is negative it counts from the last to the first axis.
If axis is a tuple of ints, flipping is performed on all of the axes
specified in the tuple.
.. versionchanged:: 1.15.0
None and tuples of axes are supported
Returns
-------
out : array_like
A view of `m` with the entries of axis reversed. Since a view is
returned, this operation is done in constant time.
See Also
--------
flipud : Flip an array vertically (axis=0).
fliplr : Flip an array horizontally (axis=1).
Notes
-----
flip(m, 0) is equivalent to flipud(m).
flip(m, 1) is equivalent to fliplr(m).
flip(m, n) corresponds to ``m[...,::-1,...]`` with ``::-1`` at position n.
flip(m) corresponds to ``m[::-1,::-1,...,::-1]`` with ``::-1`` at all
positions.
flip(m, (0, 1)) corresponds to ``m[::-1,::-1,...]`` with ``::-1`` at
position 0 and position 1.
Examples
--------
>>> A = np.arange(8).reshape((2,2,2))
>>> A
array([[[0, 1],
[2, 3]],
[[4, 5],
[6, 7]]])
>>> np.flip(A, 0)
array([[[4, 5],
[6, 7]],
[[0, 1],
[2, 3]]])
>>> np.flip(A, 1)
array([[[2, 3],
[0, 1]],
[[6, 7],
[4, 5]]])
>>> np.flip(A)
array([[[7, 6],
[5, 4]],
[[3, 2],
[1, 0]]])
>>> np.flip(A, (0, 2))
array([[[5, 4],
[7, 6]],
[[1, 0],
[3, 2]]])
>>> A = np.random.randn(3,4,5)
>>> np.all(np.flip(A,2) == A[:,:,::-1,...])
True
r N)hasattrr r s_r _nxnormalize_axis_tupler )r r indexeraxs rd rD rD s b 1f AJJ |52;.16)'af5558*qv% & &B %"+GBKK.. W:rf c J t | n# t $ r Y dS w xY wdS )a
Check whether or not an object can be iterated over.
Parameters
----------
y : object
Input object.
Returns
-------
b : bool
Return ``True`` if the object has an iterator method or is a
sequence and ``False`` otherwise.
Examples
--------
>>> np.iterable([1, 2, 3])
True
>>> np.iterable(2)
False
Notes
-----
In most cases, the results of ``np.iterable(obj)`` are consistent with
``isinstance(obj, collections.abc.Iterable)``. One notable exception is
the treatment of 0-dimensional arrays::
>>> from collections.abc import Iterable
>>> a = np.array(1.0) # 0-dimensional numpy array
>>> isinstance(a, Iterable)
True
>>> np.iterable(a)
False
FT)iter TypeError)ys rd r< r< \ s< L Q uu 4s
)keepdimsc
| |fS r_ rh )ar weightsreturnedr s rd _average_dispatcherr s
w<rf Fc t j | } |t j u ri }nd|i}|K | j |fi |}t j | }|j | j |j z }nt j | } t | j j t j t j f r!t j
| j | j d }
n t j
| j | j }
| j | j k r|t d | j
dk rt d | j d | j | k rt d t j | | j
dz
d z | j z } | d
| } | j d||
d |}t j |d k rt' d
t j | | |
j |fi ||z x}}|r@|j |j k r,t j ||j }||fS |S )a
Compute the weighted average along the specified axis.
Parameters
----------
a : array_like
Array containing data to be averaged. If `a` is not an array, a
conversion is attempted.
axis : None or int or tuple of ints, optional
Axis or axes along which to average `a`. The default,
axis=None, will average over all of the elements of the input array.
If axis is negative it counts from the last to the first axis.
.. versionadded:: 1.7.0
If axis is a tuple of ints, averaging is performed on all of the axes
specified in the tuple instead of a single axis or all the axes as
before.
weights : array_like, optional
An array of weights associated with the values in `a`. Each value in
`a` contributes to the average according to its associated weight.
The weights array can either be 1-D (in which case its length must be
the size of `a` along the given axis) or of the same shape as `a`.
If `weights=None`, then all data in `a` are assumed to have a
weight equal to one. The 1-D calculation is::
avg = sum(a * weights) / sum(weights)
The only constraint on `weights` is that `sum(weights)` must not be 0.
returned : bool, optional
Default is `False`. If `True`, the tuple (`average`, `sum_of_weights`)
is returned, otherwise only the average is returned.
If `weights=None`, `sum_of_weights` is equivalent to the number of
elements over which the average is taken.
keepdims : bool, optional
If this is set to True, the axes which are reduced are left
in the result as dimensions with size one. With this option,
the result will broadcast correctly against the original `a`.
*Note:* `keepdims` will not work with instances of `numpy.matrix`
or other classes whose methods do not support `keepdims`.
.. versionadded:: 1.23.0
Returns
-------
retval, [sum_of_weights] : array_type or double
Return the average along the specified axis. When `returned` is `True`,
return a tuple with the average as the first element and the sum
of the weights as the second element. `sum_of_weights` is of the
same type as `retval`. The result dtype follows a genereal pattern.
If `weights` is None, the result dtype will be that of `a` , or ``float64``
if `a` is integral. Otherwise, if `weights` is not None and `a` is non-
integral, the result type will be the type of lowest precision capable of
representing values of both `a` and `weights`. If `a` happens to be
integral, the previous rules still applies but the result dtype will
at least be ``float64``.
Raises
------
ZeroDivisionError
When all weights along axis are zero. See `numpy.ma.average` for a
version robust to this type of error.
TypeError
When the length of 1D `weights` is not the same as the shape of `a`
along axis.
See Also
--------
mean
ma.average : average for masked arrays -- useful if your data contains
"missing" values
numpy.result_type : Returns the type that results from applying the
numpy type promotion rules to the arguments.
Examples
--------
>>> data = np.arange(1, 5)
>>> data
array([1, 2, 3, 4])
>>> np.average(data)
2.5
>>> np.average(np.arange(1, 11), weights=np.arange(10, 0, -1))
4.0
>>> data = np.arange(6).reshape((3, 2))
>>> data
array([[0, 1],
[2, 3],
[4, 5]])
>>> np.average(data, axis=1, weights=[1./4, 3./4])
array([0.75, 2.75, 4.75])
>>> np.average(data, weights=[1./4, 3./4])
Traceback (most recent call last):
...
TypeError: Axis must be specified when shapes of a and weights differ.
>>> a = np.ones(5, dtype=np.float128)
>>> w = np.ones(5, dtype=np.complex64)
>>> avg = np.average(a, weights=w)
>>> print(avg.dtype)
complex256
With ``keepdims=True``, the following result has shape (3, 1).
>>> np.average(data, axis=1, keepdims=True)
array([[0.5],
[2.5],
[4.5]])
r Nf8z;Axis must be specified when shapes of a and weights differ.rq z81D weights expected when shapes of a and weights differ.r z5Length of weights not compatible with specified axis.rq r )r dtyper z(Weights sum to zero, can't be normalizedr rh )r r _NoValuer% r typesize
issubclassr bool_ result_typerv r r r broadcast_toswapaxesr' r& ZeroDivisionErrormultiplyr; ) r r r r r keepdims_kwavg avg_as_arraysclwgt result_dtypes rd rJ rJ sx b
aA2; !8, afT))[))}S)) %%af\->&>??mG$$ aglRZ$: ; ; > >!'39dCCLL >!'39==L
7ci | x1}} NP P Py|qwt},, KM M M /#q$'BCCC,,r4((CcgC4|CC{CC
6#* <#:< <
< 2R[C , . . ..1$ G G:E G GIL M Ml 9 * * */#|'9::??AACCx
rf c t | || } | j j t d v r5t j | st d | S )a Convert the input to an array, checking for NaNs or Infs.
Parameters
----------
a : array_like
Input data, in any form that can be converted to an array. This
includes lists, lists of tuples, tuples, tuples of tuples, tuples
of lists and ndarrays. Success requires no NaNs or Infs.
dtype : data-type, optional
By default, the data-type is inferred from the input data.
order : {'C', 'F', 'A', 'K'}, optional
Memory layout. 'A' and 'K' depend on the order of input array a.
'C' row-major (C-style),
'F' column-major (Fortran-style) memory representation.
'A' (any) means 'F' if `a` is Fortran contiguous, 'C' otherwise
'K' (keep) preserve input order
Defaults to 'C'.
Returns
-------
out : ndarray
Array interpretation of `a`. No copy is performed if the input
is already an ndarray. If `a` is a subclass of ndarray, a base
class ndarray is returned.
Raises
------
ValueError
Raises ValueError if `a` contains NaN (Not a Number) or Inf (Infinity).
See Also
--------
asarray : Create and array.
asanyarray : Similar function which passes through subclasses.
ascontiguousarray : Convert input to a contiguous array.
asfarray : Convert input to a floating point ndarray.
asfortranarray : Convert input to an ndarray with column-major
memory order.
fromiter : Create an array from an iterator.
fromfunction : Construct an array by executing a function on grid
positions.
Examples
--------
Convert a list into an array. If all elements are finite
``asarray_chkfinite`` is identical to ``asarray``.
>>> a = [1, 2]
>>> np.asarray_chkfinite(a, dtype=float)
array([1., 2.])
Raises ValueError if array_like contains Nans or Infs.
>>> a = [1, 2, np.inf]
>>> try:
... np.asarray_chkfinite(a)
... except ValueError:
... print('ValueError')
...
ValueError
)r orderAllFloatz#array must not contain infs or NaNs)r r charr( r isfiniteallr )r r r s rd rI rI 4 s` @ e,,,Aw|y,,,R[^^5G5G5I5I, 13 3 3 Hrf c / N K | V t j | r
|E d {V d S d S r_ )r r< )xcondlistfunclistargskws rd _piecewise_dispatcherr { sI
GGG {8 rf c t | } t | }t | s-t |d t t
f s| j dk r|g}t |t }t | }||dz
k r6t j
|dd }t j ||gd }|dz
}n-||k r't d
|||dz t | }t || D ]L\ } }
t |
t j j s|
|| < *| | } | j dk r |
| g|R i ||| < M|S )a
Evaluate a piecewise-defined function.
Given a set of conditions and corresponding functions, evaluate each
function on the input data wherever its condition is true.
Parameters
----------
x : ndarray or scalar
The input domain.
condlist : list of bool arrays or bool scalars
Each boolean array corresponds to a function in `funclist`. Wherever
`condlist[i]` is True, `funclist[i](x)` is used as the output value.
Each boolean array in `condlist` selects a piece of `x`,
and should therefore be of the same shape as `x`.
The length of `condlist` must correspond to that of `funclist`.
If one extra function is given, i.e. if
``len(funclist) == len(condlist) + 1``, then that extra function
is the default value, used wherever all conditions are false.
funclist : list of callables, f(x,*args,**kw), or scalars
Each function is evaluated over `x` wherever its corresponding
condition is True. It should take a 1d array as input and give an 1d
array or a scalar value as output. If, instead of a callable,
a scalar is provided then a constant function (``lambda x: scalar``) is
assumed.
args : tuple, optional
Any further arguments given to `piecewise` are passed to the functions
upon execution, i.e., if called ``piecewise(..., ..., 1, 'a')``, then
each function is called as ``f(x, 1, 'a')``.
kw : dict, optional
Keyword arguments used in calling `piecewise` are passed to the
functions upon execution, i.e., if called
``piecewise(..., ..., alpha=1)``, then each function is called as
``f(x, alpha=1)``.
Returns
-------
out : ndarray
The output is the same shape and type as x and is found by
calling the functions in `funclist` on the appropriate portions of `x`,
as defined by the boolean arrays in `condlist`. Portions not covered
by any condition have a default value of 0.
See Also
--------
choose, select, where
Notes
-----
This is similar to choose or select, except that functions are
evaluated on elements of `x` that satisfy the corresponding condition from
`condlist`.
The result is::
|--
|funclist[0](x[condlist[0]])
out = |funclist[1](x[condlist[1]])
|...
|funclist[n2](x[condlist[n2]])
|--
Examples
--------
Define the sigma function, which is -1 for ``x < 0`` and +1 for ``x >= 0``.
>>> x = np.linspace(-2.5, 2.5, 6)
>>> np.piecewise(x, [x < 0, x >= 0], [-1, 1])
array([-1., -1., -1., 1., 1., 1.])
Define the absolute value, which is ``-x`` for ``x <0`` and ``x`` for
``x >= 0``.
>>> np.piecewise(x, [x < 0, x >= 0], [lambda x: -x, lambda x: x])
array([2.5, 1.5, 0.5, 0.5, 1.5, 2.5])
Apply the same function to a scalar value.
>>> y = -2
>>> np.piecewise(y, [y < 0, y >= 0], [lambda x: -x, lambda x: x])
array(2)
r r rq T)r r r zVq[[ :xt,,,H H
ABF{{F8!d;;;;>8X"6Q??? Q
b J
VAq!A#
1
A(H-- 2 2
d$ 899 2AdGGT7Dy1}} $t1d111b11$ Hrf c # * K | E d {V |E d {V d S r_ rh )r
choicelistdefaults rd _select_dispatcherr s< rf c & t | t | k rt d t | dk rt d d |D } t j | }n'# t $ r}d| }t | dd}~ww xY wt j | }| | t j || }n'# t $ r}d| }t | dd}~ww xY wt j | } t j | }t | D ]?\ }} | j j
t j ur"t d | @|d j
dk r| d j }
n,t j | d |d d j }
t j |
|d | } |d
dd }| ddd } t! || D ] \ } } t j | | | | S ) a9
Return an array drawn from elements in choicelist, depending on conditions.
Parameters
----------
condlist : list of bool ndarrays
The list of conditions which determine from which array in `choicelist`
the output elements are taken. When multiple conditions are satisfied,
the first one encountered in `condlist` is used.
choicelist : list of ndarrays
The list of arrays from which the output elements are taken. It has
to be of the same length as `condlist`.
default : scalar, optional
The element inserted in `output` when all conditions evaluate to False.
Returns
-------
output : ndarray
The output at position m is the m-th element of the array in
`choicelist` where the m-th element of the corresponding array in
`condlist` is True.
See Also
--------
where : Return elements from one of two arrays depending on condition.
take, choose, compress, diag, diagonal
Examples
--------
>>> x = np.arange(6)
>>> condlist = [x<3, x>3]
>>> choicelist = [x, x**2]
>>> np.select(condlist, choicelist, 42)
array([ 0, 1, 2, 42, 16, 25])
>>> condlist = [x<=4, x>3]
>>> choicelist = [x, x**2]
>>> np.select(condlist, choicelist, 55)
array([ 0, 1, 2, 3, 4, 25])
z7list of cases must be same length as list of conditionsr z3select with an empty condition list is not possiblec 6 g | ]}t j | S rh )r r ).0choices rd
zselect..4 s" >>>"*V$$>>>rf z0Choicelist elements do not have a common dtype: Nz:Choicelists and default value do not have a common dtype: z7invalid entry {} in condlist: should be boolean ndarrayr r )r r r r r r r[ broadcast_arrays enumerater r r r r rv fullr copyto)
r r r intermediate_dtypeemsg
default_arrayr ir result_shaperesultr s
rd r8 r8 s` X 8}}J'' EG G G 8}}NOOO>>:>>>J' ^Z 8 ' ' 'DDDnn$&' Jw''Mm$$$' 1=AA ' ' 'N1NNnn$&' "H-H$j1J X&& U U4 :?"( * *IPPQRSSU U
U + !}Q {( *8A;
1
FFqIO
W\:b>5
9
9F
BFF#J"~HJ11 . .
&&----- Ms0 A. .
B8B
B?C
C9 C44C9c | fS r_ rh r r suboks rd _copy_dispatcherr e r rf Kc ( t | ||d S )a-
Return an array copy of the given object.
Parameters
----------
a : array_like
Input data.
order : {'C', 'F', 'A', 'K'}, optional
Controls the memory layout of the copy. 'C' means C-order,
'F' means F-order, 'A' means 'F' if `a` is Fortran contiguous,
'C' otherwise. 'K' means match the layout of `a` as closely
as possible. (Note that this function and :meth:`ndarray.copy` are very
similar, but have different default values for their order=
arguments.)
subok : bool, optional
If True, then sub-classes will be passed-through, otherwise the
returned array will be forced to be a base-class array (defaults to False).
.. versionadded:: 1.19.0
Returns
-------
arr : ndarray
Array interpretation of `a`.
See Also
--------
ndarray.copy : Preferred method for creating an array copy
Notes
-----
This is equivalent to:
>>> np.array(a, copy=True) #doctest: +SKIP
Examples
--------
Create an array x, with a reference y and a copy z:
>>> x = np.array([1, 2, 3])
>>> y = x
>>> z = np.copy(x)
Note that, when we modify x, y changes, but not z:
>>> x[0] = 10
>>> x[0] == y[0]
True
>>> x[0] == z[0]
False
Note that, np.copy clears previously set WRITEABLE=False flag.
>>> a = np.array([1, 2, 3])
>>> a.flags["WRITEABLE"] = False
>>> b = np.copy(a)
>>> b.flags["WRITEABLE"]
True
>>> b[0] = 3
>>> b
array([3, 2, 3])
Note that np.copy is a shallow copy and will not copy object
elements within arrays. This is mainly important for arrays
containing Python objects. The new array will contain the
same object which may lead to surprises if that object can
be modified (is mutable):
>>> a = np.array([1, 'm', [2, 3, 4]], dtype=object)
>>> b = np.copy(a)
>>> b[2][0] = 10
>>> a
array([1, 'm', list([10, 3, 4])], dtype=object)
To ensure all elements within an ``object`` array are copied,
use `copy.deepcopy`:
>>> import copy
>>> a = np.array([1, 'm', [2, 3, 4]], dtype=object)
>>> c = copy.deepcopy(a)
>>> c[2][0] = 10
>>> c
array([1, 'm', list([10, 3, 4])], dtype=object)
>>> a
array([1, 'm', list([2, 3, 4])], dtype=object)
T)r r r; )r
r s rd r; r; i s r %u4 8 8 88rf )r
edge_orderc ' " K | V |E d {V d S r_ rh )fr r varargss rd _gradient_dispatcherr s-
GGGrf c t j | } | j }| t t | }nt j || }t | }t | }|dk rdg|z }nU|dk r%t j |d dk r||z }n*||k rt | }t | D ]\ } }
t j |
}
|
j dk r%|
j dk rt d t |
| j || k rt d t j |
j
t j r |
t j }
t j |
} | | d k r| d } | || < nt' d |dk rt d g } t) d g|z }
t) d g|z }t) d g|z }t) d g|z }| j
}|j t j u rCt j
|j d
d }| | } n~|j t j u rnjt j |t j rnJt j |t j r | t j } t j }t9 || D ]4\ }}| j | |dz k rt d t j | |
}t j | dk }t) dd |
|< t) dd ||< t) dd ||< t) dd ||< |rB| t | | t | z
d|z z |t |
< n|dd }|dd }| |||z z z }||z
||z z }||||z z z }t j |t>
}d||< |x|_ x|_ |_ || t | z || t | z z || t | z z |t |
< |dk rd|
|< d||< d||< |r|n|d }| t | | t | z
|z |t |
< d|
|< d||< d||< |r|n|d } | t | | t | z
| z |t |
< nqd|
|< d||< d||< d||< |rd|z }d|z }d|z }n9|d }|d }d|z |z |||z z z }||z ||z z }| |||z z z }|| t | z || t | z z || t | z z |t |
< d|
|< d||< d||< d||< |rd|z }d|z }d|z }n8|d }|d }||||z z z }||z ||z z }d|z |z |||z z z }|| t | z || t | z z || t | z z |t |
< | | t) d |
|< t) d ||< t) d ||< t) d ||< 6|dk r| d S t j! rt | S | S )a
Return the gradient of an N-dimensional array.
The gradient is computed using second order accurate central differences
in the interior points and either first or second order accurate one-sides
(forward or backwards) differences at the boundaries.
The returned gradient hence has the same shape as the input array.
Parameters
----------
f : array_like
An N-dimensional array containing samples of a scalar function.
varargs : list of scalar or array, optional
Spacing between f values. Default unitary spacing for all dimensions.
Spacing can be specified using:
1. single scalar to specify a sample distance for all dimensions.
2. N scalars to specify a constant sample distance for each dimension.
i.e. `dx`, `dy`, `dz`, ...
3. N arrays to specify the coordinates of the values along each
dimension of F. The length of the array must match the size of
the corresponding dimension
4. Any combination of N scalars/arrays with the meaning of 2. and 3.
If `axis` is given, the number of varargs must equal the number of axes.
Default: 1.
edge_order : {1, 2}, optional
Gradient is calculated using N-th order accurate differences
at the boundaries. Default: 1.
.. versionadded:: 1.9.1
axis : None or int or tuple of ints, optional
Gradient is calculated only along the given axis or axes
The default (axis = None) is to calculate the gradient for all the axes
of the input array. axis may be negative, in which case it counts from
the last to the first axis.
.. versionadded:: 1.11.0
Returns
-------
gradient : ndarray or list of ndarray
A list of ndarrays (or a single ndarray if there is only one dimension)
corresponding to the derivatives of f with respect to each dimension.
Each derivative has the same shape as f.
Examples
--------
>>> f = np.array([1, 2, 4, 7, 11, 16], dtype=float)
>>> np.gradient(f)
array([1. , 1.5, 2.5, 3.5, 4.5, 5. ])
>>> np.gradient(f, 2)
array([0.5 , 0.75, 1.25, 1.75, 2.25, 2.5 ])
Spacing can be also specified with an array that represents the coordinates
of the values F along the dimensions.
For instance a uniform spacing:
>>> x = np.arange(f.size)
>>> np.gradient(f, x)
array([1. , 1.5, 2.5, 3.5, 4.5, 5. ])
Or a non uniform one:
>>> x = np.array([0., 1., 1.5, 3.5, 4., 6.], dtype=float)
>>> np.gradient(f, x)
array([1. , 3. , 3.5, 6.7, 6.9, 2.5])
For two dimensional arrays, the return will be two arrays ordered by
axis. In this example the first array stands for the gradient in
rows and the second one in columns direction:
>>> np.gradient(np.array([[1, 2, 6], [3, 4, 5]], dtype=float))
[array([[ 2., 2., -1.],
[ 2., 2., -1.]]), array([[1. , 2.5, 4. ],
[1. , 1. , 1. ]])]
In this example the spacing is also specified:
uniform for axis=0 and non uniform for axis=1
>>> dx = 2.
>>> y = [1., 1.5, 3.5]
>>> np.gradient(np.array([[1, 2, 6], [3, 4, 5]], dtype=float), dx, y)
[array([[ 1. , 1. , -0.5],
[ 1. , 1. , -0.5]]), array([[2. , 2. , 2. ],
[2. , 1.7, 0.5]])]
It is possible to specify how boundaries are treated using `edge_order`
>>> x = np.array([0, 1, 2, 3, 4])
>>> f = x**2
>>> np.gradient(f, edge_order=1)
array([1., 2., 4., 6., 7.])
>>> np.gradient(f, edge_order=2)
array([0., 2., 4., 6., 8.])
The `axis` keyword can be used to specify a subset of axes of which the
gradient is calculated
>>> np.gradient(np.array([[1, 2, 6], [3, 4, 5]], dtype=float), axis=0)
array([[ 2., 2., -1.],
[ 2., 2., -1.]])
Notes
-----
Assuming that :math:`f\in C^{3}` (i.e., :math:`f` has at least 3 continuous
derivatives) and let :math:`h_{*}` be a non-homogeneous stepsize, we
minimize the "consistency error" :math:`\eta_{i}` between the true gradient
and its estimate from a linear combination of the neighboring grid-points:
.. math::
\eta_{i} = f_{i}^{\left(1\right)} -
\left[ \alpha f\left(x_{i}\right) +
\beta f\left(x_{i} + h_{d}\right) +
\gamma f\left(x_{i}-h_{s}\right)
\right]
By substituting :math:`f(x_{i} + h_{d})` and :math:`f(x_{i} - h_{s})`
with their Taylor series expansion, this translates into solving
the following the linear system:
.. math::
\left\{
\begin{array}{r}
\alpha+\beta+\gamma=0 \\
\beta h_{d}-\gamma h_{s}=1 \\
\beta h_{d}^{2}+\gamma h_{s}^{2}=0
\end{array}
\right.
The resulting approximation of :math:`f_{i}^{(1)}` is the following:
.. math::
\hat f_{i}^{(1)} =
\frac{
h_{s}^{2}f\left(x_{i} + h_{d}\right)
+ \left(h_{d}^{2} - h_{s}^{2}\right)f\left(x_{i}\right)
- h_{d}^{2}f\left(x_{i}-h_{s}\right)}
{ h_{s}h_{d}\left(h_{d} + h_{s}\right)}
+ \mathcal{O}\left(\frac{h_{d}h_{s}^{2}
+ h_{s}h_{d}^{2}}{h_{d}
+ h_{s}}\right)
It is worth noting that if :math:`h_{s}=h_{d}`
(i.e., data are evenly spaced)
we find the standard second order approximation:
.. math::
\hat f_{i}^{(1)}=
\frac{f\left(x_{i+1}\right) - f\left(x_{i-1}\right)}{2h}
+ \mathcal{O}\left(h^{2}\right)
With a similar procedure the forward/backward approximations used for
boundaries can be derived.
References
----------
.. [1] Quarteroni A., Sacco R., Saleri F. (2007) Numerical Mathematics
(Texts in Applied Mathematics). New York: Springer.
.. [2] Durran D. R. (1999) Numerical Methods for Wave Equations
in Geophysical Fluid Dynamics. New York: Springer.
.. [3] Fornberg B. (1988) Generation of Finite Difference Formulas on
Arbitrarily Spaced Grids,
Mathematics of Computation 51, no. 184 : 699-706.
`PDF `_.
Nr rs rq z&distances must be either scalars or 1dzGwhen 1d, distances must match the length of the corresponding dimensionzinvalid number of argumentsr z)'edge_order' greater than 2 not supporteddatetime timedeltazlShape of array too small to calculate a numerical gradient, at least (edge_order + 1) elements are required.r r r @g g rt g g ?)"r r r r ranger r r r r r rv
issubdtyper r r float64r> r r slicer
datetime64namereplaceview timedelta64inexactr
empty_liker intr[ _using_numpy2_behavior) r r r r Nr len_axesrb dxr distancesdiffxoutvalsslice1slice2slice3slice4otypeax_dxoutuniform_spacingdx1dx2r bcrv dx_0dx_ns rd r? r? s ^
aA A |U1XX'a004yyH G AAvvUX
aBGGAJ''1,,
x
h
']] %bMM LAy
i00I~"" 1$$ !IJJJ9~~a!111 "M N N N}Y_bj99
9 & , ,RZ 8 8 GI&&E q!&&((
! aBqEE% ( 5666A~~DEEE
G Dkk]1_FDkk]1_FDkk]1_FDkk]1_F
GE zR]""++J DDEE
FF5MM r~ % % ubj ) )
=
+ + %$$A
4}} Z# Z# e 74=:> ) ) CD D
D mAU+++ '%..A- Q||t T2t Q||t Q~~t
d"#E&MM"2QuV}}5E"E"u*!UCf
"+C)CsSy)*AssSy)AscCi()AGAS)))E E$K*/ /AG /ag!"QuV}}%5!5AeFmm>> u8_arr = np.array([1, 0], dtype=np.uint8)
>>> np.diff(u8_arr)
array([255], dtype=uint8)
>>> u8_arr[1,...] - u8_arr[0,...]
255
If this is not desirable, then the array should be cast to a larger
integer type first:
>>> i16_arr = u8_arr.astype(np.int16)
>>> np.diff(i16_arr)
array([-1], dtype=int16)
Examples
--------
>>> x = np.array([1, 2, 4, 7, 0])
>>> np.diff(x)
array([ 1, 2, 3, -7])
>>> np.diff(x, n=2)
array([ 1, 1, -10])
>>> x = np.array([[1, 3, 6, 10], [0, 5, 6, 8]])
>>> np.diff(x)
array([[2, 3, 4],
[5, 1, 2]])
>>> np.diff(x, axis=0)
array([[-1, 2, 0, -2]])
>>> x = np.arange('1066-10-13', '1066-10-16', dtype=np.datetime64)
>>> np.diff(x)
array([1, 1], dtype='timedelta64[D]')
r z#order must be non-negative but got z4diff requires input that is at least one dimensionalrq Nr )r reprr r r/ r r r rv r r r[ r r r) r r r r! r& ) r rb r rH r[ ndcombinedrv r9 r: oprk s rd r> r> , s( j Avv1uu 1DGG ;= = = 1
A
B QwwOPPP b ) )DHbk!!-(( <1 MMEE$KoguU||<>F4Lr??F4L
6]]F
6]]Fg))xB
1XX % % Bqy!F) $ $ Hrf c | ||fS r_ rh )r xpfpleftrightperiods rd _interp_dispatcherrU s
r2;rf c d t j | }t j | rt }t j }nt
}t j }|P|dk rt d t | }d}d}t j | t j } t j |t j }t j || }|j dk s |j dk rt d |j
d |j
d k rt d | |z } ||z }t j | }|| }|| }t j |dd |z
||dd |z f }t j |dd ||dd f } || |||| S ) a
One-dimensional linear interpolation for monotonically increasing sample points.
Returns the one-dimensional piecewise linear interpolant to a function
with given discrete data points (`xp`, `fp`), evaluated at `x`.
Parameters
----------
x : array_like
The x-coordinates at which to evaluate the interpolated values.
xp : 1-D sequence of floats
The x-coordinates of the data points, must be increasing if argument
`period` is not specified. Otherwise, `xp` is internally sorted after
normalizing the periodic boundaries with ``xp = xp % period``.
fp : 1-D sequence of float or complex
The y-coordinates of the data points, same length as `xp`.
left : optional float or complex corresponding to fp
Value to return for `x < xp[0]`, default is `fp[0]`.
right : optional float or complex corresponding to fp
Value to return for `x > xp[-1]`, default is `fp[-1]`.
period : None or float, optional
A period for the x-coordinates. This parameter allows the proper
interpolation of angular x-coordinates. Parameters `left` and `right`
are ignored if `period` is specified.
.. versionadded:: 1.10.0
Returns
-------
y : float or complex (corresponding to fp) or ndarray
The interpolated values, same shape as `x`.
Raises
------
ValueError
If `xp` and `fp` have different length
If `xp` or `fp` are not 1-D sequences
If `period == 0`
See Also
--------
scipy.interpolate
Warnings
--------
The x-coordinate sequence is expected to be increasing, but this is not
explicitly enforced. However, if the sequence `xp` is non-increasing,
interpolation results are meaningless.
Note that, since NaN is unsortable, `xp` also cannot contain NaNs.
A simple check for `xp` being strictly increasing is::
np.all(np.diff(xp) > 0)
Examples
--------
>>> xp = [1, 2, 3]
>>> fp = [3, 2, 0]
>>> np.interp(2.5, xp, fp)
1.0
>>> np.interp([0, 1, 1.5, 2.72, 3.14], xp, fp)
array([3. , 3. , 2.5 , 0.56, 0. ])
>>> UNDEF = -99.0
>>> np.interp(3.14, xp, fp, right=UNDEF)
-99.0
Plot an interpolant to the sine function:
>>> x = np.linspace(0, 2*np.pi, 10)
>>> y = np.sin(x)
>>> xvals = np.linspace(0, 2*np.pi, 50)
>>> yinterp = np.interp(xvals, x, y)
>>> import matplotlib.pyplot as plt
>>> plt.plot(x, y, 'o')
[]
>>> plt.plot(xvals, yinterp, '-x')
[]
>>> plt.show()
Interpolation with periodic x-coordinates:
>>> x = [-180, -170, -185, 185, -10, -5, 0, 365]
>>> xp = [190, -190, 350, -350]
>>> fp = [5, 10, 3, 4]
>>> np.interp(x, xp, fp, period=360)
array([7.5 , 5. , 8.75, 6.25, 3. , 3.25, 3.5 , 3.75])
Complex interpolation:
>>> x = [1.5, 4.0]
>>> xp = [2,3,5]
>>> fp = [1.0j, 0, 2+3j]
>>> np.interp(x, xp, fp)
array([0.+1.j , 1.+1.5j])
Nr z period must be a non-zero valuer rq z!Data points must be 1-D sequencesz$fp and xp are not of the same lengthr )
r r iscomplexobjcompiled_interp_complex
complex128compiled_interpr( r absr rv argsortr ) r rP rQ rR rS rT interp_func input_dtypeasort_xps rd r1 r1 s R
B B r !- m % j
Q;; >?? ?V Jq
+ + +
Z"*
-
-
-
Z+
.
.
.
7a<<27a<< @AA A
8A;"(1+ % % CDD D
J
&[:b>>
\
\
^RWV^RAaC @
A
A
^RWb"QqS' 2
3
3 ;q"b$ . ..rf c | fS r_ rh )zdegs rd _angle_dispatcherrc B r rf c t | } t | j j t j r| j }| j }nd}| }t || }|r
|dt z z }|S )a
Return the angle of the complex argument.
Parameters
----------
z : array_like
A complex number or sequence of complex numbers.
deg : bool, optional
Return angle in degrees if True, radians if False (default).
Returns
-------
angle : ndarray or scalar
The counterclockwise angle from the positive real axis on the complex
plane in the range ``(-pi, pi]``, with dtype as numpy.float64.
.. versionchanged:: 1.16.0
This function works on subclasses of ndarray like `ma.array`.
See Also
--------
arctan2
absolute
Notes
-----
Although the angle of the complex number 0 is undefined, ``numpy.angle(0)``
returns the value 0.
Examples
--------
>>> np.angle([1.0, 1.0j, 1+1j]) # in radians
array([ 0. , 1.57079633, 0.78539816]) # may vary
>>> np.angle(1+1j, deg=True) # in degrees
45.0
r )
r r r r r complexfloatingimagrealr r )ra rb zimagzrealr s rd r@ r@ F sl N 1
A!', 344 u A
SV Hrf )rT c | fS r_ rh )pdiscontr rT s rd _unwrap_dispatcherrn { r rf c t | } | j }t | | }||dz }t dd g|z }t dd ||< t | }t j || }t j |t j rt |d \ }} | dk }
n|dz }d}
| } t || z
| | z } |
r"t j | || | k |dk z | |z
}
t j |
dt | |k t | d| }| | |
| z ||< |S ) a
Unwrap by taking the complement of large deltas with respect to the period.
This unwraps a signal `p` by changing elements which have an absolute
difference from their predecessor of more than ``max(discont, period/2)``
to their `period`-complementary values.
For the default case where `period` is :math:`2\pi` and `discont` is
:math:`\pi`, this unwraps a radian phase `p` such that adjacent differences
are never greater than :math:`\pi` by adding :math:`2k\pi` for some
integer :math:`k`.
Parameters
----------
p : array_like
Input array.
discont : float, optional
Maximum discontinuity between values, default is ``period/2``.
Values below ``period/2`` are treated as if they were ``period/2``.
To have an effect different from the default, `discont` should be
larger than ``period/2``.
axis : int, optional
Axis along which unwrap will operate, default is the last axis.
period : float, optional
Size of the range over which the input wraps. By default, it is
``2 pi``.
.. versionadded:: 1.21.0
Returns
-------
out : ndarray
Output array.
See Also
--------
rad2deg, deg2rad
Notes
-----
If the discontinuity in `p` is smaller than ``period/2``,
but larger than `discont`, no unwrapping is done because taking
the complement would only make the discontinuity larger.
Examples
--------
>>> phase = np.linspace(0, np.pi, num=5)
>>> phase[3:] += np.pi
>>> phase
array([ 0. , 0.78539816, 1.57079633, 5.49778714, 6.28318531]) # may vary
>>> np.unwrap(phase)
array([ 0. , 0.78539816, 1.57079633, -0.78539816, 0. ]) # may vary
>>> np.unwrap([0, 1, 2, -1, 0], period=4)
array([0, 1, 2, 3, 4])
>>> np.unwrap([ 1, 2, 3, 4, 5, 6, 1, 2, 3], period=6)
array([1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> np.unwrap([2, 3, 4, 5, 2, 3, 4, 5], period=4)
array([2, 3, 4, 5, 6, 7, 8, 9])
>>> phase_deg = np.mod(np.linspace(0 ,720, 19), 360) - 180
>>> np.unwrap(phase_deg, period=360)
array([-180., -140., -100., -60., -20., 20., 60., 100., 140.,
180., 220., 260., 300., 340., 380., 420., 460., 500.,
540.])
r Nr rq r Tr
)r; r )r r r> r) r r r r r' r divmodr r r[ r
cumsum)rl rm r rT rL ddr9 r
interval_highremboundary_ambiguous interval_lowddmod
ph_correctups rd rA rA s} D
A
B
ad B(D$
#FD>>F4L
6]]F N2v & &E
~eS[)) " #FA . .
s AX
!!>L \!6 * *\ 9E =
5- </BF; = = = =JJz1CGGg$56666 qt5 ) ) )B6Z . .t 4 44BvJ
Irf c | fS r_ rh r s rd
_sort_complexr| r rf c R t | d }| t |j j t
j s]|j j dv r| d S |j j dk r| d S | d S |S )a
Sort a complex array using the real part first, then the imaginary part.
Parameters
----------
a : array_like
Input array
Returns
-------
out : complex ndarray
Always returns a sorted complex array.
Examples
--------
>>> np.sort_complex([5, 3, 6, 2, 1])
array([1.+0.j, 2.+0.j, 3.+0.j, 5.+0.j, 6.+0.j])
>>> np.sort_complex([1 + 2j, 2 - 1j, 3 - 2j, 3 - 3j, 3 + 5j])
array([1.+2.j, 2.-1.j, 3.-3.j, 3.-2.j, 3.+5.j])
Tr; bhBHFgGD) r
sortr r r r rf r r r rC s rd rB rB s 0 adAFFHHH aglC$7 8 8 7<6 ! !88C==
W\S
88C== 88C== rf c | fS r_ rh )filttrims rd _trim_zerosr s 7Nrf fbc d}| }d|v r| D ]}|dk r n|dz }t | }d|v r| ddd D ]}|dk r n|dz
}| || S )a/
Trim the leading and/or trailing zeros from a 1-D array or sequence.
Parameters
----------
filt : 1-D array or sequence
Input array.
trim : str, optional
A string with 'f' representing trim from front and 'b' to trim from
back. Default is 'fb', trim zeros from both front and back of the
array.
Returns
-------
trimmed : 1-D array or sequence
The result of trimming the input. The input data type is preserved.
Examples
--------
>>> a = np.array((0, 0, 0, 1, 2, 3, 0, 2, 1, 0))
>>> np.trim_zeros(a)
array([1, 2, 3, 0, 2, 1])
>>> np.trim_zeros(a, 'b')
array([0, 0, 0, ..., 0, 2, 1])
The input data type is preserved, list/tuple in means list/tuple out.
>>> np.trim_zeros([0, 1, 2, 0])
[1, 2]
r r r rq BNr )upperr )r r firstr lasts rd r: r: s F
E ::<>> arr = np.arange(12).reshape((3, 4))
>>> arr
array([[ 0, 1, 2, 3],
[ 4, 5, 6, 7],
[ 8, 9, 10, 11]])
>>> condition = np.mod(arr, 3)==0
>>> condition
array([[ True, False, False, True],
[False, False, True, False],
[False, True, False, False]])
>>> np.extract(condition, arr)
array([0, 3, 6, 9])
If `condition` is boolean:
>>> arr[condition]
array([0, 3, 6, 9])
r )r r r" r# r s rd rF rF E s2 b 8E#JJi(8(8 9 9! < = ==rf c | ||fS r_ rh r maskr s rd _place_dispatcherr y s t rf c $ t | || S )a
Change elements of an array based on conditional and input values.
Similar to ``np.copyto(arr, vals, where=mask)``, the difference is that
`place` uses the first N elements of `vals`, where N is the number of
True values in `mask`, while `copyto` uses the elements where `mask`
is True.
Note that `extract` does the exact opposite of `place`.
Parameters
----------
arr : ndarray
Array to put data into.
mask : array_like
Boolean mask array. Must have the same size as `a`.
vals : 1-D sequence
Values to put into `a`. Only the first N elements are used, where
N is the number of True values in `mask`. If `vals` is smaller
than N, it will be repeated, and if elements of `a` are to be masked,
this sequence must be non-empty.
See Also
--------
copyto, put, take, extract
Examples
--------
>>> arr = np.arange(6).reshape(2, 3)
>>> np.place(arr, arr>2, [44, 55])
>>> arr
array([[ 0, 1, 2],
[44, 55, 44]])
)r, r s rd rG rG } s J #tT " ""rf Tc | t j }|r| d| z n| d| z | dS )a2
Display a message on a device.
Parameters
----------
mesg : str
Message to display.
device : object
Device to write message. If None, defaults to ``sys.stdout`` which is
very similar to ``print``. `device` needs to have ``write()`` and
``flush()`` methods.
linefeed : bool, optional
Option whether to print a line feed or not. Defaults to True.
Raises
------
AttributeError
If `device` does not have a ``write()`` or ``flush()`` method.
Examples
--------
Besides ``sys.stdout``, a file-like object can also be used as it has
both required methods:
>>> from io import StringIO
>>> buf = StringIO()
>>> np.disp(u'"Display" in a file', device=buf)
>>> buf.getvalue()
'"Display" in a file\n'
Nz%s
z%s)sysstdoutwriteflush)mesgdevicelinefeeds rd rC rC sZ @ ~ " Vd]#### TD[!!!
LLNNN
Frf z\w+z(?:{0:}(?:,{0:})*)?z\({}\)z{0:}(?:,{0:})*z ^{0:}->{0:}$c t j dd| } t j t | s"t d | t
d | d D S )as
Parse string signatures for a generalized universal function.
Arguments
---------
signature : string
Generalized universal function signature, e.g., ``(m,n),(n,p)->(m,p)``
for ``np.matmul``.
Returns
-------
Tuple of input and output core dimensions parsed from the signature, each
of the form List[Tuple[str, ...]].
z\s+ z not a valid gufunc signature: {}c 3 ^ K | ](}d t j t | D V )dS )c \ g | ])}t t j t | *S rh )r refindall_DIMENSION_NAMEr args rd r z5_parse_gufunc_signature... s< > > >
?C8899 > > >rf N)r r _ARGUMENT)r arg_lists rd z*_parse_gufunc_signature.. sY 8 8 > > Z 8 < <> > > 8 8 8 8 8 8rf z->)r submatch
_SIGNATUREr r r split) signatures rd _parse_gufunc_signaturer s vr9--I
8J * * B . 5 5i @ @B B B 8 8!* !6!68 8 8 8 8 8rf c
( |sdS t | }|j |k rt d|j |fz |j | d }t || D ]9\ }}|| v r+|| | k r t d|d|d| | 4|| |< :dS )aO
Incrementally check and update core dimension sizes for a single argument.
Arguments
---------
dim_sizes : Dict[str, int]
Sizes of existing core dimensions. Will be updated in-place.
arg : ndarray
Argument to examine.
core_dims : Tuple[str, ...]
Core dimensions for this argument.
NzR%d-dimensional argument does not have enough dimensions for all core dimensions %rz%inconsistent size for core dimension z: z vs )r r r rv r ) dim_sizesr core_dims
num_core_dims
core_shapedimr s rd _update_dim_sizesr s NNM
x-
4x#
$% % %
M>??+JJ// " " T ) y~%% jssDDD)C..23 3 3 &
"IcNN" "rf c L g }i }t | | D ]t\ }}t ||| |j t | z
}t j j d|j d| }| | ut j j j
| }||fS )a
Parse broadcast and core dimensions for vectorize with a signature.
Arguments
---------
args : Tuple[ndarray, ...]
Tuple of input arguments to examine.
input_core_dims : List[Tuple[str, ...]]
List of core dimensions corresponding to each input.
Returns
-------
broadcast_shape : Tuple[int, ...]
Common shape to broadcast all non-core dimensions to.
dim_sizes : Dict[str, int]
Common sizes for named core dimensions.
r N) r r r r r lib
stride_tricks
as_stridedrv r[ _broadcast_shape) r input_core_dimsbroadcast_argsr r r r dummy_arraybroadcast_shapes rd _parse_input_dimensionsr s $ NI dO44 + +Y)S)444x#i..(f*55a5D59IJJ k****f*;^LO I %%rf c $ fd|D S )z=Helper for calculating broadcast shapes with core dimensions.c L g | ] }t fd |D z !S )c 3 ( K | ] }| V
d S r_ rh )r r r s rd r z/_calculate_shapes...1 s' #H#HsIcN#H#H#H#H#H#Hrf )r )r r r r s rd r z%_calculate_shapes..1 sK 0 0 0
e#H#H#H#Hi#H#H#H H H H 0 0 0rf rh )r r list_of_core_dimss `` rd _calculate_shapesr / s4 0 0 0 0 0 . 0 0 0 0rf c t | || }|dgt | z }|(t d t || D }n(t d t ||| D }|S )z/Helper for creating output arrays in vectorize.Nc 3 H K | ] \ }}t j || V dS )rv r N)r r
)r rv r s rd r z!_create_arrays..< sQ @ @'5% xe5999 @ @ @ @ @ @rf c 3 L K | ] \ }}}t j ||| V dS r )r r0 )r r rv r s rd r z!_create_arrays..? sM 8 8/65% }V5FFF 8 8 8 8 8 8rf )r r r r )r r r dtypesresultsshapesarrayss rd _create_arraysr 5 s ;L
M
MF
~#f++% @ @+.vv+>+>@ @ @ @ @ 8 8 gvv668 8 8 8 8 Mrf c T e Zd ZdZej dddddfdZd Zd Zd Z d Z
d Z d
Z dS ) rH a
vectorize(pyfunc=np._NoValue, otypes=None, doc=None, excluded=None,
cache=False, signature=None)
Returns an object that acts like pyfunc, but takes arrays as input.
Define a vectorized function which takes a nested sequence of objects or
numpy arrays as inputs and returns a single numpy array or a tuple of numpy
arrays. The vectorized function evaluates `pyfunc` over successive tuples
of the input arrays like the python map function, except it uses the
broadcasting rules of numpy.
The data type of the output of `vectorized` is determined by calling
the function with the first element of the input. This can be avoided
by specifying the `otypes` argument.
Parameters
----------
pyfunc : callable, optional
A python function or method.
Can be omitted to produce a decorator with keyword arguments.
otypes : str or list of dtypes, optional
The output data type. It must be specified as either a string of
typecode characters or a list of data type specifiers. There should
be one data type specifier for each output.
doc : str, optional
The docstring for the function. If None, the docstring will be the
``pyfunc.__doc__``.
excluded : set, optional
Set of strings or integers representing the positional or keyword
arguments for which the function will not be vectorized. These will be
passed directly to `pyfunc` unmodified.
.. versionadded:: 1.7.0
cache : bool, optional
If `True`, then cache the first function call that determines the number
of outputs if `otypes` is not provided.
.. versionadded:: 1.7.0
signature : string, optional
Generalized universal function signature, e.g., ``(m,n),(n)->(m)`` for
vectorized matrix-vector multiplication. If provided, ``pyfunc`` will
be called with (and expected to return) arrays with shapes given by the
size of corresponding core dimensions. By default, ``pyfunc`` is
assumed to take scalars as input and output.
.. versionadded:: 1.12.0
Returns
-------
out : callable
A vectorized function if ``pyfunc`` was provided,
a decorator otherwise.
See Also
--------
frompyfunc : Takes an arbitrary Python function and returns a ufunc
Notes
-----
The `vectorize` function is provided primarily for convenience, not for
performance. The implementation is essentially a for loop.
If `otypes` is not specified, then a call to the function with the
first argument will be used to determine the number of outputs. The
results of this call will be cached if `cache` is `True` to prevent
calling the function twice. However, to implement the cache, the
original function must be wrapped which will slow down subsequent
calls, so only do this if your function is expensive.
The new keyword argument interface and `excluded` argument support
further degrades performance.
References
----------
.. [1] :doc:`/reference/c-api/generalized-ufuncs`
Examples
--------
>>> def myfunc(a, b):
... "Return a-b if a>b, otherwise return a+b"
... if a > b:
... return a - b
... else:
... return a + b
>>> vfunc = np.vectorize(myfunc)
>>> vfunc([1, 2, 3, 4], 2)
array([3, 4, 1, 2])
The docstring is taken from the input function to `vectorize` unless it
is specified:
>>> vfunc.__doc__
'Return a-b if a>b, otherwise return a+b'
>>> vfunc = np.vectorize(myfunc, doc='Vectorized `myfunc`')
>>> vfunc.__doc__
'Vectorized `myfunc`'
The output type is determined by evaluating the first element of the input,
unless it is specified:
>>> out = vfunc([1, 2, 3, 4], 2)
>>> type(out[0])
>>> vfunc = np.vectorize(myfunc, otypes=[float])
>>> out = vfunc([1, 2, 3, 4], 2)
>>> type(out[0])
The `excluded` argument can be used to prevent vectorizing over certain
arguments. This can be useful for array-like arguments of a fixed length
such as the coefficients for a polynomial as in `polyval`:
>>> def mypolyval(p, x):
... _p = list(p)
... res = _p.pop(0)
... while _p:
... res = res*x + _p.pop(0)
... return res
>>> vpolyval = np.vectorize(mypolyval, excluded=['p'])
>>> vpolyval(p=[1, 2, 3], x=[0, 1])
array([3, 6])
Positional arguments may also be excluded by specifying their position:
>>> vpolyval.excluded.add(0)
>>> vpolyval([1, 2, 3], x=[0, 1])
array([3, 6])
The `signature` argument allows for vectorizing functions that act on
non-scalar arrays of fixed length. For example, you can use it for a
vectorized calculation of Pearson correlation coefficient and its p-value:
>>> import scipy.stats
>>> pearsonr = np.vectorize(scipy.stats.pearsonr,
... signature='(n),(n)->(),()')
>>> pearsonr([[0, 1, 2, 3]], [[1, 2, 3, 4], [4, 3, 2, 1]])
(array([ 1., -1.]), array([ 0., 0.]))
Or for a vectorized convolution:
>>> convolve = np.vectorize(np.convolve, signature='(n),(m)->(k)')
>>> convolve(np.eye(4), [1, 2, 1])
array([[1., 2., 1., 0., 0., 0.],
[0., 1., 2., 1., 0., 0.],
[0., 0., 1., 2., 1., 0.],
[0., 0., 0., 1., 2., 1.]])
Decorator syntax is supported. The decorator can be called as
a function to provide keyword arguments.
>>>@np.vectorize
...def identity(x):
... return x
...
>>>identity([0, 1, 2])
array([0, 1, 2])
>>>@np.vectorize(otypes=[float])
...def as_float(x):
... return x
...
>>>as_float([0, 1, 2])
array([0., 1., 2.])
NFc |t j k r%t | sd}d}t ||z || _ || _ || _ |t j k r t |d r |j | _ i | _ d | _
|| _ | t |d r
|j | _ n|| _
t |t r'|D ]#} | t d vrt d| $n@t! | r d d |D }n|t d || _ |t' }t' | | _ |t+ | | _ d S d | _ d S )
NzWhen used as a decorator, z only accepts keyword arguments.__name____doc__AllzInvalid otype specified: r c @ g | ]}t j | j S rh )r r r r r s rd r z&vectorize.__init__..
s# @ @ @Acill / @ @ @rf zInvalid otype specification)r r callabler pyfunccacher r r _ufunc_docr r strr( r r< joinotypessetexcludedr _in_and_out_core_dims)
selfr r docr r r part1part2r s
rd __init__zvectorize.__init__ s
bk ! !HV,<,< ! 1E5EEEM** *
" R[ WVZ%@%@ "ODM ;76955;!>DLLDI fc " " <
N
Ny ///$*dd%LMMM 0
N f
<WW @ @ @ @ @AAFF
:;; ; uuHH
)@)K)KD & & &)-D & & &rf c n |j | _ || _ | j |j | _ d S | j | _ d S r_ )r r r r )r r r kwargss rd
_init_stage_2zvectorize._init_stage_2 s4
9 !>DLLL 9DLLLrf c f j s s
j }}nt }fdD fdt | D t fd}fdD }| fdD || S )z
Return arrays with the results of `pyfunc` broadcast (vectorized) over
`args` and `kwargs` not in `excluded`.
c g | ]}|v| S rh rh )r _nr s rd r z-vectorize._call_as_normal..0 s# ???BBh,>,>R,>,>,>rf c g | ]}|v| S rh rh )r _ir s rd r z-vectorize._call_as_normal..1 s# DDD281C1CB1C1C1Crf c t D ]\ }}| | |< t | t d j i S r_ )r updater r r )vargsr r indsr namesr the_argss rd r z'vectorize._call_as_normal..func4 sm 'oo - -FB#(9HRLL
c%s4yyzz): ; ;<<<"t{H7777rf c g | ]
}| S rh rh )r r r s rd r z-vectorize._call_as_normal..: s ---"T"X---rf c g | ]
}| S rh rh )r r r s rd r z-vectorize._call_as_normal..; s 555&*555rf r r )r r r r& r extend_vectorize_call)
r r r r r nargsr r r r s
``` @@@@rd _call_as_normalzvectorize._call_as_normal! s
= 7h 7;DEE
IIE????&???EDDDDu DDDDDzzH
8
8
8
8
8
8
8
8
8 .------E LL5555u555 6 6 6##E#:::rf c ` | j t j u r | j |i | | S | j |i |S r_ )r r r r r )r r r s rd __call__zvectorize.__call__? sF ;"+ % % D / / / /K#t#T4V444rf c
|st d | j u| j }t | }t | j }| j us || j vrt || }nd}| j u r| j || }nd |D }t j d |D rt d d |D } |
| j r
g fd}n}t
t rt
}nd}
f
d
fd
t | D }t |t | | }||fS ) zReturn (ufunc, otypes).zargs can not be emptyNc , g | ]}t | S rh )r r s rd r z3vectorize._get_ufunc_and_otypes..d s 111SGCLL111rf c 3 , K | ]}|j d k V dS r N)r r s rd r z2vectorize._get_ufunc_and_otypes..e s( ::cCHM::::::rf ?cannot call `vectorize` on size 0 inputs unless `otypes` is setc ( g | ]}|j d S r )flatr s rd r z3vectorize._get_ufunc_and_otypes..i s 222cchqk222rf c : r S | S r_ )pop)r _cacher s rd _funcz.vectorize._get_ufunc_and_otypes.._funcs s% , %zz||+ #tU|+rf rq r c N g | ]!}t | j j "S rh )r r r )r _koutputss rd r z3vectorize._get_ufunc_and_otypes.. s; 5 5 5"$ &gbk 2 2 8 = 5 5 5rf )r r r r r r
setdefaultbuiltinsr& r r r r r& ) r r r r ninnoutufuncinputsr
r r s ` @@rd _get_ufunc_and_otypesz vectorize._get_ufunc_and_otypesF s 6 455 5 ; "[F d))Ct{##D4;&&#T[*@*@"4d33 t{"" ..sE:: 21D111D|::T:::::
; ": ; ; ; 32T222FdFmG z
!, , , , , , , '5))
%7||"*WW 5 5 5 5(-d 5 5 5 6 6F uc$ii66Ef} rf c F | j | || }n|s | }nu| || \ }}d |D } || }|j dk rt ||d }n't d t
|| D }|S )z1Vectorized call to `func` over positional `args`.Nr c : g | ]}t |t S r )r object)r r s rd r z-vectorize._vectorize_call.. s% @@@aj&111@@@rf rq r r c 6 g | ]\ }}t || S r r )r r ts rd r z-vectorize._vectorize_call.. s9 ? ? ?!%A ( 3 3 3 ? ? ?rf )r _vectorize_call_with_signaturer r r r r )r r r resr r r r s rd r zvectorize._vectorize_call s > %55dDAACC @$&&CC 6 6Dt 6 L LME6 A@4@@@FeVnGzQ q ::: ? ?),Wf)=)= ? ? ? @ @
rf c | j \ }}t | t | k r/t dt | dt | t d |D }t || \ }t || }d t
|| D }d}| j }t | } t j | D ] |fd|D }
t |
t rt |
nd} | | k rt d| d| | dk r|
f}
|:t
|
| D ]\ } }
t | |
t ||||
}t
||
D ]
\ }} | |< |R|t d t j fd
|D rt d t ||| }| dk r|d n|S )
z;Vectorized call over positional arguments with a signature.z/wrong number of positional arguments: expected z, got c 3 4 K | ]}t | V d S r_ r r s rd r z;vectorize._vectorize_call_with_signature.. s( 55Z__555555rf c B g | ] \ }}t j ||d S )T)r )r r )r r rv s rd r z. s= ; ; ; C U$777 ; ; ;rf Nc 3 ( K | ] }| V
d S r_ rh )r r r s rd r z;vectorize._vectorize_call_with_signature.. s' 8 8CSZ 8 8 8 8 8 8rf rq z.wrong number of outputs from pyfunc: expected r c 3 * K | ]
}|D ]}|vV d S r_ rh )r dimsr r s rd r z;vectorize._vectorize_call_with_signature.. sQ - - $'+ - - # y 0 - - - - - - -rf zYcannot call `vectorize` with a signature including new output dimensions on size 0 inputsr )r r r r r r r r r ndindexr r r r r r& )r r r r output_core_dimsr input_shapesr r r r n_resultsr r outputr r s @@rd r z(vectorize._vectorize_call_with_signature s ,0,F)) t99O,, , ,) "? 3 3 3 3SYYY @ A A
A 5555555%< /&# &#"( ))8: : ; ;"%dL"9"9; ; ; #$$Z 1 ' 'Ed 8 8 8 84 8 8 89G(27E(B(BIG Iy jttYY() ) ) qyy"*),W6F)G)G D D%FI%iCCCC( ))967L L #&gw"7"7
'
' &u
' ?~ ": ; ; ;| - - - -(8 - - - - -
+ ! "* + + + %_i%5v? ?G "QYYwqzzG3rf )
r
__module__ __qualname__r r r r r r r r r r rh rf rd rH rH E s e eL !k$D et*. *. *. *.X% % % ; ; ;<5 5 5C C C J *:4 :4 :4 :4 :4rf rH r c | |||fS r_ rh )r r rowvarbiasddoffweightsaweightsr s rd _cov_dispatcherr4 s
q(H %%rf c |"|t | k rt d t j | } | j dk rt d |.t j | }|j dk rt d |B| t j | t j }n t j | |t j }t | d| }|s|j d dk r|j }|j d dk r(t j g
dd S |Et |d d|
}|s|j d dk r|j }t j ||fd }| |dk rd}nd}d} |t j |t }t j
|t j | k st d
|j dk rt! d |j d |j d k rt! d t# |dk rt d |} |t j |t }|j dk rt! d |j d |j d k rt! d t# |dk rt d | |} n| |z } t% |d| d \ }
} | d } | |j d |z
} n,|dk r| } n#|| |z
} n| |t' | |z z | z z
} | dk r t) j dt, d d} ||
dddf z }| |j }
n
|| z j }
t/ ||
}|t j d| z }| S )a'
Estimate a covariance matrix, given data and weights.
Covariance indicates the level to which two variables vary together.
If we examine N-dimensional samples, :math:`X = [x_1, x_2, ... x_N]^T`,
then the covariance matrix element :math:`C_{ij}` is the covariance of
:math:`x_i` and :math:`x_j`. The element :math:`C_{ii}` is the variance
of :math:`x_i`.
See the notes for an outline of the algorithm.
Parameters
----------
m : array_like
A 1-D or 2-D array containing multiple variables and observations.
Each row of `m` represents a variable, and each column a single
observation of all those variables. Also see `rowvar` below.
y : array_like, optional
An additional set of variables and observations. `y` has the same form
as that of `m`.
rowvar : bool, optional
If `rowvar` is True (default), then each row represents a
variable, with observations in the columns. Otherwise, the relationship
is transposed: each column represents a variable, while the rows
contain observations.
bias : bool, optional
Default normalization (False) is by ``(N - 1)``, where ``N`` is the
number of observations given (unbiased estimate). If `bias` is True,
then normalization is by ``N``. These values can be overridden by using
the keyword ``ddof`` in numpy versions >= 1.5.
ddof : int, optional
If not ``None`` the default value implied by `bias` is overridden.
Note that ``ddof=1`` will return the unbiased estimate, even if both
`fweights` and `aweights` are specified, and ``ddof=0`` will return
the simple average. See the notes for the details. The default value
is ``None``.
.. versionadded:: 1.5
fweights : array_like, int, optional
1-D array of integer frequency weights; the number of times each
observation vector should be repeated.
.. versionadded:: 1.10
aweights : array_like, optional
1-D array of observation vector weights. These relative weights are
typically large for observations considered "important" and smaller for
observations considered less "important". If ``ddof=0`` the array of
weights can be used to assign probabilities to observation vectors.
.. versionadded:: 1.10
dtype : data-type, optional
Data-type of the result. By default, the return data-type will have
at least `numpy.float64` precision.
.. versionadded:: 1.20
Returns
-------
out : ndarray
The covariance matrix of the variables.
See Also
--------
corrcoef : Normalized covariance matrix
Notes
-----
Assume that the observations are in the columns of the observation
array `m` and let ``f = fweights`` and ``a = aweights`` for brevity. The
steps to compute the weighted covariance are as follows::
>>> m = np.arange(10, dtype=np.float64)
>>> f = np.arange(10) * 2
>>> a = np.arange(10) ** 2.
>>> ddof = 1
>>> w = f * a
>>> v1 = np.sum(w)
>>> v2 = np.sum(w * a)
>>> m -= np.sum(m * w, axis=None, keepdims=True) / v1
>>> cov = np.dot(m * w, m.T) * v1 / (v1**2 - ddof * v2)
Note that when ``a == 1``, the normalization factor
``v1 / (v1**2 - ddof * v2)`` goes over to ``1 / (np.sum(f) - ddof)``
as it should.
Examples
--------
Consider two variables, :math:`x_0` and :math:`x_1`, which
correlate perfectly, but in opposite directions:
>>> x = np.array([[0, 2], [1, 1], [2, 0]]).T
>>> x
array([[0, 1, 2],
[2, 1, 0]])
Note how :math:`x_0` increases while :math:`x_1` decreases. The covariance
matrix shows this clearly:
>>> np.cov(x)
array([[ 1., -1.],
[-1., 1.]])
Note that element :math:`C_{0,1}`, which shows the correlation between
:math:`x_0` and :math:`x_1`, is negative.
Further, note how `x` and `y` are combined:
>>> x = [-2.1, -1, 4.3]
>>> y = [3, 1.1, 0.12]
>>> X = np.stack((x, y), axis=0)
>>> np.cov(X)
array([[11.71 , -4.286 ], # may vary
[-4.286 , 2.144133]])
>>> np.cov(x, y)
array([[11.71 , -4.286 ], # may vary
[-4.286 , 2.144133]])
>>> np.cov(x)
array(11.71)
Nzddof must be integerr z m has more than 2 dimensionsz y has more than 2 dimensions)ndminr r rq Fr; r6 r r r zfweights must be integerz'cannot handle multidimensional fweightsz,incompatible numbers of samples and fweightszfweights cannot be negativez'cannot handle multidimensional aweightsz,incompatible numbers of samples and aweightszaweights cannot be negativeT)r r r z!Degrees of freedom <= 0 for slice
stacklevelr )r1 r r r r r r( r
rv Treshaper floatr r r RuntimeErrorr& rJ r' warningswarnRuntimeWarningr conj true_dividesqueeze)r r r/ r0 r1 r2 r3 r Xwr w_sumfactX_TrD s rd rL rL s x DCII - - "$ $ $
1
Avzz7888} JqMM 6A:: ;<< < } 9N1bj11EEN1a44E
aq&&&A agajAoo
CwqzQx||##Aq)))} !%q 6 6 6 !'!*//A NAq6 * * * | 199DDD
A:he444vh")H"5"5566 ,*, ,
, =1 9; ;
; >!
* * >@ @
@ x!| / -/ /
/ :he444 =1 9; ;
; >!
* * >@ @
@ x!| / -/ /
/ 9AA
MAA===JC !HE ywqzD
t|tC(
OO+E11 qyy
9$ 4 4 4 4QQQW Aycsg AsxxzzA 4 A 99;;rf c
| |fS r_ rh )r r r/ r0 r1 r s rd _corrcoef_dispatcherrJ
s
q6Mrf c |t j us|t j ur t j dt d t | ||| } t
| }n# t $ r ||z cY S w xY wt |j }||dddf z }||dddf z }t j
|j dd|j t j | r"t j
|j dd|j |S ) ai
Return Pearson product-moment correlation coefficients.
Please refer to the documentation for `cov` for more detail. The
relationship between the correlation coefficient matrix, `R`, and the
covariance matrix, `C`, is
.. math:: R_{ij} = \frac{ C_{ij} } { \sqrt{ C_{ii} C_{jj} } }
The values of `R` are between -1 and 1, inclusive.
Parameters
----------
x : array_like
A 1-D or 2-D array containing multiple variables and observations.
Each row of `x` represents a variable, and each column a single
observation of all those variables. Also see `rowvar` below.
y : array_like, optional
An additional set of variables and observations. `y` has the same
shape as `x`.
rowvar : bool, optional
If `rowvar` is True (default), then each row represents a
variable, with observations in the columns. Otherwise, the relationship
is transposed: each column represents a variable, while the rows
contain observations.
bias : _NoValue, optional
Has no effect, do not use.
.. deprecated:: 1.10.0
ddof : _NoValue, optional
Has no effect, do not use.
.. deprecated:: 1.10.0
dtype : data-type, optional
Data-type of the result. By default, the return data-type will have
at least `numpy.float64` precision.
.. versionadded:: 1.20
Returns
-------
R : ndarray
The correlation coefficient matrix of the variables.
See Also
--------
cov : Covariance matrix
Notes
-----
Due to floating point rounding the resulting array may not be Hermitian,
the diagonal elements may not be 1, and the elements may not satisfy the
inequality abs(a) <= 1. The real and imaginary parts are clipped to the
interval [-1, 1] in an attempt to improve on that situation but is not
much help in the complex case.
This function accepts but discards arguments `bias` and `ddof`. This is
for backwards compatibility with previous versions of this function. These
arguments had no effect on the return values of the function and can be
safely ignored in this and previous versions of numpy.
Examples
--------
In this example we generate two random arrays, ``xarr`` and ``yarr``, and
compute the row-wise and column-wise Pearson correlation coefficients,
``R``. Since ``rowvar`` is true by default, we first find the row-wise
Pearson correlation coefficients between the variables of ``xarr``.
>>> import numpy as np
>>> rng = np.random.default_rng(seed=42)
>>> xarr = rng.random((3, 3))
>>> xarr
array([[0.77395605, 0.43887844, 0.85859792],
[0.69736803, 0.09417735, 0.97562235],
[0.7611397 , 0.78606431, 0.12811363]])
>>> R1 = np.corrcoef(xarr)
>>> R1
array([[ 1. , 0.99256089, -0.68080986],
[ 0.99256089, 1. , -0.76492172],
[-0.68080986, -0.76492172, 1. ]])
If we add another set of variables and observations ``yarr``, we can
compute the row-wise Pearson correlation coefficients between the
variables in ``xarr`` and ``yarr``.
>>> yarr = rng.random((3, 3))
>>> yarr
array([[0.45038594, 0.37079802, 0.92676499],
[0.64386512, 0.82276161, 0.4434142 ],
[0.22723872, 0.55458479, 0.06381726]])
>>> R2 = np.corrcoef(xarr, yarr)
>>> R2
array([[ 1. , 0.99256089, -0.68080986, 0.75008178, -0.934284 ,
-0.99004057],
[ 0.99256089, 1. , -0.76492172, 0.82502011, -0.97074098,
-0.99981569],
[-0.68080986, -0.76492172, 1. , -0.99507202, 0.89721355,
0.77714685],
[ 0.75008178, 0.82502011, -0.99507202, 1. , -0.93657855,
-0.83571711],
[-0.934284 , -0.97074098, 0.89721355, -0.93657855, 1. ,
0.97517215],
[-0.99004057, -0.99981569, 0.77714685, -0.83571711, 0.97517215,
1. ]])
Finally if we use the option ``rowvar=False``, the columns are now
being treated as the variables and we will find the column-wise Pearson
correlation coefficients between variables in ``xarr`` and ``yarr``.
>>> R3 = np.corrcoef(xarr, yarr, rowvar=False)
>>> R3
array([[ 1. , 0.77598074, -0.47458546, -0.75078643, -0.9665554 ,
0.22423734],
[ 0.77598074, 1. , -0.92346708, -0.99923895, -0.58826587,
-0.44069024],
[-0.47458546, -0.92346708, 1. , 0.93773029, 0.23297648,
0.75137473],
[-0.75078643, -0.99923895, 0.93773029, 1. , 0.55627469,
0.47536961],
[-0.9665554 , -0.58826587, 0.23297648, 0.55627469, 1. ,
-0.46666491],
[ 0.22423734, -0.44069024, 0.75137473, 0.47536961, -0.46666491,
1. ]])
z/bias and ddof have no effect and are deprecatedr r8 r Nr rq r? )
r r r> r? DeprecationWarningrL r+ r r rh cliprW rg ) r r r/ r0 r1 r rD dstddevs rd rM rM
s @ 2; $bk"9"9
G(Q 8 8 8 8 Aq&&&&A GG 1u !&\\F4 Aaaa A
GAFBqv&&&& q +
A16**** Hs
A A/.A/c d t j d| g }|d } | dk rt g |j S | dk rt d|j S t d| z
| d }ddt t |z | dz
z z z dt dt z |z | dz
z z z S ) a
Return the Blackman window.
The Blackman window is a taper formed by using the first three
terms of a summation of cosines. It was designed to have close to the
minimal leakage possible. It is close to optimal, only slightly worse
than a Kaiser window.
Parameters
----------
M : int
Number of points in the output window. If zero or less, an empty
array is returned.
Returns
-------
out : ndarray
The window, with the maximum value normalized to one (the value one
appears only if the number of samples is odd).
See Also
--------
bartlett, hamming, hanning, kaiser
Notes
-----
The Blackman window is defined as
.. math:: w(n) = 0.42 - 0.5 \cos(2\pi n/M) + 0.08 \cos(4\pi n/M)
Most references to the Blackman window come from the signal processing
literature, where it is used as one of many windowing functions for
smoothing values. It is also known as an apodization (which means
"removing the foot", i.e. smoothing discontinuities at the beginning
and end of the sampled signal) or tapering function. It is known as a
"near optimal" tapering function, almost as good (by some measures)
as the kaiser window.
References
----------
Blackman, R.B. and Tukey, J.W., (1958) The measurement of power spectra,
Dover Publications, New York.
Oppenheim, A.V., and R.W. Schafer. Discrete-Time Signal Processing.
Upper Saddle River, NJ: Prentice-Hall, 1999, pp. 468-471.
Examples
--------
>>> import matplotlib.pyplot as plt
>>> np.blackman(12)
array([-1.38777878e-17, 3.26064346e-02, 1.59903635e-01, # may vary
4.14397981e-01, 7.36045180e-01, 9.67046769e-01,
9.67046769e-01, 7.36045180e-01, 4.14397981e-01,
1.59903635e-01, 3.26064346e-02, -1.38777878e-17])
Plot the window and the frequency response:
>>> from numpy.fft import fft, fftshift
>>> window = np.blackman(51)
>>> plt.plot(window)
[]
>>> plt.title("Blackman window")
Text(0.5, 1.0, 'Blackman window')
>>> plt.ylabel("Amplitude")
Text(0, 0.5, 'Amplitude')
>>> plt.xlabel("Sample")
Text(0.5, 0, 'Sample')
>>> plt.show()
>>> plt.figure()
>>> A = fft(window, 2048) / 25.5
>>> mag = np.abs(fftshift(A))
>>> freq = np.linspace(-0.5, 0.5, len(A))
>>> with np.errstate(divide='ignore', invalid='ignore'):
... response = 20 * np.log10(mag)
...
>>> response = np.clip(response, -100, 100)
>>> plt.plot(freq, response)
[]
>>> plt.title("Frequency response of Blackman window")
Text(0.5, 1.0, 'Frequency response of Blackman window')
>>> plt.ylabel("Magnitude [dB]")
Text(0, 0.5, 'Magnitude [dB]')
>>> plt.xlabel("Normalized frequency [cycles per sample]")
Text(0.5, 0, 'Normalized frequency [cycles per sample]')
>>> _ = plt.axis('tight')
>>> plt.show()
r rq r r gzG?rt g{Gz?r$ r r
r r r r r Mvaluesrb s rd rT rT ^ s | XsAh
Fq A1uuRv|,,,,AvvAV\****qsAqA #c"Q$!*oo% %SR1Q3 -@-@(@ @@rf c 8 t j d| g }|d } | dk rt g |j S | dk rt d|j S t d| z
| d }t t
|d d|| dz
z z d|| dz
z z
S )a6
Return the Bartlett window.
The Bartlett window is very similar to a triangular window, except
that the end points are at zero. It is often used in signal
processing for tapering a signal, without generating too much
ripple in the frequency domain.
Parameters
----------
M : int
Number of points in the output window. If zero or less, an
empty array is returned.
Returns
-------
out : array
The triangular window, with the maximum value normalized to one
(the value one appears only if the number of samples is odd), with
the first and last samples equal to zero.
See Also
--------
blackman, hamming, hanning, kaiser
Notes
-----
The Bartlett window is defined as
.. math:: w(n) = \frac{2}{M-1} \left(
\frac{M-1}{2} - \left|n - \frac{M-1}{2}\right|
\right)
Most references to the Bartlett window come from the signal processing
literature, where it is used as one of many windowing functions for
smoothing values. Note that convolution with this window produces linear
interpolation. It is also known as an apodization (which means "removing
the foot", i.e. smoothing discontinuities at the beginning and end of the
sampled signal) or tapering function. The Fourier transform of the
Bartlett window is the product of two sinc functions. Note the excellent
discussion in Kanasewich [2]_.
References
----------
.. [1] M.S. Bartlett, "Periodogram Analysis and Continuous Spectra",
Biometrika 37, 1-16, 1950.
.. [2] E.R. Kanasewich, "Time Sequence Analysis in Geophysics",
The University of Alberta Press, 1975, pp. 109-110.
.. [3] A.V. Oppenheim and R.W. Schafer, "Discrete-Time Signal
Processing", Prentice-Hall, 1999, pp. 468-471.
.. [4] Wikipedia, "Window function",
https://en.wikipedia.org/wiki/Window_function
.. [5] W.H. Press, B.P. Flannery, S.A. Teukolsky, and W.T. Vetterling,
"Numerical Recipes", Cambridge University Press, 1986, page 429.
Examples
--------
>>> import matplotlib.pyplot as plt
>>> np.bartlett(12)
array([ 0. , 0.18181818, 0.36363636, 0.54545455, 0.72727273, # may vary
0.90909091, 0.90909091, 0.72727273, 0.54545455, 0.36363636,
0.18181818, 0. ])
Plot the window and its frequency response (requires SciPy and matplotlib):
>>> from numpy.fft import fft, fftshift
>>> window = np.bartlett(51)
>>> plt.plot(window)
[]
>>> plt.title("Bartlett window")
Text(0.5, 1.0, 'Bartlett window')
>>> plt.ylabel("Amplitude")
Text(0, 0.5, 'Amplitude')
>>> plt.xlabel("Sample")
Text(0.5, 0, 'Sample')
>>> plt.show()
>>> plt.figure()
>>> A = fft(window, 2048) / 25.5
>>> mag = np.abs(fftshift(A))
>>> freq = np.linspace(-0.5, 0.5, len(A))
>>> with np.errstate(divide='ignore', invalid='ignore'):
... response = 20 * np.log10(mag)
...
>>> response = np.clip(response, -100, 100)
>>> plt.plot(freq, response)
[]
>>> plt.title("Frequency response of Bartlett window")
Text(0.5, 1.0, 'Frequency response of Bartlett window')
>>> plt.ylabel("Magnitude [dB]")
Text(0, 0.5, 'Magnitude [dB]')
>>> plt.xlabel("Normalized frequency [cycles per sample]")
Text(0.5, 0, 'Normalized frequency [cycles per sample]')
>>> _ = plt.axis('tight')
>>> plt.show()
r rq r r r )r r
r r r r r rS s rd rS rS s L XsAh
Fq A1uuRv|,,,,AvvAV\****qsAqA Aq!!1q!A#w;AqsG < <>> np.hanning(12)
array([0. , 0.07937323, 0.29229249, 0.57115742, 0.82743037,
0.97974649, 0.97974649, 0.82743037, 0.57115742, 0.29229249,
0.07937323, 0. ])
Plot the window and its frequency response:
>>> import matplotlib.pyplot as plt
>>> from numpy.fft import fft, fftshift
>>> window = np.hanning(51)
>>> plt.plot(window)
[]
>>> plt.title("Hann window")
Text(0.5, 1.0, 'Hann window')
>>> plt.ylabel("Amplitude")
Text(0, 0.5, 'Amplitude')
>>> plt.xlabel("Sample")
Text(0.5, 0, 'Sample')
>>> plt.show()
>>> plt.figure()
>>> A = fft(window, 2048) / 25.5
>>> mag = np.abs(fftshift(A))
>>> freq = np.linspace(-0.5, 0.5, len(A))
>>> with np.errstate(divide='ignore', invalid='ignore'):
... response = 20 * np.log10(mag)
...
>>> response = np.clip(response, -100, 100)
>>> plt.plot(freq, response)
[]
>>> plt.title("Frequency response of the Hann window")
Text(0.5, 1.0, 'Frequency response of the Hann window')
>>> plt.ylabel("Magnitude [dB]")
Text(0, 0.5, 'Magnitude [dB]')
>>> plt.xlabel("Normalized frequency [cycles per sample]")
Text(0.5, 0, 'Normalized frequency [cycles per sample]')
>>> plt.axis('tight')
...
>>> plt.show()
r rq r r rt rR rS s rd rR rR 8 s D XsAh
Fq A1uuRv|,,,,AvvAV\****qsAqA SAqs__$ $$rf c t j d| g }|d } | dk rt g |j S | dk rt d|j S t d| z
| d }ddt t |z | dz
z z z S )a_
Return the Hamming window.
The Hamming window is a taper formed by using a weighted cosine.
Parameters
----------
M : int
Number of points in the output window. If zero or less, an
empty array is returned.
Returns
-------
out : ndarray
The window, with the maximum value normalized to one (the value
one appears only if the number of samples is odd).
See Also
--------
bartlett, blackman, hanning, kaiser
Notes
-----
The Hamming window is defined as
.. math:: w(n) = 0.54 - 0.46\cos\left(\frac{2\pi{n}}{M-1}\right)
\qquad 0 \leq n \leq M-1
The Hamming was named for R. W. Hamming, an associate of J. W. Tukey
and is described in Blackman and Tukey. It was recommended for
smoothing the truncated autocovariance function in the time domain.
Most references to the Hamming window come from the signal processing
literature, where it is used as one of many windowing functions for
smoothing values. It is also known as an apodization (which means
"removing the foot", i.e. smoothing discontinuities at the beginning
and end of the sampled signal) or tapering function.
References
----------
.. [1] Blackman, R.B. and Tukey, J.W., (1958) The measurement of power
spectra, Dover Publications, New York.
.. [2] E.R. Kanasewich, "Time Sequence Analysis in Geophysics", The
University of Alberta Press, 1975, pp. 109-110.
.. [3] Wikipedia, "Window function",
https://en.wikipedia.org/wiki/Window_function
.. [4] W.H. Press, B.P. Flannery, S.A. Teukolsky, and W.T. Vetterling,
"Numerical Recipes", Cambridge University Press, 1986, page 425.
Examples
--------
>>> np.hamming(12)
array([ 0.08 , 0.15302337, 0.34890909, 0.60546483, 0.84123594, # may vary
0.98136677, 0.98136677, 0.84123594, 0.60546483, 0.34890909,
0.15302337, 0.08 ])
Plot the window and the frequency response:
>>> import matplotlib.pyplot as plt
>>> from numpy.fft import fft, fftshift
>>> window = np.hamming(51)
>>> plt.plot(window)
[]
>>> plt.title("Hamming window")
Text(0.5, 1.0, 'Hamming window')
>>> plt.ylabel("Amplitude")
Text(0, 0.5, 'Amplitude')
>>> plt.xlabel("Sample")
Text(0.5, 0, 'Sample')
>>> plt.show()
>>> plt.figure()
>>> A = fft(window, 2048) / 25.5
>>> mag = np.abs(fftshift(A))
>>> freq = np.linspace(-0.5, 0.5, len(A))
>>> response = 20 * np.log10(mag)
>>> response = np.clip(response, -100, 100)
>>> plt.plot(freq, response)
[]
>>> plt.title("Frequency response of Hamming window")
Text(0.5, 1.0, 'Frequency response of Hamming window')
>>> plt.ylabel("Magnitude [dB]")
Text(0, 0.5, 'Magnitude [dB]')
>>> plt.xlabel("Normalized frequency [cycles per sample]")
Text(0.5, 0, 'Normalized frequency [cycles per sample]')
>>> plt.axis('tight')
...
>>> plt.show()
r rq r r gHzG?gq=
ףp?rR rS s rd rQ rQ s | XsAh
Fq A1uuRv|,,,,AvvAV\****qsAqA $s2a41:& &&rf ) g4!\Tg}b3g0 Kg5dMv;p>g"c쑾g$>g'doҾgY(X?>gZ Y&+g|t(?gR BguZ?gI ^qga?g!Ng-Ί>?g-4pKgw?gWӿg*5N?)gT`g0fFVg!g["d,->gmրVX>gna>g+A>gRx?gI墌k?g b?c |d }d}t dt | D ]}|}|}| |z |z
|| z }d||z
z S )Nr r rq rt )r& r )r r b0b1r b2s rd _chbevlr] N
s_
aB B
1c$ii
! !
rTBYa
R=rf c X t | t | dz dz
t z S )Nr$ r )r r] _i0Ar s rd _i0_1ra Z
s% q66GAcE!GT** **rf c x t | t d| z dz
t z t | z S )Ng @@r$ )r r] _i0Br r` s rd _i0_2rd ^
s0 q66GDFSL$// /$q'' 99rf c | fS r_ rh r` s rd _i0_dispatcherrf b
r rf c ( t j | } | j j dk rt d | j j dk r| t } t j | } t | | dk gt t g S )a
Modified Bessel function of the first kind, order 0.
Usually denoted :math:`I_0`.
Parameters
----------
x : array_like of float
Argument of the Bessel function.
Returns
-------
out : ndarray, shape = x.shape, dtype = float
The modified Bessel function evaluated at each of the elements of `x`.
See Also
--------
scipy.special.i0, scipy.special.iv, scipy.special.ive
Notes
-----
The scipy implementation is recommended over this function: it is a
proper ufunc written in C, and more than an order of magnitude faster.
We use the algorithm published by Clenshaw [1]_ and referenced by
Abramowitz and Stegun [2]_, for which the function domain is
partitioned into the two intervals [0,8] and (8,inf), and Chebyshev
polynomial expansions are employed in each interval. Relative error on
the domain [0,30] using IEEE arithmetic is documented [3]_ as having a
peak of 5.8e-16 with an rms of 1.4e-16 (n = 30000).
References
----------
.. [1] C. W. Clenshaw, "Chebyshev series for mathematical functions", in
*National Physical Laboratory Mathematical Tables*, vol. 5, London:
Her Majesty's Stationery Office, 1962.
.. [2] M. Abramowitz and I. A. Stegun, *Handbook of Mathematical
Functions*, 10th printing, New York: Dover, 1964, pp. 379.
https://personal.math.ubc.ca/~cbm/aands/page_379.htm
.. [3] https://metacpan.org/pod/distribution/Math-Cephes/lib/Math/Cephes.pod#i0:-Modified-Bessel-function-of-order-zero
Examples
--------
>>> np.i0(0.)
array(1.0)
>>> np.i0([0, 1, 2, 3])
array([1. , 1.26606588, 2.2795853 , 4.88079259])
rD z#i0 not supported for complex valuesr g @) r r r kindr r r< r[ r9 ra rd r` s rd rW rW f
sy f
aAw|s=>>>w|s
HHUOO
q A Qc
UEN 3 33rf c 8 t j d| |g }|d } |d }| dk rt j d|j S t d| }| dz
dz }t |t
d||z
|z dz z
z t | z S )a
Return the Kaiser window.
The Kaiser window is a taper formed by using a Bessel function.
Parameters
----------
M : int
Number of points in the output window. If zero or less, an
empty array is returned.
beta : float
Shape parameter for window.
Returns
-------
out : array
The window, with the maximum value normalized to one (the value
one appears only if the number of samples is odd).
See Also
--------
bartlett, blackman, hamming, hanning
Notes
-----
The Kaiser window is defined as
.. math:: w(n) = I_0\left( \beta \sqrt{1-\frac{4n^2}{(M-1)^2}}
\right)/I_0(\beta)
with
.. math:: \quad -\frac{M-1}{2} \leq n \leq \frac{M-1}{2},
where :math:`I_0` is the modified zeroth-order Bessel function.
The Kaiser was named for Jim Kaiser, who discovered a simple
approximation to the DPSS window based on Bessel functions. The Kaiser
window is a very good approximation to the Digital Prolate Spheroidal
Sequence, or Slepian window, which is the transform which maximizes the
energy in the main lobe of the window relative to total energy.
The Kaiser can approximate many other windows by varying the beta
parameter.
==== =======================
beta Window shape
==== =======================
0 Rectangular
5 Similar to a Hamming
6 Similar to a Hanning
8.6 Similar to a Blackman
==== =======================
A beta value of 14 is probably a good starting point. Note that as beta
gets large, the window narrows, and so the number of samples needs to be
large enough to sample the increasingly narrow spike, otherwise NaNs will
get returned.
Most references to the Kaiser window come from the signal processing
literature, where it is used as one of many windowing functions for
smoothing values. It is also known as an apodization (which means
"removing the foot", i.e. smoothing discontinuities at the beginning
and end of the sampled signal) or tapering function.
References
----------
.. [1] J. F. Kaiser, "Digital Filters" - Ch 7 in "Systems analysis by
digital computer", Editors: F.F. Kuo and J.F. Kaiser, p 218-285.
John Wiley and Sons, New York, (1966).
.. [2] E.R. Kanasewich, "Time Sequence Analysis in Geophysics", The
University of Alberta Press, 1975, pp. 177-178.
.. [3] Wikipedia, "Window function",
https://en.wikipedia.org/wiki/Window_function
Examples
--------
>>> import matplotlib.pyplot as plt
>>> np.kaiser(12, 14)
array([7.72686684e-06, 3.46009194e-03, 4.65200189e-02, # may vary
2.29737120e-01, 5.99885316e-01, 9.45674898e-01,
9.45674898e-01, 5.99885316e-01, 2.29737120e-01,
4.65200189e-02, 3.46009194e-03, 7.72686684e-06])
Plot the window and the frequency response:
>>> from numpy.fft import fft, fftshift
>>> window = np.kaiser(51, 14)
>>> plt.plot(window)
[]
>>> plt.title("Kaiser window")
Text(0.5, 1.0, 'Kaiser window')
>>> plt.ylabel("Amplitude")
Text(0, 0.5, 'Amplitude')
>>> plt.xlabel("Sample")
Text(0.5, 0, 'Sample')
>>> plt.show()
>>> plt.figure()
>>> A = fft(window, 2048) / 25.5
>>> mag = np.abs(fftshift(A))
>>> freq = np.linspace(-0.5, 0.5, len(A))
>>> response = 20 * np.log10(mag)
>>> response = np.clip(response, -100, 100)
>>> plt.plot(freq, response)
[]
>>> plt.title("Frequency response of Kaiser window")
Text(0.5, 1.0, 'Frequency response of Kaiser window')
>>> plt.ylabel("Magnitude [dB]")
Text(0, 0.5, 'Magnitude [dB]')
>>> plt.xlabel("Normalized frequency [cycles per sample]")
Text(0.5, 0, 'Normalized frequency [cycles per sample]')
>>> plt.axis('tight')
(-0.5, 0.5, -100.0, ...) # may vary
>>> plt.show()
r rq r r r r$ )r r
r r r rW r )rT betarU rb alphas rd rU rU
s z XsAtn
%
%Fq A !9DAvvwq ----q! A
qS#IE
dT!agu_s 22333 4 4RXX ==rf c | fS r_ rh r` s rd _sinc_dispatcherrm , r rf c t j | } t t | dk d| z }t | |z S )a
Return the normalized sinc function.
The sinc function is equal to :math:`\sin(\pi x)/(\pi x)` for any argument
:math:`x\ne 0`. ``sinc(0)`` takes the limit value 1, making ``sinc`` not
only everywhere continuous but also infinitely differentiable.
.. note::
Note the normalization factor of ``pi`` used in the definition.
This is the most commonly used definition in signal processing.
Use ``sinc(x / np.pi)`` to obtain the unnormalized sinc function
:math:`\sin(x)/x` that is more common in mathematics.
Parameters
----------
x : ndarray
Array (possibly multi-dimensional) of values for which to calculate
``sinc(x)``.
Returns
-------
out : ndarray
``sinc(x)``, which has the same shape as the input.
Notes
-----
The name sinc is short for "sine cardinal" or "sinus cardinalis".
The sinc function is used in various signal processing applications,
including in anti-aliasing, in the construction of a Lanczos resampling
filter, and in interpolation.
For bandlimited interpolation of discrete-time signals, the ideal
interpolation kernel is proportional to the sinc function.
References
----------
.. [1] Weisstein, Eric W. "Sinc Function." From MathWorld--A Wolfram Web
Resource. http://mathworld.wolfram.com/SincFunction.html
.. [2] Wikipedia, "Sinc function",
https://en.wikipedia.org/wiki/Sinc_function
Examples
--------
>>> import matplotlib.pyplot as plt
>>> x = np.linspace(-4, 4, 41)
>>> np.sinc(x)
array([-3.89804309e-17, -4.92362781e-02, -8.40918587e-02, # may vary
-8.90384387e-02, -5.84680802e-02, 3.89804309e-17,
6.68206631e-02, 1.16434881e-01, 1.26137788e-01,
8.50444803e-02, -3.89804309e-17, -1.03943254e-01,
-1.89206682e-01, -2.16236208e-01, -1.55914881e-01,
3.89804309e-17, 2.33872321e-01, 5.04551152e-01,
7.56826729e-01, 9.35489284e-01, 1.00000000e+00,
9.35489284e-01, 7.56826729e-01, 5.04551152e-01,
2.33872321e-01, 3.89804309e-17, -1.55914881e-01,
-2.16236208e-01, -1.89206682e-01, -1.03943254e-01,
-3.89804309e-17, 8.50444803e-02, 1.26137788e-01,
1.16434881e-01, 6.68206631e-02, 3.89804309e-17,
-5.84680802e-02, -8.90384387e-02, -8.40918587e-02,
-4.92362781e-02, -3.89804309e-17])
>>> plt.plot(x, np.sinc(x))
[]
>>> plt.title("Sinc Function")
Text(0.5, 1.0, 'Sinc Function')
>>> plt.ylabel("Amplitude")
Text(0, 0.5, 'Amplitude')
>>> plt.xlabel("X")
Text(0.5, 0, 'X')
>>> plt.show()
r g#B ;)r r r r r )r r s rd rP rP 0 s= X
aA
U167A
&
&&A q66!8Orf c | fS r_ rh r{ s rd _msort_dispatcherrp r rf c t j dt d t | dd }| d |S )a`
Return a copy of an array sorted along the first axis.
.. deprecated:: 1.24
msort is deprecated, use ``np.sort(a, axis=0)`` instead.
Parameters
----------
a : array_like
Array to be sorted.
Returns
-------
sorted_array : ndarray
Array of the same type and shape as `a`.
See Also
--------
sort
Notes
-----
``np.msort(a)`` is equivalent to ``np.sort(a, axis=0)``.
Examples
--------
>>> a = np.array([[1, 4], [3, 1]])
>>> np.msort(a) # sort along the first axis
array([[1, 1],
[3, 4]])
z3msort is deprecated, use np.sort(a, axis=0) insteadr r8 T)r r; r )r> r? rM r
r r s rd rN rN sQ H
M=
at$'''AFF1III Hrf c
t j | } | dd
| dd }|t j u rd}| j }
t j
|
|r>|. sN "H "H89dAAd "H "H "H "H "H "Hrf rq r r r r c 3 V K | ]#}|v r t j nt d V $d S r_ )r newaxisr) rt s rd r z_ureduce.. sK $ $ 4ii
U4[[ $ $ $ $ $ $rf )r r getr r r r r r& Ellipsisr r r sortedr r; rv rw )r r r r r? rL index_outkeepnkeepr srindex_rr s @rd _ureducer s3 4
aA ::fd # #D
**UD
!
!C2;
B 'b11 > ! "H "H "H "H=B2YY"H "H "H H H #XL9$< =u
t99>> !!WF6NNuRyy>>CII-DIIE!&,,//
%
%1JJq!$$ !'&5&/E122A F6NN > !BJ #XL9$< =u
Q&A
& <znr)GG $ $ $ $ r $ $ $ $ $G
xlW$ % Hrf c
| |fS r_ rh r r r? overwrite_inputr s rd _median_dispatcherr s
s8Orf c 6 t | t |||| S )a
Compute the median along the specified axis.
Returns the median of the array elements.
Parameters
----------
a : array_like
Input array or object that can be converted to an array.
axis : {int, sequence of int, None}, optional
Axis or axes along which the medians are computed. The default
is to compute the median along a flattened version of the array.
A sequence of axes is supported since version 1.9.0.
out : ndarray, optional
Alternative output array in which to place the result. It must
have the same shape and buffer length as the expected output,
but the type (of the output) will be cast if necessary.
overwrite_input : bool, optional
If True, then allow use of memory of input array `a` for
calculations. The input array will be modified by the call to
`median`. This will save memory when you do not need to preserve
the contents of the input array. Treat the input as undefined,
but it will probably be fully or partially sorted. Default is
False. If `overwrite_input` is ``True`` and `a` is not already an
`ndarray`, an error will be raised.
keepdims : bool, optional
If this is set to True, the axes which are reduced are left
in the result as dimensions with size one. With this option,
the result will broadcast correctly against the original `arr`.
.. versionadded:: 1.9.0
Returns
-------
median : ndarray
A new array holding the result. If the input contains integers
or floats smaller than ``float64``, then the output data-type is
``np.float64``. Otherwise, the data-type of the output is the
same as that of the input. If `out` is specified, that array is
returned instead.
See Also
--------
mean, percentile
Notes
-----
Given a vector ``V`` of length ``N``, the median of ``V`` is the
middle value of a sorted copy of ``V``, ``V_sorted`` - i
e., ``V_sorted[(N-1)/2]``, when ``N`` is odd, and the average of the
two middle values of ``V_sorted`` when ``N`` is even.
Examples
--------
>>> a = np.array([[10, 7, 4], [3, 2, 1]])
>>> a
array([[10, 7, 4],
[ 3, 2, 1]])
>>> np.median(a)
3.5
>>> np.median(a, axis=0)
array([6.5, 4.5, 2.5])
>>> np.median(a, axis=1)
array([7., 2.])
>>> m = np.median(a, axis=0)
>>> out = np.zeros_like(m)
>>> np.median(a, axis=0, out=m)
array([6.5, 4.5, 2.5])
>>> m
array([6.5, 4.5, 2.5])
>>> b = a.copy()
>>> np.median(b, axis=1, overwrite_input=True)
array([7., 2.])
>>> assert not np.all(a==b)
>>> b = a.copy()
>>> np.median(b, axis=None, overwrite_input=True)
3.5
>>> assert not np.all(a==b)
)r r r r? r )r _medianr s rd rO rO s) d AGhTs$3 5 5 5 5rf c t j | } || j }n
| j | }|dz dk r
|dz }|dz
|g}n |dz
dz g}t j | j t j p
| j j dv }|r| d |rF|*| }|
| n,|
|| | }nt | || }|j dk r| S |d}t d g|j
z } |j | dz }
|j | dz dk rt |
|
dz | |< nt |
dz
|
dz | |< t | } t || || } |r,|dk r&t j j || | } | S ) Nr r rq Mmr r rh r r? )r r r rv r' r r/ rh r[ r" r$ itemr) r r r% r utils_median_nancheck) r r r? r szszhkth
supports_nanspartr r routs rd r r [ s
aA |
V
WT] Av{{AgQwnQ1}o M!'2:66N!',$:NM
2 , <7799D NN3
KK$K ' ' 'DDCd+++ zRyy{{ |T{{mdi'G Jt !E z$!q eU1W--
eAguQw//
GnnG W
Dc 2 2 2D ?av|,,T4>> Krf )
interpolationc | ||fS r_ rh r qr r? r methodr r s rd _percentile_dispatcherr
q#;rf r c < |t ||d }t j | } | j j dk rt d t j |d }t | }t | st d t | |||||| S )a"
Compute the q-th percentile of the data along the specified axis.
Returns the q-th percentile(s) of the array elements.
Parameters
----------
a : array_like of real numbers
Input array or object that can be converted to an array.
q : array_like of float
Percentage or sequence of percentages for the percentiles to compute.
Values must be between 0 and 100 inclusive.
axis : {int, tuple of int, None}, optional
Axis or axes along which the percentiles are computed. The
default is to compute the percentile(s) along a flattened
version of the array.
.. versionchanged:: 1.9.0
A tuple of axes is supported
out : ndarray, optional
Alternative output array in which to place the result. It must
have the same shape and buffer length as the expected output,
but the type (of the output) will be cast if necessary.
overwrite_input : bool, optional
If True, then allow the input array `a` to be modified by intermediate
calculations, to save memory. In this case, the contents of the input
`a` after this function completes is undefined.
method : str, optional
This parameter specifies the method to use for estimating the
percentile. There are many different methods, some unique to NumPy.
See the notes for explanation. The options sorted by their R type
as summarized in the H&F paper [1]_ are:
1. 'inverted_cdf'
2. 'averaged_inverted_cdf'
3. 'closest_observation'
4. 'interpolated_inverted_cdf'
5. 'hazen'
6. 'weibull'
7. 'linear' (default)
8. 'median_unbiased'
9. 'normal_unbiased'
The first three methods are discontinuous. NumPy further defines the
following discontinuous variations of the default 'linear' (7.) option:
* 'lower'
* 'higher',
* 'midpoint'
* 'nearest'
.. versionchanged:: 1.22.0
This argument was previously called "interpolation" and only
offered the "linear" default and last four options.
keepdims : bool, optional
If this is set to True, the axes which are reduced are left in
the result as dimensions with size one. With this option, the
result will broadcast correctly against the original array `a`.
.. versionadded:: 1.9.0
interpolation : str, optional
Deprecated name for the method keyword argument.
.. deprecated:: 1.22.0
Returns
-------
percentile : scalar or ndarray
If `q` is a single percentile and `axis=None`, then the result
is a scalar. If multiple percentiles are given, first axis of
the result corresponds to the percentiles. The other axes are
the axes that remain after the reduction of `a`. If the input
contains integers or floats smaller than ``float64``, the output
data-type is ``float64``. Otherwise, the output data-type is the
same as that of the input. If `out` is specified, that array is
returned instead.
See Also
--------
mean
median : equivalent to ``percentile(..., 50)``
nanpercentile
quantile : equivalent to percentile, except q in the range [0, 1].
Notes
-----
Given a vector ``V`` of length ``n``, the q-th percentile of ``V`` is
the value ``q/100`` of the way from the minimum to the maximum in a
sorted copy of ``V``. The values and distances of the two nearest
neighbors as well as the `method` parameter will determine the
percentile if the normalized ranking does not match the location of
``q`` exactly. This function is the same as the median if ``q=50``, the
same as the minimum if ``q=0`` and the same as the maximum if
``q=100``.
The optional `method` parameter specifies the method to use when the
desired percentile lies between two indexes ``i`` and ``j = i + 1``.
In that case, we first determine ``i + g``, a virtual index that lies
between ``i`` and ``j``, where ``i`` is the floor and ``g`` is the
fractional part of the index. The final result is, then, an interpolation
of ``a[i]`` and ``a[j]`` based on ``g``. During the computation of ``g``,
``i`` and ``j`` are modified using correction constants ``alpha`` and
``beta`` whose choices depend on the ``method`` used. Finally, note that
since Python uses 0-based indexing, the code subtracts another 1 from the
index internally.
The following formula determines the virtual index ``i + g``, the location
of the percentile in the sorted sample:
.. math::
i + g = (q / 100) * ( n - alpha - beta + 1 ) + alpha
The different methods then work as follows
inverted_cdf:
method 1 of H&F [1]_.
This method gives discontinuous results:
* if g > 0 ; then take j
* if g = 0 ; then take i
averaged_inverted_cdf:
method 2 of H&F [1]_.
This method give discontinuous results:
* if g > 0 ; then take j
* if g = 0 ; then average between bounds
closest_observation:
method 3 of H&F [1]_.
This method give discontinuous results:
* if g > 0 ; then take j
* if g = 0 and index is odd ; then take j
* if g = 0 and index is even ; then take i
interpolated_inverted_cdf:
method 4 of H&F [1]_.
This method give continuous results using:
* alpha = 0
* beta = 1
hazen:
method 5 of H&F [1]_.
This method give continuous results using:
* alpha = 1/2
* beta = 1/2
weibull:
method 6 of H&F [1]_.
This method give continuous results using:
* alpha = 0
* beta = 0
linear:
method 7 of H&F [1]_.
This method give continuous results using:
* alpha = 1
* beta = 1
median_unbiased:
method 8 of H&F [1]_.
This method is probably the best method if the sample
distribution function is unknown (see reference).
This method give continuous results using:
* alpha = 1/3
* beta = 1/3
normal_unbiased:
method 9 of H&F [1]_.
This method is probably the best method if the sample
distribution function is known to be normal.
This method give continuous results using:
* alpha = 3/8
* beta = 3/8
lower:
NumPy method kept for backwards compatibility.
Takes ``i`` as the interpolation point.
higher:
NumPy method kept for backwards compatibility.
Takes ``j`` as the interpolation point.
nearest:
NumPy method kept for backwards compatibility.
Takes ``i`` or ``j``, whichever is nearest.
midpoint:
NumPy method kept for backwards compatibility.
Uses ``(i + j) / 2``.
Examples
--------
>>> a = np.array([[10, 7, 4], [3, 2, 1]])
>>> a
array([[10, 7, 4],
[ 3, 2, 1]])
>>> np.percentile(a, 50)
3.5
>>> np.percentile(a, 50, axis=0)
array([6.5, 4.5, 2.5])
>>> np.percentile(a, 50, axis=1)
array([7., 2.])
>>> np.percentile(a, 50, axis=1, keepdims=True)
array([[7.],
[2.]])
>>> m = np.percentile(a, 50, axis=0)
>>> out = np.zeros_like(m)
>>> np.percentile(a, 50, axis=0, out=out)
array([6.5, 4.5, 2.5])
>>> m
array([6.5, 4.5, 2.5])
>>> b = a.copy()
>>> np.percentile(b, 50, axis=1, overwrite_input=True)
array([7., 2.])
>>> assert not np.all(a == b)
The different methods can be visualized graphically:
.. plot::
import matplotlib.pyplot as plt
a = np.arange(4)
p = np.linspace(0, 100, 6001)
ax = plt.gca()
lines = [
('linear', '-', 'C0'),
('inverted_cdf', ':', 'C1'),
# Almost the same as `inverted_cdf`:
('averaged_inverted_cdf', '-.', 'C1'),
('closest_observation', ':', 'C2'),
('interpolated_inverted_cdf', '--', 'C1'),
('hazen', '--', 'C3'),
('weibull', '-.', 'C4'),
('median_unbiased', '--', 'C5'),
('normal_unbiased', '-.', 'C6'),
]
for method, style, color in lines:
ax.plot(
p, np.percentile(a, p, method=method),
label=method, linestyle=style, color=color)
ax.set(
title='Percentiles for different methods and data: ' + str(a),
xlabel='Percentile',
ylabel='Estimated percentile value',
yticks=a)
ax.legend(bbox_to_anchor=(1.03, 1))
plt.tight_layout()
plt.show()
References
----------
.. [1] R. J. Hyndman and Y. Fan,
"Sample quantiles in statistical packages,"
The American Statistician, 50(4), pp. 361-365, 1996
Nr= rD "a must be an array of real numbersd z)Percentiles must be in the range [0, 100])
_check_interpolation_as_methodr r r rh r rB _quantile_is_validr _quantile_uncheckedr s rd r= r= s n / M<1 1
aAw|s<===
q# A1
A a FDEEE 1dC &( < < 0 ; then take j
* if g = 0 ; then take i
averaged_inverted_cdf:
method 2 of H&F [1]_.
This method gives discontinuous results:
* if g > 0 ; then take j
* if g = 0 ; then average between bounds
closest_observation:
method 3 of H&F [1]_.
This method gives discontinuous results:
* if g > 0 ; then take j
* if g = 0 and index is odd ; then take j
* if g = 0 and index is even ; then take i
interpolated_inverted_cdf:
method 4 of H&F [1]_.
This method gives continuous results using:
* alpha = 0
* beta = 1
hazen:
method 5 of H&F [1]_.
This method gives continuous results using:
* alpha = 1/2
* beta = 1/2
weibull:
method 6 of H&F [1]_.
This method gives continuous results using:
* alpha = 0
* beta = 0
linear:
method 7 of H&F [1]_.
This method gives continuous results using:
* alpha = 1
* beta = 1
median_unbiased:
method 8 of H&F [1]_.
This method is probably the best method if the sample
distribution function is unknown (see reference).
This method gives continuous results using:
* alpha = 1/3
* beta = 1/3
normal_unbiased:
method 9 of H&F [1]_.
This method is probably the best method if the sample
distribution function is known to be normal.
This method gives continuous results using:
* alpha = 3/8
* beta = 3/8
lower:
NumPy method kept for backwards compatibility.
Takes ``i`` as the interpolation point.
higher:
NumPy method kept for backwards compatibility.
Takes ``j`` as the interpolation point.
nearest:
NumPy method kept for backwards compatibility.
Takes ``i`` or ``j``, whichever is nearest.
midpoint:
NumPy method kept for backwards compatibility.
Uses ``(i + j) / 2``.
Examples
--------
>>> a = np.array([[10, 7, 4], [3, 2, 1]])
>>> a
array([[10, 7, 4],
[ 3, 2, 1]])
>>> np.quantile(a, 0.5)
3.5
>>> np.quantile(a, 0.5, axis=0)
array([6.5, 4.5, 2.5])
>>> np.quantile(a, 0.5, axis=1)
array([7., 2.])
>>> np.quantile(a, 0.5, axis=1, keepdims=True)
array([[7.],
[2.]])
>>> m = np.quantile(a, 0.5, axis=0)
>>> out = np.zeros_like(m)
>>> np.quantile(a, 0.5, axis=0, out=out)
array([6.5, 4.5, 2.5])
>>> m
array([6.5, 4.5, 2.5])
>>> b = a.copy()
>>> np.quantile(b, 0.5, axis=1, overwrite_input=True)
array([7., 2.])
>>> assert not np.all(a == b)
See also `numpy.percentile` for a visualization of most methods.
References
----------
.. [1] R. J. Hyndman and Y. Fan,
"Sample quantiles in statistical packages,"
The American Statistician, 50(4), pp. 361-365, 1996
Nr] rD r z%Quantiles must be in the range [0, 1]) r r r r rh r r r r r s rd r] r] s ` / M:/ /
aAw|s<===
aA a B@AAA 1dC &( < < > 5 4rf c p t j d| dt d | dk rt d |S )Nz!the `interpolation=` argument to z was renamed to `method=`, which has additional options.
Users of the modes 'nearest', 'lower', 'higher', or 'midpoint' are encouraged to review the method they used. (Deprecated NumPy 1.22)r r8 r zjYou shall not pass both `method` and `interpolation`!
(`interpolation` is Deprecated in favor of `method`))r> r? rM r )r r fnames rd r r sh M "E " " "
q
* * * *
CD D D rf rk rj c 0 | |z ||d|z
|z
z z z dz
S )a0
Compute the floating point indexes of an array for the linear
interpolation of quantiles.
n : array_like
The sample sizes.
quantiles : array_like
The quantiles values.
alpha : float
A constant used to correct the index computed.
beta : float
A constant used to correct the index computed.
alpha and beta values depend on the chosen method
(see quantile documentation)
Reference:
Hyndman&Fan paper "Sample Quantiles in Statistical Packages",
DOI: 10.1080/00031305.1996.10473566
rq rh )rb rc rk rj s rd r r s3 (
y= IUT!12 2
rf c | t j | |z
} |d || }t j | S )a
Compute gamma (a.k.a 'm' or 'weight') for the linear interpolation
of quantiles.
virtual_indexes : array_like
The indexes where the percentile is supposed to be found in the sorted
sample.
previous_indexes : array_like
The floor values of virtual_indexes.
interpolation : dict
The interpolation method chosen, which may have a specific rule
modifying gamma.
gamma is usually the fractional part of virtual_indexes but can be modified
by the interpolation method.
rn )r r )virtual_indexesprevious_indexesr rj s rd
_get_gammar s? "
M/,<< = =E F; 7 7E
= rf c t || }t t | ||z | }t ||d|z
z ||dk |j dk r
||d }|S )a
Compute the linear interpolation weighted by gamma on each point of
two same shape array.
a : array_like
Left bound.
b : array_like
Right bound.
t : array_like
The interpolation weight.
out : array_like
Output array.
rL rq rt )r? r r Nrh )r! r r r )r rC r r? diff_b_alerp_interpolations rd _lerpr ! sz 1~~H#C8a sv xH a.M s! eqjRXe__q5HA5M%N rf rq rt r rb rc gamma_funs rd r| r| L s/ NNI /Y !0Cc0I09 ; ; ;rf c 4 d }t | |z dz
| S )Nc | dk S r rh ri s rd re z _inverted_cdf..S s
%1* rf rq r r s rd r` r` R s* --I /Y !0C09 ; ; ;rf r r r r returnc |j dk rt d |r |d}| }n0| }n-|d}| }n| }t ||||| }|S )Nr zq must be a scalar or 1dr )rc r r r? )r r r" flattenr; _quantile)r r r r? r r r r s rd r r X s vzz 3444 <D''))CCCC <D))++CC&&((C
s!" $ F
Mrf c B t j t j | }t j |dz }||dz
k }| r
d||< d||< |dk }| r
d||< d||< t j | j t j r2t j | }| r
d||< d||< | t j }| t j }||fS )a
Get the valid indexes of arr neighbouring virtual_indexes.
Note
This is a companion function to linear interpolation of
Quantiles
Returns
-------
(previous_indexes, next_indexes): Tuple
A Tuple of virtual_indexes neighbouring indexes
rq r r )
r r r r& r' r r/ isnanr r )r r valid_values_countr next_indexesindexes_above_boundsindexes_below_boundsvirtual_indexes_nanss rd _get_indexesr y s. }RXo%>%>??=!1A!566L*.@1.DD !! 013-.-/ )**Q. !! /12-.-. )* }SY
++ 4 !x 8 8 # # % % 457 1 213L- .'..rw77 &&rw//L \ ))rf r rc c
t j | } | j | }|dk rt j | |d } t | }n:# t
$ r- t
|dt dw xY w |d || }t j | }t j | j t j
p
| j j dv }t j |j t j r|rT|
t | dgf d t j | d }nD|
| d t j d
t$ }t' | |d| } nt) | || \ }
} |
t j t j ddg|
| f d |rt j | d }nd}| |
} | | }
t- ||
| }|j d
| j dz
z z }| | }t3 | |
|| } t j | r3| j dk r | | d } n t j | | d | | S )a
Private function that doesn't support extended axis or keepdims.
These methods are extended to this function using _ureduce
See nanpercentile for parameter usage
It computes the quantiles of the array for the given axis.
A linear interpolation is performed based on the `interpolation`.
By default, the method is "linear" where alpha == beta == 1 which
performs the 7th method of Hyndman&Fan.
With "median_unbiased" we get alpha == beta == 1/3
thus the 8th method of Hyndman&Fan.
r ) destinationz$ is not a valid method. Use one of: Nrm r r r )r .Fr r r rq rL r
) r r rv moveaxis_QuantileMethodsKeyErrorr keysr' r r/ rh r r$ r r" r r
r r r uniquer r r; r r& r )r rc r r r? values_countr r slices_having_nansr r r r r rj r s rd r r s" (
-
C9T?L qyyk#t333
4!&) 4 4 4
)
) $$&&
)
)* */3 44 2f 01, JJOmO44O
M#)RZ 0 0 JCINd4J
}_*BJ77 $ = MM+'<'<'>'>&EFFQM O O O!##g,!7!7
MM///11M : : :!#%t!&>&2&8&8&:&:&( ) )
*
* &!##g,!7!7 !% '(< ?,>> np.trapz([1, 2, 3])
4.0
The spacing between sample points can be selected by either the
``x`` or ``dx`` arguments:
>>> np.trapz([1, 2, 3], x=[4, 6, 8])
8.0
>>> np.trapz([1, 2, 3], dx=2)
8.0
Using a decreasing ``x`` corresponds to integrating in reverse:
>>> np.trapz([1, 2, 3], x=[8, 6, 4])
-8.0
More generally ``x`` is used to integrate along a parametric curve. We can
estimate the integral :math:`\int_0^1 x^2 = 1/3` using:
>>> x = np.linspace(0, 1, num=50)
>>> y = x**2
>>> np.trapz(y, x)
0.33340274885464394
Or estimate the area of a circle, noting we repeat the sample which closes
the curve:
>>> theta = np.linspace(0, 2 * np.pi, num=1000, endpoint=True)
>>> np.trapz(np.cos(theta), x=np.sin(theta))
3.141571941375841
``np.trapz`` can be applied along a specified axis to do multiple
computations in one call:
>>> a = np.arange(6).reshape(2, 3)
>>> a
array([[0, 1, 2],
[3, 4, 5]])
>>> np.trapz(a, axis=0)
array([1.5, 2.5, 3.5])
>>> np.trapz(a, axis=1)
array([2., 8.])
Nrq r r r r$ )
r r r> rv r; r) r r' r r r r reduce)
r r r5 r rO rv rL r9 r: rets
rd rV rV s L 1
Ay qMM 6Q;;QACJE'!*E$K % AAQT"""A
BDkk]2
FDkk]2
FD>>F4Lr??F4LLAeFmm$qv '7783>CCDII L L L JqMM JqMMjaf
.qv /? ?@DdKK L
Js AD A6FF__code__c ( t | ||| S )N)r r5 r )rV r s rd _fake_trapzr s aBT * * **rf )r; sparseindexingc |S r_ rh )r; r r xis rd _meshgrid_dispatcherr s
Irf xyc F t | }|dvrt d d|z fdt | D }|dk r6|dk r0ddd z |d
_ d dd z |d _ |st j |d d
i}| r d |D }|S )a
Return a list of coordinate matrices from coordinate vectors.
Make N-D coordinate arrays for vectorized evaluations of
N-D scalar/vector fields over N-D grids, given
one-dimensional coordinate arrays x1, x2,..., xn.
.. versionchanged:: 1.9
1-D and 0-D cases are allowed.
Parameters
----------
x1, x2,..., xn : array_like
1-D arrays representing the coordinates of a grid.
indexing : {'xy', 'ij'}, optional
Cartesian ('xy', default) or matrix ('ij') indexing of output.
See Notes for more details.
.. versionadded:: 1.7.0
sparse : bool, optional
If True the shape of the returned coordinate array for dimension *i*
is reduced from ``(N1, ..., Ni, ... Nn)`` to
``(1, ..., 1, Ni, 1, ..., 1)``. These sparse coordinate grids are
intended to be use with :ref:`basics.broadcasting`. When all
coordinates are used in an expression, broadcasting still leads to a
fully-dimensonal result array.
Default is False.
.. versionadded:: 1.7.0
copy : bool, optional
If False, a view into the original arrays are returned in order to
conserve memory. Default is True. Please note that
``sparse=False, copy=False`` will likely return non-contiguous
arrays. Furthermore, more than one element of a broadcast array
may refer to a single memory location. If you need to write to the
arrays, make copies first.
.. versionadded:: 1.7.0
Returns
-------
X1, X2,..., XN : list of ndarrays
For vectors `x1`, `x2`,..., `xn` with lengths ``Ni=len(xi)``,
returns ``(N1, N2, N3,..., Nn)`` shaped arrays if indexing='ij'
or ``(N2, N1, N3,..., Nn)`` shaped arrays if indexing='xy'
with the elements of `xi` repeated to fill the matrix along
the first dimension for `x1`, the second for `x2` and so on.
Notes
-----
This function supports both indexing conventions through the indexing
keyword argument. Giving the string 'ij' returns a meshgrid with
matrix indexing, while 'xy' returns a meshgrid with Cartesian indexing.
In the 2-D case with inputs of length M and N, the outputs are of shape
(N, M) for 'xy' indexing and (M, N) for 'ij' indexing. In the 3-D case
with inputs of length M, N and P, outputs are of shape (N, M, P) for
'xy' indexing and (M, N, P) for 'ij' indexing. The difference is
illustrated by the following code snippet::
xv, yv = np.meshgrid(x, y, indexing='ij')
for i in range(nx):
for j in range(ny):
# treat xv[i,j], yv[i,j]
xv, yv = np.meshgrid(x, y, indexing='xy')
for i in range(nx):
for j in range(ny):
# treat xv[j,i], yv[j,i]
In the 1-D and 0-D case, the indexing and sparse keywords have no effect.
See Also
--------
mgrid : Construct a multi-dimensional "meshgrid" using indexing notation.
ogrid : Construct an open multi-dimensional "meshgrid" using indexing
notation.
how-to-index
Examples
--------
>>> nx, ny = (3, 2)
>>> x = np.linspace(0, 1, nx)
>>> y = np.linspace(0, 1, ny)
>>> xv, yv = np.meshgrid(x, y)
>>> xv
array([[0. , 0.5, 1. ],
[0. , 0.5, 1. ]])
>>> yv
array([[0., 0., 0.],
[1., 1., 1.]])
The result of `meshgrid` is a coordinate grid:
>>> import matplotlib.pyplot as plt
>>> plt.plot(xv, yv, marker='o', color='k', linestyle='none')
>>> plt.show()
You can create sparse output arrays to save memory and computation time.
>>> xv, yv = np.meshgrid(x, y, sparse=True)
>>> xv
array([[0. , 0.5, 1. ]])
>>> yv
array([[0.],
[1.]])
`meshgrid` is very useful to evaluate functions on a grid. If the
function depends on all coordinates, both dense and sparse outputs can be
used.
>>> x = np.linspace(-5, 5, 101)
>>> y = np.linspace(-5, 5, 101)
>>> # full coordinate arrays
>>> xx, yy = np.meshgrid(x, y)
>>> zz = np.sqrt(xx**2 + yy**2)
>>> xx.shape, yy.shape, zz.shape
((101, 101), (101, 101), (101, 101))
>>> # sparse coordinate arrays
>>> xs, ys = np.meshgrid(x, y, sparse=True)
>>> zs = np.sqrt(xs**2 + ys**2)
>>> xs.shape, ys.shape, zs.shape
((1, 101), (101, 1), (101, 101))
>>> np.array_equal(zz, zs)
True
>>> h = plt.contourf(x, y, zs)
>>> plt.axis('scaled')
>>> plt.colorbar()
>>> plt.show()
)r ijz.Valid values for `indexing` are 'xy' and 'ij'.r c g | ]E\ }}t j | d | dz |dz d z FS )Nru rq )r r r; )r r r s0s rd r z meshgrid.. sb ) ) )!Q mA &&r"1"v~1q566
'BCC ) ) )rf r rq )rq r r Nr )r rq r Tc 6 g | ]}| S rh r~ r s rd r z meshgrid..+ s +++q!&&((+++rf )r r r rv r r )r; r r r r r+ r s @rd rX rX s J r77D|## <> > >
B) ) ) )#B--) ) )F 4D1HH!BqrrF*q !BqrrF*q :$f9D99 ,++F+++ Mrf c
| |fS r_ rh )r objr s rd _delete_dispatcherr 0 s :rf c @
d}t | t ur | j }n# t $ r Y nw xY wt | } | j }| j j rdnd}|'|dk r| } | j }|dz
}nt || }t d g|z }| j | }t | j }t |t r| | \ } }
} t | |
| } t! | }
|
dk r7|r || | S | | S | dk r| } | d } | d dz }
||xx |
z cc< t% || j | }| dk rn8t d| ||< | t) | |t) | < |
|k rnat |
|
z
d ||< t d g|z }t |
d ||< | t) | |t) | < | dk rnt+ |
| z
t, }d |d|
| z
| < t | |
|
z
||< t d g|z }t | |
||< | t) | } |||< | t) | |t) | < |r || S |S t |t. t0 f rt |t, sd
}nd }|}t3 j | }|j dk r5t |t2 j s| t8 }n/|j dk r$|j j d v r| }d
}|r|| k s||k rt? d |||fz |dk r||z
}||xx dz cc< t% || j | }t d| ||< | t) | |t) | < t |d ||< t d g|z }t |dz d ||< | t) | |t) | < nx|j t, k r2|j |fk r"tA d
! | | }n t+ |t, }d ||f< |||< | t) | }|r || S |S )a
Return a new array with sub-arrays along an axis deleted. For a one
dimensional array, this returns those entries not returned by
`arr[obj]`.
Parameters
----------
arr : array_like
Input array.
obj : slice, int or array of ints
Indicate indices of sub-arrays to remove along the specified axis.
.. versionchanged:: 1.19.0
Boolean indices are now treated as a mask of elements to remove,
rather than being cast to the integers 0 and 1.
axis : int, optional
The axis along which to delete the subarray defined by `obj`.
If `axis` is None, `obj` is applied to the flattened array.
Returns
-------
out : ndarray
A copy of `arr` with the elements specified by `obj` removed. Note
that `delete` does not occur in-place. If `axis` is None, `out` is
a flattened array.
See Also
--------
insert : Insert elements into an array.
append : Append elements at the end of an array.
Notes
-----
Often it is preferable to use a boolean mask. For example:
>>> arr = np.arange(12) + 1
>>> mask = np.ones(len(arr), dtype=bool)
>>> mask[[0,2,4]] = False
>>> result = arr[mask,...]
Is equivalent to ``np.delete(arr, [0,2,4], axis=0)``, but allows further
use of `mask`.
Examples
--------
>>> arr = np.array([[1,2,3,4], [5,6,7,8], [9,10,11,12]])
>>> arr
array([[ 1, 2, 3, 4],
[ 5, 6, 7, 8],
[ 9, 10, 11, 12]])
>>> np.delete(arr, 1, 0)
array([[ 1, 2, 3, 4],
[ 9, 10, 11, 12]])
>>> np.delete(arr, np.s_[::2], 1)
array([[ 2, 4],
[ 6, 8],
[10, 12]])
>>> np.delete(arr, [1,3,5], None)
array([ 1, 3, 5, 7, 8, 9, 10, 11, 12])
Nr Crq r )r r r FTuiz2index %i is out of bounds for axis %i with size %iz\boolean array argument obj to delete must be one dimensional and match the axis length of {})"r r __array_wrap__AttributeErrorr r flagsfncr" r/ r) rv r r indicesr& r r; r
r r r r r1 r r r r r rh r
IndexErrorr r )r r r wrapr arrorderslobjr3 newshapestartstopstepxrnumtodelnewslobj2r| single_value_objs rd rY rY 4 sO B D Cyy %DD D #,,C 8Dim,ssH | 199))++Cxax#D$//
4[[M$ E $ACIH#u 0 KKNNtT
5$
%
%r77 q==
0tCHH8H 4 4555xxhx/// !885DrFEa519D("Hci22 A:: e,,E$K #E%LL 1Ce 199 X
t44E$KDkk]4'F t,,F4L #E&MM 2Ce 199 U
$///D%*D!$u*T! " tH}55E$KDkk]4'F --F4LeFmm$C F4L #E&MM 2Ce 499 J#W~&& z#t/D/D joo 8q==D"*!=!==**T""CC
X]]sy~ 5 5 ((**C L 1"HHq $N+, ,
,
!GG 1HC!Hci22D#&&d e -E%LLC&&d ++ t# SUD))t f
.E%LL 9 yQD "006q ; ; ;
4DD&&&D DJd %,, tCyy
"
//c | ||fS r_ rh )r r rU r s rd _insert_dispatcherr s f rf c l d}t | t ur | j }n# t $ r Y nw xY wt | } | j }| j j rdnd}|'|dk r| } | j }|dz
}nt || }t d g|z }| j | }t | j } t |t r%t | | dt i}
nut# j | }
|
j t( k r7t+ j dt. d |
t }
n|
j dk rt3 d |
j dk r|
} | | k s| |k rt9 d
| d | d | | d
k r| |z
} t% |d| j | j }|
j d
k rt# j |d
| }|j | } | |xx | z
cc< t= | | j | }
t d| ||< | t? | |
t? | < t | | | z ||< ||
t? | < t | | z d ||< t d g|z }t | d ||< | t? | |
t? | < |r ||
S |
S |
j d
k r4t |t" j s|
t }
|
|
d
k xx |z
cc< tA |
} |
! d }|
|xx t# j | z
cc< | |xx | z
cc< tE | | t( }d||
< t= | | j | }
t d g|z }|
||< |||< ||
t? | < | |
t? | < |r ||
S |
S )a
Insert values along the given axis before the given indices.
Parameters
----------
arr : array_like
Input array.
obj : int, slice or sequence of ints
Object that defines the index or indices before which `values` is
inserted.
.. versionadded:: 1.8.0
Support for multiple insertions when `obj` is a single scalar or a
sequence with one element (similar to calling insert multiple
times).
values : array_like
Values to insert into `arr`. If the type of `values` is different
from that of `arr`, `values` is converted to the type of `arr`.
`values` should be shaped so that ``arr[...,obj,...] = values``
is legal.
axis : int, optional
Axis along which to insert `values`. If `axis` is None then `arr`
is flattened first.
Returns
-------
out : ndarray
A copy of `arr` with `values` inserted. Note that `insert`
does not occur in-place: a new array is returned. If
`axis` is None, `out` is a flattened array.
See Also
--------
append : Append elements at the end of an array.
concatenate : Join a sequence of arrays along an existing axis.
delete : Delete elements from an array.
Notes
-----
Note that for higher dimensional inserts ``obj=0`` behaves very different
from ``obj=[0]`` just like ``arr[:,0,:] = values`` is different from
``arr[:,[0],:] = values``.
Examples
--------
>>> a = np.array([[1, 1], [2, 2], [3, 3]])
>>> a
array([[1, 1],
[2, 2],
[3, 3]])
>>> np.insert(a, 1, 5)
array([1, 5, 1, ..., 2, 3, 3])
>>> np.insert(a, 1, 5, axis=1)
array([[1, 5, 1],
[2, 5, 2],
[3, 5, 3]])
Difference between sequence and scalars:
>>> np.insert(a, [1], [[1],[2],[3]], axis=1)
array([[1, 1, 1],
[2, 2, 2],
[3, 3, 3]])
>>> np.array_equal(np.insert(a, 1, [1, 2, 3], axis=1),
... np.insert(a, [1], [[1],[2],[3]], axis=1))
True
>>> b = a.flatten()
>>> b
array([1, 1, 2, 2, 3, 3])
>>> np.insert(b, [2, 2], [5, 6])
array([1, 1, 5, ..., 2, 3, 3])
>>> np.insert(b, slice(2, 4), [5, 6])
array([1, 1, 5, ..., 2, 3, 3])
>>> np.insert(b, [2, 2], [7.13, False]) # type casting
array([1, 1, 7, ..., 2, 3, 3])
>>> x = np.arange(8).reshape(2, 4)
>>> idx = (1, 3)
>>> np.insert(x, idx, 999, axis=1)
array([[ 0, 999, 1, 2, 999, 3],
[ 4, 999, 5, 6, 999, 7]])
Nr r rq r zrin the future insert will treat boolean arrays and array-likes as a boolean index instead of casting it to integerr r8 zDindex array argument obj to insert must be one dimensional or scalarzindex z is out of bounds for axis z with size r Fr7 mergesort)rh r )#r r r r r r r r r" r/ r) rv r r r r r r r
r r r> r?
FutureWarningr r r r r r r
r r r\ r )r r rU r r r r r r3 r r r numnewr r r old_masks rd rZ rZ sn r D Cyy %DD D #,,C 8Dim,ssH | 199))++Cxax#D$//
4[[M$ E $ACIH#u #++a..555 (3-- =D
M(Q
8
8
8
8 nnT**GG \A
|q A2:: .c . .d . .*+ . . / /
/ AII QJE vEKKK <1 [D11F d#& Hci22D%((d e -E%LLE5<00d "E%LLE&L$//d ++ % UD))t f
.E%LL 499
:c2:#>#> ..&& GaKA
\\F OOO - -E ENNNbi'''NNN TNNNf NNNHTN$///H HW
#)X
.
.CDkk]4
FE$KF4L Ce Cf
tCyy Jr c
| |fS r_ rh r rU r s rd _append_dispatcherr s =rf c t | } |8| j dk r| } t | }| j dz
}t | |f| S )a
Append values to the end of an array.
Parameters
----------
arr : array_like
Values are appended to a copy of this array.
values : array_like
These values are appended to a copy of `arr`. It must be of the
correct shape (the same shape as `arr`, excluding `axis`). If
`axis` is not specified, `values` can be any shape and will be
flattened before use.
axis : int, optional
The axis along which `values` are appended. If `axis` is not
given, both `arr` and `values` are flattened before use.
Returns
-------
append : ndarray
A copy of `arr` with `values` appended to `axis`. Note that
`append` does not occur in-place: a new array is allocated and
filled. If `axis` is None, `out` is a flattened array.
See Also
--------
insert : Insert elements into an array.
delete : Delete elements from an array.
Examples
--------
>>> np.append([1, 2, 3], [[4, 5, 6], [7, 8, 9]])
array([1, 2, 3, ..., 7, 8, 9])
When `axis` is specified, `values` must have the correct shape.
>>> np.append([[1, 2, 3], [4, 5, 6]], [[7, 8, 9]], axis=0)
array([[1, 2, 3],
[4, 5, 6],
[7, 8, 9]])
>>> np.append([[1, 2, 3], [4, 5, 6]], [7, 8, 9], axis=0)
Traceback (most recent call last):
...
ValueError: all the input arrays must have same number of dimensions, but
the array at index 0 has 2 dimension(s) and the array at index 1 has 1
dimension(s)
Nrq r )r r r" r r
s rd r[ r[ sZ b S//C | 8q==))++Cv xz V}4 0 0 00rf c
| |fS r_ rh )r binsrS s rd _digitize_dispatcherr s
t9rf c t j | } t j | }t j | j t j rt
d t | }|dk rt d |rdnd}|dk r0t | t j
|ddd | | z
S t j
|| | S ) a?
Return the indices of the bins to which each value in input array belongs.
========= ============= ============================
`right` order of bins returned index `i` satisfies
========= ============= ============================
``False`` increasing ``bins[i-1] <= x < bins[i]``
``True`` increasing ``bins[i-1] < x <= bins[i]``
``False`` decreasing ``bins[i-1] > x >= bins[i]``
``True`` decreasing ``bins[i-1] >= x > bins[i]``
========= ============= ============================
If values in `x` are beyond the bounds of `bins`, 0 or ``len(bins)`` is
returned as appropriate.
Parameters
----------
x : array_like
Input array to be binned. Prior to NumPy 1.10.0, this array had to
be 1-dimensional, but can now have any shape.
bins : array_like
Array of bins. It has to be 1-dimensional and monotonic.
right : bool, optional
Indicating whether the intervals include the right or the left bin
edge. Default behavior is (right==False) indicating that the interval
does not include the right edge. The left bin end is open in this
case, i.e., bins[i-1] <= x < bins[i] is the default behavior for
monotonically increasing bins.
Returns
-------
indices : ndarray of ints
Output array of indices, of same shape as `x`.
Raises
------
ValueError
If `bins` is not monotonic.
TypeError
If the type of the input is complex.
See Also
--------
bincount, histogram, unique, searchsorted
Notes
-----
If values in `x` are such that they fall outside the bin range,
attempting to index `bins` with the indices that `digitize` returns
will result in an IndexError.
.. versionadded:: 1.10.0
`np.digitize` is implemented in terms of `np.searchsorted`. This means
that a binary search is used to bin the values, which scales much better
for larger number of bins than the previous linear search. It also removes
the requirement for the input array to be 1-dimensional.
For monotonically _increasing_ `bins`, the following are equivalent::
np.digitize(x, bins, right=True)
np.searchsorted(bins, x, side='left')
Note that as the order of the arguments are reversed, the side must be too.
The `searchsorted` call is marginally faster, as it does not do any
monotonicity checks. Perhaps more importantly, it supports all dtypes.
Examples
--------
>>> x = np.array([0.2, 6.4, 3.0, 1.6])
>>> bins = np.array([0.0, 1.0, 2.5, 4.0, 10.0])
>>> inds = np.digitize(x, bins)
>>> inds
array([1, 4, 3, 2])
>>> for n in range(x.size):
... print(bins[inds[n]-1], "<=", x[n], "<", bins[inds[n]])
...
0.0 <= 0.2 < 1.0
4.0 <= 6.4 < 10.0
2.5 <= 3.0 < 4.0
1.0 <= 1.6 < 2.5
>>> x = np.array([1.2, 10.0, 12.4, 15.5, 20.])
>>> bins = np.array([0, 5, 10, 15, 20])
>>> np.digitize(x,bins,right=True)
array([1, 2, 3, 4, 4])
>>> np.digitize(x,bins,right=False)
array([1, 3, 3, 4, 5])
zx may not be complexr z3bins must be monotonically increasing or decreasingrR rS r N)side) r r r r' r rf r r0 r r searchsorted)r r rS monor s rd rK rK s v AA ;t D
}QWc 122 0./// D qyyNOOO '66D rzz4yy3+D2JEEEEE ad3333rf )NN)rq r r_ )NNN)NNFr )r F)NNNN)F)Nr )r )NT)NNNNNN)NTFNNN)NNFF)NNNNN)NNFr F)NNFr )r r N)Nrs r )collections.abcr functoolsr r r> _utilsr r6 r numpy.core.numericcorenumericr
numpy.corer r r r r r
r r r
r r r r r r r r numpy.core.umathr r r r r r r r r r r r! numpy.core.fromnumericr" r# r$ r% r& r' numpy.core.numerictypesr( r) numpy.core.function_baser* numpy.lib.twodim_baser+ numpy.core.multiarrayr, r- r. r/ r0 r1 rZ r2 rX r3 r\ r numpy.lib.histogramsr4 r5 partialarray_function_dispatch__all__dictr r rE r rD r< r r rJ rI r r9 r r8 r r; r r? rI r> rU rc r@ rn rA r| rB r r: r rF r rG rC r r _CORE_DIMENSION_LISTr _ARGUMENT_LISTr r r r r r rH r4 rL rJ rM rT rS rR rQ r_ rc r] ra rd rf rW rU rm rP rp rN r r rO r r r= r r] r r r r< r r r rz r r| r` r1 r r r r r rV r r r __globals__ __defaults__ __closure____kwdefaults__r rX r rY r rZ r r[ r rK rh rf rd r/ s
. - - - - - / / / / / / & & & & & & C B B B B B 8 7 7 7 7 7 7 7 ,)+
%g7 7 7 6 4 JJ(( $BB O O(( #d3 3((
$7 7((
D3 3((
4BB(( D? ?((
D? ?(( $1 1(( 41 1(( T0 0" "
D1 1((
[R R R j *++X6 X6 X6 ,+X6v )**Z Z Z +*Zz G) ) )X!%
,--b[b b b b .-bJ GC
C
C
C
L .//u
u
0/u
p
+,,a a a -,aH )**X9 X9 X9 +*X9z ,0D
-.. # X X X X /.Xv
)**b"+bk A
A
A
+*A
H +,,I/ I/ I/ -,I/X *++1
1
1
,+1
hT +,,\qt \ \ \ \ -,\~ ''! ! ('!H %%1 1 1 &%1 h ,--0> 0> .-0>f *++$# $# ,+$#N' ' ' ' V ,33ODD 1 2 2 !((33
"
">
2
2
8 8 82 " " "D& & &:0 0 0
GT4 T4 T4 T4 T4 T4 T4 T4n =A,0&;?& & & & &
))@DZ $Z Z Z Z *)Zz #
-..t"+BK U
U
U
U
U
/.U
p GeA eA eAP Gm= m= m=` Gi% i% i%X Ge' e' e'T B : + + +: : : ((84 84 )(84z GD> D> D>N )**M M +*M` *++*
*
,+*
ZJ
J
J
J
\ @D
+,,R5 R5 R5 -,R5j5 5 5 5p GK15HL
/00 $
c< "c< c< c< c< 10c