NumCpp  1.0
A C++ implementation of the Python Numpy library
mean.hpp
Go to the documentation of this file.
1 #pragma once
30 
31 #include "NumCpp/NdArray.hpp"
32 #include "NumCpp/Core/Shape.hpp"
33 #include "NumCpp/Core/Types.hpp"
35 
36 #include <complex>
37 #include <numeric>
38 
39 namespace nc
40 {
41  //===========================================================================
42  // Method Description:
53  template<typename dtype>
54  NdArray<double> mean(const NdArray<dtype>& inArray, Axis inAxis = Axis::NONE)
55  {
57 
58  switch (inAxis)
59  {
60  case Axis::NONE:
61  {
62  auto sum = std::accumulate(inArray.cbegin(), inArray.cend(), 0.0);
63  NdArray<double> returnArray = { sum /= static_cast<double>(inArray.size()) };
64 
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  auto sum = std::accumulate(inArray.cbegin(row), inArray.cend(row), 0.0);
73  returnArray(0, row) = sum / static_cast<double>(inArray.numCols());
74  }
75 
76  return returnArray;
77  }
78  case Axis::ROW:
79  {
80  NdArray<dtype> transposedArray = inArray.transpose();
81  NdArray<double> returnArray(1, transposedArray.numRows());
82  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
83  {
84  double sum = static_cast<double>(std::accumulate(transposedArray.cbegin(row), transposedArray.cend(row), 0.0));
85  returnArray(0, row) = sum / static_cast<double>(transposedArray.numCols());
86  }
87 
88  return returnArray;
89  }
90  default:
91  {
92  return NdArray<double>(); // get rid of compiler warning
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  return NdArray<std::complex<double>>(); // get rid of compiler warning
150  }
151  }
152  }
153 }
StaticAsserts.hpp
nc::Axis::NONE
@ NONE
STATIC_ASSERT_ARITHMETIC
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:38
nc::Axis::ROW
@ ROW
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:4591
nc::NdArray< double >
nc::uint32
std::uint32_t uint32
Definition: Types.hpp:41
nc::NdArray::numCols
uint32 numCols() const noexcept
Definition: NdArrayCore.hpp:3415
NdArray.hpp
nc::NdArray::size
size_type size() const noexcept
Definition: NdArrayCore.hpp:4310
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
Shape.hpp
nc
Definition: Coordinate.hpp:45
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1147
Types.hpp
nc::NdArray::numRows
uint32 numRows() const noexcept
Definition: NdArrayCore.hpp:3428
nc::Axis::COL
@ COL