rb-gsl 1.15.3.1

data/rdoc/hist.rdoc

@@ -0,0 +1,409 @@
+#
+# = Histograms
+# 1. {Histogram allocation}[link:files/rdoc/hist_rdoc.html#1]
+# 1. {Copying histograms}[link:files/rdoc/hist_rdoc.html#2]
+# 1. {Updating and accessing histogram elements}[link:files/rdoc/hist_rdoc.html#3]
+# 1. {Searching histogram ranges}[link:files/rdoc/hist_rdoc.html#4]
+# 1. {Histogram Statistics}[link:files/rdoc/hist_rdoc.html#5]
+# 1. {Histogram Operations}[link:files/rdoc/hist_rdoc.html#6]
+# 1. {Reading and writing histograms}[link:files/rdoc/hist_rdoc.html#7]
+# 1. {Extensions}[link:files/rdoc/hist_rdoc.html#8]
+#    1. {Histogram Operations}[link:files/rdoc/hist_rdoc.html#8.1]
+#    1. {Graph interface}[link:files/rdoc/hist_rdoc.html#8.2]
+#    1. {Histogram Fittings}[link:files/rdoc/hist_rdoc.html#8.3]
+# 1. {The histogram probability distribution}[link:files/rdoc/hist_rdoc.html#9]
+#
+# == {}[link:index.html"name="1] Histogram allocation
+# ---
+# * GSL::Histogram.alloc(n)
+# * GSL::Histogram.alloc(n, [xmin, xmax])
+# * GSL::Histogram.alloc(n, xmin, xmax)
+# * GSL::Histogram.alloc(n)
+# * GSL::Histogram.alloc(array)
+# * GSL::Histogram.alloc(vector)
+#
+#   Constructor for a histogram object with <tt>n</tt> bins. 
+#
+#   Examples:
+#
+#   1. With an integer:
+#        h = Histogram.alloc(4)  <--- Histogram of 4 bins.
+#                                     The range is not defined yet.
+#
+#                  [ bin[0] )[ bin[1] )[ bin[2] )[ bin[3] )
+#                  |---------|---------|---------|---------|
+#               range[0]  range[1]  range[2]  range[3]  range[4]
+#   
+#   1. With an array or a vector:
+#        h = Histogram.alloc([1, 3, 7, 9, 20])  <--- Histogram of 4 bins.
+#                                                  The range is initialized as
+#                                                  range[0] = 1, range[1] = 3, ..., range[4] = 20.
+#    
+#   1. With size and the range [min, max]:
+#
+#         >> h = Histogram.alloc(5, [0, 5])
+#         >> h.range
+#         => GSL::Histogram::Range: 
+#         [ 0.000e+00 1.000e+00 2.000e+00 3.000e+00 4.000e+00 5.000e+00 ]
+#         >> h.bin
+#         => GSL::Histogram::Bin: 
+#         [ 0.000e+00 0.000e+00 0.000e+00 0.000e+00 0.000e+00 ]
+#         >> h.increment(2.5)
+#         >> h.bin
+#         => GSL::Histogram::Bin: 
+#         [ 0.000e+00 0.000e+00 1.000e+00 0.000e+00 0.000e+00 ]
+#
+# ---
+# * GSL::Histogram.alloc_uniform(n, min, max)
+# * GSL::Histogram.alloc_uniform(n, [min, max])
+# * GSL::Histogram.equal_bins_p(h1, h2)
+# * GSL::Histogram.equal_bins(h1, h2)
+#
+#   Return 1 if the all of the individual bin ranges of the two histograms 
+#   are identical, and 0 otherwise.
+# ---
+# * GSL::Histogram.equal_bins_p?(h1, h2)
+# * GSL::Histogram.equal_bins?(h1, h2)
+#
+#   Return <tt>true</tt> if the all of the individual bin ranges of the two histograms 
+#   are identical, and <tt>false</tt> otherwise.
+#
+# ---
+# * GSL::Histogram#set_ranges(v)
+#
+#   This sets the ranges of the existing histogram using a {GSL::Vector}[link:files/rdoc/vector_rdoc.html] object.
+# ---
+# * GSL::Histogram#set_ranges_uniform(xmin, xmax)
+# * GSL::Histogram#set_ranges_uniform([xmin, xmax])
+#
+#   This method sets the ranges of the existing histogram <tt>self</tt> 
+#   to cover the range <tt>xmin</tt> to <tt>xmax</tt> uniformly. 
+#   The values of the histogram bins are reset to zero. 
+#   The bin ranges are shown as below,
+#      bin[0] corresponds to xmin <= x < xmin + d
+#      bin[1] corresponds to xmin + d <= x < xmin + 2 d
+#        ......
+#      bin[n-1] corresponds to xmin + (n-1)d <= x < xmax
+#   where d is the bin spacing, d = (xmax-xmin)/n.
+#
+# == {}[link:index.html"name="2] Copying Histograms
+# ---
+# * GSL::Histogram.memcpy(dest, src)
+#
+#   Copies the histogram <tt>src</tt> into the pre-existing histogram <tt>dest</tt>, 
+#   making dest into an exact copy of <tt>src</tt>. 
+#   The two histograms must be of the same size. 
+# ---
+# * GSL::Histogram#clone
+#
+#   Returns a newly created histogram which is an exact copy of the histogram 
+#   <tt>self</tt>.
+#
+# == {}[link:index.html"name="3] Updating and accessing histogram elements
+# ---
+# * GSL::Histogram#increment(x, weight = 1)
+# * GSL::Histogram#fill(x, weight = 1)
+# * GSL::Histogram#accumulate(x, weight = 1)
+#
+#   These methods updates the histogram <tt>self</tt> by adding <tt>weight</tt>
+#   (default = 1) to the bin whose range contains the coordinate <tt>x</tt>.
+#   If <tt>x</tt> is an instance of <tt>GSL::Vector</tt> or <tt>Array</tt>, 
+#   all the elements are filled into the histogram.
+#   If <tt>x</tt> is less than (greater than) the lower limit (upper limit) 
+#   of the histogram then none of bins are modified. 
+#
+# ---
+# * GSL::Histogram#increment2(x, weight = 1)
+# * GSL::Histogram#fill2(x, weight = 1)
+# * GSL::Histogram#accumulate2(x, weight = 1)
+#
+#   These methods updates the histogram <tt>self</tt> by adding <tt>weight</tt>
+#   to the bin whose range contains the coordinate <tt>x</tt>.    
+#   If <tt>x</tt> is less than the lower limit, the lowest bin is incremented.
+#   If <tt>x</tt> is greater than the upper limit, the highest bin is incremented.
+#
+# ---
+# * GSL::Histogram#get(i)
+# * GSL::Histogram#[i]
+#
+#   These methods return the contents of the <tt>i</tt>-th bin of the histogram 
+#   <tt>self</tt>.
+#
+# ---
+# * GSL::Hiatogram#get_range(i)
+#
+#   This method finds the upper and lower range limits of the <tt>i</tt>-th bin 
+#   of the histogram <tt>self</tt>, and returns an array [<tt>lower, upper</tt>].
+#
+# ---
+# * GSL::Histogram#range
+#
+#   This returns a <tt>Vector::View</tt> object as a reference to the pointer 
+#   <tt>double *range</tt> in the <tt>gsl_histogram</tt> struct.
+#
+# ---
+# * GSL::Histogram#bin
+#
+#   This returns a <tt>Vector::View</tt> object to access the pointer <tt>double *bin</tt> in the <tt>gsl_histogram</tt> struct.
+#
+# ---
+# * GSL::Histogram#max
+# * GSL::Histogram#min
+# * GSL::Histogram#bins
+#
+#   These methods return the maximum upper and minimum lower range 
+#   limits and the number of bins of the histogram <tt>self</tt>.
+#
+# ---
+# * GSL::Histogram#reset
+#
+#   This method resets all the bins in the histogram <tt>self</tt> to zero.
+#
+# == {}[link:index.html"name="4] Searching histogram ranges 
+# ---
+# * GSL::Histogram#find(x)
+#
+#   This method finds and sets the index i to the bin number which 
+#   covers the coordinate <tt>x</tt> in the histogram <tt>self</tt>.
+#
+# == {}[link:index.html"name="5] Histogram Statistics 
+# ---
+# * GSL::Histogram#max_val
+#
+#   This returns the maximum value contained in the histogram bins.
+#
+# ---
+# * GSL::Histogram#max_bin
+#
+#   This returns the index of the bin containing the maximum value. 
+#   In the case where several bins contain the same maximum value the 
+#   smallest index is returned.
+#
+# ---
+# * GSL::Histogram#min_val
+#
+#   This returns the minimum value contained in the histogram bins.
+#
+# ---
+# * GSL::Histogram#min_bin
+#
+#   This returns the index of the bin containing the minimum value. 
+#   In the case where several bins contain the same maximum value 
+#   the smallest index is returned.
+#
+# ---
+# * GSL::Histogram#mean
+#
+#   This returns the mean of the histogrammed variable, 
+#   where the histogram is regarded as a probability distribution. 
+#   Negative bin values are ignored for the purposes of this calculation. 
+#   The accuracy of the result is limited by the bin width.
+#
+# ---
+# * GSL::Histogram#sigma
+#
+#   This function returns the standard deviation of the histogrammed variable, 
+#   where the histogram is regarded as a probability distribution. 
+#   Negative bin values are ignored for the purposes of this calculation. 
+#   The accuracy of the result is limited by the bin width.
+#
+# ---
+# * GSL::Histogram#sum(istart = 0, iend = n-1)
+#
+#   The sum of values of the histogram <tt>self</tt> from the <tt>istart</tt>-th bin
+#   to the <tt>iend</tt>-th bin.
+#
+#
+# == {}[link:index.html"name="6] Histogram Operations
+#
+# ---
+# * GSL::Histogram#add(h2)
+# * GSL::Histogram#sub(h2)
+# * GSL::Histogram#mul(h2)
+# * GSL::Histogram#div(h2)
+# * GSL::Histogram#scale(val)
+# * GSL::Histogram#shift(val)
+#
+#
+#
+# == {}[link:index.html"name="7] Reading and writing histograms
+# ---
+# * GSL::Histogram#fwrite(io)
+# * GSL::Histogram#fwrite(filename)
+# * GSL::Histogram#fread(io)
+# * GSL::Histogram#fread(filename)
+# * GSL::Histogram#fprintf(io, range_format = "%e", bin_format = "%e")
+# * GSL::Histogram#fprintf(filename, range_format = "%e", bin_format = "%e")
+# * GSL::Histogram#fscanf(io)
+# * GSL::Histogram#fscanf(filename)
+#
+#
+# == {}[link:index.html"name="8] Extentions
+# === {}[link:index.html"name="8.1] Histogram operations
+# ---
+# * GSL::Histogram#normalize
+#
+#   This methods scales the contents of the bins of histogram <tt>self</tt> by its
+#   maximum value.
+#
+# ---
+# * GSL::Histogram#rebin(m = 2)
+#
+#   This method creates a new histogram merging <tt>m</tt> bins in one in the
+#   histogram <tt>self</tt>. This method cannot be used for histograms of 
+#   non-uniform bin size. If <tt>m</tt> is not an exact divider of the number 
+#   of bins of <tt>self</tt>, the range of the rebinned histogram is extended
+#   not to lose the entries in the last <tt>m-1</tt> (at most) bins.
+#
+#   Example: a histogram <tt>h</tt> of size 5 with the range [0, 5), binned as
+#
+#       GSL::Histogram::Range: 
+#       [ 0.000e+00 1.000e+00 2.000e+00 3.000e+00 4.000e+00 5.000e+00 ]
+#       GSL::Histogram::Bin: 
+#       [ 0.000e+00 3.000e+00 1.000e+00 1.000e+00 3.000e+00 ]
+#  
+#   When a new histogram is created merging two bins into one as 
+#   <tt>h2 = h.rebin</tt>, then <tt>h2</tt> looks like
+#
+#       GSL::Histogram::Range: 
+#       [ 0.000e+00 2.000e+00 4.000e+00 6.000e+00 ]
+#       GSL::Histogram::Bin: 
+#       [ 3.000e+00 2.000e+00 3.000e+00 ]
+#
+# ---
+# * GSL::Histogram#reverse
+#
+#   This method create a new histogram reversing the order of the range and the bin of 
+#   histogram <tt>self</tt>.
+#   
+# ---
+# * GSL::Histogram#integrate(istart = 0, iend = n-1)
+# * GSL::Histogram#integrate([istart, iend])
+# * GSL::Histogram#integrate(direction = 1 or -1)
+#
+#   This method calculates cumulative counts of the histogram <tt>self</tt>
+#   from the <tt>istart</tt>-th bin to the <tt>iend</tt>-th bin (<tt>iend</tt> inclusive), 
+#   and returns a <tt>GSL::Histogram::Integral</tt> 
+#   object. If <tt>istart <= iend</tt> (or <tt>direction == 1</tt>), 
+#   the <tt>i</tt>-th bin value of a 
+#   <tt>GSL::Histogram::Integral</tt> object <tt>hi</tt> created from a 
+#   <tt>GSL::Histogram</tt> <tt>h</tt> is given by <tt>hi[i] = hi[i-1] + h[i]</tt>.
+#   If <tt>istart > iend</tt> (or <tt>direction == -1</tt>), <tt>hi[i] = hi[i+1] = h[i]</tt>.
+#
+# ---
+# * GSL::Histogram::Integral#differentiate
+# * GSL::Histogram::Integral#diff
+#
+# === {}[link:index.html"name="8.2] Graphics
+# ---
+# * GSL::Histogram#graph(options)
+#
+#   This method uses the GNU plotutils <tt>graph</tt> to draw the histogram <tt>self</tt>.
+#   The options as "-T X -C -l x" etc are given by a String.
+#
+# === {}[link:index.html"name="8.3] Fitting
+# ---
+# * GSL::Histogram#fit_exponential(binstart = 0, binend = n-1)
+#
+#   This method fits the histogram <tt>self</tt> to an exponential model 
+#   <tt>h[n] = a exp(b x[n])</tt> using  the bins of indices from <tt>binstart</tt> 
+#   to <tt>binend</tt>. The result is returned as an Array of 6 elements,
+#   <tt>[a, b, erra, errb, sumsq, dof]</tt>, where
+#   * <tt>a</tt>: scale factor
+#   * <tt>b</tt>: exponent
+#   * <tt>erra, errb</tt>: fitting errors
+#   * <tt>sumsq</tt>: fitting chi-squared (not reduced chi-squared)
+#   * <tt>dof</tt>: degree-of-freedom, the number of bins used minus the number of parameters (2)
+#
+# ---
+# * GSL::Histogram#fit_power(binstart = 0, binend = n-1)
+#
+#   This method fits the histogram <tt>self</tt> to a power-law model 
+#   <tt>h[n] = a x[n]^b</tt> using  the bins of indices from <tt>binstart</tt> 
+#   to <tt>binend</tt>. The result is returned as an Array of 6 elements,
+#   <tt>[a, b, erra, errb, sumsq, dof]</tt>.
+#
+# ---
+# * GSL::Histogram#fit_gaussian(binstart = 0, binend = n-1)
+#
+#   This method fits the histogram <tt>self</tt> to Gaussian distribution
+#   using the bins of indices from <tt>binstart</tt> to <tt>binend</tt>,
+#   and returns an Array of 8 elements, 
+#   <tt>[sigma, mean, height, errsig, errmean, errhei, sumsq, dof]</tt>. 
+#
+#   Example:
+#     #!/usr/bin/env ruby
+#     require("gsl")
+#
+#     N = 10000
+#     MAX = 8
+#     rng = Rng.alloc
+#
+#     data = Ran.gaussian(rng, 1.5, N) + 2
+#     h = Histogram.alloc(100, [-MAX, MAX])
+#     h.increment(data)
+#
+#     sigma, mean, height, = h.fit_gaussian
+#     x = Vector.linspace(-MAX, MAX, 100)
+#     y = height*Ran::gaussian_pdf(x-mean, sigma)
+#     GSL::graph(h, [x, y], "-T X -C -g 3")
+#
+# == {}[link:index.html"name="9] The histogram probability distribution
+# The probability distribution function for a histogram consists of a set of bins 
+# which measure the probability of an event falling into a given range of 
+# a continuous variable x. A probability distribution function is defined
+# by the following class, which actually stores the cumulative probability 
+# distribution function. This is the natural quantity for generating samples 
+# via the inverse transform method, because there is a one-to-one mapping 
+# between the cumulative probability distribution and the range [0,1]. 
+# It can be shown that by taking a uniform random number in this 
+# range and finding its corresponding coordinate in the cumulative probability 
+# distribution we obtain samples with the desired probability distribution.
+#
+# === {}[link:index.html"name="9.1] GSL::Histogram::Pdf class
+# ---
+# * GSL::Histogram::Pdf.alloc(n)
+# * GSL::Histogram::Pdf.alloc(h)
+#
+#   Constructors. If a histogram <tt>h</tt> is given, 
+#   the probability distribution is initialized with the contents of <tt>h</tt>.
+#
+# ---
+# * GSL::Histogram::Pdf#init(h)
+#
+#   This initializes the probability distribution <tt>self</tt> with the contents 
+#   of the histogram <tt>h</tt>. 
+#
+# ---
+# * GSL::Histogram::Pdf#sample(r)
+#
+#   This method uses <tt>r</tt>, a uniform random number between zero and one, 
+#   to compute a single random sample from the probability distribution <tt>self</tt>. 
+#   The algorithm used to compute the sample s is given by the following formula,
+#      s = range[i] + delta * (range[i+1] - range[i])
+#   where i is the index which satisfies 
+#   <tt>sum[i] <= r < sum[i+1]</tt> and <tt>delta</tt> is <tt>(r - sum[i])/(sum[i+1] - sum[i])</tt>.
+#
+# ---
+# * GSL::Histogram::Pdf#n
+#
+#   This returns the number of bins of the probability distribution function.
+#
+# ---
+# * GSL::Histogram:Pdf#range
+#
+#   This returns a <tt>Vector::View</tt> object as a reference to the pointer 
+#   <tt>double *range</tt> in the <tt>gsl_histogram_pdf</tt> struct.
+# ---
+# * GSL::Histogram:Pdf#sum
+#
+#   This returns a <tt>Vector::View</tt> object as a reference to the pointer 
+#   <tt>double *sum</tt> in the <tt>gsl_histogram_pdf</tt> struct.
+#
+# {prev}[link:files/rdoc/stats_rdoc.html]
+# {next}[link:files/rdoc/hist2d_rdoc.html]
+#
+# {Reference index}[link:files/rdoc/ref_rdoc.html]
+# {top}[link:files/rdoc/index_rdoc.html]
+#
+#

