Developer Documentation
RandomNumberGenerator.hh
1 /* ========================================================================= *
2  * *
3  * OpenMesh *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openmesh.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenMesh. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40  * ========================================================================= */
41 
42 //=============================================================================
43 //
44 // Helper Functions for generating a random number between 0.0 and 1.0 with
45 // a guaranteed resolution
46 //
47 //=============================================================================
48 
49 
50 #ifndef OPENMESH_UTILS_RANDOMNUMBERGENERATOR_HH
51 #define OPENMESH_UTILS_RANDOMNUMBERGENERATOR_HH
52 
53 
54 //== INCLUDES =================================================================
55 
56 
58 #include <cstdlib>
59 
60 
61 
62 //== NAMESPACES ===============================================================
63 
64 
65 namespace OpenMesh {
66 
67 
68 //=============================================================================
69 
70 
77 class OPENMESHDLLEXPORT RandomNumberGenerator
78 {
79 public:
80 
85  explicit RandomNumberGenerator(const size_t _resolution);
86 
88  double getRand() const;
89 
90  double resolution() const;
91 
92 private:
93 
95  const size_t resolution_;
96 
98  size_t iterations_;
99 
101  double maxNum_;
102 };
103 
104 //=============================================================================
105 } // namespace OpenMesh
106 //=============================================================================
107 #endif // OPENMESH_UTILS_RANDOMNUMBERGENERATOR_HH defined
108 //=============================================================================
109 
double maxNum_
maximum random number generated, which is used for normalization
size_t iterations_
number of "blocks" of RAND_MAX that make up the desired _resolution
const size_t resolution_
desired resolution