rb-gsl 1.16.0.2 → 1.16.0.3.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +5 -0
  3. data/README +2 -2
  4. data/Rakefile +2 -3
  5. data/lib/gsl/version.rb +1 -1
  6. data/rdoc/alf.rdoc +5 -5
  7. data/rdoc/blas.rdoc +8 -8
  8. data/rdoc/bspline.rdoc +16 -16
  9. data/rdoc/changes.rdoc +4 -9
  10. data/rdoc/cheb.rdoc +24 -24
  11. data/rdoc/cholesky_complex.rdoc +21 -21
  12. data/rdoc/combi.rdoc +36 -36
  13. data/rdoc/complex.rdoc +21 -21
  14. data/rdoc/const.rdoc +46 -46
  15. data/rdoc/dht.rdoc +48 -48
  16. data/rdoc/diff.rdoc +41 -41
  17. data/rdoc/ehandling.rdoc +5 -5
  18. data/rdoc/eigen.rdoc +152 -152
  19. data/rdoc/fft.rdoc +145 -145
  20. data/rdoc/fit.rdoc +108 -108
  21. data/rdoc/function.rdoc +10 -10
  22. data/rdoc/graph.rdoc +16 -16
  23. data/rdoc/hist.rdoc +102 -102
  24. data/rdoc/hist2d.rdoc +41 -41
  25. data/rdoc/hist3d.rdoc +8 -8
  26. data/rdoc/index.rdoc +18 -21
  27. data/rdoc/integration.rdoc +109 -109
  28. data/rdoc/interp.rdoc +70 -70
  29. data/rdoc/intro.rdoc +6 -6
  30. data/rdoc/linalg.rdoc +187 -187
  31. data/rdoc/linalg_complex.rdoc +1 -1
  32. data/rdoc/math.rdoc +57 -57
  33. data/rdoc/matrix.rdoc +272 -272
  34. data/rdoc/min.rdoc +56 -56
  35. data/rdoc/monte.rdoc +21 -21
  36. data/rdoc/multimin.rdoc +94 -94
  37. data/rdoc/multiroot.rdoc +79 -79
  38. data/rdoc/narray.rdoc +31 -31
  39. data/rdoc/ndlinear.rdoc +53 -53
  40. data/rdoc/nonlinearfit.rdoc +99 -99
  41. data/rdoc/ntuple.rdoc +30 -30
  42. data/rdoc/odeiv.rdoc +87 -87
  43. data/rdoc/perm.rdoc +89 -89
  44. data/rdoc/poly.rdoc +65 -65
  45. data/rdoc/qrng.rdoc +20 -20
  46. data/rdoc/randist.rdoc +81 -81
  47. data/rdoc/ref.rdoc +56 -56
  48. data/rdoc/rng.rdoc +84 -84
  49. data/rdoc/roots.rdoc +56 -56
  50. data/rdoc/sf.rdoc +427 -427
  51. data/rdoc/siman.rdoc +18 -18
  52. data/rdoc/sort.rdoc +29 -29
  53. data/rdoc/start.rdoc +8 -8
  54. data/rdoc/stats.rdoc +51 -51
  55. data/rdoc/sum.rdoc +11 -11
  56. data/rdoc/tensor.rdoc +30 -30
  57. data/rdoc/tut.rdoc +1 -1
  58. data/rdoc/use.rdoc +37 -37
  59. data/rdoc/vector.rdoc +187 -187
  60. data/rdoc/vector_complex.rdoc +23 -23
  61. data/rdoc/wavelet.rdoc +46 -46
  62. metadata +17 -20
  63. data/rdoc/rngextra.rdoc +0 -11
  64. data/rdoc/screenshot.rdoc +0 -40
data/rdoc/complex.rdoc CHANGED
@@ -1,16 +1,16 @@
1
1
  #
2
2
  # = Complex Numbers
3
3
  # Contents:
