annotate scripts/specfun/bessel.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children ff2ff2c09865
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1996, 1997, 1999, 2000, 2005, 2007 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 -*-
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
20 ## @deftypefn {Mapping Function} {} besseli (@var{alpha}, @var{x})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
21 ## @deftypefnx {Mapping Function} {} besselj (@var{alpha}, @var{x})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
22 ## @deftypefnx {Mapping Function} {} besselk (@var{alpha}, @var{x})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
23 ## @deftypefnx {Mapping Function} {} bessely (@var{alpha}, @var{x})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
24 ## Compute Bessel functions of the following types:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
25 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
26 ## @table @code
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
27 ## @item besselj
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
28 ## Bessel functions of the first kind.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
29 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
30 ## @item bessely
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
31 ## Bessel functions of the second kind.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
32 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
33 ## @item besseli
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
34 ## Modified Bessel functions of the first kind.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
35 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
36 ## @item besselk
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
37 ## Modified Bessel functions of the second kind.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
38 ## @end table
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
39 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
40 ## The second argument, @var{x}, must be a real matrix, vector, or scalar.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
41 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
42 ## The first argument, @var{alpha}, must be greater than or equal to zero.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
43 ## If @var{alpha} is a range, it must have an increment equal to one.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
44 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
45 ## If @var{alpha} is a scalar, the result is the same size as @var{x}.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3321
diff changeset
46 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
47 ## If @var{alpha} is a range, @var{x} must be a vector or scalar, and the
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
48 ## result is a matrix with @code{length(@var{x})} rows and
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
49 ## @code{length(@var{alpha})} columns.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
50 ## @end deftypefn
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
51
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
52 function bessel ()
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
53 error ("bessel: you must use besselj, bessely, besseli, or besselk");
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
54 endfunction
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3276
diff changeset
55