1
by Steve M. Robbins
Import upstream version 1.46.0 |
1 |
<html> |
2 |
<head> |
|
3 |
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
|
4 |
<title>Class template uniform_on_sphere</title> |
|
5 |
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> |
|
6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
|
7 |
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
|
8 |
<link rel="up" href="../boost_random/reference.html#header.boost.random.uniform_on_sphere_hpp" title="Header <boost/random/uniform_on_sphere.hpp>"> |
|
9 |
<link rel="prev" href="uniform_int.html" title="Class template uniform_int"> |
|
10 |
<link rel="next" href="uniform_real.html" title="Class template uniform_real"> |
|
11 |
</head> |
|
12 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|
13 |
<table cellpadding="2" width="100%"><tr> |
|
14 |
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> |
|
15 |
<td align="center"><a href="../../../index.html">Home</a></td> |
|
16 |
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> |
|
17 |
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
|
18 |
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
|
19 |
<td align="center"><a href="../../../more/index.htm">More</a></td> |
|
20 |
</tr></table> |
|
21 |
<hr> |
|
22 |
<div class="spirit-nav"> |
|
23 |
<a accesskey="p" href="uniform_int.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_random/reference.html#header.boost.random.uniform_on_sphere_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_real.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> |
|
24 |
</div> |
|
25 |
<div class="refentry"> |
|
26 |
<a name="boost.uniform_on_sphere"></a><div class="titlepage"></div> |
|
27 |
<div class="refnamediv"> |
|
28 |
<h2><span class="refentrytitle">Class template uniform_on_sphere</span></h2> |
|
29 |
<p>boost::uniform_on_sphere</p> |
|
30 |
</div> |
|
31 |
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
|
32 |
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../boost_random/reference.html#header.boost.random.uniform_on_sphere_hpp" title="Header <boost/random/uniform_on_sphere.hpp>">boost/random/uniform_on_sphere.hpp</a>> |
|
33 |
||
34 |
</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">double</span><span class="special">,</span> <span class="keyword">typename</span> Cont <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">RealType</span><span class="special">></span> <span class="special">></span> |
|
35 |
<span class="keyword">class</span> <a class="link" href="uniform_on_sphere.html" title="Class template uniform_on_sphere">uniform_on_sphere</a> <span class="special">{</span> |
|
36 |
<span class="keyword">public</span><span class="special">:</span> |
|
37 |
<span class="comment">// types</span> |
|
38 |
<span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.uniform_on_sphere.input_type"></a><span class="identifier">input_type</span><span class="special">;</span> |
|
39 |
<span class="keyword">typedef</span> <span class="identifier">Cont</span> <a name="boost.uniform_on_sphere.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> |
|
40 |
||
41 |
<span class="comment">// <a class="link" href="uniform_on_sphere.html#boost.uniform_on_sphereconstruct-copy-destruct">construct/copy/destruct</a></span> |
|
42 |
<a class="link" href="uniform_on_sphere.html#id1162091-bb"><span class="identifier">uniform_on_sphere</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="number">2</span><span class="special">)</span><span class="special">;</span> |
|
43 |
||
44 |
<span class="comment">// <a class="link" href="uniform_on_sphere.html#id1162059-bb">public member functions</a></span> |
|
45 |
<span class="keyword">void</span> <a class="link" href="uniform_on_sphere.html#id1162062-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> |
|
46 |
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Engine<span class="special">></span> <span class="keyword">const</span> <span class="identifier">result_type</span> <span class="special">&</span> <a class="link" href="uniform_on_sphere.html#id1162070-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">&</span><span class="special">)</span><span class="special">;</span> |
|
47 |
<span class="special">}</span><span class="special">;</span></pre></div> |
|
48 |
<div class="refsect1"> |
|
49 |
<a name="id2670749"></a><h2>Description</h2> |
|
50 |
<p>Instantiations of class template uniform_on_sphere model a <a class="link" href="../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . Such a distribution produces random numbers uniformly distributed on the unit sphere of arbitrary dimension <code class="computeroutput">dim</code>. The <code class="computeroutput">Cont</code> template parameter must be a STL-like container type with begin and end operations returning non-const ForwardIterators of type <code class="computeroutput">Cont::iterator</code>. Each invocation of the <code class="computeroutput">UniformRandomNumberGenerator</code> shall result in a floating-point value in the range [0,1). </p> |
|
51 |
<div class="refsect2"> |
|
52 |
<a name="id2670793"></a><h3> |
|
53 |
<a name="boost.uniform_on_sphereconstruct-copy-destruct"></a><code class="computeroutput">uniform_on_sphere</code> |
|
54 |
public |
|
55 |
construct/copy/destruct</h3> |
|
56 |
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> |
|
57 |
<pre class="literallayout"><a name="id1162091-bb"></a><span class="identifier">uniform_on_sphere</span><span class="special">(</span><span class="keyword">int</span> dim <span class="special">=</span> <span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> |
|
58 |
<p>Constructs a <code class="computeroutput">uniform_on_sphere</code> distribution. <code class="computeroutput">dim</code> is the dimension of the sphere. </p> |
|
59 |
</li></ol></div> |
|
60 |
</div> |
|
61 |
<div class="refsect2"> |
|
62 |
<a name="id2670872"></a><h3> |
|
63 |
<a name="id1162059-bb"></a><code class="computeroutput">uniform_on_sphere</code> public member functions</h3> |
|
64 |
<div class="orderedlist"><ol class="orderedlist" type="1"> |
|
65 |
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id1162062-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> |
|
66 |
<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Engine<span class="special">></span> <span class="keyword">const</span> <span class="identifier">result_type</span> <span class="special">&</span> <a name="id1162070-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">&</span> eng<span class="special">)</span><span class="special">;</span></pre></li> |
|
67 |
</ol></div> |
|
68 |
</div> |
|
69 |
</div> |
|
70 |
</div> |
|
71 |
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
|
72 |
<td align="left"></td> |
|
73 |
<td align="right"><div class="copyright-footer">Copyright © 2000 -2005 Jens Maurer, 2009 Steven Watanabe<p> |
|
74 |
Distributed under the Boost Software License, Version 1.0. (See accompanying |
|
75 |
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>) |
|
76 |
</p> |
|
77 |
</div></td> |
|
78 |
</tr></table> |
|
79 |
<hr> |
|
80 |
<div class="spirit-nav"> |
|
81 |
<a accesskey="p" href="uniform_int.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_random/reference.html#header.boost.random.uniform_on_sphere_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_real.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> |
|
82 |
</div> |
|
83 |
</body> |
|
84 |
</html> |