NumCpp  2.5.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
mean.hpp
Go to the documentation of this file.
1 #pragma once
29 
31 #include "NumCpp/Core/Shape.hpp"
32 #include "NumCpp/Core/Types.hpp"
33 #include "NumCpp/NdArray.hpp"
34 
35 #include <complex>
36 #include <numeric>
37 
38 namespace nc
39 {
40  //===========================================================================
41  // Method Description:
52  template<typename dtype>
53  NdArray<double> mean(const NdArray<dtype>& inArray, Axis inAxis = Axis::NONE)
54  {
56 
57  switch (inAxis)
58  {
59  case Axis::NONE:
60  {
61  auto sum = std::accumulate(inArray.cbegin(), inArray.cend(), 0.0);
62  NdArray<double> returnArray = { sum /= static_cast<double>(inArray.size()) };
63 
64  return returnArray;
65  }
66  case Axis::COL:
67  {
68  NdArray<double> returnArray(1, inArray.numRows());
69  for (uint32 row = 0; row < inArray.numRows(); ++row)
70  {
71  auto sum = std::accumulate(inArray.cbegin(row), inArray.cend(row), 0.0);
72  returnArray(0, row) = sum / static_cast<double>(inArray.numCols());
73  }
74 
75  return returnArray;
76  }
77  case Axis::ROW:
78  {
79  NdArray<dtype> transposedArray = inArray.transpose();
80  NdArray<double> returnArray(1, transposedArray.numRows());
81  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
82  {
83  auto sum = static_cast<double>(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:
109  template<typename dtype>
110  NdArray<std::complex<double>> mean(const NdArray<std::complex<dtype>>& inArray, Axis inAxis = Axis::NONE)
111  {
113 
114  switch (inAxis)
115  {
116  case Axis::NONE:
117  {
118  auto sum = std::accumulate(inArray.cbegin(), inArray.cend(), std::complex<double>(0.0));
119  NdArray<std::complex<double>> returnArray = { sum /= std::complex<double>(inArray.size()) };
120 
121  return returnArray;
122  }
123  case Axis::COL:
124  {
125  NdArray<std::complex<double>> returnArray(1, inArray.numRows());
126  for (uint32 row = 0; row < inArray.numRows(); ++row)
127  {
128  auto sum = std::accumulate(inArray.cbegin(row), inArray.cend(row), std::complex<double>(0.0));
129  returnArray(0, row) = sum / std::complex<double>(inArray.numCols());
130  }
131 
132  return returnArray;
133  }
134  case Axis::ROW:
135  {
136  NdArray<std::complex<double>> transposedArray = inArray.transpose();
137  NdArray<std::complex<double>> returnArray(1, transposedArray.numRows());
138  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
139  {
140  auto sum = std::accumulate(transposedArray.cbegin(row), 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:3602
size_type size() const noexcept
Definition: NdArrayCore.hpp:4497
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1270
uint32 numRows() const noexcept
Definition: NdArrayCore.hpp:3615
NdArray< dtype > transpose() const
Definition: NdArrayCore.hpp:4830
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1614
Definition: Coordinate.hpp:45
Axis
Enum To describe an axis.
Definition: Types.hpp:46
NdArray< dtype > sum(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: sum.hpp:47
NdArray< double > mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: mean.hpp:53
std::uint32_t uint32
Definition: Types.hpp:40