juce_Random.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_RANDOM_H_INCLUDED
#define JUCE_RANDOM_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  Random
{
public:
    //==============================================================================
    explicit Random (int64 seedValue) noexcept;
 
    Random();
 
    ~Random() noexcept;
 
    int nextInt() noexcept;
 
    int nextInt (int maxValue) noexcept;
 
    int nextInt (Range<int> range) noexcept;
 
    int64 nextInt64() noexcept;
 
    float nextFloat() noexcept;
 
    double nextDouble() noexcept;
 
    bool nextBool() noexcept;
 
    BigInteger nextLargeNumber (const BigInteger& maximumValue);
 
    void fillBitsRandomly (void* bufferToFill, size_t sizeInBytes);
 
    void fillBitsRandomly (BigInteger& arrayToChange, int startBit, int numBits);
 
    //==============================================================================
    void setSeed (int64 newSeed) noexcept;
 
    int64 getSeed() const noexcept                      { return seed; }
 
    void combineSeed (int64 seedValue) noexcept;
 
    void setSeedRandomly();
 
    static Random& getSystemRandom() noexcept;
 
private:
    //==============================================================================
    int64 seed;
 
    JUCE_LEAK_DETECTOR (Random)
};
 
 
#endif   // JUCE_RANDOM_H_INCLUDED