4
- # 1. {Class methods}[link:rdoc/complex_rdoc.html#1]
5
- # 1. {Properties of Complex Numbers}[link:rdoc/complex_rdoc.html#2]
6
- # 1. {Complex Arithmetic Operators}[link:rdoc/complex_rdoc.html#3]
7
- # 1. {Elementary Complex Functions}[link:rdoc/complex_rdoc.html#4]
8
- # 1. {Complex Trigonometric Functions}[link:rdoc/complex_rdoc.html#5]
9
- # 1. {Inverse Complex Trigonometric Functions}[link:rdoc/complex_rdoc.html#6]
10
- # 1. {Complex Hyperbolic Functions}[link:rdoc/complex_rdoc.html#7]
11
- # 1. {Inverse Complex Hyperbolic Functions}[link:rdoc/complex_rdoc.html#8]
4
+ # 1. {Class methods}[link:complex_rdoc.html#label-Class+Methods]
5
+ # 1. {Properties of Complex Numbers}[link:complex_rdoc.html#label-Properties+of+complex+numbers]
6
+ # 1. {Complex Arithmetic Operators}[link:complex_rdoc.html#label-Complex+arithmetic+operators]
7
+ # 1. {Elementary Complex Functions}[link:complex_rdoc.html#label-Elementary+Complex+Functions]
8
+ # 1. {Complex Trigonometric Functions}[link:complex_rdoc.html#label-Complex+Trigonometric+Functions]
9
+ # 1. {Inverse Complex Trigonometric Functions}[link:complex_rdoc.html#label-Inverse+Complex+Trigonometric+Functions]
10
+ # 1. {Complex Hyperbolic Functions}[link:complex_rdoc.html#label-Complex+Hyperbolic+Functions]
11
+ # 1. {Inverse Complex Hyperbolic Functions}[link:complex_rdoc.html#label-Inverse+Complex+Hyperbolic+Functions]
12
12
  #
13
- # == {}[link:index.html"name="1] Class Methods
13
+ # == Class Methods
14
14
  # ---
15
15
  # * GSL::Complex.alloc(re, im)
16
16
  # * GSL::Complex.rect(re, im)
@@ -23,7 +23,7 @@
23
23
  #
24
24
  # This returns a GSL::Complex object in polar representation, with the amplitude <tt>r</tt> and the phase (argument) <tt>theta</tt>.
25
25
  #
26
- # == {}[link:index.html"name="2] Properties of complex numbers
26
+ # == Properties of complex numbers
27
27
  # ---
28
28
  # * GSL::Complex#real
29
29
  # * GSL::Complex#re
@@ -50,17 +50,17 @@
50
50
  #
51
51
  # Returns the magnitude, squared magnitude, and the logarithm of the magnitude
52
52
  #
53
- # == {}[link:index.html"name="3] Complex arithmetic operators
53
+ # == Complex arithmetic operators
54
54
  # ---
55
55
  # * GSL::Complex#add(b)
56
56
  # * GSL::Complex#+(b)
57
57
  #
58
- # Return the sum of the complex numbers <tt>self</tt> and <tt>b</tt>.
58
+ # Return the sum of the complex numbers <tt>self</tt> and <tt>b</tt>.
59
59
  # ---
60
60
  # * GSL::Complex#sub(b)
61
61
  # * GSL::Complex#-(b)
62
62
  #
63
- # Return the difference of the complex numbers <tt>self</tt> and <tt>b</tt>.
63
+ # Return the difference of the complex numbers <tt>self</tt> and <tt>b</tt>.
64
64
  # ---
65
65
  # * GSL::Complex#mul(b)
66
66
  # * GSL::Complex#*(b)
@@ -97,7 +97,7 @@
97
97
  #
98
98
  # Returns the negative of the complex number <tt>self</tt>.
99
99
  #
100
- # == {}[link:index.html"name="4] Elementary Complex Functions
100
+ # == Elementary Complex Functions
101
101
  # ---
102
102
  # * GSL::Complex#sqrt
103
103
  # * GSL::Complex#pow(az)
@@ -119,7 +119,7 @@
119
119
  # * GSL::Complex.log_b(z, b)
120
120
  #
121
121
  #
122
- # == {}[link:index.html"name="5] Complex Trigonometric Functions
122
+ # == Complex Trigonometric Functions
123
123
  # ---
124
124
  # * GSL::Complex#sin
125
125
  # * GSL::Complex#cos
@@ -138,7 +138,7 @@
138
138
  # * GSL::Complex.cot(z)
139
139
  #
140
140
  #
141
- # == {}[link:index.html"name="6] Inverse Complex Trigonometric Functions
141
+ # == Inverse Complex Trigonometric Functions
142
142
  # ---
143
143
  # * GSL::Complex#arcsin
144
144
  # * GSL::Complex#arccos
