NumCpp  2.6.2
A Templatized Header Only C++ Implementation of the Python NumPy Library
f.hpp
Go to the documentation of this file.
1 
28 #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:
55  template<typename dtype>
56  dtype f(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>
88  NdArray<dtype> f(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(), returnArray.end(),
107  [&dist](dtype& value) -> void
108  {
109  value = dist(generator_);
110  });
111 
112  return returnArray;
113  }
114  } // namespace random
115 } // 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:1558
iterator begin() noexcept
Definition: NdArrayCore.hpp:1214
A Shape Class for NdArrays.
Definition: Core/Shape.hpp:41
dtype f(dtype inDofN, dtype inDofD)
Definition: f.hpp:56
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