NumCpp  2.11.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
weibull.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  // Method Description:
55  template<typename dtype, typename GeneratorType = std::mt19937>
56  dtype weibull(GeneratorType& generator, dtype inA = 1, dtype inB = 1)
57  {
59 
60  if (inA <= 0)
61  {
62  THROW_INVALID_ARGUMENT_ERROR("input a must be greater than zero.");
63  }
64 
65  if (inB <= 0)
66  {
67  THROW_INVALID_ARGUMENT_ERROR("input b must be greater than zero.");
68  }
69 
70  std::weibull_distribution<dtype> dist(inA, inB);
71  return dist(generator);
72  }
73 
74  //============================================================================
75  // Method Description:
88  template<typename dtype, typename GeneratorType = std::mt19937>
89  NdArray<dtype> weibull(GeneratorType& generator, const Shape& inShape, dtype inA = 1, dtype inB = 1)
90  {
92 
93  if (inA <= 0)
94  {
95  THROW_INVALID_ARGUMENT_ERROR("input a must be greater than zero.");
96  }
97 
98  if (inB <= 0)
99  {
100  THROW_INVALID_ARGUMENT_ERROR("input b must be greater than zero.");
101  }
102 
103  NdArray<dtype> returnArray(inShape);
104 
105  std::weibull_distribution<dtype> dist(inA, inB);
106 
107  std::for_each(returnArray.begin(),
108  returnArray.end(),
109  [&generator, &dist](dtype& value) -> void { value = dist(generator); });
110 
111  return returnArray;
112  }
113  } // namespace detail
114 
115  //============================================================================
116  // Method Description:
126  template<typename dtype>
127  dtype weibull(dtype inA = 1, dtype inB = 1)
128  {
129  return detail::weibull(generator_, inA, inB);
130  }
131 
132  //============================================================================
133  // Method Description:
145  template<typename dtype>
146  NdArray<dtype> weibull(const Shape& inShape, dtype inA = 1, dtype inB = 1)
147  {
148  return detail::weibull(generator_, inShape, inA, inB);
149  }
150 } // 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 weibull(GeneratorType &generator, dtype inA=1, dtype inB=1)
Definition: weibull.hpp:56
Definition: Random/bernoulli.hpp:41
dtype weibull(dtype inA=1, dtype inB=1)
Definition: weibull.hpp:127
static std::mt19937_64 generator_
generator function
Definition: generator.hpp:35
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:225