<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libstdc++: std::student_t_distribution< _RealType > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libstdc++</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00702.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">std::student_t_distribution< _RealType > Class Template Reference<div class="ingroups"><a class="el" href="a01209.html">Normal Distributions</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="std::student_t_distribution" -->
<p>A <a class="el" href="a00702.html" title="A student_t_distribution random number distribution.">student_t_distribution</a> random number distribution.
<a href="a00702.html#details">More...</a></p>
<p><a href="a02382.html">List of all members.</a></p>
<h2><a name="nested-classes"></a>
Classes</h2>
<ul>
<li>struct <a class="el" href="a00703.html">param_type</a>
</ul>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef _RealType <a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="anchor" id="a07ce60b736661c608b2a30278c33478c"></a><!-- doxytag: member="std::student_t_distribution::student_t_distribution" ref="a07ce60b736661c608b2a30278c33478c" args="(_RealType __n=_RealType(1))" -->
<b>student_t_distribution</b> (_RealType __n=_RealType(1))
<li><a class="anchor" id="affc6becf5b178a8a634a64de7eb04c69"></a><!-- doxytag: member="std::student_t_distribution::student_t_distribution" ref="affc6becf5b178a8a634a64de7eb04c69" args="(const param_type &__p)" -->
<b>student_t_distribution</b> (const <a class="el" href="a00703.html">param_type</a> &__p)
<li><a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <a class="el" href="a00702.html#a3853d0609b7215cc787101a32e44c23a">max</a> () const
<li><a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <a class="el" href="a00702.html#abbd8667d22e376bb2bfb3164f5285426">min</a> () const
<li><a class="anchor" id="a02dcdcfb3f5f78642e85fc5610deb0ec"></a><!-- doxytag: member="std::student_t_distribution::n" ref="a02dcdcfb3f5f78642e85fc5610deb0ec" args="() const " -->
_RealType <b>n</b> () const
<li>template<typename _UniformRandomNumberGenerator > <a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <a class="el" href="a00702.html#afe23bf7d575d480b30d2e80bb7f93176">operator()</a> (_UniformRandomNumberGenerator &__urng)
<li><a class="anchor" id="ae4fc73a9634cc98797dace982698f570"></a><!-- doxytag: member="std::student_t_distribution::operator()" ref="ae4fc73a9634cc98797dace982698f570" args="(_UniformRandomNumberGenerator &__urng, const param_type &__p)" -->
template<typename _UniformRandomNumberGenerator > <a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <b>operator()</b> (_UniformRandomNumberGenerator &__urng, const <a class="el" href="a00703.html">param_type</a> &__p)
<li>void <a class="el" href="a00702.html#a1419abb07831366ab3d01907a8057427">param</a> (const <a class="el" href="a00703.html">param_type</a> &__param)
<li><a class="el" href="a00703.html">param_type</a> <a class="el" href="a00702.html#af87b20a25d984ab07aa6d9c7b284adcb">param</a> () const
<li>void <a class="el" href="a00702.html#a48d5f501c9847b3688480efece2a0f8c">reset</a> ()
</ul>
<h2><a name="friends"></a>
Friends</h2>
<ul>
<li>template<typename _RealType1 , typename _CharT , typename _Traits > <a class="el" href="a00251.html">std::basic_ostream</a>< _CharT, <br class="typebreak"/>
_Traits > & <a class="el" href="a00702.html#ad29a3f74ae29cde7e5e51ad78c48963f">operator<<</a> (<a class="el" href="a00251.html">std::basic_ostream</a>< _CharT, _Traits > &, const <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > &)
<li>template<typename _RealType1 > bool <a class="el" href="a00702.html#afa74db215277ec8f06fbbacf09fa465f">operator==</a> (const <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > &__d1, const <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > &__d2)
<li>template<typename _RealType1 , typename _CharT , typename _Traits > <a class="el" href="a00250.html">std::basic_istream</a>< _CharT, <br class="typebreak"/>
_Traits > & <a class="el" href="a00702.html#abd7c21f62299e7771cda90646a9260bd">operator>></a> (<a class="el" href="a00250.html">std::basic_istream</a>< _CharT, _Traits > &, <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > &)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename _RealType = double><br/>
class std::student_t_distribution< _RealType ></h3>
<p>A <a class="el" href="a00702.html" title="A student_t_distribution random number distribution.">student_t_distribution</a> random number distribution. </p>
<p>The formula for the normal probability mass function is: </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ p(x|n) = \frac{1}{\sqrt(n\pi)} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)} (1 + \frac{x^2}{n}) ^{-(n+1)/2} \]" src="form_12.png"/>
</p>
<p>Definition at line <a class="el" href="a00997_source.html#l03043">3043</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a63439550169b26a1333639493db44e3b"></a><!-- doxytag: member="std::student_t_distribution::result_type" ref="a63439550169b26a1333639493db44e3b" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname">typedef _RealType <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::<a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The type of the range of the distribution. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03050">3050</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3853d0609b7215cc787101a32e44c23a"></a><!-- doxytag: member="std::student_t_distribution::max" ref="a3853d0609b7215cc787101a32e44c23a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::max </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the least upper bound value of the distribution. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03126">3126</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="abbd8667d22e376bb2bfb3164f5285426"></a><!-- doxytag: member="std::student_t_distribution::min" ref="abbd8667d22e376bb2bfb3164f5285426" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::min </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the greatest lower bound value of the distribution. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03119">3119</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="afe23bf7d575d480b30d2e80bb7f93176"></a><!-- doxytag: member="std::student_t_distribution::operator()" ref="afe23bf7d575d480b30d2e80bb7f93176" args="(_UniformRandomNumberGenerator &__urng)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<div class="memtemplate">
template<typename _UniformRandomNumberGenerator > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00702.html#a63439550169b26a1333639493db44e3b">result_type</a> <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::operator() </td>
<td>(</td>
<td class="paramtype">_UniformRandomNumberGenerator & </td>
<td class="paramname"><em>__urng</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generating functions. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03134">3134</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
<p>References <a class="el" href="a00812_source.html#l00893">std::sqrt()</a>.</p>
</div>
</div>
<a class="anchor" id="af87b20a25d984ab07aa6d9c7b284adcb"></a><!-- doxytag: member="std::student_t_distribution::param" ref="af87b20a25d984ab07aa6d9c7b284adcb" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00703.html">param_type</a> <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::param </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the parameter set of the distribution. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03104">3104</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1419abb07831366ab3d01907a8057427"></a><!-- doxytag: member="std::student_t_distribution::param" ref="a1419abb07831366ab3d01907a8057427" args="(const param_type &__param)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::param </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00703.html">param_type</a> & </td>
<td class="paramname"><em>__param</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the parameter set of the distribution. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">__param</td><td>The new parameter set of the distribution. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00997_source.html#l03112">3112</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="a48d5f501c9847b3688480efece2a0f8c"></a><!-- doxytag: member="std::student_t_distribution::reset" ref="a48d5f501c9847b3688480efece2a0f8c" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType >::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the distribution state. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03087">3087</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
<p>References <a class="el" href="a00997_source.html#l02398">std::gamma_distribution< _RealType >::reset()</a>, and <a class="el" href="a00997_source.html#l02031">std::normal_distribution< _RealType >::reset()</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ad29a3f74ae29cde7e5e51ad78c48963f"></a><!-- doxytag: member="std::student_t_distribution::operator<<" ref="ad29a3f74ae29cde7e5e51ad78c48963f" args="(std::basic_ostream< _CharT, _Traits > &, const std::student_t_distribution< _RealType1 > &)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<div class="memtemplate">
template<typename _RealType1 , typename _CharT , typename _Traits > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00251.html">std::basic_ostream</a><_CharT, _Traits>& operator<< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00251.html">std::basic_ostream</a>< _CharT, _Traits > & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > & </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts a student_t_distribution random number distribution <code>__x</code> into the output stream <code>__os</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">__os</td><td>An output stream. </td></tr>
<tr><td class="paramname">__x</td><td>A student_t_distribution random number distribution.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The output stream with the state of <code>__x</code> inserted or in an error state. </dd></dl>
</div>
</div>
<a class="anchor" id="afa74db215277ec8f06fbbacf09fa465f"></a><!-- doxytag: member="std::student_t_distribution::operator==" ref="afa74db215277ec8f06fbbacf09fa465f" args="(const std::student_t_distribution< _RealType1 > &__d1, const std::student_t_distribution< _RealType1 > &__d2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<div class="memtemplate">
template<typename _RealType1 > </div>
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > & </td>
<td class="paramname"><em>__d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > & </td>
<td class="paramname"><em>__d2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if two Student t distributions have the same parameters and the sequences that would be generated are equal. </p>
<p>Definition at line <a class="el" href="a00997_source.html#l03156">3156</a> of file <a class="el" href="a00997_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="abd7c21f62299e7771cda90646a9260bd"></a><!-- doxytag: member="std::student_t_distribution::operator>>" ref="abd7c21f62299e7771cda90646a9260bd" args="(std::basic_istream< _CharT, _Traits > &, std::student_t_distribution< _RealType1 > &)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<div class="memtemplate">
template<typename _RealType1 , typename _CharT , typename _Traits > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00250.html">std::basic_istream</a><_CharT, _Traits>& operator>> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00250.html">std::basic_istream</a>< _CharT, _Traits > & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00702.html">std::student_t_distribution</a>< _RealType1 > & </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts a student_t_distribution random number distribution <code>__x</code> from the input stream <code>__is</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">__is</td><td>An input stream. </td></tr>
<tr><td class="paramname">__x</td><td>A student_t_distribution random number generator engine.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The input stream with <code>__x</code> extracted or in an error state. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00997_source.html">random.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a01137.html">std</a> </li>
<li class="navelem"><a class="el" href="a00702.html">student_t_distribution</a> </li>
<li class="footer">Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
</body>
</html>