@@ -161,7 +161,7 @@
161
161
  # * GSL::Complex.arccot(z)
162
162
  #
163
163
  #
164
- # == {}[link:index.html"name="7] Complex Hyperbolic Functions
164
+ # == Complex Hyperbolic Functions
165
165
  # ---
166
166
  # * GSL::Complex#sinh
167
167
  # * GSL::Complex#cosh
@@ -180,7 +180,7 @@
180
180
  # * GSL::Complex.coth(z)
181
181
  #
182
182
  #
183
- # == {}[link:index.html"name="8] Inverse Complex Hyperbolic Functions
183
+ # == Inverse Complex Hyperbolic Functions
184
184
  # ---
185
185
  # * GSL::Complex#arcsinh
186
186
  # * GSL::Complex#arccosh
@@ -201,10 +201,10 @@
201
201
  # * GSL::Complex#arccoth(z)
202
202
  #
203
203
  #
204
- # {prev}[link:rdoc/math_rdoc.html]
205
- # {next}[link:rdoc/poly_rdoc.html]
204
+ # {prev}[link:math_rdoc.html]
205
+ # {next}[link:poly_rdoc.html]
206
206
  #
207
- # {Reference index}[link:rdoc/ref_rdoc.html]
207
+ # {Reference index}[link:ref_rdoc.html]
208
208
  # {top}[link:index.html]
209
209
  #
210
210
  #
data/rdoc/const.rdoc CHANGED
@@ -2,44 +2,44 @@
2
2
  # = Physical Constants
3
3
  #
4
4
  # The GSL physical constants are defined as Ruby constants under the
5
- # modules
5
+ # modules
6
6
  # * <tt>GSL::CONST::MKSA</tt> (MKSA unit)
7
7
  # * <tt>GSL::CONST:CGSM</tt> (CGSM unit)
8
8
  # * <tt>GSL::CONST:NUM</tt> (Dimension-less constants)
9
- # For example, the GSL C constant
9
+ # For example, the GSL C constant
10
10
  # <tt>GSL_CONST_MKSA_SPEED_OF_LIGHT</tt> is represented by a Ruby constant,
11
11
  # GSL_CONST_MKSA_SPEED_OF_LIGHT ---> GSL::CONST::MKSA::SPEED_OF_LIGHT
12
12
  #
13
13
  # The following lists a part of the constants. Most of the constants are
14
14
  # defined both in the modules <tt>GSL::CONST::MKSA</tt> and <tt>GSL::CONST::CGSM</tt>.
15
- # See also the {GSL reference}[http://www.gnu.org/software/gsl/manual/gsl-ref_37.html#SEC479"target="_top]
15
+ # See also the {GSL reference}[https://gnu.org/software/gsl/manual/gsl-ref_37.html#SEC479]
16
16
  #
17
17
  # Contents:
