discrete.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_DISCRETE_H
#define SST_CORE_RNG_DISCRETE_H

#include "distrib.h"
#include "math.h"
#include "mersenne.h"
#include "rng.h"

#include <cstdlib> // for malloc/free

using namespace SST::RNG;

namespace SST {
namespace RNG {

/**
    \class DiscreteDistribution discrete.h "sst/core/rng/discrete.h"

    Creates a discrete distribution for use within SST. This distribution is the same across
    platforms and compilers.
*/
class DiscreteDistribution : public SST::RNG::RandomDistribution
{

public:
    /**
        Creates a discrete probability distribution
        \param probs An array of probabilities for each outcome
        \param probsCount The number of discrete outcomes
    */
    DiscreteDistribution(const double* probs, const uint32_t probsCount) :
        SST::RNG::RandomDistribution(),
        probCount(probsCount)
    {

        probabilities   = (double*)malloc(sizeof(double) * probsCount);
        double prob_sum = 0;

        for ( uint32_t i = 0; i < probsCount; i++ ) {
            probabilities[i] = prob_sum;
            prob_sum += probs[i];
        }

        baseDistrib   = new MersenneRNG();
        deleteDistrib = true;
    }

    /**
        Creates an exponential distribution with a specific lambda and a base random number generator
        \param lambda The lambda of the exponential distribution
        \param baseDist The base random number generator to take the distribution from.
    */
    DiscreteDistribution(const double* probs, const uint32_t probsCount, SST::RNG::Random* baseDist) :
        RandomDistribution(),
        probCount(probsCount)
    {

        probabilities   = (double*)malloc(sizeof(double) * probsCount);
        double prob_sum = 0;

        for ( uint32_t i = 0; i < probsCount; i++ ) {
            probabilities[i] = prob_sum;
            prob_sum += probs[i];
        }

        baseDistrib   = baseDist;
        deleteDistrib = false;
    }

    /**
        Destroys the exponential distribution
    */
    ~DiscreteDistribution()
    {
        free(probabilities);

        if ( deleteDistrib ) { delete baseDistrib; }
    }

    /**
        Gets the next (random) double value in the distribution
        \return The next random double from the discrete distribution, this is the double converted of the index where
       the probability is located
    */
    double getNextDouble() override
    {
        const double nextD = baseDistrib->nextUniform();

        uint32_t index = 0;

        for ( ; index < probCount; index++ ) {
            if ( probabilities[index] >= nextD ) { break; }
        }

        return (double)index;
    }

    /**
        Default constructor. FOR SERIALIZATION ONLY.
     */
    DiscreteDistribution() : RandomDistribution() {}

    /**
        Serialization function for checkpoint
    */
    void serialize_order(SST::Core::Serialization::serializer& ser) override
    {
        ser& baseDistrib;
        ser& deleteDistrib;
        ser& probCount;

        if ( ser.mode() == SST::Core::Serialization::serializer::UNPACK ) {
            probabilities = (double*)malloc(sizeof(double) * probCount);
        }

        for ( uint32_t i = 0; i < probCount; i++ ) {
            ser& probabilities[i];
        }
    }

    /**
        Serialization macro
    */
    ImplementSerializable(SST::RNG::DiscreteDistribution)

protected:
    /**
        Sets the base random number generator for the distribution.
    */
    SST::RNG::Random* baseDistrib;

    /**
        Controls whether the base distribution should be deleted when this class is destructed.
    */
    bool deleteDistrib;

    /**
        The discrete probability list
    */
    double* probabilities;

    /**
        Count of discrete probabilities
    */
    uint32_t probCount;
};

using SSTDiscreteDistribution = SST::RNG::DiscreteDistribution;

} // namespace RNG
} // namespace SST

#endif // SST_CORE_RNG_DISCRETE_H