Mercurial > octave-antonio

comparison scripts/specfun/legendre.m @ 20162:2645f9ef8c88 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed specfun, special-matrix, testfun, and time script directories. * scripts/specfun/expint.m, scripts/specfun/isprime.m, scripts/specfun/legendre.m, scripts/specfun/primes.m, scripts/specfun/reallog.m, scripts/specfun/realsqrt.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m, scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m, scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m, scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m, scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m, scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m, scripts/testfun/rundemos.m, scripts/testfun/runtests.m, scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m, scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m, scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m, scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 17:00:11 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
21 ## @deftypefn {Function File} {@var{l} =} legendre (@var{n}, @var{x}) 21 ## @deftypefn {Function File} {@var{l} =} legendre (@var{n}, @var{x})
22 ## @deftypefnx {Function File} {@var{l} =} legendre (@var{n}, @var{x}, @var{normalization}) 22 ## @deftypefnx {Function File} {@var{l} =} legendre (@var{n}, @var{x}, @var{normalization})
23 ## Compute the Legendre function of degree @var{n} and order 23 ## Compute the Legendre function of degree @var{n} and order
24 ## @var{m} = 0 @dots{} @var{n}. 24 ## @var{m} = 0 @dots{} @var{n}.
25 ## 25 ##
26 ## The value @var{n} must be a real non-negative integer. @var{x} is a 26 ## The value @var{n} must be a real non-negative integer.
27 ## vector with real-valued elements in the range [-1, 1]. 27 ##
28 ## @var{x} is a vector with real-valued elements in the range [-1, 1].
28 ## 29 ##
29 ## The optional argument @var{normalization} may be one of @qcode{"unnorm"}, 30 ## The optional argument @var{normalization} may be one of @qcode{"unnorm"},
30 ## @qcode{"sch"}, or @qcode{"norm"}. The default if no normalization is given 31 ## @qcode{"sch"}, or @qcode{"norm"}. The default if no normalization is given
31 ## is @qcode{"unnorm"}. 32 ## is @qcode{"unnorm"}.
32 ## 33 ##
86 ## m=2 | 0.00000 | -2.56500 | -4.32000 87 ## m=2 | 0.00000 | -2.56500 | -4.32000
87 ## m=3 | 0.00000 | -1.24229 | -3.24000 88 ## m=3 | 0.00000 | -1.24229 | -3.24000
88 ## @end group 89 ## @end group
89 ## @end example 90 ## @end example
90 ## 91 ##
91 ## When the optional argument @code{normalization} is @qcode{"sch"}, 92 ## When the optional argument @code{normalization} is @qcode{"sch"}, compute
92 ## compute the Schmidt semi-normalized associated Legendre function. 93 ## the Schmidt semi-normalized associated Legendre function. The Schmidt
93 ## The Schmidt semi-normalized associated Legendre function is related 94 ## semi-normalized associated Legendre function is related to the unnormalized
94 ## to the unnormalized Legendre functions by the following: 95 ## Legendre functions by the following:
95 ## 96 ##
96 ## For Legendre functions of degree @var{n} and order 0: 97 ## For Legendre functions of degree @var{n} and order 0:
97 ## 98 ##
98 ## @tex 99 ## @tex
99 ## $$ 100 ## $$
129 ## @end group 130 ## @end group
130 ## @end example 131 ## @end example
131 ## 132 ##
132 ## @end ifnottex 133 ## @end ifnottex
133 ## 134 ##
134 ## When the optional argument @var{normalization} is @qcode{"norm"}, 135 ## When the optional argument @var{normalization} is @qcode{"norm"}, compute
135 ## compute the fully normalized associated Legendre function. 136 ## the fully normalized associated Legendre function. The fully normalized
136 ## The fully normalized associated Legendre function is related 137 ## associated Legendre function is related to the unnormalized Legendre
137 ## to the unnormalized Legendre functions by the following: 138 ## functions by the following:
138 ## 139 ##
139 ## For Legendre functions of degree @var{n} and order @var{m} 140 ## For Legendre functions of degree @var{n} and order @var{m}
140 ## 141 ##
141 ## @tex 142 ## @tex
142 ## $$ 143 ## $$