Mercurial > octave-nkf

annotate scripts/specfun/bessel.m @ 20039:eba80000fa0d rc-4-0-0-2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Bump version number for 4.0.0-rc2.
author John W. Eaton <jwe@octave.org>
date Fri, 20 Mar 2015 16:19:38 -0400
parents 7239100e8570
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19136
diff changeset
1 ## Copyright (C) 1996-2015 John W. Eaton
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
2 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
4 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
8 ## your option) any later version.
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
9 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
14 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
18
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Loadable Function} {[@var{j}, @var{ierr}] =} besselj (@var{alpha}, @var{x}, @var{opt})
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
21 ## @deftypefnx {Loadable Function} {[@var{y}, @var{ierr}] =} bessely (@var{alpha}, @var{x}, @var{opt})
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
22 ## @deftypefnx {Loadable Function} {[@var{i}, @var{ierr}] =} besseli (@var{alpha}, @var{x}, @var{opt})
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
23 ## @deftypefnx {Loadable Function} {[@var{k}, @var{ierr}] =} besselk (@var{alpha}, @var{x}, @var{opt})
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
24 ## @deftypefnx {Loadable Function} {[@var{h}, @var{ierr}] =} besselh (@var{alpha}, @var{k}, @var{x}, @var{opt})
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
25 ## Compute Bessel or Hankel functions of various kinds:
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
26 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
27 ## @table @code
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
28 ## @item besselj
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
29 ## Bessel functions of the first kind. If the argument @var{opt} is supplied,
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
30 ## the result is multiplied by @code{exp (-abs (imag (x)))}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
31 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
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,
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
34 ## the result is multiplied by @w{@code{exp (-abs (imag (x)))}}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
35 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
36 ## @item besseli
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
37 ## Modified Bessel functions of the first kind. If the argument @var{opt} is
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
38 ## supplied, the result is multiplied by @w{@code{exp (-abs (real (x)))}}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
39 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
40 ## @item besselk
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
41 ## Modified Bessel functions of the second kind. If the argument @var{opt} is
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
42 ## supplied, the result is multiplied by @w{@code{exp (x)}}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
43 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
44 ## @item besselh
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
45 ## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} = 2)
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
46 ## kind. If the argument @var{opt} is supplied, the result is multiplied by
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
47 ## @w{@code{exp (-I*@var{x})}} for @var{k} = 1 or @w{@code{exp (I*@var{x})}}
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
48 ## for @var{k} = 2.
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
49 ## @end table
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
50 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
51 ## If @var{alpha} is a scalar, the result is the same size as @var{x}.
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
52 ## If @var{x} is a scalar, the result is the same size as @var{alpha}.
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
53 ## If @var{alpha} is a row vector and @var{x} is a column vector, the
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
54 ## result is a matrix with @code{length (@var{x})} rows and
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
55 ## @code{length (@var{alpha})} columns. Otherwise, @var{alpha} and
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
56 ## @var{x} must conform and the result will be the same size.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
57 ##
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
58 ## The value of @var{alpha} must be real. The value of @var{x} may be complex.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
59 ##
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
60 ## If requested, @var{ierr} contains the following status information and is
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
61 ## the same size as the result.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
62 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
63 ## @enumerate 0
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
64 ## @item
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
65 ## Normal return.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
66 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
67 ## @item
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
68 ## Input error, return @code{NaN}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
69 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
70 ## @item
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
71 ## Overflow, return @code{Inf}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
72 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
73 ## @item
19136
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
74 ## Loss of significance by argument reduction results in less than half of
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
75 ## machine accuracy.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
76 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
77 ## @item
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
78 ## Complete loss of significance by argument reduction, return @code{NaN}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
79 ##
7173
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
80 ## @item
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
81 ## Error---no computation, algorithm termination condition not met,
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
82 ## return @code{NaN}.
ff2ff2c09865 [project @ 2007-11-14 18:20:49 by jwe]
jwe
parents: 7017
diff changeset
83 ## @end enumerate
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
84 ## @end deftypefn
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
85
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
86 function bessel ()
19869
7239100e8570 bessel.m: Suppress useless backtrace from error() when help file called as fcn.
Rik <rik@octave.org>
parents: 19731
diff changeset
87 error ("bessel: you must use besselj, bessely, besseli, besselk, or besselh\n");
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
88 endfunction
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
89
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
90
12815
918610ea2f34 codesprint: new tests for specfun directory
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
91 %!error bessel ()
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 14868
diff changeset
92