CpuRandom.h

#ifndef OPENMM_CPURANDOM_H_
#define OPENMM_CPURANDOM_H_

/* -------------------------------------------------------------------------- *
 *                                   OpenMM                                   *
 * -------------------------------------------------------------------------- *
 * This is part of the OpenMM molecular simulation 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) 2013-2024 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 "sfmt/SFMT.h"
#include "windowsExportCpu.h"
#include <iosfwd>
#include <vector>

namespace OpenMM {

/**
 * This class provides a multithreaded random number generator.
 */
class OPENMM_EXPORT_CPU CpuRandom {
public:
    CpuRandom();
    ~CpuRandom();
    void initialize(int seed, int numThreads);
    float getGaussianRandom(int threadIndex);
    float getUniformRandom(int threadIndex);
    void createCheckpoint(std::ostream& stream);
    void loadCheckpoint(std::istream& stream);
private:
    bool hasInitialized;
    int randomSeed;
    std::vector<OpenMM_SFMT::SFMT*> threadRandom;
    std::vector<float> nextGaussian;
    std::vector<int> nextGaussianIsValid;
};

} // namespace OpenMM

#endif /*OPENMM_CPURANDOM_H_*/