NumCpp  2.4.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
fmod.hpp
Go to the documentation of this file.
1 #pragma once
29 
33 #include "NumCpp/NdArray.hpp"
34 
35 #include <string>
36 
37 namespace nc
38 {
39  //============================================================================
40  // Method Description:
51  template<typename dtype>
52  dtype fmod(dtype inValue1, dtype inValue2) noexcept
53  {
54  STATIC_ASSERT_INTEGER(dtype);
55 
56  return inValue1 % inValue2;
57  }
58 
59  //============================================================================
60  // Method Description:
71  template<typename dtype>
72  NdArray<dtype> fmod(const NdArray<dtype>& inArray1, const NdArray<dtype>& inArray2)
73  {
74  if (inArray1.shape() != inArray2.shape())
75  {
76  THROW_INVALID_ARGUMENT_ERROR("input array shapes are not consistant.");
77  }
78 
79  NdArray<dtype> returnArray(inArray1.shape());
80 
81  stl_algorithms::transform(inArray1.cbegin(), inArray1.cend(), inArray2.cbegin(), returnArray.begin(),
82  [](dtype inValue1, dtype inValue2) noexcept -> dtype
83  {
84  return fmod(inValue1, inValue2);
85  });
86 
87  return returnArray;
88  }
89 } // namespace nc
STATIC_ASSERT_INTEGER
#define STATIC_ASSERT_INTEGER(dtype)
Definition: StaticAsserts.hpp:40
StaticAsserts.hpp
nc::NdArray::shape
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4356
Error.hpp
nc::NdArray< dtype >
nc::stl_algorithms::transform
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
NdArray.hpp
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1487
nc
Definition: Coordinate.hpp:44
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1143
StlAlgorithms.hpp
nc::NdArray::begin
iterator begin() noexcept
Definition: NdArrayCore.hpp:1087
nc::fmod
dtype fmod(dtype inValue1, dtype inValue2) noexcept
Definition: fmod.hpp:52