Random.h

Go to the documentation of this file.
00001 #ifndef SimTK_SimTKCOMMON_RANDOM_H_
00002 #define SimTK_SimTKCOMMON_RANDOM_H_
00003 
00004 /* -------------------------------------------------------------------------- *
00005  *                      SimTK Core: SimTKcommon                               *
00006  * -------------------------------------------------------------------------- *
00007  * This is part of the SimTK Core biosimulation toolkit originating from      *
00008  * Simbios, the NIH National Center for Physics-Based Simulation of           *
00009  * Biological Structures at Stanford, funded under the NIH Roadmap for        *
00010  * Medical Research, grant U54 GM072970. See https://simtk.org.               *
00011  *                                                                            *
00012  * Portions copyright (c) 2007 Stanford University and the Authors.           *
00013  * Authors: Peter Eastman                                                     *
00014  * Contributors:                                                              *
00015  *                                                                            *
00016  * Permission is hereby granted, free of charge, to any person obtaining a    *
00017  * copy of this software and associated documentation files (the "Software"), *
00018  * to deal in the Software without restriction, including without limitation  *
00019  * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
00020  * and/or sell copies of the Software, and to permit persons to whom the      *
00021  * Software is furnished to do so, subject to the following conditions:       *
00022  *                                                                            *
00023  * The above copyright notice and this permission notice shall be included in *
00024  * all copies or substantial portions of the Software.                        *
00025  *                                                                            *
00026  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
00027  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
00028  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
00029  * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
00030  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
00031  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
00032  * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
00033  * -------------------------------------------------------------------------- */
00034 
00035 #include "SimTKcommon/basics.h"
00036 
00037 namespace SimTK {
00038 
00062 class SimTK_SimTKCOMMON_EXPORT Random {
00063 public:
00064     class Uniform;
00065     class Gaussian;
00066     class RandomImpl;
00067     ~Random();
00071     void setSeed(int seed);
00075     Real getValue() const;
00079     void fillArray(Real array[], int length) const;
00080 protected:
00081     RandomImpl* impl;
00085     Random();
00089     RandomImpl& getImpl();
00093     const RandomImpl& getConstImpl() const;
00094 private:
00095     Random(Random& r);
00096     Random operator=(Random& r);
00097 };
00098 
00103 class SimTK_SimTKCOMMON_EXPORT Random::Uniform : public Random {
00104 public:
00105     class UniformImpl;
00109     Uniform();
00113     Uniform(Real min, Real max);
00117     int getIntValue();
00121     Real getMin() const;
00125     void setMin(Real min);
00129     Real getMax() const;
00133     void setMax(Real max);
00134 protected:
00135     UniformImpl& getImpl();
00136     const UniformImpl& getConstImpl() const;
00137 };
00138 
00144 class SimTK_SimTKCOMMON_EXPORT Random::Gaussian : public Random {
00145 public:
00146     class GaussianImpl;
00150     Gaussian();
00154     Gaussian(Real mean, Real stddev);
00158     Real getMean() const;
00162     void setMean(Real mean);
00166     Real getStdDev() const;
00170     void setStdDev(Real stddev);
00171 protected:
00172     GaussianImpl& getImpl();
00173     const GaussianImpl& getConstImpl() const;
00174 };
00175 
00176 } // namespace SimTK
00177 
00178 #endif // SimTK_SimTKCOMMON_RANDOM_H_

Generated by  doxygen 1.6.2