module documentation

This module provides a number of objects (mostly functions) useful for dealing with Hermite series, including a Hermite class that encapsulates the usual arithmetic operations. (General information on how this module represents and works with such polynomials is in the docstring for its "parent" sub-package, numpy.polynomial).

Classes

Constants

Arithmetic

Calculus

Misc Functions

See Also

None

Class Hermite An Hermite series class.
Function herm2poly Convert a Hermite series to a polynomial.
Function hermadd Add one Hermite series to another.
Function hermcompanion Return the scaled companion matrix of c.
Function hermder Differentiate a Hermite series.
Function hermdiv Divide one Hermite series by another.
Function hermfit Least squares fit of Hermite series to data.
Function hermfromroots Generate a Hermite series with given roots.
Function hermgauss Gauss-Hermite quadrature.
Function hermgrid2d Evaluate a 2-D Hermite series on the Cartesian product of x and y.
Function hermgrid3d Evaluate a 3-D Hermite series on the Cartesian product of x, y, and z.
Function hermint Integrate a Hermite series.
Function hermline Hermite series whose graph is a straight line.
Function hermmul Multiply one Hermite series by another.
Function hermmulx Multiply a Hermite series by x.
Function hermpow Raise a Hermite series to a power.
Function hermroots Compute the roots of a Hermite series.
Function hermsub Subtract one Hermite series from another.
Function hermval Evaluate an Hermite series at points x.
Function hermval2d Evaluate a 2-D Hermite series at points (x, y).
Function hermval3d Evaluate a 3-D Hermite series at points (x, y, z).
Function hermvander Pseudo-Vandermonde matrix of given degree.
Function hermvander2d Pseudo-Vandermonde matrix of given degrees.
Function hermvander3d Pseudo-Vandermonde matrix of given degrees.
Function hermweight Weight function of the Hermite polynomials.
Function poly2herm poly2herm(pol)
Variable hermdomain Undocumented
Variable hermone Undocumented
Variable hermx Undocumented
Variable hermzero Undocumented
Function _normed_hermite_n Evaluate a normalized Hermite polynomial.
def herm2poly(c): (source)

Convert a Hermite series to a polynomial.

Convert an array representing the coefficients of a Hermite series, ordered from lowest degree to highest, to an array of the coefficients of the equivalent polynomial (relative to the "standard" basis) ordered from lowest to highest degree.

See Also

poly2herm

Notes

The easy way to do conversions between polynomial basis sets is to use the convert method of a class instance.

Examples

>>> from numpy.polynomial.hermite import herm2poly
>>> herm2poly([ 1.   ,  2.75 ,  0.5  ,  0.375])
array([0., 1., 2., 3.])
Parameters
c:array_like1-D array containing the Hermite series coefficients, ordered from lowest order term to highest.
Returns
ndarraypol - 1-D array containing the coefficients of the equivalent polynomial (relative to the "standard" basis) ordered from lowest order term to highest.
def hermadd(c1, c2): (source)

Add one Hermite series to another.

Returns the sum of two Hermite series c1 + c2. The arguments are sequences of coefficients ordered from lowest order term to highest, i.e., [1,2,3] represents the series P_0 + 2*P_1 + 3*P_2.

Notes

Unlike multiplication, division, etc., the sum of two Hermite series is a Hermite series (without having to "reproject" the result onto the basis set) so addition, just like that of "standard" polynomials, is simply "component-wise."

Examples

>>> from numpy.polynomial.hermite import hermadd
>>> hermadd([1, 2, 3], [1, 2, 3, 4])
array([2., 4., 6., 4.])
Parameters
c1:array_like1-D arrays of Hermite series coefficients ordered from low to high.
c2:array_like1-D arrays of Hermite series coefficients ordered from low to high.
Returns
ndarrayout - Array representing the Hermite series of their sum.
def hermcompanion(c): (source)

Return the scaled companion matrix of c.

The basis polynomials are scaled so that the companion matrix is symmetric when c is an Hermite basis polynomial. This provides better eigenvalue estimates than the unscaled case and for basis polynomials the eigenvalues are guaranteed to be real if numpy.linalg.eigvalsh is used to obtain them.

Notes

New in version 1.7.0.
Parameters
c:array_like1-D array of Hermite series coefficients ordered from low to high degree.
Returns
ndarraymat - Scaled companion matrix of dimensions (deg, deg).
def hermder(c, m=1, scl=1, axis=0): (source)

Differentiate a Hermite series.

