gsl-ocaml / doc / Gsl_histo.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Gsl_odeiv.html">
<link rel="next" href="Gsl_stats.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Gsl_error" rel="Chapter" href="Gsl_error.html">
<link title="Gsl_ieee" rel="Chapter" href="Gsl_ieee.html">
<link title="Gsl_math" rel="Chapter" href="Gsl_math.html">
<link title="Gsl_complex" rel="Chapter" href="Gsl_complex.html">
<link title="Gsl_vector" rel="Chapter" href="Gsl_vector.html">
<link title="Gsl_vector_flat" rel="Chapter" href="Gsl_vector_flat.html">
<link title="Gsl_vector_complex" rel="Chapter" href="Gsl_vector_complex.html">
<link title="Gsl_vector_complex_flat" rel="Chapter" href="Gsl_vector_complex_flat.html">
<link title="Gsl_matrix" rel="Chapter" href="Gsl_matrix.html">
<link title="Gsl_matrix_flat" rel="Chapter" href="Gsl_matrix_flat.html">
<link title="Gsl_matrix_complex" rel="Chapter" href="Gsl_matrix_complex.html">
<link title="Gsl_matrix_complex_flat" rel="Chapter" href="Gsl_matrix_complex_flat.html">
<link title="Gsl_vectmat" rel="Chapter" href="Gsl_vectmat.html">
<link title="Gsl_blas" rel="Chapter" href="Gsl_blas.html">
<link title="Gsl_blas_flat" rel="Chapter" href="Gsl_blas_flat.html">
<link title="Gsl_blas_gen" rel="Chapter" href="Gsl_blas_gen.html">
<link title="Gsl_fun" rel="Chapter" href="Gsl_fun.html">
<link title="Gsl_permut" rel="Chapter" href="Gsl_permut.html">
<link title="Gsl_sort" rel="Chapter" href="Gsl_sort.html">
<link title="Gsl_linalg" rel="Chapter" href="Gsl_linalg.html">
<link title="Gsl_eigen" rel="Chapter" href="Gsl_eigen.html">
<link title="Gsl_poly" rel="Chapter" href="Gsl_poly.html">
<link title="Gsl_interp" rel="Chapter" href="Gsl_interp.html">
<link title="Gsl_rng" rel="Chapter" href="Gsl_rng.html">
<link title="Gsl_qrng" rel="Chapter" href="Gsl_qrng.html">
<link title="Gsl_randist" rel="Chapter" href="Gsl_randist.html">
<link title="Gsl_integration" rel="Chapter" href="Gsl_integration.html">
<link title="Gsl_fit" rel="Chapter" href="Gsl_fit.html">
<link title="Gsl_multifit" rel="Chapter" href="Gsl_multifit.html">
<link title="Gsl_multifit_nlin" rel="Chapter" href="Gsl_multifit_nlin.html">
<link title="Gsl_root" rel="Chapter" href="Gsl_root.html">
<link title="Gsl_multiroot" rel="Chapter" href="Gsl_multiroot.html">
<link title="Gsl_min" rel="Chapter" href="Gsl_min.html">
<link title="Gsl_multimin" rel="Chapter" href="Gsl_multimin.html">
<link title="Gsl_diff" rel="Chapter" href="Gsl_diff.html">
<link title="Gsl_cheb" rel="Chapter" href="Gsl_cheb.html">
<link title="Gsl_sum" rel="Chapter" href="Gsl_sum.html">
<link title="Gsl_fft" rel="Chapter" href="Gsl_fft.html">
<link title="Gsl_monte" rel="Chapter" href="Gsl_monte.html">
<link title="Gsl_siman" rel="Chapter" href="Gsl_siman.html">
<link title="Gsl_odeiv" rel="Chapter" href="Gsl_odeiv.html">
<link title="Gsl_histo" rel="Chapter" href="Gsl_histo.html">
<link title="Gsl_stats" rel="Chapter" href="Gsl_stats.html">
<link title="Gsl_wavelet" rel="Chapter" href="Gsl_wavelet.html">
<link title="Gsl_bspline" rel="Chapter" href="Gsl_bspline.html">
<link title="Gsl_const" rel="Chapter" href="Gsl_const.html">
<link title="Gsl_sf" rel="Chapter" href="Gsl_sf.html">
<link title="Gsl_cdf" rel="Chapter" href="Gsl_cdf.html"><link title="Allocating histograms" rel="Section" href="#3_Allocatinghistograms">
<link title="Updating and accessing histogram elements" rel="Section" href="#3_Updatingandaccessinghistogramelements">
<link title="Searching histogram ranges" rel="Section" href="#3_Searchinghistogramranges">
<link title="Histograms statistics " rel="Section" href="#3_Histogramsstatistics">
<link title="Histogram operations" rel="Section" href="#3_Histogramoperations">
<link title="Resampling" rel="Section" href="#3_Resampling">
<title>ocamlgsl 0.6.0 : Gsl_histo</title>
</head>
<body>
<div class="navbar"><a href="Gsl_odeiv.html">Previous</a>
&nbsp;<a href="index.html">Up</a>
&nbsp;<a href="Gsl_stats.html">Next</a>
</div>
<center><h1>Module <a href="type_Gsl_histo.html">Gsl_histo</a></h1></center>
<br>
<pre><span class="keyword">module</span> Gsl_histo: <code class="code">sig</code> <a href="Gsl_histo.html">..</a> <code class="code">end</code></pre>Histograms<br>
<hr width="100%">
<br><code><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t = private {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>n&nbsp;: <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >number of histogram bins</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>range&nbsp;: <code class="type">float array</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >ranges of the bins ; n+1 elements</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>bin&nbsp;: <code class="type">float array</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >counts for each bin ; n elements</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}

