diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2012-01-03 08:05:45 -0700 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2012-01-09 11:09:37 -0700 |
commit | a4e99a7998a30d8e777510aaa5926b436a844f2b (patch) | |
tree | 4539998dd7846b8e1ce27800f79be0f32a48d666 /numpy/polynomial/legendre.py | |
parent | 88163cb1ffb3a98a4ecc74481312a618813a9f1e (diff) | |
download | numpy-a4e99a7998a30d8e777510aaa5926b436a844f2b.tar.gz |
SPELL: Spellcheck the modules. Clarify an example.
Diffstat (limited to 'numpy/polynomial/legendre.py')
-rw-r--r-- | numpy/polynomial/legendre.py | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/numpy/polynomial/legendre.py b/numpy/polynomial/legendre.py index 97c387359..8dd332f07 100644 --- a/numpy/polynomial/legendre.py +++ b/numpy/polynomial/legendre.py @@ -111,12 +111,12 @@ def poly2leg(pol) : Parameters ---------- pol : array_like - 1-d array containing the polynomial coefficients + 1-D array containing the polynomial coefficients Returns ------- c : ndarray - 1-d array containing the coefficients of the equivalent Legendre + 1-D array containing the coefficients of the equivalent Legendre series. See Also @@ -159,13 +159,13 @@ def leg2poly(c) : Parameters ---------- c : array_like - 1-d array containing the Legendre series coefficients, ordered + 1-D array containing the Legendre series coefficients, ordered from lowest order term to highest. Returns ------- pol : ndarray - 1-d array containing the coefficients of the equivalent polynomial + 1-D array containing the coefficients of the equivalent polynomial (relative to the "standard" basis) ordered from lowest order term to highest. @@ -331,7 +331,7 @@ def legadd(c1, c2): Parameters ---------- c1, c2 : array_like - 1-d arrays of Legendre series coefficients ordered from low to + 1-D arrays of Legendre series coefficients ordered from low to high. Returns @@ -381,7 +381,7 @@ def legsub(c1, c2): Parameters ---------- c1, c2 : array_like - 1-d arrays of Legendre series coefficients ordered from low to + 1-D arrays of Legendre series coefficients ordered from low to high. Returns @@ -433,7 +433,7 @@ def legmulx(c): Parameters ---------- c : array_like - 1-d array of Legendre series coefficients ordered from low to + 1-D array of Legendre series coefficients ordered from low to high. Returns @@ -480,7 +480,7 @@ def legmul(c1, c2): Parameters ---------- c1, c2 : array_like - 1-d arrays of Legendre series coefficients ordered from low to + 1-D arrays of Legendre series coefficients ordered from low to high. Returns @@ -496,8 +496,8 @@ def legmul(c1, c2): ----- In general, the (polynomial) product of two C-series results in terms that are not in the Legendre polynomial basis set. Thus, to express - the product as a Legendre series, it is necessary to "re-project" the - product onto said basis set, which may produce "un-intuitive" (but + the product as a Legendre series, it is necessary to "reproject" the + product onto said basis set, which may produce "unintuitive" (but correct) results; see Examples section below. Examples @@ -567,8 +567,8 @@ def legdiv(c1, c2): In general, the (polynomial) division of one Legendre series by another results in quotient and remainder terms that are not in the Legendre polynomial basis set. Thus, to express these results as a Legendre - series, it is necessary to "re-project" the results onto the Legendre - basis set, which may produce "un-intuitive" (but correct) results; see + series, it is necessary to "reproject" the results onto the Legendre + basis set, which may produce "unintuitive" (but correct) results; see Examples section below. Examples @@ -615,13 +615,13 @@ def legpow(c, pow, maxpower=16) : Parameters ---------- c : array_like - 1d array of Legendre series coefficients ordered from low to + l1-D array of Legendre series coefficients ordered from low to high. pow : integer Power to which the series will be raised maxpower : integer, optional Maximum power allowed. This is mainly to limit growth of the series - to umanageable size. Default is 16 + to unmanageable size. Default is 16 Returns ------- @@ -699,7 +699,7 @@ def legder(c, m=1, scl=1, axis=0) : ----- In general, the result of differentiating a Legendre series does not resemble the same operation on a power series. Thus the result of this - function may be "un-intuitive," albeit correct; see Examples section + function may be "unintuitive," albeit correct; see Examples section below. Examples @@ -766,7 +766,7 @@ def legint(c, m=1, k=[], lbnd=0, scl=1, axis=0): 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 axix, e.g., [1,2,3] + coefficients from low to high degree along each axis, e.g., [1,2,3] represents the series ``L_0 + 2*L_1 + 3*L_2`` while [[1,2],[1,2]] represents ``1*L_0(x)*L_0(y) + 1*L_1(x)*L_0(y) + 2*L_0(x)*L_1(y) + 2*L_1(x)*L_1(y)`` if axis=0 is ``x`` and axis=1 is ``y``. @@ -819,8 +819,8 @@ def legint(c, m=1, k=[], lbnd=0, scl=1, axis=0): :math:`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 "re-projected" onto the C-series basis set. Thus, typically, - the result of this function is "un-intuitive," albeit correct; see + 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 @@ -917,7 +917,7 @@ def legval(x, c, tensor=True): with themselves and with the elements of `c`. c : array_like Array of coefficients ordered so that the coefficients for terms of - degree n are contained in c[n]. If `c` is multidimesional the + 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`. @@ -1032,7 +1032,7 @@ def legval2d(x, y, c): def leggrid2d(x, y, c): """ - Evaluate a 2-D Legendre series on the Cartesion product of x and y. + Evaluate a 2-D Legendre series on the Cartesian product of x and y. This function returns the values: @@ -1068,7 +1068,7 @@ def leggrid2d(x, y, c): ------- values : ndarray, compatible object The values of the two dimensional Chebyshev series at points in the - Cartesion product of `x` and `y`. + Cartesian product of `x` and `y`. See Also -------- @@ -1120,7 +1120,7 @@ def legval3d(x, y, z, c): Returns ------- values : ndarray, compatible object - The values of the multidimension polynomial on points formed with + The values of the multidimensional polynomial on points formed with triples of corresponding values from `x`, `y`, and `z`. See Also @@ -1165,7 +1165,7 @@ def leggrid3d(x, y, z, 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 + yshape + z.shape. + x.shape + y.shape + z.shape. Parameters ---------- @@ -1184,7 +1184,7 @@ def leggrid3d(x, y, z, c): Returns ------- values : ndarray, compatible object - The values of the two dimensional polynomial at points in the Cartesion + The values of the two dimensional polynomial at points in the Cartesian product of `x` and `y`. See Also @@ -1476,7 +1476,7 @@ def legfit(x, y, deg, rcond=None, full=False, w=None): 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 - coeficient values may be poorly determined. Using a lower order fit + 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. @@ -1567,7 +1567,7 @@ def legcompanion(c): Parameters ---------- c : array_like - 1-d array of Legendre series coefficients ordered from low to high + 1-D array of Legendre series coefficients ordered from low to high degree. Returns |