NumCpp  2.8.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 
30 #include <algorithm>
31 #include <cmath>
32 #include <complex>
33 
35 #include "NumCpp/Core/Types.hpp"
36 #include "NumCpp/NdArray.hpp"
37 #include "NumCpp/Utils/sqr.hpp"
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  { squareSum += utils::sqr(static_cast<double>(value)); };
58 
59  switch (inAxis)
60  {
61  case Axis::NONE:
62  {
63  std::for_each(inArray.cbegin(), inArray.cend(), function);
64  NdArray<double> returnArray = { std::sqrt(squareSum / static_cast<double>(inArray.size())) };
65  return returnArray;
66  }
67  case Axis::COL:
68  {
69  NdArray<double> returnArray(1, inArray.numRows());
70  for (uint32 row = 0; row < inArray.numRows(); ++row)
71  {
72  squareSum = 0.0;
73  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
74  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(inArray.numCols()));
75  }
76 
77  return returnArray;
78  }
79  case Axis::ROW:
80  {
81  NdArray<dtype> transposedArray = inArray.transpose();
82  NdArray<double> returnArray(1, transposedArray.numRows());
83  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
84  {
85  squareSum = 0.0;
86  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
87  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(transposedArray.numCols()));
88  }
89 
90  return returnArray;
91  }
92  default:
93  {
94  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
95  return {}; // get rid of compiler warning
96  }
97  }
98  }
99 
100  //============================================================================
101  // Method Description:
109  template<typename dtype>
110  NdArray<std::complex<double>> rms(const NdArray<std::complex<dtype>>& inArray, Axis inAxis = Axis::NONE)
111  {
113 
114  std::complex<double> squareSum = 0.0;
115  const auto function = [&squareSum](std::complex<dtype> value) -> void
116  { squareSum += utils::sqr(complex_cast<double>(value)); };
117 
118  switch (inAxis)
119  {
120  case Axis::NONE:
121  {
122  std::for_each(inArray.cbegin(), inArray.cend(), function);
123  NdArray<std::complex<double>> returnArray = { std::sqrt(squareSum /
124  static_cast<double>(inArray.size())) };
125  return returnArray;
126  }
127  case Axis::COL:
128  {
129  NdArray<std::complex<double>> returnArray(1, inArray.numRows());
130  for (uint32 row = 0; row < inArray.numRows(); ++row)
131  {
132  squareSum = std::complex<double>(0.0, 0.0);
133  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
134  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(inArray.numCols()));
135  }
136 
137  return returnArray;
138  }
139  case Axis::ROW:
140  {
141  NdArray<std::complex<dtype>> transposedArray = inArray.transpose();
142  NdArray<std::complex<double>> returnArray(1, transposedArray.numRows());
143  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
144  {
145  squareSum = std::complex<double>(0.0, 0.0);
146  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
147  returnArray(0, row) = std::sqrt(squareSum / static_cast<double>(transposedArray.numCols()));
148  }
149 
150  return returnArray;
151  }
152  default:
153  {
154  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
155  return {}; // get rid of compiler warning
156  }
157  }
158  }
159 } // 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:3416
size_type size() const noexcept
Definition: NdArrayCore.hpp:4289
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1221
uint32 numRows() const noexcept
Definition: NdArrayCore.hpp:3428
NdArray< dtype > transpose() const
Definition: NdArrayCore.hpp:4650
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1529
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:227
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:47
auto sqrt(dtype inValue) noexcept
Definition: sqrt.hpp:48
std::uint32_t uint32
Definition: Types.hpp:40