18
- # 1. {Fundamental Constants}[link:rdoc/const_rdoc.html#1]
19
- # 1. {Astronomy and Astrophysics}[link:rdoc/const_rdoc.html#2]
20
- # 1. {Atomic and Nuclear Physics}[link:rdoc/const_rdoc.html#3]
21
- # 1. {Measurement of Time}[link:rdoc/const_rdoc.html#4]
22
- # 1. {Imperial Units}[link:rdoc/const_rdoc.html#5]
23
- # 1. {Nautical Units}[link:rdoc/const_rdoc.html#6]
24
- # 1. {Printers Units}[link:rdoc/const_rdoc.html#7]
25
- # 1. {Volume}[link:rdoc/const_rdoc.html#8]
26
- # 1. {Mass and Weight}[link:rdoc/const_rdoc.html#9]
27
- # 1. {Thermal Energy and Power}[link:rdoc/const_rdoc.html#10]
28
- # 1. {Pressure}[link:rdoc/const_rdoc.html#11]
29
- # 1. {Viscosity}[link:rdoc/const_rdoc.html#12]
30
- # 1. {Light and Illumination}[link:rdoc/const_rdoc.html#13]
31
- # 1. {Radioactivity}[link:rdoc/const_rdoc.html#14]
32
- # 1. {Force and Energy}[link:rdoc/const_rdoc.html#15]
33
- # 1. {Prefixes}[link:rdoc/const_rdoc.html#16]
34
- # 1. {Examples}[link:rdoc/const_rdoc.html#17]
35
- #
36
- # == {}[link:index.html"name="1] Fundamental Constants
18
+ # 1. {Fundamental Constants}[link:const_rdoc.html#label-Fundamental+Constants]
19
+ # 1. {Astronomy and Astrophysics}[link:const_rdoc.html#label-Astronomy+and+Astrophysics]
20
+ # 1. {Atomic and Nuclear Physics}[link:const_rdoc.html#label-Atomic+and+Nuclear+Physics]
21
+ # 1. {Measurement of Time}[link:const_rdoc.html#label-Measurement+of+Time]
22
+ # 1. {Imperial Units}[link:const_rdoc.html#label-Imperial+Units]
23
+ # 1. {Nautical Units}[link:const_rdoc.html#label-Nautical+Units]
24
+ # 1. {Printers Units}[link:const_rdoc.html#label-Printers+Units]
25
+ # 1. {Volume}[link:const_rdoc.html#label-Volume]
26
+ # 1. {Mass and Weight}[link:const_rdoc.html#label-Mass+and+Weight]
27
+ # 1. {Thermal Energy and Power}[link:const_rdoc.html#label-Thermal+Energy+and+Power]
28
+ # 1. {Pressure}[link:const_rdoc.html#label-Pressure]
29
+ # 1. {Viscosity}[link:const_rdoc.html#label-Viscosity]
30
+ # 1. {Light and Illumination}[link:const_rdoc.html#label-Light+and+Illumination]
31
+ # 1. {Radioactivity}[link:const_rdoc.html#label-Radioactivity]
32
+ # 1. {Force and Energy}[link:const_rdoc.html#label-Force+and+Energy]
33
+ # 1. {Prefixes}[link:const_rdoc.html#label-Prefixes]
34
+ # 1. {Examples}[link:const_rdoc.html#label-Example]
35
+ #
36
+ # == Fundamental Constants
37
37
  # ---
38
38
  # * GSL::CONST::MKSA::SPEED_OF_LIGHT
39
39
  #
40
40
  # The speed of light in vacuum, c.
41
41
  # ---
42
- # * GSL::CONST::MKSA::VACUUM_PERMEABILITY
42
+ # * GSL::CONST::MKSA::VACUUM_PERMEABILITY
43
43
  #
44
44
  # The permeability of free space, \mu (not defined in GSL::CONST::CGSM).
45
45
  # ---
@@ -83,7 +83,7 @@
83
83
  #
84
84
  # The magnetic field of 1 Gauss.
85
85
  #
86
- # == {}[link:index.html"name="2] Astronomy and Astrophysics
86
+ # == Astronomy and Astrophysics
87
87
  # ---
88
88
  # * GSL::CONST::MKSA::ASTRONOMICAL_UNIT
89
89
  #
@@ -109,7 +109,7 @@
109
109
  #
110
110
  # The mass of the Sun.
111
111
  #
112
- # == {}[link:index.html"name="3] Atomic and Nuclear Physics
112
+ # == Atomic and Nuclear Physics
113
113
  # ---
114
114
  # * GSL::CONST::MKSA::ELECTRON_CHARGE
115
115
  #
@@ -183,7 +183,7 @@
183
183
  #
184
184
  # The magnetic moment of the proton, mu_p.
185
185
  #
186
- # == {}[link:index.html"name="4] Measurement of Time
186
+ # == Measurement of Time
187
187
  # ---
188
188
  # * GSL::CONST::MKSA::MINUTE
189
189
  #
@@ -201,7 +201,7 @@
201
201
  #
202
202
  # The number of seconds in 1 week.
203
203
  #
204
- # == {}[link:index.html"name="5] Imperial Units
204
+ # == Imperial Units
205
205
  # ---
206
206
  # * GSL::CONST::MKSA::INCH
207
207
  #
@@ -223,7 +223,7 @@
223
223
  #
224
224
  # The length of 1 mil (1/1000th of an inch).
225
225
  #
226
- # == {}[link:index.html"name="6] Nautical Units
226
+ # == Nautical Units
227
227
  # ---
228
228
  # * GSL::CONST::MKSA::NAUTICAL_MILE
229
229
  #
@@ -237,7 +237,7 @@
237
237
  #
238
238
  # The speed of 1 knot.
239
239
  #
240
- # == {}[link:index.html"name="7] Printers Units
240
+ # == Printers Units
241
241
  # ---
