NumCpp  2.8.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
norm.hpp
Go to the documentation of this file.
1 #pragma once
29 
30 #include <algorithm>
31 #include <cmath>
32 #include <complex>
33 
35 #include "NumCpp/Core/Types.hpp"
36 #include "NumCpp/NdArray.hpp"
37 #include "NumCpp/Utils/sqr.hpp"
38 
39 namespace nc
40 {
41  //============================================================================
42  // Method Description:
50  template<typename dtype>
52  {
54 
55  double sumOfSquares = 0.0;
56  const auto function = [&sumOfSquares](dtype value) -> void
57  { sumOfSquares += utils::sqr(static_cast<double>(value)); };
58 
59  switch (inAxis)
60  {
61  case Axis::NONE:
62  {
63  std::for_each(inArray.cbegin(), inArray.cend(), function);
64 
65  NdArray<double> returnArray = { std::sqrt(sumOfSquares) };
66  return returnArray;
67  }
68  case Axis::COL:
69  {
70  NdArray<double> returnArray(1, inArray.numRows());
71  for (uint32 row = 0; row < inArray.numRows(); ++row)
72  {
73  sumOfSquares = 0.0;
74  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
75  returnArray(0, row) = std::sqrt(sumOfSquares);
76  }
77 
78  return returnArray;
79  }
80  case Axis::ROW:
81  {
82  NdArray<dtype> transposedArray = inArray.transpose();
83  NdArray<double> returnArray(1, transposedArray.numRows());
84  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
85  {
86  sumOfSquares = 0.0;
87  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
88  returnArray(0, row) = std::sqrt(sumOfSquares);
89  }
90 
91  return returnArray;
92  }
93  default:
94  {
95  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
96  return {}; // get rid of compiler warning
97  }
98  }
99  }
100 
101  //============================================================================
102  // Method Description:
110  template<typename dtype>
111  NdArray<std::complex<double>> norm(const NdArray<std::complex<dtype>>& inArray, Axis inAxis = Axis::NONE)
112  {
114 
115  std::complex<double> sumOfSquares(0.0, 0.0);
116  const auto function = [&sumOfSquares](const std::complex<dtype>& value) -> void
117  { sumOfSquares += utils::sqr(complex_cast<double>(value)); };
118 
119  switch (inAxis)
120  {
121  case Axis::NONE:
122  {
123  std::for_each(inArray.cbegin(), inArray.cend(), function);
124 
125  NdArray<std::complex<double>> returnArray = { std::sqrt(sumOfSquares) };
126  return returnArray;
127  }
128  case Axis::COL:
129  {
130  NdArray<std::complex<double>> returnArray(1, inArray.numRows());
131  for (uint32 row = 0; row < inArray.numRows(); ++row)
132  {
133  sumOfSquares = std::complex<double>(0.0, 0.0);
134  std::for_each(inArray.cbegin(row), inArray.cend(row), function);
135  returnArray(0, row) = std::sqrt(sumOfSquares);
136  }
137 
138  return returnArray;
139  }
140  case Axis::ROW:
141  {
142  NdArray<std::complex<dtype>> transposedArray = inArray.transpose();
143  NdArray<std::complex<double>> returnArray(1, transposedArray.numRows());
144  for (uint32 row = 0; row < transposedArray.numRows(); ++row)
145  {
146  sumOfSquares = std::complex<double>(0.0, 0.0);
147  std::for_each(transposedArray.cbegin(row), transposedArray.cend(row), function);
148  returnArray(0, row) = std::sqrt(sumOfSquares);
149  }
150 
151  return returnArray;
152  }
153  default:
154  {
155  THROW_INVALID_ARGUMENT_ERROR("Unimplemented axis type.");
156  return {}; // get rid of compiler warning
157  }
158  }
159  }
160 } // namespace nc
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
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
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:227
constexpr dtype sqr(dtype inValue) noexcept
Definition: sqr.hpp:44
Definition: Coordinate.hpp:45
Axis
Enum To describe an axis.
Definition: Types.hpp:47
auto sqrt(dtype inValue) noexcept
Definition: sqrt.hpp:48
NdArray< double > norm(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: norm.hpp:51
std::uint32_t uint32
Definition: Types.hpp:40