Returns the Hermite series coefficients c differentiated m times along axis. At each iteration the result is multiplied by scl (the scaling factor is for use in a linear change of variable). The argument c is an array of coefficients from low to high degree along each axis, e.g., [1,2,3] represents the series 1*H_0 + 2*H_1 + 3*H_2 while [[1,2],[1,2]] represents 1*H_0(x)*H_0(y) + 1*H_1(x)*H_0(y) + 2*H_0(x)*H_1(y) + 2*H_1(x)*H_1(y) if axis=0 is x and axis=1 is y.

See Also

hermint

Notes

In general, the result of differentiating a Hermite series does not resemble the same operation on a power series. Thus the result of this function may be "unintuitive," albeit correct; see Examples section below.

Examples

>>> from numpy.polynomial.hermite import hermder
>>> hermder([ 1. ,  0.5,  0.5,  0.5])
array([1., 2., 3.])
>>> hermder([-0.5,  1./2.,  1./8.,  1./12.,  1./16.], m=2)
array([1., 2., 3.])
Parameters
c:array_likeArray of Hermite series coefficients. If c is multidimensional the different axis correspond to different variables with the degree in each axis given by the corresponding index.
m:int, optionalNumber of derivatives taken, must be non-negative. (Default: 1)
scl:scalar, optionalEach differentiation is multiplied by scl. The end result is multiplication by scl**m. This is for use in a linear change of variable. (Default: 1)
axis:int, optional

Axis over which the derivative is taken. (Default: 0).

New in version 1.7.0.
Returns
ndarrayder - Hermite series of the derivative.
def hermdiv(c1, c2): (source)

Divide one Hermite series by another.

Returns the quotient-with-remainder of two Hermite series c1 / c2. The arguments are sequences of coefficients from lowest order "term" to highest, e.g., [1,2,3] represents the series P_0 + 2*P_1 + 3*P_2.

Notes

In general, the (polynomial) division of one Hermite series by another results in quotient and remainder terms that are not in the Hermite polynomial basis set. Thus, to express these results as a Hermite series, it is necessary to "reproject" the results onto the Hermite basis set, which may produce "unintuitive" (but correct) results; see Examples section below.

Examples

>>> from numpy.polynomial.hermite import hermdiv
>>> hermdiv([ 52.,  29.,  52.,   7.,   6.], [0, 1, 2])
(array([1., 2., 3.]), array([0.]))
>>> hermdiv([ 54.,  31.,  52.,   7.,   6.], [0, 1, 2])
(array([1., 2., 3.]), array([2., 2.]))
>>> hermdiv([ 53.,  30.,  52.,   7.,   6.], [0, 1, 2])
(array([1., 2., 3.]), array([1., 1.]))
Parameters
c1:array_like1-D arrays of Hermite series coefficients ordered from low to high.
c2:array_like1-D arrays of Hermite series coefficients ordered from low to high.
Returns
ndarrays[quo, rem] - Of Hermite series coefficients representing the quotient and remainder.
def hermfit(x, y, deg, rcond=None, full=False, w=None): (source)

Least squares fit of Hermite series to data.

Return the coefficients of a Hermite series of degree deg that is the least squares fit to the data values y given at points x. If y is 1-D the returned coefficients will also be 1-D. If y is 2-D multiple fits are done, one for each column of y, and the resulting coefficients are stored in the corresponding columns of a 2-D return. The fitted polynomial(s) are in the form

p(x) = c0 + c1*H1(x) + ... + cn*Hn(x), 

where n is deg.

See Also

numpy.polynomial.chebyshev.chebfit, numpy.polynomial.legendre.legfit, numpy.polynomial.laguerre.lagfit, numpy.polynomial.polynomial.polyfit, numpy.polynomial.hermite_e.hermefit

hermval
Evaluates a Hermite series.
hermvander
Vandermonde matrix of Hermite series.
hermweight
Hermite weight function
numpy.linalg.lstsq
Computes a least-squares fit from the matrix.
scipy.interpolate.UnivariateSpline
Computes spline fits.

Notes

The solution is the coefficients of the Hermite series p that minimizes the sum of the weighted squared errors

E = jw2j*|yj − p(xj)|2, 

where the wj are the weights. This problem is solved by setting up the (typically) overdetermined matrix equation

V(x)*c = w*y, 

where V is the weighted pseudo Vandermonde matrix of x, c are the coefficients to be solved for, w are the weights, y are the observed values. This equation is then solved using the singular value decomposition of V.

If some of the singular values of V are so small that they are neglected, then a RankWarning will be issued. This means that the coefficient values may be poorly determined. Using a lower order fit will usually get rid of the warning. The rcond parameter can also be set to a value smaller than its default, but the resulting fit may be spurious and have large contributions from roundoff error.