242
242
  # * GSL::CONST::MKSA::POINT
243
243
  #
@@ -247,7 +247,7 @@
247
247
  #
248
248
  # The length of 1 TeX point (1/72.27 inch).
249
249
  #
250
- # == {}[link:index.html"name="8] Volume
250
+ # == Volume
251
251
  # ---
252
252
  # * GSL::CONST::MKSA::ACRE
253
253
  #
@@ -277,7 +277,7 @@
277
277
  #
278
278
  # The volume of 1 pint.
279
279
  #
280
- # == {}[link:index.html"name="9] Mass and Weight
280
+ # == Mass and Weight
281
281
  # ---
282
282
  # * GSL::CONST::MKSA::POUND_MASS
283
283
  #
@@ -323,7 +323,7 @@
323
323
  #
324
324
  # The force of 1 poundal.
325
325
  #
326
- # == {}[link:index.html"name="10] Thermal Energy and Power
326
+ # == Thermal Energy and Power
327
327
  # ---
328
328
  # * GSL::CONST::MKSA::CALORIE
329
329
  #
@@ -341,7 +341,7 @@
341
341
  #
342
342
  # The power of 1 horsepower.
343
343
  #
344
- # == {}[link:index.html"name="11] Pressure
344
+ # == Pressure
345
345
  # ---
346
346
  # * GSL::CONST::MKSA::BAR
347
347
  #
@@ -371,7 +371,7 @@
371
371
  #
372
372
  # The pressure of 1 pound per square inch.
373
373
  #
374
- # == {}[link:index.html"name="12] Viscosity
374
+ # == Viscosity
375
375
  # ---
376
376
  # * GSL::CONST::MKSA::POISE
377
377
  #
@@ -381,7 +381,7 @@
381
381
  #
382
382
  # The kinematic viscosity of 1 stokes.
383
383
  #
384
- # == {}[link:index.html"name="13] Light and Illumination
384
+ # == Light and Illumination
385
385
  # ---
386
386
  # * GSL::CONST::MKSA::STILB
387
387
  #
@@ -411,7 +411,7 @@
411
411
  #
412
412
  # The luminance of 1 footlambert.
413
413
  #
414
- # == {}[link:index.html"name="14] Radioactivity
414
+ # == Radioactivity
415
415
  # ---
416
416
  # * GSL::CONST::MKSA::CURIE
417
417
  #
@@ -425,7 +425,7 @@
425
425
  #
426
426
  # The absorbed dose of 1 rad.
427
427
  #
428
- # == {}[link:index.html"name="15] Force and Energy
428
+ # == Force and Energy
429
429
  # ---
430
430
  # * GSL::CONST::MKSA::NEWTON
431
431
  #
@@ -443,7 +443,7 @@
443
443
  #
444
444
  # The energy 1 erg = 10^-7 Joule.
445
445
  #
446
- # == {}[link:index.html"name="16] Prefixes
446
+ # == Prefixes
447
447
  # ---
448
448
  # * GSL::CONST::NUM::YOTTA
449
449
  #
@@ -509,9 +509,9 @@
509
509
  #
510
510
  # 10^-24
511
511
  #
512
- # == {}[link:index.html"name="17] Example
513
- # The following program demonstrates the use of the physical constants in a
514
- # calculation. In this case, the goal is to calculate the range of light-travel
512
+ # == Example
513
+ # The following program demonstrates the use of the physical constants in a
514
+ # calculation. In this case, the goal is to calculate the range of light-travel
515
515
  # times from Earth to Mars.
516
516
  #
517
517
  # require("gsl")
@@ -523,8 +523,8 @@
523
523
  # au = ASTRONOMICAL_UNIT;
524
524
  # minutes = MINUTE;
525
525
  #
526
- # # distance stored in meters
527
- # r_earth = 1.00 * au;
526
+ # # distance stored in meters
527
+ # r_earth = 1.00 * au;
528
528
  # r_mars = 1.52 * au;
529
529
  #
530
530
  # t_min = (r_mars - r_earth) / c;
@@ -537,10 +537,10 @@
537
537
  # printf("minimum = %.1f minutes\n", t_min / minutes);
538
538
  # printf("maximum = %.1f minutes\n\n", t_max / minutes);
539
539
  #
