rng.h

// Copyright 2009-2024 NTESS. Under the terms
// of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Copyright (c) 2009-2024, NTESS
// All rights reserved.
//
// This file is part of the SST software package. For license
// information, see the LICENSE file in the top level directory of the
// distribution.

#ifndef SST_CORE_RNG_RNG_H
#define SST_CORE_RNG_RNG_H

#include "sst/core/serialization/serializable.h"

#include <stdint.h>

namespace SST {
namespace RNG {

/**
    \class Random rng.h "sst/core/rng/rng.h"

    Implements the base class for random number generators for the SST core. This does not
    implement an actual RNG itself only the base class which describes the methods each
    class will implement.
*/
class Random : public SST::Core::Serialization::serializable
{

public:
    /**
        Generates the next random number in the range [0,1).
    */
    virtual double nextUniform() = 0;

    /**
        Generates the next random number as an unsigned 32-bit integer.
    */
    virtual uint32_t generateNextUInt32() = 0;

    /**
        Generates the next random number as an unsigned 64-bit integer.
    */
    virtual uint64_t generateNextUInt64() = 0;

    /**
        Generates the next random number as a signed 64-bit integer.
    */
    virtual int64_t generateNextInt64() = 0;

    /**
        Generates the next random number as a signed 32-bit integer
    */
    virtual int32_t generateNextInt32() = 0;

    /**
        Destroys the random number generator
    */
    virtual ~Random() {}

    virtual void serialize_order(SST::Core::Serialization::serializer& UNUSED(ser)) override {};
    ImplementVirtualSerializable(SST::RNG::Random)
};

} // namespace RNG
} // namespace SST

#endif // SST_CORE_RNG_RNG_H