Google Git
Sign in
nest-open-source / nest-learning-thermostat / 5.0 / boost / 317601cb979f96545d0e892ce7cfdf59f676ee0a / . / boost_1_45_0 / doc / html / boost / triangle_distribution.html
blob: 551bfd3d5599b16ac8b03a696db65bff3d5414a5 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template triangle_distribution</title>
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../boost_random/reference.html#header.boost.random.triangle_distribution_hpp" title="Header &lt;boost/random/triangle_distribution.hpp&gt;">
<link rel="prev" href="random/subtract_with_carry_01.html" title="Class template subtract_with_carry_01">
<link rel="next" href="uniform_01.html" title="Class template uniform_01">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.html">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="random/subtract_with_carry_01.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_random/reference.html#header.boost.random.triangle_distribution_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="uniform_01.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.triangle_distribution"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template triangle_distribution</span></h2>
<p>boost::triangle_distribution</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../boost_random/reference.html#header.boost.random.triangle_distribution_hpp" title="Header &lt;boost/random/triangle_distribution.hpp&gt;">boost/random/triangle_distribution.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">double</span><span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="triangle_distribution.html" title="Class template triangle_distribution">triangle_distribution</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.triangle_distribution.input_type"></a><span class="identifier">input_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.triangle_distribution.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="triangle_distribution.html#boost.triangle_distributionconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="triangle_distribution.html#id1148914-bb"><span class="identifier">triangle_distribution</span></a><span class="special">(</span><span class="identifier">result_type</span> <span class="special">=</span> <span class="identifier">result_type</span><span class="special">(</span><span class="number">0</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">result_type</span> <span class="special">=</span> <span class="identifier">result_type</span><span class="special">(</span><span class="number">0</span><span class="special">.</span><span class="number">5</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">result_type</span> <span class="special">=</span> <span class="identifier">result_type</span><span class="special">(</span><span class="number">1</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="triangle_distribution.html#id1148837-bb">public member functions</a></span>
<span class="identifier">result_type</span> <a class="link" href="triangle_distribution.html#id1148840-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">result_type</span> <a class="link" href="triangle_distribution.html#id1148856-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">result_type</span> <a class="link" href="triangle_distribution.html#id1148871-bb"><span class="identifier">c</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="triangle_distribution.html#id1148886-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="triangle_distribution.html#id1148894-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id2510728"></a><h2>Description</h2>
<p>Instantiations of <code class="computeroutput">triangle_distribution</code> model a <a class="link" href="../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . A <code class="computeroutput">triangle_distribution</code> has three parameters, <code class="computeroutput">a</code>, <code class="computeroutput">b</code>, and <code class="computeroutput">c</code>, which are the smallest, the most probable and the largest values of the distribution respectively. </p>
<div class="refsect2">
<a name="id2510773"></a><h3>
<a name="boost.triangle_distributionconstruct-copy-destruct"></a><code class="computeroutput">triangle_distribution</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><a name="id1148914-bb"></a><span class="identifier">triangle_distribution</span><span class="special">(</span><span class="identifier">result_type</span> a_arg <span class="special">=</span> <span class="identifier">result_type</span><span class="special">(</span><span class="number">0</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">result_type</span> b_arg <span class="special">=</span> <span class="identifier">result_type</span><span class="special">(</span><span class="number">0</span><span class="special">.</span><span class="number">5</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">result_type</span> c_arg <span class="special">=</span> <span class="identifier">result_type</span><span class="special">(</span><span class="number">1</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput">triangle_distribution</code> with the parameters <code class="computeroutput">a</code>, <code class="computeroutput">b</code>, and <code class="computeroutput">c</code>.</p>
<p>Preconditions: a &lt;= b &lt;= c. </p>
</li></ol></div>
</div>
<div class="refsect2">
<a name="id2510955"></a><h3>
<a name="id1148837-bb"></a><code class="computeroutput">triangle_distribution</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1148840-bb"></a><span class="identifier">a</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the <code class="computeroutput">a</code> parameter of the distribution </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1148856-bb"></a><span class="identifier">b</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the <code class="computeroutput">b</code> parameter of the distribution </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1148871-bb"></a><span class="identifier">c</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the <code class="computeroutput">c</code> parameter of the distribution </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id1148886-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="id1148894-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span> eng<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2000 -2005 Jens Maurer, 2009 Steven Watanabe<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="random/subtract_with_carry_01.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_random/reference.html#header.boost.random.triangle_distribution_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="uniform_01.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>