Mercurial > octave-nkf

comparison scripts/specfun/bessel.m @ 10821:693e22af08ae

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck documentation of m-files Add newlines between @item fields for readability.
author Rik <octave@nomad.inbox5.com>
date Mon, 26 Jul 2010 21:25:36 -0700
parents be55736a0783
children fd0a3ac60b0e
comparison
equal deleted inserted replaced
10820:c44c786f87ba 10821:693e22af08ae
27 ## 27 ##
28 ## @table @code 28 ## @table @code
29 ## @item besselj 29 ## @item besselj
30 ## Bessel functions of the first kind. If the argument @var{opt} is supplied, 30 ## Bessel functions of the first kind. If the argument @var{opt} is supplied,
31 ## the result is multiplied by @code{exp(-abs(imag(x)))}. 31 ## the result is multiplied by @code{exp(-abs(imag(x)))}.
32 ##
32 ## @item bessely 33 ## @item bessely
33 ## Bessel functions of the second kind. If the argument @var{opt} is supplied, 34 ## Bessel functions of the second kind. If the argument @var{opt} is supplied,
34 ## the result is multiplied by @code{exp(-abs(imag(x)))}. 35 ## the result is multiplied by @code{exp(-abs(imag(x)))}.
36 ##
35 ## @item besseli 37 ## @item besseli
36 ## Modified Bessel functions of the first kind. If the argument @var{opt} is 38 ## Modified Bessel functions of the first kind. If the argument @var{opt} is
37 ## supplied, 39 ## supplied,
38 ## the result is multiplied by @code{exp(-abs(real(x)))}. 40 ## the result is multiplied by @code{exp(-abs(real(x)))}.
41 ##
39 ## @item besselk 42 ## @item besselk
40 ## Modified Bessel functions of the second kind. If the argument @var{opt} is 43 ## Modified Bessel functions of the second kind. If the argument @var{opt} is
41 ## supplied, 44 ## supplied,
42 ## the result is multiplied by @code{exp(x)}. 45 ## the result is multiplied by @code{exp(x)}.
46 ##
43 ## @item besselh 47 ## @item besselh
44 ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} 48 ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k}
45 ## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied 49 ## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied
46 ## by 50 ## by
47 ## @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for 51 ## @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for
62 ## and is the same size as the result. 66 ## and is the same size as the result.
63 ## 67 ##
64 ## @enumerate 0 68 ## @enumerate 0
65 ## @item 69 ## @item
66 ## Normal return. 70 ## Normal return.
71 ##
67 ## @item 72 ## @item
68 ## Input error, return @code{NaN}. 73 ## Input error, return @code{NaN}.
74 ##
69 ## @item 75 ## @item
70 ## Overflow, return @code{Inf}. 76 ## Overflow, return @code{Inf}.
77 ##
71 ## @item 78 ## @item
72 ## Loss of significance by argument reduction results in less than 79 ## Loss of significance by argument reduction results in less than
73 ## half of machine accuracy. 80 ## half of machine accuracy.
81 ##
74 ## @item 82 ## @item
75 ## Complete loss of significance by argument reduction, return @code{NaN}. 83 ## Complete loss of significance by argument reduction, return @code{NaN}.
84 ##
76 ## @item 85 ## @item
77 ## Error---no computation, algorithm termination condition not met, 86 ## Error---no computation, algorithm termination condition not met,
78 ## return @code{NaN}. 87 ## return @code{NaN}.
79 ## @end enumerate 88 ## @end enumerate
80 ## @end deftypefn 89 ## @end deftypefn