Gazebo Math

API Reference

6.15.1
gz/math/Rand.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef GZ_MATH_RAND_HH_
18 #define GZ_MATH_RAND_HH_
19 
20 #include <random>
21 #include <cmath>
22 #include <cstdint>
23 #include <gz/math/Helpers.hh>
24 #include <gz/math/config.hh>
25 
26 namespace ignition
27 {
28  namespace math
29  {
30  // Inline bracket to help doxygen filtering.
31  inline namespace IGNITION_MATH_VERSION_NAMESPACE {
32  //
45 
48  class IGNITION_MATH_VISIBLE Rand
49  {
53  public: static void Seed(unsigned int _seed);
54 
58  public: static unsigned int Seed();
59 
63  public: static double DblUniform(double _min = 0, double _max = 1);
64 
68  public: static double DblNormal(double _mean = 0, double _sigma = 1);
69 
73  public: static int32_t IntUniform(int _min, int _max);
74 
78  public: static int32_t IntNormal(int _mean, int _sigma);
79 
82  private: static uint32_t &SeedMutable();
83 
86  private: static GeneratorType &RandGenerator();
87  };
88  }
89  }
90 }
91 #endif
std::uniform_real_distribution< double > UniformRealDist
Definition: gz/math/Rand.hh:38
Definition: gz/math/AdditivelySeparableScalarField3.hh:27
std::mt19937 GeneratorType
Definition: gz/math/Rand.hh:35
std::normal_distribution< double > NormalRealDist
Definition: gz/math/Rand.hh:41
std::uniform_int_distribution< int32_t > UniformIntDist
Definition: gz/math/Rand.hh:44
static int32_t IntNormal(int _mean, int _sigma)
Get an integer from a normal distribution.
static unsigned int Seed()
Get the seed value.
static int32_t IntUniform(int _min, int _max)
Get an integer from a uniform distribution.
Random number generator class.
Definition: gz/math/Rand.hh:48
static double DblNormal(double _mean=0, double _sigma=1)
Get a double from a normal distribution.
static double DblUniform(double _min=0, double _max=1)
Get a double from a uniform distribution.