540
- # {prev}[link:rdoc/bspline_rdoc.html]
541
- # {next}[link:rdoc/graph_rdoc.html]
540
+ # {prev}[link:bspline_rdoc.html]
541
+ # {next}[link:graph_rdoc.html]
542
542
  #
543
- # {Reference index}[link:rdoc/ref_rdoc.html]
543
+ # {Reference index}[link:ref_rdoc.html]
544
544
  # {top}[link:index.html]
545
545
  #
546
546
  #
data/rdoc/dht.rdoc CHANGED
@@ -1,48 +1,48 @@
1
1
  #
2
2
  # = Discrete Hankel Transforms
3
- # This chapter describes functions for performing Discrete Hankel Transforms
4
- # (DHTs).
5
- #
6
- # 1. {Definitions}[link:rdoc/dht_rdoc.html#1]
7
- # 1. {Initialization}[link:rdoc/dht_rdoc.html#2]
8
- # 1. {Methods}[link:rdoc/dht_rdoc.html#3]
9
- #
10
- # == {}[link:index.html"name="1] Definitions
11
- # The discrete Hankel transform acts on a vector of sampled data, where the
12
- # samples are assumed to have been taken at points related to the zeroes of a
13
- # Bessel function of fixed order; compare this to the case of the discrete
14
- # Fourier transform, where samples are taken at points related to the zeroes
15
- # of the sine or cosine function.
16
- #
17
- # Specifically, let f(t) be a function on the unit interval. Then the finite
18
- # \nu-Hankel transform of f(t) is defined to be the set of numbers g_m given by,
3
+ # This chapter describes functions for performing Discrete Hankel Transforms
4
+ # (DHTs).
5
+ #
6
+ # 1. {Definitions}[link:dht_rdoc.html#label-Definitions]
7
+ # 1. {Initialization}[link:dht_rdoc.html#label-Initialization]
8
+ # 1. {Methods}[link:dht_rdoc.html#label-Methods]
9
+ #
10
+ # == Definitions
11
+ # The discrete Hankel transform acts on a vector of sampled data, where the
12
+ # samples are assumed to have been taken at points related to the zeroes of a
13
+ # Bessel function of fixed order; compare this to the case of the discrete
14
+ # Fourier transform, where samples are taken at points related to the zeroes
15
+ # of the sine or cosine function.
16
+ #
17
+ # Specifically, let f(t) be a function on the unit interval. Then the finite
18
+ # \nu-Hankel transform of f(t) is defined to be the set of numbers g_m given by,
19
19
  # so that, Suppose that f is band-limited in the sense that g_m=0 for m > M.
20
- # Then we have the following fundamental sampling theorem. It is this discrete
21
- # expression which defines the discrete Hankel transform. The kernel in the
22
- # summation above defines the matrix of the \nu-Hankel transform of size M-1.
23
- # The coefficients of this matrix, being dependent on \nu and M, must be
24
- # precomputed and stored; the <tt>GSL::Dht</tt> object encapsulates this data.
25
- # The constructor <tt>GSL::Dht.alloc</tt> returns a <tt>GSL::Dht</tt> object
26
- # which must be properly initialized with <tt>GSL::Dht#init</tt> before
27
- # it can be used to perform transforms on data sample vectors,
28
- # for fixed \nu and M, using the <tt>GSL::Dht#apply</tt> method.
29
- # The implementation allows a scaling of the fundamental
30
- # interval, for convenience, so that one can assume the function is defined on
31
- # the interval [0,X], rather than the unit interval.
32
- #
33
- # Notice that by assumption f(t) vanishes at the endpoints of the interval,
34
- # consistent with the inversion formula and the sampling formula given above.
35
- # Therefore, this transform corresponds to an orthogonal expansion in
36
- # eigenfunctions of the Dirichlet problem for the Bessel differential equation.
37
- #
38
- #
39
- # == {}[link:index.html"name="2] Initialization
20
+ # Then we have the following fundamental sampling theorem. It is this discrete
21
+ # expression which defines the discrete Hankel transform. The kernel in the
22
+ # summation above defines the matrix of the \nu-Hankel transform of size M-1.
23
+ # The coefficients of this matrix, being dependent on \nu and M, must be
24
+ # precomputed and stored; the <tt>GSL::Dht</tt> object encapsulates this data.
25
+ # The constructor <tt>GSL::Dht.alloc</tt> returns a <tt>GSL::Dht</tt> object
26
+ # which must be properly initialized with <tt>GSL::Dht#init</tt> before
27
+ # it can be used to perform transforms on data sample vectors,
28
+ # for fixed \nu and M, using the <tt>GSL::Dht#apply</tt> method.
29
+ # The implementation allows a scaling of the fundamental
30
+ # interval, for convenience, so that one can assume the function is defined on
31
+ # the interval [0,X], rather than the unit interval.
32
+ #
33
+ # Notice that by assumption f(t) vanishes at the endpoints of the interval,
34
+ # consistent with the inversion formula and the sampling formula given above.
35
+ # Therefore, this transform corresponds to an orthogonal expansion in
36
+ # eigenfunctions of the Dirichlet problem for the Bessel differential equation.
37
+ #
38
+ #
39
+ # == Initialization
40
40
  #
