NumCpp  2.11.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
lognormal.hpp
Go to the documentation of this file.
1 #pragma once
29 
30 #include <algorithm>
31 #include <random>
32 #include <string>
33 
36 #include "NumCpp/Core/Shape.hpp"
37 #include "NumCpp/NdArray.hpp"
39 
40 namespace nc::random
41 {
42  namespace detail
43  {
44  //============================================================================
45  // Method Description:
57  template<typename dtype, typename GeneratorType = std::mt19937>
58  dtype lognormal(GeneratorType& generator, dtype inMean = 0, dtype inSigma = 1)
59  {
61 
62  if (inSigma <= 0)
63  {
64  THROW_INVALID_ARGUMENT_ERROR("input sigma must be greater than zero.");
65  }
66 
67  std::lognormal_distribution<dtype> dist(inMean, inSigma);
68  return dist(generator);
69  }
70 
71  //============================================================================
72  // Method Description:
86  template<typename dtype, typename GeneratorType = std::mt19937>
87  NdArray<dtype> lognormal(GeneratorType& generator, const Shape& inShape, dtype inMean = 0, dtype inSigma = 1)
88  {
90 
91  if (inSigma <= 0)
92  {
93  THROW_INVALID_ARGUMENT_ERROR("input sigma must be greater than zero.");
94  }
95 
96  NdArray<dtype> returnArray(inShape);
97 
98  std::lognormal_distribution<dtype> dist(inMean, inSigma);
99 
100  std::for_each(returnArray.begin(),
101  returnArray.end(),
102  [&generator, &dist](dtype& value) -> void { value = dist(generator); });
103 
104  return returnArray;
105  }
106  } // namespace detail
107 
108  //============================================================================
109  // Method Description:
120  template<typename dtype>
121  dtype lognormal(dtype inMean = 0, dtype inSigma = 1)
122  {
123  return detail::lognormal(generator_, inMean, inSigma);
124  }
125 
126  //============================================================================
127  // Method Description:
140  template<typename dtype>
141  NdArray<dtype> lognormal(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1)
142  {
143  return detail::lognormal(generator_, inShape, inMean, inSigma);
144  }
145 } // namespace nc::random
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:37
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:39
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:138
iterator end() noexcept
Definition: NdArrayCore.hpp:1576
iterator begin() noexcept
Definition: NdArrayCore.hpp:1268
A Shape Class for NdArrays.
Definition: Core/Shape.hpp:41
dtype lognormal(GeneratorType &generator, dtype inMean=0, dtype inSigma=1)
Definition: lognormal.hpp:58
Definition: Random/bernoulli.hpp:41
dtype lognormal(dtype inMean=0, dtype inSigma=1)
Definition: lognormal.hpp:121
static std::mt19937_64 generator_
generator function
Definition: generator.hpp:35
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:225