NumCpp  2.4.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
stdev.hpp
Go to the documentation of this file.
1 #pragma once
29 
30 #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:
52  template<typename dtype>
53  NdArray<double> stdev(const NdArray<dtype>& inArray, Axis inAxis = Axis::NONE)
54  {
56 
57  double meanValue = 0.0;
58  double sum = 0.0;
59 
60  const auto function = [&sum, &meanValue](dtype value) -> void
61  {
62  sum += utils::sqr(static_cast<double>(value) - meanValue);
63  };
64 
65  switch (inAxis)
66  {
67  case Axis::NONE:
68  {
69  meanValue = mean(inArray, inAxis).item();
70  std::for_each(inArray.cbegin(), inArray.cend(), function);
71 
72  NdArray<double> returnArray = { std::sqrt(sum / inArray.size()) };
73  return returnArray;
74  }
75  case Axis::COL:
76  {
77  NdArray<double> meanValueArray = mean(inArray, inAxis);
78  NdArray<double> returnArray(1, inArray.numRows());
79  for (uint32 row = 0; row < inArray.numRows(); ++row)
80  {
81  meanValue = meanValueArray[row];
82  sum = 0.0;
83  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
84 
85  returnArray(0, row) = std::sqrt(sum / inArray.numCols());
86  }
87 
88  return returnArray;
89  }
90  case Axis::ROW:
91  {
92  NdArray<double> meanValueArray = mean(inArray, inAxis);
93  NdArray<dtype> transposedArray = inArray.transpose();
94  NdArray<double> returnArray(1, transposedArray.numRows());
95  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
96  {
97  meanValue = meanValueArray[row];
98  sum = 0.0;
99  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
100 
101  returnArray(0, row) = std::sqrt(sum / transposedArray.numCols());
102  }
103 
104  return returnArray;
105  }
106  default:
107  {
108  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
109  return {}; // get rid of compiler warning
110  }
111  }
112  }
113 
114  //============================================================================
115  // Method Description:
125  template<typename dtype>
126  NdArray<std::complex<double>> stdev(const NdArray<std::complex<dtype>>& inArray, Axis inAxis = Axis::NONE)
127  {
129 
130  std::complex<double> meanValue(0.0, 0.0);
131  std::complex<double> sum(0.0, 0.0);
132 
133  const auto function = [&sum, &meanValue](std::complex<dtype> value) -> void
134  {
135  sum += utils::sqr(complex_cast<double>(value) - meanValue);
136  };
137 
138  switch (inAxis)
139  {
140  case Axis::NONE:
141  {
142  meanValue = mean(inArray, inAxis).item();
143  std::for_each(inArray.cbegin(), inArray.cend(), function);
144 
145  NdArray<std::complex<double>> returnArray = { std::sqrt(sum / static_cast<double>(inArray.size())) };
146  return returnArray;
147  }
148  case Axis::COL:
149  {
150  NdArray<std::complex<double>> meanValueArray = mean(inArray, inAxis);
151  NdArray<std::complex<double>> returnArray(1, inArray.numRows());
152  for (uint32 row = 0; row < inArray.numRows(); ++row)
153  {
154  meanValue = meanValueArray[row];
155  sum = std::complex<double>(0.0, 0.0);
156  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
157 
158  returnArray(0, row) = std::sqrt(sum / static_cast<double>(inArray.numCols()));
159  }
160 
161  return returnArray;
162  }
163  case Axis::ROW:
164  {
165  NdArray<std::complex<double>> meanValueArray = mean(inArray, inAxis);
166  NdArray<std::complex<dtype>> transposedArray = inArray.transpose();
167  NdArray<std::complex<double>> returnArray(1, transposedArray.numRows());
168  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
169  {
170  meanValue = meanValueArray[row];
171  sum = std::complex<double>(0.0, 0.0);
172  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
173 
174  returnArray(0, row) = std::sqrt(sum / static_cast<double>(transposedArray.numCols()));
175  }
176 
177  return returnArray;
178  }
179  default:
180  {
181  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
182  return {}; // get rid of compiler warning
183  }
184  }
185  }
186 } // namespace nc
nc::NdArray::item
value_type item() const
Definition: NdArrayCore.hpp:2975
nc::Axis::NONE
@ NONE
STATIC_ASSERT_ARITHMETIC
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
nc::Axis::ROW
@ ROW
nc::sqrt
auto sqrt(dtype inValue) noexcept
Definition: sqrt.hpp:50
nc::mean
NdArray< double > mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: mean.hpp:53
nc::NdArray::transpose
NdArray< dtype > transpose() const
Definition: NdArrayCore.hpp:4652
nc::NdArray< double >
nc::stl_algorithms::for_each
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:213
nc::uint32
std::uint32_t uint32
Definition: Types.hpp:40
nc::NdArray::numCols
uint32 numCols() const noexcept
Definition: NdArrayCore.hpp:3475
NdArray.hpp
nc::NdArray::size
size_type size() const noexcept
Definition: NdArrayCore.hpp:4370
nc::sum
NdArray< dtype > sum(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: sum.hpp:47
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1487
nc::Axis
Axis
Enum To describe an axis.
Definition: Types.hpp:46
nc::stdev
NdArray< double > stdev(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: stdev.hpp:53
nc
Definition: Coordinate.hpp:44
sqr.hpp
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1143
nc::utils::sqr
constexpr dtype sqr(dtype inValue) noexcept
Definition: sqr.hpp:44
Types.hpp
nc::NdArray::numRows
uint32 numRows() const noexcept
Definition: NdArrayCore.hpp:3488
nc::Axis::COL
@ COL
mean.hpp