NumCpp  2.5.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
randFloat.hpp
Go to the documentation of this file.
1 #pragma once
30 
33 #include "NumCpp/Core/Shape.hpp"
34 #include "NumCpp/NdArray.hpp"
37 
38 #include <algorithm>
39 #include <random>
40 #include <string>
41 
42 namespace nc
43 {
44  namespace random
45  {
46  //============================================================================
47  // Method Description:
59  template<typename dtype>
60  dtype randFloat(dtype inLow, dtype inHigh = 0.0)
61  {
62  STATIC_ASSERT_FLOAT(dtype);
63 
64  if (utils::essentiallyEqual(inLow, inHigh))
65  {
66  THROW_INVALID_ARGUMENT_ERROR("input low value must be less than the input high value.");
67  }
68  else if (inLow > inHigh)
69  {
70  std::swap(inLow, inHigh);
71  }
72 
73  std::uniform_real_distribution<dtype> dist(inLow, inHigh - DtypeInfo<dtype>::epsilon());
74  return dist(generator_);
75  }
76 
77  //============================================================================
78  // Method Description:
91  template<typename dtype>
92  NdArray<dtype> randFloat(const Shape& inShape, dtype inLow, dtype inHigh = 0.0)
93  {
94  STATIC_ASSERT_FLOAT(dtype);
95 
96  if (utils::essentiallyEqual(inLow, inHigh))
97  {
98  THROW_INVALID_ARGUMENT_ERROR("input low value must be less than the input high value.");
99  }
100  else if (inLow > inHigh)
101  {
102  std::swap(inLow, inHigh);
103  }
104 
105  NdArray<dtype> returnArray(inShape);
106 
107  std::uniform_real_distribution<dtype> dist(inLow, inHigh - DtypeInfo<dtype>::epsilon());
108 
109  std::for_each(returnArray.begin(), returnArray.end(),
110  [&dist](dtype& value) -> void
111  {
112  value = dist(generator_);
113  });
114 
115  return returnArray;
116  }
117  } // namespace random
118 } // namespace nc
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
#define STATIC_ASSERT_FLOAT(dtype)
Definition: StaticAsserts.hpp:43
Holds info about the dtype.
Definition: DtypeInfo.hpp:41
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
iterator end() noexcept
Definition: NdArrayCore.hpp:1558
iterator begin() noexcept
Definition: NdArrayCore.hpp:1214
A Shape Class for NdArrays.
Definition: Core/Shape.hpp:41
dtype randFloat(dtype inLow, dtype inHigh=0.0)
Definition: randFloat.hpp:60
static std::mt19937_64 generator_
generator function
Definition: generator.hpp:39
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:213
bool essentiallyEqual(dtype inValue1, dtype inValue2) noexcept
Definition: essentiallyEqual.hpp:52
Definition: Coordinate.hpp:45
void swap(NdArray< dtype > &inArray1, NdArray< dtype > &inArray2) noexcept
Definition: swap.hpp:42