Fits using Hermite series are probably most useful when the data can be approximated by sqrt(w(x)) * p(x), where w(x) is the Hermite weight. In that case the weight sqrt(w(x[i])) should be used together with data values y[i]/sqrt(w(x[i])). The weight function is available as hermweight.

References

[1]Wikipedia, "Curve fitting", https://en.wikipedia.org/wiki/Curve_fitting

Examples

>>> from numpy.polynomial.hermite import hermfit, hermval
>>> x = np.linspace(-10, 10)
>>> err = np.random.randn(len(x))/10
>>> y = hermval(x, [1, 2, 3]) + err
>>> hermfit(x, y, 2)
array([1.0218, 1.9986, 2.9999]) # may vary
Parameters
x:array_like, shape(M, )x-coordinates of the M sample points (x[i], y[i]).
y:array_like, shape(M, ) or (M, K)y-coordinates of the sample points. Several data sets of sample points sharing the same x-coordinates can be fitted at once by passing in a 2D-array that contains one dataset per column.
deg:int or 1-D array_likeDegree(s) of the fitting polynomials. If deg is a single integer all terms up to and including the deg'th term are included in the fit. For NumPy versions >= 1.11.0 a list of integers specifying the degrees of the terms to include may be used instead.
rcond:float, optionalRelative condition number of the fit. Singular values smaller than this relative to the largest singular value will be ignored. The default value is len(x)*eps, where eps is the relative precision of the float type, about 2e-16 in most cases.
full:bool, optionalSwitch determining nature of return value. When it is False (the default) just the coefficients are returned, when True diagnostic information from the singular value decomposition is also returned.
w:array_like, shape(M, ), optionalWeights. If not None, the weight w[i] applies to the unsquared residual y[i] - y_hat[i] at x[i]. Ideally the weights are chosen so that the errors of the products w[i]*y[i] all have the same variance. When using inverse-variance weighting, use w[i] = 1/sigma(y[i]). The default value is None.
Returns
  • coef: ndarray, shape (M, ) or (M, K) - Hermite coefficients ordered from low to high. If y was 2-D, the coefficients for the data in column k of y are in column k.

  • [residuals, rank, singular_values, rcond]: list - These values are only returned if full == True

    • residuals -- sum of squared residuals of the least squares fit
    • rank -- the numerical rank of the scaled Vandermonde matrix
    • singular_values -- singular values of the scaled Vandermonde matrix
    • rcond -- value of rcond.

    For more details, see numpy.linalg.lstsq.

Warns
RankWarning

The rank of the coefficient matrix in the least-squares fit is deficient. The warning is only raised if full == False. The warnings can be turned off by

>>> import warnings
>>> warnings.simplefilter('ignore', np.RankWarning)
def hermfromroots(roots): (source)

Generate a Hermite series with given roots.

The function returns the coefficients of the polynomial

p(x) = (x − r0)*(x − r1)*...*(x − rn), 

in Hermite form, where the r_n are the roots specified in roots. If a zero has multiplicity n, then it must appear in roots n times. For instance, if 2 is a root of multiplicity three and 3 is a root of multiplicity 2, then roots looks something like [2, 2, 2, 3, 3]. The roots can appear in any order.

If the returned coefficients are c, then

p(x) = c0 + c1*H1(x) + ... + cn*Hn(x)

The coefficient of the last term is not generally 1 for monic polynomials in Hermite form.

Examples

>>> from numpy.polynomial.hermite import hermfromroots, hermval
>>> coef = hermfromroots((-1, 0, 1))
>>> hermval((-1, 0, 1), coef)
array([0.,  0.,  0.])
>>> coef = hermfromroots((-1j, 1j))
>>> hermval((-1j, 1j), coef)
array([0.+0.j, 0.+0.j])
Parameters
roots:array_likeSequence containing the roots.
Returns
ndarrayout - 1-D array of coefficients. If all roots are real then out is a real array, if some of the roots are complex, then out is complex even if all the coefficients in the result are real (see Examples below).
def hermgauss(deg): (source)

Gauss-Hermite quadrature.

Computes the sample points and weights for Gauss-Hermite quadrature. These sample points and weights will correctly integrate polynomials of degree 2*deg − 1 or less over the interval [ − inf, inf] with the weight function f(x) = exp( − x2).

Notes

New in version 1.7.0.

The results have only been tested up to degree 100, higher degrees may be problematic. The weights are determined by using the fact that

wk = c ⁄ (Hn(xk)*Hn − 1(xk))

where c is a constant independent of k and xk is the k'th root of Hn, and then scaling the results to get the right value when integrating 1.

