gz/math/Rand.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_MATH_RAND_HH_
#define GZ_MATH_RAND_HH_
 
#include <random>
#include <cmath>
#include <cstdint>
#include <gz/math/Helpers.hh>
#include <gz/math/config.hh>
 
namespace gz::math
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MATH_VERSION_NAMESPACE {
  //
  typedef std::mt19937 GeneratorType;
  typedef std::uniform_real_distribution<double> UniformRealDist;
  typedef std::normal_distribution<double> NormalRealDist;
  typedef std::uniform_int_distribution<int32_t> UniformIntDist;
 
  class GZ_MATH_VISIBLE Rand
  {
    public: static void Seed(unsigned int _seed);
 
    public: static unsigned int Seed();
 
    public: static double DblUniform(double _min = 0, double _max = 1);
 
    public: static double DblNormal(double _mean = 0, double _sigma = 1);
 
    public: static int32_t IntUniform(int _min, int _max);
 
    public: static int32_t IntNormal(int _mean, int _sigma);
 
    private: static uint32_t &SeedMutable();
 
    private: static GeneratorType &RandGenerator();
  };
  }  // namespace GZ_MATH_VERSION_NAMESPACE
}  // namespace gz::math
#endif  // GZ_MATH_RAND_HH_