Mercurial > hg > octave-lyh
comparison scripts/specfun/bessel.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 16f53d29049f |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
24 ## @deftypefnx {Loadable Function} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt}) | 24 ## @deftypefnx {Loadable Function} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt}) |
25 ## Compute Bessel or Hankel functions of various kinds: | 25 ## Compute Bessel or Hankel functions of various kinds: |
26 ## | 26 ## |
27 ## @table @code | 27 ## @table @code |
28 ## @item besselj | 28 ## @item besselj |
29 ## Bessel functions of the first kind. If the argument @var{opt} is supplied, | 29 ## Bessel functions of the first kind. If the argument @var{opt} is supplied, |
30 ## the result is multiplied by @code{exp(-abs(imag(x)))}. | 30 ## the result is multiplied by @code{exp(-abs(imag(x)))}. |
31 ## @item bessely | 31 ## @item bessely |
32 ## Bessel functions of the second kind. If the argument @var{opt} is supplied, | 32 ## Bessel functions of the second kind. If the argument @var{opt} is supplied, |
33 ## the result is multiplied by @code{exp(-abs(imag(x)))}. | 33 ## the result is multiplied by @code{exp(-abs(imag(x)))}. |
34 ## @item besseli | 34 ## @item besseli |
35 ## Modified Bessel functions of the first kind. If the argument @var{opt} is supplied, | 35 ## Modified Bessel functions of the first kind. If the argument @var{opt} is supplied, |
36 ## the result is multiplied by @code{exp(-abs(real(x)))}. | 36 ## the result is multiplied by @code{exp(-abs(real(x)))}. |
37 ## @item besselk | 37 ## @item besselk |
38 ## Modified Bessel functions of the second kind. If the argument @var{opt} is supplied, | 38 ## Modified Bessel functions of the second kind. If the argument @var{opt} is supplied, |
39 ## the result is multiplied by @code{exp(x)}. | 39 ## the result is multiplied by @code{exp(x)}. |
40 ## @item besselh | 40 ## @item besselh |
41 ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} | 41 ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} |
42 ## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied by | 42 ## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied by |
43 ## @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for | 43 ## @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for |
44 ## @var{k} = 2. | 44 ## @var{k} = 2. |
45 ## @end table | 45 ## @end table |
46 ## | 46 ## |
47 ## If @var{alpha} is a scalar, the result is the same size as @var{x}. | 47 ## If @var{alpha} is a scalar, the result is the same size as @var{x}. |
49 ## If @var{alpha} is a row vector and @var{x} is a column vector, the | 49 ## If @var{alpha} is a row vector and @var{x} is a column vector, the |
50 ## result is a matrix with @code{length (@var{x})} rows and | 50 ## result is a matrix with @code{length (@var{x})} rows and |
51 ## @code{length (@var{alpha})} columns. Otherwise, @var{alpha} and | 51 ## @code{length (@var{alpha})} columns. Otherwise, @var{alpha} and |
52 ## @var{x} must conform and the result will be the same size. | 52 ## @var{x} must conform and the result will be the same size. |
53 ## | 53 ## |
54 ## The value of @var{alpha} must be real. The value of @var{x} may be | 54 ## The value of @var{alpha} must be real. The value of @var{x} may be |
55 ## complex. | 55 ## complex. |
56 ## | 56 ## |
57 ## If requested, @var{ierr} contains the following status information | 57 ## If requested, @var{ierr} contains the following status information |
58 ## and is the same size as the result. | 58 ## and is the same size as the result. |
59 ## | 59 ## |