Parameters
deg:intNumber of sample points and weights. It must be >= 1.
Returns
  • x: ndarray - 1-D ndarray containing the sample points.
  • y: ndarray - 1-D ndarray containing the weights.
def hermgrid2d(x, y, c): (source)

Evaluate a 2-D Hermite series on the Cartesian product of x and y.

This function returns the values:

p(a, b) = i, jci, j*Hi(a)*Hj(b)

where the points (a, b) consist of all pairs formed by taking a from x and b from y. The resulting points form a grid with x in the first dimension and y in the second.

The parameters x and y are converted to arrays only if they are tuples or a lists, otherwise they are treated as a scalars. In either case, either x and y or their elements must support multiplication and addition both with themselves and with the elements of c.

If c has fewer than two dimensions, ones are implicitly appended to its shape to make it 2-D. The shape of the result will be c.shape[2:] + x.shape.

Notes

New in version 1.7.0.
Parameters
x:array_like, compatible objectsThe two dimensional series is evaluated at the points in the Cartesian product of x and y. If x or y is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and, if it isn't an ndarray, it is treated as a scalar.
y:array_like, compatible objectsThe two dimensional series is evaluated at the points in the Cartesian product of x and y. If x or y is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and, if it isn't an ndarray, it is treated as a scalar.
c:array_likeArray of coefficients ordered so that the coefficients for terms of degree i,j are contained in c[i,j]. If c has dimension greater than two the remaining indices enumerate multiple sets of coefficients.
Returns
ndarray, compatible objectvalues - The values of the two dimensional polynomial at points in the Cartesian product of x and y.
def hermgrid3d(x, y, z, c): (source)

Evaluate a 3-D Hermite series on the Cartesian product of x, y, and z.

This function returns the values:

p(a, b, c) = i, j, kci, j, k*Hi(a)*Hj(b)*Hk(c)

where the points (a, b, c) consist of all triples formed by taking a from x, b from y, and c from z. The resulting points form a grid with x in the first dimension, y in the second, and z in the third.

The parameters x, y, and z are converted to arrays only if they are tuples or a lists, otherwise they are treated as a scalars. In either case, either x, y, and z or their elements must support multiplication and addition both with themselves and with the elements of c.

If c has fewer than three dimensions, ones are implicitly appended to its shape to make it 3-D. The shape of the result will be c.shape[3:] + x.shape + y.shape + z.shape.

Notes

New in version 1.7.0.
Parameters
x:array_like, compatible objectsThe three dimensional series is evaluated at the points in the Cartesian product of x, y, and z. If x,`y`, or z is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and, if it isn't an ndarray, it is treated as a scalar.
y:array_like, compatible objectsThe three dimensional series is evaluated at the points in the Cartesian product of x, y, and z. If x,`y`, or z is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and, if it isn't an ndarray, it is treated as a scalar.
z:array_like, compatible objectsThe three dimensional series is evaluated at the points in the Cartesian product of x, y, and z. If x,`y`, or z is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and, if it isn't an ndarray, it is treated as a scalar.
c:array_likeArray of coefficients ordered so that the coefficients for terms of degree i,j are contained in c[i,j]. If c has dimension greater than two the remaining indices enumerate multiple sets of coefficients.
Returns
ndarray, compatible objectvalues - The values of the two dimensional polynomial at points in the Cartesian product of x and y.
def hermint(c, m=1, k=[], lbnd=0, scl=1, axis=0): (source)

Integrate a Hermite series.

Returns the Hermite series coefficients c integrated m times from lbnd along axis. At each iteration the resulting series is multiplied by scl and an integration constant, k, is added. The scaling factor is for use in a linear change of variable. ("Buyer beware": note that, depending on what one is doing, one may want scl to be the reciprocal of what one might expect; for more information, see the Notes section below.) The argument c is an array of coefficients from low to high degree along each axis, e.g., [1,2,3] represents the series H_0 + 2*H_1 + 3*H_2 while [[1,2],[1,2]] represents 1*H_0(x)*H_0(y) + 1*H_1(x)*H_0(y) + 2*H_0(x)*H_1(y) + 2*H_1(x)*H_1(y) if axis=0 is x and axis=1 is y.

See Also

hermder

Notes

Note that the result of each integration is multiplied by scl. Why is this important to note? Say one is making a linear change of variable u = ax + b in an integral relative to x. Then dx = du ⁄ a, so one will need to set scl equal to 1 ⁄ a - perhaps not what one would have first thought.

Also note that, in general, the result of integrating a C-series needs to be "reprojected" onto the C-series basis set. Thus, typically, the result of this function is "unintuitive," albeit correct; see Examples section below.

