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