SIM_RandomTwister.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 */

#ifndef __SIM_RandomTwister_h__
#define __SIM_RandomTwister_h__

#include "SIM_API.h"
#include <UT/UT_MTwister.h>
#include "SIM_Random.h"

/// This class defines a bunch of useful tools for random number
/// generation.  It is designed to be attached as subdata to objects
/// or solvers that need a stream of random numbers.
class SIM_API SIM_RandomTwister : public SIM_Random
{
protected:
    explicit             SIM_RandomTwister(const SIM_DataFactory *factory);
                        ~SIM_RandomTwister() override;

    void                 initializeSubclass() override;
    void                 makeEqualSubclass(const SIM_Data *source) override;
    void                 saveSubclass(std::ostream &os) const override;
    bool                 loadSubclass(UT_IStream &is) override;

    uint                 urandomSubclass() override;
    void                 setSeedSubclass(uint seed) override;

private:
    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_RandomTwister,
                        SIM_Random,
                        "Random Stream",
                        getEmptyDopDescription());

    UT_MersenneTwister   myTwister;
};

#endif