Random.h

Go to the documentation of this file.

#ifndef SimTK_SimTKCOMMON_RANDOM_H_
#define SimTK_SimTKCOMMON_RANDOM_H_

/* -------------------------------------------------------------------------- *
 *                       Simbody(tm): SimTKcommon                             *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK 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/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2007-12 Stanford University and the Authors.        *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may    *
 * not use this file except in compliance with the License. You may obtain a  *
 * copy of the License at http://www.apache.org/licenses/LICENSE-2.0.         *
 *                                                                            *
 * Unless required by applicable law or agreed to in writing, software        *
 * distributed under the License is distributed on an "AS IS" BASIS,          *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
 * See the License for the specific language governing permissions and        *
 * limitations under the License.                                             *
 * -------------------------------------------------------------------------- */

#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_