data/rdoc/hist2d.rdoc

@@ -0,0 +1,279 @@
+#
+# = GSL::Histogram2d class
+#
+# == {}[link:index.html"name="1] Class methods
+# ---
+# * GSL::Histogram2d.alloc(nx, ny)
+# * GSL::Histogram2d.alloc(xrange, yrange)
+# * GSL::Histogram2d.alloc(nx, xmin, xmax, ny, ymin, ymax)
+# * GSL::Histogram2d.alloc(nx, [xmin, xmax], ny, [ymin, ymax])
+#
+#   Constructors.
+#
+#   1. With sizes
+#         >> h2 = GSL::Histogram2d.alloc(2, 3)  # size 6
+#         >> h2.xrange
+#         => GSL::Histogram::Range: 
+#         [ 0.000e+00 1.000e+00 2.000e+00 ]
+#         >> h2.yrange
+#         => GSL::Histogram::Range: 
+#         [ 0.000e+00 1.000e+00 2.000e+00 3.000e+00 ]
+#         >> h2.bin
+#         => GSL::Histogram::Bin: 
+#         [ 0.000e+00 0.000e+00 0.000e+00 0.000e+00 0.000e+00 0.000e+00 ]
+#         >> h2.xrange.class.superclass
+#         => GSL::Vector::View::ReadOnly
+#         >> h2.bin.class.superclass
+#         => GSL::Vector::View::ReadOnly
+#
+#   1. With ranges
+#          >> h2 = Histogram2d.alloc([3, 6, 7], [2, 3, 8])
+#          >> h2.xrange
+#          => GSL::Histogram::Range: 
+#          [ 3.000e+00 6.000e+00 7.000e+00 ]
+#          >> h2.yrange
+#          => GSL::Histogram::Range: 
+#          [ 2.000e+00 3.000e+00 8.000e+00 ]
+#          >> h2.bin
+#          => GSL::Histogram::Bin: 
+#          [ 0.000e+00 0.000e+00 0.000e+00 0.000e+00 ]
+#
+#   1. With sizes and ranges
+#          >> h2 = Histogram2d.alloc(4, [0, 4], 3, [1, 5])
+#          >> h2.xrange
+#          => GSL::Histogram::Range: 
+#          [ 0.000e+00 1.000e+00 2.000e+00 3.000e+00 4.000e+00 ]
+#          >> h2.yrange
+#          => GSL::Histogram::Range: 
+#          [ 1.000e+00 2.333e+00 3.667e+00 5.000e+00 ]
+#
+# ---
+# * GSL::Histogram2d.alloc_uniform(nx, xmin, xmax, ny, ymin, ymax)
+# * GSL::Histogram2d.equal_bins_p(h1, h2)
+#
+#
+# == {}[link:index.html"name="2] Methods
+# ---
+# * GSL::Histogram2d#set_ranges(vx, vy)
+#
+#   This sets the ranges of the existing histogram using 
+#   two {GSL::Vector}[link:files/rdoc/vector_rdoc.html] objects or arrays.
+# ---
+# * GSL::Histogram2d#set_ranges_uniform(xmin, xmax, ymin, ymax)
+# * GSL::Histogram2d#set_ranges_uniform([xmin, xmax], [ymin, ymax])
+#
+#   This sets the ranges of the existing histogram <tt>self</tt> to cover 
+#   the ranges <tt>xmin</tt> to <tt>xmax</tt> and <tt>ymin</tt> to <tt>ymax</tt> uniformly. 
+#   The values of the histogram bins are reset to zero.
+#
+# ---
+# * GSL::Histogram2d#clone
+# * GSL::Histogram2d#duplicate
+#
+#   Returns a newly created histogram which is an exact copy of the 
+#   histogram <tt>self</tt>.
+#
+# ---
+# * GSL::Histogram2d#increment(x, y, weight = 1)
+# * GSL::Histogram2d#accumulate(x, y, weight = 1)
+# * GSL::Histogram2d#fill(x, y, weight = 1)
+#
+#   These method update the histogram <tt>self</tt> by adding <tt>weight</tt> 
+#   to the bin whose <tt>x</tt> and <tt>y</tt> ranges contain the coordinates (x,y).
+#   If (x,y) lies outside the limits of the histogram then none of the 
+#   bins are modified. 
+#
+# ---
+# * GSL::Histogram2d#increment2(x, y, weight = 1)
+# * GSL::Histogram2d#accumulate2(x, y, weight = 1)
+# * GSL::Histogram2d#fill2(x, y, weight = 1)
+#
+#   These are similar to <tt>GSL::Histogram#increment/accumulate/fill</tt>,
+#   but when (x,y) lies outside the limits of the histogram then the edge
+#   bin is incremented.
+#
+# ---
+# * GSL::Histogram2d#get(i[, j])
+# * GSL::Histogram2d#get([i, j])
+# * GSL::Histogram2d#[i, j]
+#
+#   Return the contents of the <tt>(i,j)</tt>-th bin of the histogram <tt>self</tt>. 
+#
+# ---
+# * GSL::Histogram2d#get_xrange(i)
+# * GSL::Histogram2d#get_yrange(j)
+#
+#   These methods find the upper and lower range limits of the <tt>i</tt>-th 
+#   and <tt>j</tt>-th bins in the x and y directions of the histogram <tt>self</tt>.
+#
+#   Ex: 
+#      >> h2 = Histogram2d.alloc(2, [0, 2], 3, [1, 4])
+#      >> h2.get_xrange(1)
+#      => [1.0, 2.0]
+#      >> h2.get_yrange(1)
+#      => [2.0, 3.0]
+#
+# ---
+# * GSL::Histogram2d#xrange
+# * GSL::Histogram2d#yrange
+#
+#   These methods returns the range of histogram as <tt>Vector::View</tt> objects.
+#
+# ---
+# * GSL::Histogram2d#xmax
+# * GSL::Histogram2d#xmin
+# * GSL::Histogram2d#ymax
+# * GSL::Histogram2d#ymin
+# * GSL::Histogram2d#nx
+# * GSL::Histogram2d#ny
+#
+#   These methodss return the maximum upper and minimum lower range limits 
+#   and the number of bins for the x and y directions of the histogram <tt>self</tt>.
+#
+# ---
+# * GSL::Histogram2d#reset
+#
+#   Resets all the bins of the histogram <tt>self</tt> to zero.
+#
+# ---
+# * GSL::Histogram2d#find(x, y)
+#
+#   Finds the indices i and j to the to the bin which covers the 
+#   coordinates (<tt>x,y</tt>).
+#
+# ---
+# * GSL::Histogram2d#max_val
+#
+#   Returns the maximum value contained in the histogram bins.
+#
+# ---
+# * GSL::Histogram2d#max_bin
+#
+#   Returns the indices (i,j) of the bin containing the maximum value in 
+#   the histogram <tt>self</tt>.
+#
+# ---
+# * GSL::Histogram2d#min_val
+#
+#   Returns the minimum value contained in the histogram bins.
+# ---
+# * GSL::Histogram2d#min_bin
+#
+#   Returns the indices (i,j) of the bin containing the minimum value
+#   in the histogram <tt>self</tt>.
+#
+# ---
+# * GSL::Histogram2d#xmean
+#
+#   Returns the mean of the histogrammed x variable, where the histogram 
+#   is regarded as a probability distribution. 
+#   Negative bin values are ignored for the purposes of this calculation.
+#
+# ---
+# * GSL::Histogram2d#xsigma
+#
+#   Returns the standard deviation of the histogrammed x variable, 
+#   where the histogram is regarded as a probability distribution. 
+#   Negative bin values are ignored for the purposes of this calculation.
+#
+# ---
+# * GSL::Histogram2d#ymean
+#
+#   Returns the mean of the histogrammed y variable, where the histogram 
+#   is regarded as a probability distribution. Negative bin values are 
+#   ignored for the purposes of this calculation.
+#
+# ---
+# * GSL::Histogram2d#ysigma
+#
+#   Returns the standard deviation of the histogrammed y variable, 
+#   where the histogram is regarded as a probability distribution. 
+#   Negative bin values are ignored for the purposes of this calculation.
+#
+# ---
+# * GSL::Histogram2d#cov
+#
+#   Returns the covariance of the histogrammed x and y variables, 
+#   where the histogram is regarded as a probability distribution. 
+#   Negative bin values are ignored for the purposes of this calculation.
+#
+# ---
+# * GSL::Histogram2d#sum
+# * GSL::Histogram2d#integral
+#
+#   Return the sum of all bin values. Negative bin values are included in the sum.
+# ---
+# * GSL::Histogram2d#add
+# * GSL::Histogram2d#sub
+# * GSL::Histogram2d#mul
+# * GSL::Histogram2d#div
+# * GSL::Histogram2d#scale(val)
+# * GSL::Histogram2d#shift(val)
+# * GSL::Histogram2d#fwrite(io)
+# * GSL::Histogram2d#fwrite(filename)
+# * GSL::Histogram2d#fread(io)
+# * GSL::Histogram2d#fread(filename)
+# * GSL::Histogram2d#fprintf(io, range_format, bin_format)
+# * GSL::Histogram2d#fprintf(filename, range_format, bin_format)
+# * GSL::Histogram2d#fscanf(io)
+# * GSL::Histogram2d#fscanf(filename)
+#
+#
+# ---
+# * GSL::Histogram2d#xproject(jstart = 0, jend = ny-1)
+#
+#   Creates a <tt>GSL::Histogram</tt> object by projecting the 2D histogram 
+#   <tt>self</tt> onto the x-axis over the y-range from <tt>jstart</tt> to <tt>jend</tt>.
+#
+# ---
+# * GSL::Histogram2d#yproject(istart = 0, iend = nx-1)
+#
+#   Creates a <tt>GSL::Histogram</tt> object by projecting the 2D histogram 
+#   <tt>self</tt> onto the y-axis over the x-range from <tt>istart</tt> to <tt>iend</tt>.
+#
+# == {}[link:index.html"name="3] GSL::Histogram2d::Pdf class
+# ---
+# * GSL::Histogram2d::Pdf.alloc(nx, ny)
+#
+#   Constructors
+#
+# ---
+# * GSL::Histogram2d::Pdf#init(h)
+#
+#   Initializer with a GSL::Histogram2d object <tt>h</tt>.
+#
+# ---
+# * GSL::Histogram2d::Pdf#sample(r1, r2)
+#
+#
+# == {}[link:index.html"name="4] Example
+#   #!/usr/bin/env ruby
+#   require("gsl")
+#
+#   N = 10000
+#   BINS = 100
+#
+#   rng = Rng.new(2)
+#   h2 = Histogram2d.alloc(BINS, [-5, 5], BINS, [-8, 8])
+#
+#   sig1 = 1.0
+#   sig2 = 2.0
+#
+#   for i in 0...N do
+#     r1 = rng.gaussian(sig1)
+#     r2 = rng.gaussian(sig2)
+#     h2.increment(r1, r2)
+#   end
+#
+#   hx = h2.xproject
+#   hy = h2.yproject
+#   printf("%f %f %f %f\n", h2.xsigma, h2.ysigma, hx.sigma, hy.sigma)
+#   GSL::graph(hx, hy, "-T X -C -g 3")
+#
+#
+# {prev}[link:files/rdoc/hist_rdoc.html]
+# {next}[link:files/rdoc/hist3d_rdoc.html]
+#
+# {Reference index}[link:files/rdoc/ref_rdoc.html]
+# {top}[link:files/rdoc/index_rdoc.html]
+#