NumCpp  2.8.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
mean.hpp
Go to the documentation of this file.
1 #pragma once
29 
30 #include <complex>
31 #include <numeric>
32 
34 #include "NumCpp/Core/Shape.hpp"
35 #include "NumCpp/Core/Types.hpp"
36 #include "NumCpp/NdArray.hpp"
37 
38 namespace nc
39 {
40  //===========================================================================
41  // Method Description:
51  template<typename dtype>
53  {
55 
56  switch (inAxis)
57  {
58  case Axis::NONE:
59  {
60  auto sum = std::accumulate(inArray.cbegin(), inArray.cend(), 0.0);
61  NdArray<double> returnArray = { sum /= static_cast<double>(inArray.size()) };
62 
63  return returnArray;
64  }
65  case Axis::COL:
66  {
67  NdArray<double> returnArray(1, inArray.numRows());
68  for (uint32 row = 0; row < inArray.numRows(); ++row)
69  {
70  auto sum = std::accumulate(inArray.cbegin(row), inArray.cend(row), 0.0);
71  returnArray(0, row) = sum / static_cast<double>(inArray.numCols());
72  }
73 
74  return returnArray;
75  }
76  case Axis::ROW:
77  {
78  NdArray<dtype> transposedArray = inArray.transpose();
79  NdArray<double> returnArray(1, transposedArray.numRows());
80  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
81  {
82  auto sum = static_cast<double>(
83  std::accumulate(transposedArray.cbegin(row), transposedArray.cend(row), 0.0));
84  returnArray(0, row) = sum / static_cast<double>(transposedArray.numCols());
85  }
86 
87  return returnArray;
88  }
89  default:
90  {
91  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
92  return {};
93  }
94  }
95  }
96 
97  //============================================================================
98  // Method Description:
108  template<typename dtype>
109  NdArray<std::complex<double>> mean(const NdArray<std::complex<dtype>>& inArray, Axis inAxis = Axis::NONE)
110  {
112 
113  switch (inAxis)
114  {
115  case Axis::NONE:
116  {
117  auto sum = std::accumulate(inArray.cbegin(), inArray.cend(), std::complex<double>(0.0));
118  NdArray<std::complex<double>> returnArray = { sum /= std::complex<double>(inArray.size()) };
119 
120  return returnArray;
121  }
122  case Axis::COL:
123  {
124  NdArray<std::complex<double>> returnArray(1, inArray.numRows());
125  for (uint32 row = 0; row < inArray.numRows(); ++row)
126  {
127  auto sum = std::accumulate(inArray.cbegin(row), inArray.cend(row), std::complex<double>(0.0));
128  returnArray(0, row) = sum / std::complex<double>(inArray.numCols());
129  }
130 
131  return returnArray;
132  }
133  case Axis::ROW:
134  {
135  NdArray<std::complex<double>> transposedArray = inArray.transpose();
136  NdArray<std::complex<double>> returnArray(1, transposedArray.numRows());
137  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
138  {
139  auto sum = std::accumulate(transposedArray.cbegin(row),
140  transposedArray.cend(row),
141  std::complex<double>(0.0));
142  returnArray(0, row) = sum / std::complex<double>(transposedArray.numCols());
143  }
144 
145  return returnArray;
146  }
147  default:
148  {
149  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
150  return {}; // get rid of compiler warning
151  }
152  }
153  }
154 } // 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
Definition: Coordinate.hpp:45
Axis
Enum To describe an axis.
Definition: Types.hpp:47
NdArray< dtype > sum(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: sum.hpp:46
NdArray< double > mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: mean.hpp:52
std::uint32_t uint32
Definition: Types.hpp:40