Mercurial > hg > octave-nkf
annotate scripts/specfun/bessel.m @ 10687:a8ce6bdecce5
Improve documentation strings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 08 Jun 2010 20:22:38 -0700 |
| parents | 16f53d29049f |
| children | be55736a0783 |
| rev | line source |
|---|---|
| 9245 | 1 ## Copyright (C) 1996, 1997, 1999, 2000, 2005, 2007, 2008, 2009 |
| 2 ## John W. Eaton | |
| 3276 | 3 ## |
| 4 ## This file is part of Octave. | |
| 5 ## | |
| 6 ## Octave is free software; you can redistribute it and/or modify it | |
| 7 ## under the terms of the GNU General Public License as published by | |
| 7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
| 9 ## your option) any later version. | |
| 3276 | 10 ## |
| 11 ## Octave is distributed in the hope that it will be useful, but | |
| 12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 14 ## General Public License for more details. | |
| 15 ## | |
| 16 ## You should have received a copy of the GNU General Public License | |
| 7016 | 17 ## along with Octave; see the file COPYING. If not, see |
| 18 ## <http://www.gnu.org/licenses/>. | |
| 3276 | 19 |
| 3321 | 20 ## -*- texinfo -*- |
| 7173 | 21 ## @deftypefn {Loadable Function} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt}) |
| 22 ## @deftypefnx {Loadable Function} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt}) | |
| 23 ## @deftypefnx {Loadable Function} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt}) | |
| 24 ## @deftypefnx {Loadable Function} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt}) | |
| 25 ## @deftypefnx {Loadable Function} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt}) | |
| 26 ## Compute Bessel or Hankel functions of various kinds: | |
| 27 ## | |
| 3321 | 28 ## @table @code |
| 29 ## @item besselj | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
30 ## Bessel functions of the first kind. If the argument @var{opt} is supplied, |
|
8278
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
31 ## the result is multiplied by @code{exp(-abs(imag(x)))}. |
| 3321 | 32 ## @item bessely |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
33 ## Bessel functions of the second kind. If the argument @var{opt} is supplied, |
|
8278
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
34 ## the result is multiplied by @code{exp(-abs(imag(x)))}. |
| 3321 | 35 ## @item besseli |
|
8278
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
36 ## Modified Bessel functions of the first kind. If the argument @var{opt} is supplied, |
|
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
37 ## the result is multiplied by @code{exp(-abs(real(x)))}. |
| 3321 | 38 ## @item besselk |
|
8278
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
39 ## Modified Bessel functions of the second kind. If the argument @var{opt} is supplied, |
|
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
40 ## the result is multiplied by @code{exp(x)}. |
| 7173 | 41 ## @item besselh |
| 42 ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
43 ## = 2) kind. If the argument @var{opt} is supplied, the result is multiplied by |
|
8278
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
44 ## @code{exp (-I*@var{x})} for @var{k} = 1 or @code{exp (I*@var{x})} for |
|
ab0674a8b345
fix scaling factor for negative alpha in zbesi,cbesi
Brian Gough <bjg@gnu.org>
parents:
7173
diff
changeset
|
45 ## @var{k} = 2. |
| 3321 | 46 ## @end table |
| 7173 | 47 ## |
| 3321 | 48 ## If @var{alpha} is a scalar, the result is the same size as @var{x}. |
| 7173 | 49 ## If @var{x} is a scalar, the result is the same size as @var{alpha}. |
| 50 ## If @var{alpha} is a row vector and @var{x} is a column vector, the | |
| 51 ## result is a matrix with @code{length (@var{x})} rows and | |
| 52 ## @code{length (@var{alpha})} columns. Otherwise, @var{alpha} and | |
| 53 ## @var{x} must conform and the result will be the same size. | |
| 54 ## | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
55 ## The value of @var{alpha} must be real. The value of @var{x} may be |
| 7173 | 56 ## complex. |
| 57 ## | |
| 58 ## If requested, @var{ierr} contains the following status information | |
| 59 ## and is the same size as the result. | |
| 60 ## | |
| 61 ## @enumerate 0 | |
| 62 ## @item | |
| 63 ## Normal return. | |
| 64 ## @item | |
| 65 ## Input error, return @code{NaN}. | |
| 66 ## @item | |
| 67 ## Overflow, return @code{Inf}. | |
| 68 ## @item | |
| 69 ## Loss of significance by argument reduction results in less than | |
| 70 ## half of machine accuracy. | |
| 71 ## @item | |
| 72 ## Complete loss of significance by argument reduction, return @code{NaN}. | |
| 73 ## @item | |
| 74 ## Error---no computation, algorithm termination condition not met, | |
| 75 ## return @code{NaN}. | |
| 76 ## @end enumerate | |
| 3321 | 77 ## @end deftypefn |
| 3276 | 78 |
| 79 function bessel () | |
| 80 error ("bessel: you must use besselj, bessely, besseli, or besselk"); | |
| 81 endfunction | |
| 3321 | 82 |