41
41
  # ---
42
42
  # * GSL::Dht.alloc(size)
43
43
  # * GSL::Dht.alloc(size, nu, xmax)
44
44
  #
45
- # These methods allocate a Discrete Hankel transform object <tt>GSL::Dht</tt>
45
+ # These methods allocate a Discrete Hankel transform object <tt>GSL::Dht</tt>
46
46
  # of size <tt>size</tt>.
47
47
  # If three arguments are given, the object is initialized with the values of
48
48
  # <tt>nu, xmax</tt>.
@@ -52,25 +52,25 @@
52
52
  #
53
53
  # This initializes the transform <tt>self</tt> for the given values of <tt>nu</tt> and <tt>xmax</tt>.
54
54
  #
55
- # == {}[link:index.html"name="3] Methods
55
+ # == Methods
56
56
  # ---
57
57
  # * GSL::Dht#apply(vin, vout)
58
58
  # * GSL::Dht#apply(vin)
59
59
  #
60
- # This applies the transform <tt>self</tt> to the vector <tt>vin</tt> whose size is
60
+ # This applies the transform <tt>self</tt> to the vector <tt>vin</tt> whose size is
61
61
  # equal to the size of the transform.
62
62
  #
63
63
  # ---
64
64
  # * GSL::Dht#x_sample(n)
65
65
  #
66
- # This method returns the value of the n'th sample point in the unit interval,
67
- # (j_{nu,n+1}/j_{nu,M}) X. These are the points where the function f(t) is
66
+ # This method returns the value of the n'th sample point in the unit interval,
67
+ # (j_{nu,n+1}/j_{nu,M}) X. These are the points where the function f(t) is
68
68
  # assumed to be sampled.
69
69
  #
70
70
  # ---
71
71
  # * GSL::Dht#k_sample(n)
72
72
  #
73
- # This method returns the value of the n'th sample point in "k-space",
73
+ # This method returns the value of the n'th sample point in "k-space",
74
74
  # j_{nu,n+1}/X.
75
75
  #
76
76
  # ---
@@ -84,16 +84,16 @@
84
84
  # ---
85
85
  # * GSL::Dht#xmax
86
86
  #
87
- # Returns the upper limit to the x-sampling domain
87
+ # Returns the upper limit to the x-sampling domain
88
88
  # ---
89
89
  # * GSL::Dht#kmax
90
90
  #
91
- # Returns the upper limit to the k-sampling domain
91
+ # Returns the upper limit to the k-sampling domain
92
92
  #
93
93
  # ---
94
94
  # * GSL::Dht#j
95
95
  #
96
- # Returns an array of computed J_nu zeros, j_{nu,s} = j[s]
96
+ # Returns an array of computed J_nu zeros, j_{nu,s} = \j[s]
97
97
  # as a <tt>GSL::Vector::View</tt>.
98
98
  #
99
99
  # ---
@@ -113,10 +113,10 @@
113
113
  #
114
114
  # Return the (n,m)-th transform coefficient.
115
115
  #
116
- # {prev}[link:rdoc/sum_rdoc.html]
117
- # {next}[link:rdoc/roots_rdoc.html]
116
+ # {prev}[link:sum_rdoc.html]
117
+ # {next}[link:roots_rdoc.html]
118
118
  #
119
- # {Reference index}[link:rdoc/ref_rdoc.html]
119
+ # {Reference index}[link:ref_rdoc.html]
120
120
  # {top}[link:index.html]
121
121
  #
122
122
  #