Random.h

Go to the documentation of this file.

#ifndef SimTK_SimTKCOMMON_RANDOM_H_
#define SimTK_SimTKCOMMON_RANDOM_H_

/* -------------------------------------------------------------------------- *
 *                      SimTK Core: SimTKcommon                               *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK Core biosimulation toolkit originating from      *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org.               *
 *                                                                            *
 * Portions copyright (c) 2007 Stanford University and the Authors.           *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
 * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
 * -------------------------------------------------------------------------- */

#include "SimTKcommon/basics.h"

namespace SimTK {

class SimTK_SimTKCOMMON_EXPORT Random {
public:
    class Uniform;
    class Gaussian;
    class RandomImpl;
    ~Random();
    void setSeed(int seed);
    Real getValue() const;
    void fillArray(Real array[], int length) const;
protected:
    RandomImpl* impl;
    Random();
    RandomImpl& getImpl();
    const RandomImpl& getConstImpl() const;
private:
    // Suppress copy constructor and copy assignment.
    Random(const Random& r);
    Random operator=(const Random& r);
};

class SimTK_SimTKCOMMON_EXPORT Random::Uniform : public Random {
public:
    class UniformImpl;
    Uniform();
    Uniform(Real min, Real max);
    int getIntValue();
    Real getMin() const;
    void setMin(Real min);
    Real getMax() const;
    void setMax(Real max);
protected:
    UniformImpl& getImpl();
    const UniformImpl& getConstImpl() const;
private:
    // Must suppress here if base class members are suppressed.
    Uniform(const Uniform& r);
    Uniform operator=(const Uniform& r);
};

class SimTK_SimTKCOMMON_EXPORT Random::Gaussian : public Random {
public:
    class GaussianImpl;
    Gaussian();
    Gaussian(Real mean, Real stddev);
    Real getMean() const;
    void setMean(Real mean);
    Real getStdDev() const;
    void setStdDev(Real stddev);
protected:
    GaussianImpl& getImpl();
    const GaussianImpl& getConstImpl() const;
private:
    // Must suppress here if base class members are suppressed.
    Gaussian(const Gaussian& r);
    Gaussian operator=(const Gaussian& r);
};

} // namespace SimTK

#endif // SimTK_SimTKCOMMON_RANDOM_H_