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