NumCpp  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
rms.hpp
Go to the documentation of this file.
1 #pragma once
29 
31 #include "NumCpp/Core/Types.hpp"
32 #include "NumCpp/NdArray.hpp"
33 #include "NumCpp/Utils/sqr.hpp"
34 
35 #include <algorithm>
36 #include <cmath>
37 #include <complex>
38 
39 namespace nc
40 {
41  //============================================================================
42  // Method Description:
50  template<typename dtype>
51  NdArray<double> rms(const NdArray<dtype>& inArray, Axis inAxis = Axis::NONE)
52  {
54 
55  double squareSum = 0.0;
56  const auto function = [&squareSum](dtype value) -> void
57  {
58  squareSum += utils::sqr(static_cast<double>(value));
59  };
60 
61  switch (inAxis)
62  {
63  case Axis::NONE:
64  {
65  std::for_each(inArray.cbegin(), inArray.cend(), function);
66  NdArray<double> returnArray = { std::sqrt(squareSum / static_cast<double>(inArray.size())) };
67  return returnArray;
68  }
69  case Axis::COL:
70  {
71  NdArray<double> returnArray(1, inArray.numRows());
72  for (uint32 row = 0; row < inArray.numRows(); ++row)
73  {
74  squareSum = 0.0;
75  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
76  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(inArray.numCols()));
77  }
78 
79  return returnArray;
80  }
81  case Axis::ROW:
82  {
83  NdArray<dtype> transposedArray = inArray.transpose();
84  NdArray<double> returnArray(1, transposedArray.numRows());
85  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
86  {
87  squareSum = 0.0;
88  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
89  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(transposedArray.numCols()));
90  }
91 
92  return returnArray;
93  }
94  default:
95  {
96  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
97  return {}; // get rid of compiler warning
98  }
99  }
100  }
101 
102  //============================================================================
103  // Method Description:
111  template<typename dtype>
112  NdArray<std::complex<double>> rms(const NdArray<std::complex<dtype>>& inArray, Axis inAxis = Axis::NONE)
113  {
115 
116  std::complex<double> squareSum = 0.0;
117  const auto function = [&squareSum](std::complex<dtype> value) -> void
118  {
119  squareSum += utils::sqr(complex_cast<double>(value));
120  };
121 
122  switch (inAxis)
123  {
124  case Axis::NONE:
125  {
126  std::for_each(inArray.cbegin(), inArray.cend(), function);
127  NdArray<std::complex<double>> returnArray = { std::sqrt(squareSum / static_cast<double>(inArray.size())) };
128  return returnArray;
129  }
130  case Axis::COL:
131  {
132  NdArray<std::complex<double>> returnArray(1, inArray.numRows());
133  for (uint32 row = 0; row < inArray.numRows(); ++row)
134  {
135  squareSum = std::complex<double>(0.0, 0.0);
136  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
137  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(inArray.numCols()));
138  }
139 
140  return returnArray;
141  }
142  case Axis::ROW:
143  {
144  NdArray<std::complex<dtype>> transposedArray = inArray.transpose();
145  NdArray<std::complex<double>> returnArray(1, transposedArray.numRows());
146  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
147  {
148  squareSum = std::complex<double>(0.0, 0.0);
149  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
150  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(transposedArray.numCols()));
151  }
152 
153  return returnArray;
154  }
155  default:
156  {
157  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
158  return {}; // get rid of compiler warning
159  }
160  }
161  }
162 } // namespace nc
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
uint32 numCols() const noexcept
Definition: NdArrayCore.hpp:3418
size_type size() const noexcept
Definition: NdArrayCore.hpp:4296
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1216
uint32 numRows() const noexcept
Definition: NdArrayCore.hpp:3430
NdArray< dtype > transpose() const
Definition: NdArrayCore.hpp:4629
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1524
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:213
constexpr dtype sqr(dtype inValue) noexcept
Definition: sqr.hpp:44
Definition: Coordinate.hpp:45
NdArray< double > rms(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: rms.hpp:51
Axis
Enum To describe an axis.
Definition: Types.hpp:46
auto sqrt(dtype inValue) noexcept
Definition: sqrt.hpp:48
std::uint32_t uint32
Definition: Types.hpp:40