Examples

>>> from numpy.polynomial.hermite import hermint
>>> hermint([1,2,3]) # integrate once, value 0 at 0.
array([1. , 0.5, 0.5, 0.5])
>>> hermint([1,2,3], m=2) # integrate twice, value & deriv 0 at 0
array([-0.5       ,  0.5       ,  0.125     ,  0.08333333,  0.0625    ]) # may vary
>>> hermint([1,2,3], k=1) # integrate once, value 1 at 0.
array([2. , 0.5, 0.5, 0.5])
>>> hermint([1,2,3], lbnd=-1) # integrate once, value 0 at -1
array([-2. ,  0.5,  0.5,  0.5])
>>> hermint([1,2,3], m=2, k=[1,2], lbnd=-1)
array([ 1.66666667, -0.5       ,  0.125     ,  0.08333333,  0.0625    ]) # may vary
Parameters
c:array_likeArray of Hermite series coefficients. If c is multidimensional the different axis correspond to different variables with the degree in each axis given by the corresponding index.
m:int, optionalOrder of integration, must be positive. (Default: 1)
k:{[], list, scalar}, optionalIntegration constant(s). The value of the first integral at lbnd is the first value in the list, the value of the second integral at lbnd is the second value, etc. If k == [] (the default), all constants are set to zero. If m == 1, a single scalar can be given instead of a list.
lbnd:scalar, optionalThe lower bound of the integral. (Default: 0)
scl:scalar, optionalFollowing each integration the result is multiplied by scl before the integration constant is added. (Default: 1)
axis:int, optional

Axis over which the integral is taken. (Default: 0).

New in version 1.7.0.
Returns
ndarrayS - Hermite series coefficients of the integral.
Raises
ValueErrorIf m < 0, len(k) > m, np.ndim(lbnd) != 0, or np.ndim(scl) != 0.
def hermline(off, scl): (source)

Hermite series whose graph is a straight line.

Examples

>>> from numpy.polynomial.hermite import hermline, hermval
>>> hermval(0,hermline(3, 2))
3.0
>>> hermval(1,hermline(3, 2))
5.0
Parameters
off:scalarsThe specified line is given by off + scl*x.
scl:scalarsThe specified line is given by off + scl*x.
Returns
ndarrayy - This module's representation of the Hermite series for off + scl*x.
def hermmul(c1, c2): (source)

Multiply one Hermite series by another.

Returns the product of two Hermite series c1 * c2. The arguments are sequences of coefficients, from lowest order "term" to highest, e.g., [1,2,3] represents the series P_0 + 2*P_1 + 3*P_2.

Notes

In general, the (polynomial) product of two C-series results in terms that are not in the Hermite polynomial basis set. Thus, to express the product as a Hermite series, it is necessary to "reproject" the product onto said basis set, which may produce "unintuitive" (but correct) results; see Examples section below.

Examples

>>> from numpy.polynomial.hermite import hermmul
>>> hermmul([1, 2, 3], [0, 1, 2])
array([52.,  29.,  52.,   7.,   6.])
Parameters
c1:array_like1-D arrays of Hermite series coefficients ordered from low to high.
c2:array_like1-D arrays of Hermite series coefficients ordered from low to high.
Returns
ndarrayout - Of Hermite series coefficients representing their product.
def hermmulx(c): (source)

Multiply a Hermite series by x.

Multiply the Hermite series c by x, where x is the independent variable.

Notes

The multiplication uses the recursion relationship for Hermite polynomials in the form

xPi(x) = (Pi + 1(x) ⁄ 2 + i*Pi − 1(x))

Examples

>>> from numpy.polynomial.hermite import hermmulx
>>> hermmulx([1, 2, 3])
array([2. , 6.5, 1. , 1.5])
Parameters
c:array_like1-D array of Hermite series coefficients ordered from low to high.
Returns
ndarrayout - Array representing the result of the multiplication.
def hermpow(c, pow, maxpower=16): (source)

Raise a Hermite series to a power.

Returns the Hermite series c raised to the power pow. The argument c is a sequence of coefficients ordered from low to high. i.e., [1,2,3] is the series P_0 + 2*P_1 + 3*P_2.

Examples

>>> from numpy.polynomial.hermite import hermpow
>>> hermpow([1, 2, 3], 2)
array([81.,  52.,  82.,  12.,   9.])
Parameters
c:array_like1-D array of Hermite series coefficients ordered from low to high.
pow:integerPower to which the series will be raised
maxpower:integer, optionalMaximum power allowed. This is mainly to limit growth of the series to unmanageable size. Default is 16
Returns
ndarraycoef - Hermite series of power.
def hermroots(c): (source)