<div class="info">
The histogram type<br>
</div>

<pre><span class="keyword">val</span> <a name="VALcheck"></a>check : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> bool</code></pre><br>
<a name="3_Allocatinghistograms"></a>
<h3>Allocating histograms</h3><br>
<pre><span class="keyword">val</span> <a name="VALmake"></a>make : <code class="type">int -> <a href="Gsl_histo.html#TYPEt">t</a></code></pre><pre><span class="keyword">val</span> <a name="VALcopy"></a>copy : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEt">t</a></code></pre><pre><span class="keyword">val</span> <a name="VALset_ranges"></a>set_ranges : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float array -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALset_ranges_uniform"></a>set_ranges_uniform : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> xmin:float -> xmax:float -> unit</code></pre><br>
<a name="3_Updatingandaccessinghistogramelements"></a>
<h3>Updating and accessing histogram elements</h3><br>
<pre><span class="keyword">val</span> <a name="VALaccumulate"></a>accumulate : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> ?w:float -> float -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALget"></a>get : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> int -> float</code></pre><pre><span class="keyword">val</span> <a name="VALget_range"></a>get_range : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> int -> float * float</code></pre><pre><span class="keyword">val</span> <a name="VALh_max"></a>h_max : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><pre><span class="keyword">val</span> <a name="VALh_min"></a>h_min : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><pre><span class="keyword">val</span> <a name="VALbins"></a>bins : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALreset"></a>reset : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> unit</code></pre><br>
<a name="3_Searchinghistogramranges"></a>
<h3>Searching histogram ranges</h3><br>
<pre><span class="keyword">val</span> <a name="VALfind"></a>find : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float -> int</code></pre><br>
<a name="3_Histogramsstatistics"></a>
<h3>Histograms statistics </h3><br>
<pre><span class="keyword">val</span> <a name="VALmax_val"></a>max_val : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><pre><span class="keyword">val</span> <a name="VALmax_bin"></a>max_bin : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALmin_val"></a>min_val : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><pre><span class="keyword">val</span> <a name="VALmin_bin"></a>min_bin : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALmean"></a>mean : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><pre><span class="keyword">val</span> <a name="VALsigma"></a>sigma : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><pre><span class="keyword">val</span> <a name="VALsum"></a>sum : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float</code></pre><br>
<a name="3_Histogramoperations"></a>
<h3>Histogram operations</h3><br>
<pre><span class="keyword">val</span> <a name="VALequal_bins_p"></a>equal_bins_p : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEt">t</a> -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALadd"></a>add : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEt">t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEt">t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmul"></a>mul : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEt">t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALdiv"></a>div : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEt">t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALscale"></a>scale : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALshift"></a>shift : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> float -> unit</code></pre><br>
<a name="3_Resampling"></a>
<h3>Resampling</h3><br>
<br><code><span class="keyword">type</span> <a name="TYPEhisto_pdf"></a><code class="type"></code>histo_pdf = private {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>pdf_n&nbsp;: <code class="type">int</code>;</code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>pdf_range&nbsp;: <code class="type">float array</code>;</code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>pdf_sum&nbsp;: <code class="type">float array</code>;</code></td>

</tr></table>
}


<pre><span class="keyword">val</span> <a name="VALinit"></a>init : <code class="type"><a href="Gsl_histo.html#TYPEt">t</a> -> <a href="Gsl_histo.html#TYPEhisto_pdf">histo_pdf</a></code></pre><pre><span class="keyword">val</span> <a name="VALsample"></a>sample : <code class="type"><a href="Gsl_histo.html#TYPEhisto_pdf">histo_pdf</a> -> float -> float</code></pre></body></html>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.