NumCpp  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
normal.hpp
Go to the documentation of this file.
1 #pragma once
29 
32 #include "NumCpp/Core/Shape.hpp"
33 #include "NumCpp/NdArray.hpp"
35 
36 #include <algorithm>
37 #include <random>
38 #include <string>
39 
40 namespace nc
41 {
42  namespace random
43  {
44  //============================================================================
45  // Method Description:
54  template<typename dtype>
55  dtype normal(dtype inMean = 0, dtype inSigma = 1)
56  {
58 
59  if (inSigma <= 0)
60  {
61  THROW_INVALID_ARGUMENT_ERROR("input sigma must be greater than zero.");
62  }
63 
64  std::normal_distribution<dtype> dist(inMean, inSigma);
65  return dist(generator_);
66  }
67 
68  //============================================================================
69  // Method Description:
80  template<typename dtype>
81  NdArray<dtype> normal(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1)
82  {
84 
85  if (inSigma <= 0)
86  {
87  THROW_INVALID_ARGUMENT_ERROR("input sigma must be greater than zero.");
88  }
89 
90  NdArray<dtype> returnArray(inShape);
91 
92  std::normal_distribution<dtype> dist(inMean, inSigma);
93 
94  std::for_each(returnArray.begin(), returnArray.end(),
95  [&dist](dtype& value) -> void
96  {
97  value = dist(generator_);
98  });
99 
100  return returnArray;
101  }
102  } // namespace random
103 } // namespace nc
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
iterator end() noexcept
Definition: NdArrayCore.hpp:1474
iterator begin() noexcept
Definition: NdArrayCore.hpp:1166
A Shape Class for NdArrays.
Definition: Core/Shape.hpp:41
dtype normal(dtype inMean=0, dtype inSigma=1)
Definition: normal.hpp:55
static std::mt19937_64 generator_
generator function
Definition: generator.hpp:39
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:213
Definition: Coordinate.hpp:45