Compute the roots of a Hermite series.

Return the roots (a.k.a. "zeros") of the polynomial

p(x) = ic[i]*Hi(x).

Notes

The root estimates are obtained as the eigenvalues of the companion matrix, Roots far from the origin of the complex plane may have large errors due to the numerical instability of the series for such values. Roots with multiplicity greater than 1 will also show larger errors as the value of the series near such points is relatively insensitive to errors in the roots. Isolated roots near the origin can be improved by a few iterations of Newton's method.

The Hermite series basis polynomials aren't powers of x so the results of this function may seem unintuitive.

Examples

>>> from numpy.polynomial.hermite import hermroots, hermfromroots
>>> coef = hermfromroots([-1, 0, 1])
>>> coef
array([0.   ,  0.25 ,  0.   ,  0.125])
>>> hermroots(coef)
array([-1.00000000e+00, -1.38777878e-17,  1.00000000e+00])
Parameters
c:1-D array_like1-D array of coefficients.
Returns
ndarrayout - Array of the roots of the series. If all the roots are real, then out is also real, otherwise it is complex.
def hermsub(c1, c2): (source)

Subtract one Hermite series from another.

Returns the difference of two Hermite series c1 - c2. The sequences of coefficients are from lowest order term to highest, i.e., [1,2,3] represents the series P_0 + 2*P_1 + 3*P_2.

Notes

Unlike multiplication, division, etc., the difference of two Hermite series is a Hermite series (without having to "reproject" the result onto the basis set) so subtraction, just like that of "standard" polynomials, is simply "component-wise."

Examples

>>> from numpy.polynomial.hermite import hermsub
>>> hermsub([1, 2, 3, 4], [1, 2, 3])
array([0.,  0.,  0.,  4.])
Parameters
c1:array_like1-D arrays of Hermite series coefficients ordered from low to high.
c2:array_like1-D arrays of Hermite series coefficients ordered from low to high.
Returns
ndarrayout - Of Hermite series coefficients representing their difference.
def hermval(x, c, tensor=True): (source)

Evaluate an Hermite series at points x.

If c is of length n + 1, this function returns the value:

p(x) = c0*H0(x) + c1*H1(x) + ... + cn*Hn(x)

The parameter x is converted to an array only if it is a tuple or a list, otherwise it is treated as a scalar. In either case, either x or its elements must support multiplication and addition both with themselves and with the elements of c.

If c is a 1-D array, then p(x) will have the same shape as x. If c is multidimensional, then the shape of the result depends on the value of tensor. If tensor is true the shape will be c.shape[1:] + x.shape. If tensor is false the shape will be c.shape[1:]. Note that scalars have shape (,).

Trailing zeros in the coefficients will be used in the evaluation, so they should be avoided if efficiency is a concern.

Notes

The evaluation uses Clenshaw recursion, aka synthetic division.

Examples

>>> from numpy.polynomial.hermite import hermval
>>> coef = [1,2,3]
>>> hermval(1, coef)
11.0
>>> hermval([[1,2],[3,4]], coef)
array([[ 11.,   51.],
       [115.,  203.]])
Parameters
x:array_like, compatible objectIf x is a list or tuple, it is converted to an ndarray, otherwise it is left unchanged and treated as a scalar. In either case, x or its elements must support addition and multiplication with themselves and with the elements of c.
c:array_likeArray of coefficients ordered so that the coefficients for terms of degree n are contained in c[n]. If c is multidimensional the remaining indices enumerate multiple polynomials. In the two dimensional case the coefficients may be thought of as stored in the columns of c.
tensor:boolean, optional

If True, the shape of the coefficient array is extended with ones on the right, one for each dimension of x. Scalars have dimension 0 for this action. The result is that every column of coefficients in c is evaluated for every element of x. If False, x is broadcast over the columns of c for the evaluation. This keyword is useful when c is multidimensional. The default value is True.

New in version 1.7.0.
Returns
ndarray, algebra_likevalues - The shape of the return value is described above.
def hermval2d(x, y, c): (source)

Evaluate a 2-D Hermite series at points (x, y).

This function returns the values:

p(x, y) = i, jci, j*Hi(x)*Hj(y)

The parameters x and y are converted to arrays only if they are tuples or a lists, otherwise they are treated as a scalars and they must have the same shape after conversion. In either case, either x and y or their elements must support multiplication and addition both with themselves and with the elements of c.

If c is a 1-D array a one is implicitly appended to its shape to make it 2-D. The shape of the result will be c.shape[2:] + x.shape.

