<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>libstdc++: std::chi_squared_distribution< _RealType > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a00607.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> | <a href="a02784.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::chi_squared_distribution< _RealType > Class Template Reference<div class="ingroups"><a class="el" href="a01688.html">Normal Distributions</a></div></div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00608.html">param_type</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:add3353e1e6f35655c681fe7de51ec8c1"><td class="memItemLeft" align="right" valign="top">typedef _RealType </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a></td></tr> <tr class="separator:add3353e1e6f35655c681fe7de51ec8c1"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:adcc6f18f7ae226e199de38593ac6f847"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcc6f18f7ae226e199de38593ac6f847"></a>  </td><td class="memItemRight" valign="bottom"><b>chi_squared_distribution</b> (_RealType __n=_RealType(1))</td></tr> <tr class="separator:adcc6f18f7ae226e199de38593ac6f847"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa580579d202642a0e5ff0ea1eb9c8e0e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa580579d202642a0e5ff0ea1eb9c8e0e"></a>  </td><td class="memItemRight" valign="bottom"><b>chi_squared_distribution</b> (const <a class="el" href="a00608.html">param_type</a> &__p)</td></tr> <tr class="separator:aa580579d202642a0e5ff0ea1eb9c8e0e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afa8480edb5ca6ee6cb730c49e3be72a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#afa8480edb5ca6ee6cb730c49e3be72a3">max</a> () const </td></tr> <tr class="separator:afa8480edb5ca6ee6cb730c49e3be72a3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab5b9de588c36c029fbdd6866ba817788"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#ab5b9de588c36c029fbdd6866ba817788">min</a> () const </td></tr> <tr class="separator:ab5b9de588c36c029fbdd6866ba817788"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a121516be31436ba471ab0a71e95f6350"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a121516be31436ba471ab0a71e95f6350"></a> _RealType </td><td class="memItemRight" valign="bottom"><b>n</b> () const </td></tr> <tr class="separator:a121516be31436ba471ab0a71e95f6350"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2ddd460528095405f9ee56cf681f306a"><td class="memTemplParams" colspan="2">template<typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:a2ddd460528095405f9ee56cf681f306a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00607.html#a2ddd460528095405f9ee56cf681f306a">operator()</a> (_UniformRandomNumberGenerator &__urng)</td></tr> <tr class="separator:a2ddd460528095405f9ee56cf681f306a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a43fae110de74440343f47f13ff9a0e67"><td class="memTemplParams" colspan="2"><a class="anchor" id="a43fae110de74440343f47f13ff9a0e67"></a> template<typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:a43fae110de74440343f47f13ff9a0e67"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><b>operator()</b> (_UniformRandomNumberGenerator &__urng, const <a class="el" href="a00608.html">param_type</a> &__p)</td></tr> <tr class="separator:a43fae110de74440343f47f13ff9a0e67"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8bef048320cde83530cbbd57c6b3ed9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00608.html">param_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#a8bef048320cde83530cbbd57c6b3ed9d">param</a> () const </td></tr> <tr class="separator:a8bef048320cde83530cbbd57c6b3ed9d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa17c3dc11719efd80ca2aefee1a07044"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#aa17c3dc11719efd80ca2aefee1a07044">param</a> (const <a class="el" href="a00608.html">param_type</a> &__param)</td></tr> <tr class="separator:aa17c3dc11719efd80ca2aefee1a07044"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a97c1963c5d5cab27292ba7233cb54b5e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#a97c1963c5d5cab27292ba7233cb54b5e">reset</a> ()</td></tr> <tr class="separator:a97c1963c5d5cab27292ba7233cb54b5e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:aebe1b72f5b814d959f807aaaf5e6319e"><td class="memTemplParams" colspan="2">template<typename _RealType1 , typename _CharT , typename _Traits > </td></tr> <tr class="memitem:aebe1b72f5b814d959f807aaaf5e6319e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00432.html">std::basic_ostream</a>< _CharT, <br class="typebreak"/> _Traits > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00607.html#aebe1b72f5b814d959f807aaaf5e6319e">operator<<</a> (<a class="el" href="a00432.html">std::basic_ostream</a>< _CharT, _Traits > &__os, const <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType1 > &__x)</td></tr> <tr class="separator:aebe1b72f5b814d959f807aaaf5e6319e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a691feda4d6a0dec975dbe07c838768b6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00607.html#a691feda4d6a0dec975dbe07c838768b6">operator==</a> (const <a class="el" href="a00607.html">chi_squared_distribution</a> &__d1, const <a class="el" href="a00607.html">chi_squared_distribution</a> &__d2)</td></tr> <tr class="separator:a691feda4d6a0dec975dbe07c838768b6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5c7725e75b4c3fec1a13c3258ceaa6bc"><td class="memTemplParams" colspan="2">template<typename _RealType1 , typename _CharT , typename _Traits > </td></tr> <tr class="memitem:a5c7725e75b4c3fec1a13c3258ceaa6bc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00431.html">std::basic_istream</a>< _CharT, <br class="typebreak"/> _Traits > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00607.html#a5c7725e75b4c3fec1a13c3258ceaa6bc">operator>></a> (<a class="el" href="a00431.html">std::basic_istream</a>< _CharT, _Traits > &__is, <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType1 > &__x)</td></tr> <tr class="separator:a5c7725e75b4c3fec1a13c3258ceaa6bc"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename _RealType = double><br/> class std::chi_squared_distribution< _RealType ></h3> <p>A <a class="el" href="a00607.html" title="A chi_squared_distribution random number distribution.">chi_squared_distribution</a> random number distribution. </p> <p>The formula for the normal probability mass function is <img class="formulaInl" alt="$p(x|n) = \frac{x^{(n/2) - 1}e^{-x/2}}{\Gamma(n/2) 2^{n/2}}$" src="form_9.png"/> </p> <p>Definition at line <a class="el" href="a01395_source.html#l02527">2527</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="add3353e1e6f35655c681fe7de51ec8c1"></a> <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="a00607.html">std::chi_squared_distribution</a>< _RealType >::<a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">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="a01395_source.html#l02530">2530</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="afa8480edb5ca6ee6cb730c49e3be72a3"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType >::max </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </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="a01395_source.html#l02607">2607</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> <p>References <a class="el" href="a01279_source.html#l00313">std::numeric_limits< _Tp >::max()</a>.</p> </div> </div> <a class="anchor" id="ab5b9de588c36c029fbdd6866ba817788"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType >::min </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </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="a01395_source.html#l02600">2600</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div> </div> <a class="anchor" id="a2ddd460528095405f9ee56cf681f306a"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <div class="memtemplate"> template<typename _UniformRandomNumberGenerator > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00607.html#add3353e1e6f35655c681fe7de51ec8c1">result_type</a> <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType >::operator() </td> <td>(</td> <td class="paramtype">_UniformRandomNumberGenerator & </td> <td class="paramname"><em>__urng</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Generating functions. </p> <p>Definition at line <a class="el" href="a01395_source.html#l02615">2615</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div> </div> <a class="anchor" id="a8bef048320cde83530cbbd57c6b3ed9d"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00608.html">param_type</a> <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType >::param </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the parameter set of the distribution. </p> <p>Definition at line <a class="el" href="a01395_source.html#l02585">2585</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div> </div> <a class="anchor" id="aa17c3dc11719efd80ca2aefee1a07044"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType >::param </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00608.html">param_type</a> & </td> <td class="paramname"><em>__param</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the parameter set of the distribution. </p> <dl class="params"><dt>Parameters</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="a01395_source.html#l02593">2593</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div> </div> <a class="anchor" id="a97c1963c5d5cab27292ba7233cb54b5e"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType >::reset </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Resets the distribution state. </p> <p>Definition at line <a class="el" href="a01395_source.html#l02571">2571</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> <p>References <a class="el" href="a01395_source.html#l02405">std::gamma_distribution< _RealType >::reset()</a>.</p> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="aebe1b72f5b814d959f807aaaf5e6319e"></a> <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="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00432.html">std::basic_ostream</a><_CharT, _Traits>& operator<< </td> <td>(</td> <td class="paramtype"><a class="el" href="a00432.html">std::basic_ostream</a>< _CharT, _Traits > & </td> <td class="paramname"><em>__os</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType1 > & </td> <td class="paramname"><em>__x</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Inserts a chi_squared_distribution random number distribution <code>__x</code> into the output stream <code>__os</code>. </p> <dl class="params"><dt>Parameters</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 chi_squared_distribution random number distribution.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</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="a691feda4d6a0dec975dbe07c838768b6"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _RealType = double> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00607.html">chi_squared_distribution</a>< _RealType > & </td> <td class="paramname"><em>__d1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00607.html">chi_squared_distribution</a>< _RealType > & </td> <td class="paramname"><em>__d2</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return true if two Chi-squared distributions have the same parameters and the sequences that would be generated are equal. </p> <p>Definition at line <a class="el" href="a01395_source.html#l02634">2634</a> of file <a class="el" href="a01395_source.html">random.h</a>.</p> </div> </div> <a class="anchor" id="a5c7725e75b4c3fec1a13c3258ceaa6bc"></a> <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="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00431.html">std::basic_istream</a><_CharT, _Traits>& operator>> </td> <td>(</td> <td class="paramtype"><a class="el" href="a00431.html">std::basic_istream</a>< _CharT, _Traits > & </td> <td class="paramname"><em>__is</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00607.html">std::chi_squared_distribution</a>< _RealType1 > & </td> <td class="paramname"><em>__x</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Extracts a chi_squared_distribution random number distribution <code>__x</code> from the input stream <code>__is</code>. </p> <dl class="params"><dt>Parameters</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 chi_squared_distribution random number generator engine.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</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="a01395_source.html">random.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a01604.html">std</a></li><li class="navelem"><a class="el" href="a00607.html">chi_squared_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.8.3 </li> </ul> </div> </body> </html>