Notes

New in version 1.7.0.
Parameters
x:array_like, compatible objectsThe two dimensional series is evaluated at the points (x, y), where x and y must have the same shape. If x or y is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and if it isn't an ndarray it is treated as a scalar.
y:array_like, compatible objectsThe two dimensional series is evaluated at the points (x, y), where x and y must have the same shape. If x or y is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and if it isn't an ndarray it is treated as a scalar.
c:array_likeArray of coefficients ordered so that the coefficient of the term of multi-degree i,j is contained in c[i,j]. If c has dimension greater than two the remaining indices enumerate multiple sets of coefficients.
Returns
ndarray, compatible objectvalues - The values of the two dimensional polynomial at points formed with pairs of corresponding values from x and y.
def hermval3d(x, y, z, c): (source)

Evaluate a 3-D Hermite series at points (x, y, z).

This function returns the values:

p(x, y, z) = i, j, kci, j, k*Hi(x)*Hj(y)*Hk(z)

The parameters x, y, and z are converted to arrays only if they are tuples or a lists, otherwise they are treated as a scalars and they must have the same shape after conversion. In either case, either x, y, and z or their elements must support multiplication and addition both with themselves and with the elements of c.

If c has fewer than 3 dimensions, ones are implicitly appended to its shape to make it 3-D. The shape of the result will be c.shape[3:] + x.shape.

Notes

New in version 1.7.0.
Parameters
x:array_like, compatible objectThe three dimensional series is evaluated at the points (x, y, z), where x, y, and z must have the same shape. If any of x, y, or z is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and if it isn't an ndarray it is treated as a scalar.
y:array_like, compatible objectThe three dimensional series is evaluated at the points (x, y, z), where x, y, and z must have the same shape. If any of x, y, or z is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and if it isn't an ndarray it is treated as a scalar.
z:array_like, compatible objectThe three dimensional series is evaluated at the points (x, y, z), where x, y, and z must have the same shape. If any of x, y, or z is a list or tuple, it is first converted to an ndarray, otherwise it is left unchanged and if it isn't an ndarray it is treated as a scalar.
c:array_likeArray of coefficients ordered so that the coefficient of the term of multi-degree i,j,k is contained in c[i,j,k]. If c has dimension greater than 3 the remaining indices enumerate multiple sets of coefficients.
Returns
ndarray, compatible objectvalues - The values of the multidimensional polynomial on points formed with triples of corresponding values from x, y, and z.
def hermvander(x, deg): (source)

Pseudo-Vandermonde matrix of given degree.

Returns the pseudo-Vandermonde matrix of degree deg and sample points x. The pseudo-Vandermonde matrix is defined by

V[..., i] = Hi(x), 

where 0 <= i <= deg. The leading indices of V index the elements of x and the last index is the degree of the Hermite polynomial.

If c is a 1-D array of coefficients of length n + 1 and V is the array V = hermvander(x, n), then np.dot(V, c) and hermval(x, c) are the same up to roundoff. This equivalence is useful both for least squares fitting and for the evaluation of a large number of Hermite series of the same degree and sample points.

Examples

>>> from numpy.polynomial.hermite import hermvander
>>> x = np.array([-1, 0, 1])
>>> hermvander(x, 3)
array([[ 1., -2.,  2.,  4.],
       [ 1.,  0., -2., -0.],
       [ 1.,  2.,  2., -4.]])
Parameters
x:array_likeArray of points. The dtype is converted to float64 or complex128 depending on whether any of the elements are complex. If x is scalar it is converted to a 1-D array.
deg:intDegree of the resulting matrix.
Returns
ndarrayvander - The pseudo-Vandermonde matrix. The shape of the returned matrix is x.shape + (deg + 1,), where The last index is the degree of the corresponding Hermite polynomial. The dtype will be the same as the converted x.
def hermvander2d(x, y, deg): (source)

Pseudo-Vandermonde matrix of given degrees.

Returns the pseudo-Vandermonde matrix of degrees deg and sample points (x, y). The pseudo-Vandermonde matrix is defined by

V[..., (deg[1] + 1)*i + j] = Hi(x)*Hj(y), 

where 0 <= i <= deg[0] and 0 <= j <= deg[1]. The leading indices of V index the points (x, y) and the last index encodes the degrees of the Hermite polynomials.

If V = hermvander2d(x, y, [xdeg, ydeg]), then the columns of V correspond to the elements of a 2-D coefficient array c of shape (xdeg + 1, ydeg + 1) in the order

c00, c01, c02..., c10, c11, c12...

and np.dot(V, c.flat) and hermval2d(x, y, c) will be the same up to roundoff. This equivalence is useful both for least squares fitting and for the evaluation of a large number of 2-D Hermite series of the same degrees and sample points.

Notes

New in version 1.7.0.
Parameters
x:array_likeArrays of point coordinates, all of the same shape. The dtypes will be converted to either float64 or complex128 depending on whether any of the elements are complex. Scalars are converted to 1-D arrays.
y:array_likeArrays of point coordinates, all of the same shape. The dtypes will be converted to either float64 or complex128 depending on whether any of the elements are complex. Scalars are converted to 1-D arrays.
deg:list of intsList of maximum degrees of the form [x_deg, y_deg].
Returns
ndarrayvander2d - The shape of the returned matrix is x.shape + (order,), where order = (deg[0] + 1)*(deg[1] + 1). The dtype will be the same as the converted x and y.
def hermvander3d(x, y, z, deg): (source)

Pseudo-Vandermonde matrix of given degrees.

Returns the pseudo-Vandermonde matrix of degrees deg and sample points (x, y, z). If l, m, n are the given degrees in x, y, z, then The pseudo-Vandermonde matrix is defined by

V[..., (m + 1)(n + 1)i + (n + 1)j + k] = Hi(x)*Hj(y)*Hk(z), 

where 0 <= i <= l, 0 <= j <= m, and 0 <= j <= n. The leading indices of V index the points (x, y, z) and the last index encodes the degrees of the Hermite polynomials.

If V = hermvander3d(x, y, z, [xdeg, ydeg, zdeg]), then the columns of V correspond to the elements of a 3-D coefficient array c of shape (xdeg + 1, ydeg + 1, zdeg + 1) in the order

c000, c001, c002, ..., c010, c011, c012, ...

and np.dot(V, c.flat) and hermval3d(x, y, z, c) will be the same up to roundoff. This equivalence is useful both for least squares fitting and for the evaluation of a large number of 3-D Hermite series of the same degrees and sample points.

Notes

New in version 1.7.0.
Parameters
x:array_likeArrays of point coordinates, all of the same shape. The dtypes will be converted to either float64 or complex128 depending on whether any of the elements are complex. Scalars are converted to 1-D arrays.
y:array_likeArrays of point coordinates, all of the same shape. The dtypes will be converted to either float64 or complex128 depending on whether any of the elements are complex. Scalars are converted to 1-D arrays.
z:array_likeArrays of point coordinates, all of the same shape. The dtypes will be converted to either float64 or complex128 depending on whether any of the elements are complex. Scalars are converted to 1-D arrays.
deg:list of intsList of maximum degrees of the form [x_deg, y_deg, z_deg].
Returns
ndarrayvander3d - The shape of the returned matrix is x.shape + (order,), where order = (deg[0] + 1)*(deg[1] + 1)*(deg[2] + 1). The dtype will be the same as the converted x, y, and z.
def hermweight(x): (source)

Weight function of the Hermite polynomials.

The weight function is exp( − x2) and the interval of integration is [ − inf, inf]. the Hermite polynomials are orthogonal, but not normalized, with respect to this weight function.

Notes

New in version 1.7.0.
Parameters
x:array_likeValues at which the weight function will be computed.
Returns
ndarrayw - The weight function at x.
def poly2herm(pol): (source)

poly2herm(pol)

Convert a polynomial to a Hermite series.

Convert an array representing the coefficients of a polynomial (relative to the "standard" basis) ordered from lowest degree to highest, to an array of the coefficients of the equivalent Hermite series, ordered from lowest to highest degree.

See Also

herm2poly

Notes

The easy way to do conversions between polynomial basis sets is to use the convert method of a class instance.

Examples

>>> from numpy.polynomial.hermite import poly2herm
>>> poly2herm(np.arange(4))
array([1.   ,  2.75 ,  0.5  ,  0.375])
Parameters
pol:array_like1-D array containing the polynomial coefficients
Returns
ndarrayc - 1-D array containing the coefficients of the equivalent Hermite series.
hermdomain = (source)

Undocumented

Undocumented

Undocumented

hermzero = (source)

Undocumented

def _normed_hermite_n(x, n): (source)

Evaluate a normalized Hermite polynomial.

Compute the value of the normalized Hermite polynomial of degree n at the points x.

Notes

New in version 1.10.0.

This function is needed for finding the Gauss points and integration weights for high degrees. The values of the standard Hermite functions overflow when n >= 207.

Parameters
x:ndarray of double.Points at which to evaluate the function
n:intDegree of the normalized Hermite function to be evaluated.
Returns
ndarrayvalues - The shape of the return value is described above.