From f80b1a85c9af75b0f8dbc0a1895459d35a3f0a11 Mon Sep 17 00:00:00 2001 From: David Pilger Date: Tue, 28 Sep 2021 22:30:49 -0600 Subject: [PATCH 01/31] fixed typo in release notes --- docs/markdown/ReleaseNotes.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index 0c18de294..ade62314d 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -1,6 +1,5 @@ # Release Notes - ## Version 2.6.2 * `tofile` and `fromfile` will now work for generic struct dtypes From 26ce38785eda804776cf7a4c0e8f46d40838b298 Mon Sep 17 00:00:00 2001 From: David Pilger Date: Tue, 23 Nov 2021 20:23:06 -0700 Subject: [PATCH 02/31] Minor adjustment to NdArray::argsort --- include/NumCpp/NdArray/NdArrayCore.hpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index e714d84f3..46261ccee 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -2158,9 +2158,10 @@ namespace nc case Axis::COL: { NdArray returnArray(shape_); + std::vector idx(shape_.cols); + for (uint32 row = 0; row < shape_.rows; ++row) { - std::vector idx(shape_.cols); std::iota(idx.begin(), idx.end(), 0); const auto function = [this, row](uint32 i1, uint32 i2) noexcept -> bool @@ -2181,9 +2182,10 @@ namespace nc { NdArray arrayTransposed = transpose(); NdArray returnArray(shape_.cols, shape_.rows); + std::vector idx(arrayTransposed.shape_.cols); + for (uint32 row = 0; row < arrayTransposed.shape_.rows; ++row) { - std::vector idx(arrayTransposed.shape_.cols); std::iota(idx.begin(), idx.end(), 0); const auto function = [&arrayTransposed, row](uint32 i1, uint32 i2) noexcept -> bool From 72f089f97594c43846aacafb1be110c3edd11d0a Mon Sep 17 00:00:00 2001 From: David Pilger Date: Tue, 30 Nov 2021 22:01:56 -0700 Subject: [PATCH 03/31] fmod now supports floating point types --- include/NumCpp/Functions/fmod.hpp | 27 +++++++++++++++++++++++---- test/pytest/test_functions.py | 18 ++++++++++++++++-- test/src/NumCppPy.cpp | 6 ++++-- 3 files changed, 43 insertions(+), 8 deletions(-) diff --git a/include/NumCpp/Functions/fmod.hpp b/include/NumCpp/Functions/fmod.hpp index 1e675b22d..4f366fe5a 100644 --- a/include/NumCpp/Functions/fmod.hpp +++ b/include/NumCpp/Functions/fmod.hpp @@ -28,10 +28,11 @@ #pragma once #include "NumCpp/Core/Internal/Error.hpp" -#include "NumCpp/Core/Internal/StaticAsserts.hpp" #include "NumCpp/Core/Internal/StlAlgorithms.hpp" +#include "NumCpp/Core/Internal/TypeTraits.hpp" #include "NumCpp/NdArray.hpp" +#include #include namespace nc @@ -48,14 +49,32 @@ namespace nc /// @return /// value /// - template + template, int> = 0> dtype fmod(dtype inValue1, dtype inValue2) noexcept { - STATIC_ASSERT_INTEGER(dtype); - return inValue1 % inValue2; } + //============================================================================ + // Method Description: + /// Return the remainder of division. + /// + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html + /// + /// + /// @param inValue1 + /// @param inValue2 + /// @return + /// value + /// + template, int> = 0> + dtype fmod(dtype inValue1, dtype inValue2) noexcept + { + return std::fmod(inValue1, inValue2); + } + //============================================================================ // Method Description: /// Return the element-wise remainder of division. diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index d733171d3..bd83a2eef 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -2872,7 +2872,7 @@ def test_fmin(): def test_fmod(): value1 = np.random.randint(1, 100, [1, ]).item() * 100 + 1000 value2 = np.random.randint(1, 100, [1, ]).item() * 100 + 1000 - assert NumCpp.fmodScaler(value1, value2) == np.fmod(value1, value2) + assert NumCpp.fmodScalerInt(value1, value2) == np.fmod(value1, value2) shapeInput = np.random.randint(20, 100, [2, ]) shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) @@ -2882,7 +2882,21 @@ def test_fmod(): data2 = np.random.randint(1, 100, [shape.rows, shape.cols], dtype=np.uint32) * 100 + 1000 cArray1.setArray(data1) cArray2.setArray(data2) - assert np.array_equal(NumCpp.fmodArray(cArray1, cArray2), np.fmod(data1, data2)) + assert np.array_equal(NumCpp.fmodArrayInt(cArray1, cArray2), np.fmod(data1, data2)) + + value1 = np.random.randint(1, 100, [1, ]).item() * 100 + 1000.5 + value2 = np.random.randint(1, 100, [1, ]).item() * 100 + 1000.5 + assert NumCpp.fmodScalerFloat(value1, value2) == np.fmod(value1, value2) + + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray1 = NumCpp.NdArray(shape) + cArray2 = NumCpp.NdArray(shape) + data1 = np.random.randint(1, 100, [shape.rows, shape.cols], dtype=np.uint32).astype(float) * 100 + 1000.5 + data2 = np.random.randint(1, 100, [shape.rows, shape.cols], dtype=np.uint32).astype(float) * 100 + 1000.5 + cArray1.setArray(data1) + cArray2.setArray(data2) + assert np.array_equal(NumCpp.fmodArrayFloat(cArray1, cArray2), np.fmod(data1, data2)) #################################################################################### diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index bbfdfb805..eec4c318c 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -7417,8 +7417,10 @@ PYBIND11_MODULE(NumCppPy, m) m.def("fminScaler", &FunctionsInterface::fminScaler); m.def("fminArray", &FunctionsInterface::fminArray); m.def("fminArray", &FunctionsInterface::fminArray); - m.def("fmodScaler", &FunctionsInterface::fmodScaler); - m.def("fmodArray", &FunctionsInterface::fmodArray); + m.def("fmodScalerInt", &FunctionsInterface::fmodScaler); + m.def("fmodArrayInt", &FunctionsInterface::fmodArray); + m.def("fmodScalerFloat", &FunctionsInterface::fmodScaler); + m.def("fmodArrayFloat", &FunctionsInterface::fmodArray); m.def("frombuffer", &FunctionsInterface::frombuffer); m.def("frombuffer", &FunctionsInterface::frombuffer); m.def("fromfile", &FunctionsInterface::fromfileBinary); From 511680a9f7101aae1f2530df1bf3a1e960467bef Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 21 Dec 2021 15:17:13 -0700 Subject: [PATCH 04/31] fmod and % operator now support float dtypes --- docs/markdown/ReleaseNotes.md | 6 + include/NumCpp/Core/Internal/Version.hpp | 2 +- include/NumCpp/Functions/angle.hpp | 2 +- include/NumCpp/Functions/conj.hpp | 2 +- include/NumCpp/Functions/copySign.hpp | 2 +- include/NumCpp/Functions/gradient.hpp | 4 +- include/NumCpp/Functions/imag.hpp | 2 +- include/NumCpp/Functions/logical_not.hpp | 2 +- include/NumCpp/Functions/logical_xor.hpp | 2 +- include/NumCpp/Functions/maximum.hpp | 2 +- include/NumCpp/Functions/minimum.hpp | 2 +- include/NumCpp/Functions/nanmean.hpp | 12 +- include/NumCpp/Functions/norm.hpp | 4 +- include/NumCpp/Functions/polar.hpp | 2 +- include/NumCpp/Functions/power.hpp | 2 +- include/NumCpp/Functions/proj.hpp | 2 +- include/NumCpp/Functions/real.hpp | 2 +- include/NumCpp/Functions/reciprocal.hpp | 2 +- include/NumCpp/Functions/remainder.hpp | 2 +- include/NumCpp/Functions/rms.hpp | 4 +- include/NumCpp/Functions/var.hpp | 4 +- include/NumCpp/NdArray/NdArrayCore.hpp | 12 +- include/NumCpp/NdArray/NdArrayOperators.hpp | 172 ++++++++++++++------ include/NumCpp/Polynomial/Poly1d.hpp | 2 +- include/NumCpp/Rotations/Quaternion.hpp | 2 +- test/pytest/test_ndarray_operators.py | 26 +++ test/src/NumCppPy.cpp | 34 ++-- 27 files changed, 210 insertions(+), 102 deletions(-) diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index ade62314d..5fa482bde 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -1,5 +1,11 @@ # Release Notes +## Version 2.6.3 + +* added `select` function +* `fmod` and the modulus `%` operator now work with float dtypes +* minor performance improvements + ## Version 2.6.2 * `tofile` and `fromfile` will now work for generic struct dtypes diff --git a/include/NumCpp/Core/Internal/Version.hpp b/include/NumCpp/Core/Internal/Version.hpp index 62986b40e..562fdf668 100644 --- a/include/NumCpp/Core/Internal/Version.hpp +++ b/include/NumCpp/Core/Internal/Version.hpp @@ -29,5 +29,5 @@ namespace nc { - constexpr char VERSION[] = "2.6.2"; ///< Current NumCpp version number + constexpr char VERSION[] = "2.6.3"; ///< Current NumCpp version number } // namespace nc diff --git a/include/NumCpp/Functions/angle.hpp b/include/NumCpp/Functions/angle.hpp index f1557827c..7fd76fb82 100644 --- a/include/NumCpp/Functions/angle.hpp +++ b/include/NumCpp/Functions/angle.hpp @@ -70,7 +70,7 @@ namespace nc { NdArray{0}))> returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), - [](auto& inValue) -> auto + [](auto& inValue) -> auto { return angle(inValue); }); diff --git a/include/NumCpp/Functions/conj.hpp b/include/NumCpp/Functions/conj.hpp index 85e2a4d8f..f4b143466 100644 --- a/include/NumCpp/Functions/conj.hpp +++ b/include/NumCpp/Functions/conj.hpp @@ -70,7 +70,7 @@ namespace nc { NdArray{0}))> returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), - [](auto& inValue) -> auto + [](auto& inValue) -> auto { return nc::conj(inValue); }); diff --git a/include/NumCpp/Functions/copySign.hpp b/include/NumCpp/Functions/copySign.hpp index e844d1f58..4cc01427e 100644 --- a/include/NumCpp/Functions/copySign.hpp +++ b/include/NumCpp/Functions/copySign.hpp @@ -60,7 +60,7 @@ namespace nc NdArray returnArray(inArray1.shape()); stl_algorithms::transform(inArray1.cbegin(), inArray1.cend(), inArray2.cbegin(), returnArray.begin(), - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return inValue2 < dtype{ 0 } ? std::abs(inValue1) * -1 : std::abs(inValue1); }); diff --git a/include/NumCpp/Functions/gradient.hpp b/include/NumCpp/Functions/gradient.hpp index 0ca5fd813..d1d37cf46 100644 --- a/include/NumCpp/Functions/gradient.hpp +++ b/include/NumCpp/Functions/gradient.hpp @@ -126,7 +126,7 @@ namespace nc returnArray[-1] = static_cast(inArray[-1]) - static_cast(inArray[-2]); stl_algorithms::transform(inArray.cbegin() + 2, inArray.cend(), inArray.cbegin(), returnArray.begin() + 1, - [](dtype value1, dtype value2) -> double + [](dtype value1, dtype value2) -> double { return (static_cast(value1) - static_cast(value2)) / 2.0; }); @@ -224,7 +224,7 @@ namespace nc returnArray[-1] = complex_cast(inArray[-1]) - complex_cast(inArray[-2]); stl_algorithms::transform(inArray.cbegin() + 2, inArray.cend(), inArray.cbegin(), returnArray.begin() + 1, - [](const std::complex& value1, const std::complex& value2) -> std::complex + [](const std::complex& value1, const std::complex& value2) -> std::complex { return (complex_cast(value1) - complex_cast(value2)) / 2.0; }); diff --git a/include/NumCpp/Functions/imag.hpp b/include/NumCpp/Functions/imag.hpp index 591a1e912..e7166d020 100644 --- a/include/NumCpp/Functions/imag.hpp +++ b/include/NumCpp/Functions/imag.hpp @@ -69,7 +69,7 @@ namespace nc { NdArray{0}))> returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), - [](auto& inValue) -> auto + [](auto& inValue) -> auto { return nc::imag(inValue); }); diff --git a/include/NumCpp/Functions/logical_not.hpp b/include/NumCpp/Functions/logical_not.hpp index 56f350649..f5d1367f9 100644 --- a/include/NumCpp/Functions/logical_not.hpp +++ b/include/NumCpp/Functions/logical_not.hpp @@ -52,7 +52,7 @@ namespace nc NdArray returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), - [](dtype inValue) -> bool + [](dtype inValue) -> bool { return inValue == dtype{ 0 }; }); diff --git a/include/NumCpp/Functions/logical_xor.hpp b/include/NumCpp/Functions/logical_xor.hpp index e547275f0..ae37dd09b 100644 --- a/include/NumCpp/Functions/logical_xor.hpp +++ b/include/NumCpp/Functions/logical_xor.hpp @@ -60,7 +60,7 @@ namespace nc NdArray returnArray(inArray1.shape()); stl_algorithms::transform(inArray1.cbegin(), inArray1.cend(), inArray2.cbegin(), returnArray.begin(), - [](dtype inValue1, dtype inValue2) -> bool + [](dtype inValue1, dtype inValue2) -> bool { return (inValue1 != dtype{ 0 }) != (inValue2 != dtype{ 0 }); }); diff --git a/include/NumCpp/Functions/maximum.hpp b/include/NumCpp/Functions/maximum.hpp index a3082ee61..f64f2315e 100644 --- a/include/NumCpp/Functions/maximum.hpp +++ b/include/NumCpp/Functions/maximum.hpp @@ -68,7 +68,7 @@ namespace nc NdArray returnArray(inArray1.shape()); stl_algorithms::transform(inArray1.cbegin(), inArray1.cend(), inArray2.cbegin(), returnArray.begin(), - [comparitor](dtype inValue1, dtype inValue2) -> dtype + [comparitor](dtype inValue1, dtype inValue2) -> dtype { return std::max(inValue1, inValue2, comparitor); }); diff --git a/include/NumCpp/Functions/minimum.hpp b/include/NumCpp/Functions/minimum.hpp index 926e813dd..3257408a4 100644 --- a/include/NumCpp/Functions/minimum.hpp +++ b/include/NumCpp/Functions/minimum.hpp @@ -66,7 +66,7 @@ namespace nc NdArray returnArray(inArray1.shape()); stl_algorithms::transform(inArray1.cbegin(), inArray1.cend(), inArray2.cbegin(), returnArray.begin(), - [comparitor](dtype inValue1, dtype inValue2) -> dtype + [comparitor](dtype inValue1, dtype inValue2) -> dtype { return std::min(inValue1, inValue2, comparitor); }); diff --git a/include/NumCpp/Functions/nanmean.hpp b/include/NumCpp/Functions/nanmean.hpp index a1f70332a..4b1665357 100644 --- a/include/NumCpp/Functions/nanmean.hpp +++ b/include/NumCpp/Functions/nanmean.hpp @@ -61,13 +61,13 @@ namespace nc case Axis::NONE: { auto sum = static_cast(std::accumulate(inArray.cbegin(), inArray.cend(), 0.0, - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return std::isnan(inValue2) ? inValue1 : inValue1 + inValue2; })); const auto numberNonNan = static_cast(std::accumulate(inArray.cbegin(), inArray.cend(), 0.0, - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return std::isnan(inValue2) ? inValue1 : inValue1 + 1; })); @@ -83,13 +83,13 @@ namespace nc for (uint32 row = 0; row < inShape.rows; ++row) { auto sum = static_cast(std::accumulate(inArray.cbegin(row), inArray.cend(row), 0.0, - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return std::isnan(inValue2) ? inValue1 : inValue1 + inValue2; })); auto numberNonNan = static_cast(std::accumulate(inArray.cbegin(row), inArray.cend(row), 0.0, - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return std::isnan(inValue2) ? inValue1 : inValue1 + 1; })); @@ -107,13 +107,13 @@ namespace nc for (uint32 row = 0; row < transShape.rows; ++row) { auto sum = static_cast(std::accumulate(transposedArray.cbegin(row), transposedArray.cend(row), 0.0, - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return std::isnan(inValue2) ? inValue1 : inValue1 + inValue2; })); auto numberNonNan = static_cast(std::accumulate(transposedArray.cbegin(row), transposedArray.cend(row), 0.0, - [](dtype inValue1, dtype inValue2) -> dtype + [](dtype inValue1, dtype inValue2) -> dtype { return std::isnan(inValue2) ? inValue1 : inValue1 + 1; })); diff --git a/include/NumCpp/Functions/norm.hpp b/include/NumCpp/Functions/norm.hpp index 162cc537d..d738f7ed9 100644 --- a/include/NumCpp/Functions/norm.hpp +++ b/include/NumCpp/Functions/norm.hpp @@ -54,7 +54,7 @@ namespace nc STATIC_ASSERT_ARITHMETIC(dtype); double sumOfSquares = 0.0; - const auto function = [&sumOfSquares](dtype value) -> void + const auto function = [&sumOfSquares](dtype value) -> void { sumOfSquares += utils::sqr(static_cast(value)); }; @@ -117,7 +117,7 @@ namespace nc STATIC_ASSERT_ARITHMETIC(dtype); std::complex sumOfSquares(0.0, 0.0); - const auto function = [&sumOfSquares](const std::complex& value) -> void + const auto function = [&sumOfSquares](const std::complex& value) -> void { sumOfSquares += utils::sqr(complex_cast(value)); }; diff --git a/include/NumCpp/Functions/polar.hpp b/include/NumCpp/Functions/polar.hpp index 87e256d48..1ceca21d0 100644 --- a/include/NumCpp/Functions/polar.hpp +++ b/include/NumCpp/Functions/polar.hpp @@ -73,7 +73,7 @@ namespace nc NdArray returnArray(magnitude.shape()); stl_algorithms::transform(magnitude.cbegin(), magnitude.cend(), phaseAngle.begin(), returnArray.begin(), - [](dtype mag, dtype angle) -> auto + [](dtype mag, dtype angle) -> auto { return nc::polar(mag, angle); }); diff --git a/include/NumCpp/Functions/power.hpp b/include/NumCpp/Functions/power.hpp index a6350a181..e1659e4c6 100644 --- a/include/NumCpp/Functions/power.hpp +++ b/include/NumCpp/Functions/power.hpp @@ -100,7 +100,7 @@ namespace nc NdArray returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), inExponents.cbegin(), returnArray.begin(), - [](dtype inValue, uint8 inExponent) -> dtype + [](dtype inValue, uint8 inExponent) -> dtype { return nc::power(inValue, inExponent); }); diff --git a/include/NumCpp/Functions/proj.hpp b/include/NumCpp/Functions/proj.hpp index 1b969908c..f077e65b5 100644 --- a/include/NumCpp/Functions/proj.hpp +++ b/include/NumCpp/Functions/proj.hpp @@ -66,7 +66,7 @@ namespace nc { NdArray{0}))> returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), - [](auto& inValue) -> auto + [](auto& inValue) -> auto { return nc::proj(inValue); }); diff --git a/include/NumCpp/Functions/real.hpp b/include/NumCpp/Functions/real.hpp index 0cfcb7db3..3d86d8555 100644 --- a/include/NumCpp/Functions/real.hpp +++ b/include/NumCpp/Functions/real.hpp @@ -70,7 +70,7 @@ namespace nc { NdArray{0}))> returnArray(inArray.shape()); stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), - [](auto& inValue) -> auto + [](auto& inValue) -> auto { return nc::real(inValue); }); diff --git a/include/NumCpp/Functions/reciprocal.hpp b/include/NumCpp/Functions/reciprocal.hpp index 6e95cb5c0..c6f2cd9f8 100644 --- a/include/NumCpp/Functions/reciprocal.hpp +++ b/include/NumCpp/Functions/reciprocal.hpp @@ -91,7 +91,7 @@ namespace nc uint32 counter = 0; std::for_each(inArray.cbegin(), inArray.cend(), - [&returnArray, &counter](std::complex value) -> void + [&returnArray, &counter](std::complex value) -> void { returnArray[counter++] = std::complex(1.0) / complex_cast(value); }); diff --git a/include/NumCpp/Functions/remainder.hpp b/include/NumCpp/Functions/remainder.hpp index f0bb1b602..5dd0a646e 100644 --- a/include/NumCpp/Functions/remainder.hpp +++ b/include/NumCpp/Functions/remainder.hpp @@ -55,7 +55,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - return std::remainder(static_cast(inValue1), static_cast(inValue2)); + return static_cast(std::remainder(inValue1, inValue2)); } //============================================================================ diff --git a/include/NumCpp/Functions/rms.hpp b/include/NumCpp/Functions/rms.hpp index cee49462f..d5ab50b96 100644 --- a/include/NumCpp/Functions/rms.hpp +++ b/include/NumCpp/Functions/rms.hpp @@ -54,7 +54,7 @@ namespace nc STATIC_ASSERT_ARITHMETIC(dtype); double squareSum = 0.0; - const auto function = [&squareSum](dtype value) -> void + const auto function = [&squareSum](dtype value) -> void { squareSum += utils::sqr(static_cast(value)); }; @@ -116,7 +116,7 @@ namespace nc STATIC_ASSERT_ARITHMETIC(dtype); std::complex squareSum = 0.0; - const auto function = [&squareSum](std::complex value) -> void + const auto function = [&squareSum](std::complex value) -> void { squareSum += utils::sqr(complex_cast(value)); }; diff --git a/include/NumCpp/Functions/var.hpp b/include/NumCpp/Functions/var.hpp index 1ce170e0a..e54f74e0d 100644 --- a/include/NumCpp/Functions/var.hpp +++ b/include/NumCpp/Functions/var.hpp @@ -54,7 +54,7 @@ namespace nc STATIC_ASSERT_ARITHMETIC(dtype); NdArray stdValues = stdev(inArray, inAxis); - const auto function = [](double& value) -> void + const auto function = [](double& value) -> void { value *= value; }; @@ -81,7 +81,7 @@ namespace nc STATIC_ASSERT_ARITHMETIC(dtype); NdArray> stdValues = stdev(inArray, inAxis); - const auto function = [](std::complex& value) -> void + const auto function = [](std::complex& value) -> void { value *= value; }; diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index 46261ccee..d1010ce8f 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -1908,7 +1908,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [](dtype i) -> bool + const auto function = [](dtype i) -> bool { return i != dtype{ 0 }; }; @@ -1964,7 +1964,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [](dtype i) -> bool + const auto function = [](dtype i) -> bool { return i != dtype{ 0 }; }; @@ -2234,7 +2234,7 @@ namespace nc } else { - const auto function = [](dtype value) -> dtypeOut + const auto function = [](dtype value) -> dtypeOut { return static_cast(value); }; @@ -2263,7 +2263,7 @@ namespace nc { NdArray outArray(shape_); - const auto function = [](const_reference value) -> dtypeOut + const auto function = [](const_reference value) -> dtypeOut { return std::complex(value); }; @@ -2326,7 +2326,7 @@ namespace nc { NdArray outArray(shape_); - const auto function = [](const_reference value) -> dtypeOut + const auto function = [](const_reference value) -> dtypeOut { return static_cast(value.real()); }; @@ -3539,7 +3539,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [](dtype i) -> bool + const auto function = [](dtype i) -> bool { return i != dtype{ 0 }; }; diff --git a/include/NumCpp/NdArray/NdArrayOperators.hpp b/include/NumCpp/NdArray/NdArrayOperators.hpp index 1ca69b7c5..27fc73500 100644 --- a/include/NumCpp/NdArray/NdArrayOperators.hpp +++ b/include/NumCpp/NdArray/NdArrayOperators.hpp @@ -31,11 +31,13 @@ #include "NumCpp/Core/Internal/StaticAsserts.hpp" #include "NumCpp/Core/Internal/StdComplexOperators.hpp" #include "NumCpp/Core/Internal/StlAlgorithms.hpp" +#include "NumCpp/Core/Internal/TypeTraits.hpp" #include "NumCpp/Functions/complex.hpp" #include "NumCpp/NdArray/NdArrayCore.hpp" #include "NumCpp/Utils/essentiallyEqual.hpp" #include +#include #include #include @@ -108,7 +110,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value += rhs; }; @@ -132,7 +134,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex& value) -> std::complex + const auto function = [rhs](std::complex& value) -> std::complex { return value += rhs; }; @@ -226,7 +228,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype value) -> dtype + const auto function = [rhs](dtype value) -> dtype { return value + rhs; }; @@ -265,7 +267,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](dtype value) -> std::complex + const auto function = [rhs](dtype value) -> std::complex { return value + rhs; }; @@ -304,7 +306,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex value) -> std::complex + const auto function = [rhs](std::complex value) -> std::complex { return value + rhs; }; @@ -397,7 +399,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value -= rhs; }; @@ -421,7 +423,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex& value) -> std::complex + const auto function = [rhs](std::complex& value) -> std::complex { return value -= rhs; }; @@ -532,7 +534,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype value) -> dtype + const auto function = [rhs](dtype value) -> dtype { return value - rhs; }; @@ -557,7 +559,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [lhs](dtype value) -> dtype + const auto function = [lhs](dtype value) -> dtype { return lhs - value; }; @@ -582,7 +584,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](dtype value) -> std::complex + const auto function = [rhs](dtype value) -> std::complex { return value - rhs; }; @@ -607,7 +609,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [lhs](dtype value) -> std::complex + const auto function = [lhs](dtype value) -> std::complex { return lhs - value; }; @@ -632,7 +634,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex value) -> std::complex + const auto function = [rhs](std::complex value) -> std::complex { return value - rhs; }; @@ -657,7 +659,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [lhs](std::complex value) -> std::complex + const auto function = [lhs](std::complex value) -> std::complex { return lhs - value; }; @@ -678,7 +680,7 @@ namespace nc template NdArray operator-(const NdArray& inArray) { - const auto function = [](dtype value) -> dtype + const auto function = [](dtype value) -> dtype { return -value; }; @@ -755,7 +757,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value *= rhs; }; @@ -779,7 +781,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex& value) -> std::complex + const auto function = [rhs](std::complex& value) -> std::complex { return value *= rhs; }; @@ -873,7 +875,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype value) -> dtype + const auto function = [rhs](dtype value) -> dtype { return value * rhs; }; @@ -912,7 +914,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](dtype value) -> std::complex + const auto function = [rhs](dtype value) -> std::complex { return value * rhs; }; @@ -951,7 +953,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex value) -> std::complex + const auto function = [rhs](std::complex value) -> std::complex { return value * rhs; }; @@ -1044,7 +1046,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value /= rhs; }; @@ -1068,7 +1070,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex& value) -> std::complex + const auto function = [rhs](std::complex& value) -> std::complex { return value /= rhs; }; @@ -1179,7 +1181,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [rhs](dtype value) -> dtype + const auto function = [rhs](dtype value) -> dtype { return value / rhs; }; @@ -1204,7 +1206,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); - const auto function = [lhs](dtype value) -> dtype + const auto function = [lhs](dtype value) -> dtype { return lhs / value; }; @@ -1229,7 +1231,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](dtype value) -> std::complex + const auto function = [rhs](dtype value) -> std::complex { return value / rhs; }; @@ -1254,7 +1256,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [lhs](dtype value) -> std::complex + const auto function = [lhs](dtype value) -> std::complex { return lhs / value; }; @@ -1279,7 +1281,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [rhs](std::complex value) -> std::complex + const auto function = [rhs](std::complex value) -> std::complex { return value / rhs; }; @@ -1304,7 +1306,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [lhs](std::complex value) -> std::complex + const auto function = [lhs](std::complex value) -> std::complex { return lhs / value; }; @@ -1324,18 +1326,43 @@ namespace nc /// @param rhs /// @return NdArray /// - template + template::value, int> = 0> NdArray& operator%=(NdArray& lhs, const NdArray& rhs) { - STATIC_ASSERT_ARITHMETIC(dtype); + if (lhs.shape() != rhs.shape()) + { + THROW_INVALID_ARGUMENT_ERROR("Array dimensions do not match."); + } + + stl_algorithms::transform(lhs.begin(), lhs.end(), rhs.cbegin(), lhs.begin(), std::modulus()); + return lhs; + } + + //============================================================================ + // Method Description: + /// Modulus the elements of two arrays + /// + /// @param lhs + /// @param rhs + /// @return NdArray + /// + template::value, int> = 0> + NdArray& operator%=(NdArray& lhs, const NdArray& rhs) + { if (lhs.shape() != rhs.shape()) { THROW_INVALID_ARGUMENT_ERROR("Array dimensions do not match."); } - stl_algorithms::transform(lhs.begin(), lhs.end(), - rhs.cbegin(), lhs.begin(), std::modulus()); + const auto function = [](const dtype value1, const dtype value2) -> dtype + { + return std::fmod(value1, value2); + }; + + stl_algorithms::transform(lhs.begin(), lhs.end(), rhs.cbegin(), lhs.begin(), function); return lhs; } @@ -1349,12 +1376,11 @@ namespace nc /// @return /// NdArray /// - template + template::value, int> = 0> NdArray& operator%=(NdArray& lhs, dtype rhs) { - STATIC_ASSERT_ARITHMETIC(dtype); - - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value %= rhs; }; @@ -1364,6 +1390,29 @@ namespace nc return lhs; } + //============================================================================ + // Method Description: + /// Modulus the scaler to the array + /// + /// @param lhs + /// @param rhs + /// @return + /// NdArray + /// + template::value, int> = 0> + NdArray& operator%=(NdArray& lhs, dtype rhs) + { + const auto function = [rhs](dtype& value) -> void + { + value = std::fmod(value, rhs); + }; + + stl_algorithms::for_each(lhs.begin(), lhs.end(), function); + + return lhs; + } + //============================================================================ // Method Description: /// Takes the modulus of the elements of two arrays @@ -1404,12 +1453,13 @@ namespace nc /// @param rhs /// @return NdArray /// - template + template::value, int> = 0> NdArray operator%(dtype lhs, const NdArray& rhs) { NdArray returnArray(rhs.shape()); stl_algorithms::transform(rhs.begin(), rhs.end(), returnArray.begin(), - [lhs](dtype value) -> dtype + [lhs](dtype value) -> dtype { return lhs % value; }); @@ -1417,6 +1467,28 @@ namespace nc return returnArray; } + //============================================================================ + // Method Description: + /// Modulus of the scaler and the array + /// + /// @param lhs + /// @param rhs + /// @return NdArray + /// + template::value, int> = 0> + NdArray operator%(dtype lhs, const NdArray& rhs) + { + NdArray returnArray(rhs.shape()); + stl_algorithms::transform(rhs.begin(), rhs.end(), returnArray.begin(), + [lhs](dtype value) -> dtype + { + return std::fmod(lhs, value); + }); + + return returnArray; + } + //============================================================================ // Method Description: /// Bitwise or the elements of two arrays @@ -1455,7 +1527,7 @@ namespace nc { STATIC_ASSERT_INTEGER(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value |= rhs; }; @@ -1549,7 +1621,7 @@ namespace nc { STATIC_ASSERT_INTEGER(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value &= rhs; }; @@ -1643,7 +1715,7 @@ namespace nc { STATIC_ASSERT_INTEGER(dtype); - const auto function = [rhs](dtype& value) -> dtype + const auto function = [rhs](dtype& value) -> dtype { return value ^= rhs; }; @@ -1711,7 +1783,7 @@ namespace nc { STATIC_ASSERT_INTEGER(dtype); - const auto function = [](dtype value) -> dtype + const auto function = [](dtype value) -> dtype { return ~value; }; @@ -1742,7 +1814,7 @@ namespace nc THROW_INVALID_ARGUMENT_ERROR("Array dimensions do not match."); } - const auto function = [](dtype value1, dtype value2) -> bool + const auto function = [](dtype value1, dtype value2) -> bool { return value1 && value2; }; @@ -1769,7 +1841,7 @@ namespace nc NdArray returnArray(lhs.shape()); - const auto function = [rhs](dtype value) -> bool + const auto function = [rhs](dtype value) -> bool { return value && rhs; }; @@ -1812,7 +1884,7 @@ namespace nc THROW_INVALID_ARGUMENT_ERROR("Array dimensions do not match."); } - const auto function = [](dtype value1, dtype value2) -> bool + const auto function = [](dtype value1, dtype value2) -> bool { return value1 || value2; }; @@ -1839,7 +1911,7 @@ namespace nc NdArray returnArray(lhs.shape()); - const auto function = [rhs](dtype value) -> bool + const auto function = [rhs](dtype value) -> bool { return value || rhs; }; @@ -1878,7 +1950,7 @@ namespace nc NdArray returnArray(inArray.shape()); - const auto function = [](dtype value) -> dtype + const auto function = [](dtype value) -> dtype { return !value; }; @@ -2390,7 +2462,7 @@ namespace nc { STATIC_ASSERT_INTEGER(dtype); - const auto function = [inNumBits](dtype& value) -> void + const auto function = [inNumBits](dtype& value) -> void { value <<= inNumBits; }; @@ -2433,7 +2505,7 @@ namespace nc { STATIC_ASSERT_INTEGER(dtype); - const auto function = [inNumBits](dtype& value) -> void + const auto function = [inNumBits](dtype& value) -> void { value >>= inNumBits; }; @@ -2474,7 +2546,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [](dtype& value) -> void + const auto function = [](dtype& value) -> void { ++value; }; @@ -2512,7 +2584,7 @@ namespace nc { STATIC_ASSERT_ARITHMETIC(dtype); - const auto function = [](dtype& value) -> void + const auto function = [](dtype& value) -> void { --value; }; diff --git a/include/NumCpp/Polynomial/Poly1d.hpp b/include/NumCpp/Polynomial/Poly1d.hpp index 01ca7b984..1abb66478 100644 --- a/include/NumCpp/Polynomial/Poly1d.hpp +++ b/include/NumCpp/Polynomial/Poly1d.hpp @@ -130,7 +130,7 @@ namespace nc { auto newCoefficients = NdArray(1, static_cast(coefficients_.size())); - const auto function = [](dtype value) -> dtypeOut + const auto function = [](dtype value) -> dtypeOut { return static_cast(value); }; diff --git a/include/NumCpp/Rotations/Quaternion.hpp b/include/NumCpp/Rotations/Quaternion.hpp index 10a14c3ed..49eab9fb6 100644 --- a/include/NumCpp/Rotations/Quaternion.hpp +++ b/include/NumCpp/Rotations/Quaternion.hpp @@ -311,7 +311,7 @@ namespace nc stl_algorithms::transform(inQuat1.components_.begin(), inQuat1.components_.end(), inQuat2.components_.begin(), newComponents.begin(), - [inPercent, oneMinus](double component1, double component2) -> double + [inPercent, oneMinus](double component1, double component2) -> double { return oneMinus * component1 + inPercent * component2; }); diff --git a/test/pytest/test_ndarray_operators.py b/test/pytest/test_ndarray_operators.py index 769d61c41..95142107e 100644 --- a/test/pytest/test_ndarray_operators.py +++ b/test/pytest/test_ndarray_operators.py @@ -1248,6 +1248,14 @@ def test_modulus(): randScaler = np.random.randint(1, 100, [1, ]).item() assert np.array_equal(NumCpp.operatorModulusScaler(cArray, randScaler), data % randScaler) + shapeInput = np.random.randint(1, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + data = np.random.randint(1, 100, [shape.rows, shape.cols]).astype(float) + cArray.setArray(data) + randScaler = float(np.random.randint(1, 100, [1, ]).item()) + assert np.array_equal(NumCpp.operatorModulusScaler(cArray, randScaler), data % randScaler) + shapeInput = np.random.randint(1, 100, [2, ]) shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) cArray = NumCpp.NdArrayUInt32(shape) @@ -1256,6 +1264,14 @@ def test_modulus(): randScaler = np.random.randint(1, 100, [1, ]).item() assert np.array_equal(NumCpp.operatorModulusScaler(randScaler, cArray), randScaler % data) + shapeInput = np.random.randint(1, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + data = np.random.randint(1, 100, [shape.rows, shape.cols]).astype(float) + cArray.setArray(data) + randScaler = float(np.random.randint(1, 100, [1, ]).item()) + assert np.array_equal(NumCpp.operatorModulusScaler(randScaler, cArray), randScaler % data) + shapeInput = np.random.randint(1, 100, [2, ]) shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) cArray1 = NumCpp.NdArrayUInt32(shape) @@ -1266,6 +1282,16 @@ def test_modulus(): cArray2.setArray(data2) assert np.array_equal(NumCpp.operatorModulusArray(cArray1, cArray2), data1 % data2) + shapeInput = np.random.randint(1, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray1 = NumCpp.NdArray(shape) + cArray2 = NumCpp.NdArray(shape) + data1 = np.random.randint(1, 100, [shape.rows, shape.cols]).astype(float) + data2 = np.random.randint(1, 100, [shape.rows, shape.cols]).astype(float) + cArray1.setArray(data1) + cArray2.setArray(data2) + assert np.array_equal(NumCpp.operatorModulusArray(cArray1, cArray2), data1 % data2) + #################################################################################### def test_bitwise_or(): diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index eec4c318c..50d7a687d 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -2063,7 +2063,7 @@ namespace NdArrayInterface namespace FunctionsInterface { template - auto absScaler(dtype inValue) -> decltype(abs(inValue)) // trailing return type to help gcc + auto absScaler(dtype inValue) -> decltype(abs(inValue)) // trailing return type to help gcc { return abs(inValue); } @@ -2207,7 +2207,7 @@ namespace FunctionsInterface //================================================================================ template - auto arcsinScaler(dtype inValue) -> decltype(arcsin(inValue)) // trailing return type to help gcc + auto arcsinScaler(dtype inValue) -> decltype(arcsin(inValue)) // trailing return type to help gcc { return arcsin(inValue); } @@ -2223,7 +2223,7 @@ namespace FunctionsInterface //================================================================================ template - auto arcsinhScaler(dtype inValue) -> decltype(arcsinh(inValue)) // trailing return type to help gcc + auto arcsinhScaler(dtype inValue) -> decltype(arcsinh(inValue)) // trailing return type to help gcc { return arcsinh(inValue); } @@ -2239,7 +2239,7 @@ namespace FunctionsInterface //================================================================================ template - auto arctanScaler(dtype inValue) -> decltype(arctan(inValue)) // trailing return type to help gcc + auto arctanScaler(dtype inValue) -> decltype(arctan(inValue)) // trailing return type to help gcc { return arctan(inValue); } @@ -2271,7 +2271,7 @@ namespace FunctionsInterface //================================================================================ template - auto arctanhScaler(dtype inValue) -> decltype(arctanh(inValue)) // trailing return type to help gcc + auto arctanhScaler(dtype inValue) -> decltype(arctanh(inValue)) // trailing return type to help gcc { return arctanh(inValue); } @@ -2830,7 +2830,7 @@ namespace FunctionsInterface //================================================================================ template - auto cosScaler(dtype inValue) -> decltype(cos(inValue)) // trailing return type to help gcc + auto cosScaler(dtype inValue) -> decltype(cos(inValue)) // trailing return type to help gcc { return cos(inValue); } @@ -2846,7 +2846,7 @@ namespace FunctionsInterface //================================================================================ template - auto coshScaler(dtype inValue) -> decltype(cosh(inValue)) // trailing return type to help gcc + auto coshScaler(dtype inValue) -> decltype(cosh(inValue)) // trailing return type to help gcc { return cosh(inValue); } @@ -3014,7 +3014,7 @@ namespace FunctionsInterface //================================================================================ template - auto expScaler(dtype inValue) -> decltype(exp(inValue)) // trailing return type to help gcc + auto expScaler(dtype inValue) -> decltype(exp(inValue)) // trailing return type to help gcc { return exp(inValue); } @@ -3467,7 +3467,7 @@ namespace FunctionsInterface //================================================================================ template - auto logScaler(dtype inValue) -> decltype(log(inValue)) // trailing return type to help gcc + auto logScaler(dtype inValue) -> decltype(log(inValue)) // trailing return type to help gcc { return log(inValue); } @@ -3483,7 +3483,7 @@ namespace FunctionsInterface //================================================================================ template - auto log10Scaler(dtype inValue) -> decltype(log10(inValue)) // trailing return type to help gcc + auto log10Scaler(dtype inValue) -> decltype(log10(inValue)) // trailing return type to help gcc { return log10(inValue); } @@ -3957,7 +3957,7 @@ namespace FunctionsInterface //================================================================================ template - auto sinScaler(dtype inValue) -> decltype(sin(inValue)) // trailing return type to help gcc + auto sinScaler(dtype inValue) -> decltype(sin(inValue)) // trailing return type to help gcc { return sin(inValue); } @@ -3989,7 +3989,7 @@ namespace FunctionsInterface //================================================================================ template - auto sinhScaler(dtype inValue) -> decltype(sinh(inValue)) // trailing return type to help gcc + auto sinhScaler(dtype inValue) -> decltype(sinh(inValue)) // trailing return type to help gcc { return sinh(inValue); } @@ -4005,7 +4005,7 @@ namespace FunctionsInterface //================================================================================ template - auto sqrtScaler(dtype inValue) -> decltype(sqrt(inValue)) // trailing return type to help gcc + auto sqrtScaler(dtype inValue) -> decltype(sqrt(inValue)) // trailing return type to help gcc { return sqrt(inValue); } @@ -4045,7 +4045,7 @@ namespace FunctionsInterface //================================================================================ template - auto tanScaler(dtype inValue) -> decltype(tan(inValue)) // trailing return type to help gcc + auto tanScaler(dtype inValue) -> decltype(tan(inValue)) // trailing return type to help gcc { return tan(inValue); } @@ -4061,7 +4061,7 @@ namespace FunctionsInterface //================================================================================ template - auto tanhScaler(dtype inValue) -> decltype(tanh(inValue)) // trailing return type to help gcc + auto tanhScaler(dtype inValue) -> decltype(tanh(inValue)) // trailing return type to help gcc { return tanh(inValue); } @@ -6806,6 +6806,10 @@ PYBIND11_MODULE(NumCppPy, m) m.def("operatorModulusScaler", &NdArrayInterface::operatorModulusScalerReversed); m.def("operatorModulusArray", &NdArrayInterface::operatorModulusArray); + m.def("operatorModulusScaler", &NdArrayInterface::operatorModulusScaler); + m.def("operatorModulusScaler", &NdArrayInterface::operatorModulusScalerReversed); + m.def("operatorModulusArray", &NdArrayInterface::operatorModulusArray); + m.def("operatorBitwiseOrScaler", &NdArrayInterface::operatorBitwiseOrScaler); m.def("operatorBitwiseOrScaler", &NdArrayInterface::operatorBitwiseOrScalerReversed); m.def("operatorBitwiseOrArray", &NdArrayInterface::operatorBitwiseOrArray); From 17de9a7bf7d8ba46a4f3d92ca4abde6c7276006f Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 21 Dec 2021 15:34:02 -0700 Subject: [PATCH 05/31] fixed a couple thread safety concerns --- include/NumCpp/ImageProcessing/Cluster.hpp | 2 +- include/NumCpp/Rotations/Quaternion.hpp | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/include/NumCpp/ImageProcessing/Cluster.hpp b/include/NumCpp/ImageProcessing/Cluster.hpp index 65ff09ffb..4c2e744b1 100644 --- a/include/NumCpp/ImageProcessing/Cluster.hpp +++ b/include/NumCpp/ImageProcessing/Cluster.hpp @@ -335,7 +335,7 @@ namespace nc { std::string out; uint32 counter = 0; - stl_algorithms::for_each(begin(), end(), + std::for_each(begin(), end(), [&](const Pixel& pixel) { out += "Pixel " + utils::num2str(counter++) + ":" + pixel.str(); diff --git a/include/NumCpp/Rotations/Quaternion.hpp b/include/NumCpp/Rotations/Quaternion.hpp index 49eab9fb6..49da8667b 100644 --- a/include/NumCpp/Rotations/Quaternion.hpp +++ b/include/NumCpp/Rotations/Quaternion.hpp @@ -765,7 +765,7 @@ namespace nc Quaternion& operator*=(double inScalar) noexcept { stl_algorithms::for_each(components_.begin(), components_.end(), - [&inScalar](double& component) + [inScalar](double& component) { component *= inScalar; }); @@ -896,7 +896,7 @@ namespace nc void normalize() noexcept { double sumOfSquares = 0.0; - stl_algorithms::for_each(components_.begin(), components_.end(), + std::for_each(components_.begin(), components_.end(), [&sumOfSquares](double component) noexcept -> void { sumOfSquares += utils::sqr(component); @@ -904,7 +904,7 @@ namespace nc const double norm = std::sqrt(sumOfSquares); stl_algorithms::for_each(components_.begin(), components_.end(), - [&norm](double& component) noexcept -> void + [norm](double& component) noexcept -> void { component /= norm; }); From b6b060f6a94ac7bf6a916736bdfeb5b58bb9611d Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Wed, 22 Dec 2021 20:39:16 -0700 Subject: [PATCH 06/31] added select() function --- include/NumCpp/Functions.hpp | 1 + include/NumCpp/Functions/hstack.hpp | 2 +- include/NumCpp/Functions/nanpercentile.hpp | 3 +- include/NumCpp/Functions/stack.hpp | 2 +- include/NumCpp/Functions/vstack.hpp | 2 +- include/NumCpp/NdArray/NdArrayCore.hpp | 2 +- test/pytest/test_functions.py | 53 +++++++++++++++- test/src/NumCppPy.cpp | 72 ++++++++++++++++++++++ 8 files changed, 130 insertions(+), 7 deletions(-) diff --git a/include/NumCpp/Functions.hpp b/include/NumCpp/Functions.hpp index 3fd8a6f72..539078a93 100644 --- a/include/NumCpp/Functions.hpp +++ b/include/NumCpp/Functions.hpp @@ -230,6 +230,7 @@ #include "NumCpp/Functions/round.hpp" #include "NumCpp/Functions/row_stack.hpp" +#include "NumCpp/Functions/select.hpp" #include "NumCpp/Functions/setdiff1d.hpp" #include "NumCpp/Functions/shape.hpp" #include "NumCpp/Functions/sign.hpp" diff --git a/include/NumCpp/Functions/hstack.hpp b/include/NumCpp/Functions/hstack.hpp index c52d8f3b0..e70160c04 100644 --- a/include/NumCpp/Functions/hstack.hpp +++ b/include/NumCpp/Functions/hstack.hpp @@ -48,7 +48,7 @@ namespace nc /// NdArray /// template - NdArray hstack(const std::initializer_list >& inArrayList) + NdArray hstack(std::initializer_list > inArrayList) { return column_stack(inArrayList); } diff --git a/include/NumCpp/Functions/nanpercentile.hpp b/include/NumCpp/Functions/nanpercentile.hpp index 687116303..481beb99d 100644 --- a/include/NumCpp/Functions/nanpercentile.hpp +++ b/include/NumCpp/Functions/nanpercentile.hpp @@ -85,7 +85,8 @@ namespace nc return returnArray; } - return percentile(NdArray(arrayCopy.data(), arrayCopy.size(), false), + return percentile(NdArray(arrayCopy.data(), + static_cast::size_type>(arrayCopy.size()), false), inPercentile, Axis::NONE, inInterpMethod); } case Axis::COL: diff --git a/include/NumCpp/Functions/stack.hpp b/include/NumCpp/Functions/stack.hpp index 038b079ab..d7048ed3b 100644 --- a/include/NumCpp/Functions/stack.hpp +++ b/include/NumCpp/Functions/stack.hpp @@ -50,7 +50,7 @@ namespace nc /// NdArray /// template - NdArray stack(const std::initializer_list >& inArrayList, Axis inAxis = Axis::NONE) + NdArray stack(std::initializer_list > inArrayList, Axis inAxis = Axis::NONE) { switch (inAxis) { diff --git a/include/NumCpp/Functions/vstack.hpp b/include/NumCpp/Functions/vstack.hpp index 739bad2da..2cbef6900 100644 --- a/include/NumCpp/Functions/vstack.hpp +++ b/include/NumCpp/Functions/vstack.hpp @@ -47,7 +47,7 @@ namespace nc /// NdArray /// template - NdArray vstack(const std::initializer_list >& inArrayList) + NdArray vstack(std::initializer_list > inArrayList) { return row_stack(inArrayList); } diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index d1010ce8f..6301432da 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -152,7 +152,7 @@ namespace nc /// @param /// inList /// - NdArray(const std::initializer_list& inList) : + NdArray(std::initializer_list inList) : shape_(1, static_cast(inList.size())), size_(shape_.size()) { diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index bd83a2eef..ad96b6282 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -11,6 +11,7 @@ #################################################################################### def factors(n): + """docstring""" return set(reduce(list.__add__, ([i, n//i] for i in range(1, int(n**0.5) + 1) if n % i == 0))) @@ -2741,7 +2742,7 @@ def test_findN(): #################################################################################### -def fix(): +def test_fix(): value = np.random.randn(1).item() * 100 assert NumCpp.fixScaler(value) == np.fix(value) @@ -5934,6 +5935,54 @@ def test_row_stack(): np.row_stack([data1, data2, data3, data4])) +#################################################################################### +def test_select(): + # vector of pointers + shape = np.random.randint(10, 100, [2, ]) + numChoices = np.random.randint(1, 10) + default = np.random.randint(100) + + condlist = [] + choicelist = [] + for i in range(numChoices): + values = np.random.rand(*shape) + condlist.append(values > np.percentile(values, 75)) + choicelist.append(np.random.randint(0, 100, shape).astype(float)) + + assert np.array_equal(NumCpp.select(condlist, choicelist, default), + np.select(condlist, choicelist, default)) + + # vector of arrays + shape = np.random.randint(10, 100, [2, ]) + numChoices = np.random.randint(1, 10) + default = np.random.randint(100) + + condlist = [] + choicelist = [] + for i in range(numChoices): + values = np.random.rand(*shape) + condlist.append(values > np.percentile(values, 75)) + choicelist.append(np.random.randint(0, 100, shape).astype(float)) + + assert np.array_equal(NumCpp.selectVector(condlist, choicelist, default), + np.select(condlist, choicelist, default)) + + # initializer list + shape = np.random.randint(10, 100, [2, ]) + numChoices = 3 + default = np.random.randint(100) + + condlist = [] + choicelist = [] + for i in range(numChoices): + values = np.random.rand(*shape) + condlist.append(values > np.percentile(values, 75)) + choicelist.append(np.random.randint(0, 100, shape).astype(float)) + + assert np.array_equal(NumCpp.select(*condlist, *choicelist, default), + np.select(condlist, choicelist, default)) + + #################################################################################### def test_setdiff1d(): shapeInput = np.random.randint(1, 10, [2, ]) @@ -6403,7 +6452,7 @@ def test_subtract(): #################################################################################### -def test_sumo(): +def test_sum(): shapeInput = np.random.randint(20, 100, [2, ]) shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) cArray = NumCpp.NdArray(shape) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 50d7a687d..b06be5eb8 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3642,6 +3642,75 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric select(std::vector> condlist, + std::vector> choicelist, dtype defaultValue) + { + std::vector> condVec{}; + std::vector*> condVecPtr{}; + condVec.reserve(condlist.size()); + condVecPtr.reserve(condlist.size()); + for (auto& cond : condlist) + { + condVec.push_back(pybind2nc(cond)); + condVecPtr.push_back(&condVec.back()); + } + + std::vector> choiceVec{}; + std::vector*> choiceVecPtr{}; + choiceVec.reserve(choicelist.size()); + choiceVecPtr.reserve(choicelist.size()); + for (auto& choice : choicelist) + { + choiceVec.push_back(pybind2nc(choice)); + choiceVecPtr.push_back(&choiceVec.back()); + } + + return nc2pybind(nc::select(condVecPtr, choiceVecPtr, defaultValue)); + } + + //================================================================================ + + template + pbArrayGeneric selectVector(std::vector> condlist, + std::vector> choicelist, dtype defaultValue) + { + std::vector> condVec{}; + condVec.reserve(condlist.size()); + for (auto& cond : condlist) + { + condVec.push_back(pybind2nc(cond)); + } + + std::vector> choiceVec{}; + choiceVec.reserve(choicelist.size()); + for (auto& choice : choicelist) + { + choiceVec.push_back(pybind2nc(choice)); + + } + + return nc2pybind(nc::select(condVec, choiceVec, defaultValue)); + } + + //================================================================================ + + template + pbArrayGeneric selectInitializerList(pbArray cond1, + pbArray cond2, + pbArray cond3, + pbArray choice1, + pbArray choice2, + pbArray choice3, + dtype defaultValue) + { + return nc2pybind(nc::select({pybind2nc(cond1), pybind2nc(cond2), pybind2nc(cond3)}, + {pybind2nc(choice1), pybind2nc(choice2), pybind2nc(choice3)}, + defaultValue)); + } + + //================================================================================ + template pbArrayGeneric sqrArray(const NdArray& inArray) { @@ -7646,6 +7715,9 @@ PYBIND11_MODULE(NumCppPy, m) m.def("roundArray", &FunctionsInterface::roundArray); m.def("row_stack", &FunctionsInterface::row_stack); + m.def("select", &FunctionsInterface::select); + m.def("selectVector", &FunctionsInterface::selectVector); + m.def("select", &FunctionsInterface::selectInitializerList); m.def("setdiff1d", &setdiff1d); m.def("setdiff1d", &setdiff1d>); m.def("signScaler", &FunctionsInterface::signScaler); From 20fcf591ddf1b018593cd14421ba10714b8dd6a0 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 10:35:31 -0700 Subject: [PATCH 07/31] forgot to include new select.hpp. adding a development list of functions to implement --- develop/functions.txt | 17 +++ include/NumCpp/Functions/select.hpp | 155 ++++++++++++++++++++++++++++ 2 files changed, 172 insertions(+) create mode 100644 develop/functions.txt create mode 100644 include/NumCpp/Functions/select.hpp diff --git a/develop/functions.txt b/develop/functions.txt new file mode 100644 index 000000000..8caae7472 --- /dev/null +++ b/develop/functions.txt @@ -0,0 +1,17 @@ + 'bartlett', https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html + 'blackman', https://numpy.org/doc/stable/reference/generated/numpy.blackman.html + 'choose', https://numpy.org/doc/stable/reference/generated/numpy.choose.html + 'corrcoef', https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html + 'cov', https://numpy.org/doc/stable/reference/generated/numpy.cov.html + 'extract', https://numpy.org/doc/stable/reference/generated/numpy.extract.html + 'geomspace', https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html + 'hamming', https://numpy.org/doc/stable/reference/generated/numpy.hamming.html + 'hammingEncode', my stuff + 'hanning', https://numpy.org/doc/stable/reference/generated/numpy.hanning.html + 'inner', https://numpy.org/doc/stable/reference/generated/numpy.inner.html + 'isneginf', https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html + 'isposinf', https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html + 'kaiser', https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html + 'logspace', https://numpy.org/doc/stable/reference/generated/numpy.logspace.html + 'place', https://numpy.org/doc/stable/reference/generated/numpy.place.html + \ No newline at end of file diff --git a/include/NumCpp/Functions/select.hpp b/include/NumCpp/Functions/select.hpp new file mode 100644 index 000000000..8a48f9d6a --- /dev/null +++ b/include/NumCpp/Functions/select.hpp @@ -0,0 +1,155 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2021 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Shape.hpp" +#include "NumCpp/Core/Internal/Error.hpp" + +#include +#include +#include +#include + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return an array drawn from elements in choiceVec, depending on conditions. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.select.html?highlight=select#numpy.select + /// + /// @param condVec The vector of conditions which determine from which array in choiceVec + /// the output elements are taken. When multiple conditions are satisfied, + /// the first one encountered in choiceVec is used. + /// @param choiceVec The vector of array pointers from which the output elements are taken. + /// It has to be of the same length as condVec. + /// @param defaultValue The element inserted in output when all conditions evaluate to False + /// @return NdArray + /// + template + NdArray select(const std::vector*>& condVec, + const std::vector*>& choiceVec, dtype defaultValue = dtype{0}) + { + if (choiceVec.size() != condVec.size()) + { + THROW_INVALID_ARGUMENT_ERROR("condVec and choiceVec need to be the same size"); + } + + if (choiceVec.size() == 0) + { + THROW_INVALID_ARGUMENT_ERROR("choiceVec is size 0"); + } + + auto theShape = condVec.front()->shape(); + for (const auto cond : condVec) + { + const auto& theCond = *cond; + if (theCond.shape() != theShape) + { + THROW_INVALID_ARGUMENT_ERROR("all NdArrays of the condVec must be the same shape"); + } + } + + for (const auto choice : choiceVec) + { + const auto& theChoice = *choice; + if (theChoice.shape() != theShape) + { + THROW_INVALID_ARGUMENT_ERROR("all NdArrays of the choiceVec must be the same shape, and the same as condVec"); + } + } + + using size_type = typename NdArray::size_type; + constexpr auto nullChoice = std::numeric_limits::max(); + + NdArray choiceIndices(theShape); + choiceIndices.fill(nullChoice); + for (size_type condIdx = 0; condIdx < condVec.size(); ++condIdx) + { + const auto& theCond = *condVec[condIdx]; + for (size_type i = 0; i < theCond.size(); ++i) + { + if (theCond[i] && choiceIndices[i] == nullChoice) + { + choiceIndices[i] = condIdx; + } + } + } + + NdArray result(theShape); + result.fill(defaultValue); + for (size_type i = 0; i < choiceIndices.size(); ++i) + { + const auto choiceIndex = choiceIndices[i]; + if (choiceIndex != nullChoice) + { + const auto& theChoice = *choiceVec[choiceIndex]; + result[i] = theChoice[i]; + } + } + + return result; + } + + //============================================================================ + // Method Description: + /// Return an array drawn from elements in choiceList, depending on conditions. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.select.html?highlight=select#numpy.select + /// + /// @param condList The list of conditions which determine from which array in choiceList + /// the output elements are taken. When multiple conditions are satisfied, + /// the first one encountered in choiceList is used. + /// @param choiceList The list of array pointers from which the output elements are taken. + /// It has to be of the same length as condVec. + /// @param defaultValue The element inserted in output when all conditions evaluate to False + /// @return NdArray + /// + template + NdArray select(const std::vector>& condList, + const std::vector>& choiceList, + dtype defaultValue = dtype{0}) + { + std::vector*> condVec; + condVec.reserve(condList.size()); + for (auto& cond : condList) + { + condVec.push_back(&cond); + } + + std::vector*> choiceVec; + choiceVec.reserve(choiceList.size()); + for (auto& choice : choiceList) + { + choiceVec.push_back(&choice); + } + + return select(condVec, choiceVec, defaultValue); + } +} // namespace nc From ae0b65420c441614ec5b390f00f2a2401284218a Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 14:51:38 -0700 Subject: [PATCH 08/31] bumping version number, updating copyright date, starting skeletons for new functions --- develop/Hamming.hpp | 404 ++++++++++++++++++ develop/ToDo.md | 18 + develop/functions.txt | 17 - docs/markdown/ReleaseNotes.md | 22 +- include/NumCpp.hpp | 2 +- include/NumCpp/Coordinates.hpp | 2 +- include/NumCpp/Coordinates/Coordinate.hpp | 2 +- include/NumCpp/Coordinates/Dec.hpp | 2 +- include/NumCpp/Coordinates/RA.hpp | 2 +- .../NumCpp/Coordinates/degreeSeperation.hpp | 2 +- .../NumCpp/Coordinates/radianSeperation.hpp | 2 +- include/NumCpp/Core.hpp | 2 +- include/NumCpp/Core/Constants.hpp | 2 +- include/NumCpp/Core/DataCube.hpp | 2 +- include/NumCpp/Core/DtypeInfo.hpp | 2 +- include/NumCpp/Core/Internal/Endian.hpp | 2 +- include/NumCpp/Core/Internal/Error.hpp | 2 +- include/NumCpp/Core/Internal/Filesystem.hpp | 2 +- .../NumCpp/Core/Internal/StaticAsserts.hpp | 2 +- .../Core/Internal/StdComplexOperators.hpp | 2 +- .../NumCpp/Core/Internal/StlAlgorithms.hpp | 2 +- include/NumCpp/Core/Internal/TypeTraits.hpp | 2 +- include/NumCpp/Core/Internal/Version.hpp | 4 +- include/NumCpp/Core/Shape.hpp | 2 +- include/NumCpp/Core/Slice.hpp | 2 +- include/NumCpp/Core/Timer.hpp | 2 +- include/NumCpp/Core/Types.hpp | 2 +- include/NumCpp/Filter.hpp | 2 +- .../Boundaries/Boundaries1d/addBoundary1d.hpp | 2 +- .../Boundaries/Boundaries1d/constant1d.hpp | 2 +- .../Boundaries/Boundaries1d/mirror1d.hpp | 2 +- .../Boundaries/Boundaries1d/nearest1d.hpp | 2 +- .../Boundaries/Boundaries1d/reflect1d.hpp | 2 +- .../Boundaries1d/trimBoundary1d.hpp | 2 +- .../Filter/Boundaries/Boundaries1d/wrap1d.hpp | 2 +- .../Boundaries/Boundaries2d/addBoundary2d.hpp | 2 +- .../Boundaries/Boundaries2d/constant2d.hpp | 2 +- .../Boundaries/Boundaries2d/fillCorners.hpp | 2 +- .../Boundaries/Boundaries2d/mirror2d.hpp | 2 +- .../Boundaries/Boundaries2d/nearest2d.hpp | 2 +- .../Boundaries/Boundaries2d/reflect2d.hpp | 2 +- .../Boundaries2d/trimBoundary2d.hpp | 2 +- .../Filter/Boundaries/Boundaries2d/wrap2d.hpp | 2 +- include/NumCpp/Filter/Boundaries/Boundary.hpp | 2 +- .../Filters1d/complementaryMedianFilter1d.hpp | 2 +- .../Filter/Filters/Filters1d/convolve1d.hpp | 2 +- .../Filters/Filters1d/gaussianFilter1d.hpp | 2 +- .../Filters/Filters1d/maximumFilter1d.hpp | 2 +- .../Filters/Filters1d/medianFilter1d.hpp | 2 +- .../Filters/Filters1d/minimumFilter1d.hpp | 2 +- .../Filters/Filters1d/percentileFilter1d.hpp | 2 +- .../Filter/Filters/Filters1d/rankFilter1d.hpp | 2 +- .../Filters/Filters1d/uniformFilter1d.hpp | 2 +- .../Filters2d/complementaryMedianFilter.hpp | 2 +- .../Filter/Filters/Filters2d/convolve.hpp | 2 +- .../Filters/Filters2d/gaussianFilter.hpp | 2 +- .../Filter/Filters/Filters2d/laplace.hpp | 2 +- .../Filters/Filters2d/maximumFilter.hpp | 2 +- .../Filter/Filters/Filters2d/medianFilter.hpp | 2 +- .../Filters/Filters2d/minimumFilter.hpp | 2 +- .../Filters/Filters2d/percentileFilter.hpp | 2 +- .../Filter/Filters/Filters2d/rankFilter.hpp | 2 +- .../Filters/Filters2d/uniformFilter.hpp | 2 +- include/NumCpp/Functions.hpp | 19 +- include/NumCpp/Functions/abs.hpp | 2 +- include/NumCpp/Functions/add.hpp | 2 +- include/NumCpp/Functions/alen.hpp | 2 +- include/NumCpp/Functions/all.hpp | 2 +- include/NumCpp/Functions/allclose.hpp | 2 +- include/NumCpp/Functions/amax.hpp | 2 +- include/NumCpp/Functions/amin.hpp | 2 +- include/NumCpp/Functions/angle.hpp | 2 +- include/NumCpp/Functions/any.hpp | 2 +- include/NumCpp/Functions/append.hpp | 2 +- include/NumCpp/Functions/applyFunction.hpp | 2 +- include/NumCpp/Functions/applyPoly1d.hpp | 2 +- include/NumCpp/Functions/arange.hpp | 2 +- include/NumCpp/Functions/arccos.hpp | 2 +- include/NumCpp/Functions/arccosh.hpp | 2 +- include/NumCpp/Functions/arcsin.hpp | 2 +- include/NumCpp/Functions/arcsinh.hpp | 2 +- include/NumCpp/Functions/arctan.hpp | 2 +- include/NumCpp/Functions/arctan2.hpp | 2 +- include/NumCpp/Functions/arctanh.hpp | 2 +- include/NumCpp/Functions/argmax.hpp | 2 +- include/NumCpp/Functions/argmin.hpp | 2 +- include/NumCpp/Functions/argsort.hpp | 2 +- include/NumCpp/Functions/argwhere.hpp | 2 +- include/NumCpp/Functions/around.hpp | 2 +- include/NumCpp/Functions/array_equal.hpp | 2 +- include/NumCpp/Functions/array_equiv.hpp | 2 +- include/NumCpp/Functions/asarray.hpp | 2 +- include/NumCpp/Functions/astype.hpp | 2 +- include/NumCpp/Functions/average.hpp | 2 +- include/NumCpp/Functions/bartlett.hpp | 49 +++ include/NumCpp/Functions/binaryRepr.hpp | 2 +- include/NumCpp/Functions/bincount.hpp | 2 +- include/NumCpp/Functions/bitwise_and.hpp | 2 +- include/NumCpp/Functions/bitwise_not.hpp | 2 +- include/NumCpp/Functions/bitwise_or.hpp | 2 +- include/NumCpp/Functions/bitwise_xor.hpp | 2 +- include/NumCpp/Functions/blackman.hpp | 49 +++ include/NumCpp/Functions/byteswap.hpp | 2 +- include/NumCpp/Functions/cbrt.hpp | 2 +- include/NumCpp/Functions/ceil.hpp | 2 +- include/NumCpp/Functions/centerOfMass.hpp | 2 +- include/NumCpp/Functions/choose.hpp | 51 +++ include/NumCpp/Functions/clip.hpp | 2 +- include/NumCpp/Functions/column_stack.hpp | 2 +- include/NumCpp/Functions/complex.hpp | 2 +- include/NumCpp/Functions/concatenate.hpp | 2 +- include/NumCpp/Functions/conj.hpp | 2 +- include/NumCpp/Functions/contains.hpp | 2 +- include/NumCpp/Functions/copy.hpp | 2 +- include/NumCpp/Functions/copySign.hpp | 2 +- include/NumCpp/Functions/copyto.hpp | 2 +- include/NumCpp/Functions/corrcoef.hpp | 50 +++ include/NumCpp/Functions/cos.hpp | 2 +- include/NumCpp/Functions/cosh.hpp | 2 +- include/NumCpp/Functions/count_nonzero.hpp | 2 +- include/NumCpp/Functions/cov.hpp | 50 +++ include/NumCpp/Functions/cross.hpp | 2 +- include/NumCpp/Functions/cube.hpp | 2 +- include/NumCpp/Functions/cumprod.hpp | 2 +- include/NumCpp/Functions/cumsum.hpp | 2 +- include/NumCpp/Functions/deg2rad.hpp | 2 +- include/NumCpp/Functions/degrees.hpp | 2 +- include/NumCpp/Functions/deleteIndices.hpp | 2 +- include/NumCpp/Functions/diag.hpp | 2 +- include/NumCpp/Functions/diagflat.hpp | 2 +- include/NumCpp/Functions/diagonal.hpp | 2 +- include/NumCpp/Functions/diff.hpp | 2 +- include/NumCpp/Functions/divide.hpp | 2 +- include/NumCpp/Functions/dot.hpp | 2 +- include/NumCpp/Functions/dump.hpp | 2 +- include/NumCpp/Functions/empty.hpp | 2 +- include/NumCpp/Functions/empty_like.hpp | 2 +- include/NumCpp/Functions/endianess.hpp | 2 +- include/NumCpp/Functions/equal.hpp | 2 +- include/NumCpp/Functions/exp.hpp | 2 +- include/NumCpp/Functions/exp2.hpp | 2 +- include/NumCpp/Functions/expm1.hpp | 2 +- include/NumCpp/Functions/extract.hpp | 49 +++ include/NumCpp/Functions/eye.hpp | 2 +- include/NumCpp/Functions/fillDiagnol.hpp | 2 +- include/NumCpp/Functions/find.hpp | 2 +- include/NumCpp/Functions/fix.hpp | 2 +- include/NumCpp/Functions/flatnonzero.hpp | 2 +- include/NumCpp/Functions/flatten.hpp | 2 +- include/NumCpp/Functions/flip.hpp | 2 +- include/NumCpp/Functions/fliplr.hpp | 2 +- include/NumCpp/Functions/flipud.hpp | 2 +- include/NumCpp/Functions/floor.hpp | 2 +- include/NumCpp/Functions/floor_divide.hpp | 2 +- include/NumCpp/Functions/fmax.hpp | 2 +- include/NumCpp/Functions/fmin.hpp | 2 +- include/NumCpp/Functions/fmod.hpp | 2 +- include/NumCpp/Functions/frombuffer.hpp | 2 +- include/NumCpp/Functions/fromfile.hpp | 2 +- include/NumCpp/Functions/fromiter.hpp | 2 +- include/NumCpp/Functions/full.hpp | 2 +- include/NumCpp/Functions/full_like.hpp | 2 +- include/NumCpp/Functions/gcd.hpp | 2 +- include/NumCpp/Functions/geomspace.hpp | 52 +++ include/NumCpp/Functions/gradient.hpp | 2 +- include/NumCpp/Functions/greater.hpp | 2 +- include/NumCpp/Functions/greater_equal.hpp | 2 +- include/NumCpp/Functions/hamming.hpp | 49 +++ include/NumCpp/Functions/hammingEncode.hpp | 43 ++ include/NumCpp/Functions/hanning.hpp | 49 +++ include/NumCpp/Functions/histogram.hpp | 2 +- include/NumCpp/Functions/hstack.hpp | 2 +- include/NumCpp/Functions/hypot.hpp | 2 +- include/NumCpp/Functions/identity.hpp | 2 +- include/NumCpp/Functions/imag.hpp | 2 +- include/NumCpp/Functions/inner.hpp | 49 +++ include/NumCpp/Functions/interp.hpp | 2 +- include/NumCpp/Functions/intersect1d.hpp | 2 +- include/NumCpp/Functions/invert.hpp | 2 +- include/NumCpp/Functions/isclose.hpp | 2 +- include/NumCpp/Functions/isinf.hpp | 2 +- include/NumCpp/Functions/isnan.hpp | 2 +- include/NumCpp/Functions/isneginf.hpp | 48 +++ include/NumCpp/Functions/isposinf.hpp | 48 +++ include/NumCpp/Functions/kaiser.hpp | 47 ++ include/NumCpp/Functions/lcm.hpp | 2 +- include/NumCpp/Functions/ldexp.hpp | 2 +- include/NumCpp/Functions/left_shift.hpp | 2 +- include/NumCpp/Functions/less.hpp | 2 +- include/NumCpp/Functions/less_equal.hpp | 2 +- include/NumCpp/Functions/linspace.hpp | 2 +- include/NumCpp/Functions/load.hpp | 2 +- include/NumCpp/Functions/log.hpp | 2 +- include/NumCpp/Functions/log10.hpp | 2 +- include/NumCpp/Functions/log1p.hpp | 2 +- include/NumCpp/Functions/log2.hpp | 2 +- include/NumCpp/Functions/logical_and.hpp | 2 +- include/NumCpp/Functions/logical_not.hpp | 2 +- include/NumCpp/Functions/logical_or.hpp | 2 +- include/NumCpp/Functions/logical_xor.hpp | 2 +- include/NumCpp/Functions/logspace.hpp | 52 +++ include/NumCpp/Functions/matmul.hpp | 2 +- include/NumCpp/Functions/max.hpp | 2 +- include/NumCpp/Functions/maximum.hpp | 2 +- include/NumCpp/Functions/mean.hpp | 2 +- include/NumCpp/Functions/median.hpp | 2 +- include/NumCpp/Functions/meshgrid.hpp | 2 +- include/NumCpp/Functions/min.hpp | 2 +- include/NumCpp/Functions/minimum.hpp | 2 +- include/NumCpp/Functions/mod.hpp | 2 +- include/NumCpp/Functions/multiply.hpp | 2 +- include/NumCpp/Functions/nan_to_num.hpp | 2 +- include/NumCpp/Functions/nanargmax.hpp | 2 +- include/NumCpp/Functions/nanargmin.hpp | 2 +- include/NumCpp/Functions/nancumprod.hpp | 2 +- include/NumCpp/Functions/nancumsum.hpp | 2 +- include/NumCpp/Functions/nanmax.hpp | 2 +- include/NumCpp/Functions/nanmean.hpp | 2 +- include/NumCpp/Functions/nanmedian.hpp | 2 +- include/NumCpp/Functions/nanmin.hpp | 2 +- include/NumCpp/Functions/nanpercentile.hpp | 2 +- include/NumCpp/Functions/nanprod.hpp | 2 +- include/NumCpp/Functions/nans.hpp | 2 +- include/NumCpp/Functions/nans_like.hpp | 2 +- include/NumCpp/Functions/nanstdev.hpp | 2 +- include/NumCpp/Functions/nansum.hpp | 2 +- include/NumCpp/Functions/nanvar.hpp | 2 +- include/NumCpp/Functions/nbytes.hpp | 2 +- include/NumCpp/Functions/negative.hpp | 2 +- include/NumCpp/Functions/newbyteorder.hpp | 2 +- include/NumCpp/Functions/none.hpp | 2 +- include/NumCpp/Functions/nonzero.hpp | 2 +- include/NumCpp/Functions/norm.hpp | 2 +- include/NumCpp/Functions/not_equal.hpp | 2 +- include/NumCpp/Functions/ones.hpp | 2 +- include/NumCpp/Functions/ones_like.hpp | 2 +- include/NumCpp/Functions/outer.hpp | 2 +- include/NumCpp/Functions/pad.hpp | 2 +- include/NumCpp/Functions/partition.hpp | 2 +- include/NumCpp/Functions/percentile.hpp | 2 +- include/NumCpp/Functions/place.hpp | 52 +++ include/NumCpp/Functions/polar.hpp | 2 +- include/NumCpp/Functions/power.hpp | 2 +- include/NumCpp/Functions/powerf.hpp | 2 +- include/NumCpp/Functions/print.hpp | 2 +- include/NumCpp/Functions/prod.hpp | 2 +- include/NumCpp/Functions/proj.hpp | 2 +- include/NumCpp/Functions/ptp.hpp | 2 +- include/NumCpp/Functions/put.hpp | 2 +- include/NumCpp/Functions/putmask.hpp | 2 +- include/NumCpp/Functions/rad2deg.hpp | 2 +- include/NumCpp/Functions/radians.hpp | 2 +- include/NumCpp/Functions/ravel.hpp | 2 +- include/NumCpp/Functions/real.hpp | 2 +- include/NumCpp/Functions/reciprocal.hpp | 2 +- include/NumCpp/Functions/remainder.hpp | 2 +- include/NumCpp/Functions/repeat.hpp | 2 +- include/NumCpp/Functions/replace.hpp | 2 +- include/NumCpp/Functions/reshape.hpp | 2 +- include/NumCpp/Functions/resizeFast.hpp | 2 +- include/NumCpp/Functions/resizeSlow.hpp | 2 +- include/NumCpp/Functions/right_shift.hpp | 2 +- include/NumCpp/Functions/rint.hpp | 2 +- include/NumCpp/Functions/rms.hpp | 2 +- include/NumCpp/Functions/roll.hpp | 2 +- include/NumCpp/Functions/rot90.hpp | 2 +- include/NumCpp/Functions/round.hpp | 2 +- include/NumCpp/Functions/row_stack.hpp | 2 +- include/NumCpp/Functions/select.hpp | 2 +- include/NumCpp/Functions/setdiff1d.hpp | 2 +- include/NumCpp/Functions/shape.hpp | 2 +- include/NumCpp/Functions/sign.hpp | 2 +- include/NumCpp/Functions/signbit.hpp | 2 +- include/NumCpp/Functions/sin.hpp | 2 +- include/NumCpp/Functions/sinc.hpp | 2 +- include/NumCpp/Functions/sinh.hpp | 2 +- include/NumCpp/Functions/size.hpp | 2 +- include/NumCpp/Functions/sort.hpp | 2 +- include/NumCpp/Functions/sqrt.hpp | 2 +- include/NumCpp/Functions/square.hpp | 2 +- include/NumCpp/Functions/stack.hpp | 2 +- include/NumCpp/Functions/stdev.hpp | 2 +- include/NumCpp/Functions/subtract.hpp | 2 +- include/NumCpp/Functions/sum.hpp | 2 +- include/NumCpp/Functions/swap.hpp | 2 +- include/NumCpp/Functions/swapaxes.hpp | 2 +- include/NumCpp/Functions/tan.hpp | 2 +- include/NumCpp/Functions/tanh.hpp | 2 +- include/NumCpp/Functions/tile.hpp | 2 +- include/NumCpp/Functions/toStlVector.hpp | 2 +- include/NumCpp/Functions/tofile.hpp | 2 +- include/NumCpp/Functions/trace.hpp | 2 +- include/NumCpp/Functions/transpose.hpp | 2 +- include/NumCpp/Functions/trapz.hpp | 2 +- include/NumCpp/Functions/tri.hpp | 2 +- include/NumCpp/Functions/trim_zeros.hpp | 2 +- include/NumCpp/Functions/trunc.hpp | 2 +- include/NumCpp/Functions/union1d.hpp | 2 +- include/NumCpp/Functions/unique.hpp | 2 +- include/NumCpp/Functions/unwrap.hpp | 2 +- include/NumCpp/Functions/var.hpp | 2 +- include/NumCpp/Functions/vstack.hpp | 2 +- include/NumCpp/Functions/where.hpp | 2 +- include/NumCpp/Functions/zeros.hpp | 2 +- include/NumCpp/Functions/zeros_like.hpp | 2 +- include/NumCpp/ImageProcessing.hpp | 2 +- include/NumCpp/ImageProcessing/Centroid.hpp | 2 +- include/NumCpp/ImageProcessing/Cluster.hpp | 2 +- .../NumCpp/ImageProcessing/ClusterMaker.hpp | 2 +- include/NumCpp/ImageProcessing/Pixel.hpp | 2 +- .../NumCpp/ImageProcessing/applyThreshold.hpp | 2 +- .../ImageProcessing/centroidClusters.hpp | 2 +- .../NumCpp/ImageProcessing/clusterPixels.hpp | 2 +- .../ImageProcessing/generateCentroids.hpp | 2 +- .../ImageProcessing/generateThreshold.hpp | 2 +- .../ImageProcessing/windowExceedances.hpp | 2 +- include/NumCpp/Integrate.hpp | 2 +- include/NumCpp/Integrate/gauss_legendre.hpp | 2 +- include/NumCpp/Integrate/romberg.hpp | 2 +- include/NumCpp/Integrate/simpson.hpp | 2 +- include/NumCpp/Integrate/trapazoidal.hpp | 2 +- include/NumCpp/Linalg.hpp | 2 +- include/NumCpp/Linalg/cholesky.hpp | 2 +- include/NumCpp/Linalg/det.hpp | 2 +- include/NumCpp/Linalg/gaussNewtonNlls.hpp | 2 +- include/NumCpp/Linalg/hat.hpp | 2 +- include/NumCpp/Linalg/inv.hpp | 2 +- include/NumCpp/Linalg/lstsq.hpp | 2 +- include/NumCpp/Linalg/lu_decomposition.hpp | 2 +- include/NumCpp/Linalg/matrix_power.hpp | 2 +- include/NumCpp/Linalg/multi_dot.hpp | 2 +- .../NumCpp/Linalg/pivotLU_decomposition.hpp | 2 +- include/NumCpp/Linalg/solve.hpp | 2 +- include/NumCpp/Linalg/svd.hpp | 2 +- include/NumCpp/NdArray.hpp | 2 +- include/NumCpp/NdArray/NdArrayCore.hpp | 2 +- include/NumCpp/NdArray/NdArrayIterators.hpp | 2 +- include/NumCpp/NdArray/NdArrayOperators.hpp | 2 +- include/NumCpp/Polynomial.hpp | 2 +- include/NumCpp/Polynomial/Poly1d.hpp | 2 +- include/NumCpp/Polynomial/chebyshev_t.hpp | 2 +- include/NumCpp/Polynomial/chebyshev_u.hpp | 2 +- include/NumCpp/Polynomial/hermite.hpp | 2 +- include/NumCpp/Polynomial/laguerre.hpp | 2 +- include/NumCpp/Polynomial/legendre_p.hpp | 2 +- include/NumCpp/Polynomial/legendre_q.hpp | 2 +- .../NumCpp/Polynomial/spherical_harmonic.hpp | 2 +- include/NumCpp/PythonInterface.hpp | 2 +- .../NumCpp/PythonInterface/BoostInterface.hpp | 2 +- .../BoostNumpyNdarrayHelper.hpp | 2 +- .../PythonInterface/PybindInterface.hpp | 2 +- include/NumCpp/Random.hpp | 2 +- include/NumCpp/Random/bernoilli.hpp | 2 +- include/NumCpp/Random/beta.hpp | 2 +- include/NumCpp/Random/binomial.hpp | 2 +- include/NumCpp/Random/cauchy.hpp | 2 +- include/NumCpp/Random/chiSquare.hpp | 2 +- include/NumCpp/Random/choice.hpp | 2 +- include/NumCpp/Random/discrete.hpp | 2 +- include/NumCpp/Random/exponential.hpp | 2 +- include/NumCpp/Random/extremeValue.hpp | 2 +- include/NumCpp/Random/f.hpp | 2 +- include/NumCpp/Random/gamma.hpp | 2 +- include/NumCpp/Random/generator.hpp | 2 +- include/NumCpp/Random/geometric.hpp | 2 +- include/NumCpp/Random/laplace.hpp | 2 +- include/NumCpp/Random/lognormal.hpp | 2 +- include/NumCpp/Random/negativeBinomial.hpp | 2 +- .../NumCpp/Random/nonCentralChiSquared.hpp | 2 +- include/NumCpp/Random/normal.hpp | 2 +- include/NumCpp/Random/permutation.hpp | 2 +- include/NumCpp/Random/poisson.hpp | 2 +- include/NumCpp/Random/rand.hpp | 2 +- include/NumCpp/Random/randFloat.hpp | 2 +- include/NumCpp/Random/randInt.hpp | 2 +- include/NumCpp/Random/randN.hpp | 2 +- include/NumCpp/Random/shuffle.hpp | 2 +- include/NumCpp/Random/standardNormal.hpp | 2 +- include/NumCpp/Random/studentT.hpp | 2 +- include/NumCpp/Random/triangle.hpp | 2 +- include/NumCpp/Random/uniform.hpp | 2 +- include/NumCpp/Random/uniformOnSphere.hpp | 2 +- include/NumCpp/Random/weibull.hpp | 2 +- include/NumCpp/Roots.hpp | 2 +- include/NumCpp/Roots/Bisection.hpp | 2 +- include/NumCpp/Roots/Brent.hpp | 2 +- include/NumCpp/Roots/Dekker.hpp | 2 +- include/NumCpp/Roots/Iteration.hpp | 2 +- include/NumCpp/Roots/Newton.hpp | 2 +- include/NumCpp/Roots/Secant.hpp | 2 +- include/NumCpp/Rotations.hpp | 2 +- include/NumCpp/Rotations/DCM.hpp | 2 +- include/NumCpp/Rotations/Quaternion.hpp | 2 +- .../NumCpp/Rotations/rodriguesRotation.hpp | 2 +- include/NumCpp/Rotations/wahbasProblem.hpp | 2 +- include/NumCpp/Special.hpp | 2 +- include/NumCpp/Special/airy_ai.hpp | 2 +- include/NumCpp/Special/airy_ai_prime.hpp | 2 +- include/NumCpp/Special/airy_bi.hpp | 2 +- include/NumCpp/Special/airy_bi_prime.hpp | 2 +- include/NumCpp/Special/bernoulli.hpp | 2 +- include/NumCpp/Special/bessel_in.hpp | 2 +- include/NumCpp/Special/bessel_in_prime.hpp | 2 +- include/NumCpp/Special/bessel_jn.hpp | 2 +- include/NumCpp/Special/bessel_jn_prime.hpp | 2 +- include/NumCpp/Special/bessel_kn.hpp | 2 +- include/NumCpp/Special/bessel_kn_prime.hpp | 2 +- include/NumCpp/Special/bessel_yn.hpp | 2 +- include/NumCpp/Special/bessel_yn_prime.hpp | 2 +- include/NumCpp/Special/beta.hpp | 2 +- include/NumCpp/Special/cnr.hpp | 2 +- include/NumCpp/Special/comp_ellint_1.hpp | 2 +- include/NumCpp/Special/comp_ellint_2.hpp | 2 +- include/NumCpp/Special/comp_ellint_3.hpp | 2 +- include/NumCpp/Special/cyclic_hankel_1.hpp | 2 +- include/NumCpp/Special/cyclic_hankel_2.hpp | 2 +- include/NumCpp/Special/digamma.hpp | 2 +- include/NumCpp/Special/ellint_1.hpp | 2 +- include/NumCpp/Special/ellint_2.hpp | 2 +- include/NumCpp/Special/ellint_3.hpp | 2 +- include/NumCpp/Special/erf.hpp | 2 +- include/NumCpp/Special/erf_inv.hpp | 2 +- include/NumCpp/Special/erfc.hpp | 2 +- include/NumCpp/Special/erfc_inv.hpp | 2 +- include/NumCpp/Special/expint.hpp | 2 +- include/NumCpp/Special/factorial.hpp | 2 +- include/NumCpp/Special/gamma.hpp | 2 +- include/NumCpp/Special/gamma1pm1.hpp | 2 +- include/NumCpp/Special/log_gamma.hpp | 2 +- include/NumCpp/Special/pnr.hpp | 2 +- include/NumCpp/Special/polygamma.hpp | 2 +- include/NumCpp/Special/prime.hpp | 2 +- include/NumCpp/Special/riemann_zeta.hpp | 2 +- include/NumCpp/Special/softmax.hpp | 2 +- .../NumCpp/Special/spherical_bessel_jn.hpp | 2 +- .../NumCpp/Special/spherical_bessel_yn.hpp | 2 +- include/NumCpp/Special/spherical_hankel_1.hpp | 2 +- include/NumCpp/Special/spherical_hankel_2.hpp | 2 +- include/NumCpp/Special/trigamma.hpp | 2 +- include/NumCpp/Utils.hpp | 2 +- include/NumCpp/Utils/cube.hpp | 2 +- include/NumCpp/Utils/essentiallyEqual.hpp | 2 +- include/NumCpp/Utils/gaussian.hpp | 2 +- include/NumCpp/Utils/gaussian1d.hpp | 2 +- include/NumCpp/Utils/interp.hpp | 2 +- include/NumCpp/Utils/num2str.hpp | 2 +- include/NumCpp/Utils/power.hpp | 2 +- include/NumCpp/Utils/powerf.hpp | 2 +- include/NumCpp/Utils/sqr.hpp | 2 +- include/NumCpp/Utils/value2str.hpp | 2 +- include/NumCpp/Vector.hpp | 2 +- include/NumCpp/Vector/Vec2.hpp | 2 +- include/NumCpp/Vector/Vec3.hpp | 2 +- 453 files changed, 1679 insertions(+), 454 deletions(-) create mode 100644 develop/Hamming.hpp create mode 100644 develop/ToDo.md delete mode 100644 develop/functions.txt create mode 100644 include/NumCpp/Functions/bartlett.hpp create mode 100644 include/NumCpp/Functions/blackman.hpp create mode 100644 include/NumCpp/Functions/choose.hpp create mode 100644 include/NumCpp/Functions/corrcoef.hpp create mode 100644 include/NumCpp/Functions/cov.hpp create mode 100644 include/NumCpp/Functions/extract.hpp create mode 100644 include/NumCpp/Functions/geomspace.hpp create mode 100644 include/NumCpp/Functions/hamming.hpp create mode 100644 include/NumCpp/Functions/hammingEncode.hpp create mode 100644 include/NumCpp/Functions/hanning.hpp create mode 100644 include/NumCpp/Functions/inner.hpp create mode 100644 include/NumCpp/Functions/isneginf.hpp create mode 100644 include/NumCpp/Functions/isposinf.hpp create mode 100644 include/NumCpp/Functions/kaiser.hpp create mode 100644 include/NumCpp/Functions/logspace.hpp create mode 100644 include/NumCpp/Functions/place.hpp diff --git a/develop/Hamming.hpp b/develop/Hamming.hpp new file mode 100644 index 000000000..724ce0e2d --- /dev/null +++ b/develop/Hamming.hpp @@ -0,0 +1,404 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Hamming EDAC encoding https://en.wikipedia.org/wiki/Hamming_code +/// + +#pragma once + +#include +#include +#include +#include +#include +#include + +#include "boost/dynamic_bitset.hpp" + +#include "TypeTraits.hpp" + +namespace hamming +{ + namespace detail + { + /** + * @brief Tests if value is a power of two + * + * @param n integer value + * @return bool true if value is a power of two, else false + */ + template< + typename IntType, + std::enable_if_t, int> = 0 + > + constexpr bool isPowerOfTwo(IntType n) noexcept + { + // Returns true if the given non-negative integer n is a power of two. + return n != 0 && (n & (n - 1)) == 0; + } + + /** + * @brief Calculates the next power of two after n + * >>> _next_power_of_two(768) + * 1024 + * >>> _next_power_of_two(4) + * 8 + * + * @param n integer value + * @return next power of two + * @exception std::invalid_argument if input value is less than zero + */ + template< + typename IntType, + std::enable_if_t, int> = 0 + > + std::size_t nextPowerOfTwo(IntType n) + { + if (n < 0) + { + throw std::invalid_argument("Input value must be greater than or equal to zero."); + } + + if (isPowerOfTwo(n)) + { + return static_cast(n) << 1; + } + + return static_cast(std::pow(2, std::ceil(std::log2(n)))); + } + + /** + * @brief Calculates the first n powers of two + * + * @param n integer value + * @return first n powers of two + * @exception std::bad_alloc if unable to allocate for return vector + */ + template< + typename IntType, + std::enable_if_t, int> = 0 + > + std::vector powersOfTwo(IntType n) + { + auto i = std::size_t{ 0 }; + auto power = std::size_t{ 1 }; + auto powers = std::vector(); + powers.reserve(n); + + while (i < static_cast(n)) + { + powers.push_back(power); + power <<= 1; + ++i; + } + + return powers; + } + + /** + * @brief Calculates the number of needed Hamming SECDED parity bits to encode the data + * + * @param numDataBits the number of data bits to encode + * @return number of Hamming SECDED parity bits + * @exception std::invalid_argument if input value is less than zero + * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + */ + template< + typename IntType, + std::enable_if_t, int> = 0 + > + std::size_t numSecdedParityBitsNeeded(IntType numDataBits) + { + const auto n = nextPowerOfTwo(numDataBits); + const auto lowerBin = static_cast(std::floor(std::log2(n))); + const auto upperBin = lowerBin + 1; + const auto dataBitBoundary = n - lowerBin - 1; + const auto numParityBits = numDataBits <= dataBitBoundary ? lowerBin + 1 : upperBin + 1; + + if (!isPowerOfTwo(numParityBits + numDataBits)) + { + throw std::runtime_error("input number of data bits is not a valid Hamming SECDED code configuration."); + } + + return numParityBits; + } + + /** + * @brief Returns the indices of all data bits covered by a specified parity bit in a bitstring + * of length numDataBits. The indices are relative to DATA BITSTRING ITSELF, NOT including + * parity bits. + * + * @param numDataBits the number of data bits to encode + * @param parityBit the parity bit number + * @return number of Hamming SECDED parity bits + * @exception std::invalid_argument if parityBit is not a power of two + * @exception std::bad_alloc if unable to allocate return vector + */ + template< + typename IntType1, + typename IntType2, + std::enable_if_t, int> = 0, + std::enable_if_t, int> = 0 + > + std::vector dataBitsCovered(IntType1 numDataBits, IntType2 parityBit) + { + if (!isPowerOfTwo(parityBit)) + { + throw std::invalid_argument("All hamming parity bits are indexed by powers of two."); + } + + std::size_t dataIndex = 1; // bit we're currently at in the DATA bitstring + std::size_t totalIndex = 3; // bit we're currently at in the OVERALL bitstring + auto parityBit_ = static_cast(parityBit); + + auto indices = std::vector(); + indices.reserve(numDataBits); // worst case + + while (dataIndex <= static_cast(numDataBits)) + { + const auto currentBitIsData = !isPowerOfTwo(totalIndex); + if (currentBitIsData && (totalIndex % (parityBit_ << 1)) >= parityBit_) + { + indices.push_back(dataIndex - 1); // adjust output to be zero indexed + } + + dataIndex += currentBitIsData ? 1 : 0; + ++totalIndex; + } + + return indices; + } + + /** + * @brief Calculates the overall parity of the data, assumes last bit is the parity bit itself + * + * @param data the data word + * @return overall parity bit value + */ + template + constexpr bool calculateParity(const std::bitset& data) noexcept + { + bool parity = false; + for (std::size_t i = 0; i < DataBits - 1; ++i) + { + parity ^= data[i]; + } + + return parity; + } + + /** + * @brief Calculates the overall parity of the data, assumes last bit is the parity bit itself + * + * @param data the data word + * @return overall parity bit value + */ + inline bool calculateParity(const boost::dynamic_bitset<>& data) noexcept + { + bool parity = false; + for (std::size_t i = 0; i < data.size() - 1; ++i) + { + parity ^= data[i]; + } + + return parity; + } + + /** + * @brief Calculates the specified Hamming parity bit (1, 2, 4, 8, etc.) for the given data. + * Assumes even parity to allow for easier computation of parity using XOR. + * + * @param data the data word + * @param parityBit the parity bit number + * @return parity bit value + * @exception std::invalid_argument if parityBit is not a power of two + * @exception std::bad_alloc if unable to allocate return vector + */ + template< + std::size_t DataBits, + typename IntType, + std::enable_if_t, int> = 0 + > + bool calculateParity(const std::bitset& data, IntType parityBit) + { + bool parity = false; + for (const auto i : dataBitsCovered(DataBits, parityBit)) + { + parity ^= data[i]; + } + + return parity; + } + + /** + * @brief Checks that the number of DataBits and EncodedBits are consistent + * + * @return the number of parity bits + * @exception std::runtime_error if DataBits and EncodedBits are not consistent + * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + */ + template< + std::size_t DataBits, + std::size_t EncodedBits, + std::enable_if_t, int> = 0 + > + std::size_t checkBitsConsistent() + { + const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits); + if (numParityBits + DataBits != EncodedBits) + { + throw std::runtime_error("DataBits and EncodedBits are not consistent"); + } + + return numParityBits; + } + + /** + * @brief Returns the Hamming SECDED decoded bits from the endoded bits. Assumes that the + * DataBits and EncodedBits have been checks for consistancy already + * + * @param encodedBits the Hamming SECDED encoded word + * @return data bits from the encoded word + */ + template< + std::size_t DataBits, + std::size_t EncodedBits, + std::enable_if_t, int> = 0 + > + std::bitset extractData(const std::bitset& encodedBits) noexcept + { + auto dataBits = std::bitset(); + + std::size_t dataIndex = 0; + for (std::size_t encodedIndex = 0; encodedIndex < EncodedBits; ++encodedIndex) + { + if (!isPowerOfTwo(encodedIndex + 1)) + { + dataBits[dataIndex++] = encodedBits[encodedIndex]; + if (dataIndex == DataBits) + { + break; + } + } + } + + return dataBits; + } + } // namespace detail + + /** + * @brief Returns the Hamming SECDED encoded bits for the data bits + * + * @param dataBits the data bits to encode + * @return encoded data bits + * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + */ + template + boost::dynamic_bitset<> encode(const std::bitset& dataBits) + { + const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits); + const auto numEncodedBits = numParityBits + DataBits; + + auto encodedBits = boost::dynamic_bitset<>(numEncodedBits); + + // set the parity bits + for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) // -1 because overall parity will be calculated seperately later + { + encodedBits[parityBit - 1] = detail::calculateParity(dataBits, parityBit); + } + + // set the data bits, switch to 1 based to make things easier for isPowerOfTwo + std::size_t dataBitIndex = 0; + for (std::size_t bitIndex = 1; bitIndex <= numEncodedBits - 1; ++bitIndex) // -1 to account for the overall parity bit + { + if (!detail::isPowerOfTwo(bitIndex)) + { + encodedBits[bitIndex - 1] = dataBits[dataBitIndex++]; + } + } + + // compute and set overall parity for the entire encoded data (not including the overall parity bit itself) + encodedBits[numEncodedBits - 1] = detail::calculateParity(encodedBits); // overall parity at the end + + // all done! + return encodedBits; + } + + /** + * @brief Returns the Hamming SECDED decoded bits for the enocoded bits + * + * @param encodedBits the encoded bits to decode + * @param decodedBits the output decoded bits + * @return int status (0=no errors, 1=1 corrected error, 2=2 errors detected) + * @exception std::runtime_error if DataBits and EncodedBits are not consistent + * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + */ + template< + std::size_t DataBits, + std::size_t EncodedBits, + std::enable_if_t, int> = 0 + > + int decode(std::bitset encodedBits, std::bitset& decodedBits) + { + const auto numParityBits = detail::checkBitsConsistent(); + + // the data bits, which may be corrupted + decodedBits = detail::extractData(encodedBits); + + // check the overall parity bit + const auto overallExpected = detail::calculateParity(encodedBits); + const auto overallActual = encodedBits[EncodedBits - 1]; + const auto overallCorrect = overallExpected == overallActual; + + // check individual parities - each parity bit's index (besides overall parity) is a power of two + std::size_t indexOfError = 0; + for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) + { + const auto expected = detail::calculateParity(decodedBits, parityBit); + const auto actual = encodedBits[parityBit - 1]; // -1 because parityBit is 1 based + if (expected != actual) + { + indexOfError += parityBit; + } + } + + // attempt to repair a single flipped bit or throw exception if more than one + if (overallCorrect && indexOfError != 0) + { + // two errors found + return 2; + } + else if (!overallCorrect && indexOfError != 0) + { + // one error found, flip the bit in error and we're good + encodedBits.flip(indexOfError - 1); + decodedBits = detail::extractData(encodedBits); + return 1; + } + + return 0; + } +} // namespace hamming +#endif // #ifndef HAMMING_H_ diff --git a/develop/ToDo.md b/develop/ToDo.md new file mode 100644 index 000000000..e587b4f5c --- /dev/null +++ b/develop/ToDo.md @@ -0,0 +1,18 @@ + ## Functions to add: + + * `bartlett`, https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html + * `blackman`, https://numpy.org/doc/stable/reference/generated/numpy.blackman.html + * `choose`, https://numpy.org/doc/stable/reference/generated/numpy.choose.html + * `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html + * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html + * `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html + * `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html + * `hamming`, https://numpy.org/doc/stable/reference/generated/numpy.hamming.html + * `hammingEncode`, my stuff + * `hanning`, https://numpy.org/doc/stable/reference/generated/numpy.hanning.html + * `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html + * `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html + * `isposinf`, https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html + * `kaiser`, https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html + * `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html + * `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html diff --git a/develop/functions.txt b/develop/functions.txt deleted file mode 100644 index 8caae7472..000000000 --- a/develop/functions.txt +++ /dev/null @@ -1,17 +0,0 @@ - 'bartlett', https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html - 'blackman', https://numpy.org/doc/stable/reference/generated/numpy.blackman.html - 'choose', https://numpy.org/doc/stable/reference/generated/numpy.choose.html - 'corrcoef', https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html - 'cov', https://numpy.org/doc/stable/reference/generated/numpy.cov.html - 'extract', https://numpy.org/doc/stable/reference/generated/numpy.extract.html - 'geomspace', https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html - 'hamming', https://numpy.org/doc/stable/reference/generated/numpy.hamming.html - 'hammingEncode', my stuff - 'hanning', https://numpy.org/doc/stable/reference/generated/numpy.hanning.html - 'inner', https://numpy.org/doc/stable/reference/generated/numpy.inner.html - 'isneginf', https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html - 'isposinf', https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html - 'kaiser', https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html - 'logspace', https://numpy.org/doc/stable/reference/generated/numpy.logspace.html - 'place', https://numpy.org/doc/stable/reference/generated/numpy.place.html - \ No newline at end of file diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index 5fa482bde..51b48a9ed 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -1,8 +1,24 @@ # Release Notes -## Version 2.6.3 - -* added `select` function +## Version 2.7.0 + +* added `bartlett`, https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html +* added `blackman`, https://numpy.org/doc/stable/reference/generated/numpy.blackman.html +* added `choose`, https://numpy.org/doc/stable/reference/generated/numpy.choose.html +* added `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html +* added `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html +* added `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html +* added `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html +* added `hamming`, https://numpy.org/doc/stable/reference/generated/numpy.hamming.html +* added `hammingEncode`, https://en.wikipedia.org/wiki/Hamming_code +* added `hanning`, https://numpy.org/doc/stable/reference/generated/numpy.hanning.html +* added `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html +* added `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html +* added `isposinf`, https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html +* added `kaiser`, https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html +* added `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html +* added `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html +* added `select` function, https://numpy.org/doc/stable/reference/generated/numpy.select.html * `fmod` and the modulus `%` operator now work with float dtypes * minor performance improvements diff --git a/include/NumCpp.hpp b/include/NumCpp.hpp index e4a4ee8f7..fc70b03a8 100644 --- a/include/NumCpp.hpp +++ b/include/NumCpp.hpp @@ -6,7 +6,7 @@ /// /// /// @section License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Coordinates.hpp b/include/NumCpp/Coordinates.hpp index 54070ec41..cfe39ce1e 100644 --- a/include/NumCpp/Coordinates.hpp +++ b/include/NumCpp/Coordinates.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Coordinates/Coordinate.hpp b/include/NumCpp/Coordinates/Coordinate.hpp index 3a47cc1f0..0c84cf02d 100644 --- a/include/NumCpp/Coordinates/Coordinate.hpp +++ b/include/NumCpp/Coordinates/Coordinate.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Coordinates/Dec.hpp b/include/NumCpp/Coordinates/Dec.hpp index ed1699d5a..d846c5251 100644 --- a/include/NumCpp/Coordinates/Dec.hpp +++ b/include/NumCpp/Coordinates/Dec.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Coordinates/RA.hpp b/include/NumCpp/Coordinates/RA.hpp index 341c483dc..4e9a556a0 100644 --- a/include/NumCpp/Coordinates/RA.hpp +++ b/include/NumCpp/Coordinates/RA.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Coordinates/degreeSeperation.hpp b/include/NumCpp/Coordinates/degreeSeperation.hpp index f83d35f85..6e9843db5 100644 --- a/include/NumCpp/Coordinates/degreeSeperation.hpp +++ b/include/NumCpp/Coordinates/degreeSeperation.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Coordinates/radianSeperation.hpp b/include/NumCpp/Coordinates/radianSeperation.hpp index 547ffa9e3..37fdc44df 100644 --- a/include/NumCpp/Coordinates/radianSeperation.hpp +++ b/include/NumCpp/Coordinates/radianSeperation.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core.hpp b/include/NumCpp/Core.hpp index bb32c8ba3..09a4f881f 100644 --- a/include/NumCpp/Core.hpp +++ b/include/NumCpp/Core.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Constants.hpp b/include/NumCpp/Core/Constants.hpp index 10e36c2c8..74eac3f0b 100644 --- a/include/NumCpp/Core/Constants.hpp +++ b/include/NumCpp/Core/Constants.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/DataCube.hpp b/include/NumCpp/Core/DataCube.hpp index c455db87f..84c85d989 100644 --- a/include/NumCpp/Core/DataCube.hpp +++ b/include/NumCpp/Core/DataCube.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/DtypeInfo.hpp b/include/NumCpp/Core/DtypeInfo.hpp index 86b3baf67..2c1472c29 100644 --- a/include/NumCpp/Core/DtypeInfo.hpp +++ b/include/NumCpp/Core/DtypeInfo.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/Endian.hpp b/include/NumCpp/Core/Internal/Endian.hpp index 18a2e684d..f4081be38 100644 --- a/include/NumCpp/Core/Internal/Endian.hpp +++ b/include/NumCpp/Core/Internal/Endian.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/Error.hpp b/include/NumCpp/Core/Internal/Error.hpp index d1a6d65f7..831944831 100644 --- a/include/NumCpp/Core/Internal/Error.hpp +++ b/include/NumCpp/Core/Internal/Error.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/Filesystem.hpp b/include/NumCpp/Core/Internal/Filesystem.hpp index dae51b168..29115e456 100644 --- a/include/NumCpp/Core/Internal/Filesystem.hpp +++ b/include/NumCpp/Core/Internal/Filesystem.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/StaticAsserts.hpp b/include/NumCpp/Core/Internal/StaticAsserts.hpp index 4e231f3ff..67a752d62 100644 --- a/include/NumCpp/Core/Internal/StaticAsserts.hpp +++ b/include/NumCpp/Core/Internal/StaticAsserts.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/StdComplexOperators.hpp b/include/NumCpp/Core/Internal/StdComplexOperators.hpp index 500228f0d..423bfd830 100644 --- a/include/NumCpp/Core/Internal/StdComplexOperators.hpp +++ b/include/NumCpp/Core/Internal/StdComplexOperators.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/StlAlgorithms.hpp b/include/NumCpp/Core/Internal/StlAlgorithms.hpp index 2b4ccde06..9d413f9a5 100644 --- a/include/NumCpp/Core/Internal/StlAlgorithms.hpp +++ b/include/NumCpp/Core/Internal/StlAlgorithms.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/TypeTraits.hpp b/include/NumCpp/Core/Internal/TypeTraits.hpp index c658b051c..5c307787b 100644 --- a/include/NumCpp/Core/Internal/TypeTraits.hpp +++ b/include/NumCpp/Core/Internal/TypeTraits.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Internal/Version.hpp b/include/NumCpp/Core/Internal/Version.hpp index 562fdf668..37b8b79fc 100644 --- a/include/NumCpp/Core/Internal/Version.hpp +++ b/include/NumCpp/Core/Internal/Version.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software @@ -29,5 +29,5 @@ namespace nc { - constexpr char VERSION[] = "2.6.3"; ///< Current NumCpp version number + constexpr char VERSION[] = "2.7.0"; ///< Current NumCpp version number } // namespace nc diff --git a/include/NumCpp/Core/Shape.hpp b/include/NumCpp/Core/Shape.hpp index c5a3cd667..eb3b69c3c 100644 --- a/include/NumCpp/Core/Shape.hpp +++ b/include/NumCpp/Core/Shape.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Slice.hpp b/include/NumCpp/Core/Slice.hpp index 417689e6f..d5268bf5b 100644 --- a/include/NumCpp/Core/Slice.hpp +++ b/include/NumCpp/Core/Slice.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Timer.hpp b/include/NumCpp/Core/Timer.hpp index 51f1944ce..552759823 100644 --- a/include/NumCpp/Core/Timer.hpp +++ b/include/NumCpp/Core/Timer.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Core/Types.hpp b/include/NumCpp/Core/Types.hpp index bd6cd86b5..a65c6dede 100644 --- a/include/NumCpp/Core/Types.hpp +++ b/include/NumCpp/Core/Types.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter.hpp b/include/NumCpp/Filter.hpp index f3662f699..78ad7dde6 100644 --- a/include/NumCpp/Filter.hpp +++ b/include/NumCpp/Filter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp index 2f2429567..e1e843267 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp index e330c9d5a..a867224c8 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp index 1d61809eb..c740fbee7 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp index 5273f0d2e..8406677d7 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp index 4bd24e8aa..a6812b89d 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp index ee73fcd14..ca373978d 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp index 215955cd0..59ec3f555 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp index c180bda6f..b1dfbfe13 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp index b51dd4b00..cd4b016bb 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp index 73e926190..c85389d70 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp index 6fa7fa5df..b884b77cb 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp index 76d42f2cf..7fcfb5030 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp index f61d008f4..e1086d8bc 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp index 915a81d6b..631fab916 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp index 1088d4d33..86c49870f 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Boundaries/Boundary.hpp b/include/NumCpp/Filter/Boundaries/Boundary.hpp index 9c0502e23..f4a85eab4 100644 --- a/include/NumCpp/Filter/Boundaries/Boundary.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundary.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp index 30f99884c..d7677e09d 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp index 11c2a778a..e6c8ce29f 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp index 6442e5d1e..a9b7e93ea 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp index 7af1cb0d8..cbd3a2865 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp index 454e9e486..6249dbf19 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp index 4246ec7bd..d6be7b19f 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp index 55d1f3c3b..1a828b0e6 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp index 9fc6ed40f..4223a8d54 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp index 37709ad11..4cbb44672 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp index 6344ba69e..2299de08e 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp b/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp index f112cd6c7..036fd71bf 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp index 86c846edb..64e992760 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp b/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp index b444ffac1..9f811303b 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp index d8b7f4216..637b0a5e0 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp index 35e0cae48..6ddee6654 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp index f99f79e8a..93cd140f1 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp index 2f27ed938..2888a339f 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp index 6d5b24e6d..185924c13 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp index e864d4dfd..93879b6b0 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions.hpp b/include/NumCpp/Functions.hpp index 539078a93..0bc80c7e7 100644 --- a/include/NumCpp/Functions.hpp +++ b/include/NumCpp/Functions.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software @@ -58,17 +58,20 @@ #include "NumCpp/Functions/astype.hpp" #include "NumCpp/Functions/average.hpp" +#include "NumCpp/Functions/bartlett.hpp" #include "NumCpp/Functions/binaryRepr.hpp" #include "NumCpp/Functions/bincount.hpp" #include "NumCpp/Functions/bitwise_and.hpp" #include "NumCpp/Functions/bitwise_not.hpp" #include "NumCpp/Functions/bitwise_or.hpp" #include "NumCpp/Functions/bitwise_xor.hpp" +#include "NumCpp/Functions/blackman.hpp" #include "NumCpp/Functions/byteswap.hpp" #include "NumCpp/Functions/cbrt.hpp" #include "NumCpp/Functions/ceil.hpp" #include "NumCpp/Functions/centerOfMass.hpp" +#include "NumCpp/Functions/choose.hpp" #include "NumCpp/Functions/clip.hpp" #include "NumCpp/Functions/column_stack.hpp" #include "NumCpp/Functions/complex.hpp" @@ -80,7 +83,9 @@ #include "NumCpp/Functions/copyto.hpp" #include "NumCpp/Functions/cos.hpp" #include "NumCpp/Functions/cosh.hpp" +#include "NumCpp/Functions/corrcoef.hpp" #include "NumCpp/Functions/count_nonzero.hpp" +#include "NumCpp/Functions/cov.hpp" #include "NumCpp/Functions/cross.hpp" #include "NumCpp/Functions/cube.hpp" #include "NumCpp/Functions/cumprod.hpp" @@ -104,6 +109,7 @@ #include "NumCpp/Functions/exp.hpp" #include "NumCpp/Functions/exp2.hpp" #include "NumCpp/Functions/expm1.hpp" +#include "NumCpp/Functions/extract.hpp" #include "NumCpp/Functions/eye.hpp" #include "NumCpp/Functions/fillDiagnol.hpp" @@ -126,23 +132,32 @@ #include "NumCpp/Functions/full_like.hpp" #include "NumCpp/Functions/gcd.hpp" +#include "NumCpp/Functions/geomspace.hpp" #include "NumCpp/Functions/gradient.hpp" #include "NumCpp/Functions/greater.hpp" #include "NumCpp/Functions/greater_equal.hpp" +#include "NumCpp/Functions/hamming.hpp" +#include "NumCpp/Functions/hammingEncode.hpp" +#include "NumCpp/Functions/hanning.hpp" #include "NumCpp/Functions/histogram.hpp" #include "NumCpp/Functions/hstack.hpp" #include "NumCpp/Functions/hypot.hpp" #include "NumCpp/Functions/identity.hpp" #include "NumCpp/Functions/imag.hpp" +#include "NumCpp/Functions/inner.hpp" #include "NumCpp/Functions/interp.hpp" #include "NumCpp/Functions/intersect1d.hpp" #include "NumCpp/Functions/invert.hpp" #include "NumCpp/Functions/isclose.hpp" #include "NumCpp/Functions/isinf.hpp" +#include "NumCpp/Functions/isneginf.hpp" +#include "NumCpp/Functions/isposinf.hpp" #include "NumCpp/Functions/isnan.hpp" +#include "NumCpp/Functions/kaiser.hpp" + #include "NumCpp/Functions/lcm.hpp" #include "NumCpp/Functions/ldexp.hpp" #include "NumCpp/Functions/left_shift.hpp" @@ -158,6 +173,7 @@ #include "NumCpp/Functions/logical_not.hpp" #include "NumCpp/Functions/logical_or.hpp" #include "NumCpp/Functions/logical_xor.hpp" +#include "NumCpp/Functions/logspace.hpp" #include "NumCpp/Functions/matmul.hpp" #include "NumCpp/Functions/max.hpp" @@ -201,6 +217,7 @@ #include "NumCpp/Functions/pad.hpp" #include "NumCpp/Functions/partition.hpp" #include "NumCpp/Functions/percentile.hpp" +#include "NumCpp/Functions/place.hpp" #include "NumCpp/Functions/polar.hpp" #include "NumCpp/Functions/power.hpp" #include "NumCpp/Functions/powerf.hpp" diff --git a/include/NumCpp/Functions/abs.hpp b/include/NumCpp/Functions/abs.hpp index 9ed499005..a2b7ec59c 100644 --- a/include/NumCpp/Functions/abs.hpp +++ b/include/NumCpp/Functions/abs.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/add.hpp b/include/NumCpp/Functions/add.hpp index 9a8ac8157..af1f897ab 100644 --- a/include/NumCpp/Functions/add.hpp +++ b/include/NumCpp/Functions/add.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/alen.hpp b/include/NumCpp/Functions/alen.hpp index d2e669edd..a67efe4f5 100644 --- a/include/NumCpp/Functions/alen.hpp +++ b/include/NumCpp/Functions/alen.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/all.hpp b/include/NumCpp/Functions/all.hpp index 548f0652a..f5e14bf0e 100644 --- a/include/NumCpp/Functions/all.hpp +++ b/include/NumCpp/Functions/all.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/allclose.hpp b/include/NumCpp/Functions/allclose.hpp index 0c17d2ce8..77744d40a 100644 --- a/include/NumCpp/Functions/allclose.hpp +++ b/include/NumCpp/Functions/allclose.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/amax.hpp b/include/NumCpp/Functions/amax.hpp index e4991426c..dbad5d0a2 100644 --- a/include/NumCpp/Functions/amax.hpp +++ b/include/NumCpp/Functions/amax.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/amin.hpp b/include/NumCpp/Functions/amin.hpp index 3f4aa6fa8..ce8d397e1 100644 --- a/include/NumCpp/Functions/amin.hpp +++ b/include/NumCpp/Functions/amin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/angle.hpp b/include/NumCpp/Functions/angle.hpp index 7fd76fb82..6812120d7 100644 --- a/include/NumCpp/Functions/angle.hpp +++ b/include/NumCpp/Functions/angle.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/any.hpp b/include/NumCpp/Functions/any.hpp index e3f8eefaa..b392785a1 100644 --- a/include/NumCpp/Functions/any.hpp +++ b/include/NumCpp/Functions/any.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/append.hpp b/include/NumCpp/Functions/append.hpp index 70fce66a9..ad6fd2ad2 100644 --- a/include/NumCpp/Functions/append.hpp +++ b/include/NumCpp/Functions/append.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/applyFunction.hpp b/include/NumCpp/Functions/applyFunction.hpp index 42656e7f4..2c046ddb2 100644 --- a/include/NumCpp/Functions/applyFunction.hpp +++ b/include/NumCpp/Functions/applyFunction.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/applyPoly1d.hpp b/include/NumCpp/Functions/applyPoly1d.hpp index dc32b1405..fae3c6f1f 100644 --- a/include/NumCpp/Functions/applyPoly1d.hpp +++ b/include/NumCpp/Functions/applyPoly1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arange.hpp b/include/NumCpp/Functions/arange.hpp index 201654c7c..233092284 100644 --- a/include/NumCpp/Functions/arange.hpp +++ b/include/NumCpp/Functions/arange.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arccos.hpp b/include/NumCpp/Functions/arccos.hpp index e49c01d89..fa7754895 100644 --- a/include/NumCpp/Functions/arccos.hpp +++ b/include/NumCpp/Functions/arccos.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arccosh.hpp b/include/NumCpp/Functions/arccosh.hpp index 6c83032f3..b85f52519 100644 --- a/include/NumCpp/Functions/arccosh.hpp +++ b/include/NumCpp/Functions/arccosh.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arcsin.hpp b/include/NumCpp/Functions/arcsin.hpp index 750bf8cab..250d52117 100644 --- a/include/NumCpp/Functions/arcsin.hpp +++ b/include/NumCpp/Functions/arcsin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arcsinh.hpp b/include/NumCpp/Functions/arcsinh.hpp index 0c18036b2..d3a0a6975 100644 --- a/include/NumCpp/Functions/arcsinh.hpp +++ b/include/NumCpp/Functions/arcsinh.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arctan.hpp b/include/NumCpp/Functions/arctan.hpp index ae9424a97..628bc732b 100644 --- a/include/NumCpp/Functions/arctan.hpp +++ b/include/NumCpp/Functions/arctan.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arctan2.hpp b/include/NumCpp/Functions/arctan2.hpp index a25b7f9bd..2f4596cea 100644 --- a/include/NumCpp/Functions/arctan2.hpp +++ b/include/NumCpp/Functions/arctan2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/arctanh.hpp b/include/NumCpp/Functions/arctanh.hpp index 4b6f06025..d2811d906 100644 --- a/include/NumCpp/Functions/arctanh.hpp +++ b/include/NumCpp/Functions/arctanh.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/argmax.hpp b/include/NumCpp/Functions/argmax.hpp index 2281bdf2a..a5530bbad 100644 --- a/include/NumCpp/Functions/argmax.hpp +++ b/include/NumCpp/Functions/argmax.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/argmin.hpp b/include/NumCpp/Functions/argmin.hpp index 76f817611..45e6b97f4 100644 --- a/include/NumCpp/Functions/argmin.hpp +++ b/include/NumCpp/Functions/argmin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/argsort.hpp b/include/NumCpp/Functions/argsort.hpp index 1e35683ad..27e7d672f 100644 --- a/include/NumCpp/Functions/argsort.hpp +++ b/include/NumCpp/Functions/argsort.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/argwhere.hpp b/include/NumCpp/Functions/argwhere.hpp index 4e6e2593b..0bf215252 100644 --- a/include/NumCpp/Functions/argwhere.hpp +++ b/include/NumCpp/Functions/argwhere.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/around.hpp b/include/NumCpp/Functions/around.hpp index c14b4eaa4..9a9277ac4 100644 --- a/include/NumCpp/Functions/around.hpp +++ b/include/NumCpp/Functions/around.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/array_equal.hpp b/include/NumCpp/Functions/array_equal.hpp index 05573bb9d..8ccbc9521 100644 --- a/include/NumCpp/Functions/array_equal.hpp +++ b/include/NumCpp/Functions/array_equal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/array_equiv.hpp b/include/NumCpp/Functions/array_equiv.hpp index f4b0388dc..81edb3b35 100644 --- a/include/NumCpp/Functions/array_equiv.hpp +++ b/include/NumCpp/Functions/array_equiv.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/asarray.hpp b/include/NumCpp/Functions/asarray.hpp index 7ff1adb64..778ff226a 100644 --- a/include/NumCpp/Functions/asarray.hpp +++ b/include/NumCpp/Functions/asarray.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/astype.hpp b/include/NumCpp/Functions/astype.hpp index 244ddc4d2..514a6ab78 100644 --- a/include/NumCpp/Functions/astype.hpp +++ b/include/NumCpp/Functions/astype.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/average.hpp b/include/NumCpp/Functions/average.hpp index 1c245fe05..59edcdaf2 100644 --- a/include/NumCpp/Functions/average.hpp +++ b/include/NumCpp/Functions/average.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/bartlett.hpp b/include/NumCpp/Functions/bartlett.hpp new file mode 100644 index 000000000..be518737a --- /dev/null +++ b/include/NumCpp/Functions/bartlett.hpp @@ -0,0 +1,49 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// The Bartlett window is very similar to a triangular window, except that the end + /// points are at zero. It is often used in signal processing for tapering a signal, + /// without generating too much ripple in the frequency domain. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html + /// + /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @return NdArray + /// + // inline NdArray bartlett(int M) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/binaryRepr.hpp b/include/NumCpp/Functions/binaryRepr.hpp index 8c0c92ffb..21c0e78db 100644 --- a/include/NumCpp/Functions/binaryRepr.hpp +++ b/include/NumCpp/Functions/binaryRepr.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/bincount.hpp b/include/NumCpp/Functions/bincount.hpp index bf6407c43..55d86e5a9 100644 --- a/include/NumCpp/Functions/bincount.hpp +++ b/include/NumCpp/Functions/bincount.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/bitwise_and.hpp b/include/NumCpp/Functions/bitwise_and.hpp index 34f58a0c1..db304ee6d 100644 --- a/include/NumCpp/Functions/bitwise_and.hpp +++ b/include/NumCpp/Functions/bitwise_and.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/bitwise_not.hpp b/include/NumCpp/Functions/bitwise_not.hpp index 8e7e337cf..94c4a8703 100644 --- a/include/NumCpp/Functions/bitwise_not.hpp +++ b/include/NumCpp/Functions/bitwise_not.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/bitwise_or.hpp b/include/NumCpp/Functions/bitwise_or.hpp index 13b606ede..17e59dc1a 100644 --- a/include/NumCpp/Functions/bitwise_or.hpp +++ b/include/NumCpp/Functions/bitwise_or.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/bitwise_xor.hpp b/include/NumCpp/Functions/bitwise_xor.hpp index 8423f7090..a72c96948 100644 --- a/include/NumCpp/Functions/bitwise_xor.hpp +++ b/include/NumCpp/Functions/bitwise_xor.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/blackman.hpp b/include/NumCpp/Functions/blackman.hpp new file mode 100644 index 000000000..e1a61fa1f --- /dev/null +++ b/include/NumCpp/Functions/blackman.hpp @@ -0,0 +1,49 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// The Blackman window is a taper formed by using the first three terms of a summation of + /// cosines. It was designed to have close to the minimal leakage possible. It is close to + /// optimal, only slightly worse than a Kaiser window. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.blackman.html + /// + /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @return NdArray + /// + // inline NdArray blackman(int M) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/byteswap.hpp b/include/NumCpp/Functions/byteswap.hpp index 5f5fdbbb2..6292a6ecb 100644 --- a/include/NumCpp/Functions/byteswap.hpp +++ b/include/NumCpp/Functions/byteswap.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/cbrt.hpp b/include/NumCpp/Functions/cbrt.hpp index d0bf4bff5..2191c9d62 100644 --- a/include/NumCpp/Functions/cbrt.hpp +++ b/include/NumCpp/Functions/cbrt.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/ceil.hpp b/include/NumCpp/Functions/ceil.hpp index b5afb42ae..1bb1c962a 100644 --- a/include/NumCpp/Functions/ceil.hpp +++ b/include/NumCpp/Functions/ceil.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/centerOfMass.hpp b/include/NumCpp/Functions/centerOfMass.hpp index 887beb855..69d1c304b 100644 --- a/include/NumCpp/Functions/centerOfMass.hpp +++ b/include/NumCpp/Functions/centerOfMass.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/choose.hpp b/include/NumCpp/Functions/choose.hpp new file mode 100644 index 000000000..eb4b8310b --- /dev/null +++ b/include/NumCpp/Functions/choose.hpp @@ -0,0 +1,51 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Construct an array from an index array and a list of arrays to choose from. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.choose.html + /// + /// @param a: int array. This array must contain integers in [0, n-1], where n is the number of choices + /// @param choices: Choice arrays. a and all of the choices must be broadcastable to the same shape. + /// @return NdArray + /// + // template choose(const NdArray& a, const std::vector*>& choices) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/clip.hpp b/include/NumCpp/Functions/clip.hpp index a4c11b797..8bc262ac1 100644 --- a/include/NumCpp/Functions/clip.hpp +++ b/include/NumCpp/Functions/clip.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/column_stack.hpp b/include/NumCpp/Functions/column_stack.hpp index a744cefd1..bb354651a 100644 --- a/include/NumCpp/Functions/column_stack.hpp +++ b/include/NumCpp/Functions/column_stack.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/complex.hpp b/include/NumCpp/Functions/complex.hpp index 35e3a6aae..8d9dd935e 100644 --- a/include/NumCpp/Functions/complex.hpp +++ b/include/NumCpp/Functions/complex.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/concatenate.hpp b/include/NumCpp/Functions/concatenate.hpp index aac7ee296..d42cdbe8c 100644 --- a/include/NumCpp/Functions/concatenate.hpp +++ b/include/NumCpp/Functions/concatenate.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/conj.hpp b/include/NumCpp/Functions/conj.hpp index f4b143466..ea1c02496 100644 --- a/include/NumCpp/Functions/conj.hpp +++ b/include/NumCpp/Functions/conj.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/contains.hpp b/include/NumCpp/Functions/contains.hpp index f5f5e833e..a62827829 100644 --- a/include/NumCpp/Functions/contains.hpp +++ b/include/NumCpp/Functions/contains.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/copy.hpp b/include/NumCpp/Functions/copy.hpp index 0b90f3763..360799550 100644 --- a/include/NumCpp/Functions/copy.hpp +++ b/include/NumCpp/Functions/copy.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/copySign.hpp b/include/NumCpp/Functions/copySign.hpp index 4cc01427e..f8753086a 100644 --- a/include/NumCpp/Functions/copySign.hpp +++ b/include/NumCpp/Functions/copySign.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/copyto.hpp b/include/NumCpp/Functions/copyto.hpp index 4add2a49c..5bdc4892b 100644 --- a/include/NumCpp/Functions/copyto.hpp +++ b/include/NumCpp/Functions/copyto.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/corrcoef.hpp b/include/NumCpp/Functions/corrcoef.hpp new file mode 100644 index 000000000..60fa86e83 --- /dev/null +++ b/include/NumCpp/Functions/corrcoef.hpp @@ -0,0 +1,50 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return Pearson product-moment correlation coefficients. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html + /// + /// @param x: A 1-D or 2-D array containing multiple variables and observations. + /// Each row of x represents a variable, and each column a single observation + /// of all those variables. + /// @return NdArray + /// + // template + // NdArray corrcoef(const NdArray& x) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/cos.hpp b/include/NumCpp/Functions/cos.hpp index 0c16e9c51..eaf41b6c9 100644 --- a/include/NumCpp/Functions/cos.hpp +++ b/include/NumCpp/Functions/cos.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/cosh.hpp b/include/NumCpp/Functions/cosh.hpp index 9dc9dc403..c17fb3ee5 100644 --- a/include/NumCpp/Functions/cosh.hpp +++ b/include/NumCpp/Functions/cosh.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/count_nonzero.hpp b/include/NumCpp/Functions/count_nonzero.hpp index a0c35e2bb..415f0718e 100644 --- a/include/NumCpp/Functions/count_nonzero.hpp +++ b/include/NumCpp/Functions/count_nonzero.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/cov.hpp b/include/NumCpp/Functions/cov.hpp new file mode 100644 index 000000000..0eb153b33 --- /dev/null +++ b/include/NumCpp/Functions/cov.hpp @@ -0,0 +1,50 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Estimate a covariance matrix, given data and weights. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.cov.html + /// + /// @param x: A 1-D or 2-D array containing multiple variables and observations. + /// Each row of x represents a variable, and each column a single observation + /// of all those variables. + /// @return NdArray + /// + // template + // NdArray cov(const NdArray& x) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/cross.hpp b/include/NumCpp/Functions/cross.hpp index 9821a18f1..e65f6c9f7 100644 --- a/include/NumCpp/Functions/cross.hpp +++ b/include/NumCpp/Functions/cross.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/cube.hpp b/include/NumCpp/Functions/cube.hpp index 4d657593d..176519024 100644 --- a/include/NumCpp/Functions/cube.hpp +++ b/include/NumCpp/Functions/cube.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/cumprod.hpp b/include/NumCpp/Functions/cumprod.hpp index 93b81127b..89ab72ed7 100644 --- a/include/NumCpp/Functions/cumprod.hpp +++ b/include/NumCpp/Functions/cumprod.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/cumsum.hpp b/include/NumCpp/Functions/cumsum.hpp index ac0f0449c..e85a7b41e 100644 --- a/include/NumCpp/Functions/cumsum.hpp +++ b/include/NumCpp/Functions/cumsum.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/deg2rad.hpp b/include/NumCpp/Functions/deg2rad.hpp index c51e73125..1935fbc60 100644 --- a/include/NumCpp/Functions/deg2rad.hpp +++ b/include/NumCpp/Functions/deg2rad.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/degrees.hpp b/include/NumCpp/Functions/degrees.hpp index 2b8a1cc21..e4e670fb2 100644 --- a/include/NumCpp/Functions/degrees.hpp +++ b/include/NumCpp/Functions/degrees.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/deleteIndices.hpp b/include/NumCpp/Functions/deleteIndices.hpp index db917f2ff..d4857e77c 100644 --- a/include/NumCpp/Functions/deleteIndices.hpp +++ b/include/NumCpp/Functions/deleteIndices.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/diag.hpp b/include/NumCpp/Functions/diag.hpp index 18588aec6..38042d0d1 100644 --- a/include/NumCpp/Functions/diag.hpp +++ b/include/NumCpp/Functions/diag.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/diagflat.hpp b/include/NumCpp/Functions/diagflat.hpp index 2ef0f135a..c6ade0bb0 100644 --- a/include/NumCpp/Functions/diagflat.hpp +++ b/include/NumCpp/Functions/diagflat.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/diagonal.hpp b/include/NumCpp/Functions/diagonal.hpp index 827de1d0f..e218dc363 100644 --- a/include/NumCpp/Functions/diagonal.hpp +++ b/include/NumCpp/Functions/diagonal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/diff.hpp b/include/NumCpp/Functions/diff.hpp index 37566e4aa..c84ccf29a 100644 --- a/include/NumCpp/Functions/diff.hpp +++ b/include/NumCpp/Functions/diff.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/divide.hpp b/include/NumCpp/Functions/divide.hpp index eeaa2f492..b5c3a16cd 100644 --- a/include/NumCpp/Functions/divide.hpp +++ b/include/NumCpp/Functions/divide.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/dot.hpp b/include/NumCpp/Functions/dot.hpp index 7ca35bf6b..957c589a9 100644 --- a/include/NumCpp/Functions/dot.hpp +++ b/include/NumCpp/Functions/dot.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/dump.hpp b/include/NumCpp/Functions/dump.hpp index a1287d93e..84d46d641 100644 --- a/include/NumCpp/Functions/dump.hpp +++ b/include/NumCpp/Functions/dump.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/empty.hpp b/include/NumCpp/Functions/empty.hpp index 5a71fbade..8cbab5038 100644 --- a/include/NumCpp/Functions/empty.hpp +++ b/include/NumCpp/Functions/empty.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/empty_like.hpp b/include/NumCpp/Functions/empty_like.hpp index 7a66f1c9e..bf951ba00 100644 --- a/include/NumCpp/Functions/empty_like.hpp +++ b/include/NumCpp/Functions/empty_like.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/endianess.hpp b/include/NumCpp/Functions/endianess.hpp index c88c862b6..b006575e9 100644 --- a/include/NumCpp/Functions/endianess.hpp +++ b/include/NumCpp/Functions/endianess.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/equal.hpp b/include/NumCpp/Functions/equal.hpp index a46a82807..99dedd141 100644 --- a/include/NumCpp/Functions/equal.hpp +++ b/include/NumCpp/Functions/equal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/exp.hpp b/include/NumCpp/Functions/exp.hpp index 45a3db6f0..732853c30 100644 --- a/include/NumCpp/Functions/exp.hpp +++ b/include/NumCpp/Functions/exp.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/exp2.hpp b/include/NumCpp/Functions/exp2.hpp index 254fcc894..b5577fa14 100644 --- a/include/NumCpp/Functions/exp2.hpp +++ b/include/NumCpp/Functions/exp2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/expm1.hpp b/include/NumCpp/Functions/expm1.hpp index 954e9c447..dacb5065c 100644 --- a/include/NumCpp/Functions/expm1.hpp +++ b/include/NumCpp/Functions/expm1.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/extract.hpp b/include/NumCpp/Functions/extract.hpp new file mode 100644 index 000000000..d287c72a6 --- /dev/null +++ b/include/NumCpp/Functions/extract.hpp @@ -0,0 +1,49 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return the elements of an array that satisfy some condition. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.extract.html + /// + /// @param condition: An array whose nonzero or True entries indicate the elements of arr to extract. + /// @param arr: Input array of the same size as condition + /// @return NdArray + /// + // template + // NdArray extract(const NdArray& condition, const NdArray& arr) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/eye.hpp b/include/NumCpp/Functions/eye.hpp index 2004c69b9..8e2dd1915 100644 --- a/include/NumCpp/Functions/eye.hpp +++ b/include/NumCpp/Functions/eye.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fillDiagnol.hpp b/include/NumCpp/Functions/fillDiagnol.hpp index 82debb3b4..05c9b2e08 100644 --- a/include/NumCpp/Functions/fillDiagnol.hpp +++ b/include/NumCpp/Functions/fillDiagnol.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/find.hpp b/include/NumCpp/Functions/find.hpp index b6ec86be8..fa06f5602 100644 --- a/include/NumCpp/Functions/find.hpp +++ b/include/NumCpp/Functions/find.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fix.hpp b/include/NumCpp/Functions/fix.hpp index be4751b7f..abfa8f527 100644 --- a/include/NumCpp/Functions/fix.hpp +++ b/include/NumCpp/Functions/fix.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/flatnonzero.hpp b/include/NumCpp/Functions/flatnonzero.hpp index d59c0b2cc..15125170d 100644 --- a/include/NumCpp/Functions/flatnonzero.hpp +++ b/include/NumCpp/Functions/flatnonzero.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/flatten.hpp b/include/NumCpp/Functions/flatten.hpp index 3cfb9e0b2..d9d91d94c 100644 --- a/include/NumCpp/Functions/flatten.hpp +++ b/include/NumCpp/Functions/flatten.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/flip.hpp b/include/NumCpp/Functions/flip.hpp index a05b58cf3..38149e99e 100644 --- a/include/NumCpp/Functions/flip.hpp +++ b/include/NumCpp/Functions/flip.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fliplr.hpp b/include/NumCpp/Functions/fliplr.hpp index a31bdbc57..332c3416e 100644 --- a/include/NumCpp/Functions/fliplr.hpp +++ b/include/NumCpp/Functions/fliplr.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/flipud.hpp b/include/NumCpp/Functions/flipud.hpp index a8a6137a4..415df8297 100644 --- a/include/NumCpp/Functions/flipud.hpp +++ b/include/NumCpp/Functions/flipud.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/floor.hpp b/include/NumCpp/Functions/floor.hpp index 52886aae3..1c7b8c6c2 100644 --- a/include/NumCpp/Functions/floor.hpp +++ b/include/NumCpp/Functions/floor.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/floor_divide.hpp b/include/NumCpp/Functions/floor_divide.hpp index b9ef6f205..2f8db8353 100644 --- a/include/NumCpp/Functions/floor_divide.hpp +++ b/include/NumCpp/Functions/floor_divide.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fmax.hpp b/include/NumCpp/Functions/fmax.hpp index d6e34471f..425f0362c 100644 --- a/include/NumCpp/Functions/fmax.hpp +++ b/include/NumCpp/Functions/fmax.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fmin.hpp b/include/NumCpp/Functions/fmin.hpp index e2cbb0c23..0838fde37 100644 --- a/include/NumCpp/Functions/fmin.hpp +++ b/include/NumCpp/Functions/fmin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fmod.hpp b/include/NumCpp/Functions/fmod.hpp index 4f366fe5a..6e88fc1ad 100644 --- a/include/NumCpp/Functions/fmod.hpp +++ b/include/NumCpp/Functions/fmod.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/frombuffer.hpp b/include/NumCpp/Functions/frombuffer.hpp index eb9ba9259..2306cdf94 100644 --- a/include/NumCpp/Functions/frombuffer.hpp +++ b/include/NumCpp/Functions/frombuffer.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fromfile.hpp b/include/NumCpp/Functions/fromfile.hpp index 2b5c65197..724ebb280 100644 --- a/include/NumCpp/Functions/fromfile.hpp +++ b/include/NumCpp/Functions/fromfile.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/fromiter.hpp b/include/NumCpp/Functions/fromiter.hpp index 025d9fe22..84b7883e9 100644 --- a/include/NumCpp/Functions/fromiter.hpp +++ b/include/NumCpp/Functions/fromiter.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/full.hpp b/include/NumCpp/Functions/full.hpp index 142a027b2..e2433ef1c 100644 --- a/include/NumCpp/Functions/full.hpp +++ b/include/NumCpp/Functions/full.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/full_like.hpp b/include/NumCpp/Functions/full_like.hpp index 8dc5012b4..2a750aef1 100644 --- a/include/NumCpp/Functions/full_like.hpp +++ b/include/NumCpp/Functions/full_like.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/gcd.hpp b/include/NumCpp/Functions/gcd.hpp index 23c82ebed..c8c2daa8a 100644 --- a/include/NumCpp/Functions/gcd.hpp +++ b/include/NumCpp/Functions/gcd.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/geomspace.hpp b/include/NumCpp/Functions/geomspace.hpp new file mode 100644 index 000000000..0d4307b77 --- /dev/null +++ b/include/NumCpp/Functions/geomspace.hpp @@ -0,0 +1,52 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return numbers spaced evenly on a log scale (a geometric progression). + /// + /// This is similar to logspace, but with endpoints specified directly. + /// Each output sample is a constant multiple of the previous. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html + /// + /// @param start: the starting value of a sequence + /// @param stop: The final value of the sequence, unless endpoint is False. + /// In that case, num + 1 values are spaced over the interval + /// in log-space, of which all but the last (a sequence of length num) are returned. + /// @param num: Number of samples to generate. Default 50. + /// @param enpoint: If true, stop is the last sample. Otherwide,it is not included. Default is true. + /// @return NdArray + /// + +} // namespace nc diff --git a/include/NumCpp/Functions/gradient.hpp b/include/NumCpp/Functions/gradient.hpp index d1d37cf46..000c9e07e 100644 --- a/include/NumCpp/Functions/gradient.hpp +++ b/include/NumCpp/Functions/gradient.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/greater.hpp b/include/NumCpp/Functions/greater.hpp index ad6cc41db..0c7aac3f8 100644 --- a/include/NumCpp/Functions/greater.hpp +++ b/include/NumCpp/Functions/greater.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/greater_equal.hpp b/include/NumCpp/Functions/greater_equal.hpp index 519d73f5e..f11bd8720 100644 --- a/include/NumCpp/Functions/greater_equal.hpp +++ b/include/NumCpp/Functions/greater_equal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/hamming.hpp b/include/NumCpp/Functions/hamming.hpp new file mode 100644 index 000000000..94a3869d6 --- /dev/null +++ b/include/NumCpp/Functions/hamming.hpp @@ -0,0 +1,49 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return the Hamming window. + /// + /// The Hamming window is a taper formed by using a weighted cosine. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.hamming.html + /// + /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @return NdArray + /// + // inline NdArray hamming(int M) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/hammingEncode.hpp b/include/NumCpp/Functions/hammingEncode.hpp new file mode 100644 index 000000000..466a92994 --- /dev/null +++ b/include/NumCpp/Functions/hammingEncode.hpp @@ -0,0 +1,43 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Hamming SECDED EDAC encoding and decoding + /// https://en.wikipedia.org/wiki/Hamming_code + /// + /// @param + /// @return NdArray + /// + +} // namespace nc diff --git a/include/NumCpp/Functions/hanning.hpp b/include/NumCpp/Functions/hanning.hpp new file mode 100644 index 000000000..c6c52ffc9 --- /dev/null +++ b/include/NumCpp/Functions/hanning.hpp @@ -0,0 +1,49 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return the Hanning window. + /// + /// The Hamming window is a taper formed by using a weighted cosine. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.hanning.html + /// + /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @return NdArray + /// + // inline NdArray hanning(int M) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/histogram.hpp b/include/NumCpp/Functions/histogram.hpp index 19b515363..7998f0089 100644 --- a/include/NumCpp/Functions/histogram.hpp +++ b/include/NumCpp/Functions/histogram.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/hstack.hpp b/include/NumCpp/Functions/hstack.hpp index e70160c04..dfbc4258f 100644 --- a/include/NumCpp/Functions/hstack.hpp +++ b/include/NumCpp/Functions/hstack.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/hypot.hpp b/include/NumCpp/Functions/hypot.hpp index 03ce3ba3b..da8521c2a 100644 --- a/include/NumCpp/Functions/hypot.hpp +++ b/include/NumCpp/Functions/hypot.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/identity.hpp b/include/NumCpp/Functions/identity.hpp index 0681a87f1..7d9974399 100644 --- a/include/NumCpp/Functions/identity.hpp +++ b/include/NumCpp/Functions/identity.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/imag.hpp b/include/NumCpp/Functions/imag.hpp index e7166d020..97aeb28b3 100644 --- a/include/NumCpp/Functions/imag.hpp +++ b/include/NumCpp/Functions/imag.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/inner.hpp b/include/NumCpp/Functions/inner.hpp new file mode 100644 index 000000000..d91cca2fd --- /dev/null +++ b/include/NumCpp/Functions/inner.hpp @@ -0,0 +1,49 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Inner product of two arrays. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.inner.html + /// + /// @param a: array 1 + /// @param b: array 2 + /// @return NdArray + /// + // template + // NdArray inner(const NdArray& a, const NdArray& b) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/interp.hpp b/include/NumCpp/Functions/interp.hpp index d15a964e2..f0e4e83ab 100644 --- a/include/NumCpp/Functions/interp.hpp +++ b/include/NumCpp/Functions/interp.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/intersect1d.hpp b/include/NumCpp/Functions/intersect1d.hpp index 1245a22de..45d4e85a5 100644 --- a/include/NumCpp/Functions/intersect1d.hpp +++ b/include/NumCpp/Functions/intersect1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/invert.hpp b/include/NumCpp/Functions/invert.hpp index 1a968ecbb..706395b1c 100644 --- a/include/NumCpp/Functions/invert.hpp +++ b/include/NumCpp/Functions/invert.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/isclose.hpp b/include/NumCpp/Functions/isclose.hpp index 32646f9ad..ab388f2af 100644 --- a/include/NumCpp/Functions/isclose.hpp +++ b/include/NumCpp/Functions/isclose.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/isinf.hpp b/include/NumCpp/Functions/isinf.hpp index 97a2352a6..9e6ad4e9b 100644 --- a/include/NumCpp/Functions/isinf.hpp +++ b/include/NumCpp/Functions/isinf.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/isnan.hpp b/include/NumCpp/Functions/isnan.hpp index 3496ba476..6fe4a5569 100644 --- a/include/NumCpp/Functions/isnan.hpp +++ b/include/NumCpp/Functions/isnan.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/isneginf.hpp b/include/NumCpp/Functions/isneginf.hpp new file mode 100644 index 000000000..675c065d1 --- /dev/null +++ b/include/NumCpp/Functions/isneginf.hpp @@ -0,0 +1,48 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Test element-wise for negative infinity, return result as bool array. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html + /// + /// @param x: input array + /// @return NdArray + /// + // template + // NdArray isneginf(const NdArray& inArray) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/isposinf.hpp b/include/NumCpp/Functions/isposinf.hpp new file mode 100644 index 000000000..e160fbc35 --- /dev/null +++ b/include/NumCpp/Functions/isposinf.hpp @@ -0,0 +1,48 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Test element-wise for positive infinity, return result as bool array. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html + /// + /// @param x: input array + /// @return NdArray + /// + // template + // NdArray isposinf(const NdArray& inArray) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/kaiser.hpp b/include/NumCpp/Functions/kaiser.hpp new file mode 100644 index 000000000..24e3b4cdd --- /dev/null +++ b/include/NumCpp/Functions/kaiser.hpp @@ -0,0 +1,47 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// The Kaiser window is a taper formed by using a Bessel function. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html + /// + /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @return NdArray + /// + // inline NdArray kaiser(int M) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/lcm.hpp b/include/NumCpp/Functions/lcm.hpp index 8e53ebf05..142a102bc 100644 --- a/include/NumCpp/Functions/lcm.hpp +++ b/include/NumCpp/Functions/lcm.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/ldexp.hpp b/include/NumCpp/Functions/ldexp.hpp index b048d74bd..ccf956b3e 100644 --- a/include/NumCpp/Functions/ldexp.hpp +++ b/include/NumCpp/Functions/ldexp.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/left_shift.hpp b/include/NumCpp/Functions/left_shift.hpp index c37c007eb..7587284e4 100644 --- a/include/NumCpp/Functions/left_shift.hpp +++ b/include/NumCpp/Functions/left_shift.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/less.hpp b/include/NumCpp/Functions/less.hpp index 10ae933ba..25beaeaf9 100644 --- a/include/NumCpp/Functions/less.hpp +++ b/include/NumCpp/Functions/less.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/less_equal.hpp b/include/NumCpp/Functions/less_equal.hpp index 19d412368..bf42ae25e 100644 --- a/include/NumCpp/Functions/less_equal.hpp +++ b/include/NumCpp/Functions/less_equal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/linspace.hpp b/include/NumCpp/Functions/linspace.hpp index d1f92f3c8..7aecb529b 100644 --- a/include/NumCpp/Functions/linspace.hpp +++ b/include/NumCpp/Functions/linspace.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/load.hpp b/include/NumCpp/Functions/load.hpp index c42a9adb4..e1d7e8464 100644 --- a/include/NumCpp/Functions/load.hpp +++ b/include/NumCpp/Functions/load.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/log.hpp b/include/NumCpp/Functions/log.hpp index deb1e0632..4011a0ef4 100644 --- a/include/NumCpp/Functions/log.hpp +++ b/include/NumCpp/Functions/log.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/log10.hpp b/include/NumCpp/Functions/log10.hpp index d5fedca3d..64e7d1256 100644 --- a/include/NumCpp/Functions/log10.hpp +++ b/include/NumCpp/Functions/log10.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/log1p.hpp b/include/NumCpp/Functions/log1p.hpp index 6d851ab75..75e25a198 100644 --- a/include/NumCpp/Functions/log1p.hpp +++ b/include/NumCpp/Functions/log1p.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/log2.hpp b/include/NumCpp/Functions/log2.hpp index 53b162c1a..e39273a31 100644 --- a/include/NumCpp/Functions/log2.hpp +++ b/include/NumCpp/Functions/log2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/logical_and.hpp b/include/NumCpp/Functions/logical_and.hpp index 5a47184d2..a22ae9849 100644 --- a/include/NumCpp/Functions/logical_and.hpp +++ b/include/NumCpp/Functions/logical_and.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/logical_not.hpp b/include/NumCpp/Functions/logical_not.hpp index f5d1367f9..ed596615c 100644 --- a/include/NumCpp/Functions/logical_not.hpp +++ b/include/NumCpp/Functions/logical_not.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/logical_or.hpp b/include/NumCpp/Functions/logical_or.hpp index 44ca39190..7b38621c6 100644 --- a/include/NumCpp/Functions/logical_or.hpp +++ b/include/NumCpp/Functions/logical_or.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/logical_xor.hpp b/include/NumCpp/Functions/logical_xor.hpp index ae37dd09b..021f7092a 100644 --- a/include/NumCpp/Functions/logical_xor.hpp +++ b/include/NumCpp/Functions/logical_xor.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/logspace.hpp b/include/NumCpp/Functions/logspace.hpp new file mode 100644 index 000000000..2bd3842b1 --- /dev/null +++ b/include/NumCpp/Functions/logspace.hpp @@ -0,0 +1,52 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return numbers spaced evenly on a log scale. + /// + /// This is similar to logspace, but with endpoints specified directly. + /// Each output sample is a constant multiple of the previous. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.logspace.html + /// + /// @param start: the starting value of a sequence + /// @param stop: The final value of the sequence, unless endpoint is False. + /// In that case, num + 1 values are spaced over the interval + /// in log-space, of which all but the last (a sequence of length num) are returned. + /// @param num: Number of samples to generate. Default 50. + /// @param enpoint: If true, stop is the last sample. Otherwide,it is not included. Default is true. + /// @return NdArray + /// + +} // namespace nc diff --git a/include/NumCpp/Functions/matmul.hpp b/include/NumCpp/Functions/matmul.hpp index 2bc15b874..c50316a4e 100644 --- a/include/NumCpp/Functions/matmul.hpp +++ b/include/NumCpp/Functions/matmul.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/max.hpp b/include/NumCpp/Functions/max.hpp index 5e5898d43..396dcb4b3 100644 --- a/include/NumCpp/Functions/max.hpp +++ b/include/NumCpp/Functions/max.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/maximum.hpp b/include/NumCpp/Functions/maximum.hpp index f64f2315e..ced7838b0 100644 --- a/include/NumCpp/Functions/maximum.hpp +++ b/include/NumCpp/Functions/maximum.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/mean.hpp b/include/NumCpp/Functions/mean.hpp index 70e373951..d34a9ea21 100644 --- a/include/NumCpp/Functions/mean.hpp +++ b/include/NumCpp/Functions/mean.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/median.hpp b/include/NumCpp/Functions/median.hpp index 31fe98ae3..8672fe0cc 100644 --- a/include/NumCpp/Functions/median.hpp +++ b/include/NumCpp/Functions/median.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/meshgrid.hpp b/include/NumCpp/Functions/meshgrid.hpp index 1e732aabf..90b673047 100644 --- a/include/NumCpp/Functions/meshgrid.hpp +++ b/include/NumCpp/Functions/meshgrid.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/min.hpp b/include/NumCpp/Functions/min.hpp index 757aeb193..ee9bb93bd 100644 --- a/include/NumCpp/Functions/min.hpp +++ b/include/NumCpp/Functions/min.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/minimum.hpp b/include/NumCpp/Functions/minimum.hpp index 3257408a4..e02c7f50b 100644 --- a/include/NumCpp/Functions/minimum.hpp +++ b/include/NumCpp/Functions/minimum.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/mod.hpp b/include/NumCpp/Functions/mod.hpp index 6e9cf3f8a..c3c1215ea 100644 --- a/include/NumCpp/Functions/mod.hpp +++ b/include/NumCpp/Functions/mod.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/multiply.hpp b/include/NumCpp/Functions/multiply.hpp index a34aaa04c..5e24f91ba 100644 --- a/include/NumCpp/Functions/multiply.hpp +++ b/include/NumCpp/Functions/multiply.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nan_to_num.hpp b/include/NumCpp/Functions/nan_to_num.hpp index ca3c0d5af..ae590ba8e 100644 --- a/include/NumCpp/Functions/nan_to_num.hpp +++ b/include/NumCpp/Functions/nan_to_num.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanargmax.hpp b/include/NumCpp/Functions/nanargmax.hpp index 568383b19..2c0380b10 100644 --- a/include/NumCpp/Functions/nanargmax.hpp +++ b/include/NumCpp/Functions/nanargmax.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanargmin.hpp b/include/NumCpp/Functions/nanargmin.hpp index 5ba46c9d3..e193855fc 100644 --- a/include/NumCpp/Functions/nanargmin.hpp +++ b/include/NumCpp/Functions/nanargmin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nancumprod.hpp b/include/NumCpp/Functions/nancumprod.hpp index 1a5321e9b..cefab6f66 100644 --- a/include/NumCpp/Functions/nancumprod.hpp +++ b/include/NumCpp/Functions/nancumprod.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nancumsum.hpp b/include/NumCpp/Functions/nancumsum.hpp index 7511de15f..9a7f84803 100644 --- a/include/NumCpp/Functions/nancumsum.hpp +++ b/include/NumCpp/Functions/nancumsum.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanmax.hpp b/include/NumCpp/Functions/nanmax.hpp index 4954e719f..9bd081da1 100644 --- a/include/NumCpp/Functions/nanmax.hpp +++ b/include/NumCpp/Functions/nanmax.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanmean.hpp b/include/NumCpp/Functions/nanmean.hpp index 4b1665357..406a0dd53 100644 --- a/include/NumCpp/Functions/nanmean.hpp +++ b/include/NumCpp/Functions/nanmean.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanmedian.hpp b/include/NumCpp/Functions/nanmedian.hpp index 655270211..6fc81bd7d 100644 --- a/include/NumCpp/Functions/nanmedian.hpp +++ b/include/NumCpp/Functions/nanmedian.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanmin.hpp b/include/NumCpp/Functions/nanmin.hpp index c184b2467..3be14451e 100644 --- a/include/NumCpp/Functions/nanmin.hpp +++ b/include/NumCpp/Functions/nanmin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanpercentile.hpp b/include/NumCpp/Functions/nanpercentile.hpp index 481beb99d..57142f9db 100644 --- a/include/NumCpp/Functions/nanpercentile.hpp +++ b/include/NumCpp/Functions/nanpercentile.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanprod.hpp b/include/NumCpp/Functions/nanprod.hpp index 1e353c491..08b784a5f 100644 --- a/include/NumCpp/Functions/nanprod.hpp +++ b/include/NumCpp/Functions/nanprod.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nans.hpp b/include/NumCpp/Functions/nans.hpp index 5def2072b..4ffd5435e 100644 --- a/include/NumCpp/Functions/nans.hpp +++ b/include/NumCpp/Functions/nans.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nans_like.hpp b/include/NumCpp/Functions/nans_like.hpp index 67847db8d..f62c28ae2 100644 --- a/include/NumCpp/Functions/nans_like.hpp +++ b/include/NumCpp/Functions/nans_like.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanstdev.hpp b/include/NumCpp/Functions/nanstdev.hpp index 46c7ed164..50a4183c9 100644 --- a/include/NumCpp/Functions/nanstdev.hpp +++ b/include/NumCpp/Functions/nanstdev.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nansum.hpp b/include/NumCpp/Functions/nansum.hpp index ffd893c1e..e2b585053 100644 --- a/include/NumCpp/Functions/nansum.hpp +++ b/include/NumCpp/Functions/nansum.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nanvar.hpp b/include/NumCpp/Functions/nanvar.hpp index d08ed60a9..a00ddab31 100644 --- a/include/NumCpp/Functions/nanvar.hpp +++ b/include/NumCpp/Functions/nanvar.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nbytes.hpp b/include/NumCpp/Functions/nbytes.hpp index 601b5b1a4..6ef670521 100644 --- a/include/NumCpp/Functions/nbytes.hpp +++ b/include/NumCpp/Functions/nbytes.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/negative.hpp b/include/NumCpp/Functions/negative.hpp index 3a209c30e..6b358ef75 100644 --- a/include/NumCpp/Functions/negative.hpp +++ b/include/NumCpp/Functions/negative.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/newbyteorder.hpp b/include/NumCpp/Functions/newbyteorder.hpp index 334a2d463..f7820243c 100644 --- a/include/NumCpp/Functions/newbyteorder.hpp +++ b/include/NumCpp/Functions/newbyteorder.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/none.hpp b/include/NumCpp/Functions/none.hpp index 2d94ebd4e..ada03cafe 100644 --- a/include/NumCpp/Functions/none.hpp +++ b/include/NumCpp/Functions/none.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/nonzero.hpp b/include/NumCpp/Functions/nonzero.hpp index 981561127..d101625cb 100644 --- a/include/NumCpp/Functions/nonzero.hpp +++ b/include/NumCpp/Functions/nonzero.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/norm.hpp b/include/NumCpp/Functions/norm.hpp index d738f7ed9..b834e814f 100644 --- a/include/NumCpp/Functions/norm.hpp +++ b/include/NumCpp/Functions/norm.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/not_equal.hpp b/include/NumCpp/Functions/not_equal.hpp index d82d409db..70ebb5572 100644 --- a/include/NumCpp/Functions/not_equal.hpp +++ b/include/NumCpp/Functions/not_equal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/ones.hpp b/include/NumCpp/Functions/ones.hpp index 6d8deb562..3ccaf41bc 100644 --- a/include/NumCpp/Functions/ones.hpp +++ b/include/NumCpp/Functions/ones.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/ones_like.hpp b/include/NumCpp/Functions/ones_like.hpp index f3aeb2cb0..f7e4a1e60 100644 --- a/include/NumCpp/Functions/ones_like.hpp +++ b/include/NumCpp/Functions/ones_like.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/outer.hpp b/include/NumCpp/Functions/outer.hpp index f8e640fe5..8f19ebd1c 100644 --- a/include/NumCpp/Functions/outer.hpp +++ b/include/NumCpp/Functions/outer.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/pad.hpp b/include/NumCpp/Functions/pad.hpp index 23a0532b0..def7ca38d 100644 --- a/include/NumCpp/Functions/pad.hpp +++ b/include/NumCpp/Functions/pad.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/partition.hpp b/include/NumCpp/Functions/partition.hpp index 5dd3a4266..810cf4002 100644 --- a/include/NumCpp/Functions/partition.hpp +++ b/include/NumCpp/Functions/partition.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/percentile.hpp b/include/NumCpp/Functions/percentile.hpp index 49186df32..1cfbc619a 100644 --- a/include/NumCpp/Functions/percentile.hpp +++ b/include/NumCpp/Functions/percentile.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/place.hpp b/include/NumCpp/Functions/place.hpp new file mode 100644 index 000000000..2abb6260f --- /dev/null +++ b/include/NumCpp/Functions/place.hpp @@ -0,0 +1,52 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Change elements of an array based on conditional and input values. + /// + /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.place.html + /// + /// @param arr: Array to put data into. + /// @param mask: Boolean mask array. Must have the same size as arr + /// @param vals: Values to put into a. Only the first N elements are used, where N is the + /// number of True values in mask. If vals is smaller than N, it will be repeated, + /// and if elements of a are to be masked, this sequence must be non-empty. + /// @return NdArray + /// + // template + // NdArray place(const NdArray& arr, const NdArray& mask, const NdArray vals) + // { + + // } +} // namespace nc diff --git a/include/NumCpp/Functions/polar.hpp b/include/NumCpp/Functions/polar.hpp index 1ceca21d0..de1d114cd 100644 --- a/include/NumCpp/Functions/polar.hpp +++ b/include/NumCpp/Functions/polar.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/power.hpp b/include/NumCpp/Functions/power.hpp index e1659e4c6..dd6fa97fb 100644 --- a/include/NumCpp/Functions/power.hpp +++ b/include/NumCpp/Functions/power.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/powerf.hpp b/include/NumCpp/Functions/powerf.hpp index 8c59b50b6..f81241e7c 100644 --- a/include/NumCpp/Functions/powerf.hpp +++ b/include/NumCpp/Functions/powerf.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/print.hpp b/include/NumCpp/Functions/print.hpp index 23bdbe183..ef1e5069b 100644 --- a/include/NumCpp/Functions/print.hpp +++ b/include/NumCpp/Functions/print.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/prod.hpp b/include/NumCpp/Functions/prod.hpp index d1b3465a4..fbceaa635 100644 --- a/include/NumCpp/Functions/prod.hpp +++ b/include/NumCpp/Functions/prod.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/proj.hpp b/include/NumCpp/Functions/proj.hpp index f077e65b5..b87d67678 100644 --- a/include/NumCpp/Functions/proj.hpp +++ b/include/NumCpp/Functions/proj.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/ptp.hpp b/include/NumCpp/Functions/ptp.hpp index 3dd266e72..ffef33fd4 100644 --- a/include/NumCpp/Functions/ptp.hpp +++ b/include/NumCpp/Functions/ptp.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/put.hpp b/include/NumCpp/Functions/put.hpp index 15c82ff95..f4df240f4 100644 --- a/include/NumCpp/Functions/put.hpp +++ b/include/NumCpp/Functions/put.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/putmask.hpp b/include/NumCpp/Functions/putmask.hpp index 4cda073ab..7daa95212 100644 --- a/include/NumCpp/Functions/putmask.hpp +++ b/include/NumCpp/Functions/putmask.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/rad2deg.hpp b/include/NumCpp/Functions/rad2deg.hpp index f4bd07d40..36b1736c8 100644 --- a/include/NumCpp/Functions/rad2deg.hpp +++ b/include/NumCpp/Functions/rad2deg.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/radians.hpp b/include/NumCpp/Functions/radians.hpp index 2efe5041d..37b371db0 100644 --- a/include/NumCpp/Functions/radians.hpp +++ b/include/NumCpp/Functions/radians.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/ravel.hpp b/include/NumCpp/Functions/ravel.hpp index c98a10e32..657ccb8c7 100644 --- a/include/NumCpp/Functions/ravel.hpp +++ b/include/NumCpp/Functions/ravel.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/real.hpp b/include/NumCpp/Functions/real.hpp index 3d86d8555..77da94ad6 100644 --- a/include/NumCpp/Functions/real.hpp +++ b/include/NumCpp/Functions/real.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/reciprocal.hpp b/include/NumCpp/Functions/reciprocal.hpp index c6f2cd9f8..ec1e3835b 100644 --- a/include/NumCpp/Functions/reciprocal.hpp +++ b/include/NumCpp/Functions/reciprocal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/remainder.hpp b/include/NumCpp/Functions/remainder.hpp index 5dd0a646e..d099aa06c 100644 --- a/include/NumCpp/Functions/remainder.hpp +++ b/include/NumCpp/Functions/remainder.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/repeat.hpp b/include/NumCpp/Functions/repeat.hpp index 7dac118df..d573173c3 100644 --- a/include/NumCpp/Functions/repeat.hpp +++ b/include/NumCpp/Functions/repeat.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/replace.hpp b/include/NumCpp/Functions/replace.hpp index ee6fe91e4..f13f593aa 100644 --- a/include/NumCpp/Functions/replace.hpp +++ b/include/NumCpp/Functions/replace.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/reshape.hpp b/include/NumCpp/Functions/reshape.hpp index 9cfc01b6f..6fe456b7c 100644 --- a/include/NumCpp/Functions/reshape.hpp +++ b/include/NumCpp/Functions/reshape.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/resizeFast.hpp b/include/NumCpp/Functions/resizeFast.hpp index 6cc01b13f..3b36e64a6 100644 --- a/include/NumCpp/Functions/resizeFast.hpp +++ b/include/NumCpp/Functions/resizeFast.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/resizeSlow.hpp b/include/NumCpp/Functions/resizeSlow.hpp index 7edc6950a..5d6dcd4f0 100644 --- a/include/NumCpp/Functions/resizeSlow.hpp +++ b/include/NumCpp/Functions/resizeSlow.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/right_shift.hpp b/include/NumCpp/Functions/right_shift.hpp index aa81f2429..c7f99230c 100644 --- a/include/NumCpp/Functions/right_shift.hpp +++ b/include/NumCpp/Functions/right_shift.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/rint.hpp b/include/NumCpp/Functions/rint.hpp index 0700f9535..7c7f7e3b3 100644 --- a/include/NumCpp/Functions/rint.hpp +++ b/include/NumCpp/Functions/rint.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/rms.hpp b/include/NumCpp/Functions/rms.hpp index d5ab50b96..a04aeda85 100644 --- a/include/NumCpp/Functions/rms.hpp +++ b/include/NumCpp/Functions/rms.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/roll.hpp b/include/NumCpp/Functions/roll.hpp index 8af8518fe..3fc54510a 100644 --- a/include/NumCpp/Functions/roll.hpp +++ b/include/NumCpp/Functions/roll.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/rot90.hpp b/include/NumCpp/Functions/rot90.hpp index 06060d00c..19d630a6b 100644 --- a/include/NumCpp/Functions/rot90.hpp +++ b/include/NumCpp/Functions/rot90.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/round.hpp b/include/NumCpp/Functions/round.hpp index f7c068b49..c5f9c200b 100644 --- a/include/NumCpp/Functions/round.hpp +++ b/include/NumCpp/Functions/round.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/row_stack.hpp b/include/NumCpp/Functions/row_stack.hpp index 429a67e5d..ee32cd306 100644 --- a/include/NumCpp/Functions/row_stack.hpp +++ b/include/NumCpp/Functions/row_stack.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/select.hpp b/include/NumCpp/Functions/select.hpp index 8a48f9d6a..75e5de017 100644 --- a/include/NumCpp/Functions/select.hpp +++ b/include/NumCpp/Functions/select.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/setdiff1d.hpp b/include/NumCpp/Functions/setdiff1d.hpp index 20b4213dc..3d03ed177 100644 --- a/include/NumCpp/Functions/setdiff1d.hpp +++ b/include/NumCpp/Functions/setdiff1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/shape.hpp b/include/NumCpp/Functions/shape.hpp index 0b182ea91..5ad62a01b 100644 --- a/include/NumCpp/Functions/shape.hpp +++ b/include/NumCpp/Functions/shape.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sign.hpp b/include/NumCpp/Functions/sign.hpp index 13025a8d3..ad5fcad68 100644 --- a/include/NumCpp/Functions/sign.hpp +++ b/include/NumCpp/Functions/sign.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/signbit.hpp b/include/NumCpp/Functions/signbit.hpp index 994ddbe2c..a2e5220d0 100644 --- a/include/NumCpp/Functions/signbit.hpp +++ b/include/NumCpp/Functions/signbit.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sin.hpp b/include/NumCpp/Functions/sin.hpp index f88e633a9..8f89183b8 100644 --- a/include/NumCpp/Functions/sin.hpp +++ b/include/NumCpp/Functions/sin.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sinc.hpp b/include/NumCpp/Functions/sinc.hpp index 3241986e3..be3a77cd8 100644 --- a/include/NumCpp/Functions/sinc.hpp +++ b/include/NumCpp/Functions/sinc.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sinh.hpp b/include/NumCpp/Functions/sinh.hpp index cd66dece8..ac878c26e 100644 --- a/include/NumCpp/Functions/sinh.hpp +++ b/include/NumCpp/Functions/sinh.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/size.hpp b/include/NumCpp/Functions/size.hpp index da12b362b..96006aede 100644 --- a/include/NumCpp/Functions/size.hpp +++ b/include/NumCpp/Functions/size.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sort.hpp b/include/NumCpp/Functions/sort.hpp index 89f524b70..fe48d2dcf 100644 --- a/include/NumCpp/Functions/sort.hpp +++ b/include/NumCpp/Functions/sort.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sqrt.hpp b/include/NumCpp/Functions/sqrt.hpp index 42d240eec..7b31bb2e9 100644 --- a/include/NumCpp/Functions/sqrt.hpp +++ b/include/NumCpp/Functions/sqrt.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/square.hpp b/include/NumCpp/Functions/square.hpp index 0548ddd18..fa14b1571 100644 --- a/include/NumCpp/Functions/square.hpp +++ b/include/NumCpp/Functions/square.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/stack.hpp b/include/NumCpp/Functions/stack.hpp index d7048ed3b..45d1af6bd 100644 --- a/include/NumCpp/Functions/stack.hpp +++ b/include/NumCpp/Functions/stack.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/stdev.hpp b/include/NumCpp/Functions/stdev.hpp index 3172fc18c..9b9713dfe 100644 --- a/include/NumCpp/Functions/stdev.hpp +++ b/include/NumCpp/Functions/stdev.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/subtract.hpp b/include/NumCpp/Functions/subtract.hpp index e0df81aaf..4b5fa3d6b 100644 --- a/include/NumCpp/Functions/subtract.hpp +++ b/include/NumCpp/Functions/subtract.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/sum.hpp b/include/NumCpp/Functions/sum.hpp index 8b9999eee..63ae8fd6b 100644 --- a/include/NumCpp/Functions/sum.hpp +++ b/include/NumCpp/Functions/sum.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/swap.hpp b/include/NumCpp/Functions/swap.hpp index 08c608db8..a827d2fd8 100644 --- a/include/NumCpp/Functions/swap.hpp +++ b/include/NumCpp/Functions/swap.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/swapaxes.hpp b/include/NumCpp/Functions/swapaxes.hpp index 79e8dd6fc..5f085c414 100644 --- a/include/NumCpp/Functions/swapaxes.hpp +++ b/include/NumCpp/Functions/swapaxes.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/tan.hpp b/include/NumCpp/Functions/tan.hpp index 0cd35b06a..4cb382b8b 100644 --- a/include/NumCpp/Functions/tan.hpp +++ b/include/NumCpp/Functions/tan.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/tanh.hpp b/include/NumCpp/Functions/tanh.hpp index 53e985c33..7f2b5a96a 100644 --- a/include/NumCpp/Functions/tanh.hpp +++ b/include/NumCpp/Functions/tanh.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/tile.hpp b/include/NumCpp/Functions/tile.hpp index 7c528cf75..a546c6636 100644 --- a/include/NumCpp/Functions/tile.hpp +++ b/include/NumCpp/Functions/tile.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/toStlVector.hpp b/include/NumCpp/Functions/toStlVector.hpp index f526bd790..c056cd220 100644 --- a/include/NumCpp/Functions/toStlVector.hpp +++ b/include/NumCpp/Functions/toStlVector.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/tofile.hpp b/include/NumCpp/Functions/tofile.hpp index 8ef62bbff..979ce4635 100644 --- a/include/NumCpp/Functions/tofile.hpp +++ b/include/NumCpp/Functions/tofile.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/trace.hpp b/include/NumCpp/Functions/trace.hpp index 5d2130406..92fb69434 100644 --- a/include/NumCpp/Functions/trace.hpp +++ b/include/NumCpp/Functions/trace.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/transpose.hpp b/include/NumCpp/Functions/transpose.hpp index 14b13f338..3cc2fe96f 100644 --- a/include/NumCpp/Functions/transpose.hpp +++ b/include/NumCpp/Functions/transpose.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/trapz.hpp b/include/NumCpp/Functions/trapz.hpp index 914d48cf8..5262e16a8 100644 --- a/include/NumCpp/Functions/trapz.hpp +++ b/include/NumCpp/Functions/trapz.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/tri.hpp b/include/NumCpp/Functions/tri.hpp index 3f3c34799..86383755a 100644 --- a/include/NumCpp/Functions/tri.hpp +++ b/include/NumCpp/Functions/tri.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/trim_zeros.hpp b/include/NumCpp/Functions/trim_zeros.hpp index 959513ce8..732e3af32 100644 --- a/include/NumCpp/Functions/trim_zeros.hpp +++ b/include/NumCpp/Functions/trim_zeros.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/trunc.hpp b/include/NumCpp/Functions/trunc.hpp index 27d110b04..023a0b32d 100644 --- a/include/NumCpp/Functions/trunc.hpp +++ b/include/NumCpp/Functions/trunc.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/union1d.hpp b/include/NumCpp/Functions/union1d.hpp index 0d9d5f5b9..e5748a2ac 100644 --- a/include/NumCpp/Functions/union1d.hpp +++ b/include/NumCpp/Functions/union1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/unique.hpp b/include/NumCpp/Functions/unique.hpp index 131576f7a..ba9129779 100644 --- a/include/NumCpp/Functions/unique.hpp +++ b/include/NumCpp/Functions/unique.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/unwrap.hpp b/include/NumCpp/Functions/unwrap.hpp index a6d95b414..ad2a92627 100644 --- a/include/NumCpp/Functions/unwrap.hpp +++ b/include/NumCpp/Functions/unwrap.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/var.hpp b/include/NumCpp/Functions/var.hpp index e54f74e0d..f46d8d69a 100644 --- a/include/NumCpp/Functions/var.hpp +++ b/include/NumCpp/Functions/var.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/vstack.hpp b/include/NumCpp/Functions/vstack.hpp index 2cbef6900..aeafb2db8 100644 --- a/include/NumCpp/Functions/vstack.hpp +++ b/include/NumCpp/Functions/vstack.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/where.hpp b/include/NumCpp/Functions/where.hpp index 7bdb72a87..a6edcea38 100644 --- a/include/NumCpp/Functions/where.hpp +++ b/include/NumCpp/Functions/where.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/zeros.hpp b/include/NumCpp/Functions/zeros.hpp index f97b5f040..99c300103 100644 --- a/include/NumCpp/Functions/zeros.hpp +++ b/include/NumCpp/Functions/zeros.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Functions/zeros_like.hpp b/include/NumCpp/Functions/zeros_like.hpp index 02cd244ef..2f9830f00 100644 --- a/include/NumCpp/Functions/zeros_like.hpp +++ b/include/NumCpp/Functions/zeros_like.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing.hpp b/include/NumCpp/ImageProcessing.hpp index 16d9b6a14..b505b9bee 100644 --- a/include/NumCpp/ImageProcessing.hpp +++ b/include/NumCpp/ImageProcessing.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/Centroid.hpp b/include/NumCpp/ImageProcessing/Centroid.hpp index cf62f2a52..09f4ca066 100644 --- a/include/NumCpp/ImageProcessing/Centroid.hpp +++ b/include/NumCpp/ImageProcessing/Centroid.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/Cluster.hpp b/include/NumCpp/ImageProcessing/Cluster.hpp index 4c2e744b1..217cf9d4c 100644 --- a/include/NumCpp/ImageProcessing/Cluster.hpp +++ b/include/NumCpp/ImageProcessing/Cluster.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/ClusterMaker.hpp b/include/NumCpp/ImageProcessing/ClusterMaker.hpp index 383122e40..804643d13 100644 --- a/include/NumCpp/ImageProcessing/ClusterMaker.hpp +++ b/include/NumCpp/ImageProcessing/ClusterMaker.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/Pixel.hpp b/include/NumCpp/ImageProcessing/Pixel.hpp index 41ed16b5a..f61f72c91 100644 --- a/include/NumCpp/ImageProcessing/Pixel.hpp +++ b/include/NumCpp/ImageProcessing/Pixel.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/applyThreshold.hpp b/include/NumCpp/ImageProcessing/applyThreshold.hpp index 5db3dc1c9..e4faab701 100644 --- a/include/NumCpp/ImageProcessing/applyThreshold.hpp +++ b/include/NumCpp/ImageProcessing/applyThreshold.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/centroidClusters.hpp b/include/NumCpp/ImageProcessing/centroidClusters.hpp index 624681061..3ba6768f3 100644 --- a/include/NumCpp/ImageProcessing/centroidClusters.hpp +++ b/include/NumCpp/ImageProcessing/centroidClusters.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/clusterPixels.hpp b/include/NumCpp/ImageProcessing/clusterPixels.hpp index b4299817a..b532ac500 100644 --- a/include/NumCpp/ImageProcessing/clusterPixels.hpp +++ b/include/NumCpp/ImageProcessing/clusterPixels.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/generateCentroids.hpp b/include/NumCpp/ImageProcessing/generateCentroids.hpp index d5ddf86a4..92229f4a9 100644 --- a/include/NumCpp/ImageProcessing/generateCentroids.hpp +++ b/include/NumCpp/ImageProcessing/generateCentroids.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/generateThreshold.hpp b/include/NumCpp/ImageProcessing/generateThreshold.hpp index 797f367a3..f3a9246b8 100644 --- a/include/NumCpp/ImageProcessing/generateThreshold.hpp +++ b/include/NumCpp/ImageProcessing/generateThreshold.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/ImageProcessing/windowExceedances.hpp b/include/NumCpp/ImageProcessing/windowExceedances.hpp index ee4b61c81..06027865f 100644 --- a/include/NumCpp/ImageProcessing/windowExceedances.hpp +++ b/include/NumCpp/ImageProcessing/windowExceedances.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Integrate.hpp b/include/NumCpp/Integrate.hpp index 05a536a1b..09046dce6 100644 --- a/include/NumCpp/Integrate.hpp +++ b/include/NumCpp/Integrate.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Integrate/gauss_legendre.hpp b/include/NumCpp/Integrate/gauss_legendre.hpp index 981a8e4f0..75e88f6dd 100644 --- a/include/NumCpp/Integrate/gauss_legendre.hpp +++ b/include/NumCpp/Integrate/gauss_legendre.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Integrate/romberg.hpp b/include/NumCpp/Integrate/romberg.hpp index 44cd4d631..2dc41d7ec 100644 --- a/include/NumCpp/Integrate/romberg.hpp +++ b/include/NumCpp/Integrate/romberg.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Integrate/simpson.hpp b/include/NumCpp/Integrate/simpson.hpp index 44bb2e265..988025ce5 100644 --- a/include/NumCpp/Integrate/simpson.hpp +++ b/include/NumCpp/Integrate/simpson.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Integrate/trapazoidal.hpp b/include/NumCpp/Integrate/trapazoidal.hpp index 10661d2d0..4f047f423 100644 --- a/include/NumCpp/Integrate/trapazoidal.hpp +++ b/include/NumCpp/Integrate/trapazoidal.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg.hpp b/include/NumCpp/Linalg.hpp index 5234d5ab0..2edef94fe 100644 --- a/include/NumCpp/Linalg.hpp +++ b/include/NumCpp/Linalg.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/cholesky.hpp b/include/NumCpp/Linalg/cholesky.hpp index 55bf9a455..377f54723 100644 --- a/include/NumCpp/Linalg/cholesky.hpp +++ b/include/NumCpp/Linalg/cholesky.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/det.hpp b/include/NumCpp/Linalg/det.hpp index f1562d4d6..d0bba4ef5 100644 --- a/include/NumCpp/Linalg/det.hpp +++ b/include/NumCpp/Linalg/det.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/gaussNewtonNlls.hpp b/include/NumCpp/Linalg/gaussNewtonNlls.hpp index 5b665c2bf..f42b9e65c 100644 --- a/include/NumCpp/Linalg/gaussNewtonNlls.hpp +++ b/include/NumCpp/Linalg/gaussNewtonNlls.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/hat.hpp b/include/NumCpp/Linalg/hat.hpp index ebb387d8f..a9d4a711d 100644 --- a/include/NumCpp/Linalg/hat.hpp +++ b/include/NumCpp/Linalg/hat.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/inv.hpp b/include/NumCpp/Linalg/inv.hpp index 00f6aa488..2a1e124de 100644 --- a/include/NumCpp/Linalg/inv.hpp +++ b/include/NumCpp/Linalg/inv.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/lstsq.hpp b/include/NumCpp/Linalg/lstsq.hpp index d0d03b553..c9ad74a7f 100644 --- a/include/NumCpp/Linalg/lstsq.hpp +++ b/include/NumCpp/Linalg/lstsq.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/lu_decomposition.hpp b/include/NumCpp/Linalg/lu_decomposition.hpp index 44e2b0296..f9413ec6a 100644 --- a/include/NumCpp/Linalg/lu_decomposition.hpp +++ b/include/NumCpp/Linalg/lu_decomposition.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/matrix_power.hpp b/include/NumCpp/Linalg/matrix_power.hpp index 9bba6387f..345f81fd3 100644 --- a/include/NumCpp/Linalg/matrix_power.hpp +++ b/include/NumCpp/Linalg/matrix_power.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/multi_dot.hpp b/include/NumCpp/Linalg/multi_dot.hpp index 760f77f46..8b45c3543 100644 --- a/include/NumCpp/Linalg/multi_dot.hpp +++ b/include/NumCpp/Linalg/multi_dot.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/pivotLU_decomposition.hpp b/include/NumCpp/Linalg/pivotLU_decomposition.hpp index e077b0990..2b58d9c47 100644 --- a/include/NumCpp/Linalg/pivotLU_decomposition.hpp +++ b/include/NumCpp/Linalg/pivotLU_decomposition.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/solve.hpp b/include/NumCpp/Linalg/solve.hpp index cff9502aa..ee2a2077e 100644 --- a/include/NumCpp/Linalg/solve.hpp +++ b/include/NumCpp/Linalg/solve.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Linalg/svd.hpp b/include/NumCpp/Linalg/svd.hpp index 765849899..1c5835f10 100644 --- a/include/NumCpp/Linalg/svd.hpp +++ b/include/NumCpp/Linalg/svd.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/NdArray.hpp b/include/NumCpp/NdArray.hpp index b22c54478..d53eb2b8c 100644 --- a/include/NumCpp/NdArray.hpp +++ b/include/NumCpp/NdArray.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index 6301432da..384e6edb3 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/NdArray/NdArrayIterators.hpp b/include/NumCpp/NdArray/NdArrayIterators.hpp index ac4c94956..017ad0b52 100644 --- a/include/NumCpp/NdArray/NdArrayIterators.hpp +++ b/include/NumCpp/NdArray/NdArrayIterators.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/NdArray/NdArrayOperators.hpp b/include/NumCpp/NdArray/NdArrayOperators.hpp index 27fc73500..e55040c78 100644 --- a/include/NumCpp/NdArray/NdArrayOperators.hpp +++ b/include/NumCpp/NdArray/NdArrayOperators.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial.hpp b/include/NumCpp/Polynomial.hpp index 58c64ba6b..af0b2d649 100644 --- a/include/NumCpp/Polynomial.hpp +++ b/include/NumCpp/Polynomial.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/Poly1d.hpp b/include/NumCpp/Polynomial/Poly1d.hpp index 1abb66478..316275a7f 100644 --- a/include/NumCpp/Polynomial/Poly1d.hpp +++ b/include/NumCpp/Polynomial/Poly1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/chebyshev_t.hpp b/include/NumCpp/Polynomial/chebyshev_t.hpp index b2e652c52..8b5e778d5 100644 --- a/include/NumCpp/Polynomial/chebyshev_t.hpp +++ b/include/NumCpp/Polynomial/chebyshev_t.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/chebyshev_u.hpp b/include/NumCpp/Polynomial/chebyshev_u.hpp index 855006dac..3b4509fb8 100644 --- a/include/NumCpp/Polynomial/chebyshev_u.hpp +++ b/include/NumCpp/Polynomial/chebyshev_u.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/hermite.hpp b/include/NumCpp/Polynomial/hermite.hpp index 8f618b92c..2f99bcdbc 100644 --- a/include/NumCpp/Polynomial/hermite.hpp +++ b/include/NumCpp/Polynomial/hermite.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/laguerre.hpp b/include/NumCpp/Polynomial/laguerre.hpp index 0abba1cd3..3e03643d5 100644 --- a/include/NumCpp/Polynomial/laguerre.hpp +++ b/include/NumCpp/Polynomial/laguerre.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/legendre_p.hpp b/include/NumCpp/Polynomial/legendre_p.hpp index f10dd108a..0836ef6f3 100644 --- a/include/NumCpp/Polynomial/legendre_p.hpp +++ b/include/NumCpp/Polynomial/legendre_p.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/legendre_q.hpp b/include/NumCpp/Polynomial/legendre_q.hpp index 91655183d..2cd086600 100644 --- a/include/NumCpp/Polynomial/legendre_q.hpp +++ b/include/NumCpp/Polynomial/legendre_q.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Polynomial/spherical_harmonic.hpp b/include/NumCpp/Polynomial/spherical_harmonic.hpp index cfb37c5ba..dbf57d8aa 100644 --- a/include/NumCpp/Polynomial/spherical_harmonic.hpp +++ b/include/NumCpp/Polynomial/spherical_harmonic.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/PythonInterface.hpp b/include/NumCpp/PythonInterface.hpp index 2d0292947..f4370c8e7 100644 --- a/include/NumCpp/PythonInterface.hpp +++ b/include/NumCpp/PythonInterface.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/PythonInterface/BoostInterface.hpp b/include/NumCpp/PythonInterface/BoostInterface.hpp index 10a05e907..8b51fe1e7 100644 --- a/include/NumCpp/PythonInterface/BoostInterface.hpp +++ b/include/NumCpp/PythonInterface/BoostInterface.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp b/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp index 558681243..cda131117 100644 --- a/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp +++ b/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/PythonInterface/PybindInterface.hpp b/include/NumCpp/PythonInterface/PybindInterface.hpp index 9ad7fc3a3..63a9edc2b 100644 --- a/include/NumCpp/PythonInterface/PybindInterface.hpp +++ b/include/NumCpp/PythonInterface/PybindInterface.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random.hpp b/include/NumCpp/Random.hpp index 2e8277c58..b5d1511ff 100644 --- a/include/NumCpp/Random.hpp +++ b/include/NumCpp/Random.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/bernoilli.hpp b/include/NumCpp/Random/bernoilli.hpp index 1a96c9149..2a482d28e 100644 --- a/include/NumCpp/Random/bernoilli.hpp +++ b/include/NumCpp/Random/bernoilli.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/beta.hpp b/include/NumCpp/Random/beta.hpp index 226c4473b..fb6bb68fb 100644 --- a/include/NumCpp/Random/beta.hpp +++ b/include/NumCpp/Random/beta.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/binomial.hpp b/include/NumCpp/Random/binomial.hpp index 64771aee7..08a996bb5 100644 --- a/include/NumCpp/Random/binomial.hpp +++ b/include/NumCpp/Random/binomial.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/cauchy.hpp b/include/NumCpp/Random/cauchy.hpp index d88a737aa..3c83c38ae 100644 --- a/include/NumCpp/Random/cauchy.hpp +++ b/include/NumCpp/Random/cauchy.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/chiSquare.hpp b/include/NumCpp/Random/chiSquare.hpp index f9189b320..d4ff74e8d 100644 --- a/include/NumCpp/Random/chiSquare.hpp +++ b/include/NumCpp/Random/chiSquare.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/choice.hpp b/include/NumCpp/Random/choice.hpp index 26bf34333..c9561549d 100644 --- a/include/NumCpp/Random/choice.hpp +++ b/include/NumCpp/Random/choice.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/discrete.hpp b/include/NumCpp/Random/discrete.hpp index 0c6a2c3a6..74971cc69 100644 --- a/include/NumCpp/Random/discrete.hpp +++ b/include/NumCpp/Random/discrete.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/exponential.hpp b/include/NumCpp/Random/exponential.hpp index 402bce42b..845c9c207 100644 --- a/include/NumCpp/Random/exponential.hpp +++ b/include/NumCpp/Random/exponential.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/extremeValue.hpp b/include/NumCpp/Random/extremeValue.hpp index 5e40d7a3b..cf07bbc98 100644 --- a/include/NumCpp/Random/extremeValue.hpp +++ b/include/NumCpp/Random/extremeValue.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/f.hpp b/include/NumCpp/Random/f.hpp index d3bcd6ac5..df8f6f333 100644 --- a/include/NumCpp/Random/f.hpp +++ b/include/NumCpp/Random/f.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/gamma.hpp b/include/NumCpp/Random/gamma.hpp index 9272882eb..f665165a0 100644 --- a/include/NumCpp/Random/gamma.hpp +++ b/include/NumCpp/Random/gamma.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/generator.hpp b/include/NumCpp/Random/generator.hpp index fedf766d1..971ea05d1 100644 --- a/include/NumCpp/Random/generator.hpp +++ b/include/NumCpp/Random/generator.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/geometric.hpp b/include/NumCpp/Random/geometric.hpp index ffa85561f..3af486f4f 100644 --- a/include/NumCpp/Random/geometric.hpp +++ b/include/NumCpp/Random/geometric.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/laplace.hpp b/include/NumCpp/Random/laplace.hpp index a620be57a..bbbb7abf2 100644 --- a/include/NumCpp/Random/laplace.hpp +++ b/include/NumCpp/Random/laplace.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/lognormal.hpp b/include/NumCpp/Random/lognormal.hpp index 5e703efb7..a75fef2f3 100644 --- a/include/NumCpp/Random/lognormal.hpp +++ b/include/NumCpp/Random/lognormal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/negativeBinomial.hpp b/include/NumCpp/Random/negativeBinomial.hpp index d991c123a..e9c65cac5 100644 --- a/include/NumCpp/Random/negativeBinomial.hpp +++ b/include/NumCpp/Random/negativeBinomial.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/nonCentralChiSquared.hpp b/include/NumCpp/Random/nonCentralChiSquared.hpp index e08ae442d..16ec7e68e 100644 --- a/include/NumCpp/Random/nonCentralChiSquared.hpp +++ b/include/NumCpp/Random/nonCentralChiSquared.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/normal.hpp b/include/NumCpp/Random/normal.hpp index 579207e44..d924567dd 100644 --- a/include/NumCpp/Random/normal.hpp +++ b/include/NumCpp/Random/normal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/permutation.hpp b/include/NumCpp/Random/permutation.hpp index 678130fdf..4c7b4a4e0 100644 --- a/include/NumCpp/Random/permutation.hpp +++ b/include/NumCpp/Random/permutation.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/poisson.hpp b/include/NumCpp/Random/poisson.hpp index bca93c22a..d92872795 100644 --- a/include/NumCpp/Random/poisson.hpp +++ b/include/NumCpp/Random/poisson.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/rand.hpp b/include/NumCpp/Random/rand.hpp index 08edcc32e..cb6eb5397 100644 --- a/include/NumCpp/Random/rand.hpp +++ b/include/NumCpp/Random/rand.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/randFloat.hpp b/include/NumCpp/Random/randFloat.hpp index 76a311f1b..741fcb7f9 100644 --- a/include/NumCpp/Random/randFloat.hpp +++ b/include/NumCpp/Random/randFloat.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/randInt.hpp b/include/NumCpp/Random/randInt.hpp index 329a1c1e3..7d80cd34c 100644 --- a/include/NumCpp/Random/randInt.hpp +++ b/include/NumCpp/Random/randInt.hpp @@ -4,7 +4,7 @@ /// @version 1.1 /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/randN.hpp b/include/NumCpp/Random/randN.hpp index 04ccd10b5..2920e6d65 100644 --- a/include/NumCpp/Random/randN.hpp +++ b/include/NumCpp/Random/randN.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/shuffle.hpp b/include/NumCpp/Random/shuffle.hpp index f3a5f84ef..9ef259d9a 100644 --- a/include/NumCpp/Random/shuffle.hpp +++ b/include/NumCpp/Random/shuffle.hpp @@ -4,7 +4,7 @@ /// @version 1.1 /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/standardNormal.hpp b/include/NumCpp/Random/standardNormal.hpp index f17b9fbc8..05b409fb4 100644 --- a/include/NumCpp/Random/standardNormal.hpp +++ b/include/NumCpp/Random/standardNormal.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/studentT.hpp b/include/NumCpp/Random/studentT.hpp index 3f0443f9b..66744bb16 100644 --- a/include/NumCpp/Random/studentT.hpp +++ b/include/NumCpp/Random/studentT.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/triangle.hpp b/include/NumCpp/Random/triangle.hpp index 5e4394e6f..5c7e152c7 100644 --- a/include/NumCpp/Random/triangle.hpp +++ b/include/NumCpp/Random/triangle.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/uniform.hpp b/include/NumCpp/Random/uniform.hpp index d1079ab48..00787ad37 100644 --- a/include/NumCpp/Random/uniform.hpp +++ b/include/NumCpp/Random/uniform.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/uniformOnSphere.hpp b/include/NumCpp/Random/uniformOnSphere.hpp index f7e79d791..d6167c65b 100644 --- a/include/NumCpp/Random/uniformOnSphere.hpp +++ b/include/NumCpp/Random/uniformOnSphere.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Random/weibull.hpp b/include/NumCpp/Random/weibull.hpp index 18ad76836..c6d341cbc 100644 --- a/include/NumCpp/Random/weibull.hpp +++ b/include/NumCpp/Random/weibull.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots.hpp b/include/NumCpp/Roots.hpp index e5f25c975..78d149507 100644 --- a/include/NumCpp/Roots.hpp +++ b/include/NumCpp/Roots.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots/Bisection.hpp b/include/NumCpp/Roots/Bisection.hpp index 866be1c90..6a4fa851e 100644 --- a/include/NumCpp/Roots/Bisection.hpp +++ b/include/NumCpp/Roots/Bisection.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots/Brent.hpp b/include/NumCpp/Roots/Brent.hpp index 920eb7d46..e6cffbd26 100644 --- a/include/NumCpp/Roots/Brent.hpp +++ b/include/NumCpp/Roots/Brent.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots/Dekker.hpp b/include/NumCpp/Roots/Dekker.hpp index 61824f0d3..6b372ebb3 100644 --- a/include/NumCpp/Roots/Dekker.hpp +++ b/include/NumCpp/Roots/Dekker.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots/Iteration.hpp b/include/NumCpp/Roots/Iteration.hpp index ba002191e..4ebef991f 100644 --- a/include/NumCpp/Roots/Iteration.hpp +++ b/include/NumCpp/Roots/Iteration.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots/Newton.hpp b/include/NumCpp/Roots/Newton.hpp index a7997a64a..32aba7603 100644 --- a/include/NumCpp/Roots/Newton.hpp +++ b/include/NumCpp/Roots/Newton.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Roots/Secant.hpp b/include/NumCpp/Roots/Secant.hpp index 2e7511343..95730905d 100644 --- a/include/NumCpp/Roots/Secant.hpp +++ b/include/NumCpp/Roots/Secant.hpp @@ -4,7 +4,7 @@ /// /// License /// Copyright 2019 Benjamin Mahr -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Rotations.hpp b/include/NumCpp/Rotations.hpp index 3ec475d9b..789f9db67 100644 --- a/include/NumCpp/Rotations.hpp +++ b/include/NumCpp/Rotations.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Rotations/DCM.hpp b/include/NumCpp/Rotations/DCM.hpp index 3fa635382..43012b079 100644 --- a/include/NumCpp/Rotations/DCM.hpp +++ b/include/NumCpp/Rotations/DCM.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Rotations/Quaternion.hpp b/include/NumCpp/Rotations/Quaternion.hpp index 49da8667b..0e2275717 100644 --- a/include/NumCpp/Rotations/Quaternion.hpp +++ b/include/NumCpp/Rotations/Quaternion.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Rotations/rodriguesRotation.hpp b/include/NumCpp/Rotations/rodriguesRotation.hpp index cfb913bf4..d3ac9fadf 100644 --- a/include/NumCpp/Rotations/rodriguesRotation.hpp +++ b/include/NumCpp/Rotations/rodriguesRotation.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Rotations/wahbasProblem.hpp b/include/NumCpp/Rotations/wahbasProblem.hpp index a0842403a..b0d36f351 100644 --- a/include/NumCpp/Rotations/wahbasProblem.hpp +++ b/include/NumCpp/Rotations/wahbasProblem.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special.hpp b/include/NumCpp/Special.hpp index 7c1481450..2d4e582e7 100644 --- a/include/NumCpp/Special.hpp +++ b/include/NumCpp/Special.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/airy_ai.hpp b/include/NumCpp/Special/airy_ai.hpp index 7994fec4b..d74c88c92 100644 --- a/include/NumCpp/Special/airy_ai.hpp +++ b/include/NumCpp/Special/airy_ai.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/airy_ai_prime.hpp b/include/NumCpp/Special/airy_ai_prime.hpp index 2b1dcdeda..f37270038 100644 --- a/include/NumCpp/Special/airy_ai_prime.hpp +++ b/include/NumCpp/Special/airy_ai_prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/airy_bi.hpp b/include/NumCpp/Special/airy_bi.hpp index d08d8720b..e49e39a3c 100644 --- a/include/NumCpp/Special/airy_bi.hpp +++ b/include/NumCpp/Special/airy_bi.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/airy_bi_prime.hpp b/include/NumCpp/Special/airy_bi_prime.hpp index c5f65972d..6365603c9 100644 --- a/include/NumCpp/Special/airy_bi_prime.hpp +++ b/include/NumCpp/Special/airy_bi_prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bernoulli.hpp b/include/NumCpp/Special/bernoulli.hpp index f10cf4913..5315d02b1 100644 --- a/include/NumCpp/Special/bernoulli.hpp +++ b/include/NumCpp/Special/bernoulli.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_in.hpp b/include/NumCpp/Special/bessel_in.hpp index d2ea50e77..1edcfdae9 100644 --- a/include/NumCpp/Special/bessel_in.hpp +++ b/include/NumCpp/Special/bessel_in.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_in_prime.hpp b/include/NumCpp/Special/bessel_in_prime.hpp index 39e896094..8cd8d1471 100644 --- a/include/NumCpp/Special/bessel_in_prime.hpp +++ b/include/NumCpp/Special/bessel_in_prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_jn.hpp b/include/NumCpp/Special/bessel_jn.hpp index 39f256db4..25ed7f548 100644 --- a/include/NumCpp/Special/bessel_jn.hpp +++ b/include/NumCpp/Special/bessel_jn.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_jn_prime.hpp b/include/NumCpp/Special/bessel_jn_prime.hpp index 49b84e869..5a253b915 100644 --- a/include/NumCpp/Special/bessel_jn_prime.hpp +++ b/include/NumCpp/Special/bessel_jn_prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_kn.hpp b/include/NumCpp/Special/bessel_kn.hpp index 9e7947461..664aaa817 100644 --- a/include/NumCpp/Special/bessel_kn.hpp +++ b/include/NumCpp/Special/bessel_kn.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_kn_prime.hpp b/include/NumCpp/Special/bessel_kn_prime.hpp index b2599dd0c..daba1b2d8 100644 --- a/include/NumCpp/Special/bessel_kn_prime.hpp +++ b/include/NumCpp/Special/bessel_kn_prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_yn.hpp b/include/NumCpp/Special/bessel_yn.hpp index 695737a5f..82231ea02 100644 --- a/include/NumCpp/Special/bessel_yn.hpp +++ b/include/NumCpp/Special/bessel_yn.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/bessel_yn_prime.hpp b/include/NumCpp/Special/bessel_yn_prime.hpp index e93dc756f..994eba93c 100644 --- a/include/NumCpp/Special/bessel_yn_prime.hpp +++ b/include/NumCpp/Special/bessel_yn_prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/beta.hpp b/include/NumCpp/Special/beta.hpp index aa1da9e2e..cc52fb70b 100644 --- a/include/NumCpp/Special/beta.hpp +++ b/include/NumCpp/Special/beta.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/cnr.hpp b/include/NumCpp/Special/cnr.hpp index 3bdab2f6d..43bba6656 100644 --- a/include/NumCpp/Special/cnr.hpp +++ b/include/NumCpp/Special/cnr.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/comp_ellint_1.hpp b/include/NumCpp/Special/comp_ellint_1.hpp index c15078159..3b2dfea16 100644 --- a/include/NumCpp/Special/comp_ellint_1.hpp +++ b/include/NumCpp/Special/comp_ellint_1.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/comp_ellint_2.hpp b/include/NumCpp/Special/comp_ellint_2.hpp index 38e2bfe54..0a726db29 100644 --- a/include/NumCpp/Special/comp_ellint_2.hpp +++ b/include/NumCpp/Special/comp_ellint_2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/comp_ellint_3.hpp b/include/NumCpp/Special/comp_ellint_3.hpp index 1c15c3347..60f02b221 100644 --- a/include/NumCpp/Special/comp_ellint_3.hpp +++ b/include/NumCpp/Special/comp_ellint_3.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/cyclic_hankel_1.hpp b/include/NumCpp/Special/cyclic_hankel_1.hpp index 658b474cf..bef46d989 100644 --- a/include/NumCpp/Special/cyclic_hankel_1.hpp +++ b/include/NumCpp/Special/cyclic_hankel_1.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/cyclic_hankel_2.hpp b/include/NumCpp/Special/cyclic_hankel_2.hpp index 3fa7376aa..aa6a7e91d 100644 --- a/include/NumCpp/Special/cyclic_hankel_2.hpp +++ b/include/NumCpp/Special/cyclic_hankel_2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/digamma.hpp b/include/NumCpp/Special/digamma.hpp index 7caac3412..74ab6e06e 100644 --- a/include/NumCpp/Special/digamma.hpp +++ b/include/NumCpp/Special/digamma.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/ellint_1.hpp b/include/NumCpp/Special/ellint_1.hpp index 30c6dddb5..1cf93c87f 100644 --- a/include/NumCpp/Special/ellint_1.hpp +++ b/include/NumCpp/Special/ellint_1.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/ellint_2.hpp b/include/NumCpp/Special/ellint_2.hpp index 362ee58af..792adcd42 100644 --- a/include/NumCpp/Special/ellint_2.hpp +++ b/include/NumCpp/Special/ellint_2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/ellint_3.hpp b/include/NumCpp/Special/ellint_3.hpp index 2465c00e1..a7d8ad25d 100644 --- a/include/NumCpp/Special/ellint_3.hpp +++ b/include/NumCpp/Special/ellint_3.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/erf.hpp b/include/NumCpp/Special/erf.hpp index 268ec98a1..38c29f999 100644 --- a/include/NumCpp/Special/erf.hpp +++ b/include/NumCpp/Special/erf.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/erf_inv.hpp b/include/NumCpp/Special/erf_inv.hpp index f9961b710..359f05665 100644 --- a/include/NumCpp/Special/erf_inv.hpp +++ b/include/NumCpp/Special/erf_inv.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/erfc.hpp b/include/NumCpp/Special/erfc.hpp index 6b7137d40..cff04c5d4 100644 --- a/include/NumCpp/Special/erfc.hpp +++ b/include/NumCpp/Special/erfc.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/erfc_inv.hpp b/include/NumCpp/Special/erfc_inv.hpp index 23a0519cf..e2589f167 100644 --- a/include/NumCpp/Special/erfc_inv.hpp +++ b/include/NumCpp/Special/erfc_inv.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/expint.hpp b/include/NumCpp/Special/expint.hpp index df76a117b..c139ccbd5 100644 --- a/include/NumCpp/Special/expint.hpp +++ b/include/NumCpp/Special/expint.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/factorial.hpp b/include/NumCpp/Special/factorial.hpp index 874fcec31..6031605d4 100644 --- a/include/NumCpp/Special/factorial.hpp +++ b/include/NumCpp/Special/factorial.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/gamma.hpp b/include/NumCpp/Special/gamma.hpp index 7c1cc16f0..6f9c76e74 100644 --- a/include/NumCpp/Special/gamma.hpp +++ b/include/NumCpp/Special/gamma.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/gamma1pm1.hpp b/include/NumCpp/Special/gamma1pm1.hpp index 0cc64b8dc..4135170fe 100644 --- a/include/NumCpp/Special/gamma1pm1.hpp +++ b/include/NumCpp/Special/gamma1pm1.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/log_gamma.hpp b/include/NumCpp/Special/log_gamma.hpp index ae0942843..8a8fb5443 100644 --- a/include/NumCpp/Special/log_gamma.hpp +++ b/include/NumCpp/Special/log_gamma.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/pnr.hpp b/include/NumCpp/Special/pnr.hpp index 336192baf..673740fc0 100644 --- a/include/NumCpp/Special/pnr.hpp +++ b/include/NumCpp/Special/pnr.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/polygamma.hpp b/include/NumCpp/Special/polygamma.hpp index e99d05653..4da25dab0 100644 --- a/include/NumCpp/Special/polygamma.hpp +++ b/include/NumCpp/Special/polygamma.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/prime.hpp b/include/NumCpp/Special/prime.hpp index ecf9cb3c4..ec9ebf3bf 100644 --- a/include/NumCpp/Special/prime.hpp +++ b/include/NumCpp/Special/prime.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/riemann_zeta.hpp b/include/NumCpp/Special/riemann_zeta.hpp index 596331d96..0a8639af2 100644 --- a/include/NumCpp/Special/riemann_zeta.hpp +++ b/include/NumCpp/Special/riemann_zeta.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/softmax.hpp b/include/NumCpp/Special/softmax.hpp index 5e8d5b245..40ff478f8 100644 --- a/include/NumCpp/Special/softmax.hpp +++ b/include/NumCpp/Special/softmax.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/spherical_bessel_jn.hpp b/include/NumCpp/Special/spherical_bessel_jn.hpp index 687ec8146..496415b44 100644 --- a/include/NumCpp/Special/spherical_bessel_jn.hpp +++ b/include/NumCpp/Special/spherical_bessel_jn.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/spherical_bessel_yn.hpp b/include/NumCpp/Special/spherical_bessel_yn.hpp index 23013ae4f..c862adb7f 100644 --- a/include/NumCpp/Special/spherical_bessel_yn.hpp +++ b/include/NumCpp/Special/spherical_bessel_yn.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/spherical_hankel_1.hpp b/include/NumCpp/Special/spherical_hankel_1.hpp index 822439650..dffc2ad85 100644 --- a/include/NumCpp/Special/spherical_hankel_1.hpp +++ b/include/NumCpp/Special/spherical_hankel_1.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/spherical_hankel_2.hpp b/include/NumCpp/Special/spherical_hankel_2.hpp index 6f974a5e4..fccb9e489 100644 --- a/include/NumCpp/Special/spherical_hankel_2.hpp +++ b/include/NumCpp/Special/spherical_hankel_2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Special/trigamma.hpp b/include/NumCpp/Special/trigamma.hpp index bf85808f3..e86a859d2 100644 --- a/include/NumCpp/Special/trigamma.hpp +++ b/include/NumCpp/Special/trigamma.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils.hpp b/include/NumCpp/Utils.hpp index 6f5d1c3e2..8706b5836 100644 --- a/include/NumCpp/Utils.hpp +++ b/include/NumCpp/Utils.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/cube.hpp b/include/NumCpp/Utils/cube.hpp index 762486978..e29e3d32d 100644 --- a/include/NumCpp/Utils/cube.hpp +++ b/include/NumCpp/Utils/cube.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/essentiallyEqual.hpp b/include/NumCpp/Utils/essentiallyEqual.hpp index 464fc34db..54f60e67c 100644 --- a/include/NumCpp/Utils/essentiallyEqual.hpp +++ b/include/NumCpp/Utils/essentiallyEqual.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/gaussian.hpp b/include/NumCpp/Utils/gaussian.hpp index dde12a404..57589f0a0 100644 --- a/include/NumCpp/Utils/gaussian.hpp +++ b/include/NumCpp/Utils/gaussian.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/gaussian1d.hpp b/include/NumCpp/Utils/gaussian1d.hpp index 508a2b575..7e0b82161 100644 --- a/include/NumCpp/Utils/gaussian1d.hpp +++ b/include/NumCpp/Utils/gaussian1d.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/interp.hpp b/include/NumCpp/Utils/interp.hpp index 4228bbcb0..acd249ca9 100644 --- a/include/NumCpp/Utils/interp.hpp +++ b/include/NumCpp/Utils/interp.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/num2str.hpp b/include/NumCpp/Utils/num2str.hpp index a3679e969..7dd47d53d 100644 --- a/include/NumCpp/Utils/num2str.hpp +++ b/include/NumCpp/Utils/num2str.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/power.hpp b/include/NumCpp/Utils/power.hpp index 2b0206cb9..f26c4ef62 100644 --- a/include/NumCpp/Utils/power.hpp +++ b/include/NumCpp/Utils/power.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/powerf.hpp b/include/NumCpp/Utils/powerf.hpp index 91eb24fe4..c458d4d75 100644 --- a/include/NumCpp/Utils/powerf.hpp +++ b/include/NumCpp/Utils/powerf.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/sqr.hpp b/include/NumCpp/Utils/sqr.hpp index af3bc752b..5536168de 100644 --- a/include/NumCpp/Utils/sqr.hpp +++ b/include/NumCpp/Utils/sqr.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Utils/value2str.hpp b/include/NumCpp/Utils/value2str.hpp index 4f09af907..c2aacc44b 100644 --- a/include/NumCpp/Utils/value2str.hpp +++ b/include/NumCpp/Utils/value2str.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Vector.hpp b/include/NumCpp/Vector.hpp index 292bb9ca2..d640f3866 100644 --- a/include/NumCpp/Vector.hpp +++ b/include/NumCpp/Vector.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Vector/Vec2.hpp b/include/NumCpp/Vector/Vec2.hpp index fc8c4859a..2d8bd9032 100644 --- a/include/NumCpp/Vector/Vec2.hpp +++ b/include/NumCpp/Vector/Vec2.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software diff --git a/include/NumCpp/Vector/Vec3.hpp b/include/NumCpp/Vector/Vec3.hpp index e38dc5b80..012829c2f 100644 --- a/include/NumCpp/Vector/Vec3.hpp +++ b/include/NumCpp/Vector/Vec3.hpp @@ -3,7 +3,7 @@ /// [GitHub Repository](https://github.com/dpilger26/NumCpp) /// /// License -/// Copyright 2018-2021 David Pilger +/// Copyright 2018-2022 David Pilger /// /// Permission is hereby granted, free of charge, to any person obtaining a copy of this /// software and associated documentation files(the "Software"), to deal in the Software From 09d1e020244787d89d93b8781615b6b65d26143b Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 16:09:26 -0700 Subject: [PATCH 09/31] implemented blackman --- include/NumCpp/Functions/blackman.hpp | 30 ++++++++++++++++++++++----- test/pytest/test_functions.py | 7 +++++++ test/src/NumCppPy.cpp | 8 +++++++ 3 files changed, 40 insertions(+), 5 deletions(-) diff --git a/include/NumCpp/Functions/blackman.hpp b/include/NumCpp/Functions/blackman.hpp index e1a61fa1f..4b1fa5664 100644 --- a/include/NumCpp/Functions/blackman.hpp +++ b/include/NumCpp/Functions/blackman.hpp @@ -27,7 +27,11 @@ /// #pragma once +#include + #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Constants.hpp" +#include "NumCpp/Functions/linspace.hpp" namespace nc { @@ -39,11 +43,27 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.blackman.html /// - /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// - // inline NdArray blackman(int M) - // { - - // } + inline NdArray blackman(int32 m) + { + if (m < 1) + { + return {}; + } + + const auto mDouble = static_cast(m); + + NdArray result(1, m); + int32 i = 0; + for (auto n : linspace(0.0, mDouble, m, true)) + { + const auto nOverM = n / mDouble; + result[i++] = 0.42 - 0.5 * std::cos(2.0 * constants::pi * nOverM) + + 0.08 * std::cos(4.0 * constants::pi * nOverM); + } + + return result; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index ad96b6282..fefd3bc39 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -1382,6 +1382,13 @@ def test_bitwise_xor(): assert np.array_equal(NumCpp.bitwise_xor(cArray1, cArray2), np.bitwise_xor(data1, data2)) +#################################################################################### +def test_blackman(): + m = np.random.randint(2, 100) + assert np.array_equal(np.round(NumCpp.blackman(m), 9).flatten(), + np.round(np.blackman(m), 9)) + + #################################################################################### def test_byteswap(): shapeInput = np.random.randint(20, 100, [2, ]) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index b06be5eb8..7ecbcff88 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -2643,6 +2643,13 @@ namespace FunctionsInterface //================================================================================ + pbArrayGeneric blackman(nc::int32 m) + { + return nc2pybind(nc::blackman(m)); + } + + //================================================================================ + template pbArrayGeneric andOperatorArray(const NdArray& inArray1, const NdArray& inArray2) { @@ -7364,6 +7371,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("bitwise_not", &FunctionsInterface::bitwise_not); m.def("bitwise_or", &FunctionsInterface::bitwise_or); m.def("bitwise_xor", &FunctionsInterface::bitwise_xor); + m.def("blackman", &FunctionsInterface::blackman); m.def("andOperatorArray", &FunctionsInterface::andOperatorArray); m.def("andOperatorScaler", &FunctionsInterface::andOperatorScaler); m.def("orOperatorArray", &FunctionsInterface::orOperatorArray); From 329c524f76b7b5e916709667c18d1d22ddd559e8 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 16:31:03 -0700 Subject: [PATCH 10/31] implemented bartlett --- develop/ToDo.md | 2 -- include/NumCpp/Functions/bartlett.hpp | 27 +++++++++++++++++++++++---- test/pytest/test_functions.py | 7 +++++++ test/src/NumCppPy.cpp | 8 ++++++++ 4 files changed, 38 insertions(+), 6 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index e587b4f5c..bbe42a774 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -1,7 +1,5 @@ ## Functions to add: - * `bartlett`, https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html - * `blackman`, https://numpy.org/doc/stable/reference/generated/numpy.blackman.html * `choose`, https://numpy.org/doc/stable/reference/generated/numpy.choose.html * `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html diff --git a/include/NumCpp/Functions/bartlett.hpp b/include/NumCpp/Functions/bartlett.hpp index be518737a..7fcb19825 100644 --- a/include/NumCpp/Functions/bartlett.hpp +++ b/include/NumCpp/Functions/bartlett.hpp @@ -27,7 +27,10 @@ /// #pragma once +#include + #include "NumCpp/NdArray.hpp" +#include "NumCpp/Functions/linspace.hpp" namespace nc { @@ -39,11 +42,27 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html /// - /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// - // inline NdArray bartlett(int M) - // { + inline NdArray bartlett(int32 m) + { + if (m < 1) + { + return {}; + } + + const auto mDouble = static_cast(m); + const auto mMinus1Over2 = (mDouble - 1.0) / 2.0; + const auto mMinus1Over2Inv = 1.0 / mMinus1Over2; + + NdArray result(1, m); + int32 i = 0; + for (auto n : linspace(0.0, mDouble - 1.0, m, true)) + { + result[i++] = mMinus1Over2Inv * (mMinus1Over2 - std::abs(n - mMinus1Over2)); + } - // } + return result; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index fefd3bc39..6e020a41f 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -1285,6 +1285,13 @@ def test_averageWeighted(): np.round(np.average(data, weights=weights.flatten(), axis=1), 9)) +#################################################################################### +def test_bartlett(): + m = np.random.randint(2, 100) + assert np.array_equal(np.round(NumCpp.bartlett(m), 9).flatten(), + np.round(np.bartlett(m), 9)) + + #################################################################################### def test_binaryRepr(): value = np.random.randint(0, np.iinfo(np.uint64).max, [1, ], dtype=np.uint64).item() diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 7ecbcff88..30ea44c23 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -2643,6 +2643,13 @@ namespace FunctionsInterface //================================================================================ + pbArrayGeneric bartlett(nc::int32 m) + { + return nc2pybind(nc::bartlett(m)); + } + + //================================================================================ + pbArrayGeneric blackman(nc::int32 m) { return nc2pybind(nc::blackman(m)); @@ -7364,6 +7371,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("averageWeighted", &FunctionsInterface::averageWeighted); m.def("averageWeighted", &FunctionsInterface::averageWeightedComplex); + m.def("bartlett", &FunctionsInterface::bartlett); m.def("binaryRepr", &binaryRepr); m.def("bincount", &FunctionsInterface::bincount); m.def("bincountWeighted", &FunctionsInterface::bincountWeighted); From 16d1962ad0f556b1015dcec722e9c1989654295a Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 16:37:19 -0700 Subject: [PATCH 11/31] added hamming window --- include/NumCpp/Functions/hamming.hpp | 28 +++++++++++++++++++++++----- test/pytest/test_functions.py | 7 +++++++ test/src/NumCppPy.cpp | 8 ++++++++ 3 files changed, 38 insertions(+), 5 deletions(-) diff --git a/include/NumCpp/Functions/hamming.hpp b/include/NumCpp/Functions/hamming.hpp index 94a3869d6..12ec856bb 100644 --- a/include/NumCpp/Functions/hamming.hpp +++ b/include/NumCpp/Functions/hamming.hpp @@ -27,7 +27,10 @@ /// #pragma once +#include + #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Constants.hpp" namespace nc { @@ -39,11 +42,26 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.hamming.html /// - /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// - // inline NdArray hamming(int M) - // { - - // } + inline NdArray hamming(int32 m) + { + if (m < 1) + { + return {}; + } + + const auto mDouble = static_cast(m); + const auto twoPiDivMMinus1 = (2.0 * constants::pi) / (mDouble - 1.0); + + NdArray result(1, m); + int32 i = 0; + for (auto n : linspace(0.0, mDouble - 1.0, m, true)) + { + result[i++] = 0.54 - 0.46 * std::cos(twoPiDivMMinus1 * n); + } + + return result; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index 6e020a41f..d412a22f1 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3207,6 +3207,13 @@ def test_greater_equal(): np.greater_equal(data1, data2)) +#################################################################################### +def test_hamming(): + m = np.random.randint(2, 100) + assert np.array_equal(np.round(NumCpp.hamming(m), 9).flatten(), + np.round(np.hamming(m), 9)) + + #################################################################################### def test_histogram(): shape = NumCpp.Shape(1024, 1024) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 30ea44c23..fe4378bc4 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3293,6 +3293,13 @@ namespace FunctionsInterface //================================================================================ + pbArrayGeneric hamming(nc::int32 m) + { + return nc2pybind(nc::hamming(m)); + } + + //================================================================================ + template pbArrayGeneric histogramWithEdges(const NdArray& inArray, const NdArray& inBinEdges) { @@ -7538,6 +7545,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("gradient", &FunctionsInterface::gradient); m.def("gradient", &FunctionsInterface::gradient); + m.def("hamming", &FunctionsInterface::hamming); m.def("histogram", &FunctionsInterface::histogram); m.def("histogram", &FunctionsInterface::histogramWithEdges); m.def("hstack", &FunctionsInterface::hstack); From ea07e6fbe698e30b887ffd8aad3b7efdc0633f1d Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 16:41:12 -0700 Subject: [PATCH 12/31] added hanning --- develop/ToDo.md | 2 -- include/NumCpp/Functions/hanning.hpp | 32 ++++++++++++++++++++++------ test/pytest/test_functions.py | 7 ++++++ test/src/NumCppPy.cpp | 8 +++++++ 4 files changed, 40 insertions(+), 9 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index bbe42a774..d2d5de190 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -5,9 +5,7 @@ * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html * `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html * `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html - * `hamming`, https://numpy.org/doc/stable/reference/generated/numpy.hamming.html * `hammingEncode`, my stuff - * `hanning`, https://numpy.org/doc/stable/reference/generated/numpy.hanning.html * `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html * `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html * `isposinf`, https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html diff --git a/include/NumCpp/Functions/hanning.hpp b/include/NumCpp/Functions/hanning.hpp index c6c52ffc9..1c0cce377 100644 --- a/include/NumCpp/Functions/hanning.hpp +++ b/include/NumCpp/Functions/hanning.hpp @@ -27,23 +27,41 @@ /// #pragma once +#include + #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Constants.hpp" namespace nc { //============================================================================ // Method Description: - /// Return the Hanning window. + /// Return the Hamming window. /// - /// The Hamming window is a taper formed by using a weighted cosine. + /// The Hanning window is a taper formed by using a weighted cosine. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.hanning.html /// - /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// - // inline NdArray hanning(int M) - // { - - // } + inline NdArray hanning(int32 m) + { + if (m < 1) + { + return {}; + } + + const auto mDouble = static_cast(m); + const auto twoPiDivMMinus1 = (2.0 * constants::pi) / (mDouble - 1.0); + + NdArray result(1, m); + int32 i = 0; + for (auto n : linspace(0.0, mDouble - 1.0, m, true)) + { + result[i++] = 0.5 - 0.5 * std::cos(twoPiDivMMinus1 * n); + } + + return result; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index d412a22f1..aea57b248 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3214,6 +3214,13 @@ def test_hamming(): np.round(np.hamming(m), 9)) +#################################################################################### +def test_hanning(): + m = np.random.randint(2, 100) + assert np.array_equal(np.round(NumCpp.hanning(m), 9).flatten(), + np.round(np.hanning(m), 9)) + + #################################################################################### def test_histogram(): shape = NumCpp.Shape(1024, 1024) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index fe4378bc4..efea677b6 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3300,6 +3300,13 @@ namespace FunctionsInterface //================================================================================ + pbArrayGeneric hanning(nc::int32 m) + { + return nc2pybind(nc::hanning(m)); + } + + //================================================================================ + template pbArrayGeneric histogramWithEdges(const NdArray& inArray, const NdArray& inBinEdges) { @@ -7546,6 +7553,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("gradient", &FunctionsInterface::gradient); m.def("hamming", &FunctionsInterface::hamming); + m.def("hanning", &FunctionsInterface::hanning); m.def("histogram", &FunctionsInterface::histogram); m.def("histogram", &FunctionsInterface::histogramWithEdges); m.def("hstack", &FunctionsInterface::hstack); From 5c11e78dd3e095439381c7e4a679d8c2a98aaf8e Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Thu, 23 Dec 2021 16:54:11 -0700 Subject: [PATCH 13/31] implemented kaiser --- develop/ToDo.md | 1 - include/NumCpp/Functions/kaiser.hpp | 34 ++++++++++++++++++++++++----- test/pytest/test_functions.py | 8 +++++++ test/src/NumCppPy.cpp | 9 ++++++++ 4 files changed, 46 insertions(+), 6 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index d2d5de190..a09f466aa 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -9,6 +9,5 @@ * `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html * `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html * `isposinf`, https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html - * `kaiser`, https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html * `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html * `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html diff --git a/include/NumCpp/Functions/kaiser.hpp b/include/NumCpp/Functions/kaiser.hpp index 24e3b4cdd..6fd3046db 100644 --- a/include/NumCpp/Functions/kaiser.hpp +++ b/include/NumCpp/Functions/kaiser.hpp @@ -27,7 +27,11 @@ /// #pragma once +#include + #include "NumCpp/NdArray.hpp" +#include "NumCpp/Special/bessel_in.hpp" +#include "NumCpp/Utils/sqr.hpp" namespace nc { @@ -37,11 +41,31 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html /// - /// @param M: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. + /// @param beta: shape parameter for the window /// @return NdArray /// - // inline NdArray kaiser(int M) - // { - - // } + inline NdArray kaiser(int32 m, double beta) + { + if (m < 1) + { + return {}; + } + + const auto mDouble = static_cast(m); + const auto mMinus1 = mDouble - 1.0; + const auto mMinus1Over2 = mMinus1 / 2.0; + const auto mMinus1Squared = utils::sqr(mMinus1); + const auto i0Beta = special::bessel_in(0, beta); + + NdArray result(1, m); + int32 i = 0; + for (auto n : linspace(-mMinus1Over2, mMinus1Over2, m, true)) + { + auto value = beta * std::sqrt(1.0 - (4.0 * utils::sqr(n)) / mMinus1Squared); + result[i++] = special::bessel_in(0, value) / i0Beta; + } + + return result; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index aea57b248..502b36139 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3417,6 +3417,14 @@ def test_isnan(): assert np.array_equal(NumCpp.isnanArray(cArray), np.isnan(data)) +#################################################################################### +def test_kaiser(): + m = np.random.randint(2, 100) + beta = np.random.rand(1).item() + assert np.array_equal(np.round(NumCpp.kaiser(m, beta), 9).flatten(), + np.round(np.kaiser(m, beta), 9)) + + #################################################################################### def test_lcm(): if not NumCpp.NUMCPP_NO_USE_BOOST or NumCpp.STL_GCD_LCM: diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index efea677b6..f9875731a 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3414,6 +3414,13 @@ namespace FunctionsInterface //================================================================================ + pbArrayGeneric kaiser(nc::int32 m, double beta) + { + return nc2pybind(nc::kaiser(m, beta)); + } + + //================================================================================ + template dtype ldexpScaler(dtype inValue1, uint8 inValue2) { @@ -7574,6 +7581,8 @@ PYBIND11_MODULE(NumCppPy, m) m.def("isnanScaler", &FunctionsInterface::isnanScaler); m.def("isnanArray", &FunctionsInterface::isnanArray); + m.def("kaiser", &FunctionsInterface::kaiser); + #if !defined(NUMCPP_NO_USE_BOOST) || defined(__cpp_lib_gcd_lcm) m.def("lcmScaler", &FunctionsInterface::lcmScaler); #endif From d38d2ca8cd47ec4975dd9e5e2303e7ae641be0fb Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 10:26:41 -0700 Subject: [PATCH 14/31] added isposinf and isneginf --- develop/ToDo.md | 4 +-- include/NumCpp/Functions/isneginf.hpp | 49 ++++++++++++++++++++++----- include/NumCpp/Functions/isposinf.hpp | 49 ++++++++++++++++++++++----- test/pytest/test_functions.py | 41 +++++++++++++++++++++- test/src/NumCppPy.cpp | 36 ++++++++++++++++++++ 5 files changed, 158 insertions(+), 21 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index a09f466aa..0ea073177 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -7,7 +7,7 @@ * `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html * `hammingEncode`, my stuff * `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html - * `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html - * `isposinf`, https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html * `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html * `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html + + * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy diff --git a/include/NumCpp/Functions/isneginf.hpp b/include/NumCpp/Functions/isneginf.hpp index 675c065d1..33ed5552a 100644 --- a/include/NumCpp/Functions/isneginf.hpp +++ b/include/NumCpp/Functions/isneginf.hpp @@ -28,21 +28,52 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Functions/isinf.hpp" namespace nc { //============================================================================ // Method Description: - /// Test element-wise for negative infinity, return result as bool array. + /// Test for negative inf and return result as a boolean. /// - /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isneginf.html /// - /// @param x: input array - /// @return NdArray + /// @param + /// inValue /// - // template - // NdArray isneginf(const NdArray& inArray) - // { - - // } + /// @return + /// bool + /// + template + bool isneginf(dtype inValue) noexcept + { + STATIC_ASSERT_FLOAT(dtype); + + return inValue < 0 && std::isinf(inValue); + } + + //============================================================================ + // Method Description: + /// Test element-wise for negative inf and return result as a boolean array. + /// + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isneginf.html + /// + /// @param + /// inArray + /// + /// @return + /// NdArray + /// + template + NdArray isneginf(const NdArray& inArray) + { + NdArray returnArray(inArray.shape()); + stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), + [](dtype inValue) noexcept -> bool + { + return isneginf(inValue); + }); + + return returnArray; + } } // namespace nc diff --git a/include/NumCpp/Functions/isposinf.hpp b/include/NumCpp/Functions/isposinf.hpp index e160fbc35..47e7d2884 100644 --- a/include/NumCpp/Functions/isposinf.hpp +++ b/include/NumCpp/Functions/isposinf.hpp @@ -28,21 +28,52 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Functions/isinf.hpp" namespace nc { //============================================================================ // Method Description: - /// Test element-wise for positive infinity, return result as bool array. + /// Test for positive inf and return result as a boolean. /// - /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isposinf.html /// - /// @param x: input array - /// @return NdArray + /// @param + /// inValue /// - // template - // NdArray isposinf(const NdArray& inArray) - // { - - // } + /// @return + /// bool + /// + template + bool isposinf(dtype inValue) noexcept + { + STATIC_ASSERT_FLOAT(dtype); + + return inValue > 0 && std::isinf(inValue); + } + + //============================================================================ + // Method Description: + /// Test element-wise for positive inf and return result as a boolean array. + /// + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isposinf.html + /// + /// @param + /// inArray + /// + /// @return + /// NdArray + /// + template + NdArray isposinf(const NdArray& inArray) + { + NdArray returnArray(inArray.shape()); + stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), + [](dtype inValue) noexcept -> bool + { + return isposinf(inValue); + }); + + return returnArray; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index 502b36139..cb7065035 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3392,7 +3392,10 @@ def test_isclose(): #################################################################################### def test_isinf(): value = np.random.randn(1).item() * 100 + 1000 - assert NumCpp.isinfScaler(value) == np.isinf(value) + assert not NumCpp.isinfScaler(value) + + assert NumCpp.isinfScaler(np.inf) + assert NumCpp.isinfScaler(-np.inf) shapeInput = np.random.randint(20, 100, [2, ]) shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) @@ -3403,6 +3406,42 @@ def test_isinf(): assert np.array_equal(NumCpp.isinfArray(cArray), np.isinf(data)) +#################################################################################### +def test_isposinf(): + value = np.random.randn(1).item() * 100 + 1000 + assert not NumCpp.isposinfScaler(value) + + assert NumCpp.isposinfScaler(np.inf) + assert not NumCpp.isposinfScaler(-np.inf) + + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + data = np.random.randn(shape.rows, shape.cols) * 100 + 1000 + data[data > np.percentile(data, 75)] = np.inf + data[data < np.percentile(data, 25)] = -np.inf + cArray.setArray(data) + assert np.array_equal(NumCpp.isposinfArray(cArray), np.isposinf(data)) + + +#################################################################################### +def test_isneginf(): + value = np.random.randn(1).item() * 100 + 1000 + assert not NumCpp.isneginfScaler(value) + + assert not NumCpp.isneginfScaler(np.inf) + assert NumCpp.isneginfScaler(-np.inf) + + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + data = np.random.randn(shape.rows, shape.cols) * 100 + 1000 + data[data > np.percentile(data, 75)] = np.inf + data[data < np.percentile(data, 25)] = -np.inf + cArray.setArray(data) + assert np.array_equal(NumCpp.isneginfArray(cArray), np.isneginf(data)) + + #################################################################################### def test_isnan(): value = np.random.randn(1).item() * 100 + 1000 diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index f9875731a..5a7ba9d4b 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3396,6 +3396,38 @@ namespace FunctionsInterface return nc2pybind(nc::isinf(inArray)); } + //================================================================================ + + template + bool isposinfScaler(dtype inValue) + { + return nc::isposinf(inValue); + } + + //================================================================================ + + template + pbArrayGeneric isposinfArray(const NdArray& inArray) + { + return nc2pybind(nc::isposinf(inArray)); + } + + //================================================================================ + + template + bool isneginfScaler(dtype inValue) + { + return nc::isneginf(inValue); + } + + //================================================================================ + + template + pbArrayGeneric isneginfArray(const NdArray& inArray) + { + return nc2pybind(nc::isneginf(inArray)); + } + //================================================================================ template @@ -7578,6 +7610,10 @@ PYBIND11_MODULE(NumCppPy, m) m.def("isclose", &isclose); m.def("isinfScaler", &FunctionsInterface::isinfScaler); m.def("isinfArray", &FunctionsInterface::isinfArray); + m.def("isposinfScaler", &FunctionsInterface::isposinfScaler); + m.def("isposinfArray", &FunctionsInterface::isposinfArray); + m.def("isneginfScaler", &FunctionsInterface::isneginfScaler); + m.def("isneginfArray", &FunctionsInterface::isneginfArray); m.def("isnanScaler", &FunctionsInterface::isnanScaler); m.def("isnanArray", &FunctionsInterface::isnanArray); From d5b80f444bb1a48823ee53951f621d5b1890cc61 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 10:47:32 -0700 Subject: [PATCH 15/31] added place function --- develop/ToDo.md | 2 -- include/NumCpp/Functions.hpp | 1 - include/NumCpp/Functions/choose.hpp | 51 ----------------------------- include/NumCpp/Functions/place.hpp | 31 ++++++++++++++---- test/pytest/test_functions.py | 23 +++++++++++++ test/src/NumCppPy.cpp | 1 + 6 files changed, 48 insertions(+), 61 deletions(-) delete mode 100644 include/NumCpp/Functions/choose.hpp diff --git a/develop/ToDo.md b/develop/ToDo.md index 0ea073177..83242e733 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -1,6 +1,5 @@ ## Functions to add: - * `choose`, https://numpy.org/doc/stable/reference/generated/numpy.choose.html * `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html * `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html @@ -8,6 +7,5 @@ * `hammingEncode`, my stuff * `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html * `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html - * `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy diff --git a/include/NumCpp/Functions.hpp b/include/NumCpp/Functions.hpp index 0bc80c7e7..91505303f 100644 --- a/include/NumCpp/Functions.hpp +++ b/include/NumCpp/Functions.hpp @@ -71,7 +71,6 @@ #include "NumCpp/Functions/cbrt.hpp" #include "NumCpp/Functions/ceil.hpp" #include "NumCpp/Functions/centerOfMass.hpp" -#include "NumCpp/Functions/choose.hpp" #include "NumCpp/Functions/clip.hpp" #include "NumCpp/Functions/column_stack.hpp" #include "NumCpp/Functions/complex.hpp" diff --git a/include/NumCpp/Functions/choose.hpp b/include/NumCpp/Functions/choose.hpp deleted file mode 100644 index eb4b8310b..000000000 --- a/include/NumCpp/Functions/choose.hpp +++ /dev/null @@ -1,51 +0,0 @@ -/// @file -/// @author David Pilger -/// [GitHub Repository](https://github.com/dpilger26/NumCpp) -/// -/// License -/// Copyright 2018-2022 David Pilger -/// -/// Permission is hereby granted, free of charge, to any person obtaining a copy of this -/// software and associated documentation files(the "Software"), to deal in the Software -/// without restriction, including without limitation the rights to use, copy, modify, -/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to -/// permit persons to whom the Software is furnished to do so, subject to the following -/// conditions : -/// -/// The above copyright notice and this permission notice shall be included in all copies -/// or substantial portions of the Software. -/// -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, -/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR -/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE -/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR -/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -/// DEALINGS IN THE SOFTWARE. -/// -/// Description -/// Functions for working with NdArrays -/// -#pragma once - -#include - -#include "NumCpp/NdArray.hpp" - -namespace nc -{ - //============================================================================ - // Method Description: - /// Construct an array from an index array and a list of arrays to choose from. - /// - /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.choose.html - /// - /// @param a: int array. This array must contain integers in [0, n-1], where n is the number of choices - /// @param choices: Choice arrays. a and all of the choices must be broadcastable to the same shape. - /// @return NdArray - /// - // template choose(const NdArray& a, const std::vector*>& choices) - // { - - // } -} // namespace nc diff --git a/include/NumCpp/Functions/place.hpp b/include/NumCpp/Functions/place.hpp index 2abb6260f..498cf66af 100644 --- a/include/NumCpp/Functions/place.hpp +++ b/include/NumCpp/Functions/place.hpp @@ -28,6 +28,7 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/Error.hpp" namespace nc { @@ -40,13 +41,29 @@ namespace nc /// @param arr: Array to put data into. /// @param mask: Boolean mask array. Must have the same size as arr /// @param vals: Values to put into a. Only the first N elements are used, where N is the - /// number of True values in mask. If vals is smaller than N, it will be repeated, - /// and if elements of a are to be masked, this sequence must be non-empty. + /// number of True values in mask. If vals is smaller than N, it will be repeated. /// @return NdArray /// - // template - // NdArray place(const NdArray& arr, const NdArray& mask, const NdArray vals) - // { - - // } + template + void place(NdArray& arr, const NdArray& mask, const NdArray& vals) + { + if (mask.size() != arr.size()) + { + THROW_INVALID_ARGUMENT_ERROR("Input arguments 'arr' and 'mask' must have the same size."); + } + + if (vals.isempty()) + { + return; + } + + auto valIdx = 0; + for (auto i = 0; i < arr.size(); ++i) + { + if (mask[i]) + { + arr[i] = vals[valIdx++ % vals.size()]; + } + } + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index cb7065035..9e6dcf3ae 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -5422,6 +5422,29 @@ def test_percentile(): np.round(np.percentile(data, percentile, axis=1, interpolation='linear'), 9)) +#################################################################################### +def test_place(): + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + cMask = NumCpp.NdArrayBool(shape) + data = np.random.randint(0, 100, [shape.rows, shape.cols]).astype(float) + mask = np.random.randint(0, 2, [shape.rows, shape.cols]).astype(bool) + cArray.setArray(data) + cMask.setArray(mask) + replaceValues = np.random.randint(0, 100, [shape.size() // 2, ]) + cReplaceValues = NumCpp.NdArray(1, replaceValues.size) + cReplaceValues.setArray(replaceValues) + + assert np.array_equal(cArray.getNumpyArray(), data) + + NumCpp.place(cArray, cMask, cReplaceValues) + assert not np.array_equal(cArray.getNumpyArray(), data) + + np.place(data, mask, replaceValues) + assert np.array_equal(cArray.getNumpyArray(), data) + + #################################################################################### def test_polar(): components = np.random.rand(2).astype(float) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 5a7ba9d4b..e53778a47 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -7735,6 +7735,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("partition", &partition); m.def("partition", &partition); m.def("percentile", &percentile); + m.def("place", &place); m.def("polarScaler", &FunctionsInterface::polarScaler); m.def("polarArray", &FunctionsInterface::polarArray); m.def("powerArrayScaler", &FunctionsInterface::powerArrayScaler); From 695db408afae44dd36b672089c621bc3d81f4f72 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 11:06:37 -0700 Subject: [PATCH 16/31] added extract function --- include/NumCpp/Functions/extract.hpp | 27 ++++++++++++++++++++++----- include/NumCpp/Functions/place.hpp | 2 +- test/pytest/test_functions.py | 10 ++++++++++ test/src/NumCppPy.cpp | 9 +++++++++ 4 files changed, 42 insertions(+), 6 deletions(-) diff --git a/include/NumCpp/Functions/extract.hpp b/include/NumCpp/Functions/extract.hpp index d287c72a6..cfa90f7a9 100644 --- a/include/NumCpp/Functions/extract.hpp +++ b/include/NumCpp/Functions/extract.hpp @@ -28,6 +28,9 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/Error.hpp" + +#include namespace nc { @@ -41,9 +44,23 @@ namespace nc /// @param arr: Input array of the same size as condition /// @return NdArray /// - // template - // NdArray extract(const NdArray& condition, const NdArray& arr) - // { - - // } + template + NdArray extract(const NdArray& condition, const NdArray& arr) + { + if (condition.size() != arr.size()) + { + THROW_INVALID_ARGUMENT_ERROR("Input arguments 'condition' and 'arr' must have the same size."); + } + + std::vector values; + for (decltype(arr.size()) i = 0; i < arr.size(); ++i) + { + if (condition[i]) + { + values.push_back(arr[i]); + } + } + + return NdArray(values.begin(), values.end()); + } } // namespace nc diff --git a/include/NumCpp/Functions/place.hpp b/include/NumCpp/Functions/place.hpp index 498cf66af..7bc6b9465 100644 --- a/include/NumCpp/Functions/place.hpp +++ b/include/NumCpp/Functions/place.hpp @@ -58,7 +58,7 @@ namespace nc } auto valIdx = 0; - for (auto i = 0; i < arr.size(); ++i) + for (decltype(arr.size()) i = 0; i < arr.size(); ++i) { if (mask[i]) { diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index 9e6dcf3ae..c35348e7b 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -2616,6 +2616,16 @@ def test_equal(): assert np.array_equal(NumCpp.equal(cArray1, cArray2), np.equal(data1, data2)) +#################################################################################### +def test_extract(): + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + data = np.random.randint(0, 100, [shape.rows, shape.cols]).astype(float) + mask = np.random.randint(0, 2, [shape.rows, shape.cols]).astype(bool) + assert np.array_equal(NumCpp.extract(mask, data).flatten(), + np.extract(mask, data)) + + #################################################################################### def test_exp2(): value = np.abs(np.random.rand(1).item()) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index e53778a47..acaa0d381 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3027,6 +3027,14 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric extract(pbArray condition, pbArray arr) + { + return nc2pybind(nc::extract(pybind2nc(condition), pybind2nc(arr))); + } + + //================================================================================ + template auto expScaler(dtype inValue) -> decltype(exp(inValue)) // trailing return type to help gcc { @@ -7519,6 +7527,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("endianess", &endianess); m.def("equal", &FunctionsInterface::equal); m.def("equal", &FunctionsInterface::equal); + m.def("extract", &FunctionsInterface::extract); m.def("expScaler", &FunctionsInterface::expScaler); m.def("expScaler", &FunctionsInterface::expScaler); m.def("expArray", &FunctionsInterface::expArray); From a3e9b5459c08322b540b1933a65a8a789f60ab07 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 11:55:46 -0700 Subject: [PATCH 17/31] added inner function --- develop/ToDo.md | 2 -- include/NumCpp/Functions/inner.hpp | 19 +++++++++++++------ test/pytest/test_functions.py | 8 ++++++++ test/src/NumCppPy.cpp | 13 +++++++++++-- 4 files changed, 32 insertions(+), 10 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index 83242e733..90dd624b2 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -2,10 +2,8 @@ * `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html - * `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html * `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html * `hammingEncode`, my stuff - * `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html * `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy diff --git a/include/NumCpp/Functions/inner.hpp b/include/NumCpp/Functions/inner.hpp index d91cca2fd..64455daa4 100644 --- a/include/NumCpp/Functions/inner.hpp +++ b/include/NumCpp/Functions/inner.hpp @@ -28,12 +28,14 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/Error.hpp" +#include namespace nc { //============================================================================ // Method Description: - /// Inner product of two arrays. + /// Inner product of two 1-D arrays. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.inner.html /// @@ -41,9 +43,14 @@ namespace nc /// @param b: array 2 /// @return NdArray /// - // template - // NdArray inner(const NdArray& a, const NdArray& b) - // { - - // } + template + dtype inner(const NdArray& a, const NdArray& b) + { + if (a.size() != b.size()) + { + THROW_INVALID_ARGUMENT_ERROR("Inputs 'a' and 'b' must have the same size"); + } + + return std::inner_product(a.cbegin(), a.cend(), b.cbegin(), dtype{ 0 }); + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index c35348e7b..c38ce870c 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3326,6 +3326,14 @@ def test_imag(): assert np.array_equal(np.round(NumCpp.imagArray(cArray), 9), np.round(np.imag(data), 9)) +#################################################################################### +def test_inner(): + arraySize = np.random.randint(10, 100) + a = np.random.randint(0, 100, [arraySize, ]) + b = np.random.randint(0, 100, [arraySize, ]) + assert NumCpp.inner(a, b) == np.inner(a, b) + + #################################################################################### def test_interp(): endPoint = np.random.randint(10, 20, [1, ]).item() diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index acaa0d381..ab188a9e8 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3382,6 +3382,14 @@ namespace FunctionsInterface //================================================================================ + template + dtype inner(pbArray a, pbArray b) + { + return nc::inner(pybind2nc(a), pybind2nc(b)); + } + + //================================================================================ + template pbArrayGeneric interp(const NdArray& inX, const NdArray& inXp, const NdArray& inFp) { @@ -3404,7 +3412,7 @@ namespace FunctionsInterface return nc2pybind(nc::isinf(inArray)); } - //================================================================================ + //================================================================================ template bool isposinfScaler(dtype inValue) @@ -3420,7 +3428,7 @@ namespace FunctionsInterface return nc2pybind(nc::isposinf(inArray)); } - //================================================================================ + //================================================================================ template bool isneginfScaler(dtype inValue) @@ -7613,6 +7621,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("identityComplex", &identity); m.def("imagScaler", &FunctionsInterface::imagScaler); m.def("imagArray", &FunctionsInterface::imagArray); + m.def("inner", &FunctionsInterface::inner); m.def("interp", &FunctionsInterface::interp); m.def("intersect1d", &intersect1d); m.def("invert", &invert); From bb10a1e3609d907308ba8b9aa21e728ea3a69d2a Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 12:55:25 -0700 Subject: [PATCH 18/31] added logspace function --- develop/ToDo.md | 6 +++++- include/NumCpp/Functions/logspace.hpp | 16 +++++++++++++++- test/pytest/test_functions.py | 12 ++++++++++++ test/src/NumCppPy.cpp | 9 +++++++++ 4 files changed, 41 insertions(+), 2 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index 90dd624b2..46a4f6dc1 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -3,7 +3,11 @@ * `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html * `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html + +## Additional capability + * `hammingEncode`, my stuff - * `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html + +## Changes * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy diff --git a/include/NumCpp/Functions/logspace.hpp b/include/NumCpp/Functions/logspace.hpp index 2bd3842b1..324c101de 100644 --- a/include/NumCpp/Functions/logspace.hpp +++ b/include/NumCpp/Functions/logspace.hpp @@ -28,6 +28,9 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StlAlgorithms.hpp" +#include "NumCpp/Functions/linspace.hpp" +#include "NumCpp/Utils/powerf.hpp" namespace nc { @@ -45,8 +48,19 @@ namespace nc /// In that case, num + 1 values are spaced over the interval /// in log-space, of which all but the last (a sequence of length num) are returned. /// @param num: Number of samples to generate. Default 50. - /// @param enpoint: If true, stop is the last sample. Otherwide,it is not included. Default is true. + /// @param enpoint: If true, stop is the last sample. Otherwise,it is not included. Default is true. /// @return NdArray /// + template + NdArray logspace(dtype start, dtype stop, uint32 num = 50, bool endPoint = true, double base = 10.0) + { + auto spacedValues = linspace(static_cast(start), static_cast(stop), num, endPoint); + stl_algorithms::for_each(spacedValues.begin(), spacedValues.end(), + [base](auto& value) -> void + { + value = utils::powerf(base, value); + }); + return spacedValues; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index c38ce870c..34ad3e9a8 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3639,6 +3639,18 @@ def test_log(): assert np.array_equal(np.round(NumCpp.logArray(cArray), 9), np.round(np.log(data), 9)) +#################################################################################### +def test_logspace(): + start = np.random.randint(0, 100) + stop = np.random.randint(start + 1, 3 * start) + num = np.random.randint(1, 100) + base = np.random.rand(1) * 10 + assert np.array_equal(np.round(NumCpp.logspace(start, stop, num, True, base).flatten(), 9), + np.round(np.logspace(start=start, stop=stop, num=num, endpoint=True, base=base), 9)) + assert np.array_equal(np.round(NumCpp.logspace(start, stop, num, False, base).flatten(), 9), + np.round(np.logspace(start=start, stop=stop, num=num, endpoint=False, base=base), 9)) + + #################################################################################### def test_log10(): value = np.random.randn(1).item() * 100 + 1000 diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index ab188a9e8..49def86b0 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3565,6 +3565,14 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric logspace(dtype start, dtype stop, uint32 num, bool endPoint, double base) + { + return nc2pybind(nc::logspace(start, stop, num, endPoint, base)); + } + + //================================================================================ + template auto log10Scaler(dtype inValue) -> decltype(log10(inValue)) // trailing return type to help gcc { @@ -7656,6 +7664,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("logArray", &FunctionsInterface::logArray); m.def("logScaler", &FunctionsInterface::logScaler); m.def("logArray", &FunctionsInterface::logArray); + m.def("logspace", &FunctionsInterface::logspace); m.def("log10Scaler", &FunctionsInterface::log10Scaler); m.def("log10Array", &FunctionsInterface::log10Array); m.def("log10Scaler", &FunctionsInterface::log10Scaler); From 0f36052d83d1922ce1a7f7c9d54d00f5d807d503 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 13:47:47 -0700 Subject: [PATCH 19/31] added logb function --- develop/ToDo.md | 4 ++++ docs/markdown/ReleaseNotes.md | 2 +- include/NumCpp/Functions.hpp | 1 + test/pytest/test_functions.py | 14 ++++++++++++++ test/src/NumCppPy.cpp | 18 ++++++++++++++++++ 5 files changed, 38 insertions(+), 1 deletion(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index 46a4f6dc1..b47167d88 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -11,3 +11,7 @@ ## Changes * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy + +## Cleanup + + * cleanup all doxygen doc strings? diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index 51b48a9ed..26dfa0903 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -4,7 +4,6 @@ * added `bartlett`, https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html * added `blackman`, https://numpy.org/doc/stable/reference/generated/numpy.blackman.html -* added `choose`, https://numpy.org/doc/stable/reference/generated/numpy.choose.html * added `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html * added `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html * added `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html @@ -16,6 +15,7 @@ * added `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html * added `isposinf`, https://numpy.org/doc/stable/reference/generated/numpy.isposinf.html * added `kaiser`, https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html +* added `logb`, logarithm of with an arbitrary base b * added `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html * added `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html * added `select` function, https://numpy.org/doc/stable/reference/generated/numpy.select.html diff --git a/include/NumCpp/Functions.hpp b/include/NumCpp/Functions.hpp index 91505303f..418024399 100644 --- a/include/NumCpp/Functions.hpp +++ b/include/NumCpp/Functions.hpp @@ -165,6 +165,7 @@ #include "NumCpp/Functions/linspace.hpp" #include "NumCpp/Functions/load.hpp" #include "NumCpp/Functions/log.hpp" +#include "NumCpp/Functions/logb.hpp" #include "NumCpp/Functions/log10.hpp" #include "NumCpp/Functions/log1p.hpp" #include "NumCpp/Functions/log2.hpp" diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index 34ad3e9a8..b789d80d8 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3639,6 +3639,20 @@ def test_log(): assert np.array_equal(np.round(NumCpp.logArray(cArray), 9), np.round(np.log(data), 9)) +#################################################################################### +def test_logb(): + value = np.random.randn(1).item() * 100 + 1000 + base = np.random.randn(1).item() * 2 + 10 + assert np.round(NumCpp.logbScaler(value, base), 9) == np.round(np.log(value) / np.log(base), 9) + + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + data = np.random.randn(shape.rows, shape.cols) * 100 + 1000 + cArray.setArray(data) + assert np.array_equal(np.round(NumCpp.logbArray(cArray, base), 9), np.round(np.log(data) / np.log(base), 9)) + + #################################################################################### def test_logspace(): start = np.random.randint(0, 100) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 49def86b0..610d93694 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3565,6 +3565,22 @@ namespace FunctionsInterface //================================================================================ + template + auto logbScaler(dtype inValue, dtype base) -> decltype(logb(inValue)) // trailing return type to help gcc + { + return logb(inValue, base); + } + + //================================================================================ + + template + pbArrayGeneric logbArray(const NdArray& inArray, dtype base) + { + return nc2pybind(logb(inArray, base)); + } + + //================================================================================ + template pbArrayGeneric logspace(dtype start, dtype stop, uint32 num, bool endPoint, double base) { @@ -7664,6 +7680,8 @@ PYBIND11_MODULE(NumCppPy, m) m.def("logArray", &FunctionsInterface::logArray); m.def("logScaler", &FunctionsInterface::logScaler); m.def("logArray", &FunctionsInterface::logArray); + m.def("logbScaler", &FunctionsInterface::logbScaler); + m.def("logbArray", &FunctionsInterface::logbArray); m.def("logspace", &FunctionsInterface::logspace); m.def("log10Scaler", &FunctionsInterface::log10Scaler); m.def("log10Array", &FunctionsInterface::log10Array); From ef14c01932e2bfcaeb83d83aa1348d6192742fc8 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Mon, 3 Jan 2022 15:09:40 -0700 Subject: [PATCH 20/31] added nth_root and geomspace functions --- docs/markdown/ReleaseNotes.md | 1 + include/NumCpp/Functions.hpp | 1 + include/NumCpp/Functions/geomspace.hpp | 29 ++++++++++ include/NumCpp/Functions/inner.hpp | 3 + include/NumCpp/Functions/isneginf.hpp | 1 + include/NumCpp/Functions/isposinf.hpp | 1 + include/NumCpp/Functions/logb.hpp | 77 ++++++++++++++++++++++++++ include/NumCpp/Functions/logspace.hpp | 3 + include/NumCpp/Functions/nth_root.hpp | 74 +++++++++++++++++++++++++ test/pytest/test_functions.py | 23 ++++++++ test/src/NumCppPy.cpp | 27 +++++++++ 11 files changed, 240 insertions(+) create mode 100644 include/NumCpp/Functions/logb.hpp create mode 100644 include/NumCpp/Functions/nth_root.hpp diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index 26dfa0903..69d99e2dc 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -17,6 +17,7 @@ * added `kaiser`, https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html * added `logb`, logarithm of with an arbitrary base b * added `logspace`, https://numpy.org/doc/stable/reference/generated/numpy.logspace.html +* added `nth_root`, the nth root of a value * added `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html * added `select` function, https://numpy.org/doc/stable/reference/generated/numpy.select.html * `fmod` and the modulus `%` operator now work with float dtypes diff --git a/include/NumCpp/Functions.hpp b/include/NumCpp/Functions.hpp index 418024399..a8598be0f 100644 --- a/include/NumCpp/Functions.hpp +++ b/include/NumCpp/Functions.hpp @@ -205,6 +205,7 @@ #include "NumCpp/Functions/nbytes.hpp" #include "NumCpp/Functions/negative.hpp" #include "NumCpp/Functions/newbyteorder.hpp" +#include "NumCpp/Functions/nth_root.hpp" #include "NumCpp/Functions/none.hpp" #include "NumCpp/Functions/nonzero.hpp" #include "NumCpp/Functions/norm.hpp" diff --git a/include/NumCpp/Functions/geomspace.hpp b/include/NumCpp/Functions/geomspace.hpp index 0d4307b77..8abc0a267 100644 --- a/include/NumCpp/Functions/geomspace.hpp +++ b/include/NumCpp/Functions/geomspace.hpp @@ -28,6 +28,12 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/Error.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" +#include "NumCpp/Functions/logb.hpp" +#include "NumCpp/Functions/logspace.hpp" +#include "NumCpp/Functions/nth_root.hpp" +#include "NumCpp/Utils/essentiallyEqual.hpp" namespace nc { @@ -48,5 +54,28 @@ namespace nc /// @param enpoint: If true, stop is the last sample. Otherwide,it is not included. Default is true. /// @return NdArray /// + template + NdArray geomspace(dtype start, dtype stop, uint32 num = 50, bool endPoint = true) + { + STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); + if (utils::essentiallyEqual(start, dtype{0})) + { + THROW_INVALID_ARGUMENT_ERROR("Geometric sequence cannot include zero"); + } + + if (num == 1) + { + return { static_cast(start) }; + } + else if (num == 2 && endPoint) + { + return {static_cast(start), static_cast(stop)}; + } + + const auto base = nth_root(stop / start, num - 1); + const auto logStart = logb(start, base); + const auto logStop = logb(stop, base); + return logspace(logStart, logStop, num, endPoint, base); + } } // namespace nc diff --git a/include/NumCpp/Functions/inner.hpp b/include/NumCpp/Functions/inner.hpp index 64455daa4..7d213e001 100644 --- a/include/NumCpp/Functions/inner.hpp +++ b/include/NumCpp/Functions/inner.hpp @@ -29,6 +29,7 @@ #include "NumCpp/NdArray.hpp" #include "NumCpp/Core/Internal/Error.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" #include namespace nc @@ -46,6 +47,8 @@ namespace nc template dtype inner(const NdArray& a, const NdArray& b) { + STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); + if (a.size() != b.size()) { THROW_INVALID_ARGUMENT_ERROR("Inputs 'a' and 'b' must have the same size"); diff --git a/include/NumCpp/Functions/isneginf.hpp b/include/NumCpp/Functions/isneginf.hpp index 33ed5552a..b2305ef8a 100644 --- a/include/NumCpp/Functions/isneginf.hpp +++ b/include/NumCpp/Functions/isneginf.hpp @@ -28,6 +28,7 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" #include "NumCpp/Functions/isinf.hpp" namespace nc diff --git a/include/NumCpp/Functions/isposinf.hpp b/include/NumCpp/Functions/isposinf.hpp index 47e7d2884..7e1d00f98 100644 --- a/include/NumCpp/Functions/isposinf.hpp +++ b/include/NumCpp/Functions/isposinf.hpp @@ -28,6 +28,7 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" #include "NumCpp/Functions/isinf.hpp" namespace nc diff --git a/include/NumCpp/Functions/logb.hpp b/include/NumCpp/Functions/logb.hpp new file mode 100644 index 000000000..9fe8397a2 --- /dev/null +++ b/include/NumCpp/Functions/logb.hpp @@ -0,0 +1,77 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/Core/Internal/StaticAsserts.hpp" +#include "NumCpp/Core/Internal/StlAlgorithms.hpp" +#include "NumCpp/NdArray.hpp" + +#include +#include + +namespace nc +{ + //============================================================================ + // Method Description: + /// Logarithm of an arbitrary base + /// + /// @param inValue + /// @param inBase: the logorithm base + /// + /// @return value + /// + template + auto logb(dtype inValue, dtype inBase) noexcept + { + STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); + + return std::log(inValue) / std::log(inBase); + } + + //============================================================================ + // Method Description: + /// Logarithm of an arbitrary base + /// + /// @param inValue + /// @param inBase: the logorithm base + /// + /// @return NdArray + /// + template + auto logb(const NdArray& inArray, dtype inBase) + { + NdArray returnArray(inArray.shape()); + stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), + [inBase](dtype inValue) noexcept -> auto + { + return logb(inValue, inBase); + }); + + return returnArray; + } +} // namespace nc diff --git a/include/NumCpp/Functions/logspace.hpp b/include/NumCpp/Functions/logspace.hpp index 324c101de..e39f44aa3 100644 --- a/include/NumCpp/Functions/logspace.hpp +++ b/include/NumCpp/Functions/logspace.hpp @@ -28,6 +28,7 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" #include "NumCpp/Core/Internal/StlAlgorithms.hpp" #include "NumCpp/Functions/linspace.hpp" #include "NumCpp/Utils/powerf.hpp" @@ -54,6 +55,8 @@ namespace nc template NdArray logspace(dtype start, dtype stop, uint32 num = 50, bool endPoint = true, double base = 10.0) { + STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); + auto spacedValues = linspace(static_cast(start), static_cast(stop), num, endPoint); stl_algorithms::for_each(spacedValues.begin(), spacedValues.end(), [base](auto& value) -> void diff --git a/include/NumCpp/Functions/nth_root.hpp b/include/NumCpp/Functions/nth_root.hpp new file mode 100644 index 000000000..00fcd475d --- /dev/null +++ b/include/NumCpp/Functions/nth_root.hpp @@ -0,0 +1,74 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" +#include "NumCpp/Core/Internal/StlAlgorithms.hpp" +#include "NumCpp/Utils/powerf.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Return the nth-root of an value. + /// + /// @param inValue + /// @param inRoot + /// @return value + /// + template + double nth_root(dtype1 inValue, dtype2 inRoot) noexcept + { + STATIC_ASSERT_ARITHMETIC(dtype1); + STATIC_ASSERT_ARITHMETIC(dtype2); + + return utils::powerf(static_cast(inValue), 1.0 / static_cast(inRoot)); + } + + //============================================================================ + // Method Description: + /// Return the nth-root of an array. + /// + /// @param inArray + /// @param inRoot + /// @return NdArray + /// + template + NdArray nth_root(const NdArray& inArray, dtype2 inRoot) + { + NdArray returnArray(inArray.shape()); + stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(), + [inRoot](dtype1 inValue) noexcept -> double + { + return nth_root(inValue, inRoot); + }); + + return returnArray; + } +} // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index b789d80d8..0bf0fbef2 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -3106,6 +3106,17 @@ def test_gcd(): assert NumCpp.gcdArray(cArray) == np.gcd.reduce(data) # noqa +#################################################################################### +def test_geomspace(): + start = np.random.randint(0, 100) + stop = np.random.randint(start + 1, 3 * start) + num = np.random.randint(1, 100) + assert np.array_equal(np.round(NumCpp.geomspace(start, stop, num, True).flatten(), 9), + np.round(np.geomspace(start=start, stop=stop, num=num, endpoint=True), 9)) + assert np.array_equal(np.round(NumCpp.geomspace(start, stop, num, False).flatten(), 9), + np.round(np.geomspace(start=start, stop=stop, num=num, endpoint=False), 9)) + + #################################################################################### def test_gradient(): shapeInput = np.random.randint(20, 100, [2, ]) @@ -4961,6 +4972,18 @@ def test_newbyteorderArray(): data.newbyteorder()) +#################################################################################### +def test_nth_root(): + shapeInput = np.random.randint(20, 100, [2, ]) + shape = NumCpp.Shape(shapeInput[0].item(), shapeInput[1].item()) + cArray = NumCpp.NdArray(shape) + data = np.random.randint(0, 100, [shape.rows, shape.cols]).astype(float) + cArray.setArray(data) + root = np.random.rand(1).item() * 10 + assert np.array_equal(np.round(NumCpp.nth_rootArray(cArray, root), 9), + np.round(np.power(data, 1 / root), 9)) + + #################################################################################### def test_none(): shapeInput = np.random.randint(20, 100, [2, ]) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 610d93694..7adeecf23 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -3293,6 +3293,14 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric geomspace(dtype start, dtype stop, uint32 num, bool endPoint) + { + return nc2pybind(nc::geomspace(start, stop, num, endPoint)); + } + + //================================================================================ + template pbArrayGeneric gradient(const NdArray& inArray, Axis inAxis = Axis::NONE) { @@ -3717,6 +3725,22 @@ namespace FunctionsInterface //================================================================================ + template + double nth_rootScaler(dtype1 inValue, dtype2 inRoot) + { + return nth_root(inValue, inRoot); + } + + //================================================================================ + + template + pbArrayGeneric nth_rootArray(const NdArray& inArray, dtype2 inRoot) + { + return nc2pybind(nth_root(inArray, inRoot)); + } + + //================================================================================ + template pbArrayGeneric onesSquare(uint32 inSquareSize) { @@ -7625,6 +7649,7 @@ PYBIND11_MODULE(NumCppPy, m) #ifndef NUMCPP_NO_USE_BOOST m.def("gcdArray", &FunctionsInterface::gcdArray); #endif + m.def("geomspace", &FunctionsInterface::geomspace); m.def("greater", &greater); m.def("greater", &greater); m.def("greater_equal", &greater_equal); @@ -7753,6 +7778,8 @@ PYBIND11_MODULE(NumCppPy, m) m.def("negative", &negative); m.def("newbyteorderScaler", &FunctionsInterface::newbyteorderScaler); m.def("newbyteorderArray", &FunctionsInterface::newbyteorderArray); + m.def("nth_rootScaler", &FunctionsInterface::nth_rootScaler); + m.def("nth_rootArray", &FunctionsInterface::nth_rootArray); m.def("none", &FunctionsInterface::noneArray); m.def("none", &FunctionsInterface::noneArray); m.def("nonzero", &nonzero); From 378d1029e27f93aa874f95b9b92191b39236115f Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 11:01:24 -0700 Subject: [PATCH 21/31] added cov and corrcoef functions --- develop/ToDo.md | 6 ---- include/NumCpp/Functions/corrcoef.hpp | 26 +++++++++++--- include/NumCpp/Functions/cov.hpp | 50 ++++++++++++++++++++++++--- test/pytest/test_functions.py | 16 +++++++++ test/src/NumCppPy.cpp | 18 ++++++++++ 5 files changed, 100 insertions(+), 16 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index b47167d88..5eddb47db 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -1,9 +1,3 @@ - ## Functions to add: - - * `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html - * `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html - * `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html - ## Additional capability * `hammingEncode`, my stuff diff --git a/include/NumCpp/Functions/corrcoef.hpp b/include/NumCpp/Functions/corrcoef.hpp index 60fa86e83..f7b78688d 100644 --- a/include/NumCpp/Functions/corrcoef.hpp +++ b/include/NumCpp/Functions/corrcoef.hpp @@ -28,6 +28,10 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" +#include "NumCpp/Functions/cov.hpp" +#include "NumCpp/Functions/empty_like.hpp" +#include "NumCpp/Functions/sqrt.hpp" namespace nc { @@ -42,9 +46,21 @@ namespace nc /// of all those variables. /// @return NdArray /// - // template - // NdArray corrcoef(const NdArray& x) - // { - - // } + template + NdArray corrcoef(const NdArray& x) + { + STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype); + + const auto covariance = cov(x); + auto normalizedCovariance = empty_like(covariance); + for (decltype(covariance.numRows()) i = 0; i < covariance.numRows(); ++i) + { + for (decltype(covariance.numCols()) j = 0; j < covariance.numCols(); ++j) + { + normalizedCovariance(i, j) = covariance(i, j) / sqrt(covariance(i, i) * covariance(j, j)); + } + } + + return normalizedCovariance; + } } // namespace nc diff --git a/include/NumCpp/Functions/cov.hpp b/include/NumCpp/Functions/cov.hpp index 0eb153b33..45511f058 100644 --- a/include/NumCpp/Functions/cov.hpp +++ b/include/NumCpp/Functions/cov.hpp @@ -28,6 +28,10 @@ #pragma once #include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" +#include "NumCpp/Functions/mean.hpp" + +#include namespace nc { @@ -42,9 +46,45 @@ namespace nc /// of all those variables. /// @return NdArray /// - // template - // NdArray cov(const NdArray& x) - // { - - // } + template + NdArray cov(const NdArray& x) + { + STATIC_ASSERT_ARITHMETIC(dtype); + + const auto varMeans = mean(x, Axis::COL); + const auto numVars = x.numRows(); + const auto numObs = x.numCols(); + using IndexType = std::remove_const::type; + + // upper triangle + auto covariance = NdArray(numVars); + for (IndexType i = 0; i < numVars; ++i) + { + const auto var1Mean = varMeans[i]; + + for (IndexType j = i; j < numVars; ++j) + { + const auto var2Mean = varMeans[j]; + + double sum = 0.0; + for (IndexType iObs = 0; iObs < numObs; ++iObs) + { + sum += (x(i, iObs) - var1Mean) * (x(j, iObs) - var2Mean); + } + + covariance(i, j) = sum / static_cast(numObs - 1); + } + } + + // fill in the rest of the symmetric matrix + for (IndexType j = 0; j < numVars; ++j) + { + for (IndexType i = j + 1; i < numVars; ++i) + { + covariance(i, j) = covariance(j, i); + } + } + + return covariance; + } } // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index 0bf0fbef2..517711238 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -1725,6 +1725,14 @@ def test_copyto(): assert np.array_equal(NumCpp.copyto(cArray2, cArray1), data1) +#################################################################################### +def test_corrcoef(): + shape = np.random.randint(10, 50, [2, ]) + a = np.random.randint(0, 100, shape) + assert np.array_equal(np.round(NumCpp.corrcoef(a), 9), + np.round(np.corrcoef(a), 9)) + + #################################################################################### def test_cos(): value = np.abs(np.random.rand(1).item()) @@ -1824,6 +1832,14 @@ def test_count_nonzero(): assert np.array_equal(NumCpp.count_nonzero(cArray, NumCpp.Axis.COL).flatten(), np.count_nonzero(data, axis=1)) +#################################################################################### +def test_cov(): + shape = np.random.randint(10, 50, [2, ]) + a = np.random.randint(0, 100, shape) + assert np.array_equal(np.round(NumCpp.cov(a), 9), + np.round(np.cov(a), 9)) + + #################################################################################### def test_cross(): shape = NumCpp.Shape(1, 2) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 7adeecf23..16ab390fe 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -2843,6 +2843,14 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric corrcoef(pbArray x) + { + return nc2pybind(nc::corrcoef(pybind2nc(x))); + } + + //================================================================================ + template auto cosScaler(dtype inValue) -> decltype(cos(inValue)) // trailing return type to help gcc { @@ -2883,6 +2891,14 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric cov(pbArray x) + { + return nc2pybind(nc::cov(pybind2nc(x))); + } + + //================================================================================ + template pbArrayGeneric cubeArray(const NdArray& inArray) { @@ -7525,6 +7541,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("copy", &FunctionsInterface::copy); m.def("copysign", &FunctionsInterface::copySign); m.def("copyto", &FunctionsInterface::copyto); + m.def("corrcoef", &FunctionsInterface::corrcoef); m.def("cosScaler", &FunctionsInterface::cosScaler); m.def("cosScaler", &FunctionsInterface::cosScaler); m.def("cosArray", &FunctionsInterface::cosArray); @@ -7535,6 +7552,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("coshArray", &FunctionsInterface::coshArray); m.def("count_nonzero", &FunctionsInterface::count_nonzero); m.def("count_nonzero", &FunctionsInterface::count_nonzero); + m.def("cov", &FunctionsInterface::cov); m.def("cross", &cross); m.def("cross", &cross); m.def("cube", &FunctionsInterface::cubeArray); From 9e440c12ce8a2367a1509756816ff7f67cf64068 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 12:18:42 -0700 Subject: [PATCH 22/31] added bias input to cov function --- include/NumCpp/Functions/cov.hpp | 7 +++++-- test/pytest/test_functions.py | 6 ++++-- test/src/NumCppPy.cpp | 4 ++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/include/NumCpp/Functions/cov.hpp b/include/NumCpp/Functions/cov.hpp index 45511f058..96174cd2e 100644 --- a/include/NumCpp/Functions/cov.hpp +++ b/include/NumCpp/Functions/cov.hpp @@ -44,16 +44,19 @@ namespace nc /// @param x: A 1-D or 2-D array containing multiple variables and observations. /// Each row of x represents a variable, and each column a single observation /// of all those variables. + /// @param bias: Default normalization (false) is by (N - 1), where N is the number of observations + /// given (unbiased estimate). If bias is True, then normalization is by N. /// @return NdArray /// template - NdArray cov(const NdArray& x) + NdArray cov(const NdArray& x, bool bias = false) { STATIC_ASSERT_ARITHMETIC(dtype); const auto varMeans = mean(x, Axis::COL); const auto numVars = x.numRows(); const auto numObs = x.numCols(); + const auto normilizationFactor = bias ? static_cast(numObs) : static_cast(numObs - 1); using IndexType = std::remove_const::type; // upper triangle @@ -72,7 +75,7 @@ namespace nc sum += (x(i, iObs) - var1Mean) * (x(j, iObs) - var2Mean); } - covariance(i, j) = sum / static_cast(numObs - 1); + covariance(i, j) = sum / normilizationFactor; } } diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index 517711238..ba131d26c 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -1836,8 +1836,10 @@ def test_count_nonzero(): def test_cov(): shape = np.random.randint(10, 50, [2, ]) a = np.random.randint(0, 100, shape) - assert np.array_equal(np.round(NumCpp.cov(a), 9), - np.round(np.cov(a), 9)) + assert np.array_equal(np.round(NumCpp.cov(a, False), 9), + np.round(np.cov(a, bias=False), 9)) + assert np.array_equal(np.round(NumCpp.cov(a, True), 9), + np.round(np.cov(a, bias=True), 9)) #################################################################################### diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index 16ab390fe..ae51818b2 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -2892,9 +2892,9 @@ namespace FunctionsInterface //================================================================================ template - pbArrayGeneric cov(pbArray x) + pbArrayGeneric cov(pbArray x, bool bias) { - return nc2pybind(nc::cov(pybind2nc(x))); + return nc2pybind(nc::cov(pybind2nc(x), bias)); } //================================================================================ From ad5a7f84934ce9267d69861acaa103a0b71f93f8 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 13:21:17 -0700 Subject: [PATCH 23/31] added cov_inv function --- docs/markdown/ReleaseNotes.md | 1 + include/NumCpp/Functions.hpp | 1 + include/NumCpp/Functions/cov.hpp | 2 +- include/NumCpp/Functions/cov_inv.hpp | 55 ++++++++++++++++++++++++++++ test/pytest/test_functions.py | 11 +++++- test/src/NumCppPy.cpp | 9 +++++ 6 files changed, 77 insertions(+), 2 deletions(-) create mode 100644 include/NumCpp/Functions/cov_inv.hpp diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index 69d99e2dc..8cd4b2acd 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -6,6 +6,7 @@ * added `blackman`, https://numpy.org/doc/stable/reference/generated/numpy.blackman.html * added `corrcoef`, https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html * added `cov`, https://numpy.org/doc/stable/reference/generated/numpy.cov.html +* added `cov_inv`, the inverse covariance matrix, aka the concentration matrix * added `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html * added `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html * added `hamming`, https://numpy.org/doc/stable/reference/generated/numpy.hamming.html diff --git a/include/NumCpp/Functions.hpp b/include/NumCpp/Functions.hpp index a8598be0f..14ff093de 100644 --- a/include/NumCpp/Functions.hpp +++ b/include/NumCpp/Functions.hpp @@ -85,6 +85,7 @@ #include "NumCpp/Functions/corrcoef.hpp" #include "NumCpp/Functions/count_nonzero.hpp" #include "NumCpp/Functions/cov.hpp" +#include "NumCpp/Functions/cov_inv.hpp" #include "NumCpp/Functions/cross.hpp" #include "NumCpp/Functions/cube.hpp" #include "NumCpp/Functions/cumprod.hpp" diff --git a/include/NumCpp/Functions/cov.hpp b/include/NumCpp/Functions/cov.hpp index 96174cd2e..da0d9fe50 100644 --- a/include/NumCpp/Functions/cov.hpp +++ b/include/NumCpp/Functions/cov.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// Estimate a covariance matrix, given data and weights. + /// Estimate a covariance matrix. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.cov.html /// diff --git a/include/NumCpp/Functions/cov_inv.hpp b/include/NumCpp/Functions/cov_inv.hpp new file mode 100644 index 000000000..506e75ee0 --- /dev/null +++ b/include/NumCpp/Functions/cov_inv.hpp @@ -0,0 +1,55 @@ +/// @file +/// @author David Pilger +/// [GitHub Repository](https://github.com/dpilger26/NumCpp) +/// +/// License +/// Copyright 2018-2022 David Pilger +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy of this +/// software and associated documentation files(the "Software"), to deal in the Software +/// without restriction, including without limitation the rights to use, copy, modify, +/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to +/// permit persons to whom the Software is furnished to do so, subject to the following +/// conditions : +/// +/// The above copyright notice and this permission notice shall be included in all copies +/// or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE +/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +/// DEALINGS IN THE SOFTWARE. +/// +/// Description +/// Functions for working with NdArrays +/// +#pragma once + +#include "NumCpp/NdArray.hpp" +#include "NumCpp/Core/Internal/StaticAsserts.hpp" +#include "NumCpp/Functions/cov.hpp" +#include "NumCpp/Linalg/inv.hpp" + +namespace nc +{ + //============================================================================ + // Method Description: + /// Estimate an inverse covariance matrix, aka the concentration matrix + /// + /// @param x: A 1-D or 2-D array containing multiple variables and observations. + /// Each row of x represents a variable, and each column a single observation + /// of all those variables. + /// @param bias: Default normalization (false) is by (N - 1), where N is the number of observations + /// given (unbiased estimate). If bias is True, then normalization is by N. + /// @return NdArray + /// + template + NdArray cov_inv(const NdArray& x, bool bias = false) + { + STATIC_ASSERT_ARITHMETIC(dtype); + + return linalg::inv(cov(x, bias)); + } +} // namespace nc diff --git a/test/pytest/test_functions.py b/test/pytest/test_functions.py index ba131d26c..8a8ba0654 100644 --- a/test/pytest/test_functions.py +++ b/test/pytest/test_functions.py @@ -18,7 +18,7 @@ def factors(n): #################################################################################### def test_seed(): - np.random.seed(1) + np.random.seed(777) #################################################################################### @@ -1842,6 +1842,15 @@ def test_cov(): np.round(np.cov(a, bias=True), 9)) +#################################################################################### +def test_cov_inv(): + a = np.random.randint(0, 100, [5, 8]) + assert np.array_equal(np.round(NumCpp.cov_inv(a, False), 9), + np.round(np.linalg.inv(np.cov(a, bias=False)), 9)) + assert np.array_equal(np.round(NumCpp.cov_inv(a, True), 9), + np.round(np.linalg.inv(np.cov(a, bias=True)), 9)) + + #################################################################################### def test_cross(): shape = NumCpp.Shape(1, 2) diff --git a/test/src/NumCppPy.cpp b/test/src/NumCppPy.cpp index ae51818b2..894b59b39 100644 --- a/test/src/NumCppPy.cpp +++ b/test/src/NumCppPy.cpp @@ -2899,6 +2899,14 @@ namespace FunctionsInterface //================================================================================ + template + pbArrayGeneric cov_inv(pbArray x, bool bias) + { + return nc2pybind(nc::cov_inv(pybind2nc(x), bias)); + } + + //================================================================================ + template pbArrayGeneric cubeArray(const NdArray& inArray) { @@ -7553,6 +7561,7 @@ PYBIND11_MODULE(NumCppPy, m) m.def("count_nonzero", &FunctionsInterface::count_nonzero); m.def("count_nonzero", &FunctionsInterface::count_nonzero); m.def("cov", &FunctionsInterface::cov); + m.def("cov_inv", &FunctionsInterface::cov_inv); m.def("cross", &cross); m.def("cross", &cross); m.def("cube", &FunctionsInterface::cubeArray); From 902ffcaf6598c916b86039b96ee4ed62ba17dfd6 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 15:34:37 -0700 Subject: [PATCH 24/31] added hamming edac encode and decode --- develop/Hamming.hpp | 404 -------------------- docs/markdown/ReleaseNotes.md | 2 +- include/NumCpp/Core/Internal/TypeTraits.hpp | 19 +- include/NumCpp/Functions/hammingEncode.hpp | 403 ++++++++++++++++++- 4 files changed, 410 insertions(+), 418 deletions(-) delete mode 100644 develop/Hamming.hpp diff --git a/develop/Hamming.hpp b/develop/Hamming.hpp deleted file mode 100644 index 724ce0e2d..000000000 --- a/develop/Hamming.hpp +++ /dev/null @@ -1,404 +0,0 @@ -/// @file -/// @author David Pilger -/// [GitHub Repository](https://github.com/dpilger26/NumCpp) -/// -/// License -/// Copyright 2018-2022 David Pilger -/// -/// Permission is hereby granted, free of charge, to any person obtaining a copy of this -/// software and associated documentation files(the "Software"), to deal in the Software -/// without restriction, including without limitation the rights to use, copy, modify, -/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to -/// permit persons to whom the Software is furnished to do so, subject to the following -/// conditions : -/// -/// The above copyright notice and this permission notice shall be included in all copies -/// or substantial portions of the Software. -/// -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, -/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR -/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE -/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR -/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -/// DEALINGS IN THE SOFTWARE. -/// -/// Description -/// Hamming EDAC encoding https://en.wikipedia.org/wiki/Hamming_code -/// - -#pragma once - -#include -#include -#include -#include -#include -#include - -#include "boost/dynamic_bitset.hpp" - -#include "TypeTraits.hpp" - -namespace hamming -{ - namespace detail - { - /** - * @brief Tests if value is a power of two - * - * @param n integer value - * @return bool true if value is a power of two, else false - */ - template< - typename IntType, - std::enable_if_t, int> = 0 - > - constexpr bool isPowerOfTwo(IntType n) noexcept - { - // Returns true if the given non-negative integer n is a power of two. - return n != 0 && (n & (n - 1)) == 0; - } - - /** - * @brief Calculates the next power of two after n - * >>> _next_power_of_two(768) - * 1024 - * >>> _next_power_of_two(4) - * 8 - * - * @param n integer value - * @return next power of two - * @exception std::invalid_argument if input value is less than zero - */ - template< - typename IntType, - std::enable_if_t, int> = 0 - > - std::size_t nextPowerOfTwo(IntType n) - { - if (n < 0) - { - throw std::invalid_argument("Input value must be greater than or equal to zero."); - } - - if (isPowerOfTwo(n)) - { - return static_cast(n) << 1; - } - - return static_cast(std::pow(2, std::ceil(std::log2(n)))); - } - - /** - * @brief Calculates the first n powers of two - * - * @param n integer value - * @return first n powers of two - * @exception std::bad_alloc if unable to allocate for return vector - */ - template< - typename IntType, - std::enable_if_t, int> = 0 - > - std::vector powersOfTwo(IntType n) - { - auto i = std::size_t{ 0 }; - auto power = std::size_t{ 1 }; - auto powers = std::vector(); - powers.reserve(n); - - while (i < static_cast(n)) - { - powers.push_back(power); - power <<= 1; - ++i; - } - - return powers; - } - - /** - * @brief Calculates the number of needed Hamming SECDED parity bits to encode the data - * - * @param numDataBits the number of data bits to encode - * @return number of Hamming SECDED parity bits - * @exception std::invalid_argument if input value is less than zero - * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code - */ - template< - typename IntType, - std::enable_if_t, int> = 0 - > - std::size_t numSecdedParityBitsNeeded(IntType numDataBits) - { - const auto n = nextPowerOfTwo(numDataBits); - const auto lowerBin = static_cast(std::floor(std::log2(n))); - const auto upperBin = lowerBin + 1; - const auto dataBitBoundary = n - lowerBin - 1; - const auto numParityBits = numDataBits <= dataBitBoundary ? lowerBin + 1 : upperBin + 1; - - if (!isPowerOfTwo(numParityBits + numDataBits)) - { - throw std::runtime_error("input number of data bits is not a valid Hamming SECDED code configuration."); - } - - return numParityBits; - } - - /** - * @brief Returns the indices of all data bits covered by a specified parity bit in a bitstring - * of length numDataBits. The indices are relative to DATA BITSTRING ITSELF, NOT including - * parity bits. - * - * @param numDataBits the number of data bits to encode - * @param parityBit the parity bit number - * @return number of Hamming SECDED parity bits - * @exception std::invalid_argument if parityBit is not a power of two - * @exception std::bad_alloc if unable to allocate return vector - */ - template< - typename IntType1, - typename IntType2, - std::enable_if_t, int> = 0, - std::enable_if_t, int> = 0 - > - std::vector dataBitsCovered(IntType1 numDataBits, IntType2 parityBit) - { - if (!isPowerOfTwo(parityBit)) - { - throw std::invalid_argument("All hamming parity bits are indexed by powers of two."); - } - - std::size_t dataIndex = 1; // bit we're currently at in the DATA bitstring - std::size_t totalIndex = 3; // bit we're currently at in the OVERALL bitstring - auto parityBit_ = static_cast(parityBit); - - auto indices = std::vector(); - indices.reserve(numDataBits); // worst case - - while (dataIndex <= static_cast(numDataBits)) - { - const auto currentBitIsData = !isPowerOfTwo(totalIndex); - if (currentBitIsData && (totalIndex % (parityBit_ << 1)) >= parityBit_) - { - indices.push_back(dataIndex - 1); // adjust output to be zero indexed - } - - dataIndex += currentBitIsData ? 1 : 0; - ++totalIndex; - } - - return indices; - } - - /** - * @brief Calculates the overall parity of the data, assumes last bit is the parity bit itself - * - * @param data the data word - * @return overall parity bit value - */ - template - constexpr bool calculateParity(const std::bitset& data) noexcept - { - bool parity = false; - for (std::size_t i = 0; i < DataBits - 1; ++i) - { - parity ^= data[i]; - } - - return parity; - } - - /** - * @brief Calculates the overall parity of the data, assumes last bit is the parity bit itself - * - * @param data the data word - * @return overall parity bit value - */ - inline bool calculateParity(const boost::dynamic_bitset<>& data) noexcept - { - bool parity = false; - for (std::size_t i = 0; i < data.size() - 1; ++i) - { - parity ^= data[i]; - } - - return parity; - } - - /** - * @brief Calculates the specified Hamming parity bit (1, 2, 4, 8, etc.) for the given data. - * Assumes even parity to allow for easier computation of parity using XOR. - * - * @param data the data word - * @param parityBit the parity bit number - * @return parity bit value - * @exception std::invalid_argument if parityBit is not a power of two - * @exception std::bad_alloc if unable to allocate return vector - */ - template< - std::size_t DataBits, - typename IntType, - std::enable_if_t, int> = 0 - > - bool calculateParity(const std::bitset& data, IntType parityBit) - { - bool parity = false; - for (const auto i : dataBitsCovered(DataBits, parityBit)) - { - parity ^= data[i]; - } - - return parity; - } - - /** - * @brief Checks that the number of DataBits and EncodedBits are consistent - * - * @return the number of parity bits - * @exception std::runtime_error if DataBits and EncodedBits are not consistent - * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code - */ - template< - std::size_t DataBits, - std::size_t EncodedBits, - std::enable_if_t, int> = 0 - > - std::size_t checkBitsConsistent() - { - const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits); - if (numParityBits + DataBits != EncodedBits) - { - throw std::runtime_error("DataBits and EncodedBits are not consistent"); - } - - return numParityBits; - } - - /** - * @brief Returns the Hamming SECDED decoded bits from the endoded bits. Assumes that the - * DataBits and EncodedBits have been checks for consistancy already - * - * @param encodedBits the Hamming SECDED encoded word - * @return data bits from the encoded word - */ - template< - std::size_t DataBits, - std::size_t EncodedBits, - std::enable_if_t, int> = 0 - > - std::bitset extractData(const std::bitset& encodedBits) noexcept - { - auto dataBits = std::bitset(); - - std::size_t dataIndex = 0; - for (std::size_t encodedIndex = 0; encodedIndex < EncodedBits; ++encodedIndex) - { - if (!isPowerOfTwo(encodedIndex + 1)) - { - dataBits[dataIndex++] = encodedBits[encodedIndex]; - if (dataIndex == DataBits) - { - break; - } - } - } - - return dataBits; - } - } // namespace detail - - /** - * @brief Returns the Hamming SECDED encoded bits for the data bits - * - * @param dataBits the data bits to encode - * @return encoded data bits - * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code - */ - template - boost::dynamic_bitset<> encode(const std::bitset& dataBits) - { - const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits); - const auto numEncodedBits = numParityBits + DataBits; - - auto encodedBits = boost::dynamic_bitset<>(numEncodedBits); - - // set the parity bits - for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) // -1 because overall parity will be calculated seperately later - { - encodedBits[parityBit - 1] = detail::calculateParity(dataBits, parityBit); - } - - // set the data bits, switch to 1 based to make things easier for isPowerOfTwo - std::size_t dataBitIndex = 0; - for (std::size_t bitIndex = 1; bitIndex <= numEncodedBits - 1; ++bitIndex) // -1 to account for the overall parity bit - { - if (!detail::isPowerOfTwo(bitIndex)) - { - encodedBits[bitIndex - 1] = dataBits[dataBitIndex++]; - } - } - - // compute and set overall parity for the entire encoded data (not including the overall parity bit itself) - encodedBits[numEncodedBits - 1] = detail::calculateParity(encodedBits); // overall parity at the end - - // all done! - return encodedBits; - } - - /** - * @brief Returns the Hamming SECDED decoded bits for the enocoded bits - * - * @param encodedBits the encoded bits to decode - * @param decodedBits the output decoded bits - * @return int status (0=no errors, 1=1 corrected error, 2=2 errors detected) - * @exception std::runtime_error if DataBits and EncodedBits are not consistent - * @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code - */ - template< - std::size_t DataBits, - std::size_t EncodedBits, - std::enable_if_t, int> = 0 - > - int decode(std::bitset encodedBits, std::bitset& decodedBits) - { - const auto numParityBits = detail::checkBitsConsistent(); - - // the data bits, which may be corrupted - decodedBits = detail::extractData(encodedBits); - - // check the overall parity bit - const auto overallExpected = detail::calculateParity(encodedBits); - const auto overallActual = encodedBits[EncodedBits - 1]; - const auto overallCorrect = overallExpected == overallActual; - - // check individual parities - each parity bit's index (besides overall parity) is a power of two - std::size_t indexOfError = 0; - for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) - { - const auto expected = detail::calculateParity(decodedBits, parityBit); - const auto actual = encodedBits[parityBit - 1]; // -1 because parityBit is 1 based - if (expected != actual) - { - indexOfError += parityBit; - } - } - - // attempt to repair a single flipped bit or throw exception if more than one - if (overallCorrect && indexOfError != 0) - { - // two errors found - return 2; - } - else if (!overallCorrect && indexOfError != 0) - { - // one error found, flip the bit in error and we're good - encodedBits.flip(indexOfError - 1); - decodedBits = detail::extractData(encodedBits); - return 1; - } - - return 0; - } -} // namespace hamming -#endif // #ifndef HAMMING_H_ diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index 8cd4b2acd..ab6235934 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -10,7 +10,6 @@ * added `extract`, https://numpy.org/doc/stable/reference/generated/numpy.extract.html * added `geomspace`, https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html * added `hamming`, https://numpy.org/doc/stable/reference/generated/numpy.hamming.html -* added `hammingEncode`, https://en.wikipedia.org/wiki/Hamming_code * added `hanning`, https://numpy.org/doc/stable/reference/generated/numpy.hanning.html * added `inner`, https://numpy.org/doc/stable/reference/generated/numpy.inner.html * added `isneginf`, https://numpy.org/doc/stable/reference/generated/numpy.isneginf.html @@ -22,6 +21,7 @@ * added `place`, https://numpy.org/doc/stable/reference/generated/numpy.place.html * added `select` function, https://numpy.org/doc/stable/reference/generated/numpy.select.html * `fmod` and the modulus `%` operator now work with float dtypes +* added Hamming EDAC (Error Dectection and Correction) `encode` and `decode` functions, https://en.wikipedia.org/wiki/Hamming_code * minor performance improvements ## Version 2.6.2 diff --git a/include/NumCpp/Core/Internal/TypeTraits.hpp b/include/NumCpp/Core/Internal/TypeTraits.hpp index 5c307787b..23ad857a5 100644 --- a/include/NumCpp/Core/Internal/TypeTraits.hpp +++ b/include/NumCpp/Core/Internal/TypeTraits.hpp @@ -185,8 +185,25 @@ namespace nc //============================================================================ // Class Description: - /// std::is_complex helper + /// is_complex helper /// template constexpr bool is_complex_v = is_complex::value; + + //============================================================================ + // Class Description: + /// type trait to test if one value is larger than another at compile time + /// + template + struct greaterThan + { + static constexpr bool value = Value1 > Value2; + }; + + //============================================================================ + // Class Description: + /// greaterThan helper + /// + template + constexpr bool greaterThan_v = greaterThan::value; } // namespace nc diff --git a/include/NumCpp/Functions/hammingEncode.hpp b/include/NumCpp/Functions/hammingEncode.hpp index 466a92994..f3f7fe045 100644 --- a/include/NumCpp/Functions/hammingEncode.hpp +++ b/include/NumCpp/Functions/hammingEncode.hpp @@ -23,21 +23,400 @@ /// DEALINGS IN THE SOFTWARE. /// /// Description -/// Functions for working with NdArrays +/// Hamming EDAC encoding https://en.wikipedia.org/wiki/Hamming_code /// + #pragma once -#include "NumCpp/NdArray.hpp" +#ifndef NUMCPP_NO_USE_BOOST + +#include +#include +#include +#include +#include +#include + +#include "boost/dynamic_bitset.hpp" + +#include "NumCpp/Core/Internal/TypeTraits.hpp" namespace nc { - //============================================================================ - // Method Description: - /// Hamming SECDED EDAC encoding and decoding - /// https://en.wikipedia.org/wiki/Hamming_code - /// - /// @param - /// @return NdArray - /// - -} // namespace nc + namespace edac::detail + { + //============================================================================ + // Method Description: + /// @brief Tests if value is a power of two + /// + /// @param n integer value + /// @return bool true if value is a power of two, else false + /// + template< + typename IntType, + std::enable_if_t, int> = 0 + > + constexpr bool isPowerOfTwo(IntType n) noexcept + { + // Returns true if the given non-negative integer n is a power of two. + return n != 0 && (n & (n - 1)) == 0; + } + + //============================================================================ + // Method Description: + /// Calculates the next power of two after n + /// >>> _next_power_of_two(768) + /// 1024 + /// >>> _next_power_of_two(4) + /// 8 + /// + /// @param n integer value + /// @return next power of two + /// @exception std::invalid_argument if input value is less than zero + //// + template< + typename IntType, + std::enable_if_t, int> = 0 + > + std::size_t nextPowerOfTwo(IntType n) + { + if (n < 0) + { + throw std::invalid_argument("Input value must be greater than or equal to zero."); + } + + if (isPowerOfTwo(n)) + { + return static_cast(n) << 1; + } + + return static_cast(std::pow(2, std::ceil(std::log2(n)))); + } + + //============================================================================ + // Method Description: + /// Calculates the first n powers of two + /// + /// @param n integer value + /// @return first n powers of two + /// @exception std::bad_alloc if unable to allocate for return vector + /// + template< + typename IntType, + std::enable_if_t, int> = 0 + > + std::vector powersOfTwo(IntType n) + { + auto i = std::size_t{ 0 }; + auto power = std::size_t{ 1 }; + auto powers = std::vector(); + powers.reserve(n); + + while (i < static_cast(n)) + { + powers.push_back(power); + power <<= 1; + ++i; + } + + return powers; + } + + //============================================================================ + // Method Description: + /// Calculates the number of needed Hamming SECDED parity bits to encode the data + /// + /// @param numDataBits the number of data bits to encode + /// @return number of Hamming SECDED parity bits + /// @exception std::invalid_argument if input value is less than zero + /// @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + /// + template< + typename IntType, + std::enable_if_t, int> = 0 + > + std::size_t numSecdedParityBitsNeeded(IntType numDataBits) + { + const auto n = nextPowerOfTwo(numDataBits); + const auto lowerBin = static_cast(std::floor(std::log2(n))); + const auto upperBin = lowerBin + 1; + const auto dataBitBoundary = n - lowerBin - 1; + const auto numParityBits = numDataBits <= dataBitBoundary ? lowerBin + 1 : upperBin + 1; + + if (!isPowerOfTwo(numParityBits + numDataBits)) + { + throw std::runtime_error("input number of data bits is not a valid Hamming SECDED code configuration."); + } + + return numParityBits; + } + + //============================================================================ + // Method Description: + /// Returns the indices of all data bits covered by a specified parity bit in a bitstring + /// of length numDataBits. The indices are relative to DATA BITSTRING ITSELF, NOT including + /// parity bits. + /// + /// @param numDataBits the number of data bits to encode + /// @param parityBit the parity bit number + /// @return number of Hamming SECDED parity bits + /// @exception std::invalid_argument if parityBit is not a power of two + /// @exception std::bad_alloc if unable to allocate return vector + /// + template< + typename IntType1, + typename IntType2, + std::enable_if_t, int> = 0, + std::enable_if_t, int> = 0 + > + std::vector dataBitsCovered(IntType1 numDataBits, IntType2 parityBit) + { + if (!isPowerOfTwo(parityBit)) + { + throw std::invalid_argument("All hamming parity bits are indexed by powers of two."); + } + + std::size_t dataIndex = 1; // bit we're currently at in the DATA bitstring + std::size_t totalIndex = 3; // bit we're currently at in the OVERALL bitstring + auto parityBit_ = static_cast(parityBit); + + auto indices = std::vector(); + indices.reserve(numDataBits); // worst case + + while (dataIndex <= static_cast(numDataBits)) + { + const auto currentBitIsData = !isPowerOfTwo(totalIndex); + if (currentBitIsData && (totalIndex % (parityBit_ << 1)) >= parityBit_) + { + indices.push_back(dataIndex - 1); // adjust output to be zero indexed + } + + dataIndex += currentBitIsData ? 1 : 0; + ++totalIndex; + } + + return indices; + } + + //============================================================================ + // Method Description: + /// Calculates the overall parity of the data, assumes last bit is the parity bit itself + /// + /// @param data the data word + /// @return overall parity bit value + /// + template + constexpr bool calculateParity(const std::bitset& data) noexcept + { + bool parity = false; + for (std::size_t i = 0; i < DataBits - 1; ++i) + { + parity ^= data[i]; + } + + return parity; + } + + //============================================================================ + // Method Description: + /// Calculates the overall parity of the data, assumes last bit is the parity bit itself + /// + /// @param data the data word + /// @return overall parity bit value + /// + inline bool calculateParity(const boost::dynamic_bitset<>& data) noexcept + { + bool parity = false; + for (std::size_t i = 0; i < data.size() - 1; ++i) + { + parity ^= data[i]; + } + + return parity; + } + + //============================================================================ + // Method Description: + /// Calculates the specified Hamming parity bit (1, 2, 4, 8, etc.) for the given data. + /// Assumes even parity to allow for easier computation of parity using XOR. + /// + /// @param data the data word + /// @param parityBit the parity bit number + /// @return parity bit value + /// @exception std::invalid_argument if parityBit is not a power of two + /// @exception std::bad_alloc if unable to allocate return vector + /// + template< + std::size_t DataBits, + typename IntType, + std::enable_if_t, int> = 0 + > + bool calculateParity(const std::bitset& data, IntType parityBit) + { + bool parity = false; + for (const auto i : dataBitsCovered(DataBits, parityBit)) + { + parity ^= data[i]; + } + + return parity; + } + + //============================================================================ + // Method Description: + /// Checks that the number of DataBits and EncodedBits are consistent + /// + /// @return the number of parity bits + /// @exception std::runtime_error if DataBits and EncodedBits are not consistent + /// @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + /// + template< + std::size_t DataBits, + std::size_t EncodedBits, + std::enable_if_t, int> = 0 + > + std::size_t checkBitsConsistent() + { + const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits); + if (numParityBits + DataBits != EncodedBits) + { + throw std::runtime_error("DataBits and EncodedBits are not consistent"); + } + + return numParityBits; + } + + //============================================================================ + // Method Description: + /// Returns the Hamming SECDED decoded bits from the endoded bits. Assumes that the + /// DataBits and EncodedBits have been checks for consistancy already + /// + /// @param encodedBits the Hamming SECDED encoded word + /// @return data bits from the encoded word + /// + template< + std::size_t DataBits, + std::size_t EncodedBits, + std::enable_if_t, int> = 0 + > + std::bitset extractData(const std::bitset& encodedBits) noexcept + { + auto dataBits = std::bitset(); + + std::size_t dataIndex = 0; + for (std::size_t encodedIndex = 0; encodedIndex < EncodedBits; ++encodedIndex) + { + if (!isPowerOfTwo(encodedIndex + 1)) + { + dataBits[dataIndex++] = encodedBits[encodedIndex]; + if (dataIndex == DataBits) + { + break; + } + } + } + + return dataBits; + } + } // namespace edac::detail + + namespace edac + { + //============================================================================ + // Method Description: + /// Returns the Hamming SECDED encoded bits for the data bits + /// + /// @param dataBits the data bits to encode + /// @return encoded data bits + /// @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + /// + template + boost::dynamic_bitset<> encode(const std::bitset& dataBits) + { + const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits); + const auto numEncodedBits = numParityBits + DataBits; + + auto encodedBits = boost::dynamic_bitset<>(numEncodedBits); + + // set the parity bits + for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) // -1 because overall parity will be calculated seperately later + { + encodedBits[parityBit - 1] = detail::calculateParity(dataBits, parityBit); + } + + // set the data bits, switch to 1 based to make things easier for isPowerOfTwo + std::size_t dataBitIndex = 0; + for (std::size_t bitIndex = 1; bitIndex <= numEncodedBits - 1; ++bitIndex) // -1 to account for the overall parity bit + { + if (!detail::isPowerOfTwo(bitIndex)) + { + encodedBits[bitIndex - 1] = dataBits[dataBitIndex++]; + } + } + + // compute and set overall parity for the entire encoded data (not including the overall parity bit itself) + encodedBits[numEncodedBits - 1] = detail::calculateParity(encodedBits); // overall parity at the end + + // all done! + return encodedBits; + } + + //============================================================================ + // Method Description: + /// Returns the Hamming SECDED decoded bits for the enocoded bits + /// https://en.wikipedia.org/wiki/Hamming_code + /// + /// @param encodedBits the encoded bits to decode + /// @param decodedBits the output decoded bits + /// @return int status (0=no errors, 1=1 corrected error, 2=2 errors detected) + /// @exception std::runtime_error if DataBits and EncodedBits are not consistent + /// @exception std::runtime_error if the number of data bits does not represent a valid Hamming SECDED code + /// + template< + std::size_t DataBits, + std::size_t EncodedBits, + std::enable_if_t, int> = 0 + > + int decode(std::bitset encodedBits, std::bitset& decodedBits) + { + const auto numParityBits = detail::checkBitsConsistent(); + + // the data bits, which may be corrupted + decodedBits = detail::extractData(encodedBits); + + // check the overall parity bit + const auto overallExpected = detail::calculateParity(encodedBits); + const auto overallActual = encodedBits[EncodedBits - 1]; + const auto overallCorrect = overallExpected == overallActual; + + // check individual parities - each parity bit's index (besides overall parity) is a power of two + std::size_t indexOfError = 0; + for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) + { + const auto expected = detail::calculateParity(decodedBits, parityBit); + const auto actual = encodedBits[parityBit - 1]; // -1 because parityBit is 1 based + if (expected != actual) + { + indexOfError += parityBit; + } + } + + // attempt to repair a single flipped bit or throw exception if more than one + if (overallCorrect && indexOfError != 0) + { + // two errors found + return 2; + } + else if (!overallCorrect && indexOfError != 0) + { + // one error found, flip the bit in error and we're good + encodedBits.flip(indexOfError - 1); + decodedBits = detail::extractData(encodedBits); + return 1; + } + + return 0; + } + } // namespace edac +} // namespace nc +#endif // #ifndef NUMCPP_NO_USE_BOOST From 67d40e04a48d54fda91449c74b722223c6d411c7 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 15:41:50 -0700 Subject: [PATCH 25/31] fixed a compiler warning in astype --- include/NumCpp/NdArray/NdArrayCore.hpp | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index 384e6edb3..6d9a16466 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -2227,20 +2227,12 @@ namespace nc NdArray astype() const { NdArray outArray(shape_); - - if (is_same_v) - { - std::copy(cbegin(), cend(), outArray.begin()); - } - else - { - const auto function = [](dtype value) -> dtypeOut + stl_algorithms::transform(cbegin(), cend(), outArray.begin(), + [](dtype value) -> dtypeOut { return static_cast(value); - }; - - stl_algorithms::transform(cbegin(), cend(), outArray.begin(), function); - } + } + ); return outArray; } From 1aa1be5d6aabf49f7c7d15b33536db312e2b3829 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 15:57:05 -0700 Subject: [PATCH 26/31] minor white space reformating --- develop/ToDo.md | 4 - include/NumCpp/Coordinates/Coordinate.hpp | 52 +- include/NumCpp/Coordinates/Dec.hpp | 34 +- include/NumCpp/Coordinates/RA.hpp | 30 +- .../NumCpp/Coordinates/degreeSeperation.hpp | 6 +- .../NumCpp/Coordinates/radianSeperation.hpp | 6 +- include/NumCpp/Core/DataCube.hpp | 76 +- include/NumCpp/Core/DtypeInfo.hpp | 36 +- include/NumCpp/Core/Internal/Endian.hpp | 4 +- include/NumCpp/Core/Internal/Error.hpp | 2 +- include/NumCpp/Core/Internal/Filesystem.hpp | 16 +- .../Core/Internal/StdComplexOperators.hpp | 10 +- .../NumCpp/Core/Internal/StlAlgorithms.hpp | 76 +- include/NumCpp/Core/Internal/TypeTraits.hpp | 40 +- include/NumCpp/Core/Shape.hpp | 26 +- include/NumCpp/Core/Slice.hpp | 28 +- include/NumCpp/Core/Timer.hpp | 16 +- include/NumCpp/Core/Types.hpp | 4 +- .../Boundaries/Boundaries1d/addBoundary1d.hpp | 4 +- .../Boundaries/Boundaries1d/constant1d.hpp | 4 +- .../Boundaries/Boundaries1d/mirror1d.hpp | 4 +- .../Boundaries/Boundaries1d/nearest1d.hpp | 4 +- .../Boundaries/Boundaries1d/reflect1d.hpp | 2 +- .../Boundaries1d/trimBoundary1d.hpp | 4 +- .../Filter/Boundaries/Boundaries1d/wrap1d.hpp | 4 +- .../Boundaries/Boundaries2d/addBoundary2d.hpp | 4 +- .../Boundaries/Boundaries2d/constant2d.hpp | 4 +- .../Boundaries/Boundaries2d/fillCorners.hpp | 4 +- .../Boundaries/Boundaries2d/mirror2d.hpp | 4 +- .../Boundaries/Boundaries2d/nearest2d.hpp | 4 +- .../Boundaries/Boundaries2d/reflect2d.hpp | 4 +- .../Boundaries2d/trimBoundary2d.hpp | 4 +- .../Filter/Boundaries/Boundaries2d/wrap2d.hpp | 4 +- include/NumCpp/Filter/Boundaries/Boundary.hpp | 2 +- .../Filters1d/complementaryMedianFilter1d.hpp | 4 +- .../Filter/Filters/Filters1d/convolve1d.hpp | 6 +- .../Filters/Filters1d/gaussianFilter1d.hpp | 6 +- .../Filters/Filters1d/maximumFilter1d.hpp | 6 +- .../Filters/Filters1d/medianFilter1d.hpp | 6 +- .../Filters/Filters1d/minimumFilter1d.hpp | 6 +- .../Filters/Filters1d/percentileFilter1d.hpp | 6 +- .../Filter/Filters/Filters1d/rankFilter1d.hpp | 6 +- .../Filters/Filters1d/uniformFilter1d.hpp | 6 +- .../Filters2d/complementaryMedianFilter.hpp | 4 +- .../Filter/Filters/Filters2d/convolve.hpp | 6 +- .../Filters/Filters2d/gaussianFilter.hpp | 6 +- .../Filter/Filters/Filters2d/laplace.hpp | 6 +- .../Filters/Filters2d/maximumFilter.hpp | 6 +- .../Filter/Filters/Filters2d/medianFilter.hpp | 6 +- .../Filters/Filters2d/minimumFilter.hpp | 6 +- .../Filters/Filters2d/percentileFilter.hpp | 6 +- .../Filter/Filters/Filters2d/rankFilter.hpp | 6 +- .../Filters/Filters2d/uniformFilter.hpp | 6 +- include/NumCpp/Functions/abs.hpp | 16 +- include/NumCpp/Functions/add.hpp | 54 +- include/NumCpp/Functions/alen.hpp | 6 +- include/NumCpp/Functions/all.hpp | 6 +- include/NumCpp/Functions/allclose.hpp | 8 +- include/NumCpp/Functions/amax.hpp | 6 +- include/NumCpp/Functions/amin.hpp | 6 +- include/NumCpp/Functions/angle.hpp | 16 +- include/NumCpp/Functions/any.hpp | 6 +- include/NumCpp/Functions/append.hpp | 10 +- include/NumCpp/Functions/applyFunction.hpp | 6 +- include/NumCpp/Functions/applyPoly1d.hpp | 4 +- include/NumCpp/Functions/arange.hpp | 58 +- include/NumCpp/Functions/arccos.hpp | 16 +- include/NumCpp/Functions/arccosh.hpp | 16 +- include/NumCpp/Functions/arcsin.hpp | 16 +- include/NumCpp/Functions/arcsinh.hpp | 16 +- include/NumCpp/Functions/arctan.hpp | 16 +- include/NumCpp/Functions/arctan2.hpp | 12 +- include/NumCpp/Functions/arctanh.hpp | 16 +- include/NumCpp/Functions/argmax.hpp | 6 +- include/NumCpp/Functions/argmin.hpp | 6 +- include/NumCpp/Functions/argsort.hpp | 6 +- include/NumCpp/Functions/argwhere.hpp | 6 +- include/NumCpp/Functions/around.hpp | 12 +- include/NumCpp/Functions/array_equal.hpp | 6 +- include/NumCpp/Functions/array_equiv.hpp | 10 +- include/NumCpp/Functions/asarray.hpp | 134 +-- include/NumCpp/Functions/astype.hpp | 6 +- include/NumCpp/Functions/average.hpp | 18 +- include/NumCpp/Functions/bartlett.hpp | 2 +- include/NumCpp/Functions/binaryRepr.hpp | 6 +- include/NumCpp/Functions/bincount.hpp | 40 +- include/NumCpp/Functions/bitwise_and.hpp | 6 +- include/NumCpp/Functions/bitwise_not.hpp | 6 +- include/NumCpp/Functions/bitwise_or.hpp | 6 +- include/NumCpp/Functions/bitwise_xor.hpp | 6 +- include/NumCpp/Functions/blackman.hpp | 2 +- include/NumCpp/Functions/byteswap.hpp | 6 +- include/NumCpp/Functions/cbrt.hpp | 12 +- include/NumCpp/Functions/ceil.hpp | 8 +- include/NumCpp/Functions/centerOfMass.hpp | 2 +- include/NumCpp/Functions/clip.hpp | 12 +- include/NumCpp/Functions/column_stack.hpp | 8 +- include/NumCpp/Functions/complex.hpp | 16 +- include/NumCpp/Functions/concatenate.hpp | 6 +- include/NumCpp/Functions/conj.hpp | 16 +- include/NumCpp/Functions/contains.hpp | 4 +- include/NumCpp/Functions/copy.hpp | 8 +- include/NumCpp/Functions/copySign.hpp | 6 +- include/NumCpp/Functions/copyto.hpp | 6 +- include/NumCpp/Functions/corrcoef.hpp | 6 +- include/NumCpp/Functions/cos.hpp | 16 +- include/NumCpp/Functions/cosh.hpp | 16 +- include/NumCpp/Functions/count_nonzero.hpp | 6 +- include/NumCpp/Functions/cov.hpp | 8 +- include/NumCpp/Functions/cov_inv.hpp | 8 +- include/NumCpp/Functions/cross.hpp | 6 +- include/NumCpp/Functions/cube.hpp | 12 +- include/NumCpp/Functions/cumprod.hpp | 6 +- include/NumCpp/Functions/cumsum.hpp | 6 +- include/NumCpp/Functions/deg2rad.hpp | 16 +- include/NumCpp/Functions/degrees.hpp | 16 +- include/NumCpp/Functions/deleteIndices.hpp | 12 +- include/NumCpp/Functions/diag.hpp | 8 +- include/NumCpp/Functions/diagflat.hpp | 6 +- include/NumCpp/Functions/diagonal.hpp | 6 +- include/NumCpp/Functions/diff.hpp | 8 +- include/NumCpp/Functions/divide.hpp | 54 +- include/NumCpp/Functions/dot.hpp | 20 +- include/NumCpp/Functions/dump.hpp | 6 +- include/NumCpp/Functions/empty.hpp | 14 +- include/NumCpp/Functions/empty_like.hpp | 8 +- include/NumCpp/Functions/endianess.hpp | 6 +- include/NumCpp/Functions/equal.hpp | 6 +- include/NumCpp/Functions/exp.hpp | 16 +- include/NumCpp/Functions/exp2.hpp | 16 +- include/NumCpp/Functions/expm1.hpp | 16 +- include/NumCpp/Functions/extract.hpp | 2 +- include/NumCpp/Functions/eye.hpp | 24 +- include/NumCpp/Functions/fillDiagnol.hpp | 4 +- include/NumCpp/Functions/find.hpp | 4 +- include/NumCpp/Functions/fix.hpp | 16 +- include/NumCpp/Functions/flatnonzero.hpp | 8 +- include/NumCpp/Functions/flatten.hpp | 6 +- include/NumCpp/Functions/flip.hpp | 6 +- include/NumCpp/Functions/fliplr.hpp | 8 +- include/NumCpp/Functions/flipud.hpp | 8 +- include/NumCpp/Functions/floor.hpp | 8 +- include/NumCpp/Functions/floor_divide.hpp | 12 +- include/NumCpp/Functions/fmax.hpp | 20 +- include/NumCpp/Functions/fmin.hpp | 20 +- include/NumCpp/Functions/fmod.hpp | 18 +- include/NumCpp/Functions/frombuffer.hpp | 6 +- include/NumCpp/Functions/fromfile.hpp | 12 +- include/NumCpp/Functions/fromiter.hpp | 6 +- include/NumCpp/Functions/full.hpp | 18 +- include/NumCpp/Functions/full_like.hpp | 6 +- include/NumCpp/Functions/gcd.hpp | 20 +- include/NumCpp/Functions/geomspace.hpp | 6 +- include/NumCpp/Functions/gradient.hpp | 12 +- include/NumCpp/Functions/greater.hpp | 6 +- include/NumCpp/Functions/greater_equal.hpp | 6 +- include/NumCpp/Functions/hamming.hpp | 2 +- include/NumCpp/Functions/hammingEncode.hpp | 8 +- include/NumCpp/Functions/hanning.hpp | 2 +- include/NumCpp/Functions/histogram.hpp | 14 +- include/NumCpp/Functions/hstack.hpp | 8 +- include/NumCpp/Functions/hypot.hpp | 24 +- include/NumCpp/Functions/identity.hpp | 10 +- include/NumCpp/Functions/imag.hpp | 16 +- include/NumCpp/Functions/inner.hpp | 2 +- include/NumCpp/Functions/interp.hpp | 16 +- include/NumCpp/Functions/intersect1d.hpp | 8 +- include/NumCpp/Functions/invert.hpp | 8 +- include/NumCpp/Functions/isclose.hpp | 12 +- include/NumCpp/Functions/isinf.hpp | 16 +- include/NumCpp/Functions/isnan.hpp | 16 +- include/NumCpp/Functions/isneginf.hpp | 12 +- include/NumCpp/Functions/isposinf.hpp | 12 +- include/NumCpp/Functions/kaiser.hpp | 2 +- include/NumCpp/Functions/lcm.hpp | 18 +- include/NumCpp/Functions/ldexp.hpp | 12 +- include/NumCpp/Functions/left_shift.hpp | 6 +- include/NumCpp/Functions/less.hpp | 6 +- include/NumCpp/Functions/less_equal.hpp | 6 +- include/NumCpp/Functions/linspace.hpp | 16 +- include/NumCpp/Functions/load.hpp | 8 +- include/NumCpp/Functions/log.hpp | 16 +- include/NumCpp/Functions/log10.hpp | 16 +- include/NumCpp/Functions/log1p.hpp | 20 +- include/NumCpp/Functions/log2.hpp | 16 +- include/NumCpp/Functions/logb.hpp | 4 +- include/NumCpp/Functions/logical_and.hpp | 6 +- include/NumCpp/Functions/logical_not.hpp | 8 +- include/NumCpp/Functions/logical_or.hpp | 6 +- include/NumCpp/Functions/logical_xor.hpp | 6 +- include/NumCpp/Functions/logspace.hpp | 6 +- include/NumCpp/Functions/matmul.hpp | 18 +- include/NumCpp/Functions/max.hpp | 4 +- include/NumCpp/Functions/maximum.hpp | 6 +- include/NumCpp/Functions/mean.hpp | 12 +- include/NumCpp/Functions/median.hpp | 6 +- include/NumCpp/Functions/meshgrid.hpp | 22 +- include/NumCpp/Functions/min.hpp | 4 +- include/NumCpp/Functions/minimum.hpp | 6 +- include/NumCpp/Functions/mod.hpp | 6 +- include/NumCpp/Functions/multiply.hpp | 54 +- include/NumCpp/Functions/nan_to_num.hpp | 4 +- include/NumCpp/Functions/nanargmax.hpp | 6 +- include/NumCpp/Functions/nanargmin.hpp | 6 +- include/NumCpp/Functions/nancumprod.hpp | 6 +- include/NumCpp/Functions/nancumsum.hpp | 6 +- include/NumCpp/Functions/nanmax.hpp | 6 +- include/NumCpp/Functions/nanmean.hpp | 6 +- include/NumCpp/Functions/nanmedian.hpp | 6 +- include/NumCpp/Functions/nanmin.hpp | 6 +- include/NumCpp/Functions/nanpercentile.hpp | 6 +- include/NumCpp/Functions/nanprod.hpp | 6 +- include/NumCpp/Functions/nans.hpp | 22 +- include/NumCpp/Functions/nans_like.hpp | 6 +- include/NumCpp/Functions/nanstdev.hpp | 6 +- include/NumCpp/Functions/nansum.hpp | 6 +- include/NumCpp/Functions/nanvar.hpp | 6 +- include/NumCpp/Functions/nbytes.hpp | 6 +- include/NumCpp/Functions/negative.hpp | 8 +- include/NumCpp/Functions/newbyteorder.hpp | 20 +- include/NumCpp/Functions/none.hpp | 6 +- include/NumCpp/Functions/nonzero.hpp | 10 +- include/NumCpp/Functions/norm.hpp | 8 +- include/NumCpp/Functions/not_equal.hpp | 6 +- include/NumCpp/Functions/nth_root.hpp | 4 +- include/NumCpp/Functions/ones.hpp | 20 +- include/NumCpp/Functions/ones_like.hpp | 8 +- include/NumCpp/Functions/outer.hpp | 2 +- include/NumCpp/Functions/pad.hpp | 6 +- include/NumCpp/Functions/partition.hpp | 16 +- include/NumCpp/Functions/percentile.hpp | 16 +- include/NumCpp/Functions/place.hpp | 4 +- include/NumCpp/Functions/polar.hpp | 10 +- include/NumCpp/Functions/power.hpp | 18 +- include/NumCpp/Functions/powerf.hpp | 18 +- include/NumCpp/Functions/print.hpp | 6 +- include/NumCpp/Functions/prod.hpp | 6 +- include/NumCpp/Functions/proj.hpp | 12 +- include/NumCpp/Functions/ptp.hpp | 6 +- include/NumCpp/Functions/put.hpp | 16 +- include/NumCpp/Functions/putmask.hpp | 20 +- include/NumCpp/Functions/rad2deg.hpp | 16 +- include/NumCpp/Functions/radians.hpp | 16 +- include/NumCpp/Functions/ravel.hpp | 2 +- include/NumCpp/Functions/real.hpp | 16 +- include/NumCpp/Functions/reciprocal.hpp | 20 +- include/NumCpp/Functions/remainder.hpp | 12 +- include/NumCpp/Functions/repeat.hpp | 12 +- include/NumCpp/Functions/replace.hpp | 2 +- include/NumCpp/Functions/reshape.hpp | 18 +- include/NumCpp/Functions/resizeFast.hpp | 16 +- include/NumCpp/Functions/resizeSlow.hpp | 24 +- include/NumCpp/Functions/right_shift.hpp | 6 +- include/NumCpp/Functions/rint.hpp | 16 +- include/NumCpp/Functions/rms.hpp | 8 +- include/NumCpp/Functions/roll.hpp | 6 +- include/NumCpp/Functions/rot90.hpp | 6 +- include/NumCpp/Functions/round.hpp | 8 +- include/NumCpp/Functions/row_stack.hpp | 6 +- include/NumCpp/Functions/select.hpp | 16 +- include/NumCpp/Functions/setdiff1d.hpp | 8 +- include/NumCpp/Functions/shape.hpp | 6 +- include/NumCpp/Functions/sign.hpp | 24 +- include/NumCpp/Functions/signbit.hpp | 16 +- include/NumCpp/Functions/sin.hpp | 16 +- include/NumCpp/Functions/sinc.hpp | 20 +- include/NumCpp/Functions/sinh.hpp | 16 +- include/NumCpp/Functions/size.hpp | 6 +- include/NumCpp/Functions/sort.hpp | 6 +- include/NumCpp/Functions/sqrt.hpp | 16 +- include/NumCpp/Functions/square.hpp | 16 +- include/NumCpp/Functions/stack.hpp | 6 +- include/NumCpp/Functions/stdev.hpp | 12 +- include/NumCpp/Functions/subtract.hpp | 54 +- include/NumCpp/Functions/sum.hpp | 6 +- include/NumCpp/Functions/swap.hpp | 2 +- include/NumCpp/Functions/swapaxes.hpp | 8 +- include/NumCpp/Functions/tan.hpp | 16 +- include/NumCpp/Functions/tanh.hpp | 16 +- include/NumCpp/Functions/tile.hpp | 12 +- include/NumCpp/Functions/toStlVector.hpp | 6 +- include/NumCpp/Functions/tofile.hpp | 16 +- include/NumCpp/Functions/trace.hpp | 6 +- include/NumCpp/Functions/transpose.hpp | 8 +- include/NumCpp/Functions/trapz.hpp | 12 +- include/NumCpp/Functions/tri.hpp | 56 +- include/NumCpp/Functions/trim_zeros.hpp | 6 +- include/NumCpp/Functions/trunc.hpp | 16 +- include/NumCpp/Functions/union1d.hpp | 10 +- include/NumCpp/Functions/unique.hpp | 10 +- include/NumCpp/Functions/unwrap.hpp | 20 +- include/NumCpp/Functions/var.hpp | 12 +- include/NumCpp/Functions/vstack.hpp | 8 +- include/NumCpp/Functions/where.hpp | 32 +- include/NumCpp/Functions/zeros.hpp | 22 +- include/NumCpp/Functions/zeros_like.hpp | 8 +- include/NumCpp/ImageProcessing/Centroid.hpp | 64 +- include/NumCpp/ImageProcessing/Cluster.hpp | 98 +- .../NumCpp/ImageProcessing/ClusterMaker.hpp | 50 +- include/NumCpp/ImageProcessing/Pixel.hpp | 40 +- .../NumCpp/ImageProcessing/applyThreshold.hpp | 6 +- .../ImageProcessing/centroidClusters.hpp | 4 +- .../NumCpp/ImageProcessing/clusterPixels.hpp | 4 +- .../ImageProcessing/generateCentroids.hpp | 8 +- .../ImageProcessing/generateThreshold.hpp | 8 +- .../ImageProcessing/windowExceedances.hpp | 4 +- include/NumCpp/Integrate/gauss_legendre.hpp | 18 +- include/NumCpp/Integrate/romberg.hpp | 2 +- include/NumCpp/Integrate/simpson.hpp | 2 +- include/NumCpp/Integrate/trapazoidal.hpp | 2 +- include/NumCpp/Linalg/cholesky.hpp | 4 +- include/NumCpp/Linalg/det.hpp | 10 +- include/NumCpp/Linalg/gaussNewtonNlls.hpp | 16 +- include/NumCpp/Linalg/hat.hpp | 16 +- include/NumCpp/Linalg/inv.hpp | 8 +- include/NumCpp/Linalg/lstsq.hpp | 20 +- include/NumCpp/Linalg/lu_decomposition.hpp | 2 +- include/NumCpp/Linalg/matrix_power.hpp | 14 +- include/NumCpp/Linalg/multi_dot.hpp | 10 +- .../NumCpp/Linalg/pivotLU_decomposition.hpp | 2 +- include/NumCpp/Linalg/solve.hpp | 2 +- include/NumCpp/Linalg/svd.hpp | 4 +- include/NumCpp/Linalg/svd/SVDClass.hpp | 36 +- include/NumCpp/NdArray/NdArrayCore.hpp | 1062 ++++++++--------- include/NumCpp/NdArray/NdArrayIterators.hpp | 144 +-- include/NumCpp/NdArray/NdArrayOperators.hpp | 428 +++---- include/NumCpp/Polynomial/Poly1d.hpp | 100 +- include/NumCpp/Polynomial/chebyshev_t.hpp | 8 +- include/NumCpp/Polynomial/chebyshev_u.hpp | 8 +- include/NumCpp/Polynomial/hermite.hpp | 8 +- include/NumCpp/Polynomial/laguerre.hpp | 16 +- include/NumCpp/Polynomial/legendre_p.hpp | 16 +- include/NumCpp/Polynomial/legendre_q.hpp | 8 +- .../NumCpp/Polynomial/spherical_harmonic.hpp | 12 +- .../NumCpp/PythonInterface/BoostInterface.hpp | 10 +- .../BoostNumpyNdarrayHelper.hpp | 38 +- .../PythonInterface/PybindInterface.hpp | 12 +- include/NumCpp/Random/bernoilli.hpp | 10 +- include/NumCpp/Random/beta.hpp | 10 +- include/NumCpp/Random/binomial.hpp | 14 +- include/NumCpp/Random/cauchy.hpp | 10 +- include/NumCpp/Random/chiSquare.hpp | 14 +- include/NumCpp/Random/choice.hpp | 8 +- include/NumCpp/Random/discrete.hpp | 26 +- include/NumCpp/Random/exponential.hpp | 14 +- include/NumCpp/Random/extremeValue.hpp | 10 +- include/NumCpp/Random/f.hpp | 14 +- include/NumCpp/Random/gamma.hpp | 14 +- include/NumCpp/Random/generator.hpp | 6 +- include/NumCpp/Random/geometric.hpp | 14 +- include/NumCpp/Random/laplace.hpp | 10 +- include/NumCpp/Random/lognormal.hpp | 14 +- include/NumCpp/Random/negativeBinomial.hpp | 14 +- .../NumCpp/Random/nonCentralChiSquared.hpp | 10 +- include/NumCpp/Random/normal.hpp | 14 +- include/NumCpp/Random/permutation.hpp | 20 +- include/NumCpp/Random/poisson.hpp | 14 +- include/NumCpp/Random/rand.hpp | 18 +- include/NumCpp/Random/randFloat.hpp | 22 +- include/NumCpp/Random/randInt.hpp | 22 +- include/NumCpp/Random/randN.hpp | 14 +- include/NumCpp/Random/shuffle.hpp | 4 +- include/NumCpp/Random/standardNormal.hpp | 20 +- include/NumCpp/Random/studentT.hpp | 14 +- include/NumCpp/Random/triangle.hpp | 12 +- include/NumCpp/Random/uniform.hpp | 20 +- include/NumCpp/Random/uniformOnSphere.hpp | 8 +- include/NumCpp/Random/weibull.hpp | 14 +- include/NumCpp/Roots/Bisection.hpp | 14 +- include/NumCpp/Roots/Brent.hpp | 22 +- include/NumCpp/Roots/Dekker.hpp | 18 +- include/NumCpp/Roots/Iteration.hpp | 14 +- include/NumCpp/Roots/Newton.hpp | 12 +- include/NumCpp/Roots/Secant.hpp | 12 +- include/NumCpp/Rotations/DCM.hpp | 62 +- include/NumCpp/Rotations/Quaternion.hpp | 226 ++-- .../NumCpp/Rotations/rodriguesRotation.hpp | 4 +- include/NumCpp/Rotations/wahbasProblem.hpp | 4 +- include/NumCpp/Special/airy_ai.hpp | 12 +- include/NumCpp/Special/airy_ai_prime.hpp | 12 +- include/NumCpp/Special/airy_bi.hpp | 12 +- include/NumCpp/Special/airy_bi_prime.hpp | 12 +- include/NumCpp/Special/bernoulli.hpp | 12 +- include/NumCpp/Special/bessel_in.hpp | 8 +- include/NumCpp/Special/bessel_in_prime.hpp | 8 +- include/NumCpp/Special/bessel_jn.hpp | 8 +- include/NumCpp/Special/bessel_jn_prime.hpp | 8 +- include/NumCpp/Special/bessel_kn.hpp | 8 +- include/NumCpp/Special/bessel_kn_prime.hpp | 8 +- include/NumCpp/Special/bessel_yn.hpp | 8 +- include/NumCpp/Special/bessel_yn_prime.hpp | 8 +- include/NumCpp/Special/beta.hpp | 8 +- include/NumCpp/Special/cnr.hpp | 2 +- include/NumCpp/Special/comp_ellint_1.hpp | 8 +- include/NumCpp/Special/comp_ellint_2.hpp | 8 +- include/NumCpp/Special/comp_ellint_3.hpp | 4 +- include/NumCpp/Special/cyclic_hankel_1.hpp | 8 +- include/NumCpp/Special/cyclic_hankel_2.hpp | 8 +- include/NumCpp/Special/digamma.hpp | 8 +- include/NumCpp/Special/ellint_1.hpp | 4 +- include/NumCpp/Special/ellint_2.hpp | 4 +- include/NumCpp/Special/ellint_3.hpp | 4 +- include/NumCpp/Special/erf.hpp | 16 +- include/NumCpp/Special/erf_inv.hpp | 12 +- include/NumCpp/Special/erfc.hpp | 14 +- include/NumCpp/Special/erfc_inv.hpp | 12 +- include/NumCpp/Special/expint.hpp | 8 +- include/NumCpp/Special/factorial.hpp | 8 +- include/NumCpp/Special/gamma.hpp | 8 +- include/NumCpp/Special/gamma1pm1.hpp | 8 +- include/NumCpp/Special/log_gamma.hpp | 8 +- include/NumCpp/Special/pnr.hpp | 2 +- include/NumCpp/Special/polygamma.hpp | 4 +- include/NumCpp/Special/prime.hpp | 8 +- include/NumCpp/Special/riemann_zeta.hpp | 12 +- include/NumCpp/Special/softmax.hpp | 2 +- .../NumCpp/Special/spherical_bessel_jn.hpp | 8 +- .../NumCpp/Special/spherical_bessel_yn.hpp | 8 +- include/NumCpp/Special/spherical_hankel_1.hpp | 6 +- include/NumCpp/Special/spherical_hankel_2.hpp | 6 +- include/NumCpp/Special/trigamma.hpp | 8 +- include/NumCpp/Utils/cube.hpp | 2 +- include/NumCpp/Utils/essentiallyEqual.hpp | 12 +- include/NumCpp/Utils/gaussian.hpp | 4 +- include/NumCpp/Utils/gaussian1d.hpp | 2 +- include/NumCpp/Utils/interp.hpp | 2 +- include/NumCpp/Utils/num2str.hpp | 2 +- include/NumCpp/Utils/power.hpp | 2 +- include/NumCpp/Utils/powerf.hpp | 2 +- include/NumCpp/Utils/sqr.hpp | 2 +- include/NumCpp/Utils/value2str.hpp | 2 +- include/NumCpp/Vector/Vec2.hpp | 82 +- include/NumCpp/Vector/Vec3.hpp | 88 +- 433 files changed, 3616 insertions(+), 3620 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index 5eddb47db..7e04ffc39 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -1,7 +1,3 @@ -## Additional capability - - * `hammingEncode`, my stuff - ## Changes * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy diff --git a/include/NumCpp/Coordinates/Coordinate.hpp b/include/NumCpp/Coordinates/Coordinate.hpp index 0c84cf02d..859a438c6 100644 --- a/include/NumCpp/Coordinates/Coordinate.hpp +++ b/include/NumCpp/Coordinates/Coordinate.hpp @@ -46,17 +46,17 @@ namespace nc namespace coordinates { //================================================================================ - /// Holds a full coordinate object + /// Holds a full coordinate object class Coordinate { public: //============================================================================ - /// Default Constructor + /// Default Constructor /// Coordinate() = default; //============================================================================ - /// Constructor + /// Constructor /// /// @param inRaDegrees /// @param inDecDegrees @@ -69,7 +69,7 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// /// @param inRaHours /// @param inRaMinutes @@ -88,7 +88,7 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// /// @param inRA /// @param inDec @@ -101,7 +101,7 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// /// @param inX /// @param inY @@ -116,7 +116,7 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// /// @param inCartesianVector /// @@ -135,7 +135,7 @@ namespace nc } //============================================================================ - /// Returns the Dec object + /// Returns the Dec object /// /// @return Dec /// @@ -145,7 +145,7 @@ namespace nc } //============================================================================ - /// Returns the RA object + /// Returns the RA object /// /// @return RA /// @@ -155,7 +155,7 @@ namespace nc } //============================================================================ - /// Returns the cartesian x value + /// Returns the cartesian x value /// /// @return x /// @@ -165,7 +165,7 @@ namespace nc } //============================================================================ - /// Returns the cartesian y value + /// Returns the cartesian y value /// /// @return y /// @@ -175,7 +175,7 @@ namespace nc } //============================================================================ - /// Returns the cartesian z value + /// Returns the cartesian z value /// /// @return z /// @@ -185,7 +185,7 @@ namespace nc } //============================================================================ - /// Returns the cartesian xyz triplet as an NdArray + /// Returns the cartesian xyz triplet as an NdArray /// /// @return NdArray /// @@ -196,7 +196,7 @@ namespace nc } //============================================================================ - /// Returns the degree seperation between the two Coordinates + /// Returns the degree seperation between the two Coordinates /// /// @param inOtherCoordinate /// @@ -208,8 +208,8 @@ namespace nc } //============================================================================ - /// Returns the degree seperation between the Coordinate - /// and the input vector + /// Returns the degree seperation between the Coordinate + /// and the input vector /// /// @param inVector /// @@ -221,7 +221,7 @@ namespace nc } //============================================================================ - /// Returns the radian seperation between the two Coordinates + /// Returns the radian seperation between the two Coordinates /// /// @param inOtherCoordinate /// @@ -233,8 +233,8 @@ namespace nc } //============================================================================ - /// Returns the radian seperation between the Coordinate - /// and the input vector + /// Returns the radian seperation between the Coordinate + /// and the input vector /// /// @param inVector /// @@ -251,7 +251,7 @@ namespace nc } //============================================================================ - /// Returns coordinate as a string representation + /// Returns coordinate as a string representation /// /// @return string /// @@ -265,7 +265,7 @@ namespace nc } //============================================================================ - /// Prints the Coordinate object to the console + /// Prints the Coordinate object to the console /// void print() const { @@ -273,7 +273,7 @@ namespace nc } //============================================================================ - /// Equality operator + /// Equality operator /// /// @param inRhs /// @@ -285,7 +285,7 @@ namespace nc } //============================================================================ - /// Not equality operator + /// Not equality operator /// /// @param inRhs /// @@ -297,7 +297,7 @@ namespace nc } //============================================================================ - /// Ostream operator + /// Ostream operator /// /// @param inStream /// @param inCoord @@ -319,7 +319,7 @@ namespace nc double z_{ 0.0 }; //============================================================================ - /// Converts polar coordinates to cartesian coordinates + /// Converts polar coordinates to cartesian coordinates /// void cartesianToPolar() noexcept { @@ -336,7 +336,7 @@ namespace nc } //============================================================================ - /// Converts polar coordinates to cartesian coordinates + /// Converts polar coordinates to cartesian coordinates /// void polarToCartesian() noexcept { diff --git a/include/NumCpp/Coordinates/Dec.hpp b/include/NumCpp/Coordinates/Dec.hpp index d846c5251..1c81e7295 100644 --- a/include/NumCpp/Coordinates/Dec.hpp +++ b/include/NumCpp/Coordinates/Dec.hpp @@ -42,21 +42,21 @@ namespace nc namespace coordinates { //================================================================================ - /// Struct Enum for positive or negative Dec angle + /// Struct Enum for positive or negative Dec angle enum class Sign { NEGATIVE = 0, POSITIVE }; //================================================================================ - /// Holds a Declination object + /// Holds a Declination object class Dec { public: //============================================================================ - /// Default Constructor + /// Default Constructor /// Dec() = default; //============================================================================ - /// Constructor + /// Constructor /// /// @param inDegrees /// @@ -79,10 +79,10 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// /// @param inSign - /// @param inDegrees + /// @param inDegrees /// @param inMinutes /// @param inSeconds /// @@ -99,7 +99,7 @@ namespace nc } //============================================================================ - /// Get the sign of the degrees (positive or negative) + /// Get the sign of the degrees (positive or negative) /// /// @return Sign /// @@ -109,7 +109,7 @@ namespace nc } //============================================================================ - /// Get the degrees value + /// Get the degrees value /// /// @return degrees /// @@ -119,7 +119,7 @@ namespace nc } //============================================================================ - /// Get the radians value + /// Get the radians value /// /// @return minutes /// @@ -129,7 +129,7 @@ namespace nc } //============================================================================ - /// Get the whole degrees value + /// Get the whole degrees value /// /// @return whole degrees /// @@ -139,7 +139,7 @@ namespace nc } //============================================================================ - /// Get the minute value + /// Get the minute value /// /// @return minutes /// @@ -149,7 +149,7 @@ namespace nc } //============================================================================ - /// Get the seconds value + /// Get the seconds value /// /// @return seconds /// @@ -159,7 +159,7 @@ namespace nc } //============================================================================ - /// Return the dec object as a string representation + /// Return the dec object as a string representation /// /// @return std::string /// @@ -172,7 +172,7 @@ namespace nc } //============================================================================ - /// Prints the Dec object to the console + /// Prints the Dec object to the console /// void print() const { @@ -180,7 +180,7 @@ namespace nc } //============================================================================ - /// Equality operator + /// Equality operator /// /// @param inRhs /// @@ -192,7 +192,7 @@ namespace nc } //============================================================================ - /// Not equality operator + /// Not equality operator /// /// @param inRhs /// @@ -204,7 +204,7 @@ namespace nc } //============================================================================ - /// Ostream operator + /// Ostream operator /// /// @param inStream /// @param inDec diff --git a/include/NumCpp/Coordinates/RA.hpp b/include/NumCpp/Coordinates/RA.hpp index 4e9a556a0..9f2658909 100644 --- a/include/NumCpp/Coordinates/RA.hpp +++ b/include/NumCpp/Coordinates/RA.hpp @@ -42,17 +42,17 @@ namespace nc namespace coordinates { //================================================================================ - /// Holds a right ascension object + /// Holds a right ascension object class RA { public: //============================================================================ - /// Default Constructor + /// Default Constructor /// RA() = default; //============================================================================ - /// Constructor + /// Constructor /// /// @param inDegrees /// @@ -72,9 +72,9 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// - /// @param inHours + /// @param inHours /// @param inMinutes /// @param inSeconds /// @@ -88,7 +88,7 @@ namespace nc } //============================================================================ - /// Get the radians value + /// Get the radians value /// /// @return radians /// @@ -98,7 +98,7 @@ namespace nc } //============================================================================ - /// Get the degrees value + /// Get the degrees value /// /// @return degrees /// @@ -108,7 +108,7 @@ namespace nc } //============================================================================ - /// Get the hour value + /// Get the hour value /// /// @return hours /// @@ -118,7 +118,7 @@ namespace nc } //============================================================================ - /// Get the minute value + /// Get the minute value /// /// @return minutes /// @@ -128,7 +128,7 @@ namespace nc } //============================================================================ - /// Get the seconds value + /// Get the seconds value /// /// @return seconds /// @@ -138,7 +138,7 @@ namespace nc } //============================================================================ - /// Return the RA object as a string representation + /// Return the RA object as a string representation /// /// @return std::string /// @@ -150,7 +150,7 @@ namespace nc } //============================================================================ - /// Prints the RA object to the console + /// Prints the RA object to the console /// void print() const { @@ -158,7 +158,7 @@ namespace nc } //============================================================================ - /// Equality operator + /// Equality operator /// /// @param inRhs /// @@ -170,7 +170,7 @@ namespace nc } //============================================================================ - /// Not equality operator + /// Not equality operator /// /// @param inRhs /// @@ -182,7 +182,7 @@ namespace nc } //============================================================================ - /// Ostream operator + /// Ostream operator /// /// @param inStream /// @param inRa diff --git a/include/NumCpp/Coordinates/degreeSeperation.hpp b/include/NumCpp/Coordinates/degreeSeperation.hpp index 6e9843db5..84247ebcb 100644 --- a/include/NumCpp/Coordinates/degreeSeperation.hpp +++ b/include/NumCpp/Coordinates/degreeSeperation.hpp @@ -35,7 +35,7 @@ namespace nc namespace coordinates { //============================================================================ - /// Returns the degree seperation between the two Coordinates + /// Returns the degree seperation between the two Coordinates /// /// @param inCoordinate1 /// @param inCoordinate2 @@ -48,8 +48,8 @@ namespace nc } //============================================================================ - /// Returns the degree seperation between the Coordinate - /// and the input vector + /// Returns the degree seperation between the Coordinate + /// and the input vector /// /// @param inVector1 /// @param inVector2 diff --git a/include/NumCpp/Coordinates/radianSeperation.hpp b/include/NumCpp/Coordinates/radianSeperation.hpp index 37fdc44df..0dc7ad778 100644 --- a/include/NumCpp/Coordinates/radianSeperation.hpp +++ b/include/NumCpp/Coordinates/radianSeperation.hpp @@ -35,7 +35,7 @@ namespace nc namespace coordinates { //============================================================================ - /// Returns the radian seperation between the two Coordinates + /// Returns the radian seperation between the two Coordinates /// /// @param inCoordinate1 /// @param inCoordinate2 @@ -48,8 +48,8 @@ namespace nc } //============================================================================ - /// Returns the radian seperation between the Coordinate - /// and the input vector + /// Returns the radian seperation between the Coordinate + /// and the input vector /// /// @param inVector1 /// @param inVector2 diff --git a/include/NumCpp/Core/DataCube.hpp b/include/NumCpp/Core/DataCube.hpp index 84c85d989..a2dc95038 100644 --- a/include/NumCpp/Core/DataCube.hpp +++ b/include/NumCpp/Core/DataCube.hpp @@ -51,12 +51,12 @@ namespace nc using const_iterator = typename std::deque >::const_iterator; //============================================================================ - /// Default Constructor + /// Default Constructor /// DataCube() = default; //============================================================================ - /// Constructor, preallocates to the input size + /// Constructor, preallocates to the input size /// /// @param inSize /// @@ -66,7 +66,7 @@ namespace nc } //============================================================================ - /// Access method, with bounds checking. Returns the 2d z "slice" element of the cube. + /// Access method, with bounds checking. Returns the 2d z "slice" element of the cube. /// /// @param inIndex /// @@ -78,7 +78,7 @@ namespace nc } //============================================================================ - /// Const access method, with bounds checking. Returns the 2d z "slice" element of the cube. + /// Const access method, with bounds checking. Returns the 2d z "slice" element of the cube. /// /// @param inIndex /// @@ -90,7 +90,7 @@ namespace nc } //============================================================================ - /// Returns a reference to the last 2d "slice" of the cube in the z-axis + /// Returns a reference to the last 2d "slice" of the cube in the z-axis /// /// @return NdArray& /// @@ -100,7 +100,7 @@ namespace nc } //============================================================================ - /// Returns an iterator to the first 2d z "slice" of the cube. + /// Returns an iterator to the first 2d z "slice" of the cube. /// /// @return iterator /// @@ -110,7 +110,7 @@ namespace nc } //============================================================================ - /// Returns an const_iterator to the first 2d z "slice" of the cube. + /// Returns an const_iterator to the first 2d z "slice" of the cube. /// /// @return const_iterator /// @@ -120,7 +120,7 @@ namespace nc } //============================================================================ - /// Outputs the DataCube as a .bin file + /// Outputs the DataCube as a .bin file /// /// @param inFilename /// @@ -147,7 +147,7 @@ namespace nc } //============================================================================ - /// Tests whether or not the container is empty + /// Tests whether or not the container is empty /// /// @return bool /// @@ -157,7 +157,7 @@ namespace nc } //============================================================================ - /// Returns an iterator to 1 past the last 2d z "slice" of the cube. + /// Returns an iterator to 1 past the last 2d z "slice" of the cube. /// /// @return iterator /// @@ -167,7 +167,7 @@ namespace nc } //============================================================================ - /// Returns an const_iterator to 1 past the last 2d z "slice" of the cube. + /// Returns an const_iterator to 1 past the last 2d z "slice" of the cube. /// /// @return const_iterator /// @@ -177,7 +177,7 @@ namespace nc } //============================================================================ - /// Returns a reference to the front 2d "slice" of the cube in the z-axis + /// Returns a reference to the front 2d "slice" of the cube in the z-axis /// /// @return NdArray& /// @@ -187,7 +187,7 @@ namespace nc } //============================================================================ - /// Returns the x/y shape of the cube + /// Returns the x/y shape of the cube /// /// @return Shape /// @@ -197,7 +197,7 @@ namespace nc } //============================================================================ - /// Returns the size of the z-axis of the cube + /// Returns the size of the z-axis of the cube /// /// @return size /// @@ -207,7 +207,7 @@ namespace nc } //============================================================================ - /// Removes the last z "slice" of the cube + /// Removes the last z "slice" of the cube /// void pop_back() noexcept { @@ -215,7 +215,7 @@ namespace nc } //============================================================================ - /// Adds a new z "slice" to the end of the cube + /// Adds a new z "slice" to the end of the cube /// /// @param inArray /// @@ -239,7 +239,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube + /// Slices the z dimension of the cube /// /// @param inIndex: the flattend 2d index (row, col) to slice /// @return NdArray @@ -262,7 +262,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube + /// Slices the z dimension of the cube /// /// @param inIndex: the flattend 2d index (row, col) to slice /// @param inSliceZ: the slice dimensions of the z-axis @@ -287,7 +287,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -316,7 +316,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -347,7 +347,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -370,7 +370,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -395,7 +395,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -418,7 +418,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -443,7 +443,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -461,7 +461,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with NO bounds checking + /// Slices the z dimension of the cube with NO bounds checking /// /// @param inRow /// @param inCol @@ -480,7 +480,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inIndex: the flattend 2d index (row, col) to slice /// @return NdArray @@ -501,7 +501,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inIndex: the flattend 2d index (row, col) to slice /// @param inSliceZ: the slice dimensions of the z-axis @@ -529,7 +529,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -561,7 +561,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -599,7 +599,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -627,7 +627,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -662,7 +662,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -690,7 +690,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -725,7 +725,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -747,7 +747,7 @@ namespace nc } //============================================================================ - /// Slices the z dimension of the cube with bounds checking + /// Slices the z dimension of the cube with bounds checking /// /// @param inRow /// @param inCol @@ -776,7 +776,7 @@ namespace nc } //============================================================================ - /// Access operator, no bounds checking. Returns the 2d z "slice" element of the cube. + /// Access operator, no bounds checking. Returns the 2d z "slice" element of the cube. /// /// @param inIndex /// @@ -788,7 +788,7 @@ namespace nc } //============================================================================ - /// Const access operator, no bounds checking. Returns the 2d z "slice" element of the cube. + /// Const access operator, no bounds checking. Returns the 2d z "slice" element of the cube. /// /// @param inIndex /// diff --git a/include/NumCpp/Core/DtypeInfo.hpp b/include/NumCpp/Core/DtypeInfo.hpp index 2c1472c29..503d8b618 100644 --- a/include/NumCpp/Core/DtypeInfo.hpp +++ b/include/NumCpp/Core/DtypeInfo.hpp @@ -35,14 +35,14 @@ namespace nc { //================================================================================ - /// Holds info about the dtype + /// Holds info about the dtype template class DtypeInfo { public: //============================================================================ - /// For integer types: number of non-sign bits in the representation. - /// For floating types : number of digits(in radix base) in the mantissa + /// For integer types: number of non-sign bits in the representation. + /// For floating types : number of digits(in radix base) in the mantissa /// /// @return number of bits /// @@ -54,8 +54,8 @@ namespace nc } //============================================================================ - /// Machine epsilon (the difference between 1 and the least - /// value greater than 1 that is representable). + /// Machine epsilon (the difference between 1 and the least + /// value greater than 1 that is representable). /// /// @return dtype /// @@ -67,7 +67,7 @@ namespace nc } //============================================================================ - /// True if type is integer. + /// True if type is integer. /// /// @return bool /// @@ -79,7 +79,7 @@ namespace nc } //============================================================================ - /// True if type is signed. + /// True if type is signed. /// /// @return bool /// @@ -91,7 +91,7 @@ namespace nc } //============================================================================ - /// Returns the minimum value of the dtype + /// Returns the minimum value of the dtype /// /// @return min value /// @@ -103,7 +103,7 @@ namespace nc } //============================================================================ - /// Returns the maximum value of the dtype + /// Returns the maximum value of the dtype /// /// @return max value /// @@ -116,14 +116,14 @@ namespace nc }; //================================================================================ - /// Holds info about the std::complex + /// Holds info about the std::complex template class DtypeInfo> { public: //============================================================================ - /// For integer types: number of non-sign bits in the representation. - /// For floating types : number of digits(in radix base) in the mantissa + /// For integer types: number of non-sign bits in the representation. + /// For floating types : number of digits(in radix base) in the mantissa /// /// @return number of bits /// @@ -135,8 +135,8 @@ namespace nc } //============================================================================ - /// Machine epsilon (the difference between 1 and the least - /// value greater than 1 that is representable). + /// Machine epsilon (the difference between 1 and the least + /// value greater than 1 that is representable). /// /// @return dtype /// @@ -148,7 +148,7 @@ namespace nc } //============================================================================ - /// True if type is integer. + /// True if type is integer. /// /// @return bool /// @@ -160,7 +160,7 @@ namespace nc } //============================================================================ - /// True if type is signed. + /// True if type is signed. /// /// @return bool /// @@ -172,7 +172,7 @@ namespace nc } //============================================================================ - /// Returns the minimum value of the dtype + /// Returns the minimum value of the dtype /// /// @return min value /// @@ -184,7 +184,7 @@ namespace nc } //============================================================================ - /// Returns the maximum value of the dtype + /// Returns the maximum value of the dtype /// /// @return max value /// diff --git a/include/NumCpp/Core/Internal/Endian.hpp b/include/NumCpp/Core/Internal/Endian.hpp index f4081be38..07d28330d 100644 --- a/include/NumCpp/Core/Internal/Endian.hpp +++ b/include/NumCpp/Core/Internal/Endian.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Function Description: - /// Determines the endianess of the system + /// Determines the endianess of the system /// /// @return bool true if the system is little endian /// @@ -54,7 +54,7 @@ namespace nc //============================================================================ // Function Description: - /// Swaps the bytes of the input value + /// Swaps the bytes of the input value /// /// @param value /// @return byte swapped value diff --git a/include/NumCpp/Core/Internal/Error.hpp b/include/NumCpp/Core/Internal/Error.hpp index 831944831..6b52e1061 100644 --- a/include/NumCpp/Core/Internal/Error.hpp +++ b/include/NumCpp/Core/Internal/Error.hpp @@ -41,7 +41,7 @@ namespace nc namespace error { //============================================================================ - /// Makes the full error message string + /// Makes the full error message string /// /// @param file: the file /// @param function: the function diff --git a/include/NumCpp/Core/Internal/Filesystem.hpp b/include/NumCpp/Core/Internal/Filesystem.hpp index 29115e456..bbcb6a9ef 100644 --- a/include/NumCpp/Core/Internal/Filesystem.hpp +++ b/include/NumCpp/Core/Internal/Filesystem.hpp @@ -35,13 +35,13 @@ namespace nc namespace filesystem { //================================================================================ - /// Provides simple filesystem functions + /// Provides simple filesystem functions class File { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param filename: the full filename /// @@ -63,7 +63,7 @@ namespace nc //============================================================================ // Method Description: - /// Tests whether or not the file exists + /// Tests whether or not the file exists /// /// @return bool /// @@ -74,7 +74,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the file extension without the dot + /// Returns the file extension without the dot /// /// @return std::string /// @@ -85,7 +85,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the input full filename + /// Returns the input full filename /// /// @return std::string /// @@ -96,7 +96,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns true if the file has an extension + /// Returns true if the file has an extension /// /// @return bool /// @@ -107,7 +107,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the filename + /// Returns the filename /// /// @return std::string /// @@ -118,7 +118,7 @@ namespace nc //============================================================================ // Method Description: - /// Sets the extension to the input extension. Do not input the dot. + /// Sets the extension to the input extension. Do not input the dot. /// E.g. input "txt", not ".txt" /// /// @return std::string diff --git a/include/NumCpp/Core/Internal/StdComplexOperators.hpp b/include/NumCpp/Core/Internal/StdComplexOperators.hpp index 423bfd830..8eef74887 100644 --- a/include/NumCpp/Core/Internal/StdComplexOperators.hpp +++ b/include/NumCpp/Core/Internal/StdComplexOperators.hpp @@ -35,7 +35,7 @@ namespace nc { //============================================================================ // Method Description: - /// Less than operator for std::complex + /// Less than operator for std::complex /// /// @param lhs /// @param rhs @@ -54,7 +54,7 @@ namespace nc //============================================================================ // Method Description: - /// Less than or equal operator for std::complex + /// Less than or equal operator for std::complex /// /// @param lhs /// @param rhs @@ -73,7 +73,7 @@ namespace nc //============================================================================ // Method Description: - /// Greater than operator for std::complex + /// Greater than operator for std::complex /// /// @param lhs /// @param rhs @@ -87,7 +87,7 @@ namespace nc //============================================================================ // Method Description: - /// Greater than or equal operator for std::complex + /// Greater than or equal operator for std::complex /// /// @param lhs /// @param rhs @@ -101,7 +101,7 @@ namespace nc //============================================================================ // Method Description: - /// Greater than or equal operator for std::complex + /// Greater than or equal operator for std::complex /// /// @param value /// @return std::complex diff --git a/include/NumCpp/Core/Internal/StlAlgorithms.hpp b/include/NumCpp/Core/Internal/StlAlgorithms.hpp index 9d413f9a5..f478b5c91 100644 --- a/include/NumCpp/Core/Internal/StlAlgorithms.hpp +++ b/include/NumCpp/Core/Internal/StlAlgorithms.hpp @@ -46,7 +46,7 @@ namespace nc { //============================================================================ // Method Description: - /// Tests if all of the elements of a range satisy a predicate + /// Tests if all of the elements of a range satisy a predicate /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -65,7 +65,7 @@ namespace nc //============================================================================ // Method Description: - /// Tests if any of the elements of a range satisy a predicate + /// Tests if any of the elements of a range satisy a predicate /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -84,7 +84,7 @@ namespace nc //============================================================================ // Method Description: - /// Copies from one container to another + /// Copies from one container to another /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -103,7 +103,7 @@ namespace nc //============================================================================ // Method Description: - /// Counts the values in the range + /// Counts the values in the range /// /// @param first: the first iterator of container /// @param last: the last iterator of container @@ -124,7 +124,7 @@ namespace nc //============================================================================ // Method Description: - /// Test if two ranges are equal + /// Test if two ranges are equal /// /// @param first1: the first iterator of first container /// @param last1: the last iterator of first container @@ -143,7 +143,7 @@ namespace nc //============================================================================ // Method Description: - /// Test if two ranges are equal + /// Test if two ranges are equal /// /// @param first1: the first iterator of first container /// @param last1: the last iterator of first container @@ -164,7 +164,7 @@ namespace nc //============================================================================ // Method Description: - /// Fills the range with the value + /// Fills the range with the value /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -183,8 +183,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns the first element in the range [first, last) - /// that satisfies specific criteria: + /// Returns the first element in the range [first, last) + /// that satisfies specific criteria: /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -203,7 +203,7 @@ namespace nc //============================================================================ // Method Description: - /// Runs the function on each element of the range + /// Runs the function on each element of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -221,7 +221,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns true if the array is sorted + /// Returns true if the array is sorted /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -239,7 +239,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns true if the array is sorted + /// Returns true if the array is sorted /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -258,7 +258,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the maximum element of the range + /// Returns the maximum element of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -276,7 +276,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the maximum element of the range + /// Returns the maximum element of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -295,7 +295,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the minimum element of the range + /// Returns the minimum element of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -312,7 +312,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the minimum element of the range + /// Returns the minimum element of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -331,7 +331,7 @@ namespace nc //============================================================================ // Method Description: - /// Runs the minimum and maximum elements of the range + /// Runs the minimum and maximum elements of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -349,7 +349,7 @@ namespace nc //============================================================================ // Method Description: - /// Runs the minimum and maximum elements of the range + /// Runs the minimum and maximum elements of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -368,7 +368,7 @@ namespace nc //============================================================================ // Method Description: - /// Tests if none of the elements of a range satisy a predicate + /// Tests if none of the elements of a range satisy a predicate /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -387,7 +387,7 @@ namespace nc //============================================================================ // Method Description: - /// Sorts up to the nth element + /// Sorts up to the nth element /// /// @param first: the first iterator of the range /// @param nth: the element that should be sorted @@ -405,7 +405,7 @@ namespace nc //============================================================================ // Method Description: - /// Sorts up to the nth element + /// Sorts up to the nth element /// /// @param first: the first iterator of the range /// @param nth: the element that should be sorted @@ -424,7 +424,7 @@ namespace nc //============================================================================ // Method Description: - /// replaces a value in the range with another value + /// replaces a value in the range with another value /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -444,7 +444,7 @@ namespace nc //============================================================================ // Method Description: - /// reverses the range + /// reverses the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -461,7 +461,7 @@ namespace nc //============================================================================ // Method Description: - /// Rotates the elements of a range + /// Rotates the elements of a range /// /// @param first: the first iterator of the range /// @param firstN: the element that should appear at the beginning of the rotated range @@ -479,7 +479,7 @@ namespace nc //============================================================================ // Method Description: - /// finds the difference of two ranges + /// finds the difference of two ranges /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -502,7 +502,7 @@ namespace nc //============================================================================ // Method Description: - /// finds the difference of two ranges + /// finds the difference of two ranges /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -526,7 +526,7 @@ namespace nc //============================================================================ // Method Description: - /// finds the intersection of two ranges + /// finds the intersection of two ranges /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -549,7 +549,7 @@ namespace nc //============================================================================ // Method Description: - /// finds the intersection of two ranges + /// finds the intersection of two ranges /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -573,7 +573,7 @@ namespace nc //============================================================================ // Method Description: - /// finds the union of two ranges + /// finds the union of two ranges /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -596,7 +596,7 @@ namespace nc //============================================================================ // Method Description: - /// finds the union of two ranges + /// finds the union of two ranges /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -620,7 +620,7 @@ namespace nc //============================================================================ // Method Description: - /// Sorts the range + /// Sorts the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -637,7 +637,7 @@ namespace nc //============================================================================ // Method Description: - /// Sorts the range + /// Sorts the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -655,7 +655,7 @@ namespace nc //============================================================================ // Method Description: - /// Sorts the range preserving order + /// Sorts the range preserving order /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -672,7 +672,7 @@ namespace nc //============================================================================ // Method Description: - /// Sorts the range preserving order + /// Sorts the range preserving order /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -690,7 +690,7 @@ namespace nc //============================================================================ // Method Description: - /// Transforms the elements of the range + /// Transforms the elements of the range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -711,7 +711,7 @@ namespace nc //============================================================================ // Method Description: - /// Transforms the elements of the range + /// Transforms the elements of the range /// /// @param first1: the first iterator of the source /// @param last1: the last iterator of the source @@ -733,7 +733,7 @@ namespace nc //============================================================================ // Method Description: - /// Copies the unique elements of a range + /// Copies the unique elements of a range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source @@ -753,7 +753,7 @@ namespace nc //============================================================================ // Method Description: - /// Copies the unique elements of a range + /// Copies the unique elements of a range /// /// @param first: the first iterator of the source /// @param last: the last iterator of the source diff --git a/include/NumCpp/Core/Internal/TypeTraits.hpp b/include/NumCpp/Core/Internal/TypeTraits.hpp index 23ad857a5..009f76b53 100644 --- a/include/NumCpp/Core/Internal/TypeTraits.hpp +++ b/include/NumCpp/Core/Internal/TypeTraits.hpp @@ -34,49 +34,49 @@ namespace nc { //============================================================================ // Class Description: - /// std::enable_if helper, for c++14 compatibility + /// std::enable_if helper, for c++14 compatibility /// template using enable_if_t = typename std::enable_if::type; //============================================================================ // Class Description: - /// std::is_same helper, for c++14 compatibility + /// std::is_same helper, for c++14 compatibility /// template constexpr bool is_same_v = std::is_same::value; //============================================================================ // Class Description: - /// std::is_arithmetic helper, for c++14 compatibility + /// std::is_arithmetic helper, for c++14 compatibility /// template constexpr bool is_arithmetic_v = std::is_arithmetic::value; //============================================================================ // Class Description: - /// std::is_integral helper, for c++14 compatibility + /// std::is_integral helper, for c++14 compatibility /// template constexpr bool is_integral_v = std::is_integral::value; //============================================================================ // Class Description: - /// std::is_floating_point helper, for c++14 compatibility + /// std::is_floating_point helper, for c++14 compatibility /// template constexpr bool is_floating_point_v = std::is_floating_point::value; //============================================================================ // Class Description: - /// Template class for determining if all of the types are arithmetic + /// Template class for determining if all of the types are arithmetic /// template struct all_arithmetic; //============================================================================ // Class Description: - /// Template class specialization for determining if all of the types are arithmetic + /// Template class specialization for determining if all of the types are arithmetic /// template struct all_arithmetic @@ -86,7 +86,7 @@ namespace nc //============================================================================ // Class Description: - /// Template class specialization for determining if all of the types are arithmetic + /// Template class specialization for determining if all of the types are arithmetic /// template struct all_arithmetic @@ -96,21 +96,21 @@ namespace nc //============================================================================ // Class Description: - /// all_arithmetic helper + /// all_arithmetic helper /// template constexpr bool all_arithmetic_v = all_arithmetic::value; //============================================================================ // Class Description: - /// Template class for determining if all of the types are the same as another type + /// Template class for determining if all of the types are the same as another type /// template struct all_same; //============================================================================ // Class Description: - /// Template class specialization for determining if all of the types are the same as another type + /// Template class specialization for determining if all of the types are the same as another type /// template struct all_same @@ -120,7 +120,7 @@ namespace nc //============================================================================ // Class Description: - /// Template class specialization for determining if all of the types are the same as another type + /// Template class specialization for determining if all of the types are the same as another type /// template struct all_same @@ -130,14 +130,14 @@ namespace nc //============================================================================ // Class Description: - /// all_same helper + /// all_same helper /// template constexpr bool all_same_v = all_same::value; //============================================================================ // Class Description: - /// Template class for determining if dtype is a valid dtype for NdArray + /// Template class for determining if dtype is a valid dtype for NdArray /// template struct is_valid_dtype @@ -158,14 +158,14 @@ namespace nc //============================================================================ // Class Description: - /// is_valid_dtype helper + /// is_valid_dtype helper /// template constexpr bool is_valid_dtype_v = is_valid_dtype::value; //============================================================================ // Class Description: - /// Template class for determining if type is std::complex<> + /// Template class for determining if type is std::complex<> /// template struct is_complex @@ -175,7 +175,7 @@ namespace nc //============================================================================ // Class Description: - /// Template class specialization for determining if type is std::complex<> + /// Template class specialization for determining if type is std::complex<> /// template struct is_complex> @@ -185,14 +185,14 @@ namespace nc //============================================================================ // Class Description: - /// is_complex helper + /// is_complex helper /// template constexpr bool is_complex_v = is_complex::value; //============================================================================ // Class Description: - /// type trait to test if one value is larger than another at compile time + /// type trait to test if one value is larger than another at compile time /// template struct greaterThan @@ -202,7 +202,7 @@ namespace nc //============================================================================ // Class Description: - /// greaterThan helper + /// greaterThan helper /// template constexpr bool greaterThan_v = greaterThan::value; diff --git a/include/NumCpp/Core/Shape.hpp b/include/NumCpp/Core/Shape.hpp index eb3b69c3c..c7f1ea28e 100644 --- a/include/NumCpp/Core/Shape.hpp +++ b/include/NumCpp/Core/Shape.hpp @@ -36,7 +36,7 @@ namespace nc { //================================================================================ - /// A Shape Class for NdArrays + /// A Shape Class for NdArrays class Shape { public: @@ -45,12 +45,12 @@ namespace nc uint32 cols{ 0 }; //============================================================================ - /// Constructor + /// Constructor /// constexpr Shape() = default; //============================================================================ - /// Constructor + /// Constructor /// /// @param inSquareSize /// @@ -60,7 +60,7 @@ namespace nc {} //============================================================================ - /// Constructor + /// Constructor /// /// @param inRows /// @param inCols @@ -71,7 +71,7 @@ namespace nc {} //============================================================================ - /// Equality operator + /// Equality operator /// /// @param inOtherShape /// @@ -83,7 +83,7 @@ namespace nc } //============================================================================ - /// Not equality operator + /// Not equality operator /// /// @param inOtherShape /// @@ -95,7 +95,7 @@ namespace nc } //============================================================================ - /// Returns the size of the shape + /// Returns the size of the shape /// /// @return size /// @@ -105,8 +105,8 @@ namespace nc } //============================================================================ - /// Returns whether the shape is null (constructed with the - /// default constructor). + /// Returns whether the shape is null (constructed with the + /// default constructor). /// /// @return bool /// @@ -116,7 +116,7 @@ namespace nc } //============================================================================ - /// Returns whether the shape is square or not. + /// Returns whether the shape is square or not. /// /// @return bool /// @@ -126,7 +126,7 @@ namespace nc } //============================================================================ - /// Returns the shape as a string representation + /// Returns the shape as a string representation /// /// @return std::string /// @@ -137,7 +137,7 @@ namespace nc } //============================================================================ - /// Prints the shape to the console + /// Prints the shape to the console /// void print() const { @@ -145,7 +145,7 @@ namespace nc } //============================================================================ - /// IO operator for the Shape class + /// IO operator for the Shape class /// /// @param inOStream /// @param inShape diff --git a/include/NumCpp/Core/Slice.hpp b/include/NumCpp/Core/Slice.hpp index d5268bf5b..548d0fbac 100644 --- a/include/NumCpp/Core/Slice.hpp +++ b/include/NumCpp/Core/Slice.hpp @@ -39,7 +39,7 @@ namespace nc { //================================================================================ - /// A Class for slicing into NdArrays + /// A Class for slicing into NdArrays class Slice { public: @@ -49,12 +49,12 @@ namespace nc int32 step{ 1 }; //============================================================================ - /// Constructor + /// Constructor /// constexpr Slice() = default; //============================================================================ - /// Constructor + /// Constructor /// /// @param inStop (index not included) /// @@ -63,7 +63,7 @@ namespace nc {} //============================================================================ - /// Constructor + /// Constructor /// /// @param inStart /// @param inStop (index not included) @@ -74,7 +74,7 @@ namespace nc {} //============================================================================ - /// Constructor + /// Constructor /// /// @param inStart /// @param inStop (not included) @@ -87,7 +87,7 @@ namespace nc {} //============================================================================ - /// Equality operator + /// Equality operator /// /// @param inOtherSlice /// @@ -99,7 +99,7 @@ namespace nc } //============================================================================ - /// Not equality operator + /// Not equality operator /// /// @param inOtherSlice /// @@ -111,7 +111,7 @@ namespace nc } //============================================================================ - /// Prints the shape to the console + /// Prints the shape to the console /// /// @return std::string /// @@ -122,7 +122,7 @@ namespace nc } //============================================================================ - /// Prints the shape to the console + /// Prints the shape to the console /// void print() const { @@ -130,7 +130,7 @@ namespace nc } //============================================================================ - /// Make the slice all positive and does some error checking + /// Make the slice all positive and does some error checking /// /// @param inArraySize /// @@ -179,9 +179,9 @@ namespace nc } //============================================================================ - /// Returns the number of elements that the slice contains. - /// be aware that this method will also make the slice all - /// positive! + /// Returns the number of elements that the slice contains. + /// be aware that this method will also make the slice all + /// positive! /// /// @param inArraySize /// @@ -198,7 +198,7 @@ namespace nc } //============================================================================ - /// IO operator for the Slice class + /// IO operator for the Slice class /// /// @param inOStream /// @param inSlice diff --git a/include/NumCpp/Core/Timer.hpp b/include/NumCpp/Core/Timer.hpp index 552759823..00193ab1a 100644 --- a/include/NumCpp/Core/Timer.hpp +++ b/include/NumCpp/Core/Timer.hpp @@ -38,7 +38,7 @@ namespace nc { //================================================================================ - /// A timer class for timing code execution + /// A timer class for timing code execution template class Timer { @@ -49,7 +49,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// Timer() : start_(ChronoClock::now()) @@ -59,7 +59,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inName /// @@ -72,7 +72,7 @@ namespace nc //============================================================================ // Method Description: - /// Sets/changes the timer name + /// Sets/changes the timer name /// /// @param inName /// @@ -83,7 +83,7 @@ namespace nc //============================================================================ // Method Description: - /// Sleeps the current thread + /// Sleeps the current thread /// /// @param length: the length of time to sleep /// @@ -94,7 +94,7 @@ namespace nc //============================================================================ // Method Description: - /// Starts the timer + /// Starts the timer /// void tic() noexcept { @@ -103,10 +103,10 @@ namespace nc //============================================================================ // Method Description: - /// Stops the timer + /// Stops the timer /// /// @param printElapsedTime: bool whether or not to print the elapsed time to - /// the console + /// the console /// @return ellapsed time in specified time units /// uint64 toc(bool printElapsedTime = true) diff --git a/include/NumCpp/Core/Types.hpp b/include/NumCpp/Core/Types.hpp index a65c6dede..360a7c1d7 100644 --- a/include/NumCpp/Core/Types.hpp +++ b/include/NumCpp/Core/Types.hpp @@ -42,10 +42,10 @@ namespace nc using uint8 = std::uint8_t; //================================================================================ - /// Enum To describe an axis + /// Enum To describe an axis enum class Axis { NONE = 0, ROW, COL }; //================================================================================ - /// Enum for endianess + /// Enum for endianess enum class Endian { NATIVE = 0, BIG, LITTLE }; } // namespace nc diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp index e1e843267..c8353daea 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp @@ -48,14 +48,14 @@ namespace nc { //============================================================================ // Method Description: - /// Wrap boundary + /// Wrap boundary /// /// @param inImage /// @param inBoundaryType /// @param inKernalSize /// @param inConstantValue (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray addBoundary1d(const NdArray& inImage, Boundary inBoundaryType, uint32 inKernalSize, dtype inConstantValue = 0) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp index a867224c8..31a37d55f 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp @@ -40,13 +40,13 @@ namespace nc { //============================================================================ // Method Description: - /// Constant boundary1d + /// Constant boundary1d /// /// @param inImage /// @param inBoundarySize /// @param inConstantValue /// @return - /// NdArray + /// NdArray /// template NdArray constant1d(const NdArray& inImage, uint32 inBoundarySize, dtype inConstantValue) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp index c740fbee7..02c868124 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp @@ -41,12 +41,12 @@ namespace nc { //============================================================================ // Method Description: - /// Mirror boundary1d + /// Mirror boundary1d /// /// @param inImage /// @param inBoundarySize /// @return - /// NdArray + /// NdArray /// template NdArray mirror1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp index 8406677d7..318c865ad 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp @@ -39,12 +39,12 @@ namespace nc { //============================================================================ // Method Description: - /// Nearest boundary1d + /// Nearest boundary1d /// /// @param inImage /// @param inBoundarySize /// @return - /// NdArray + /// NdArray /// template NdArray nearest1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp index a6812b89d..f891b31dc 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp @@ -41,7 +41,7 @@ namespace nc { //============================================================================ // Method Description: - /// Reflects the boundaries + /// Reflects the boundaries /// /// @param inImage /// @param inBoundarySize diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp index ca373978d..1a54d37fa 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp @@ -40,12 +40,12 @@ namespace nc { //============================================================================ // Method Description: - /// trims the boundary off to make the image back to the original size + /// trims the boundary off to make the image back to the original size /// /// @param inImageWithBoundary /// @param inSize /// @return - /// NdArray + /// NdArray /// template NdArray trimBoundary1d(const NdArray& inImageWithBoundary, uint32 inSize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp index 59ec3f555..882393981 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp @@ -40,12 +40,12 @@ namespace nc { //============================================================================ // Method Description: - /// Wrap boundary1d + /// Wrap boundary1d /// /// @param inImage /// @param inBoundarySize /// @return - /// NdArray + /// NdArray /// template NdArray wrap1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp index b1dfbfe13..40c77e4af 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp @@ -48,14 +48,14 @@ namespace nc { //============================================================================ // Method Description: - /// Wrap boundary + /// Wrap boundary /// /// @param inImage /// @param inBoundaryType /// @param inKernalSize /// @param inConstantValue (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray addBoundary2d(const NdArray& inImage, Boundary inBoundaryType, uint32 inKernalSize, dtype inConstantValue = 0) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp index cd4b016bb..18471cb50 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp @@ -42,13 +42,13 @@ namespace nc { //============================================================================ // Method Description: - /// Constant boundary + /// Constant boundary /// /// @param inImage /// @param inBoundarySize /// @param inConstantValue /// @return - /// NdArray + /// NdArray /// template NdArray constant2d(const NdArray& inImage, uint32 inBoundarySize, dtype inConstantValue) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp index c85389d70..9111a5345 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp @@ -41,7 +41,7 @@ namespace nc { //============================================================================ // Method Description: - /// extends the corner values + /// extends the corner values /// /// @param inArray /// @param inBorderWidth @@ -74,7 +74,7 @@ namespace nc //============================================================================ // Method Description: - /// extends the corner values + /// extends the corner values /// /// @param inArray /// @param inBorderWidth diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp index b884b77cb..83a739e82 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp @@ -42,12 +42,12 @@ namespace nc { //============================================================================ // Method Description: - /// Mirror boundary + /// Mirror boundary /// /// @param inImage /// @param inBoundarySize /// @return - /// NdArray + /// NdArray /// template NdArray mirror2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp index 7fcfb5030..628d41598 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp @@ -42,12 +42,12 @@ namespace nc { //============================================================================ // Method Description: - /// Nearest boundary + /// Nearest boundary /// /// @param inImage /// @param inBoundarySize /// @return - /// NdArray + /// NdArray /// template NdArray nearest2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp index e1086d8bc..bc66bcd40 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp @@ -42,13 +42,13 @@ namespace nc { //============================================================================ // Method Description: - /// Reflects the boundaries + /// Reflects the boundaries /// /// @param inImage /// @param inBoundarySize /// /// @return - /// NdArray + /// NdArray /// template NdArray reflect2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp index 631fab916..5418fdeaf 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp @@ -41,12 +41,12 @@ namespace nc { //============================================================================ // Method Description: - /// trims the boundary off to make the image back to the original size + /// trims the boundary off to make the image back to the original size /// /// @param inImageWithBoundary /// @param inSize /// @return - /// NdArray + /// NdArray /// template NdArray trimBoundary2d(const NdArray& inImageWithBoundary, uint32 inSize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp index 86c49870f..b5bcb2569 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp @@ -42,12 +42,12 @@ namespace nc { //============================================================================ // Method Description: - /// Wrap boundary + /// Wrap boundary /// /// @param inImage /// @param inBoundarySize /// @return - /// NdArray + /// NdArray /// template NdArray wrap2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundary.hpp b/include/NumCpp/Filter/Boundaries/Boundary.hpp index f4a85eab4..d596bda4c 100644 --- a/include/NumCpp/Filter/Boundaries/Boundary.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundary.hpp @@ -33,7 +33,7 @@ namespace nc { //================================================================================ // Enum Description: - /// Boundary condition to apply to the image filter + /// Boundary condition to apply to the image filter enum class Boundary { REFLECT = 0, CONSTANT, NEAREST, MIRROR, WRAP }; } // namespace filter } // namespace nc diff --git a/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp index d7677e09d..3cac2fdb0 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate a one-dimensional complemenatry median filter. + /// Calculate a one-dimensional complemenatry median filter. /// /// @param inImageArray /// @param inSize: square size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray complementaryMedianFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp index e6c8ce29f..b039981e5 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp @@ -41,16 +41,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional kernel convolution. + /// Calculates a one-dimensional kernel convolution. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.convolve1d.html#scipy.ndimage.convolve1d + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.convolve1d.html#scipy.ndimage.convolve1d /// /// @param inImageArray /// @param inWeights /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray convolve1d(const NdArray& inImageArray, const NdArray& inWeights, diff --git a/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp index a9b7e93ea..0410fd15f 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp @@ -43,16 +43,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate a one-dimensional gaussian filter. + /// Calculate a one-dimensional gaussian filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.generic_filter1d.html#scipy.ndimage.generic_filter1d + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.generic_filter1d.html#scipy.ndimage.generic_filter1d /// /// @param inImageArray /// @param inSigma: Standard deviation for Gaussian kernel /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray gaussianFilter1d(const NdArray& inImageArray, double inSigma, diff --git a/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp index cbd3a2865..ca9064bfe 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional maximum filter. + /// Calculates a one-dimensional maximum filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.maximum_filter1d.html#scipy.ndimage.maximum_filter1d + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.maximum_filter1d.html#scipy.ndimage.maximum_filter1d /// /// @param inImageArray /// @param inSize: linear size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray maximumFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp index 6249dbf19..018cb4ba4 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional median filter. + /// Calculates a one-dimensional median filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.median_filter.html#scipy.ndimage.median_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.median_filter.html#scipy.ndimage.median_filter /// /// @param inImageArray /// @param inSize: linear size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray medianFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp index d6be7b19f..c82069a08 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional minumum filter. + /// Calculates a one-dimensional minumum filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.minimum_filter1d.html#scipy.ndimage.minimum_filter1d + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.minimum_filter1d.html#scipy.ndimage.minimum_filter1d /// /// @param inImageArray /// @param inSize: linear size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray minumumFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp index 1a828b0e6..056a70612 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp @@ -40,9 +40,9 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional percentile filter. + /// Calculates a one-dimensional percentile filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.percentile_filter.html#scipy.ndimage.percentile_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.percentile_filter.html#scipy.ndimage.percentile_filter /// /// @param inImageArray /// @param inSize: linear size of the kernel to apply @@ -50,7 +50,7 @@ namespace nc /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray percentileFilter1d(const NdArray& inImageArray, uint32 inSize, double inPercentile, diff --git a/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp index 4223a8d54..474725d1b 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp @@ -40,9 +40,9 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional rank filter. + /// Calculates a one-dimensional rank filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.rank_filter.html#scipy.ndimage.rank_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.rank_filter.html#scipy.ndimage.rank_filter /// /// @param inImageArray /// @param inSize: linear size of the kernel to apply @@ -50,7 +50,7 @@ namespace nc /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray rankFilter1d(const NdArray& inImageArray, uint32 inSize, uint8 inRank, diff --git a/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp index 4cbb44672..9197733ba 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp @@ -40,16 +40,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a one-dimensional uniform filter. + /// Calculates a one-dimensional uniform filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.uniform_filter1d.html#scipy.ndimage.uniform_filter1d + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.uniform_filter1d.html#scipy.ndimage.uniform_filter1d /// /// @param inImageArray /// @param inSize: linear size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray uniformFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp index 2299de08e..a2e85edfe 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional complemenatry median filter. + /// Calculates a multidimensional complemenatry median filter. /// /// @param inImageArray /// @param inSize: square size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray complementaryMedianFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp b/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp index 036fd71bf..7fa7cb00e 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp @@ -46,9 +46,9 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional kernel convolution. + /// Calculates a multidimensional kernel convolution. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.convolve.html#scipy.ndimage.convolve + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.convolve.html#scipy.ndimage.convolve /// /// @param inImageArray /// @param inSize: square size of the kernel to apply @@ -56,7 +56,7 @@ namespace nc /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray convolve(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp index 64e992760..2ead49bf9 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp @@ -43,16 +43,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional gaussian filter. + /// Calculates a multidimensional gaussian filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.gaussian_filter.html#scipy.ndimage.gaussian_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.gaussian_filter.html#scipy.ndimage.gaussian_filter /// /// @param inImageArray /// @param inSigma: Standard deviation for Gaussian kernel /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray gaussianFilter(const NdArray& inImageArray, double inSigma, diff --git a/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp b/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp index 9f811303b..588655d5d 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp @@ -36,15 +36,15 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate the 2D laplace filter. + /// Calculate the 2D laplace filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.laplace.html#scipy.ndimage.laplace + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.laplace.html#scipy.ndimage.laplace /// /// @param inImageArray /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray laplace(const NdArray& inImageArray, Boundary inBoundaryType = Boundary::REFLECT, dtype inConstantValue = 0) diff --git a/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp index 637b0a5e0..2991daf1b 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional maximum filter. + /// Calculates a multidimensional maximum filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.maximum_filter.html#scipy.ndimage.maximum_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.maximum_filter.html#scipy.ndimage.maximum_filter /// /// @param inImageArray /// @param inSize: square size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray maximumFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp index 6ddee6654..8f91e5af3 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional median filter. + /// Calculates a multidimensional median filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.median_filter.html#scipy.ndimage.median_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.median_filter.html#scipy.ndimage.median_filter /// /// @param inImageArray /// @param inSize: square size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray medianFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp index 93cd140f1..9e4f912ef 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional minimum filter. + /// Calculates a multidimensional minimum filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.minimum_filter.html#scipy.ndimage.minimum_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.minimum_filter.html#scipy.ndimage.minimum_filter /// /// @param inImageArray /// @param inSize: square size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray minimumFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp index 2888a339f..e07b2c189 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp @@ -40,9 +40,9 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional percentile filter. + /// Calculates a multidimensional percentile filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.percentile_filter.html#scipy.ndimage.percentile_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.percentile_filter.html#scipy.ndimage.percentile_filter /// /// @param inImageArray /// @param inSize: square size of the kernel to apply @@ -50,7 +50,7 @@ namespace nc /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray percentileFilter(const NdArray& inImageArray, uint32 inSize, double inPercentile, diff --git a/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp index 185924c13..e45893cff 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp @@ -43,9 +43,9 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional rank filter. + /// Calculates a multidimensional rank filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.rank_filter.html#scipy.ndimage.rank_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.rank_filter.html#scipy.ndimage.rank_filter /// /// @param inImageArray /// @param inSize: square size of the kernel to apply @@ -53,7 +53,7 @@ namespace nc /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray rankFilter(const NdArray& inImageArray, uint32 inSize, uint32 inRank, diff --git a/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp index 93879b6b0..8bf12c3bc 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp @@ -40,16 +40,16 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a multidimensional uniform filter. + /// Calculates a multidimensional uniform filter. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.uniform_filter.html#scipy.ndimage.uniform_filter + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.uniform_filter.html#scipy.ndimage.uniform_filter /// /// @param inImageArray /// @param inSize: square size of the kernel to apply /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) /// @param inConstantValue: contant value if boundary = 'constant' (default 0) /// @return - /// NdArray + /// NdArray /// template NdArray uniformFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Functions/abs.hpp b/include/NumCpp/Functions/abs.hpp index a2b7ec59c..0838b049e 100644 --- a/include/NumCpp/Functions/abs.hpp +++ b/include/NumCpp/Functions/abs.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate the absolute value. + /// Calculate the absolute value. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.absolute.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.absolute.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto abs(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Calculate the absolute value element-wise. + /// Calculate the absolute value element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.absolute.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.absolute.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto abs(const NdArray& inArray) diff --git a/include/NumCpp/Functions/add.hpp b/include/NumCpp/Functions/add.hpp index af1f897ab..fb18a6f05 100644 --- a/include/NumCpp/Functions/add.hpp +++ b/include/NumCpp/Functions/add.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray add(const NdArray& inArray1, const NdArray& inArray2) @@ -52,14 +52,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray add(const NdArray& inArray, dtype value) @@ -69,14 +69,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray add(dtype value, const NdArray& inArray) @@ -86,14 +86,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> add(const NdArray& inArray1, const NdArray>& inArray2) @@ -103,14 +103,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> add(const NdArray>& inArray1, const NdArray& inArray2) @@ -120,14 +120,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> add(const NdArray& inArray, const std::complex& value) @@ -137,14 +137,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> add(const std::complex& value, const NdArray& inArray) @@ -154,14 +154,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> add(const NdArray>& inArray, dtype value) @@ -171,14 +171,14 @@ namespace nc //============================================================================ // Method Description: - /// Add arguments element-wise. + /// Add arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> add(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/alen.hpp b/include/NumCpp/Functions/alen.hpp index a67efe4f5..6dbb142af 100644 --- a/include/NumCpp/Functions/alen.hpp +++ b/include/NumCpp/Functions/alen.hpp @@ -34,12 +34,12 @@ namespace nc { //============================================================================ // Method Description: - /// Return the length of the first dimension of the input array. + /// Return the length of the first dimension of the input array. /// /// @param - /// inArray + /// inArray /// @return - /// length uint16 + /// length uint16 /// template uint32 alen(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/all.hpp b/include/NumCpp/Functions/all.hpp index f5e14bf0e..66818f8a5 100644 --- a/include/NumCpp/Functions/all.hpp +++ b/include/NumCpp/Functions/all.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Test whether all array elements along a given axis evaluate to True. + /// Test whether all array elements along a given axis evaluate to True. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.all.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.all.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// bool + /// bool /// template NdArray all(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/allclose.hpp b/include/NumCpp/Functions/allclose.hpp index 77744d40a..030b7ba48 100644 --- a/include/NumCpp/Functions/allclose.hpp +++ b/include/NumCpp/Functions/allclose.hpp @@ -40,16 +40,16 @@ namespace nc { //============================================================================ // Method Description: - /// Returns True if two arrays are element-wise equal within a tolerance. - /// inTolerance must be a positive number + /// Returns True if two arrays are element-wise equal within a tolerance. + /// inTolerance must be a positive number /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.allclose.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.allclose.html /// /// @param inArray1 /// @param inArray2 /// @param inTolerance: (Optional, default 1e-5) /// @return - /// bool + /// bool /// template bool allclose(const NdArray& inArray1, const NdArray& inArray2, double inTolerance = 1e-5) diff --git a/include/NumCpp/Functions/amax.hpp b/include/NumCpp/Functions/amax.hpp index dbad5d0a2..77060d3f5 100644 --- a/include/NumCpp/Functions/amax.hpp +++ b/include/NumCpp/Functions/amax.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the maximum of an array or maximum along an axis. + /// Return the maximum of an array or maximum along an axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.amax.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.amax.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// max value + /// max value /// template NdArray amax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/amin.hpp b/include/NumCpp/Functions/amin.hpp index ce8d397e1..e9c470398 100644 --- a/include/NumCpp/Functions/amin.hpp +++ b/include/NumCpp/Functions/amin.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the minimum of an array or minimum along an axis. + /// Return the minimum of an array or minimum along an axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.amin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.amin.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// min value + /// min value /// template NdArray amin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/angle.hpp b/include/NumCpp/Functions/angle.hpp index 6812120d7..82490970b 100644 --- a/include/NumCpp/Functions/angle.hpp +++ b/include/NumCpp/Functions/angle.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the angle of the complex argument. + /// Return the angle of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.angle.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.angle.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto angle(const std::complex& inValue) @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the angle of the complex argument. + /// Return the angle of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.angle.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.angle.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto angle(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/any.hpp b/include/NumCpp/Functions/any.hpp index b392785a1..503010b3e 100644 --- a/include/NumCpp/Functions/any.hpp +++ b/include/NumCpp/Functions/any.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Test whether any array element along a given axis evaluates to True. + /// Test whether any array element along a given axis evaluates to True. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.any.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.any.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray any(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/append.hpp b/include/NumCpp/Functions/append.hpp index ad6fd2ad2..4f7486f53 100644 --- a/include/NumCpp/Functions/append.hpp +++ b/include/NumCpp/Functions/append.hpp @@ -38,17 +38,17 @@ namespace nc { //============================================================================ // Method Description: - /// Append values to the end of an array. + /// Append values to the end of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.append.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.append.html /// /// @param inArray /// @param inAppendValues /// @param inAxis (Optional, default NONE): The axis along which values are appended. - /// If axis is not given, both inArray and inAppendValues - /// are flattened before use. + /// If axis is not given, both inArray and inAppendValues + /// are flattened before use. /// @return - /// NdArray + /// NdArray /// template NdArray append(const NdArray& inArray, const NdArray& inAppendValues, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/applyFunction.hpp b/include/NumCpp/Functions/applyFunction.hpp index 2c046ddb2..ec0985cf1 100644 --- a/include/NumCpp/Functions/applyFunction.hpp +++ b/include/NumCpp/Functions/applyFunction.hpp @@ -36,13 +36,13 @@ namespace nc { //============================================================================ // Method Description: - /// Apply the input function element wise to the input - /// array in place. + /// Apply the input function element wise to the input + /// array in place. /// /// @param inArray /// @param inFunc /// @return - /// NdArray + /// NdArray /// template void applyFunction(NdArray& inArray, const std::function& inFunc) diff --git a/include/NumCpp/Functions/applyPoly1d.hpp b/include/NumCpp/Functions/applyPoly1d.hpp index fae3c6f1f..744b6c4af 100644 --- a/include/NumCpp/Functions/applyPoly1d.hpp +++ b/include/NumCpp/Functions/applyPoly1d.hpp @@ -35,12 +35,12 @@ namespace nc { //============================================================================ // Method Description: - /// Apply polynomial elemnt wise to the input values. + /// Apply polynomial elemnt wise to the input values. /// /// @param inArray /// @param inPoly /// @return - /// NdArray + /// NdArray /// template void applyPoly1d(NdArray& inArray, const polynomial::Poly1d& inPoly) diff --git a/include/NumCpp/Functions/arange.hpp b/include/NumCpp/Functions/arange.hpp index 233092284..bae66f305 100644 --- a/include/NumCpp/Functions/arange.hpp +++ b/include/NumCpp/Functions/arange.hpp @@ -38,23 +38,23 @@ namespace nc { //============================================================================ // Method Description: - /// Return evenly spaced values within a given interval. + /// Return evenly spaced values within a given interval. /// - /// Values are generated within the half - open interval[start, stop) - /// (in other words, the interval including start but excluding stop). - /// For integer arguments the function is equivalent to the Python built - in - /// range function, but returns an ndarray rather than a list. + /// Values are generated within the half - open interval[start, stop) + /// (in other words, the interval including start but excluding stop). + /// For integer arguments the function is equivalent to the Python built - in + /// range function, but returns an ndarray rather than a list. /// - /// When using a non - integer step, such as 0.1, the results will often - /// not be consistent.It is better to use linspace for these cases. + /// When using a non - integer step, such as 0.1, the results will often + /// not be consistent.It is better to use linspace for these cases. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html /// /// @param inStart /// @param inStop /// @param inStep: (Optional, defaults to 1) /// @return - /// NdArray + /// NdArray /// template NdArray arange(dtype inStart, dtype inStop, dtype inStep = 1) @@ -98,22 +98,22 @@ namespace nc //============================================================================ // Method Description: - /// Return evenly spaced values within a given interval. + /// Return evenly spaced values within a given interval. /// - /// Values are generated within the half - open interval[start, stop) - /// (in other words, the interval including start but excluding stop). - /// For integer arguments the function is equivalent to the Python built - in - /// range function, but returns an ndarray rather than a list. + /// Values are generated within the half - open interval[start, stop) + /// (in other words, the interval including start but excluding stop). + /// For integer arguments the function is equivalent to the Python built - in + /// range function, but returns an ndarray rather than a list. /// - /// When using a non - integer step, such as 0.1, the results will often - /// not be consistent.It is better to use linspace for these cases. + /// When using a non - integer step, such as 0.1, the results will often + /// not be consistent.It is better to use linspace for these cases. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html /// /// @param - /// inStop: start is 0 and step is 1 + /// inStop: start is 0 and step is 1 /// @return - /// NdArray + /// NdArray /// template NdArray arange(dtype inStop) @@ -128,22 +128,22 @@ namespace nc //============================================================================ // Method Description: - /// Return evenly spaced values within a given interval. + /// Return evenly spaced values within a given interval. /// - /// Values are generated within the half - open interval[start, stop) - /// (in other words, the interval including start but excluding stop). - /// For integer arguments the function is equivalent to the Python built - in - /// range function, but returns an ndarray rather than a list. + /// Values are generated within the half - open interval[start, stop) + /// (in other words, the interval including start but excluding stop). + /// For integer arguments the function is equivalent to the Python built - in + /// range function, but returns an ndarray rather than a list. /// - /// When using a non - integer step, such as 0.1, the results will often - /// not be consistent.It is better to use linspace for these cases. + /// When using a non - integer step, such as 0.1, the results will often + /// not be consistent.It is better to use linspace for these cases. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html /// /// @param - /// inSlice + /// inSlice /// @return - /// NdArray + /// NdArray /// template NdArray arange(const Slice& inSlice) diff --git a/include/NumCpp/Functions/arccos.hpp b/include/NumCpp/Functions/arccos.hpp index fa7754895..174c10b61 100644 --- a/include/NumCpp/Functions/arccos.hpp +++ b/include/NumCpp/Functions/arccos.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse cosine + /// Trigonometric inverse cosine /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccos.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccos.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto arccos(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse cosine, element-wise. + /// Trigonometric inverse cosine, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccos.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccos.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto arccos(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arccosh.hpp b/include/NumCpp/Functions/arccosh.hpp index b85f52519..811ac12ff 100644 --- a/include/NumCpp/Functions/arccosh.hpp +++ b/include/NumCpp/Functions/arccosh.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse hyperbolic cosine. + /// Trigonometric inverse hyperbolic cosine. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccosh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccosh.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto arccosh(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse hyperbolic cosine, element-wise. + /// Trigonometric inverse hyperbolic cosine, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccosh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccosh.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto arccosh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arcsin.hpp b/include/NumCpp/Functions/arcsin.hpp index 250d52117..c764f64e9 100644 --- a/include/NumCpp/Functions/arcsin.hpp +++ b/include/NumCpp/Functions/arcsin.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse sine. + /// Trigonometric inverse sine. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsin.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto arcsin(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse sine, element-wise. + /// Trigonometric inverse sine, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsin.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto arcsin(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arcsinh.hpp b/include/NumCpp/Functions/arcsinh.hpp index d3a0a6975..e00b5b0fd 100644 --- a/include/NumCpp/Functions/arcsinh.hpp +++ b/include/NumCpp/Functions/arcsinh.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse hyperbolic sine. + /// Trigonometric inverse hyperbolic sine. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsinh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsinh.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto arcsinh(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse hyperbolic sine, element-wise. + /// Trigonometric inverse hyperbolic sine, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsinh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsinh.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto arcsinh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arctan.hpp b/include/NumCpp/Functions/arctan.hpp index 628bc732b..e11fd0df4 100644 --- a/include/NumCpp/Functions/arctan.hpp +++ b/include/NumCpp/Functions/arctan.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse tangent. + /// Trigonometric inverse tangent. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto arctan(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse tangent, element-wise. + /// Trigonometric inverse tangent, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto arctan(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arctan2.hpp b/include/NumCpp/Functions/arctan2.hpp index 2f4596cea..2d481ab8d 100644 --- a/include/NumCpp/Functions/arctan2.hpp +++ b/include/NumCpp/Functions/arctan2.hpp @@ -39,14 +39,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse tangent. + /// Trigonometric inverse tangent. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan2.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan2.html /// /// @param inY /// @param inX /// @return - /// value + /// value /// template auto arctan2(dtype inY, dtype inX) noexcept @@ -58,14 +58,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse tangent, element-wise. + /// Trigonometric inverse tangent, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan2.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan2.html /// /// @param inY /// @param inX /// @return - /// NdArray + /// NdArray /// template auto arctan2(const NdArray& inY, const NdArray& inX) diff --git a/include/NumCpp/Functions/arctanh.hpp b/include/NumCpp/Functions/arctanh.hpp index d2811d906..d3dd209a0 100644 --- a/include/NumCpp/Functions/arctanh.hpp +++ b/include/NumCpp/Functions/arctanh.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric inverse hyperbolic tangent. + /// Trigonometric inverse hyperbolic tangent. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctanh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctanh.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto arctanh(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric inverse hyperbolic tangent, element-wise. + /// Trigonometric inverse hyperbolic tangent, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctanh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctanh.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto arctanh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/argmax.hpp b/include/NumCpp/Functions/argmax.hpp index a5530bbad..01c4a028d 100644 --- a/include/NumCpp/Functions/argmax.hpp +++ b/include/NumCpp/Functions/argmax.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the indices of the maximum values along an axis. + /// Returns the indices of the maximum values along an axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argmax.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argmax.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray argmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/argmin.hpp b/include/NumCpp/Functions/argmin.hpp index 45e6b97f4..bbbce3529 100644 --- a/include/NumCpp/Functions/argmin.hpp +++ b/include/NumCpp/Functions/argmin.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the indices of the minimum values along an axis. + /// Returns the indices of the minimum values along an axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argmin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argmin.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray argmin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/argsort.hpp b/include/NumCpp/Functions/argsort.hpp index 27e7d672f..3aedb5a1d 100644 --- a/include/NumCpp/Functions/argsort.hpp +++ b/include/NumCpp/Functions/argsort.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the indices that would sort an array. + /// Returns the indices that would sort an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argsort.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argsort.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray argsort(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/argwhere.hpp b/include/NumCpp/Functions/argwhere.hpp index 0bf215252..3a9fd388b 100644 --- a/include/NumCpp/Functions/argwhere.hpp +++ b/include/NumCpp/Functions/argwhere.hpp @@ -34,13 +34,13 @@ namespace nc { //============================================================================ // Method Description: - /// Find the indices of array elements that are non-zero, grouped by element. + /// Find the indices of array elements that are non-zero, grouped by element. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argwhere.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argwhere.html /// /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray argwhere(const NdArray& inArray) diff --git a/include/NumCpp/Functions/around.hpp b/include/NumCpp/Functions/around.hpp index 9a9277ac4..e54327839 100644 --- a/include/NumCpp/Functions/around.hpp +++ b/include/NumCpp/Functions/around.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Evenly round to the given number of decimals. + /// Evenly round to the given number of decimals. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.around.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.around.html /// /// @param inValue /// @param inNumDecimals: (Optional, default = 0) /// @return - /// value + /// value /// template dtype around(dtype inValue, uint8 inNumDecimals = 0) @@ -51,14 +51,14 @@ namespace nc //============================================================================ // Method Description: - /// Evenly round to the given number of decimals. + /// Evenly round to the given number of decimals. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.around.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.around.html /// /// @param inArray /// @param inNumDecimals: (Optional, default = 0) /// @return - /// NdArray + /// NdArray /// template NdArray around(const NdArray& inArray, uint8 inNumDecimals = 0) diff --git a/include/NumCpp/Functions/array_equal.hpp b/include/NumCpp/Functions/array_equal.hpp index 8ccbc9521..f688d76cb 100644 --- a/include/NumCpp/Functions/array_equal.hpp +++ b/include/NumCpp/Functions/array_equal.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// True if two arrays have the same shape and elements, False otherwise. + /// True if two arrays have the same shape and elements, False otherwise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.array_equal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.array_equal.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// bool + /// bool /// template bool array_equal(const NdArray& inArray1, const NdArray& inArray2) noexcept diff --git a/include/NumCpp/Functions/array_equiv.hpp b/include/NumCpp/Functions/array_equiv.hpp index 81edb3b35..af2176ba2 100644 --- a/include/NumCpp/Functions/array_equiv.hpp +++ b/include/NumCpp/Functions/array_equiv.hpp @@ -38,18 +38,18 @@ namespace nc { //============================================================================ // Method Description: - /// Returns True if input arrays are shape consistent and all elements equal. + /// Returns True if input arrays are shape consistent and all elements equal. /// - /// Shape consistent means they are either the same shape, or one input array - /// can be broadcasted to create the same shape as the other one. + /// Shape consistent means they are either the same shape, or one input array + /// can be broadcasted to create the same shape as the other one. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.array_equiv.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.array_equiv.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// bool + /// bool /// template bool array_equiv(const NdArray& inArray1, const NdArray& inArray2) noexcept diff --git a/include/NumCpp/Functions/asarray.hpp b/include/NumCpp/Functions/asarray.hpp index 778ff226a..81e3181c8 100644 --- a/include/NumCpp/Functions/asarray.hpp +++ b/include/NumCpp/Functions/asarray.hpp @@ -43,15 +43,15 @@ namespace nc { //============================================================================ // Method Description: - /// Convert the list initializer to an array. - /// eg: NdArray myArray = NC::asarray({1,2,3}); + /// Convert the list initializer to an array. + /// eg: NdArray myArray = NC::asarray({1,2,3}); /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param - /// inList + /// inList /// @return - /// NdArray + /// NdArray /// template, int> = 0> @@ -62,15 +62,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert the list initializer to an array. - /// eg: NdArray myArray = NC::asarray({{1,2,3}, {4, 5, 6}}); + /// Convert the list initializer to an array. + /// eg: NdArray myArray = NC::asarray({{1,2,3}, {4, 5, 6}}); /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param - /// inList + /// inList /// @return - /// NdArray + /// NdArray /// template NdArray asarray(std::initializer_list > inList) @@ -80,15 +80,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert the std::array to an array. + /// Convert the std::array to an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// @return - /// NdArray + /// NdArray /// template, int> = 0> @@ -99,15 +99,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert the std::array to an array. + /// Convert the std::array to an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// @return - /// NdArray + /// NdArray /// template NdArray asarray(std::array, Dim0Size>& inArray, bool copy = true) @@ -117,15 +117,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert the vector to an array. + /// Convert the vector to an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inVector - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// @return - /// NdArray + /// NdArray /// template, int> = 0> @@ -136,13 +136,13 @@ namespace nc //============================================================================ // Method Description: - /// Convert the vector to an array. Makes a copy of the data. + /// Convert the vector to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inVector /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const std::vector>& inVector) @@ -152,15 +152,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert the vector to an array. + /// Convert the vector to an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inVector - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// @return - /// NdArray + /// NdArray /// template NdArray asarray(std::vector>& inVector, bool copy = true) @@ -170,13 +170,13 @@ namespace nc //============================================================================ // Method Description: - /// Convert the vector to an array. + /// Convert the vector to an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inDeque /// @return - /// NdArray + /// NdArray /// template, int> = 0> @@ -187,13 +187,13 @@ namespace nc //============================================================================ // Method Description: - /// Convert the vector to an array. Makes a copy of the data. + /// Convert the vector to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param inDeque /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const std::deque>& inDeque) @@ -203,14 +203,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert the set to an array. Makes a copy of the data. + /// Convert the set to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param - /// inSet + /// inSet /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const std::set& inSet) @@ -220,14 +220,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert the list to an array. Makes a copy of the data. + /// Convert the list to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param - /// inList + /// inList /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const std::list& inList) @@ -237,14 +237,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert the forward_list to an array. Makes a copy of the data. + /// Convert the forward_list to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param iterBegin /// @param iterEnd /// @return - /// NdArray + /// NdArray /// template auto asarray(Iterator iterBegin, Iterator iterEnd) @@ -254,14 +254,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert the forward_list to an array. Makes a copy of the data. + /// Convert the forward_list to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param iterBegin /// @param iterEnd /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const dtype* iterBegin, const dtype* iterEnd) @@ -271,14 +271,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert the c-style array to an array. Makes a copy of the data. + /// Convert the c-style array to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param ptr to array /// @param size: the number of elements in the array /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const dtype* ptr, uint32 size) @@ -288,15 +288,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert the c-style array to an array. Makes a copy of the data. + /// Convert the c-style array to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param ptr to array /// @param numRows: number of rows of the buffer /// @param numCols: number of cols of the buffer /// @return - /// NdArray + /// NdArray /// template NdArray asarray(const dtype* ptr, uint32 numRows, uint32 numCols) @@ -306,16 +306,16 @@ namespace nc //============================================================================ // Method Description: - /// Convert the c-style array to an array. Makes a copy of the data. + /// Convert the c-style array to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param ptr to array /// @param size: the number of elements in the array /// @param takeOwnership: whether or not to take ownership of the data - /// and call delete[] in the destructor. + /// and call delete[] in the destructor. /// @return - /// NdArray + /// NdArray /// template::value, int> = 0> @@ -326,17 +326,17 @@ namespace nc //============================================================================ // Method Description: - /// Convert the c-style array to an array. Makes a copy of the data. + /// Convert the c-style array to an array. Makes a copy of the data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// /// @param ptr to array /// @param numRows: number of rows of the buffer /// @param numCols: number of cols of the buffer /// @param takeOwnership: whether or not to take ownership of the data - /// and call delete[] in the destructor. + /// and call delete[] in the destructor. /// @return - /// NdArray + /// NdArray /// template::value, int> = 0> diff --git a/include/NumCpp/Functions/astype.hpp b/include/NumCpp/Functions/astype.hpp index 514a6ab78..a7f48489d 100644 --- a/include/NumCpp/Functions/astype.hpp +++ b/include/NumCpp/Functions/astype.hpp @@ -36,12 +36,12 @@ namespace nc { //============================================================================ // Method Description: - /// Returns a copy of the array, cast to a specified type. + /// Returns a copy of the array, cast to a specified type. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray astype(const NdArray inArray) diff --git a/include/NumCpp/Functions/average.hpp b/include/NumCpp/Functions/average.hpp index 59edcdaf2..6960d2c35 100644 --- a/include/NumCpp/Functions/average.hpp +++ b/include/NumCpp/Functions/average.hpp @@ -44,14 +44,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the average along the specified axis. + /// Compute the average along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template auto average(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -61,15 +61,15 @@ namespace nc //============================================================================ // Method Description: - /// Compute the weighted average along the specified axis. + /// Compute the weighted average along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html /// /// @param inArray /// @param inWeights /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray average(const NdArray& inArray, const NdArray& inWeights, Axis inAxis = Axis::NONE) @@ -150,15 +150,15 @@ namespace nc //============================================================================ // Method Description: - /// Compute the weighted average along the specified axis. + /// Compute the weighted average along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html /// /// @param inArray /// @param inWeights /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray> average(const NdArray>& inArray, diff --git a/include/NumCpp/Functions/bartlett.hpp b/include/NumCpp/Functions/bartlett.hpp index 7fcb19825..eb2f9a8e5 100644 --- a/include/NumCpp/Functions/bartlett.hpp +++ b/include/NumCpp/Functions/bartlett.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ // Method Description: - /// The Bartlett window is very similar to a triangular window, except that the end + /// The Bartlett window is very similar to a triangular window, except that the end /// points are at zero. It is often used in signal processing for tapering a signal, /// without generating too much ripple in the frequency domain. /// diff --git a/include/NumCpp/Functions/binaryRepr.hpp b/include/NumCpp/Functions/binaryRepr.hpp index 21c0e78db..38919b36f 100644 --- a/include/NumCpp/Functions/binaryRepr.hpp +++ b/include/NumCpp/Functions/binaryRepr.hpp @@ -37,13 +37,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return the binary representation of the input number as a string. + /// Return the binary representation of the input number as a string. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.binary_repr.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.binary_repr.html /// /// @param inValue /// @return - /// std::string + /// std::string /// template std::string binaryRepr(dtype inValue) diff --git a/include/NumCpp/Functions/bincount.hpp b/include/NumCpp/Functions/bincount.hpp index 55d86e5a9..023601f53 100644 --- a/include/NumCpp/Functions/bincount.hpp +++ b/include/NumCpp/Functions/bincount.hpp @@ -39,21 +39,21 @@ namespace nc { //============================================================================ // Method Description: - /// Count number of occurrences of each value in array of non-negative ints. - /// Negative values will be counted in the zero bin. + /// Count number of occurrences of each value in array of non-negative ints. + /// Negative values will be counted in the zero bin. /// - /// The number of bins(of size 1) is one larger than the largest value in x. - /// If minlength is specified, there will be at least this number of bins in - /// the output array(though it will be longer if necessary, depending on the - /// contents of x).Each bin gives the number of occurrences of its index value - /// in x. + /// The number of bins(of size 1) is one larger than the largest value in x. + /// If minlength is specified, there will be at least this number of bins in + /// the output array(though it will be longer if necessary, depending on the + /// contents of x).Each bin gives the number of occurrences of its index value + /// in x. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bincount.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bincount.html /// /// @param inArray /// @param inMinLength /// @return - /// NdArray + /// NdArray /// template NdArray bincount(const NdArray& inArray, uint16 inMinLength = 1) @@ -88,24 +88,24 @@ namespace nc //============================================================================ // Method Description: - /// Count number of occurrences of each value in array of non-negative ints. - /// Negative values will be counted in the zero bin. + /// Count number of occurrences of each value in array of non-negative ints. + /// Negative values will be counted in the zero bin. /// - /// The number of bins(of size 1) is one larger than the largest value in x. - /// If minlength is specified, there will be at least this number of bins in - /// the output array(though it will be longer if necessary, depending on the - /// contents of x).Each bin gives the number of occurrences of its index value - /// in x.If weights is specified the input array is weighted by it, i.e. if a - /// value n is found at position i, out[n] += weight[i] instead of out[n] += 1. - /// Weights array shall be of the same shape as inArray. + /// The number of bins(of size 1) is one larger than the largest value in x. + /// If minlength is specified, there will be at least this number of bins in + /// the output array(though it will be longer if necessary, depending on the + /// contents of x).Each bin gives the number of occurrences of its index value + /// in x.If weights is specified the input array is weighted by it, i.e. if a + /// value n is found at position i, out[n] += weight[i] instead of out[n] += 1. + /// Weights array shall be of the same shape as inArray. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bincount.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bincount.html /// /// @param inArray /// @param inWeights /// @param inMinLength /// @return - /// NdArray + /// NdArray /// template NdArray bincount(const NdArray& inArray, const NdArray& inWeights, uint16 inMinLength = 1) diff --git a/include/NumCpp/Functions/bitwise_and.hpp b/include/NumCpp/Functions/bitwise_and.hpp index db304ee6d..962ff2fe7 100644 --- a/include/NumCpp/Functions/bitwise_and.hpp +++ b/include/NumCpp/Functions/bitwise_and.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the bit-wise AND of two arrays element-wise. + /// Compute the bit-wise AND of two arrays element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_and.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_and.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray bitwise_and(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/bitwise_not.hpp b/include/NumCpp/Functions/bitwise_not.hpp index 94c4a8703..a9ac8612c 100644 --- a/include/NumCpp/Functions/bitwise_not.hpp +++ b/include/NumCpp/Functions/bitwise_not.hpp @@ -33,11 +33,11 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the bit-wise NOT the input array element-wise. + /// Compute the bit-wise NOT the input array element-wise. /// - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray bitwise_not(const NdArray& inArray) diff --git a/include/NumCpp/Functions/bitwise_or.hpp b/include/NumCpp/Functions/bitwise_or.hpp index 17e59dc1a..684f686c5 100644 --- a/include/NumCpp/Functions/bitwise_or.hpp +++ b/include/NumCpp/Functions/bitwise_or.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the bit-wise OR of two arrays element-wise. + /// Compute the bit-wise OR of two arrays element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_or.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_or.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray bitwise_or(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/bitwise_xor.hpp b/include/NumCpp/Functions/bitwise_xor.hpp index a72c96948..1ecff5d6b 100644 --- a/include/NumCpp/Functions/bitwise_xor.hpp +++ b/include/NumCpp/Functions/bitwise_xor.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the bit-wise XOR of two arrays element-wise. + /// Compute the bit-wise XOR of two arrays element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_xor.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_xor.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray bitwise_xor(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/blackman.hpp b/include/NumCpp/Functions/blackman.hpp index 4b1fa5664..8ded1cfa5 100644 --- a/include/NumCpp/Functions/blackman.hpp +++ b/include/NumCpp/Functions/blackman.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// The Blackman window is a taper formed by using the first three terms of a summation of + /// The Blackman window is a taper formed by using the first three terms of a summation of /// cosines. It was designed to have close to the minimal leakage possible. It is close to /// optimal, only slightly worse than a Kaiser window. /// diff --git a/include/NumCpp/Functions/byteswap.hpp b/include/NumCpp/Functions/byteswap.hpp index 6292a6ecb..3cca460ed 100644 --- a/include/NumCpp/Functions/byteswap.hpp +++ b/include/NumCpp/Functions/byteswap.hpp @@ -33,13 +33,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array with the bytes of the array elements - /// swapped. + /// Return a new array with the bytes of the array elements + /// swapped. /// /// @param inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray byteswap(const NdArray& inArray) diff --git a/include/NumCpp/Functions/cbrt.hpp b/include/NumCpp/Functions/cbrt.hpp index 2191c9d62..e4711d9b2 100644 --- a/include/NumCpp/Functions/cbrt.hpp +++ b/include/NumCpp/Functions/cbrt.hpp @@ -37,13 +37,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return the cube-root of an array. + /// Return the cube-root of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cbrt.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cbrt.html /// /// @param inValue /// @return - /// value + /// value /// template double cbrt(dtype inValue) noexcept @@ -55,13 +55,13 @@ namespace nc //============================================================================ // Method Description: - /// Return the cube-root of an array, element-wise. + /// Return the cube-root of an array, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cbrt.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cbrt.html /// /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray cbrt(const NdArray& inArray) diff --git a/include/NumCpp/Functions/ceil.hpp b/include/NumCpp/Functions/ceil.hpp index 1bb1c962a..4e1b17e77 100644 --- a/include/NumCpp/Functions/ceil.hpp +++ b/include/NumCpp/Functions/ceil.hpp @@ -37,9 +37,9 @@ namespace nc { //============================================================================ // Method Description: - /// Return the ceiling of the input. + /// Return the ceiling of the input. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ceil.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ceil.html /// /// @param inValue /// @return value @@ -54,9 +54,9 @@ namespace nc //============================================================================ // Method Description: - /// Return the ceiling of the input, element-wise. + /// Return the ceiling of the input, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ceil.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ceil.html /// /// @param inArray /// @return NdArray diff --git a/include/NumCpp/Functions/centerOfMass.hpp b/include/NumCpp/Functions/centerOfMass.hpp index 69d1c304b..d566d5d78 100644 --- a/include/NumCpp/Functions/centerOfMass.hpp +++ b/include/NumCpp/Functions/centerOfMass.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the center of mass of the array values along an axis. + /// Returns the center of mass of the array values along an axis. /// /// @param inArray /// @param inAxis (Optional, default NONE which is a 2d center of mass) diff --git a/include/NumCpp/Functions/clip.hpp b/include/NumCpp/Functions/clip.hpp index 8bc262ac1..1c4092720 100644 --- a/include/NumCpp/Functions/clip.hpp +++ b/include/NumCpp/Functions/clip.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Clip (limit) the value. + /// Clip (limit) the value. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.clip.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.clip.html /// /// @param inValue /// @param inMinValue /// @param inMaxValue /// @return - /// NdArray + /// NdArray /// template dtype clip(dtype inValue, dtype inMinValue, dtype inMaxValue) @@ -77,15 +77,15 @@ namespace nc //============================================================================ // Method Description: - /// Clip (limit) the values in an array. + /// Clip (limit) the values in an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.clip.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.clip.html /// /// @param inArray /// @param inMinValue /// @param inMaxValue /// @return - /// NdArray + /// NdArray /// template NdArray clip(const NdArray& inArray, dtype inMinValue, dtype inMaxValue) diff --git a/include/NumCpp/Functions/column_stack.hpp b/include/NumCpp/Functions/column_stack.hpp index bb354651a..d723e0963 100644 --- a/include/NumCpp/Functions/column_stack.hpp +++ b/include/NumCpp/Functions/column_stack.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Stack 1-D arrays as columns into a 2-D array. + /// Stack 1-D arrays as columns into a 2-D array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.column_stack.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.column_stack.html /// /// @param - /// inArrayList: {list} of arrays to stack + /// inArrayList: {list} of arrays to stack /// @return - /// NdArray + /// NdArray /// template NdArray column_stack(const std::initializer_list >& inArrayList) diff --git a/include/NumCpp/Functions/complex.hpp b/include/NumCpp/Functions/complex.hpp index 8d9dd935e..aeb52cf49 100644 --- a/include/NumCpp/Functions/complex.hpp +++ b/include/NumCpp/Functions/complex.hpp @@ -38,11 +38,11 @@ namespace nc { //============================================================================ // Method Description: - /// Returns a std::complex from the input real and imag components + /// Returns a std::complex from the input real and imag components /// /// @param inReal: the real component of the complex number /// @return - /// value + /// value /// template auto complex(dtype inReal) @@ -54,12 +54,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns a std::complex from the input real and imag components + /// Returns a std::complex from the input real and imag components /// /// @param inReal: the real component of the complex number /// @param inImag: the imaginary component of the complex number /// @return - /// value + /// value /// template auto complex(dtype inReal, dtype inImag) @@ -71,11 +71,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns a std::complex from the input real and imag components + /// Returns a std::complex from the input real and imag components /// /// @param inReal: the real component of the complex number /// @return - /// NdArray + /// NdArray /// template auto complex(const NdArray& inReal) @@ -92,12 +92,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns a std::complex from the input real and imag components + /// Returns a std::complex from the input real and imag components /// /// @param inReal: the real component of the complex number /// @param inImag: the imaginary component of the complex number /// @return - /// NdArray + /// NdArray /// template auto complex(const NdArray& inReal, const NdArray& inImag) diff --git a/include/NumCpp/Functions/concatenate.hpp b/include/NumCpp/Functions/concatenate.hpp index d42cdbe8c..8c0cfc867 100644 --- a/include/NumCpp/Functions/concatenate.hpp +++ b/include/NumCpp/Functions/concatenate.hpp @@ -39,14 +39,14 @@ namespace nc { //============================================================================ // Method Description: - /// Join a sequence of arrays along an existing axis. + /// Join a sequence of arrays along an existing axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.concatenate.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.concatenate.html /// /// @param inArrayList /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray concatenate(const std::initializer_list >& inArrayList, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/conj.hpp b/include/NumCpp/Functions/conj.hpp index ea1c02496..2b5076e21 100644 --- a/include/NumCpp/Functions/conj.hpp +++ b/include/NumCpp/Functions/conj.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the complex conjugate of the complex argument. + /// Return the complex conjugate of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.conj.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.conj.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto conj(const std::complex& inValue) @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the complex conjugate of the complex argument. + /// Return the complex conjugate of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.conj.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.conj.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto conj(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/contains.hpp b/include/NumCpp/Functions/contains.hpp index a62827829..d6831c4f4 100644 --- a/include/NumCpp/Functions/contains.hpp +++ b/include/NumCpp/Functions/contains.hpp @@ -34,13 +34,13 @@ namespace nc { //============================================================================ // Method Description: - /// returns whether or not a value is included the array + /// returns whether or not a value is included the array /// /// @param inArray /// @param inValue /// @param inAxis (Optional, default NONE) /// @return - /// bool + /// bool /// template NdArray contains(const NdArray& inArray, dtype inValue, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/copy.hpp b/include/NumCpp/Functions/copy.hpp index 360799550..f4138136a 100644 --- a/include/NumCpp/Functions/copy.hpp +++ b/include/NumCpp/Functions/copy.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return an array copy of the given object. + /// Return an array copy of the given object. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copy.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copy.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray copy(const NdArray& inArray) diff --git a/include/NumCpp/Functions/copySign.hpp b/include/NumCpp/Functions/copySign.hpp index f8753086a..f800b2997 100644 --- a/include/NumCpp/Functions/copySign.hpp +++ b/include/NumCpp/Functions/copySign.hpp @@ -39,14 +39,14 @@ namespace nc { //============================================================================ // Method Description: - /// Change the sign of x1 to that of x2, element-wise. + /// Change the sign of x1 to that of x2, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copysign.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copysign.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray copySign(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/copyto.hpp b/include/NumCpp/Functions/copyto.hpp index 5bdc4892b..795eb9823 100644 --- a/include/NumCpp/Functions/copyto.hpp +++ b/include/NumCpp/Functions/copyto.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Copies values from one array to another + /// Copies values from one array to another /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copyto.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copyto.html /// /// @param inDestArray /// @param inSrcArray /// @return - /// NdArray + /// NdArray /// template NdArray& copyto(NdArray& inDestArray, const NdArray& inSrcArray) diff --git a/include/NumCpp/Functions/corrcoef.hpp b/include/NumCpp/Functions/corrcoef.hpp index f7b78688d..03335f044 100644 --- a/include/NumCpp/Functions/corrcoef.hpp +++ b/include/NumCpp/Functions/corrcoef.hpp @@ -37,13 +37,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return Pearson product-moment correlation coefficients. + /// Return Pearson product-moment correlation coefficients. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html /// /// @param x: A 1-D or 2-D array containing multiple variables and observations. - /// Each row of x represents a variable, and each column a single observation - /// of all those variables. + /// Each row of x represents a variable, and each column a single observation + /// of all those variables. /// @return NdArray /// template diff --git a/include/NumCpp/Functions/cos.hpp b/include/NumCpp/Functions/cos.hpp index eaf41b6c9..d9d23197e 100644 --- a/include/NumCpp/Functions/cos.hpp +++ b/include/NumCpp/Functions/cos.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Cosine + /// Cosine /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cos.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cos.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto cos(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Cosine element-wise. + /// Cosine element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cos.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cos.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto cos(const NdArray& inArray) diff --git a/include/NumCpp/Functions/cosh.hpp b/include/NumCpp/Functions/cosh.hpp index c17fb3ee5..76d579404 100644 --- a/include/NumCpp/Functions/cosh.hpp +++ b/include/NumCpp/Functions/cosh.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Hyperbolic Cosine. + /// Hyperbolic Cosine. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cosh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cosh.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto cosh(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Hyperbolic Cosine element-wise. + /// Hyperbolic Cosine element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cosh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cosh.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto cosh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/count_nonzero.hpp b/include/NumCpp/Functions/count_nonzero.hpp index 415f0718e..cc11c21b5 100644 --- a/include/NumCpp/Functions/count_nonzero.hpp +++ b/include/NumCpp/Functions/count_nonzero.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Counts the number of non-zero values in the array. + /// Counts the number of non-zero values in the array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.count_nonzero.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.count_nonzero.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray count_nonzero(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/cov.hpp b/include/NumCpp/Functions/cov.hpp index da0d9fe50..4630de4b9 100644 --- a/include/NumCpp/Functions/cov.hpp +++ b/include/NumCpp/Functions/cov.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Estimate a covariance matrix. + /// Estimate a covariance matrix. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.cov.html /// /// @param x: A 1-D or 2-D array containing multiple variables and observations. - /// Each row of x represents a variable, and each column a single observation - /// of all those variables. + /// Each row of x represents a variable, and each column a single observation + /// of all those variables. /// @param bias: Default normalization (false) is by (N - 1), where N is the number of observations - /// given (unbiased estimate). If bias is True, then normalization is by N. + /// given (unbiased estimate). If bias is True, then normalization is by N. /// @return NdArray /// template diff --git a/include/NumCpp/Functions/cov_inv.hpp b/include/NumCpp/Functions/cov_inv.hpp index 506e75ee0..714ca8e25 100644 --- a/include/NumCpp/Functions/cov_inv.hpp +++ b/include/NumCpp/Functions/cov_inv.hpp @@ -36,13 +36,13 @@ namespace nc { //============================================================================ // Method Description: - /// Estimate an inverse covariance matrix, aka the concentration matrix + /// Estimate an inverse covariance matrix, aka the concentration matrix /// /// @param x: A 1-D or 2-D array containing multiple variables and observations. - /// Each row of x represents a variable, and each column a single observation - /// of all those variables. + /// Each row of x represents a variable, and each column a single observation + /// of all those variables. /// @param bias: Default normalization (false) is by (N - 1), where N is the number of observations - /// given (unbiased estimate). If bias is True, then normalization is by N. + /// given (unbiased estimate). If bias is True, then normalization is by N. /// @return NdArray /// template diff --git a/include/NumCpp/Functions/cross.hpp b/include/NumCpp/Functions/cross.hpp index e65f6c9f7..6465693b0 100644 --- a/include/NumCpp/Functions/cross.hpp +++ b/include/NumCpp/Functions/cross.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the cross product of two (arrays of) vectors. + /// Return the cross product of two (arrays of) vectors. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cross.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cross.html /// /// @param inArray1 /// @param inArray2 /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray cross(const NdArray& inArray1, const NdArray& inArray2, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/cube.hpp b/include/NumCpp/Functions/cube.hpp index 176519024..5ff4e2d11 100644 --- a/include/NumCpp/Functions/cube.hpp +++ b/include/NumCpp/Functions/cube.hpp @@ -36,12 +36,12 @@ namespace nc { //============================================================================ // Method Description: - /// Cubes the input + /// Cubes the input /// /// @param - /// inValue + /// inValue /// @return - /// cubed value + /// cubed value /// template constexpr dtype cube(dtype inValue) noexcept @@ -53,12 +53,12 @@ namespace nc //============================================================================ // Method Description: - /// Cubes the elements of the array + /// Cubes the elements of the array /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray cube(const NdArray& inArray) diff --git a/include/NumCpp/Functions/cumprod.hpp b/include/NumCpp/Functions/cumprod.hpp index 89ab72ed7..ad68b4358 100644 --- a/include/NumCpp/Functions/cumprod.hpp +++ b/include/NumCpp/Functions/cumprod.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the cumulative product of elements along a given axis. + /// Return the cumulative product of elements along a given axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cumprod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cumprod.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray cumprod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/cumsum.hpp b/include/NumCpp/Functions/cumsum.hpp index e85a7b41e..d3fbfd0f5 100644 --- a/include/NumCpp/Functions/cumsum.hpp +++ b/include/NumCpp/Functions/cumsum.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the cumulative sum of the elements along a given axis. + /// Return the cumulative sum of the elements along a given axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cumsum.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cumsum.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray cumsum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/deg2rad.hpp b/include/NumCpp/Functions/deg2rad.hpp index 1935fbc60..8f292c079 100644 --- a/include/NumCpp/Functions/deg2rad.hpp +++ b/include/NumCpp/Functions/deg2rad.hpp @@ -36,14 +36,14 @@ namespace nc { //============================================================================ // Method Description: - /// Convert angles from degrees to radians. + /// Convert angles from degrees to radians. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.deg2rad.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.deg2rad.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template constexpr auto deg2rad(dtype inValue) noexcept @@ -55,14 +55,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert angles from degrees to radians. + /// Convert angles from degrees to radians. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.deg2rad.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.deg2rad.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto deg2rad(const NdArray& inArray) diff --git a/include/NumCpp/Functions/degrees.hpp b/include/NumCpp/Functions/degrees.hpp index e4e670fb2..1987bfefc 100644 --- a/include/NumCpp/Functions/degrees.hpp +++ b/include/NumCpp/Functions/degrees.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Convert angles from degrees to radians. + /// Convert angles from degrees to radians. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.degrees.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.degrees.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template constexpr auto degrees(dtype inValue) noexcept @@ -51,14 +51,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert angles from degrees to radians. + /// Convert angles from degrees to radians. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.degrees.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.degrees.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto degrees(const NdArray& inArray) diff --git a/include/NumCpp/Functions/deleteIndices.hpp b/include/NumCpp/Functions/deleteIndices.hpp index d4857e77c..642cb89ac 100644 --- a/include/NumCpp/Functions/deleteIndices.hpp +++ b/include/NumCpp/Functions/deleteIndices.hpp @@ -40,13 +40,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array with sub-arrays along an axis deleted. + /// Return a new array with sub-arrays along an axis deleted. /// /// @param inArray /// @param inArrayIdxs /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array /// @return - /// NdArray + /// NdArray /// template NdArray deleteIndices(const NdArray& inArray, const NdArray& inArrayIdxs, Axis inAxis = Axis::NONE) @@ -138,13 +138,13 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array with sub-arrays along an axis deleted. + /// Return a new array with sub-arrays along an axis deleted. /// /// @param inArray /// @param inIndicesSlice /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array /// @return - /// NdArray + /// NdArray /// template NdArray deleteIndices(const NdArray& inArray, const Slice& inIndicesSlice, Axis inAxis = Axis::NONE) @@ -181,13 +181,13 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array with sub-arrays along an axis deleted. + /// Return a new array with sub-arrays along an axis deleted. /// /// @param inArray /// @param inIndex /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array /// @return - /// NdArray + /// NdArray /// template NdArray deleteIndices(const NdArray& inArray, uint32 inIndex, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/diag.hpp b/include/NumCpp/Functions/diag.hpp index 38042d0d1..6e4a5208e 100644 --- a/include/NumCpp/Functions/diag.hpp +++ b/include/NumCpp/Functions/diag.hpp @@ -36,14 +36,14 @@ namespace nc { //============================================================================ // Method Description: - /// Extract a diagonal or construct a diagonal array. + /// Extract a diagonal or construct a diagonal array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diag.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diag.html /// /// @param inArray /// @param k Diagonal in question. The default is 0. - /// Use k>0 for diagonals above the main diagonal, and k<0 - /// for diagonals below the main diagonal. + /// Use k>0 for diagonals above the main diagonal, and k<0 + /// for diagonals below the main diagonal. /// /// @return NdArray /// diff --git a/include/NumCpp/Functions/diagflat.hpp b/include/NumCpp/Functions/diagflat.hpp index c6ade0bb0..2404c3d61 100644 --- a/include/NumCpp/Functions/diagflat.hpp +++ b/include/NumCpp/Functions/diagflat.hpp @@ -37,13 +37,13 @@ namespace nc { //============================================================================ // Method Description: - /// Create a two-dimensional array with the flattened input as a diagonal. + /// Create a two-dimensional array with the flattened input as a diagonal. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diagflat.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diagflat.html /// /// @param inArray /// @param k Diagonal to set; 0, the default, corresponds to the �main� diagonal, - /// a positive (negative) k giving the number of the diagonal above (below) the main. + /// a positive (negative) k giving the number of the diagonal above (below) the main. /// /// @return NdArray /// diff --git a/include/NumCpp/Functions/diagonal.hpp b/include/NumCpp/Functions/diagonal.hpp index e218dc363..271247423 100644 --- a/include/NumCpp/Functions/diagonal.hpp +++ b/include/NumCpp/Functions/diagonal.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return specified diagonals. + /// Return specified diagonals. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diagonal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diagonal.html /// /// @param inArray /// @param inOffset (Defaults to 0) /// @param inAxis (Optional, default ROW) axis the offset is applied to /// @return - /// NdArray + /// NdArray /// template NdArray diagonal(const NdArray& inArray, int32 inOffset = 0, Axis inAxis = Axis::ROW) diff --git a/include/NumCpp/Functions/diff.hpp b/include/NumCpp/Functions/diff.hpp index c84ccf29a..0e3728e6c 100644 --- a/include/NumCpp/Functions/diff.hpp +++ b/include/NumCpp/Functions/diff.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate the n-th discrete difference along given axis. - /// Unsigned dtypes will give you weird results...obviously. + /// Calculate the n-th discrete difference along given axis. + /// Unsigned dtypes will give you weird results...obviously. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diff.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diff.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray diff(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/divide.hpp b/include/NumCpp/Functions/divide.hpp index b5c3a16cd..7ddd046fd 100644 --- a/include/NumCpp/Functions/divide.hpp +++ b/include/NumCpp/Functions/divide.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray divide(const NdArray& inArray1, const NdArray& inArray2) @@ -52,14 +52,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray divide(const NdArray& inArray, dtype value) @@ -69,14 +69,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray divide(dtype value, const NdArray& inArray) @@ -86,14 +86,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> divide(const NdArray& inArray1, const NdArray>& inArray2) @@ -103,14 +103,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> divide(const NdArray>& inArray1, const NdArray& inArray2) @@ -120,14 +120,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> divide(const NdArray& inArray, const std::complex& value) @@ -137,14 +137,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> divide(const std::complex& value, const NdArray& inArray) @@ -154,14 +154,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> divide(const NdArray>& inArray, dtype value) @@ -171,14 +171,14 @@ namespace nc //============================================================================ // Method Description: - /// divide arguments element-wise. + /// divide arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> divide(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/dot.hpp b/include/NumCpp/Functions/dot.hpp index 957c589a9..da082c85d 100644 --- a/include/NumCpp/Functions/dot.hpp +++ b/include/NumCpp/Functions/dot.hpp @@ -35,9 +35,9 @@ namespace nc { //============================================================================ // Method Description: - /// Dot product of two arrays. + /// Dot product of two arrays. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.dot.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.dot.html /// /// @param inArray1 /// @param inArray2 @@ -51,12 +51,12 @@ namespace nc //============================================================================ // Method Description: - /// Dot product of two arrays. + /// Dot product of two arrays. /// - /// For 2-D arrays it is equivalent to matrix multiplication, - /// and for 1-D arrays to inner product of vectors. + /// For 2-D arrays it is equivalent to matrix multiplication, + /// and for 1-D arrays to inner product of vectors. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html /// /// @param inArray1 /// @param inArray2 @@ -105,12 +105,12 @@ namespace nc //============================================================================ // Method Description: - /// Dot product of two arrays. + /// Dot product of two arrays. /// - /// For 2-D arrays it is equivalent to matrix multiplication, - /// and for 1-D arrays to inner product of vectors. + /// For 2-D arrays it is equivalent to matrix multiplication, + /// and for 1-D arrays to inner product of vectors. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html /// /// @param inArray1 /// @param inArray2 diff --git a/include/NumCpp/Functions/dump.hpp b/include/NumCpp/Functions/dump.hpp index 84d46d641..8c971a9ef 100644 --- a/include/NumCpp/Functions/dump.hpp +++ b/include/NumCpp/Functions/dump.hpp @@ -35,13 +35,13 @@ namespace nc { //============================================================================ // Method Description: - /// Dump a binary file of the array to the specified file. - /// The array can be read back with or NC::load. + /// Dump a binary file of the array to the specified file. + /// The array can be read back with or NC::load. /// /// @param inArray /// @param inFilename /// @return - /// NdArray + /// NdArray /// template void dump(const NdArray& inArray, const std::string& inFilename) diff --git a/include/NumCpp/Functions/empty.hpp b/include/NumCpp/Functions/empty.hpp index 8cbab5038..b84a12056 100644 --- a/include/NumCpp/Functions/empty.hpp +++ b/include/NumCpp/Functions/empty.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, without initializing entries. + /// Return a new array of given shape and type, without initializing entries. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty.html /// /// @param inNumRows /// @param inNumCols /// @return - /// NdArray + /// NdArray /// template NdArray empty(uint32 inNumRows, uint32 inNumCols) @@ -52,14 +52,14 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, without initializing entries. + /// Return a new array of given shape and type, without initializing entries. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty.html /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// template NdArray empty(const Shape& inShape) diff --git a/include/NumCpp/Functions/empty_like.hpp b/include/NumCpp/Functions/empty_like.hpp index bf951ba00..7d7ef14d4 100644 --- a/include/NumCpp/Functions/empty_like.hpp +++ b/include/NumCpp/Functions/empty_like.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array with the same shape as a given array. + /// Return a new array with the same shape as a given array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty_like.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty_like.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray empty_like(const NdArray& inArray) diff --git a/include/NumCpp/Functions/endianess.hpp b/include/NumCpp/Functions/endianess.hpp index b006575e9..856570219 100644 --- a/include/NumCpp/Functions/endianess.hpp +++ b/include/NumCpp/Functions/endianess.hpp @@ -33,12 +33,12 @@ namespace nc { //============================================================================ // Method Description: - /// Return the endianess of the array values. + /// Return the endianess of the array values. /// /// @param - /// inArray + /// inArray /// @return - /// Endian + /// Endian /// template Endian endianess(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/equal.hpp b/include/NumCpp/Functions/equal.hpp index 99dedd141..0ebd28ae6 100644 --- a/include/NumCpp/Functions/equal.hpp +++ b/include/NumCpp/Functions/equal.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return (x1 == x2) element-wise. + /// Return (x1 == x2) element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.equal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.equal.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/exp.hpp b/include/NumCpp/Functions/exp.hpp index 732853c30..4031f993e 100644 --- a/include/NumCpp/Functions/exp.hpp +++ b/include/NumCpp/Functions/exp.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate the exponential of the input value. + /// Calculate the exponential of the input value. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto exp(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Calculate the exponential of all elements in the input array. + /// Calculate the exponential of all elements in the input array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto exp(const NdArray& inArray) diff --git a/include/NumCpp/Functions/exp2.hpp b/include/NumCpp/Functions/exp2.hpp index b5577fa14..0d0361361 100644 --- a/include/NumCpp/Functions/exp2.hpp +++ b/include/NumCpp/Functions/exp2.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate 2**p for all p in the input value. + /// Calculate 2**p for all p in the input value. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp2.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp2.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto exp2(dtype inValue) noexcept @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Calculate 2**p for all p in the input array. + /// Calculate 2**p for all p in the input array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp2.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp2.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto exp2(const NdArray& inArray) diff --git a/include/NumCpp/Functions/expm1.hpp b/include/NumCpp/Functions/expm1.hpp index dacb5065c..62d5a469e 100644 --- a/include/NumCpp/Functions/expm1.hpp +++ b/include/NumCpp/Functions/expm1.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate exp(x) - 1 for the input value. + /// Calculate exp(x) - 1 for the input value. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.expm1.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.expm1.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto expm1(dtype inValue) noexcept @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Calculate exp(x) - 1 for all elements in the array. + /// Calculate exp(x) - 1 for all elements in the array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.expm1.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.expm1.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto expm1(const NdArray& inArray) diff --git a/include/NumCpp/Functions/extract.hpp b/include/NumCpp/Functions/extract.hpp index cfa90f7a9..bc721205b 100644 --- a/include/NumCpp/Functions/extract.hpp +++ b/include/NumCpp/Functions/extract.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ // Method Description: - /// Return the elements of an array that satisfy some condition. + /// Return the elements of an array that satisfy some condition. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.extract.html /// diff --git a/include/NumCpp/Functions/eye.hpp b/include/NumCpp/Functions/eye.hpp index 8e2dd1915..70787553b 100644 --- a/include/NumCpp/Functions/eye.hpp +++ b/include/NumCpp/Functions/eye.hpp @@ -36,17 +36,17 @@ namespace nc { //============================================================================ // Method Description: - /// Return a 2-D array with ones on the diagonal and zeros elsewhere. + /// Return a 2-D array with ones on the diagonal and zeros elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html /// /// @param inN: number of rows (N) /// @param inM: number of columns (M) /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, - /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. + /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. /// /// @return - /// NdArray + /// NdArray /// template NdArray eye(uint32 inN, uint32 inM, int32 inK = 0) @@ -88,16 +88,16 @@ namespace nc //============================================================================ // Method Description: - /// Return a 2-D array with ones on the diagonal and zeros elsewhere. + /// Return a 2-D array with ones on the diagonal and zeros elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html /// /// @param inN: number of rows and columns (N) /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, - /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. + /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. /// /// @return - /// NdArray + /// NdArray /// template NdArray eye(uint32 inN, int32 inK = 0) @@ -107,16 +107,16 @@ namespace nc //============================================================================ // Method Description: - /// Return a 2-D array with ones on the diagonal and zeros elsewhere. + /// Return a 2-D array with ones on the diagonal and zeros elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html /// /// @param inShape /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, - /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. + /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. /// /// @return - /// NdArray + /// NdArray /// template NdArray eye(const Shape& inShape, int32 inK = 0) diff --git a/include/NumCpp/Functions/fillDiagnol.hpp b/include/NumCpp/Functions/fillDiagnol.hpp index 05c9b2e08..c147c52c4 100644 --- a/include/NumCpp/Functions/fillDiagnol.hpp +++ b/include/NumCpp/Functions/fillDiagnol.hpp @@ -35,9 +35,9 @@ namespace nc { //============================================================================ // Method Description: - /// Fill the main diagonal of the given array. + /// Fill the main diagonal of the given array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fill_diagonal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fill_diagonal.html /// /// @param inArray /// @param inValue diff --git a/include/NumCpp/Functions/find.hpp b/include/NumCpp/Functions/find.hpp index fa06f5602..e8a078446 100644 --- a/include/NumCpp/Functions/find.hpp +++ b/include/NumCpp/Functions/find.hpp @@ -36,13 +36,13 @@ namespace nc { //============================================================================ // Method Description: - /// Find flat indices of nonzero elements. + /// Find flat indices of nonzero elements. /// /// @param mask: the mask to apply to the array /// @param n: the first n indices to return (optional, default all) /// /// @return - /// NdArray + /// NdArray /// inline NdArray find(const NdArray& mask, uint32 n = std::numeric_limits::max()) { diff --git a/include/NumCpp/Functions/fix.hpp b/include/NumCpp/Functions/fix.hpp index abfa8f527..25c5ee5cf 100644 --- a/include/NumCpp/Functions/fix.hpp +++ b/include/NumCpp/Functions/fix.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Round to nearest integer towards zero. + /// Round to nearest integer towards zero. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fix.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fix.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template dtype fix(dtype inValue) noexcept @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Round to nearest integer towards zero. + /// Round to nearest integer towards zero. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fix.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fix.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray fix(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flatnonzero.hpp b/include/NumCpp/Functions/flatnonzero.hpp index 15125170d..7ea456efc 100644 --- a/include/NumCpp/Functions/flatnonzero.hpp +++ b/include/NumCpp/Functions/flatnonzero.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return indices that are non-zero in the flattened version of a. + /// Return indices that are non-zero in the flattened version of a. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flatnonzero.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flatnonzero.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray flatnonzero(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flatten.hpp b/include/NumCpp/Functions/flatten.hpp index d9d91d94c..15b5b4f69 100644 --- a/include/NumCpp/Functions/flatten.hpp +++ b/include/NumCpp/Functions/flatten.hpp @@ -33,13 +33,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return a copy of the array collapsed into one dimension. + /// Return a copy of the array collapsed into one dimension. /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray flatten(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flip.hpp b/include/NumCpp/Functions/flip.hpp index 38149e99e..db82c33cb 100644 --- a/include/NumCpp/Functions/flip.hpp +++ b/include/NumCpp/Functions/flip.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Reverse the order of elements in an array along the given axis. + /// Reverse the order of elements in an array along the given axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flip.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flip.html /// /// @param inArray /// @param inAxis /// @return - /// NdArray + /// NdArray /// template NdArray flip(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/fliplr.hpp b/include/NumCpp/Functions/fliplr.hpp index 332c3416e..371ad5462 100644 --- a/include/NumCpp/Functions/fliplr.hpp +++ b/include/NumCpp/Functions/fliplr.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Flip array in the left/right direction. + /// Flip array in the left/right direction. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fliplr.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fliplr.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray fliplr(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flipud.hpp b/include/NumCpp/Functions/flipud.hpp index 415df8297..b62ad115a 100644 --- a/include/NumCpp/Functions/flipud.hpp +++ b/include/NumCpp/Functions/flipud.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Flip array in the up/down direction. + /// Flip array in the up/down direction. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flipud.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flipud.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray flipud(const NdArray& inArray) diff --git a/include/NumCpp/Functions/floor.hpp b/include/NumCpp/Functions/floor.hpp index 1c7b8c6c2..ad53ed31a 100644 --- a/include/NumCpp/Functions/floor.hpp +++ b/include/NumCpp/Functions/floor.hpp @@ -37,9 +37,9 @@ namespace nc { //============================================================================ // Method Description: - /// Return the floor of the input. + /// Return the floor of the input. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor.html /// /// @param inValue /// @return value @@ -54,9 +54,9 @@ namespace nc //============================================================================ // Method Description: - /// Return the floor of the input, element-wise. + /// Return the floor of the input, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor.html /// /// @param inArray /// @return NdArray diff --git a/include/NumCpp/Functions/floor_divide.hpp b/include/NumCpp/Functions/floor_divide.hpp index 2f8db8353..b7fa3c23c 100644 --- a/include/NumCpp/Functions/floor_divide.hpp +++ b/include/NumCpp/Functions/floor_divide.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the largest integer smaller or equal to the division of the inputs. + /// Return the largest integer smaller or equal to the division of the inputs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor_divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor_divide.html /// /// @param inValue1 /// @param inValue2 /// @return - /// value + /// value /// template dtype floor_divide(dtype inValue1, dtype inValue2) noexcept @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the largest integer smaller or equal to the division of the inputs. + /// Return the largest integer smaller or equal to the division of the inputs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor_divide.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor_divide.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray floor_divide(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/fmax.hpp b/include/NumCpp/Functions/fmax.hpp index 425f0362c..855608b55 100644 --- a/include/NumCpp/Functions/fmax.hpp +++ b/include/NumCpp/Functions/fmax.hpp @@ -40,17 +40,17 @@ namespace nc { //============================================================================ // Method Description: - /// maximum of inputs. + /// maximum of inputs. /// - /// Compare two value and returns a value containing the - /// maxima + /// Compare two value and returns a value containing the + /// maxima /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmax.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmax.html /// /// @param inValue1 /// @param inValue2 /// @return - /// value + /// value /// template dtype fmax(dtype inValue1, dtype inValue2) noexcept @@ -66,17 +66,17 @@ namespace nc //============================================================================ // Method Description: - /// Element-wise maximum of array elements. + /// Element-wise maximum of array elements. /// - /// Compare two arrays and returns a new array containing the - /// element - wise maxima + /// Compare two arrays and returns a new array containing the + /// element - wise maxima /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmax.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmax.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray fmax(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/fmin.hpp b/include/NumCpp/Functions/fmin.hpp index 0838fde37..859e53f21 100644 --- a/include/NumCpp/Functions/fmin.hpp +++ b/include/NumCpp/Functions/fmin.hpp @@ -40,17 +40,17 @@ namespace nc { //============================================================================ // Method Description: - /// minimum of inputs. + /// minimum of inputs. /// - /// Compare two value and returns a value containing the - /// minima + /// Compare two value and returns a value containing the + /// minima /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmin.html /// /// @param inValue1 /// @param inValue2 /// @return - /// value + /// value /// template dtype fmin(dtype inValue1, dtype inValue2) noexcept @@ -66,17 +66,17 @@ namespace nc //============================================================================ // Method Description: - /// Element-wise minimum of array elements. + /// Element-wise minimum of array elements. /// - /// Compare two arrays and returns a new array containing the - /// element - wise minima + /// Compare two arrays and returns a new array containing the + /// element - wise minima /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmin.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray fmin(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/fmod.hpp b/include/NumCpp/Functions/fmod.hpp index 6e88fc1ad..424c46942 100644 --- a/include/NumCpp/Functions/fmod.hpp +++ b/include/NumCpp/Functions/fmod.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the remainder of division. + /// Return the remainder of division. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html /// /// /// @param inValue1 /// @param inValue2 /// @return - /// value + /// value /// template, int> = 0> @@ -58,15 +58,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the remainder of division. + /// Return the remainder of division. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html /// /// /// @param inValue1 /// @param inValue2 /// @return - /// value + /// value /// template, int> = 0> @@ -77,15 +77,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the element-wise remainder of division. + /// Return the element-wise remainder of division. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html /// /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray fmod(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/frombuffer.hpp b/include/NumCpp/Functions/frombuffer.hpp index 2306cdf94..d230002eb 100644 --- a/include/NumCpp/Functions/frombuffer.hpp +++ b/include/NumCpp/Functions/frombuffer.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Interpret a buffer as a 1-dimensional array. + /// Interpret a buffer as a 1-dimensional array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.frombuffer.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.frombuffer.html /// /// @param inBufferPtr /// @param inNumBytes /// @return - /// NdArray + /// NdArray /// template NdArray frombuffer(const char* inBufferPtr, uint32 inNumBytes) diff --git a/include/NumCpp/Functions/fromfile.hpp b/include/NumCpp/Functions/fromfile.hpp index 724ebb280..6864b00ab 100644 --- a/include/NumCpp/Functions/fromfile.hpp +++ b/include/NumCpp/Functions/fromfile.hpp @@ -42,13 +42,13 @@ namespace nc { //============================================================================ // Method Description: - /// Construct an array from data in a binary file. + /// Construct an array from data in a binary file. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromfile.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromfile.html /// /// @param inFilename /// @return - /// NdArray + /// NdArray /// template NdArray fromfile(const std::string& inFilename) @@ -87,14 +87,14 @@ namespace nc //============================================================================ // Method Description: - /// Construct an array from data in a text file. + /// Construct an array from data in a text file. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromfile.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromfile.html /// /// @param inFilename /// @param inSep: Delimiter separator between values in the file /// @return - /// NdArray + /// NdArray /// template NdArray fromfile(const std::string& inFilename, const char inSep) diff --git a/include/NumCpp/Functions/fromiter.hpp b/include/NumCpp/Functions/fromiter.hpp index 84b7883e9..a48eca9c1 100644 --- a/include/NumCpp/Functions/fromiter.hpp +++ b/include/NumCpp/Functions/fromiter.hpp @@ -36,14 +36,14 @@ namespace nc { //============================================================================ // Method Description: - /// Create a new 1-dimensional array from an iterable object. + /// Create a new 1-dimensional array from an iterable object. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromiter.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromiter.html /// /// @param inBegin /// @param inEnd /// @return - /// NdArray + /// NdArray /// template NdArray fromiter(Iter inBegin, Iter inEnd) diff --git a/include/NumCpp/Functions/full.hpp b/include/NumCpp/Functions/full.hpp index e2433ef1c..f31ae1e8c 100644 --- a/include/NumCpp/Functions/full.hpp +++ b/include/NumCpp/Functions/full.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with inFillValue + /// Return a new array of given shape and type, filled with inFillValue /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html /// /// @param inSquareSize /// @param inFillValue /// @return - /// NdArray + /// NdArray /// template NdArray full(uint32 inSquareSize, dtype inFillValue) @@ -54,15 +54,15 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with inFillValue + /// Return a new array of given shape and type, filled with inFillValue /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html /// /// @param inNumRows /// @param inNumCols /// @param inFillValue /// @return - /// NdArray + /// NdArray /// template NdArray full(uint32 inNumRows, uint32 inNumCols, dtype inFillValue) @@ -74,14 +74,14 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with inFillValue + /// Return a new array of given shape and type, filled with inFillValue /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html /// /// @param inShape /// @param inFillValue /// @return - /// NdArray + /// NdArray /// template NdArray full(const Shape& inShape, dtype inFillValue) diff --git a/include/NumCpp/Functions/full_like.hpp b/include/NumCpp/Functions/full_like.hpp index 2a750aef1..7985ed115 100644 --- a/include/NumCpp/Functions/full_like.hpp +++ b/include/NumCpp/Functions/full_like.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a full array with the same shape and type as a given array. + /// Return a full array with the same shape and type as a given array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full_like.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full_like.html /// /// @param inArray /// @param inFillValue /// @return - /// NdArray + /// NdArray /// template NdArray full_like(const NdArray& inArray, dtype inFillValue) diff --git a/include/NumCpp/Functions/gcd.hpp b/include/NumCpp/Functions/gcd.hpp index c8c2daa8a..14759871a 100644 --- a/include/NumCpp/Functions/gcd.hpp +++ b/include/NumCpp/Functions/gcd.hpp @@ -45,16 +45,16 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the greatest common divisor of |x1| and |x2|. - /// NOTE: Use of this function requires either using the Boost - /// includes or a C++17 compliant compiler. + /// Returns the greatest common divisor of |x1| and |x2|. + /// NOTE: Use of this function requires either using the Boost + /// includes or a C++17 compliant compiler. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gcd.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gcd.html /// /// @param inValue1 /// @param inValue2 /// @return - /// dtype + /// dtype /// template dtype gcd(dtype inValue1, dtype inValue2) noexcept @@ -71,15 +71,15 @@ namespace nc #ifndef NUMCPP_NO_USE_BOOST //============================================================================ // Method Description: - /// Returns the greatest common divisor of the values in the - /// input array. - /// NOTE: Use of this function requires using the Boost includes. + /// Returns the greatest common divisor of the values in the + /// input array. + /// NOTE: Use of this function requires using the Boost includes. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gcd.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gcd.html /// /// @param inArray /// @return - /// NdArray + /// NdArray /// template dtype gcd(const NdArray& inArray) diff --git a/include/NumCpp/Functions/geomspace.hpp b/include/NumCpp/Functions/geomspace.hpp index 8abc0a267..488ce96aa 100644 --- a/include/NumCpp/Functions/geomspace.hpp +++ b/include/NumCpp/Functions/geomspace.hpp @@ -39,7 +39,7 @@ namespace nc { //============================================================================ // Method Description: - /// Return numbers spaced evenly on a log scale (a geometric progression). + /// Return numbers spaced evenly on a log scale (a geometric progression). /// /// This is similar to logspace, but with endpoints specified directly. /// Each output sample is a constant multiple of the previous. @@ -48,8 +48,8 @@ namespace nc /// /// @param start: the starting value of a sequence /// @param stop: The final value of the sequence, unless endpoint is False. - /// In that case, num + 1 values are spaced over the interval - /// in log-space, of which all but the last (a sequence of length num) are returned. + /// In that case, num + 1 values are spaced over the interval + /// in log-space, of which all but the last (a sequence of length num) are returned. /// @param num: Number of samples to generate. Default 50. /// @param enpoint: If true, stop is the last sample. Otherwide,it is not included. Default is true. /// @return NdArray diff --git a/include/NumCpp/Functions/gradient.hpp b/include/NumCpp/Functions/gradient.hpp index 000c9e07e..fd93fabb6 100644 --- a/include/NumCpp/Functions/gradient.hpp +++ b/include/NumCpp/Functions/gradient.hpp @@ -42,15 +42,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the gradient of the array. + /// Return the gradient of the array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gradient.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gradient.html /// /// /// @param inArray /// @param inAxis (default ROW) /// @return - /// NdArray + /// NdArray /// template NdArray gradient(const NdArray& inArray, Axis inAxis = Axis::ROW) @@ -138,15 +138,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the gradient of the array. + /// Return the gradient of the array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gradient.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gradient.html /// /// /// @param inArray /// @param inAxis (default ROW) /// @return - /// NdArray + /// NdArray /// template NdArray> gradient(const NdArray>& inArray, Axis inAxis = Axis::ROW) diff --git a/include/NumCpp/Functions/greater.hpp b/include/NumCpp/Functions/greater.hpp index 0c7aac3f8..4b80e1f6b 100644 --- a/include/NumCpp/Functions/greater.hpp +++ b/include/NumCpp/Functions/greater.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the truth value of (x1 > x2) element-wise. + /// Return the truth value of (x1 > x2) element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.greater.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.greater.html /// /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray greater(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/greater_equal.hpp b/include/NumCpp/Functions/greater_equal.hpp index f11bd8720..92a197866 100644 --- a/include/NumCpp/Functions/greater_equal.hpp +++ b/include/NumCpp/Functions/greater_equal.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the truth value of (x1 >= x2) element-wise. + /// Return the truth value of (x1 >= x2) element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.greater_equal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.greater_equal.html /// /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray greater_equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/hamming.hpp b/include/NumCpp/Functions/hamming.hpp index 12ec856bb..a2d2c1272 100644 --- a/include/NumCpp/Functions/hamming.hpp +++ b/include/NumCpp/Functions/hamming.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ // Method Description: - /// Return the Hamming window. + /// Return the Hamming window. /// /// The Hamming window is a taper formed by using a weighted cosine. /// diff --git a/include/NumCpp/Functions/hammingEncode.hpp b/include/NumCpp/Functions/hammingEncode.hpp index f3f7fe045..995da010e 100644 --- a/include/NumCpp/Functions/hammingEncode.hpp +++ b/include/NumCpp/Functions/hammingEncode.hpp @@ -66,9 +66,9 @@ namespace nc // Method Description: /// Calculates the next power of two after n /// >>> _next_power_of_two(768) - /// 1024 + /// 1024 /// >>> _next_power_of_two(4) - /// 8 + /// 8 /// /// @param n integer value /// @return next power of two @@ -289,7 +289,7 @@ namespace nc //============================================================================ // Method Description: /// Returns the Hamming SECDED decoded bits from the endoded bits. Assumes that the - /// DataBits and EncodedBits have been checks for consistancy already + /// DataBits and EncodedBits have been checks for consistancy already /// /// @param encodedBits the Hamming SECDED encoded word /// @return data bits from the encoded word @@ -363,7 +363,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the Hamming SECDED decoded bits for the enocoded bits + /// Returns the Hamming SECDED decoded bits for the enocoded bits /// https://en.wikipedia.org/wiki/Hamming_code /// /// @param encodedBits the encoded bits to decode diff --git a/include/NumCpp/Functions/hanning.hpp b/include/NumCpp/Functions/hanning.hpp index 1c0cce377..c0ca54197 100644 --- a/include/NumCpp/Functions/hanning.hpp +++ b/include/NumCpp/Functions/hanning.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ // Method Description: - /// Return the Hamming window. + /// Return the Hamming window. /// /// The Hanning window is a taper formed by using a weighted cosine. /// diff --git a/include/NumCpp/Functions/histogram.hpp b/include/NumCpp/Functions/histogram.hpp index 7998f0089..bcc619188 100644 --- a/include/NumCpp/Functions/histogram.hpp +++ b/include/NumCpp/Functions/histogram.hpp @@ -42,17 +42,17 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the histogram of a set of data. + /// Compute the histogram of a set of data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.histogram.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.histogram.html /// /// /// @param inArray /// @param inBinEdges: monotonically increasing array of bin edges, including the - /// rightmost edge, allowing for non-uniform bin widths. + /// rightmost edge, allowing for non-uniform bin widths. /// /// @return - /// array of histogram counts + /// array of histogram counts /// template NdArray histogram(const NdArray& inArray, const NdArray& inBinEdges) @@ -111,16 +111,16 @@ namespace nc //============================================================================ // Method Description: - /// Compute the histogram of a set of data. + /// Compute the histogram of a set of data. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.histogram.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.histogram.html /// /// /// @param inArray /// @param inNumBins( default 10) /// /// @return - /// std::pair of NdArrays; first is histogram counts, seconds is the bin edges + /// std::pair of NdArrays; first is histogram counts, seconds is the bin edges /// template std::pair, NdArray > histogram(const NdArray& inArray, uint32 inNumBins = 10) diff --git a/include/NumCpp/Functions/hstack.hpp b/include/NumCpp/Functions/hstack.hpp index dfbc4258f..b23cb84b5 100644 --- a/include/NumCpp/Functions/hstack.hpp +++ b/include/NumCpp/Functions/hstack.hpp @@ -36,16 +36,16 @@ namespace nc { //============================================================================ // Method Description: - /// Stack arrays in sequence horizontally (column wise). + /// Stack arrays in sequence horizontally (column wise). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hstack.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hstack.html /// /// /// @param - /// inArrayList: {list} of arrays to stack + /// inArrayList: {list} of arrays to stack /// /// @return - /// NdArray + /// NdArray /// template NdArray hstack(std::initializer_list > inArrayList) diff --git a/include/NumCpp/Functions/hypot.hpp b/include/NumCpp/Functions/hypot.hpp index da8521c2a..2f66a8d27 100644 --- a/include/NumCpp/Functions/hypot.hpp +++ b/include/NumCpp/Functions/hypot.hpp @@ -40,18 +40,18 @@ namespace nc { //============================================================================ // Method Description: - /// Given the "legs" of a right triangle, return its hypotenuse. + /// Given the "legs" of a right triangle, return its hypotenuse. /// - /// Equivalent to sqrt(x1**2 + x2**2), element - wise. + /// Equivalent to sqrt(x1**2 + x2**2), element - wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html /// /// /// @param inValue1 /// @param inValue2 /// /// @return - /// value + /// value /// template double hypot(dtype inValue1, dtype inValue2) noexcept @@ -63,11 +63,11 @@ namespace nc //============================================================================ // Method Description: - /// Given the "legs" of a right triangle, return its hypotenuse. + /// Given the "legs" of a right triangle, return its hypotenuse. /// - /// Equivalent to sqrt(x1**2 + x2**2 + x3**2), element - wise. + /// Equivalent to sqrt(x1**2 + x2**2 + x3**2), element - wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html /// /// /// @param inValue1 @@ -75,7 +75,7 @@ namespace nc /// @param inValue3 /// /// @return - /// value + /// value /// template double hypot(dtype inValue1, dtype inValue2, dtype inValue3) noexcept @@ -95,18 +95,18 @@ namespace nc //============================================================================ // Method Description: - /// Given the "legs" of a right triangle, return its hypotenuse. + /// Given the "legs" of a right triangle, return its hypotenuse. /// - /// Equivalent to sqrt(x1**2 + x2**2), element - wise. + /// Equivalent to sqrt(x1**2 + x2**2), element - wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html /// /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray hypot(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/identity.hpp b/include/NumCpp/Functions/identity.hpp index 7d9974399..f5b8dad44 100644 --- a/include/NumCpp/Functions/identity.hpp +++ b/include/NumCpp/Functions/identity.hpp @@ -33,17 +33,17 @@ namespace nc { //============================================================================ // Method Description: - /// Return the identity array. + /// Return the identity array. /// - /// The identity array is a square array with ones on the main diagonal. + /// The identity array is a square array with ones on the main diagonal. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.identity.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.identity.html /// /// @param - /// inSquareSize + /// inSquareSize /// /// @return - /// NdArray + /// NdArray /// template NdArray identity(uint32 inSquareSize) diff --git a/include/NumCpp/Functions/imag.hpp b/include/NumCpp/Functions/imag.hpp index 97aeb28b3..9417efdf4 100644 --- a/include/NumCpp/Functions/imag.hpp +++ b/include/NumCpp/Functions/imag.hpp @@ -36,14 +36,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the imaginar part of the complex argument. + /// Return the imaginar part of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.imag.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.imag.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto imag(const std::complex& inValue) @@ -55,14 +55,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the imaginary part of the complex argument. + /// Return the imaginary part of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.imag.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.imag.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto imag(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/inner.hpp b/include/NumCpp/Functions/inner.hpp index 7d213e001..18f7e859b 100644 --- a/include/NumCpp/Functions/inner.hpp +++ b/include/NumCpp/Functions/inner.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ // Method Description: - /// Inner product of two 1-D arrays. + /// Inner product of two 1-D arrays. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.inner.html /// diff --git a/include/NumCpp/Functions/interp.hpp b/include/NumCpp/Functions/interp.hpp index f0e4e83ab..9443c4865 100644 --- a/include/NumCpp/Functions/interp.hpp +++ b/include/NumCpp/Functions/interp.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ - /// Returns the linear interpolation between two points + /// Returns the linear interpolation between two points /// /// @param inValue1 /// @param inValue2 @@ -52,21 +52,21 @@ namespace nc //============================================================================ // Method Description: - /// One-dimensional linear interpolation. + /// One-dimensional linear interpolation. /// - /// Returns the one - dimensional piecewise linear interpolant - /// to a function with given values at discrete data - points. - /// If input arrays are not one dimensional they will be - /// internally flattened. + /// Returns the one - dimensional piecewise linear interpolant + /// to a function with given values at discrete data - points. + /// If input arrays are not one dimensional they will be + /// internally flattened. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.interp.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.interp.html /// /// @param inX: The x-coordinates at which to evaluate the interpolated values. /// @param inXp: The x-coordinates of the data points, must be increasing. Otherwise, xp is internally sorted. /// @param inFp: The y-coordinates of the data points, same length as inXp. /// /// @return - /// NdArray + /// NdArray /// template NdArray interp(const NdArray& inX, const NdArray& inXp, const NdArray& inFp) diff --git a/include/NumCpp/Functions/intersect1d.hpp b/include/NumCpp/Functions/intersect1d.hpp index 45d4e85a5..a4e33b11d 100644 --- a/include/NumCpp/Functions/intersect1d.hpp +++ b/include/NumCpp/Functions/intersect1d.hpp @@ -38,17 +38,17 @@ namespace nc { //============================================================================ // Method Description: - /// Find the intersection of two arrays. + /// Find the intersection of two arrays. /// - /// Return the sorted, unique values that are in both of the input arrays. + /// Return the sorted, unique values that are in both of the input arrays. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.intersect1d.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.intersect1d.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray intersect1d(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/invert.hpp b/include/NumCpp/Functions/invert.hpp index 706395b1c..8027a89c3 100644 --- a/include/NumCpp/Functions/invert.hpp +++ b/include/NumCpp/Functions/invert.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute bit-wise inversion, or bit-wise NOT, element-wise. + /// Compute bit-wise inversion, or bit-wise NOT, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.invert.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.invert.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray invert(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isclose.hpp b/include/NumCpp/Functions/isclose.hpp index ab388f2af..7ec74d3c1 100644 --- a/include/NumCpp/Functions/isclose.hpp +++ b/include/NumCpp/Functions/isclose.hpp @@ -39,13 +39,13 @@ namespace nc { //============================================================================ // Method Description: - /// Returns a boolean array where two arrays are element-wise - /// equal within a tolerance. + /// Returns a boolean array where two arrays are element-wise + /// equal within a tolerance. /// - /// For finite values, isclose uses the following equation to test whether two floating point values are equivalent. - /// absolute(a - b) <= (atol + rtol * absolute(b)) + /// For finite values, isclose uses the following equation to test whether two floating point values are equivalent. + /// absolute(a - b) <= (atol + rtol * absolute(b)) /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isclose.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isclose.html /// /// @param inArray1 /// @param inArray2 @@ -53,7 +53,7 @@ namespace nc /// @param inAtol: absolute tolerance (default 1e-9) /// /// @return - /// NdArray + /// NdArray /// template NdArray isclose(const NdArray& inArray1, const NdArray& inArray2, double inRtol = 1e-05, double inAtol = 1e-08) diff --git a/include/NumCpp/Functions/isinf.hpp b/include/NumCpp/Functions/isinf.hpp index 9e6ad4e9b..2c494b839 100644 --- a/include/NumCpp/Functions/isinf.hpp +++ b/include/NumCpp/Functions/isinf.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Test for inf and return result as a boolean. + /// Test for inf and return result as a boolean. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isinf.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isinf.html /// /// @param - /// inValue + /// inValue /// /// @return - /// bool + /// bool /// template bool isinf(dtype inValue) noexcept @@ -57,15 +57,15 @@ namespace nc //============================================================================ // Method Description: - /// Test element-wise for inf and return result as a boolean array. + /// Test element-wise for inf and return result as a boolean array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isinf.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isinf.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray isinf(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isnan.hpp b/include/NumCpp/Functions/isnan.hpp index 6fe4a5569..47b136236 100644 --- a/include/NumCpp/Functions/isnan.hpp +++ b/include/NumCpp/Functions/isnan.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Test for NaN and return result as a boolean. + /// Test for NaN and return result as a boolean. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isnan.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isnan.html /// /// @param - /// inValue + /// inValue /// /// @return - /// bool + /// bool /// template bool isnan(dtype inValue) noexcept @@ -62,15 +62,15 @@ namespace nc //============================================================================ // Method Description: - /// Test element-wise for NaN and return result as a boolean array. + /// Test element-wise for NaN and return result as a boolean array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isnan.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isnan.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray isnan(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isneginf.hpp b/include/NumCpp/Functions/isneginf.hpp index b2305ef8a..da7d97189 100644 --- a/include/NumCpp/Functions/isneginf.hpp +++ b/include/NumCpp/Functions/isneginf.hpp @@ -35,15 +35,15 @@ namespace nc { //============================================================================ // Method Description: - /// Test for negative inf and return result as a boolean. + /// Test for negative inf and return result as a boolean. /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isneginf.html /// /// @param - /// inValue + /// inValue /// /// @return - /// bool + /// bool /// template bool isneginf(dtype inValue) noexcept @@ -55,15 +55,15 @@ namespace nc //============================================================================ // Method Description: - /// Test element-wise for negative inf and return result as a boolean array. + /// Test element-wise for negative inf and return result as a boolean array. /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isneginf.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray isneginf(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isposinf.hpp b/include/NumCpp/Functions/isposinf.hpp index 7e1d00f98..fddcfb1fd 100644 --- a/include/NumCpp/Functions/isposinf.hpp +++ b/include/NumCpp/Functions/isposinf.hpp @@ -35,15 +35,15 @@ namespace nc { //============================================================================ // Method Description: - /// Test for positive inf and return result as a boolean. + /// Test for positive inf and return result as a boolean. /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isposinf.html /// /// @param - /// inValue + /// inValue /// /// @return - /// bool + /// bool /// template bool isposinf(dtype inValue) noexcept @@ -55,15 +55,15 @@ namespace nc //============================================================================ // Method Description: - /// Test element-wise for positive inf and return result as a boolean array. + /// Test element-wise for positive inf and return result as a boolean array. /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isposinf.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray isposinf(const NdArray& inArray) diff --git a/include/NumCpp/Functions/kaiser.hpp b/include/NumCpp/Functions/kaiser.hpp index 6fd3046db..2ffb6de34 100644 --- a/include/NumCpp/Functions/kaiser.hpp +++ b/include/NumCpp/Functions/kaiser.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// The Kaiser window is a taper formed by using a Bessel function. + /// The Kaiser window is a taper formed by using a Bessel function. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.kaiser.html /// diff --git a/include/NumCpp/Functions/lcm.hpp b/include/NumCpp/Functions/lcm.hpp index 142a102bc..47da81b2e 100644 --- a/include/NumCpp/Functions/lcm.hpp +++ b/include/NumCpp/Functions/lcm.hpp @@ -45,16 +45,16 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the least common multiple of |x1| and |x2|. - /// NOTE: Use of this function requires either using the Boost - /// includes or a C++17 compliant compiler. + /// Returns the least common multiple of |x1| and |x2|. + /// NOTE: Use of this function requires either using the Boost + /// includes or a C++17 compliant compiler. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.lcm.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.lcm.html /// /// @param inValue1 /// @param inValue2 /// @return - /// dtype + /// dtype /// template dtype lcm(dtype inValue1, dtype inValue2) noexcept @@ -71,14 +71,14 @@ namespace nc #ifndef NUMCPP_NO_USE_BOOST //============================================================================ // Method Description: - /// Returns the least common multiple of the values of the input array. - /// NOTE: Use of this function requires using the Boost includes. + /// Returns the least common multiple of the values of the input array. + /// NOTE: Use of this function requires using the Boost includes. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.lcm.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.lcm.html /// /// @param inArray /// @return - /// NdArray + /// NdArray /// template dtype lcm(const NdArray& inArray) diff --git a/include/NumCpp/Functions/ldexp.hpp b/include/NumCpp/Functions/ldexp.hpp index ccf956b3e..d0eded719 100644 --- a/include/NumCpp/Functions/ldexp.hpp +++ b/include/NumCpp/Functions/ldexp.hpp @@ -40,15 +40,15 @@ namespace nc { //============================================================================ // Method Description: - /// Returns x1 * 2^x2. + /// Returns x1 * 2^x2. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ldexp.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ldexp.html /// /// @param inValue1 /// @param inValue2 /// /// @return - /// value + /// value /// template dtype ldexp(dtype inValue1, uint8 inValue2) noexcept @@ -60,15 +60,15 @@ namespace nc //============================================================================ // Method Description: - /// Returns x1 * 2^x2, element-wise. + /// Returns x1 * 2^x2, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ldexp.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ldexp.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray ldexp(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/left_shift.hpp b/include/NumCpp/Functions/left_shift.hpp index 7587284e4..17ec426e6 100644 --- a/include/NumCpp/Functions/left_shift.hpp +++ b/include/NumCpp/Functions/left_shift.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// Shift the bits of an integer to the left. + /// Shift the bits of an integer to the left. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.left_shift.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.left_shift.html /// /// @param inArray /// @param inNumBits /// /// @return - /// NdArray + /// NdArray /// template NdArray left_shift(const NdArray& inArray, uint8 inNumBits) diff --git a/include/NumCpp/Functions/less.hpp b/include/NumCpp/Functions/less.hpp index 25beaeaf9..038f643d3 100644 --- a/include/NumCpp/Functions/less.hpp +++ b/include/NumCpp/Functions/less.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the truth value of (x1 < x2) element-wise. + /// Return the truth value of (x1 < x2) element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.less.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.less.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray less(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/less_equal.hpp b/include/NumCpp/Functions/less_equal.hpp index bf42ae25e..b196898fc 100644 --- a/include/NumCpp/Functions/less_equal.hpp +++ b/include/NumCpp/Functions/less_equal.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the truth value of (x1 <= x2) element-wise. + /// Return the truth value of (x1 <= x2) element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.less_equal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.less_equal.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray less_equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/linspace.hpp b/include/NumCpp/Functions/linspace.hpp index 7aecb529b..c534b02b8 100644 --- a/include/NumCpp/Functions/linspace.hpp +++ b/include/NumCpp/Functions/linspace.hpp @@ -38,17 +38,17 @@ namespace nc { //============================================================================ // Method Description: - /// Return evenly spaced numbers over a specified interval. + /// Return evenly spaced numbers over a specified interval. /// - /// Returns num evenly spaced samples, calculated over the - /// interval[start, stop]. + /// Returns num evenly spaced samples, calculated over the + /// interval[start, stop]. /// - /// The endpoint of the interval can optionally be excluded. + /// The endpoint of the interval can optionally be excluded. /// - /// Mostly only usefull if called with a floating point type - /// for the template argument. + /// Mostly only usefull if called with a floating point type + /// for the template argument. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.linspace.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.linspace.html /// /// @param inStart /// @param inStop @@ -56,7 +56,7 @@ namespace nc /// @param endPoint: include endPoint (default = true) /// /// @return - /// NdArray + /// NdArray /// template NdArray linspace(dtype inStart, dtype inStop, uint32 inNum = 50, bool endPoint = true) diff --git a/include/NumCpp/Functions/load.hpp b/include/NumCpp/Functions/load.hpp index e1d7e8464..3cf187c79 100644 --- a/include/NumCpp/Functions/load.hpp +++ b/include/NumCpp/Functions/load.hpp @@ -36,15 +36,15 @@ namespace nc { //============================================================================ // Method Description: - /// loads a .bin file from the dump() method into an NdArray + /// loads a .bin file from the dump() method into an NdArray /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.load.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.load.html /// /// @param - /// inFilename + /// inFilename /// /// @return - /// NdArray + /// NdArray /// template NdArray load(const std::string& inFilename) diff --git a/include/NumCpp/Functions/log.hpp b/include/NumCpp/Functions/log.hpp index 4011a0ef4..995f402ef 100644 --- a/include/NumCpp/Functions/log.hpp +++ b/include/NumCpp/Functions/log.hpp @@ -38,15 +38,15 @@ namespace nc { //============================================================================ // Method Description: - /// Natural logarithm. + /// Natural logarithm. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template auto log(dtype inValue) noexcept @@ -58,15 +58,15 @@ namespace nc //============================================================================ // Method Description: - /// Natural logarithm, element-wise. + /// Natural logarithm, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template auto log(const NdArray& inArray) diff --git a/include/NumCpp/Functions/log10.hpp b/include/NumCpp/Functions/log10.hpp index 64e7d1256..aec8393de 100644 --- a/include/NumCpp/Functions/log10.hpp +++ b/include/NumCpp/Functions/log10.hpp @@ -38,15 +38,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the base 10 logarithm of the input array. + /// Return the base 10 logarithm of the input array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log10.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log10.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template auto log10(dtype inValue) noexcept @@ -58,15 +58,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the base 10 logarithm of the input array, element-wise. + /// Return the base 10 logarithm of the input array, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log10.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log10.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template auto log10(const NdArray& inArray) diff --git a/include/NumCpp/Functions/log1p.hpp b/include/NumCpp/Functions/log1p.hpp index 75e25a198..f3ae54f65 100644 --- a/include/NumCpp/Functions/log1p.hpp +++ b/include/NumCpp/Functions/log1p.hpp @@ -37,17 +37,17 @@ namespace nc { //============================================================================ // Method Description: - /// Return the natural logarithm of one plus the input array. + /// Return the natural logarithm of one plus the input array. /// - /// Calculates log(1 + x). + /// Calculates log(1 + x). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log1p.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log1p.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template auto log1p(dtype inValue) noexcept @@ -59,17 +59,17 @@ namespace nc //============================================================================ // Method Description: - /// Return the natural logarithm of one plus the input array, element-wise. + /// Return the natural logarithm of one plus the input array, element-wise. /// - /// Calculates log(1 + x). + /// Calculates log(1 + x). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log1p.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log1p.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template auto log1p(const NdArray& inArray) diff --git a/include/NumCpp/Functions/log2.hpp b/include/NumCpp/Functions/log2.hpp index e39273a31..633e73bbd 100644 --- a/include/NumCpp/Functions/log2.hpp +++ b/include/NumCpp/Functions/log2.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Base-2 logarithm of x. + /// Base-2 logarithm of x. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log2.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log2.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template auto log2(dtype inValue) noexcept @@ -57,15 +57,15 @@ namespace nc //============================================================================ // Method Description: - /// Base-2 logarithm of x. + /// Base-2 logarithm of x. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log2.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log2.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template auto log2(const NdArray& inArray) diff --git a/include/NumCpp/Functions/logb.hpp b/include/NumCpp/Functions/logb.hpp index 9fe8397a2..19dadcc0c 100644 --- a/include/NumCpp/Functions/logb.hpp +++ b/include/NumCpp/Functions/logb.hpp @@ -38,7 +38,7 @@ namespace nc { //============================================================================ // Method Description: - /// Logarithm of an arbitrary base + /// Logarithm of an arbitrary base /// /// @param inValue /// @param inBase: the logorithm base @@ -55,7 +55,7 @@ namespace nc //============================================================================ // Method Description: - /// Logarithm of an arbitrary base + /// Logarithm of an arbitrary base /// /// @param inValue /// @param inBase: the logorithm base diff --git a/include/NumCpp/Functions/logical_and.hpp b/include/NumCpp/Functions/logical_and.hpp index a22ae9849..3ef959324 100644 --- a/include/NumCpp/Functions/logical_and.hpp +++ b/include/NumCpp/Functions/logical_and.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the truth value of x1 AND x2 element-wise. + /// Compute the truth value of x1 AND x2 element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_and.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_and.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray logical_and(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/logical_not.hpp b/include/NumCpp/Functions/logical_not.hpp index ed596615c..26cb2b323 100644 --- a/include/NumCpp/Functions/logical_not.hpp +++ b/include/NumCpp/Functions/logical_not.hpp @@ -35,15 +35,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the truth value of NOT x element-wise. + /// Compute the truth value of NOT x element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_not.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_not.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray logical_not(const NdArray& inArray) diff --git a/include/NumCpp/Functions/logical_or.hpp b/include/NumCpp/Functions/logical_or.hpp index 7b38621c6..ddc4baa5b 100644 --- a/include/NumCpp/Functions/logical_or.hpp +++ b/include/NumCpp/Functions/logical_or.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the truth value of x1 OR x2 element-wise. + /// Compute the truth value of x1 OR x2 element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_or.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_or.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray logical_or(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/logical_xor.hpp b/include/NumCpp/Functions/logical_xor.hpp index 021f7092a..0dc9bbe6d 100644 --- a/include/NumCpp/Functions/logical_xor.hpp +++ b/include/NumCpp/Functions/logical_xor.hpp @@ -38,15 +38,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the truth value of x1 XOR x2 element-wise. + /// Compute the truth value of x1 XOR x2 element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_xor.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_xor.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray logical_xor(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/logspace.hpp b/include/NumCpp/Functions/logspace.hpp index e39f44aa3..9ebbeaefb 100644 --- a/include/NumCpp/Functions/logspace.hpp +++ b/include/NumCpp/Functions/logspace.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// Return numbers spaced evenly on a log scale. + /// Return numbers spaced evenly on a log scale. /// /// This is similar to logspace, but with endpoints specified directly. /// Each output sample is a constant multiple of the previous. @@ -46,8 +46,8 @@ namespace nc /// /// @param start: the starting value of a sequence /// @param stop: The final value of the sequence, unless endpoint is False. - /// In that case, num + 1 values are spaced over the interval - /// in log-space, of which all but the last (a sequence of length num) are returned. + /// In that case, num + 1 values are spaced over the interval + /// in log-space, of which all but the last (a sequence of length num) are returned. /// @param num: Number of samples to generate. Default 50. /// @param enpoint: If true, stop is the last sample. Otherwise,it is not included. Default is true. /// @return NdArray diff --git a/include/NumCpp/Functions/matmul.hpp b/include/NumCpp/Functions/matmul.hpp index c50316a4e..213f9f0c5 100644 --- a/include/NumCpp/Functions/matmul.hpp +++ b/include/NumCpp/Functions/matmul.hpp @@ -36,15 +36,15 @@ namespace nc { //============================================================================ // Method Description: - /// Matrix product of two arrays. + /// Matrix product of two arrays. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray matmul(const NdArray& inArray1, const NdArray& inArray2) @@ -54,15 +54,15 @@ namespace nc //============================================================================ // Method Description: - /// Matrix product of two arrays. + /// Matrix product of two arrays. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray> matmul(const NdArray& inArray1, const NdArray>& inArray2) @@ -72,15 +72,15 @@ namespace nc //============================================================================ // Method Description: - /// Matrix product of two arrays. + /// Matrix product of two arrays. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray> matmul(const NdArray>& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/max.hpp b/include/NumCpp/Functions/max.hpp index 396dcb4b3..c869f7981 100644 --- a/include/NumCpp/Functions/max.hpp +++ b/include/NumCpp/Functions/max.hpp @@ -33,13 +33,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return the maximum of an array or maximum along an axis. + /// Return the maximum of an array or maximum along an axis. /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray max(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/maximum.hpp b/include/NumCpp/Functions/maximum.hpp index ced7838b0..0420d1add 100644 --- a/include/NumCpp/Functions/maximum.hpp +++ b/include/NumCpp/Functions/maximum.hpp @@ -40,16 +40,16 @@ namespace nc { //============================================================================ // Method Description: - /// Element-wise maximum of array elements. + /// Element-wise maximum of array elements. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.maximum.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.maximum.html /// /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray maximum(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/mean.hpp b/include/NumCpp/Functions/mean.hpp index d34a9ea21..522de05aa 100644 --- a/include/NumCpp/Functions/mean.hpp +++ b/include/NumCpp/Functions/mean.hpp @@ -39,15 +39,15 @@ namespace nc { //=========================================================================== // Method Description: - /// Compute the mean along the specified axis. + /// Compute the mean along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mean.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mean.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray mean(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -96,15 +96,15 @@ namespace nc //============================================================================ // Method Description: - /// Compute the mean along the specified axis. + /// Compute the mean along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mean.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mean.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray> mean(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/median.hpp b/include/NumCpp/Functions/median.hpp index 8672fe0cc..fd2cba913 100644 --- a/include/NumCpp/Functions/median.hpp +++ b/include/NumCpp/Functions/median.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the median along the specified axis. + /// Compute the median along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.median.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.median.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray median(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/meshgrid.hpp b/include/NumCpp/Functions/meshgrid.hpp index 90b673047..72ab0c47e 100644 --- a/include/NumCpp/Functions/meshgrid.hpp +++ b/include/NumCpp/Functions/meshgrid.hpp @@ -37,18 +37,18 @@ namespace nc { //============================================================================ // Method Description: - /// Return coordinate matrices from coordinate vectors. - /// Make 2D coordinate arrays for vectorized evaluations of 2D scaler - /// vector fields over 2D grids, given one - dimensional coordinate arrays x1, x2, ..., xn. - /// If input arrays are not one dimensional they will be flattened. + /// Return coordinate matrices from coordinate vectors. + /// Make 2D coordinate arrays for vectorized evaluations of 2D scaler + /// vector fields over 2D grids, given one - dimensional coordinate arrays x1, x2, ..., xn. + /// If input arrays are not one dimensional they will be flattened. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html /// /// @param inICoords /// @param inJCoords /// /// @return - /// std::pair, NdArray >, i and j matrices + /// std::pair, NdArray >, i and j matrices /// template std::pair, NdArray > meshgrid(const NdArray& inICoords, const NdArray& inJCoords) @@ -83,17 +83,17 @@ namespace nc //============================================================================ // Method Description: -/// Return coordinate matrices from coordinate vectors. -/// Make 2D coordinate arrays for vectorized evaluations of 2D scaler -/// vector fields over 2D grids, given one - dimensional coordinate arrays x1, x2, ..., xn. +/// Return coordinate matrices from coordinate vectors. +/// Make 2D coordinate arrays for vectorized evaluations of 2D scaler +/// vector fields over 2D grids, given one - dimensional coordinate arrays x1, x2, ..., xn. /// -/// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html +/// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html /// /// @param inSlice1 /// @param inSlice2 /// /// @return -/// std::pair, NdArray >, i and j matrices +/// std::pair, NdArray >, i and j matrices /// template std::pair, NdArray > meshgrid(const Slice& inSlice1, const Slice& inSlice2) diff --git a/include/NumCpp/Functions/min.hpp b/include/NumCpp/Functions/min.hpp index ee9bb93bd..ec09c6194 100644 --- a/include/NumCpp/Functions/min.hpp +++ b/include/NumCpp/Functions/min.hpp @@ -33,13 +33,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return the minimum of an array or minimum along an axis. + /// Return the minimum of an array or minimum along an axis. /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray min(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/minimum.hpp b/include/NumCpp/Functions/minimum.hpp index e02c7f50b..1c720bded 100644 --- a/include/NumCpp/Functions/minimum.hpp +++ b/include/NumCpp/Functions/minimum.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Element-wise minimum of array elements. + /// Element-wise minimum of array elements. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.minimum.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.minimum.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray minimum(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/mod.hpp b/include/NumCpp/Functions/mod.hpp index c3c1215ea..1757eda4c 100644 --- a/include/NumCpp/Functions/mod.hpp +++ b/include/NumCpp/Functions/mod.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return element-wise remainder of division. + /// Return element-wise remainder of division. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mod.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray mod(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/multiply.hpp b/include/NumCpp/Functions/multiply.hpp index 5e24f91ba..db9b29942 100644 --- a/include/NumCpp/Functions/multiply.hpp +++ b/include/NumCpp/Functions/multiply.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray multiply(const NdArray& inArray1, const NdArray& inArray2) @@ -52,14 +52,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray multiply(const NdArray& inArray, dtype value) @@ -69,14 +69,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray multiply(dtype value, const NdArray& inArray) @@ -86,14 +86,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> multiply(const NdArray& inArray1, const NdArray>& inArray2) @@ -103,14 +103,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> multiply(const NdArray>& inArray1, const NdArray& inArray2) @@ -120,14 +120,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> multiply(const NdArray& inArray, const std::complex& value) @@ -137,14 +137,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> multiply(const std::complex& value, const NdArray& inArray) @@ -154,14 +154,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> multiply(const NdArray>& inArray, dtype value) @@ -171,14 +171,14 @@ namespace nc //============================================================================ // Method Description: - /// multiply arguments element-wise. + /// multiply arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> multiply(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/nan_to_num.hpp b/include/NumCpp/Functions/nan_to_num.hpp index ae590ba8e..3a1eebcd3 100644 --- a/include/NumCpp/Functions/nan_to_num.hpp +++ b/include/NumCpp/Functions/nan_to_num.hpp @@ -40,7 +40,7 @@ namespace nc { //============================================================================ // Method Description: - /// Replace NaN with zero and infinity with large finite numbers (default behaviour) + /// Replace NaN with zero and infinity with large finite numbers (default behaviour) /// or with the numbers defined by the user using the nan, posinf and/or neginf keywords. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.nan_to_num.html @@ -50,7 +50,7 @@ namespace nc /// @param posInf: value to be used to fill positive infinity values, default a very large number /// @param negInf: value to be used to fill negative infinity values, default a very large negative number /// @return - /// NdArray + /// NdArray /// template NdArray nan_to_num(NdArray inArray, diff --git a/include/NumCpp/Functions/nanargmax.hpp b/include/NumCpp/Functions/nanargmax.hpp index 2c0380b10..1de70bbfc 100644 --- a/include/NumCpp/Functions/nanargmax.hpp +++ b/include/NumCpp/Functions/nanargmax.hpp @@ -40,14 +40,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the indices of the maximum values along an axis ignoring NaNs. + /// Returns the indices of the maximum values along an axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanargmax.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanargmax.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray nanargmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanargmin.hpp b/include/NumCpp/Functions/nanargmin.hpp index e193855fc..b1ade6653 100644 --- a/include/NumCpp/Functions/nanargmin.hpp +++ b/include/NumCpp/Functions/nanargmin.hpp @@ -40,14 +40,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the indices of the minimum values along an axis ignoring NaNs. + /// Returns the indices of the minimum values along an axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanargmin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanargmin.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray nanargmin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nancumprod.hpp b/include/NumCpp/Functions/nancumprod.hpp index cefab6f66..7c3b6c2a5 100644 --- a/include/NumCpp/Functions/nancumprod.hpp +++ b/include/NumCpp/Functions/nancumprod.hpp @@ -39,14 +39,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the cumulative product of elements along a given axis ignoring NaNs. + /// Return the cumulative product of elements along a given axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nancumprod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nancumprod.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray nancumprod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nancumsum.hpp b/include/NumCpp/Functions/nancumsum.hpp index 9a7f84803..eb5765502 100644 --- a/include/NumCpp/Functions/nancumsum.hpp +++ b/include/NumCpp/Functions/nancumsum.hpp @@ -39,14 +39,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the cumulative sum of the elements along a given axis ignoring NaNs. + /// Return the cumulative sum of the elements along a given axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nancumsum.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nancumsum.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray nancumsum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmax.hpp b/include/NumCpp/Functions/nanmax.hpp index 9bd081da1..a400dc8c6 100644 --- a/include/NumCpp/Functions/nanmax.hpp +++ b/include/NumCpp/Functions/nanmax.hpp @@ -40,15 +40,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the maximum of an array or maximum along an axis ignoring NaNs. + /// Return the maximum of an array or maximum along an axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmax.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmax.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmean.hpp b/include/NumCpp/Functions/nanmean.hpp index 406a0dd53..233c225ed 100644 --- a/include/NumCpp/Functions/nanmean.hpp +++ b/include/NumCpp/Functions/nanmean.hpp @@ -41,15 +41,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the mean along the specified axis ignoring NaNs. + /// Compute the mean along the specified axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmean.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmean.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanmean(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmedian.hpp b/include/NumCpp/Functions/nanmedian.hpp index 6fc81bd7d..be731d2f3 100644 --- a/include/NumCpp/Functions/nanmedian.hpp +++ b/include/NumCpp/Functions/nanmedian.hpp @@ -42,15 +42,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the median along the specified axis ignoring NaNs. + /// Compute the median along the specified axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmedian.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmedian.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanmedian(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmin.hpp b/include/NumCpp/Functions/nanmin.hpp index 3be14451e..b195616b4 100644 --- a/include/NumCpp/Functions/nanmin.hpp +++ b/include/NumCpp/Functions/nanmin.hpp @@ -40,15 +40,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the minimum of an array or maximum along an axis ignoring NaNs. + /// Return the minimum of an array or maximum along an axis ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmin.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanmin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanpercentile.hpp b/include/NumCpp/Functions/nanpercentile.hpp index 57142f9db..1bb296a0e 100644 --- a/include/NumCpp/Functions/nanpercentile.hpp +++ b/include/NumCpp/Functions/nanpercentile.hpp @@ -48,16 +48,16 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the qth percentile of the data along the specified axis, while ignoring nan values. + /// Compute the qth percentile of the data along the specified axis, while ignoring nan values. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanpercentile.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanpercentile.html /// /// @param inArray /// @param inPercentile /// @param inAxis (Optional, default NONE) /// @param inInterpMethod (default linear) choices = ['linear','lower','higher','nearest','midpoint'] /// @return - /// NdArray + /// NdArray /// template NdArray nanpercentile(const NdArray& inArray, double inPercentile, diff --git a/include/NumCpp/Functions/nanprod.hpp b/include/NumCpp/Functions/nanprod.hpp index 08b784a5f..290840fb0 100644 --- a/include/NumCpp/Functions/nanprod.hpp +++ b/include/NumCpp/Functions/nanprod.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the product of array elements over a given axis treating Not a Numbers (NaNs) as ones. + /// Return the product of array elements over a given axis treating Not a Numbers (NaNs) as ones. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanprod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanprod.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanprod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nans.hpp b/include/NumCpp/Functions/nans.hpp index 4ffd5435e..ad98e0f13 100644 --- a/include/NumCpp/Functions/nans.hpp +++ b/include/NumCpp/Functions/nans.hpp @@ -36,13 +36,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with nans. - /// Only really works for dtype = float/double + /// Return a new array of given shape and type, filled with nans. + /// Only really works for dtype = float/double /// /// @param - /// inSquareSize + /// inSquareSize /// @return - /// NdArray + /// NdArray /// inline NdArray nans(uint32 inSquareSize) { @@ -51,13 +51,13 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with nans. - /// Only really works for dtype = float/double + /// Return a new array of given shape and type, filled with nans. + /// Only really works for dtype = float/double /// /// @param inNumRows /// @param inNumCols /// @return - /// NdArray + /// NdArray /// inline NdArray nans(uint32 inNumRows, uint32 inNumCols) { @@ -66,13 +66,13 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with nans. - /// Only really works for dtype = float/double + /// Return a new array of given shape and type, filled with nans. + /// Only really works for dtype = float/double /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// inline NdArray nans(const Shape& inShape) { diff --git a/include/NumCpp/Functions/nans_like.hpp b/include/NumCpp/Functions/nans_like.hpp index f62c28ae2..553701098 100644 --- a/include/NumCpp/Functions/nans_like.hpp +++ b/include/NumCpp/Functions/nans_like.hpp @@ -33,12 +33,12 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with nans. + /// Return a new array of given shape and type, filled with nans. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray nans_like(const NdArray& inArray) diff --git a/include/NumCpp/Functions/nanstdev.hpp b/include/NumCpp/Functions/nanstdev.hpp index 50a4183c9..effccb571 100644 --- a/include/NumCpp/Functions/nanstdev.hpp +++ b/include/NumCpp/Functions/nanstdev.hpp @@ -41,15 +41,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the standard deviation along the specified axis, while ignoring NaNs. + /// Compute the standard deviation along the specified axis, while ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanstd.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanstd.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanstdev(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nansum.hpp b/include/NumCpp/Functions/nansum.hpp index e2b585053..fed538921 100644 --- a/include/NumCpp/Functions/nansum.hpp +++ b/include/NumCpp/Functions/nansum.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the sum of array elements over a given axis treating Not a Numbers (NaNs) as zero. + /// Return the sum of array elements over a given axis treating Not a Numbers (NaNs) as zero. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nansum.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nansum.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nansum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanvar.hpp b/include/NumCpp/Functions/nanvar.hpp index a00ddab31..2d5a155d1 100644 --- a/include/NumCpp/Functions/nanvar.hpp +++ b/include/NumCpp/Functions/nanvar.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the variance along the specified axis, while ignoring NaNs. + /// Compute the variance along the specified axis, while ignoring NaNs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanvar.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanvar.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray nanvar(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nbytes.hpp b/include/NumCpp/Functions/nbytes.hpp index 6ef670521..6b4955b18 100644 --- a/include/NumCpp/Functions/nbytes.hpp +++ b/include/NumCpp/Functions/nbytes.hpp @@ -33,12 +33,12 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the number of bytes held by the array + /// Returns the number of bytes held by the array /// /// @param - /// inArray + /// inArray /// @return - /// number of bytes + /// number of bytes /// template uint64 nbytes(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/negative.hpp b/include/NumCpp/Functions/negative.hpp index 6b358ef75..b400b313f 100644 --- a/include/NumCpp/Functions/negative.hpp +++ b/include/NumCpp/Functions/negative.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Numerical negative, element-wise. + /// Numerical negative, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.negative.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.negative.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray negative(const NdArray& inArray) diff --git a/include/NumCpp/Functions/newbyteorder.hpp b/include/NumCpp/Functions/newbyteorder.hpp index f7820243c..a279ca6bb 100644 --- a/include/NumCpp/Functions/newbyteorder.hpp +++ b/include/NumCpp/Functions/newbyteorder.hpp @@ -34,17 +34,17 @@ namespace nc { //============================================================================ // Method Description: - /// Return the array with the same data viewed with a - /// different byte order. only works for integer types, - /// floating point types will not compile and you will - /// be confused as to why... + /// Return the array with the same data viewed with a + /// different byte order. only works for integer types, + /// floating point types will not compile and you will + /// be confused as to why... /// /// /// @param inValue /// @param inEndianess /// /// @return - /// inValue + /// inValue /// template dtype newbyteorder(dtype inValue, Endian inEndianess) @@ -55,17 +55,17 @@ namespace nc //============================================================================ // Method Description: - /// Return the array with the same data viewed with a - /// different byte order. only works for integer types, - /// floating point types will not compile and you will - /// be confused as to why... + /// Return the array with the same data viewed with a + /// different byte order. only works for integer types, + /// floating point types will not compile and you will + /// be confused as to why... /// /// /// @param inArray /// @param inEndianess /// /// @return - /// NdArray + /// NdArray /// template NdArray newbyteorder(const NdArray& inArray, Endian inEndianess) diff --git a/include/NumCpp/Functions/none.hpp b/include/NumCpp/Functions/none.hpp index ada03cafe..8e60414d8 100644 --- a/include/NumCpp/Functions/none.hpp +++ b/include/NumCpp/Functions/none.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Test whether no array elements along a given axis evaluate to True. + /// Test whether no array elements along a given axis evaluate to True. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.all.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.all.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// bool + /// bool /// template NdArray none(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nonzero.hpp b/include/NumCpp/Functions/nonzero.hpp index d101625cb..5522eb03d 100644 --- a/include/NumCpp/Functions/nonzero.hpp +++ b/include/NumCpp/Functions/nonzero.hpp @@ -35,16 +35,16 @@ namespace nc { //============================================================================ // Method Description: - /// Return the indices of the flattened array of the - /// elements that are non-zero. + /// Return the indices of the flattened array of the + /// elements that are non-zero. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nonzero.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nonzero.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template std::pair, NdArray > nonzero(const NdArray& inArray) diff --git a/include/NumCpp/Functions/norm.hpp b/include/NumCpp/Functions/norm.hpp index b834e814f..1d85ae1a4 100644 --- a/include/NumCpp/Functions/norm.hpp +++ b/include/NumCpp/Functions/norm.hpp @@ -40,13 +40,13 @@ namespace nc { //============================================================================ // Method Description: - /// Matrix or vector norm. + /// Matrix or vector norm. /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray norm(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -103,13 +103,13 @@ namespace nc //============================================================================ // Method Description: - /// Matrix or vector norm. + /// Matrix or vector norm. /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray> norm(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/not_equal.hpp b/include/NumCpp/Functions/not_equal.hpp index 70ebb5572..e31f222f9 100644 --- a/include/NumCpp/Functions/not_equal.hpp +++ b/include/NumCpp/Functions/not_equal.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return (x1 != x2) element-wise. + /// Return (x1 != x2) element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.not_equal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.not_equal.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray not_equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/nth_root.hpp b/include/NumCpp/Functions/nth_root.hpp index 00fcd475d..8df90d7b0 100644 --- a/include/NumCpp/Functions/nth_root.hpp +++ b/include/NumCpp/Functions/nth_root.hpp @@ -36,7 +36,7 @@ namespace nc { //============================================================================ // Method Description: - /// Return the nth-root of an value. + /// Return the nth-root of an value. /// /// @param inValue /// @param inRoot @@ -53,7 +53,7 @@ namespace nc //============================================================================ // Method Description: - /// Return the nth-root of an array. + /// Return the nth-root of an array. /// /// @param inArray /// @param inRoot diff --git a/include/NumCpp/Functions/ones.hpp b/include/NumCpp/Functions/ones.hpp index 3ccaf41bc..c305df82d 100644 --- a/include/NumCpp/Functions/ones.hpp +++ b/include/NumCpp/Functions/ones.hpp @@ -37,13 +37,13 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with ones. + /// Return a new array of given shape and type, filled with ones. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html /// /// @param inSquareSize /// @return - /// NdArray + /// NdArray /// template NdArray ones(uint32 inSquareSize) @@ -55,14 +55,14 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with ones. + /// Return a new array of given shape and type, filled with ones. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html /// /// @param inNumRows /// @param inNumCols /// @return - /// NdArray + /// NdArray /// template NdArray ones(uint32 inNumRows, uint32 inNumCols) @@ -74,14 +74,14 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with ones. + /// Return a new array of given shape and type, filled with ones. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// template NdArray ones(const Shape& inShape) diff --git a/include/NumCpp/Functions/ones_like.hpp b/include/NumCpp/Functions/ones_like.hpp index f7e4a1e60..38477eb68 100644 --- a/include/NumCpp/Functions/ones_like.hpp +++ b/include/NumCpp/Functions/ones_like.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with ones. + /// Return a new array of given shape and type, filled with ones. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones_like.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones_like.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray ones_like(const NdArray& inArray) diff --git a/include/NumCpp/Functions/outer.hpp b/include/NumCpp/Functions/outer.hpp index 8f19ebd1c..0b76b8ae9 100644 --- a/include/NumCpp/Functions/outer.hpp +++ b/include/NumCpp/Functions/outer.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// The outer product of two vectors. Inputs are flattened if not already 1-dimensional. + /// The outer product of two vectors. Inputs are flattened if not already 1-dimensional. /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.outer.html /// diff --git a/include/NumCpp/Functions/pad.hpp b/include/NumCpp/Functions/pad.hpp index def7ca38d..2cb387154 100644 --- a/include/NumCpp/Functions/pad.hpp +++ b/include/NumCpp/Functions/pad.hpp @@ -36,15 +36,15 @@ namespace nc { //============================================================================ // Method Description: - /// Pads an array. + /// Pads an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.pad.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.pad.html /// /// @param inArray /// @param inPadWidth /// @param inPadValue /// @return - /// NdArray + /// NdArray /// template NdArray pad(const NdArray& inArray, uint16 inPadWidth, dtype inPadValue) diff --git a/include/NumCpp/Functions/partition.hpp b/include/NumCpp/Functions/partition.hpp index 810cf4002..3ece35b32 100644 --- a/include/NumCpp/Functions/partition.hpp +++ b/include/NumCpp/Functions/partition.hpp @@ -34,20 +34,20 @@ namespace nc { //============================================================================ // Method Description: - /// Rearranges the elements in the array in such a way that - /// value of the element in kth position is in the position it - /// would be in a sorted array. All elements smaller than the kth - /// element are moved before this element and all equal or greater - /// are moved behind it. The ordering of the elements in the two - /// partitions is undefined. + /// Rearranges the elements in the array in such a way that + /// value of the element in kth position is in the position it + /// would be in a sorted array. All elements smaller than the kth + /// element are moved before this element and all equal or greater + /// are moved behind it. The ordering of the elements in the two + /// partitions is undefined. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.partition.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.partition.html /// /// @param inArray /// @param inKth: kth element /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray partition(const NdArray& inArray, uint32 inKth, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/percentile.hpp b/include/NumCpp/Functions/percentile.hpp index 1cfbc619a..d1dcc484b 100644 --- a/include/NumCpp/Functions/percentile.hpp +++ b/include/NumCpp/Functions/percentile.hpp @@ -46,21 +46,21 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the qth percentile of the data along the specified axis. + /// Compute the qth percentile of the data along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.percentile.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.percentile.html /// /// @param inArray /// @param inPercentile: percentile must be in the range [0, 100] /// @param inAxis (Optional, default NONE) /// @param inInterpMethod (Optional) interpolation method - /// linear: i + (j - i) * fraction, where fraction is the fractional part of the index surrounded by i and j. - /// lower : i. - /// higher : j. - /// nearest : i or j, whichever is nearest. - /// midpoint : (i + j) / 2. + /// linear: i + (j - i) * fraction, where fraction is the fractional part of the index surrounded by i and j. + /// lower : i. + /// higher : j. + /// nearest : i or j, whichever is nearest. + /// midpoint : (i + j) / 2. /// @return - /// NdArray + /// NdArray /// template NdArray percentile(const NdArray& inArray, double inPercentile, diff --git a/include/NumCpp/Functions/place.hpp b/include/NumCpp/Functions/place.hpp index 7bc6b9465..5f6b6d433 100644 --- a/include/NumCpp/Functions/place.hpp +++ b/include/NumCpp/Functions/place.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Change elements of an array based on conditional and input values. + /// Change elements of an array based on conditional and input values. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.place.html /// /// @param arr: Array to put data into. /// @param mask: Boolean mask array. Must have the same size as arr /// @param vals: Values to put into a. Only the first N elements are used, where N is the - /// number of True values in mask. If vals is smaller than N, it will be repeated. + /// number of True values in mask. If vals is smaller than N, it will be repeated. /// @return NdArray /// template diff --git a/include/NumCpp/Functions/polar.hpp b/include/NumCpp/Functions/polar.hpp index de1d114cd..0219c023d 100644 --- a/include/NumCpp/Functions/polar.hpp +++ b/include/NumCpp/Functions/polar.hpp @@ -38,13 +38,13 @@ namespace nc { //============================================================================ // Method Description: - /// Returns a complex number with magnitude r and phase angle theta. + /// Returns a complex number with magnitude r and phase angle theta. /// /// @param magnitude /// @param phaseAngle - /// + /// /// @return - /// std::complex + /// std::complex /// template auto polar(dtype magnitude, dtype phaseAngle) @@ -56,12 +56,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns a complex number with magnitude r and phase angle theta. + /// Returns a complex number with magnitude r and phase angle theta. /// /// @param magnitude /// @param phaseAngle /// @return - /// NdArray + /// NdArray /// template auto polar(const NdArray& magnitude, const NdArray& phaseAngle) diff --git a/include/NumCpp/Functions/power.hpp b/include/NumCpp/Functions/power.hpp index dd6fa97fb..04640f58f 100644 --- a/include/NumCpp/Functions/power.hpp +++ b/include/NumCpp/Functions/power.hpp @@ -40,14 +40,14 @@ namespace nc { //============================================================================ // Method Description: - /// Raises the elements of the array to the input integer power + /// Raises the elements of the array to the input integer power /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// /// @param inValue /// @param inExponent /// @return - /// value raised to the power + /// value raised to the power /// template constexpr dtype power(dtype inValue, uint8 inExponent) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Raises the elements of the array to the input integer power + /// Raises the elements of the array to the input integer power /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// /// @param inArray /// @param inExponent /// @return - /// NdArray + /// NdArray /// template NdArray power(const NdArray& inArray, uint8 inExponent) @@ -81,14 +81,14 @@ namespace nc //============================================================================ // Method Description: - /// Raises the elements of the array to the input integer powers + /// Raises the elements of the array to the input integer powers /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// /// @param inArray /// @param inExponents /// @return - /// NdArray + /// NdArray /// template NdArray power(const NdArray& inArray, const NdArray& inExponents) diff --git a/include/NumCpp/Functions/powerf.hpp b/include/NumCpp/Functions/powerf.hpp index f81241e7c..179731657 100644 --- a/include/NumCpp/Functions/powerf.hpp +++ b/include/NumCpp/Functions/powerf.hpp @@ -40,14 +40,14 @@ namespace nc { //============================================================================ // Method Description: - /// Raises the elements of the array to the input floating point power + /// Raises the elements of the array to the input floating point power /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// /// @param inValue /// @param inExponent /// @return - /// value raised to the power + /// value raised to the power /// template auto powerf(dtype1 inValue, dtype2 inExponent) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Raises the elements of the array to the input floating point power + /// Raises the elements of the array to the input floating point power /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// /// @param inArray /// @param inExponent /// @return - /// NdArray + /// NdArray /// template auto powerf(const NdArray& inArray, dtype2 inExponent) @@ -81,14 +81,14 @@ namespace nc //============================================================================ // Method Description: - /// Raises the elements of the array to the input floating point powers + /// Raises the elements of the array to the input floating point powers /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// /// @param inArray /// @param inExponents /// @return - /// NdArray + /// NdArray /// template auto powerf(const NdArray& inArray, const NdArray& inExponents) diff --git a/include/NumCpp/Functions/print.hpp b/include/NumCpp/Functions/print.hpp index ef1e5069b..b68bf46bc 100644 --- a/include/NumCpp/Functions/print.hpp +++ b/include/NumCpp/Functions/print.hpp @@ -36,12 +36,12 @@ namespace nc { //============================================================================ // Method Description: - /// Prints the array to the console. + /// Prints the array to the console. /// /// @param - /// inArray + /// inArray /// @return - /// None + /// None /// template void print(const NdArray& inArray) diff --git a/include/NumCpp/Functions/prod.hpp b/include/NumCpp/Functions/prod.hpp index fbceaa635..2a4d1a5c7 100644 --- a/include/NumCpp/Functions/prod.hpp +++ b/include/NumCpp/Functions/prod.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the product of array elements over a given axis. + /// Return the product of array elements over a given axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.prod.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.prod.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray prod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/proj.hpp b/include/NumCpp/Functions/proj.hpp index b87d67678..a4fc9847c 100644 --- a/include/NumCpp/Functions/proj.hpp +++ b/include/NumCpp/Functions/proj.hpp @@ -37,12 +37,12 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the projection of the complex number z onto the Riemann sphere. + /// Returns the projection of the complex number z onto the Riemann sphere. /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto proj(const std::complex& inValue) @@ -54,12 +54,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns the projection of the complex number z onto the Riemann sphere. + /// Returns the projection of the complex number z onto the Riemann sphere. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto proj(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/ptp.hpp b/include/NumCpp/Functions/ptp.hpp index ffef33fd4..417306593 100644 --- a/include/NumCpp/Functions/ptp.hpp +++ b/include/NumCpp/Functions/ptp.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Range of values (maximum - minimum) along an axis. + /// Range of values (maximum - minimum) along an axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ptp.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ptp.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray ptp(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/put.hpp b/include/NumCpp/Functions/put.hpp index f4df240f4..70b0ac4b7 100644 --- a/include/NumCpp/Functions/put.hpp +++ b/include/NumCpp/Functions/put.hpp @@ -34,16 +34,16 @@ namespace nc { //============================================================================ // Method Description: - /// Replaces specified elements of an array with given values. - /// The indexing works on the flattened target array + /// Replaces specified elements of an array with given values. + /// The indexing works on the flattened target array /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.put.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.put.html /// /// @param inArray /// @param inIndices /// @param inValue /// @return - /// NdArray + /// NdArray /// template NdArray& put(NdArray& inArray, const NdArray& inIndices, dtype inValue) @@ -54,16 +54,16 @@ namespace nc //============================================================================ // Method Description: - /// Replaces specified elements of an array with given values. - /// The indexing works on the flattened target array + /// Replaces specified elements of an array with given values. + /// The indexing works on the flattened target array /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.put.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.put.html /// /// @param inArray /// @param inIndices /// @param inValues /// @return - /// NdArray + /// NdArray /// template NdArray& put(NdArray& inArray, const NdArray& inIndices, const NdArray& inValues) diff --git a/include/NumCpp/Functions/putmask.hpp b/include/NumCpp/Functions/putmask.hpp index 7daa95212..b2cf5dd24 100644 --- a/include/NumCpp/Functions/putmask.hpp +++ b/include/NumCpp/Functions/putmask.hpp @@ -33,19 +33,19 @@ namespace nc { //============================================================================ // Method Description: - /// Changes elements of an array based on conditional and input values. + /// Changes elements of an array based on conditional and input values. /// - /// Sets a.flat[n] = values[n] for each n where mask.flat[n] == True. + /// Sets a.flat[n] = values[n] for each n where mask.flat[n] == True. /// - /// If values is not the same size as a and mask then it will repeat. + /// If values is not the same size as a and mask then it will repeat. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.putmask.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.putmask.html /// /// @param inArray /// @param inMask /// @param inValue /// @return - /// NdArray + /// NdArray /// template NdArray& putmask(NdArray& inArray, const NdArray& inMask, dtype inValue) @@ -56,19 +56,19 @@ namespace nc //============================================================================ // Method Description: - /// Changes elements of an array based on conditional and input values. + /// Changes elements of an array based on conditional and input values. /// - /// Sets a.flat[n] = values[n] for each n where mask.flat[n] == True. + /// Sets a.flat[n] = values[n] for each n where mask.flat[n] == True. /// - /// If values is not the same size as a and mask then it will repeat. + /// If values is not the same size as a and mask then it will repeat. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.putmask.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.putmask.html /// /// @param inArray /// @param inMask /// @param inValues /// @return - /// NdArray + /// NdArray /// template NdArray& putmask(NdArray& inArray, const NdArray& inMask, const NdArray& inValues) diff --git a/include/NumCpp/Functions/rad2deg.hpp b/include/NumCpp/Functions/rad2deg.hpp index 36b1736c8..7a2aed4c3 100644 --- a/include/NumCpp/Functions/rad2deg.hpp +++ b/include/NumCpp/Functions/rad2deg.hpp @@ -36,15 +36,15 @@ namespace nc { //============================================================================ // Method Description: - /// Convert angles from radians to degrees. + /// Convert angles from radians to degrees. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rad2deg.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rad2deg.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template constexpr auto rad2deg(dtype inValue) noexcept @@ -56,15 +56,15 @@ namespace nc //============================================================================ // Method Description: - /// Convert angles from radians to degrees. + /// Convert angles from radians to degrees. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rad2deg.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rad2deg.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template auto rad2deg(const NdArray& inArray) diff --git a/include/NumCpp/Functions/radians.hpp b/include/NumCpp/Functions/radians.hpp index 37b371db0..30f34cbe5 100644 --- a/include/NumCpp/Functions/radians.hpp +++ b/include/NumCpp/Functions/radians.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Convert angles from degrees to radians. + /// Convert angles from degrees to radians. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.radians.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.radians.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template constexpr auto radians(dtype inValue) noexcept @@ -51,14 +51,14 @@ namespace nc //============================================================================ // Method Description: - /// Convert angles from degrees to radians. + /// Convert angles from degrees to radians. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.radians.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.radians.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto radians(const NdArray& inArray) diff --git a/include/NumCpp/Functions/ravel.hpp b/include/NumCpp/Functions/ravel.hpp index 657ccb8c7..7a33bc911 100644 --- a/include/NumCpp/Functions/ravel.hpp +++ b/include/NumCpp/Functions/ravel.hpp @@ -33,7 +33,7 @@ namespace nc { //============================================================================ // Method Description: - /// Flattens the array but does not make a copy. + /// Flattens the array but does not make a copy. /// /// Numpy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.ravel.html /// diff --git a/include/NumCpp/Functions/real.hpp b/include/NumCpp/Functions/real.hpp index 77da94ad6..9186017da 100644 --- a/include/NumCpp/Functions/real.hpp +++ b/include/NumCpp/Functions/real.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the real part of the complex argument. + /// Return the real part of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.real.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.real.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto real(const std::complex& inValue) @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the real part of the complex argument. + /// Return the real part of the complex argument. /// - /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.real.html + /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.real.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto real(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/reciprocal.hpp b/include/NumCpp/Functions/reciprocal.hpp index ec1e3835b..35212d367 100644 --- a/include/NumCpp/Functions/reciprocal.hpp +++ b/include/NumCpp/Functions/reciprocal.hpp @@ -39,17 +39,17 @@ namespace nc { //============================================================================ // Method Description: - /// Return the reciprocal of the argument, element-wise. + /// Return the reciprocal of the argument, element-wise. /// - /// Calculates 1 / x. + /// Calculates 1 / x. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.reciprocal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.reciprocal.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray reciprocal(const NdArray& inArray) @@ -70,17 +70,17 @@ namespace nc //============================================================================ // Method Description: - /// Return the reciprocal of the argument, element-wise. + /// Return the reciprocal of the argument, element-wise. /// - /// Calculates 1 / x. + /// Calculates 1 / x. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.reciprocal.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.reciprocal.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray> reciprocal(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/remainder.hpp b/include/NumCpp/Functions/remainder.hpp index d099aa06c..d92bf562a 100644 --- a/include/NumCpp/Functions/remainder.hpp +++ b/include/NumCpp/Functions/remainder.hpp @@ -40,15 +40,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return remainder of division. + /// Return remainder of division. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.remainder.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.remainder.html /// /// @param inValue1 /// @param inValue2 /// /// @return - /// NdArray + /// NdArray /// template double remainder(dtype inValue1, dtype inValue2) noexcept @@ -60,15 +60,15 @@ namespace nc //============================================================================ // Method Description: - /// Return element-wise remainder of division. + /// Return element-wise remainder of division. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.remainder.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.remainder.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray remainder(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/repeat.hpp b/include/NumCpp/Functions/repeat.hpp index d573173c3..2b2fb8c52 100644 --- a/include/NumCpp/Functions/repeat.hpp +++ b/include/NumCpp/Functions/repeat.hpp @@ -35,16 +35,16 @@ namespace nc { //============================================================================ // Method Description: - /// Repeat elements of an array. + /// Repeat elements of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.repeat.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.repeat.html /// /// @param inArray /// @param inNumRows /// @param inNumCols /// /// @return - /// NdArray + /// NdArray /// template NdArray repeat(const NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -54,15 +54,15 @@ namespace nc //============================================================================ // Method Description: - /// Repeat elements of an array. + /// Repeat elements of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.repeat.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.repeat.html /// /// @param inArray /// @param inRepeatShape /// /// @return - /// NdArray + /// NdArray /// template NdArray repeat(const NdArray& inArray, const Shape& inRepeatShape) diff --git a/include/NumCpp/Functions/replace.hpp b/include/NumCpp/Functions/replace.hpp index f13f593aa..f543ae9cd 100644 --- a/include/NumCpp/Functions/replace.hpp +++ b/include/NumCpp/Functions/replace.hpp @@ -33,7 +33,7 @@ namespace nc { //============================================================================ // Method Description: - /// Replaces the matching elements of an array with the new value + /// Replaces the matching elements of an array with the new value /// /// @param inArray /// @param oldValue: the value to replace diff --git a/include/NumCpp/Functions/reshape.hpp b/include/NumCpp/Functions/reshape.hpp index 6fe456b7c..d5115ad9e 100644 --- a/include/NumCpp/Functions/reshape.hpp +++ b/include/NumCpp/Functions/reshape.hpp @@ -35,9 +35,9 @@ namespace nc { //============================================================================ // Method Description: - /// Gives a new shape to an array without changing its data. + /// Gives a new shape to an array without changing its data. /// - /// The new shape should be compatible with the original shape. If an single integer, + /// The new shape should be compatible with the original shape. If an single integer, /// then the result will be a 1-D array of that length. One shape dimension /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. @@ -46,7 +46,7 @@ namespace nc /// @param inSize /// /// @return - /// NdArray + /// NdArray /// template NdArray& reshape(NdArray& inArray, uint32 inSize) @@ -57,9 +57,9 @@ namespace nc //============================================================================ // Method Description: - /// Gives a new shape to an array without changing its data. + /// Gives a new shape to an array without changing its data. /// - /// The new shape should be compatible with the original shape. If an single integer, + /// The new shape should be compatible with the original shape. If an single integer, /// then the result will be a 1-D array of that length. One shape dimension /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. @@ -69,7 +69,7 @@ namespace nc /// @param inNumCols /// /// @return - /// NdArray + /// NdArray /// template NdArray& reshape(NdArray& inArray, int32 inNumRows, int32 inNumCols) @@ -80,9 +80,9 @@ namespace nc //============================================================================ // Method Description: - /// Gives a new shape to an array without changing its data. + /// Gives a new shape to an array without changing its data. /// - /// The new shape should be compatible with the original shape. If an single integer, + /// The new shape should be compatible with the original shape. If an single integer, /// then the result will be a 1-D array of that length. One shape dimension /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. @@ -91,7 +91,7 @@ namespace nc /// @param inNewShape /// /// @return - /// NdArray + /// NdArray /// template NdArray& reshape(NdArray& inArray, const Shape& inNewShape) diff --git a/include/NumCpp/Functions/resizeFast.hpp b/include/NumCpp/Functions/resizeFast.hpp index 3b36e64a6..4397bb4ed 100644 --- a/include/NumCpp/Functions/resizeFast.hpp +++ b/include/NumCpp/Functions/resizeFast.hpp @@ -35,17 +35,17 @@ namespace nc { //============================================================================ // Method Description: - /// Change shape and size of array in-place. All previous - /// data of the array is lost. + /// Change shape and size of array in-place. All previous + /// data of the array is lost. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// /// @param inArray /// @param inNumRows /// @param inNumCols /// /// @return - /// NdArray + /// NdArray /// template NdArray& resizeFast(NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -56,16 +56,16 @@ namespace nc //============================================================================ // Method Description: - /// Change shape and size of array in-place. All previous - /// data of the array is lost. + /// Change shape and size of array in-place. All previous + /// data of the array is lost. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// /// @param inArray /// @param inNewShape /// /// @return - /// NdArray + /// NdArray /// template NdArray& resizeFast(NdArray& inArray, const Shape& inNewShape) diff --git a/include/NumCpp/Functions/resizeSlow.hpp b/include/NumCpp/Functions/resizeSlow.hpp index 5d6dcd4f0..a9e2e5c9d 100644 --- a/include/NumCpp/Functions/resizeSlow.hpp +++ b/include/NumCpp/Functions/resizeSlow.hpp @@ -35,19 +35,19 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array with the specified shape. If new shape - /// is larger than old shape then array will be padded with zeros. - /// If new shape is smaller than the old shape then the data will - /// be discarded. + /// Return a new array with the specified shape. If new shape + /// is larger than old shape then array will be padded with zeros. + /// If new shape is smaller than the old shape then the data will + /// be discarded. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// /// @param inArray /// @param inNumRows /// @param inNumCols /// /// @return - /// NdArray + /// NdArray /// template NdArray& resizeSlow(NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -58,18 +58,18 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array with the specified shape. If new shape - /// is larger than old shape then array will be padded with zeros. - /// If new shape is smaller than the old shape then the data will - /// be discarded. + /// Return a new array with the specified shape. If new shape + /// is larger than old shape then array will be padded with zeros. + /// If new shape is smaller than the old shape then the data will + /// be discarded. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// /// @param inArray /// @param inNewShape /// /// @return - /// NdArray + /// NdArray /// template NdArray& resizeSlow(NdArray& inArray, const Shape& inNewShape) diff --git a/include/NumCpp/Functions/right_shift.hpp b/include/NumCpp/Functions/right_shift.hpp index c7f99230c..1b243366d 100644 --- a/include/NumCpp/Functions/right_shift.hpp +++ b/include/NumCpp/Functions/right_shift.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// Shift the bits of an integer to the right. + /// Shift the bits of an integer to the right. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.right_shift.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.right_shift.html /// /// @param inArray /// @param inNumBits /// /// @return - /// NdArray + /// NdArray /// template NdArray right_shift(const NdArray& inArray, uint8 inNumBits) diff --git a/include/NumCpp/Functions/rint.hpp b/include/NumCpp/Functions/rint.hpp index 7c7f7e3b3..c9f45e36a 100644 --- a/include/NumCpp/Functions/rint.hpp +++ b/include/NumCpp/Functions/rint.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Round value to the nearest integer. + /// Round value to the nearest integer. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rint.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rint.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template dtype rint(dtype inValue) noexcept @@ -57,15 +57,15 @@ namespace nc //============================================================================ // Method Description: - /// Round elements of the array to the nearest integer. + /// Round elements of the array to the nearest integer. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rint.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rint.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray rint(const NdArray& inArray) diff --git a/include/NumCpp/Functions/rms.hpp b/include/NumCpp/Functions/rms.hpp index a04aeda85..94f53efe6 100644 --- a/include/NumCpp/Functions/rms.hpp +++ b/include/NumCpp/Functions/rms.hpp @@ -40,13 +40,13 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the root mean square (RMS) along the specified axis. + /// Compute the root mean square (RMS) along the specified axis. /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray rms(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -102,13 +102,13 @@ namespace nc //============================================================================ // Method Description: - /// Compute the root mean square (RMS) along the specified axis. + /// Compute the root mean square (RMS) along the specified axis. /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray> rms(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/roll.hpp b/include/NumCpp/Functions/roll.hpp index 3fc54510a..ef3ab6e3a 100644 --- a/include/NumCpp/Functions/roll.hpp +++ b/include/NumCpp/Functions/roll.hpp @@ -38,16 +38,16 @@ namespace nc { //============================================================================ // Method Description: - /// Roll array elements along a given axis. + /// Roll array elements along a given axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.roll.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.roll.html /// /// @param inArray /// @param inShift: (elements to shift, positive means forward, negative means backwards) /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray roll(const NdArray& inArray, int32 inShift, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/rot90.hpp b/include/NumCpp/Functions/rot90.hpp index 19d630a6b..307b19c65 100644 --- a/include/NumCpp/Functions/rot90.hpp +++ b/include/NumCpp/Functions/rot90.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Rotate an array by 90 degrees counter clockwise in the plane. + /// Rotate an array by 90 degrees counter clockwise in the plane. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rot90.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rot90.html /// /// @param inArray /// @param inK: the number of times to rotate 90 degrees /// /// @return - /// NdArray + /// NdArray /// template NdArray rot90(const NdArray& inArray, uint8 inK = 1) diff --git a/include/NumCpp/Functions/round.hpp b/include/NumCpp/Functions/round.hpp index c5f9c200b..49ef1b8de 100644 --- a/include/NumCpp/Functions/round.hpp +++ b/include/NumCpp/Functions/round.hpp @@ -34,13 +34,13 @@ namespace nc { //============================================================================ // Method Description: - /// Round value to the given number of decimals. + /// Round value to the given number of decimals. /// /// @param inValue /// @param inDecimals /// /// @return - /// value + /// value /// template dtype round(dtype inValue, uint8 inDecimals = 0) @@ -51,13 +51,13 @@ namespace nc //============================================================================ // Method Description: - /// Round an array to the given number of decimals. + /// Round an array to the given number of decimals. /// /// @param inArray /// @param inDecimals /// /// @return - /// NdArray + /// NdArray /// template NdArray round(const NdArray& inArray, uint8 inDecimals = 0) diff --git a/include/NumCpp/Functions/row_stack.hpp b/include/NumCpp/Functions/row_stack.hpp index ee32cd306..91e4997d7 100644 --- a/include/NumCpp/Functions/row_stack.hpp +++ b/include/NumCpp/Functions/row_stack.hpp @@ -39,13 +39,13 @@ namespace nc { //============================================================================ // Method Description: - /// Stack arrays in sequence vertically (row wise). + /// Stack arrays in sequence vertically (row wise). /// /// @param - /// inArrayList: {list} of arrays to stack + /// inArrayList: {list} of arrays to stack /// /// @return - /// NdArray + /// NdArray /// template NdArray row_stack(const std::initializer_list >& inArrayList) diff --git a/include/NumCpp/Functions/select.hpp b/include/NumCpp/Functions/select.hpp index 75e5de017..23623af88 100644 --- a/include/NumCpp/Functions/select.hpp +++ b/include/NumCpp/Functions/select.hpp @@ -40,15 +40,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return an array drawn from elements in choiceVec, depending on conditions. + /// Return an array drawn from elements in choiceVec, depending on conditions. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.select.html?highlight=select#numpy.select /// /// @param condVec The vector of conditions which determine from which array in choiceVec - /// the output elements are taken. When multiple conditions are satisfied, - /// the first one encountered in choiceVec is used. + /// the output elements are taken. When multiple conditions are satisfied, + /// the first one encountered in choiceVec is used. /// @param choiceVec The vector of array pointers from which the output elements are taken. - /// It has to be of the same length as condVec. + /// It has to be of the same length as condVec. /// @param defaultValue The element inserted in output when all conditions evaluate to False /// @return NdArray /// @@ -119,15 +119,15 @@ namespace nc //============================================================================ // Method Description: - /// Return an array drawn from elements in choiceList, depending on conditions. + /// Return an array drawn from elements in choiceList, depending on conditions. /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.select.html?highlight=select#numpy.select /// /// @param condList The list of conditions which determine from which array in choiceList - /// the output elements are taken. When multiple conditions are satisfied, - /// the first one encountered in choiceList is used. + /// the output elements are taken. When multiple conditions are satisfied, + /// the first one encountered in choiceList is used. /// @param choiceList The list of array pointers from which the output elements are taken. - /// It has to be of the same length as condVec. + /// It has to be of the same length as condVec. /// @param defaultValue The element inserted in output when all conditions evaluate to False /// @return NdArray /// diff --git a/include/NumCpp/Functions/setdiff1d.hpp b/include/NumCpp/Functions/setdiff1d.hpp index 3d03ed177..f13e918bd 100644 --- a/include/NumCpp/Functions/setdiff1d.hpp +++ b/include/NumCpp/Functions/setdiff1d.hpp @@ -40,16 +40,16 @@ namespace nc { //============================================================================ // Method Description: - /// Find the set difference of two arrays. + /// Find the set difference of two arrays. /// - /// Return the sorted, unique values in ar1 that are not in ar2. + /// Return the sorted, unique values in ar1 that are not in ar2. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.setdiff1d.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.setdiff1d.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray setdiff1d(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/shape.hpp b/include/NumCpp/Functions/shape.hpp index 5ad62a01b..6f69275c1 100644 --- a/include/NumCpp/Functions/shape.hpp +++ b/include/NumCpp/Functions/shape.hpp @@ -33,12 +33,12 @@ namespace nc { //============================================================================ // Method Description: - /// Return the shape of the array + /// Return the shape of the array /// /// @param - /// inArray + /// inArray /// @return - /// Shape + /// Shape /// template Shape shape(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/sign.hpp b/include/NumCpp/Functions/sign.hpp index ad5fcad68..142522a1c 100644 --- a/include/NumCpp/Functions/sign.hpp +++ b/include/NumCpp/Functions/sign.hpp @@ -38,17 +38,17 @@ namespace nc { //============================================================================ // Method Description: - /// Returns an element-wise indication of the sign of a number. + /// Returns an element-wise indication of the sign of a number. /// - /// The sign function returns - 1 if x < 0, 0 if x == 0, 1 if x > 0. - /// nan is returned for nan inputs. + /// The sign function returns - 1 if x < 0, 0 if x == 0, 1 if x > 0. + /// nan is returned for nan inputs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sign.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sign.html /// /// @param - /// inValue + /// inValue /// @return - /// NdArray + /// NdArray /// template int8 sign(dtype inValue) noexcept @@ -70,17 +70,17 @@ namespace nc //============================================================================ // Method Description: - /// Returns an element-wise indication of the sign of a number. + /// Returns an element-wise indication of the sign of a number. /// - /// The sign function returns - 1 if x < 0, 0 if x == 0, 1 if x > 0. - /// nan is returned for nan inputs. + /// The sign function returns - 1 if x < 0, 0 if x == 0, 1 if x > 0. + /// nan is returned for nan inputs. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sign.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sign.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray sign(const NdArray& inArray) diff --git a/include/NumCpp/Functions/signbit.hpp b/include/NumCpp/Functions/signbit.hpp index a2e5220d0..b0085b425 100644 --- a/include/NumCpp/Functions/signbit.hpp +++ b/include/NumCpp/Functions/signbit.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns element-wise True where signbit is set (less than zero). + /// Returns element-wise True where signbit is set (less than zero). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.signbit.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.signbit.html /// /// @param - /// inValue + /// inValue /// @return - /// NdArray + /// NdArray /// template bool signbit(dtype inValue) noexcept @@ -54,14 +54,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns element-wise True where signbit is set (less than zero). + /// Returns element-wise True where signbit is set (less than zero). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.signbit.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.signbit.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray signbit(const NdArray& inArray) diff --git a/include/NumCpp/Functions/sin.hpp b/include/NumCpp/Functions/sin.hpp index 8f89183b8..63fe3203c 100644 --- a/include/NumCpp/Functions/sin.hpp +++ b/include/NumCpp/Functions/sin.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Trigonometric sine. + /// Trigonometric sine. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sin.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto sin(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Trigonometric sine, element-wise. + /// Trigonometric sine, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sin.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sin.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto sin(const NdArray& inArray) diff --git a/include/NumCpp/Functions/sinc.hpp b/include/NumCpp/Functions/sinc.hpp index be3a77cd8..b3049ddd3 100644 --- a/include/NumCpp/Functions/sinc.hpp +++ b/include/NumCpp/Functions/sinc.hpp @@ -37,16 +37,16 @@ namespace nc { //============================================================================ // Method Description: - /// Return the sinc function. + /// Return the sinc function. /// - /// The sinc function is sin(pi*x) / (pi*x). + /// The sinc function is sin(pi*x) / (pi*x). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinc.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinc.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto sinc(dtype inValue) noexcept @@ -58,16 +58,16 @@ namespace nc //============================================================================ // Method Description: - /// Return the sinc function. + /// Return the sinc function. /// - /// The sinc function is sin(pi*x) / (pi*x). + /// The sinc function is sin(pi*x) / (pi*x). /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinc.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinc.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto sinc(const NdArray& inArray) diff --git a/include/NumCpp/Functions/sinh.hpp b/include/NumCpp/Functions/sinh.hpp index ac878c26e..6041df55e 100644 --- a/include/NumCpp/Functions/sinh.hpp +++ b/include/NumCpp/Functions/sinh.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Hyperbolic sine. + /// Hyperbolic sine. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinh.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto sinh(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Hyperbolic sine, element-wise. + /// Hyperbolic sine, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinh.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto sinh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/size.hpp b/include/NumCpp/Functions/size.hpp index 96006aede..5a54b6114 100644 --- a/include/NumCpp/Functions/size.hpp +++ b/include/NumCpp/Functions/size.hpp @@ -34,12 +34,12 @@ namespace nc { //============================================================================ // Method Description: - /// Return the number of elements. + /// Return the number of elements. /// /// @param - /// inArray + /// inArray /// @return - /// uint32 size + /// uint32 size /// template uint32 size(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/sort.hpp b/include/NumCpp/Functions/sort.hpp index fe48d2dcf..3464938a4 100644 --- a/include/NumCpp/Functions/sort.hpp +++ b/include/NumCpp/Functions/sort.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a sorted copy of an array. + /// Return a sorted copy of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sort.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sort.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray sort(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/sqrt.hpp b/include/NumCpp/Functions/sqrt.hpp index 7b31bb2e9..1b778fe2b 100644 --- a/include/NumCpp/Functions/sqrt.hpp +++ b/include/NumCpp/Functions/sqrt.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the positive square-root of a value. + /// Return the positive square-root of a value. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sqrt.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sqrt.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto sqrt(dtype inValue) noexcept @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the positive square-root of an array, element-wise. + /// Return the positive square-root of an array, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sqrt.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sqrt.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto sqrt(const NdArray& inArray) diff --git a/include/NumCpp/Functions/square.hpp b/include/NumCpp/Functions/square.hpp index fa14b1571..7c52294a2 100644 --- a/include/NumCpp/Functions/square.hpp +++ b/include/NumCpp/Functions/square.hpp @@ -36,14 +36,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return the square of an array. + /// Return the square of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.square.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.square.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template constexpr dtype square(dtype inValue) noexcept @@ -55,14 +55,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the square of an array, element-wise. + /// Return the square of an array, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.square.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.square.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray square(const NdArray& inArray) diff --git a/include/NumCpp/Functions/stack.hpp b/include/NumCpp/Functions/stack.hpp index 45d1af6bd..5ef75f7d0 100644 --- a/include/NumCpp/Functions/stack.hpp +++ b/include/NumCpp/Functions/stack.hpp @@ -40,14 +40,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the variance along the specified axis. + /// Compute the variance along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.stack.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.stack.html /// /// @param inArrayList: {list} of arrays to stack /// @param inAxis: axis to stack the input NdArrays /// @return - /// NdArray + /// NdArray /// template NdArray stack(std::initializer_list > inArrayList, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/stdev.hpp b/include/NumCpp/Functions/stdev.hpp index 9b9713dfe..1d39f6508 100644 --- a/include/NumCpp/Functions/stdev.hpp +++ b/include/NumCpp/Functions/stdev.hpp @@ -40,14 +40,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the standard deviation along the specified axis. + /// Compute the standard deviation along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.std.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.std.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray stdev(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -113,14 +113,14 @@ namespace nc //============================================================================ // Method Description: - /// Compute the standard deviation along the specified axis. + /// Compute the standard deviation along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.std.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.std.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray> stdev(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/subtract.hpp b/include/NumCpp/Functions/subtract.hpp index 4b5fa3d6b..9a430d468 100644 --- a/include/NumCpp/Functions/subtract.hpp +++ b/include/NumCpp/Functions/subtract.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray subtract(const NdArray& inArray1, const NdArray& inArray2) @@ -52,14 +52,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray subtract(const NdArray& inArray, dtype value) @@ -69,14 +69,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray subtract(dtype value, const NdArray& inArray) @@ -86,14 +86,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> subtract(const NdArray& inArray1, const NdArray>& inArray2) @@ -103,14 +103,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param inArray1 /// @param inArray2 /// @return - /// NdArray + /// NdArray /// template NdArray> subtract(const NdArray>& inArray1, const NdArray& inArray2) @@ -120,14 +120,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> subtract(const NdArray& inArray, const std::complex& value) @@ -137,14 +137,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> subtract(const std::complex& value, const NdArray& inArray) @@ -154,14 +154,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param inArray /// @param value /// @return - /// NdArray + /// NdArray /// template NdArray> subtract(const NdArray>& inArray, dtype value) @@ -171,14 +171,14 @@ namespace nc //============================================================================ // Method Description: - /// subtract arguments element-wise. + /// subtract arguments element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// /// @param value /// @param inArray /// @return - /// NdArray + /// NdArray /// template NdArray> subtract(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/sum.hpp b/include/NumCpp/Functions/sum.hpp index 63ae8fd6b..c3e4951de 100644 --- a/include/NumCpp/Functions/sum.hpp +++ b/include/NumCpp/Functions/sum.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Sum of array elements over a given axis. + /// Sum of array elements over a given axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sum.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sum.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// template NdArray sum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/swap.hpp b/include/NumCpp/Functions/swap.hpp index a827d2fd8..62ea7afdc 100644 --- a/include/NumCpp/Functions/swap.hpp +++ b/include/NumCpp/Functions/swap.hpp @@ -33,7 +33,7 @@ namespace nc { //============================================================================ // Method Description: - /// Swaps the contents of two arrays + /// Swaps the contents of two arrays /// /// @param inArray1 /// @param inArray2 diff --git a/include/NumCpp/Functions/swapaxes.hpp b/include/NumCpp/Functions/swapaxes.hpp index 5f085c414..d35df29a7 100644 --- a/include/NumCpp/Functions/swapaxes.hpp +++ b/include/NumCpp/Functions/swapaxes.hpp @@ -33,14 +33,14 @@ namespace nc { //============================================================================ // Method Description: - /// Interchange two axes of an array. + /// Interchange two axes of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.swapaxes.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.swapaxes.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray swapaxes(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tan.hpp b/include/NumCpp/Functions/tan.hpp index 4cb382b8b..ba6c6d157 100644 --- a/include/NumCpp/Functions/tan.hpp +++ b/include/NumCpp/Functions/tan.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute tangent. + /// Compute tangent. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tan.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tan.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto tan(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Compute tangent element-wise. + /// Compute tangent element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tan.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tan.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto tan(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tanh.hpp b/include/NumCpp/Functions/tanh.hpp index 7f2b5a96a..04c371980 100644 --- a/include/NumCpp/Functions/tanh.hpp +++ b/include/NumCpp/Functions/tanh.hpp @@ -38,14 +38,14 @@ namespace nc { //============================================================================ // Method Description: - /// Compute hyperbolic tangent. + /// Compute hyperbolic tangent. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tanh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tanh.html /// /// @param - /// inValue + /// inValue /// @return - /// value + /// value /// template auto tanh(dtype inValue) noexcept @@ -57,14 +57,14 @@ namespace nc //============================================================================ // Method Description: - /// Compute hyperbolic tangent element-wise. + /// Compute hyperbolic tangent element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tanh.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tanh.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto tanh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tile.hpp b/include/NumCpp/Functions/tile.hpp index a546c6636..8348aefee 100644 --- a/include/NumCpp/Functions/tile.hpp +++ b/include/NumCpp/Functions/tile.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// Construct an array by repeating A the number of times given by reps. + /// Construct an array by repeating A the number of times given by reps. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tile.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tile.html /// /// @param inArray /// @param inNumRows /// @param inNumCols /// @return - /// NdArray + /// NdArray /// template NdArray tile(const NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -52,14 +52,14 @@ namespace nc //============================================================================ // Method Description: - /// Construct an array by repeating A the number of times given by reps. + /// Construct an array by repeating A the number of times given by reps. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tile.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tile.html /// /// @param inArray /// @param inReps /// @return - /// NdArray + /// NdArray /// template NdArray tile(const NdArray& inArray, const Shape& inReps) diff --git a/include/NumCpp/Functions/toStlVector.hpp b/include/NumCpp/Functions/toStlVector.hpp index c056cd220..25476fa45 100644 --- a/include/NumCpp/Functions/toStlVector.hpp +++ b/include/NumCpp/Functions/toStlVector.hpp @@ -33,12 +33,12 @@ namespace nc { //============================================================================ // Method Description: - /// Write flattened array to an STL vector + /// Write flattened array to an STL vector /// /// @param - /// inArray + /// inArray /// @return - /// std::vector + /// std::vector /// template std::vector toStlVector(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tofile.hpp b/include/NumCpp/Functions/tofile.hpp index 979ce4635..0a1f957da 100644 --- a/include/NumCpp/Functions/tofile.hpp +++ b/include/NumCpp/Functions/tofile.hpp @@ -35,14 +35,14 @@ namespace nc { //============================================================================ // Method Description: - /// Write array to a file as binary. - /// The data produced by this method can be recovered - /// using the function fromfile(). + /// Write array to a file as binary. + /// The data produced by this method can be recovered + /// using the function fromfile(). /// /// @param inArray /// @param inFilename /// @return - /// None + /// None /// template void tofile(const NdArray& inArray, const std::string& inFilename) @@ -52,15 +52,15 @@ namespace nc //============================================================================ // Method Description: - /// Write array to a file as text. - /// The data produced by this method can be recovered - /// using the function fromfile(). + /// Write array to a file as text. + /// The data produced by this method can be recovered + /// using the function fromfile(). /// /// @param inArray /// @param inFilename /// @param inSep: Separator between array items for text output. /// @return - /// None + /// None /// template void tofile(const NdArray& inArray, const std::string& inFilename, const char inSep) diff --git a/include/NumCpp/Functions/trace.hpp b/include/NumCpp/Functions/trace.hpp index 92fb69434..c86bb1c5b 100644 --- a/include/NumCpp/Functions/trace.hpp +++ b/include/NumCpp/Functions/trace.hpp @@ -34,15 +34,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the sum along diagonals of the array. + /// Return the sum along diagonals of the array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trace.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trace.html /// /// @param inArray /// @param inOffset: (Offset from main diaganol, default = 0, negative=above, positve=below) /// @param inAxis (Optional, default ROW) /// @return - /// NdArray + /// NdArray /// template dtype trace(const NdArray& inArray, int16 inOffset = 0, Axis inAxis = Axis::ROW) noexcept diff --git a/include/NumCpp/Functions/transpose.hpp b/include/NumCpp/Functions/transpose.hpp index 3cc2fe96f..64e444f7c 100644 --- a/include/NumCpp/Functions/transpose.hpp +++ b/include/NumCpp/Functions/transpose.hpp @@ -33,15 +33,15 @@ namespace nc { //============================================================================ // Method Description: - /// Permute the dimensions of an array. + /// Permute the dimensions of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.transpose.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.transpose.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray transpose(const NdArray& inArray) diff --git a/include/NumCpp/Functions/trapz.hpp b/include/NumCpp/Functions/trapz.hpp index 5262e16a8..cd0c322d5 100644 --- a/include/NumCpp/Functions/trapz.hpp +++ b/include/NumCpp/Functions/trapz.hpp @@ -39,16 +39,16 @@ namespace nc { //============================================================================ // Method Description: - /// Integrate along the given axis using the composite trapezoidal rule. + /// Integrate along the given axis using the composite trapezoidal rule. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trapz.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trapz.html /// /// @param inArray /// @param dx: (Optional defaults to 1.0) /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray trapz(const NdArray& inArray, double dx = 1.0, Axis inAxis = Axis::NONE) @@ -115,16 +115,16 @@ namespace nc //============================================================================ // Method Description: - /// Integrate along the given axis using the composite trapezoidal rule. + /// Integrate along the given axis using the composite trapezoidal rule. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trapz.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trapz.html /// /// @param inArrayY /// @param inArrayX /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray trapz(const NdArray& inArrayY, const NdArray& inArrayX, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/tri.hpp b/include/NumCpp/Functions/tri.hpp index 86383755a..2a12c0ed6 100644 --- a/include/NumCpp/Functions/tri.hpp +++ b/include/NumCpp/Functions/tri.hpp @@ -36,16 +36,16 @@ namespace nc { //============================================================================ // Method Description: - /// An array with ones at and below the given diagonal and zeros elsewhere. + /// An array with ones at and below the given diagonal and zeros elsewhere. /// /// @param inN: number of rows and cols /// @param inOffset: (the sub-diagonal at and below which the array is filled. - /// k = 0 is the main diagonal, while k < 0 is below it, - /// and k > 0 is above. The default is 0.) + /// k = 0 is the main diagonal, while k < 0 is below it, + /// and k > 0 is above. The default is 0.) /// /// /// @return - /// NdArray + /// NdArray /// template NdArray tril(uint32 inN, int32 inOffset = 0) @@ -83,17 +83,17 @@ namespace nc //============================================================================ // Method Description: - /// An array with ones at and below the given diagonal and zeros elsewhere. + /// An array with ones at and below the given diagonal and zeros elsewhere. /// /// @param inN: number of rows /// @param inM: number of columns /// @param inOffset: (the sub-diagonal at and below which the array is filled. - /// k = 0 is the main diagonal, while k < 0 is below it, - /// and k > 0 is above. The default is 0.) + /// k = 0 is the main diagonal, while k < 0 is below it, + /// and k > 0 is above. The default is 0.) /// /// /// @return - /// NdArray + /// NdArray /// template NdArray tril(uint32 inN, uint32 inM, int32 inOffset = 0) @@ -135,20 +135,20 @@ namespace nc //============================================================================ // Method Description: - /// Lower triangle of an array. + /// Lower triangle of an array. /// - /// Return a copy of an array with elements above the k - th diagonal zeroed. + /// Return a copy of an array with elements above the k - th diagonal zeroed. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tril.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tril.html /// /// @param inArray: number of rows and cols /// @param inOffset: (the sub-diagonal at and below which the array is filled. - /// k = 0 is the main diagonal, while k < 0 is below it, - /// and k > 0 is above. The default is 0.) + /// k = 0 is the main diagonal, while k < 0 is below it, + /// and k > 0 is above. The default is 0.) /// /// /// @return - /// NdArray + /// NdArray /// template NdArray tril(const NdArray& inArray, int32 inOffset = 0) @@ -163,17 +163,17 @@ namespace nc //============================================================================ // Method Description: - /// An array with ones at and above the given diagonal and zeros elsewhere. + /// An array with ones at and above the given diagonal and zeros elsewhere. /// /// @param inN: number of rows /// @param inM: number of columns /// @param inOffset: (the sub-diagonal at and above which the array is filled. - /// k = 0 is the main diagonal, while k < 0 is below it, - /// and k > 0 is above. The default is 0.) + /// k = 0 is the main diagonal, while k < 0 is below it, + /// and k > 0 is above. The default is 0.) /// /// /// @return - /// NdArray + /// NdArray /// template NdArray triu(uint32 inN, uint32 inM, int32 inOffset) @@ -214,16 +214,16 @@ namespace nc //============================================================================ // Method Description: - /// An array with ones at and above the given diagonal and zeros elsewhere. + /// An array with ones at and above the given diagonal and zeros elsewhere. /// /// @param inN: number of rows and cols /// @param inOffset: (the sub-diagonal at and above which the array is filled. - /// k = 0 is the main diagonal, while k < 0 is below it, - /// and k > 0 is above. The default is 0.) + /// k = 0 is the main diagonal, while k < 0 is below it, + /// and k > 0 is above. The default is 0.) /// /// /// @return - /// NdArray + /// NdArray /// template NdArray triu(uint32 inN, int32 inOffset = 0) @@ -235,20 +235,20 @@ namespace nc //============================================================================ // Method Description: - /// Upper triangle of an array. + /// Upper triangle of an array. /// - /// Return a copy of an array with elements below the k - th diagonal zeroed. + /// Return a copy of an array with elements below the k - th diagonal zeroed. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.triu.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.triu.html /// /// @param inArray: number of rows and cols /// @param inOffset: (the sub-diagonal at and below which the array is filled. - /// k = 0 is the main diagonal, while k < 0 is below it, - /// and k > 0 is above. The default is 0.) + /// k = 0 is the main diagonal, while k < 0 is below it, + /// and k > 0 is above. The default is 0.) /// /// /// @return - /// NdArray + /// NdArray /// template NdArray triu(const NdArray& inArray, int32 inOffset = 0) diff --git a/include/NumCpp/Functions/trim_zeros.hpp b/include/NumCpp/Functions/trim_zeros.hpp index 732e3af32..948a9af40 100644 --- a/include/NumCpp/Functions/trim_zeros.hpp +++ b/include/NumCpp/Functions/trim_zeros.hpp @@ -39,15 +39,15 @@ namespace nc { //============================================================================ // Method Description: - /// Trim the leading and/or trailing zeros from a 1-D array or sequence. + /// Trim the leading and/or trailing zeros from a 1-D array or sequence. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trim_zeros.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trim_zeros.html /// /// @param inArray /// @param inTrim: ("f" = front, "b" = back, "fb" = front and back) /// /// @return - /// NdArray + /// NdArray /// template NdArray trim_zeros(const NdArray& inArray, const std::string& inTrim = "fb") diff --git a/include/NumCpp/Functions/trunc.hpp b/include/NumCpp/Functions/trunc.hpp index 023a0b32d..f3e7d9051 100644 --- a/include/NumCpp/Functions/trunc.hpp +++ b/include/NumCpp/Functions/trunc.hpp @@ -37,15 +37,15 @@ namespace nc { //============================================================================ // Method Description: - /// Return the truncated value of the input. + /// Return the truncated value of the input. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trunc.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trunc.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template dtype trunc(dtype inValue) noexcept @@ -57,15 +57,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the truncated value of the input, element-wise. + /// Return the truncated value of the input, element-wise. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trunc.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trunc.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray trunc(const NdArray& inArray) diff --git a/include/NumCpp/Functions/union1d.hpp b/include/NumCpp/Functions/union1d.hpp index e5748a2ac..56bac3266 100644 --- a/include/NumCpp/Functions/union1d.hpp +++ b/include/NumCpp/Functions/union1d.hpp @@ -35,18 +35,18 @@ namespace nc { //============================================================================ // Method Description: - /// Find the union of two arrays. + /// Find the union of two arrays. /// - /// Return the unique, sorted array of values that are in - /// either of the two input arrays. + /// Return the unique, sorted array of values that are in + /// either of the two input arrays. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.union1d.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.union1d.html /// /// @param inArray1 /// @param inArray2 /// /// @return - /// NdArray + /// NdArray /// template NdArray union1d(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/unique.hpp b/include/NumCpp/Functions/unique.hpp index ba9129779..bb7f4c44b 100644 --- a/include/NumCpp/Functions/unique.hpp +++ b/include/NumCpp/Functions/unique.hpp @@ -40,17 +40,17 @@ namespace nc { //============================================================================ // Method Description: - /// Find the unique elements of an array. + /// Find the unique elements of an array. /// - /// Returns the sorted unique elements of an array. + /// Returns the sorted unique elements of an array. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unique.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unique.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray unique(const NdArray& inArray) diff --git a/include/NumCpp/Functions/unwrap.hpp b/include/NumCpp/Functions/unwrap.hpp index ad2a92627..c87b26d30 100644 --- a/include/NumCpp/Functions/unwrap.hpp +++ b/include/NumCpp/Functions/unwrap.hpp @@ -37,16 +37,16 @@ namespace nc { //============================================================================ // Method Description: - /// Unwrap by changing deltas between values to 2*pi complement. - /// Unwraps to [-pi, pi]. + /// Unwrap by changing deltas between values to 2*pi complement. + /// Unwraps to [-pi, pi]. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unwrap.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unwrap.html /// /// @param - /// inValue + /// inValue /// /// @return - /// value + /// value /// template dtype unwrap(dtype inValue) noexcept @@ -58,16 +58,16 @@ namespace nc //============================================================================ // Method Description: - /// Unwrap by changing deltas between values to 2*pi complement. - /// Unwraps to [-pi, pi]. + /// Unwrap by changing deltas between values to 2*pi complement. + /// Unwraps to [-pi, pi]. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unwrap.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unwrap.html /// /// @param - /// inArray + /// inArray /// /// @return - /// NdArray + /// NdArray /// template NdArray unwrap(const NdArray& inArray) diff --git a/include/NumCpp/Functions/var.hpp b/include/NumCpp/Functions/var.hpp index f46d8d69a..3c5ec40dc 100644 --- a/include/NumCpp/Functions/var.hpp +++ b/include/NumCpp/Functions/var.hpp @@ -38,15 +38,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the variance along the specified axis. + /// Compute the variance along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.var.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.var.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray var(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -65,15 +65,15 @@ namespace nc //============================================================================ // Method Description: - /// Compute the variance along the specified axis. + /// Compute the variance along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.var.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.var.html /// /// @param inArray /// @param inAxis (Optional, default NONE) /// /// @return - /// NdArray + /// NdArray /// template NdArray> var(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/vstack.hpp b/include/NumCpp/Functions/vstack.hpp index aeafb2db8..523b90c0e 100644 --- a/include/NumCpp/Functions/vstack.hpp +++ b/include/NumCpp/Functions/vstack.hpp @@ -36,15 +36,15 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the variance along the specified axis. + /// Compute the variance along the specified axis. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.vstack.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.vstack.html /// /// @param - /// inArrayList: {list} of arrays to stack + /// inArrayList: {list} of arrays to stack /// /// @return - /// NdArray + /// NdArray /// template NdArray vstack(std::initializer_list > inArrayList) diff --git a/include/NumCpp/Functions/where.hpp b/include/NumCpp/Functions/where.hpp index a6edcea38..601a5b081 100644 --- a/include/NumCpp/Functions/where.hpp +++ b/include/NumCpp/Functions/where.hpp @@ -37,11 +37,11 @@ namespace nc { //============================================================================ // Method Description: - /// Return elements, either from x or y, depending on the input mask. - /// The output array contains elements of x where mask is True, and - /// elements from y elsewhere. + /// Return elements, either from x or y, depending on the input mask. + /// The output array contains elements of x where mask is True, and + /// elements from y elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// /// @param inMask /// @param inA @@ -84,11 +84,11 @@ namespace nc //============================================================================ // Method Description: - /// Return elements, either from x or y, depending on the input mask. - /// The output array contains elements of x where mask is True, and - /// elements from y elsewhere. + /// Return elements, either from x or y, depending on the input mask. + /// The output array contains elements of x where mask is True, and + /// elements from y elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// /// @param inMask /// @param inA @@ -126,11 +126,11 @@ namespace nc //============================================================================ // Method Description: - /// Return elements, either from x or y, depending on the input mask. - /// The output array contains elements of x where mask is True, and - /// elements from y elsewhere. + /// Return elements, either from x or y, depending on the input mask. + /// The output array contains elements of x where mask is True, and + /// elements from y elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// /// @param inMask /// @param inA @@ -168,11 +168,11 @@ namespace nc //============================================================================ // Method Description: - /// Return elements, either from x or y, depending on the input mask. - /// The output array contains elements of x where mask is True, and - /// elements from y elsewhere. + /// Return elements, either from x or y, depending on the input mask. + /// The output array contains elements of x where mask is True, and + /// elements from y elsewhere. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// /// @param inMask /// @param inA diff --git a/include/NumCpp/Functions/zeros.hpp b/include/NumCpp/Functions/zeros.hpp index 99c300103..aa95f166b 100644 --- a/include/NumCpp/Functions/zeros.hpp +++ b/include/NumCpp/Functions/zeros.hpp @@ -37,14 +37,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with zeros. + /// Return a new array of given shape and type, filled with zeros. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html /// /// @param - /// inSquareSize + /// inSquareSize /// @return - /// NdArray + /// NdArray /// template NdArray zeros(uint32 inSquareSize) @@ -56,14 +56,14 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with zeros. + /// Return a new array of given shape and type, filled with zeros. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html /// /// @param inNumRows /// @param inNumCols /// @return - /// NdArray + /// NdArray /// template NdArray zeros(uint32 inNumRows, uint32 inNumCols) @@ -75,14 +75,14 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with zeros. + /// Return a new array of given shape and type, filled with zeros. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// template NdArray zeros(const Shape& inShape) diff --git a/include/NumCpp/Functions/zeros_like.hpp b/include/NumCpp/Functions/zeros_like.hpp index 2f9830f00..444637b55 100644 --- a/include/NumCpp/Functions/zeros_like.hpp +++ b/include/NumCpp/Functions/zeros_like.hpp @@ -34,14 +34,14 @@ namespace nc { //============================================================================ // Method Description: - /// Return a new array of given shape and type, filled with zeros. + /// Return a new array of given shape and type, filled with zeros. /// - /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros_like.html + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros_like.html /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray zeros_like(const NdArray& inArray) diff --git a/include/NumCpp/ImageProcessing/Centroid.hpp b/include/NumCpp/ImageProcessing/Centroid.hpp index 09f4ca066..e7684d916 100644 --- a/include/NumCpp/ImageProcessing/Centroid.hpp +++ b/include/NumCpp/ImageProcessing/Centroid.hpp @@ -43,7 +43,7 @@ namespace nc { //================================================================================ // Class Description: - /// holds the information for a centroid + /// holds the information for a centroid template class Centroid { @@ -53,13 +53,13 @@ namespace nc public: //============================================================================= // Description: - /// defualt constructor needed by containers + /// defualt constructor needed by containers /// Centroid() = default; //============================================================================= // Description: - /// constructor + /// constructor /// /// @param inCluster /// @@ -72,10 +72,10 @@ namespace nc //============================================================================= // Description: - /// gets the centroid row + /// gets the centroid row /// /// @return - /// centroid row + /// centroid row /// double row() const noexcept { @@ -84,10 +84,10 @@ namespace nc //============================================================================= // Description: - /// gets the centroid col + /// gets the centroid col /// /// @return - /// centroid col + /// centroid col /// double col() const noexcept { @@ -96,10 +96,10 @@ namespace nc //============================================================================= // Description: - /// gets the centroid intensity + /// gets the centroid intensity /// /// @return - /// centroid intensity + /// centroid intensity /// dtype intensity() const noexcept { @@ -108,10 +108,10 @@ namespace nc //============================================================================= // Description: - /// returns the estimated eod of the centroid + /// returns the estimated eod of the centroid /// /// @return - /// star id + /// star id /// double eod() const noexcept { @@ -120,10 +120,10 @@ namespace nc //============================================================================= // Description: - /// returns the centroid as a string representation + /// returns the centroid as a string representation /// /// @return - /// std::string + /// std::string /// std::string str() const { @@ -136,7 +136,7 @@ namespace nc //============================================================================ /// Method Description: - /// prints the Centroid object to the console + /// prints the Centroid object to the console /// void print() const { @@ -145,13 +145,13 @@ namespace nc //============================================================================= // Description: - /// equality operator + /// equality operator /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// bool operator==(const Centroid& rhs) const noexcept { @@ -160,13 +160,13 @@ namespace nc //============================================================================= // Description: - /// not equality operator + /// not equality operator /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// bool operator!=(const Centroid& rhs) const noexcept { @@ -175,16 +175,16 @@ namespace nc //============================================================================= // Description: - /// less than operator for std::sort algorithm; - /// NOTE: std::sort sorts in ascending order. Since I want to sort - /// the centroids in descensing order, I am purposefully defining - /// this operator backwards! + /// less than operator for std::sort algorithm; + /// NOTE: std::sort sorts in ascending order. Since I want to sort + /// the centroids in descensing order, I am purposefully defining + /// this operator backwards! /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// bool operator<(const Centroid& rhs) const noexcept { @@ -193,12 +193,12 @@ namespace nc //============================================================================= // Description: - /// ostream operator + /// ostream operator /// /// @param inStream /// @param inCentriod /// @return - /// std::ostream + /// std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Centroid& inCentriod) { @@ -215,12 +215,12 @@ namespace nc //============================================================================= // Description: - /// center of mass algorithm; - /// WARNING: if both positive and negative values are present in the cluster, - /// it can lead to an undefined COM. + /// center of mass algorithm; + /// WARNING: if both positive and negative values are present in the cluster, + /// it can lead to an undefined COM. /// /// @param - /// inCluster + /// inCluster /// void centerOfMass(const Cluster& inCluster) { diff --git a/include/NumCpp/ImageProcessing/Cluster.hpp b/include/NumCpp/ImageProcessing/Cluster.hpp index 217cf9d4c..6ee03c578 100644 --- a/include/NumCpp/ImageProcessing/Cluster.hpp +++ b/include/NumCpp/ImageProcessing/Cluster.hpp @@ -48,7 +48,7 @@ namespace nc { //================================================================================ // Class Description: - /// Holds the information for a cluster of pixels + /// Holds the information for a cluster of pixels template class Cluster { @@ -61,16 +61,16 @@ namespace nc //============================================================================= // Description: - /// default constructor needed by containers + /// default constructor needed by containers /// Cluster() = default; //============================================================================= // Description: - /// constructor + /// constructor /// /// @param - /// inClusterId + /// inClusterId /// explicit Cluster(uint32 inClusterId) noexcept : clusterId_(inClusterId) @@ -78,13 +78,13 @@ namespace nc //============================================================================= // Description: - /// equality operator + /// equality operator /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// bool operator==(const Cluster& rhs) const noexcept { @@ -98,13 +98,13 @@ namespace nc //============================================================================= // Description: - /// not equality operator + /// not equality operator /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// bool operator!=(const Cluster& rhs) const noexcept { @@ -113,13 +113,13 @@ namespace nc //============================================================================= // Description: - /// access operator, no bounds checking + /// access operator, no bounds checking /// /// @param - /// inIndex + /// inIndex /// /// @return - /// Pixel + /// Pixel /// const Pixel& operator[](uint32 inIndex) const noexcept { @@ -128,13 +128,13 @@ namespace nc //============================================================================= // Description: - /// access method with bounds checking + /// access method with bounds checking /// /// @param - /// inIndex + /// inIndex /// /// @return - /// Pixel + /// Pixel /// const Pixel& at(uint32 inIndex) const { @@ -147,10 +147,10 @@ namespace nc //============================================================================= // Description: - /// returns in iterator to the beginning pixel of the cluster + /// returns in iterator to the beginning pixel of the cluster /// /// @return - /// const_iterator + /// const_iterator /// const_iterator begin() const noexcept { @@ -159,10 +159,10 @@ namespace nc //============================================================================= // Description: - /// returns in iterator to the 1 past the end pixel of the cluster + /// returns in iterator to the 1 past the end pixel of the cluster /// /// @return - /// const_iterator + /// const_iterator /// const_iterator end() const noexcept { @@ -171,10 +171,10 @@ namespace nc //============================================================================= // Description: - /// returns the number of pixels in the cluster + /// returns the number of pixels in the cluster /// /// @return - /// number of pixels in the cluster + /// number of pixels in the cluster /// uint32 size() const noexcept { @@ -183,10 +183,10 @@ namespace nc //============================================================================= // Description: - /// returns the minimum row number of the cluster + /// returns the minimum row number of the cluster /// /// @return - /// minimum row number of the cluster + /// minimum row number of the cluster /// uint32 clusterId() const noexcept { @@ -195,10 +195,10 @@ namespace nc //============================================================================= // Description: - /// returns the minimum row number of the cluster + /// returns the minimum row number of the cluster /// /// @return - /// minimum row number of the cluster + /// minimum row number of the cluster /// uint32 rowMin() const noexcept { @@ -207,10 +207,10 @@ namespace nc //============================================================================= // Description: - /// returns the maximum row number of the cluster + /// returns the maximum row number of the cluster /// /// @return - /// maximum row number of the cluster + /// maximum row number of the cluster /// uint32 rowMax() const noexcept { @@ -219,10 +219,10 @@ namespace nc //============================================================================= // Description: - /// returns the minimum column number of the cluster + /// returns the minimum column number of the cluster /// /// @return - /// minimum column number of the cluster + /// minimum column number of the cluster /// uint32 colMin() const noexcept { @@ -231,10 +231,10 @@ namespace nc //============================================================================= // Description: - /// returns the maximum column number of the cluster + /// returns the maximum column number of the cluster /// /// @return - /// maximum column number of the cluster + /// maximum column number of the cluster /// uint32 colMax() const noexcept { @@ -243,10 +243,10 @@ namespace nc //============================================================================= // Description: - /// returns the number of rows the cluster spans + /// returns the number of rows the cluster spans /// /// @return - /// number of rows + /// number of rows /// uint32 height() const noexcept { @@ -255,10 +255,10 @@ namespace nc //============================================================================= // Description: - /// returns the number of columns the cluster spans + /// returns the number of columns the cluster spans /// /// @return - /// number of columns + /// number of columns /// uint32 width() const noexcept { @@ -267,10 +267,10 @@ namespace nc //============================================================================= // Description: - /// returns the summed intensity of the cluster + /// returns the summed intensity of the cluster /// /// @return - /// summed cluster intensity + /// summed cluster intensity /// dtype intensity() const noexcept { @@ -279,10 +279,10 @@ namespace nc //============================================================================= // Description: - /// returns the intensity of the peak pixel in the cluster + /// returns the intensity of the peak pixel in the cluster /// /// @return - /// peak pixel intensity + /// peak pixel intensity /// dtype peakPixelIntensity() const noexcept { @@ -291,10 +291,10 @@ namespace nc //============================================================================= // Description: - /// returns the cluster estimated energy on detector (EOD) + /// returns the cluster estimated energy on detector (EOD) /// /// @return - /// eod + /// eod /// double eod() const noexcept { @@ -303,10 +303,10 @@ namespace nc //============================================================================= // Description: - /// adds a pixel to the cluster + /// adds a pixel to the cluster /// /// @param - /// inPixel + /// inPixel /// void addPixel(const Pixel& inPixel) { @@ -326,10 +326,10 @@ namespace nc //============================================================================= // Description: - /// returns a string representation of the cluster + /// returns a string representation of the cluster /// /// @return - /// string + /// string /// std::string str() const { @@ -346,7 +346,7 @@ namespace nc //============================================================================ /// Method Description: - /// prints the Cluster object to the console + /// prints the Cluster object to the console /// void print() const { @@ -355,12 +355,12 @@ namespace nc //============================================================================= // Description: - /// osstream operator + /// osstream operator /// /// @param inStream /// @param inCluster /// @return - /// std::ostream + /// std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Cluster& inCluster) { diff --git a/include/NumCpp/ImageProcessing/ClusterMaker.hpp b/include/NumCpp/ImageProcessing/ClusterMaker.hpp index 804643d13..c34869acb 100644 --- a/include/NumCpp/ImageProcessing/ClusterMaker.hpp +++ b/include/NumCpp/ImageProcessing/ClusterMaker.hpp @@ -47,7 +47,7 @@ namespace nc { //============================================================================= // Class Description: - /// Clusters exceedance data into contiguous groups + /// Clusters exceedance data into contiguous groups template class ClusterMaker { @@ -60,14 +60,14 @@ namespace nc //============================================================================= // Description: - /// constructor + /// constructor /// /// @param inXcdArrayPtr: pointer to exceedance array /// @param inIntensityArrayPtr: pointer to intensity array /// @param inBorderWidth: border to apply around exceedance pixels post clustering (default 0) /// /// @return - /// None + /// None /// ClusterMaker(const NdArray* const inXcdArrayPtr, const NdArray* const inIntensityArrayPtr, uint8 inBorderWidth = 0) : xcds_(inXcdArrayPtr), @@ -103,10 +103,10 @@ namespace nc //============================================================================= // Description: - /// returns the number of clusters in the frame + /// returns the number of clusters in the frame /// /// @return - /// number of clusters + /// number of clusters /// uint32 size() noexcept { @@ -115,13 +115,13 @@ namespace nc //============================================================================= // Description: - /// access operator, no bounds checking + /// access operator, no bounds checking /// /// @param - /// inIndex + /// inIndex /// /// @return - /// Cluster + /// Cluster /// const Cluster& operator[](uint32 inIndex) const noexcept { @@ -130,13 +130,13 @@ namespace nc //============================================================================= // Description: - /// access method with bounds checking + /// access method with bounds checking /// /// @param - /// inIndex + /// inIndex /// /// @return - /// Cluster + /// Cluster /// const Cluster& at(uint32 inIndex) const { @@ -149,10 +149,10 @@ namespace nc //============================================================================= // Description: - /// returns in iterator to the beginning cluster of the container + /// returns in iterator to the beginning cluster of the container /// /// @return - /// const_iterator + /// const_iterator /// const_iterator begin() const noexcept { @@ -161,10 +161,10 @@ namespace nc //============================================================================= // Description: - /// returns in iterator to the 1 past the end cluster of the container + /// returns in iterator to the 1 past the end cluster of the container /// /// @return - /// const_iterator + /// const_iterator /// const_iterator end() const noexcept { @@ -183,13 +183,13 @@ namespace nc //============================================================================= // Description: - /// checks that the input row and column have not fallen off of the edge + /// checks that the input row and column have not fallen off of the edge /// /// @param inRow /// @param inCol /// /// @return - /// returns a pixel object clipped to the image boundaries + /// returns a pixel object clipped to the image boundaries /// Pixel makePixel(int32 inRow, int32 inCol) noexcept { @@ -204,12 +204,12 @@ namespace nc //============================================================================= // Description: - /// finds all of the neighboring pixels to the input pixel + /// finds all of the neighboring pixels to the input pixel /// /// @param inPixel /// @param outNeighbors /// @return - /// None + /// None /// void findNeighbors(const Pixel& inPixel, std::set >& outNeighbors) { @@ -231,13 +231,13 @@ namespace nc //============================================================================= // Description: - /// finds all of the neighboring pixels to the input pixel that are NOT exceedances + /// finds all of the neighboring pixels to the input pixel that are NOT exceedances /// /// @param inPixel /// @param outNeighbors /// /// @return - /// vector of non exceedance neighboring pixels + /// vector of non exceedance neighboring pixels /// void findNeighborNotXcds(const Pixel& inPixel, std::vector >& outNeighbors) { @@ -256,13 +256,13 @@ namespace nc //============================================================================= // Description: - /// finds the pixel index of neighboring pixels + /// finds the pixel index of neighboring pixels /// /// @param inPixel /// @param outNeighbors /// /// @return - /// vector of neighboring pixel indices + /// vector of neighboring pixel indices /// void findNeighborXcds(const Pixel& inPixel, std::vector& outNeighbors) { @@ -289,7 +289,7 @@ namespace nc //============================================================================= // Description: - /// workhorse method that performs the clustering algorithm + /// workhorse method that performs the clustering algorithm /// void runClusterMaker() { @@ -349,7 +349,7 @@ namespace nc //============================================================================= // Description: - /// 3x3 dialates the clusters + /// 3x3 dialates the clusters /// void expandClusters() { diff --git a/include/NumCpp/ImageProcessing/Pixel.hpp b/include/NumCpp/ImageProcessing/Pixel.hpp index f61f72c91..9bcaf10b0 100644 --- a/include/NumCpp/ImageProcessing/Pixel.hpp +++ b/include/NumCpp/ImageProcessing/Pixel.hpp @@ -41,7 +41,7 @@ namespace nc { //================================================================================ // Class Description: - /// Holds the information for a single pixel + /// Holds the information for a single pixel template class Pixel { @@ -57,13 +57,13 @@ namespace nc //============================================================================= // Description: - /// defualt constructor needed by containers + /// defualt constructor needed by containers /// constexpr Pixel() = default; //============================================================================= // Description: - /// constructor + /// constructor /// /// @param inRow: pixel row /// @param inCol: pixel column @@ -77,13 +77,13 @@ namespace nc //============================================================================= // Description: - /// equality operator + /// equality operator /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// constexpr bool operator==(const Pixel& rhs) const noexcept { @@ -92,13 +92,13 @@ namespace nc //============================================================================= // Description: - /// not equality operator + /// not equality operator /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// constexpr bool operator!=(const Pixel& rhs) const noexcept { @@ -107,16 +107,16 @@ namespace nc //============================================================================= // Description: - /// less than operator for std::sort algorithm and std::set<>; - /// NOTE: std::sort sorts in ascending order. Since I want to sort - /// the centroids in descensing order, I am purposefully defining - /// this operator backwards! + /// less than operator for std::sort algorithm and std::set<>; + /// NOTE: std::sort sorts in ascending order. Since I want to sort + /// the centroids in descensing order, I am purposefully defining + /// this operator backwards! /// /// @param - /// rhs + /// rhs /// /// @return - /// bool + /// bool /// bool operator<(const Pixel& rhs) const noexcept { @@ -134,10 +134,10 @@ namespace nc //============================================================================= // Description: - /// returns the pixel information as a string + /// returns the pixel information as a string /// /// @return - /// std::string + /// std::string /// std::string str() const { @@ -148,7 +148,7 @@ namespace nc //============================================================================ /// Method Description: - /// prints the Pixel object to the console + /// prints the Pixel object to the console /// void print() const { @@ -157,12 +157,12 @@ namespace nc //============================================================================= // Description: - /// osstream operator + /// osstream operator /// /// @param inStream /// @param inPixel /// @return - /// std::ostream + /// std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Pixel& inPixel) { diff --git a/include/NumCpp/ImageProcessing/applyThreshold.hpp b/include/NumCpp/ImageProcessing/applyThreshold.hpp index e4faab701..8bd636a52 100644 --- a/include/NumCpp/ImageProcessing/applyThreshold.hpp +++ b/include/NumCpp/ImageProcessing/applyThreshold.hpp @@ -36,12 +36,12 @@ namespace nc { //============================================================================ // Method Description: - /// Applies a threshold to an image + /// Applies a threshold to an image /// /// @param inImageArray - /// @param inThreshold + /// @param inThreshold /// @return - /// NdArray of booleans of pixels that exceeded the threshold + /// NdArray of booleans of pixels that exceeded the threshold /// template NdArray applyThreshold(const NdArray& inImageArray, dtype inThreshold) diff --git a/include/NumCpp/ImageProcessing/centroidClusters.hpp b/include/NumCpp/ImageProcessing/centroidClusters.hpp index 3ba6768f3..7b0047284 100644 --- a/include/NumCpp/ImageProcessing/centroidClusters.hpp +++ b/include/NumCpp/ImageProcessing/centroidClusters.hpp @@ -41,11 +41,11 @@ namespace nc { //============================================================================ // Method Description: - /// Center of Mass centroids clusters + /// Center of Mass centroids clusters /// /// @param inClusters /// @return - /// std::vector + /// std::vector /// template std::vector > centroidClusters(const std::vector >& inClusters) diff --git a/include/NumCpp/ImageProcessing/clusterPixels.hpp b/include/NumCpp/ImageProcessing/clusterPixels.hpp index b532ac500..6a8360921 100644 --- a/include/NumCpp/ImageProcessing/clusterPixels.hpp +++ b/include/NumCpp/ImageProcessing/clusterPixels.hpp @@ -42,13 +42,13 @@ namespace nc { //============================================================================ // Method Description: - /// Clusters exceedance pixels from an image + /// Clusters exceedance pixels from an image /// /// @param inImageArray /// @param inExceedances /// @param inBorderWidth: border to apply around exceedance pixels post clustering (default 0) /// @return - /// std::vector + /// std::vector /// template std::vector > clusterPixels(const NdArray& inImageArray, const NdArray& inExceedances, uint8 inBorderWidth = 0) diff --git a/include/NumCpp/ImageProcessing/generateCentroids.hpp b/include/NumCpp/ImageProcessing/generateCentroids.hpp index 92229f4a9..055dbc3ff 100644 --- a/include/NumCpp/ImageProcessing/generateCentroids.hpp +++ b/include/NumCpp/ImageProcessing/generateCentroids.hpp @@ -23,7 +23,7 @@ /// DEALINGS IN THE SOFTWARE. /// /// Description -/// Generates a list of centroids givin an input exceedance rate +/// Generates a list of centroids givin an input exceedance rate /// #pragma once @@ -47,15 +47,15 @@ namespace nc { //============================================================================ // Method Description: - /// Generates a list of centroids givin an input exceedance - /// rate + /// Generates a list of centroids givin an input exceedance + /// rate /// /// @param inImageArray /// @param inRate: exceedance rate /// @param inWindowType: (string "pre", or "post" for where to apply the exceedance windowing) /// @param inBorderWidth: border to apply (default 0) /// @return - /// std::vector + /// std::vector /// template std::vector > generateCentroids(const NdArray& inImageArray, double inRate, const std::string& inWindowType, uint8 inBorderWidth = 0) diff --git a/include/NumCpp/ImageProcessing/generateThreshold.hpp b/include/NumCpp/ImageProcessing/generateThreshold.hpp index f3a9246b8..dce03daac 100644 --- a/include/NumCpp/ImageProcessing/generateThreshold.hpp +++ b/include/NumCpp/ImageProcessing/generateThreshold.hpp @@ -44,14 +44,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculates a threshold such that the input rate of pixels - /// exceeds the threshold. Really should only be used for integer - /// input array values. If using floating point data, user beware... + /// Calculates a threshold such that the input rate of pixels + /// exceeds the threshold. Really should only be used for integer + /// input array values. If using floating point data, user beware... /// /// @param inImageArray /// @param inRate /// @return - /// dtype + /// dtype /// template dtype generateThreshold(const NdArray& inImageArray, double inRate) diff --git a/include/NumCpp/ImageProcessing/windowExceedances.hpp b/include/NumCpp/ImageProcessing/windowExceedances.hpp index 06027865f..e2beec8f2 100644 --- a/include/NumCpp/ImageProcessing/windowExceedances.hpp +++ b/include/NumCpp/ImageProcessing/windowExceedances.hpp @@ -40,12 +40,12 @@ namespace nc { //============================================================================ // Method Description: - /// Window expand around exceedance pixels + /// Window expand around exceedance pixels /// /// @param inExceedances /// @param inBorderWidth /// @return - /// NdArray + /// NdArray /// inline NdArray windowExceedances(const NdArray& inExceedances, uint8 inBorderWidth) noexcept { diff --git a/include/NumCpp/Integrate/gauss_legendre.hpp b/include/NumCpp/Integrate/gauss_legendre.hpp index 75e88f6dd..a00792c24 100644 --- a/include/NumCpp/Integrate/gauss_legendre.hpp +++ b/include/NumCpp/Integrate/gauss_legendre.hpp @@ -45,14 +45,14 @@ namespace nc { //============================================================================ // Class Description: - /// Legendre Polynomial class + /// Legendre Polynomial class /// class LegendrePolynomial { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param numIterations: the number of iterations to perform /// @@ -66,7 +66,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the weights vector + /// Returns the weights vector /// /// @return weights vector /// @@ -77,7 +77,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the roots vector + /// Returns the roots vector /// /// @return roots vector /// @@ -89,7 +89,7 @@ namespace nc private: //============================================================================ // Class Description: - /// Simple class to hold the results + /// Simple class to hold the results /// struct Result { @@ -98,7 +98,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param val: the value /// @param deriv: the derivative @@ -111,7 +111,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the weights and roots vectors + /// Calculates the weights and roots vectors /// void calculateWeightAndRoot() noexcept { @@ -136,7 +136,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the weights and roots vectors + /// Calculates the weights and roots vectors /// /// @param x /// @return Result @@ -170,7 +170,7 @@ namespace nc //============================================================================ // Method Description: - /// Performs Gauss-Legendre integration of the input function + /// Performs Gauss-Legendre integration of the input function /// /// @param low: the lower bound of the integration /// @param high: the upper bound of the integration diff --git a/include/NumCpp/Integrate/romberg.hpp b/include/NumCpp/Integrate/romberg.hpp index 2dc41d7ec..2f8c04cca 100644 --- a/include/NumCpp/Integrate/romberg.hpp +++ b/include/NumCpp/Integrate/romberg.hpp @@ -44,7 +44,7 @@ namespace nc { //============================================================================ // Method Description: - /// Performs Newton-Cotes Romberg integration of the input function + /// Performs Newton-Cotes Romberg integration of the input function /// /// @param low: the lower bound of the integration /// @param high: the upper bound of the integration diff --git a/include/NumCpp/Integrate/simpson.hpp b/include/NumCpp/Integrate/simpson.hpp index 988025ce5..0948c7914 100644 --- a/include/NumCpp/Integrate/simpson.hpp +++ b/include/NumCpp/Integrate/simpson.hpp @@ -41,7 +41,7 @@ namespace nc { //============================================================================ // Method Description: - /// Performs Newton-Cotes Simpson integration of the input function + /// Performs Newton-Cotes Simpson integration of the input function /// /// @param low: the lower bound of the integration /// @param high: the upper bound of the integration diff --git a/include/NumCpp/Integrate/trapazoidal.hpp b/include/NumCpp/Integrate/trapazoidal.hpp index 4f047f423..6b76478a3 100644 --- a/include/NumCpp/Integrate/trapazoidal.hpp +++ b/include/NumCpp/Integrate/trapazoidal.hpp @@ -41,7 +41,7 @@ namespace nc { //============================================================================ // Method Description: - /// Performs Newton-Cotes trapazoidal integration of the input function + /// Performs Newton-Cotes trapazoidal integration of the input function /// /// @param low: the lower bound of the integration /// @param high: the upper bound of the integration diff --git a/include/NumCpp/Linalg/cholesky.hpp b/include/NumCpp/Linalg/cholesky.hpp index 377f54723..adb0b68ad 100644 --- a/include/NumCpp/Linalg/cholesky.hpp +++ b/include/NumCpp/Linalg/cholesky.hpp @@ -42,9 +42,9 @@ namespace nc { //============================================================================ // Method Description: - /// matrix cholesky decomposition A = L * L.transpose() + /// matrix cholesky decomposition A = L * L.transpose() /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.cholesky.html#numpy.linalg.cholesky + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.cholesky.html#numpy.linalg.cholesky /// /// @param inMatrix: NdArray to be decomposed /// diff --git a/include/NumCpp/Linalg/det.hpp b/include/NumCpp/Linalg/det.hpp index d0bba4ef5..2cba77b5c 100644 --- a/include/NumCpp/Linalg/det.hpp +++ b/include/NumCpp/Linalg/det.hpp @@ -42,15 +42,15 @@ namespace nc { //============================================================================ // Method Description: - /// matrix determinant. - /// NOTE: can get verrrrry slow for large matrices (order > 10) + /// matrix determinant. + /// NOTE: can get verrrrry slow for large matrices (order > 10) /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.det.html#scipy.linalg.det + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.det.html#scipy.linalg.det /// /// @param - /// inArray + /// inArray /// @return - /// matrix determinant + /// matrix determinant /// template dtype det(const NdArray& inArray) diff --git a/include/NumCpp/Linalg/gaussNewtonNlls.hpp b/include/NumCpp/Linalg/gaussNewtonNlls.hpp index f42b9e65c..012660792 100644 --- a/include/NumCpp/Linalg/gaussNewtonNlls.hpp +++ b/include/NumCpp/Linalg/gaussNewtonNlls.hpp @@ -55,17 +55,17 @@ namespace nc /// /// @param numIterations: the number of iterations to perform /// @param coordinates: the coordinate values. The shape needs to be [n x d], where d is - /// the number of diminsions of the fit function (f(x) is one dimensional, - /// f(x, y) is two dimensions, etc), and n is the number of observations - /// that are being fit to. + /// the number of diminsions of the fit function (f(x) is one dimensional, + /// f(x, y) is two dimensions, etc), and n is the number of observations + /// that are being fit to. /// @param measurements: the measured values that are being fit /// @param function: a std::function of the function that is being fit. The function takes as - /// inputs an NdArray of a single set of the coordinate values, and an NdArray - /// of the current values of the fit parameters + /// inputs an NdArray of a single set of the coordinate values, and an NdArray + /// of the current values of the fit parameters /// @param derivatives: array of std::functions to calculate the function - /// derivatives. The function that is being fit. The function takes as - /// inputs an NdArray of a single set of the coordinate values, and an NdArray - /// of the current values of the fit parameters + /// derivatives. The function that is being fit. The function takes as + /// inputs an NdArray of a single set of the coordinate values, and an NdArray + /// of the current values of the fit parameters /// @param initialGuess: the initial guess of the parameters to be solved for /// /// @return std::pair of NdArray of solved parameter values, and rms of the residuals value diff --git a/include/NumCpp/Linalg/hat.hpp b/include/NumCpp/Linalg/hat.hpp index a9d4a711d..5748ae032 100644 --- a/include/NumCpp/Linalg/hat.hpp +++ b/include/NumCpp/Linalg/hat.hpp @@ -40,13 +40,13 @@ namespace nc { //============================================================================ // Method Description: - /// vector hat operator + /// vector hat operator /// /// @param inX /// @param inY /// @param inZ /// @return - /// 3x3 NdArray + /// 3x3 NdArray /// template NdArray hat(dtype inX, dtype inY, dtype inZ) @@ -69,12 +69,12 @@ namespace nc //============================================================================ // Method Description: - /// vector hat operator + /// vector hat operator /// /// @param - /// inVec (3x1, or 1x3 cartesian vector) + /// inVec (3x1, or 1x3 cartesian vector) /// @return - /// 3x3 NdArray + /// 3x3 NdArray /// template NdArray hat(const NdArray& inVec) @@ -91,12 +91,12 @@ namespace nc //============================================================================ // Method Description: - /// vector hat operator + /// vector hat operator /// /// @param - /// inVec + /// inVec /// @return - /// 3x3 NdArray + /// 3x3 NdArray /// inline NdArray hat(const Vec3& inVec) { diff --git a/include/NumCpp/Linalg/inv.hpp b/include/NumCpp/Linalg/inv.hpp index 2a1e124de..cd404db89 100644 --- a/include/NumCpp/Linalg/inv.hpp +++ b/include/NumCpp/Linalg/inv.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// matrix inverse + /// matrix inverse /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.inv.html#scipy.linalg.inv + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.inv.html#scipy.linalg.inv /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray inv(const NdArray& inArray) diff --git a/include/NumCpp/Linalg/lstsq.hpp b/include/NumCpp/Linalg/lstsq.hpp index c9ad74a7f..2d0b9e690 100644 --- a/include/NumCpp/Linalg/lstsq.hpp +++ b/include/NumCpp/Linalg/lstsq.hpp @@ -37,23 +37,23 @@ namespace nc { //============================================================================ // Method Description: - /// Solves the equation a x = b by computing a vector x - /// that minimizes the Euclidean 2-norm || b - a x ||^2. - /// The equation may be under-, well-, or over- determined - /// (i.e., the number of linearly independent rows of a can - /// be less than, equal to, or greater than its number of - /// linearly independent columns). If a is square and of - /// full rank, then x (but for round-off error) is the - /// "exact" solution of the equation. + /// Solves the equation a x = b by computing a vector x + /// that minimizes the Euclidean 2-norm || b - a x ||^2. + /// The equation may be under-, well-, or over- determined + /// (i.e., the number of linearly independent rows of a can + /// be less than, equal to, or greater than its number of + /// linearly independent columns). If a is square and of + /// full rank, then x (but for round-off error) is the + /// "exact" solution of the equation. /// - /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.lstsq.html#scipy.linalg.lstsq + /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.lstsq.html#scipy.linalg.lstsq /// /// @param inA: coefficient matrix /// @param inB: Ordinate or "dependent variable" values /// @param inTolerance (default 1e-12) /// /// @return - /// NdArray + /// NdArray /// template NdArray lstsq(const NdArray& inA, const NdArray& inB, double inTolerance = 1e-12) diff --git a/include/NumCpp/Linalg/lu_decomposition.hpp b/include/NumCpp/Linalg/lu_decomposition.hpp index f9413ec6a..192423af5 100644 --- a/include/NumCpp/Linalg/lu_decomposition.hpp +++ b/include/NumCpp/Linalg/lu_decomposition.hpp @@ -47,7 +47,7 @@ namespace nc { //============================================================================ // Method Description: - /// matrix LU decomposition A = LU + /// matrix LU decomposition A = LU /// /// @param inMatrix: NdArray to be decomposed /// diff --git a/include/NumCpp/Linalg/matrix_power.hpp b/include/NumCpp/Linalg/matrix_power.hpp index 345f81fd3..69bbb397e 100644 --- a/include/NumCpp/Linalg/matrix_power.hpp +++ b/include/NumCpp/Linalg/matrix_power.hpp @@ -43,20 +43,20 @@ namespace nc { //============================================================================ // Method Description: - /// Raise a square matrix to the (integer) power n. + /// Raise a square matrix to the (integer) power n. /// - /// For positive integers n, the power is computed by repeated - /// matrix squarings and matrix multiplications. If n == 0, - /// the identity matrix of the same shape as M is returned. - /// If n < 0, the inverse is computed and then raised to the abs(n). + /// For positive integers n, the power is computed by repeated + /// matrix squarings and matrix multiplications. If n == 0, + /// the identity matrix of the same shape as M is returned. + /// If n < 0, the inverse is computed and then raised to the abs(n). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.matrix_power.html#numpy.linalg.matrix_power + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.matrix_power.html#numpy.linalg.matrix_power /// /// @param inArray /// @param inPower /// /// @return - /// NdArray + /// NdArray /// template NdArray matrix_power(const NdArray& inArray, int16 inPower) diff --git a/include/NumCpp/Linalg/multi_dot.hpp b/include/NumCpp/Linalg/multi_dot.hpp index 8b45c3543..a3921c665 100644 --- a/include/NumCpp/Linalg/multi_dot.hpp +++ b/include/NumCpp/Linalg/multi_dot.hpp @@ -41,16 +41,16 @@ namespace nc { //============================================================================ // Method Description: - /// Compute the dot product of two or more arrays in a single - /// function call. + /// Compute the dot product of two or more arrays in a single + /// function call. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.multi_dot.html#numpy.linalg.multi_dot + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.multi_dot.html#numpy.linalg.multi_dot /// /// @param - /// inList: list of arrays + /// inList: list of arrays /// /// @return - /// NdArray + /// NdArray /// template NdArray multi_dot(const std::initializer_list >& inList) diff --git a/include/NumCpp/Linalg/pivotLU_decomposition.hpp b/include/NumCpp/Linalg/pivotLU_decomposition.hpp index 2b58d9c47..42fbce0fd 100644 --- a/include/NumCpp/Linalg/pivotLU_decomposition.hpp +++ b/include/NumCpp/Linalg/pivotLU_decomposition.hpp @@ -48,7 +48,7 @@ namespace nc { //============================================================================ // Method Description: - /// matrix pivot LU decomposition PA = LU + /// matrix pivot LU decomposition PA = LU /// /// @param inMatrix: NdArray to be decomposed /// diff --git a/include/NumCpp/Linalg/solve.hpp b/include/NumCpp/Linalg/solve.hpp index ee2a2077e..678626b0f 100644 --- a/include/NumCpp/Linalg/solve.hpp +++ b/include/NumCpp/Linalg/solve.hpp @@ -39,7 +39,7 @@ namespace nc { //============================================================================ // Method Description: - /// Solve a linear matrix equation, or system of linear scalar equations. + /// Solve a linear matrix equation, or system of linear scalar equations. /// Computes the “exact” solution, x, of the well-determined, i.e., full rank, /// linear matrix equation ax = b. /// diff --git a/include/NumCpp/Linalg/svd.hpp b/include/NumCpp/Linalg/svd.hpp index 1c5835f10..b0dbf0f09 100644 --- a/include/NumCpp/Linalg/svd.hpp +++ b/include/NumCpp/Linalg/svd.hpp @@ -40,9 +40,9 @@ namespace nc { //============================================================================ // Method Description: - /// matrix svd + /// matrix svd /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.svd.html#numpy.linalg.svd + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.svd.html#numpy.linalg.svd /// /// @param inArray: NdArray to be SVDed /// @param outU: NdArray output U diff --git a/include/NumCpp/Linalg/svd/SVDClass.hpp b/include/NumCpp/Linalg/svd/SVDClass.hpp index cdb84e49f..52a16ed23 100644 --- a/include/NumCpp/Linalg/svd/SVDClass.hpp +++ b/include/NumCpp/Linalg/svd/SVDClass.hpp @@ -42,17 +42,17 @@ namespace nc { // ============================================================================= // Class Description: - /// performs the singular value decomposition of a general matrix, - /// taken and adapted from Numerical Recipes Third Edition svd.h + /// performs the singular value decomposition of a general matrix, + /// taken and adapted from Numerical Recipes Third Edition svd.h class SVD { public: // ============================================================================= // Description: - /// Constructor + /// Constructor /// /// @param - /// inMatrix: matrix to perform SVD on + /// inMatrix: matrix to perform SVD on /// explicit SVD(const NdArray& inMatrix) : m_(inMatrix.shape().rows), @@ -69,10 +69,10 @@ namespace nc // ============================================================================= // Description: - /// the resultant u matrix + /// the resultant u matrix /// /// @return - /// u matrix + /// u matrix /// const NdArray& u() noexcept { @@ -81,10 +81,10 @@ namespace nc // ============================================================================= // Description: - /// the resultant v matrix + /// the resultant v matrix /// /// @return - /// v matrix + /// v matrix /// const NdArray& v() noexcept { @@ -93,10 +93,10 @@ namespace nc // ============================================================================= // Description: - /// the resultant w matrix + /// the resultant w matrix /// /// @return - /// s matrix + /// s matrix /// const NdArray& s() noexcept { @@ -105,13 +105,13 @@ namespace nc // ============================================================================= // Description: - /// solves the linear least squares problem + /// solves the linear least squares problem /// /// @param inInput /// @param inThresh (default -1.0) /// /// @return - /// NdArray + /// NdArray /// NdArray solve(const NdArray& inInput, double inThresh = -1.0) { @@ -159,13 +159,13 @@ namespace nc private: // ============================================================================= // Description: - /// returns the SIGN of two values + /// returns the SIGN of two values /// /// @param inA /// @param inB /// /// @return - /// value + /// value /// static double SIGN(double inA, double inB) noexcept { @@ -174,7 +174,7 @@ namespace nc // ============================================================================= // Description: - /// decomposes the input matrix + /// decomposes the input matrix /// void decompose() { @@ -515,7 +515,7 @@ namespace nc // ============================================================================= // Description: - /// reorders the input matrix + /// reorders the input matrix /// void reorder() { @@ -626,13 +626,13 @@ namespace nc // ============================================================================= // Description: - /// performs pythag of input values + /// performs pythag of input values /// /// @param inA /// @param inB /// /// @return - /// resultant value + /// resultant value /// static double pythag(double inA, double inB) noexcept { diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index 6d9a16466..7d6c9e63d 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -66,7 +66,7 @@ namespace nc { //================================================================================ // Class Description: - /// Holds 1D and 2D arrays, the main work horse of the NumCpp library + /// Holds 1D and 2D arrays, the main work horse of the NumCpp library template> class NdArray { @@ -99,16 +99,16 @@ namespace nc //============================================================================ // Method Description: - /// Defualt Constructor, not very usefull... + /// Defualt Constructor, not very usefull... /// NdArray() = default; //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param - /// inSquareSize: square number of rows and columns + /// inSquareSize: square number of rows and columns /// explicit NdArray(size_type inSquareSize) : shape_(inSquareSize, inSquareSize), @@ -119,7 +119,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inNumRows /// @param inNumCols @@ -133,10 +133,10 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param - /// inShape + /// inShape /// explicit NdArray(const Shape& inShape) : shape_(inShape), @@ -147,10 +147,10 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param - /// inList + /// inList /// NdArray(std::initializer_list inList) : shape_(1, static_cast(inList.size())), @@ -165,10 +165,10 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param - /// inList: 2D initializer list + /// inList: 2D initializer list /// NdArray(const std::initializer_list >& inList) : shape_(static_cast(inList.size()), 0) @@ -198,11 +198,11 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// template, int> = 0> @@ -227,11 +227,11 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param in2dArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// template NdArray(std::array, Dim0Size>& in2dArray, bool copy = true) : @@ -256,11 +256,11 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inVector - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// template, int> = 0> NdArray(std::vector& inVector, bool copy = true) : @@ -284,7 +284,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param in2dVector /// @@ -316,11 +316,11 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param in2dArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or - /// act as a non-owning shell. Default true. + /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// act as a non-owning shell. Default true. /// template NdArray(std::vector>& in2dArray, bool copy = true) : @@ -345,7 +345,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inDeque /// @@ -363,7 +363,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param in2dDeque /// @@ -395,10 +395,10 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param - /// inList + /// inList /// explicit NdArray(const std::list& inList) : shape_(1, static_cast(inList.size())), @@ -413,7 +413,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inFirst /// @param inLast @@ -433,8 +433,8 @@ namespace nc //============================================================================ // Method Description: - /// Constructor. Copies the contents of the buffer into - /// the array. + /// Constructor. Copies the contents of the buffer into + /// the array. /// /// @param inPtr: const_pointer to beginning of buffer /// @param size: number of elements in buffer @@ -452,8 +452,8 @@ namespace nc //============================================================================ // Method Description: - /// Constructor. Copies the contents of the buffer into - /// the array. + /// Constructor. Copies the contents of the buffer into + /// the array. /// /// @param inPtr: const_pointer to beginning of buffer /// @param numRows: number of rows of the buffer @@ -475,13 +475,13 @@ namespace nc //============================================================================ // Method Description: - /// Constructor. Operates as a shell around an already existing - /// array of data. + /// Constructor. Operates as a shell around an already existing + /// array of data. /// /// @param inPtr: pointer to beginning of the array /// @param size: the number of elements in the array /// @param takeOwnership: whether or not to take ownership of the data - /// and call delete[] in the destructor. + /// and call delete[] in the destructor. /// template, int> = 0> @@ -494,14 +494,14 @@ namespace nc //============================================================================ // Method Description: - /// Constructor. Operates as a shell around an already existing - /// array of data. + /// Constructor. Operates as a shell around an already existing + /// array of data. /// /// @param inPtr: pointer to beginning of the array /// @param numRows: the number of rows in the array /// @param numCols: the nubmer of column in the array /// @param takeOwnership: whether or not to take ownership of the data - /// and call delete[] in the destructor. + /// and call delete[] in the destructor. /// template, int> = 0> @@ -514,10 +514,10 @@ namespace nc //============================================================================ // Method Description: - /// Copy Constructor + /// Copy Constructor /// /// @param - /// inOtherArray + /// inOtherArray /// NdArray(const NdArray& inOtherArray) : shape_(inOtherArray.shape_), @@ -533,10 +533,10 @@ namespace nc //============================================================================ // Method Description: - /// Move Constructor + /// Move Constructor /// /// @param - /// inOtherArray + /// inOtherArray /// NdArray(NdArray&& inOtherArray) noexcept : shape_(inOtherArray.shape_), @@ -553,7 +553,7 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// ~NdArray() noexcept { @@ -562,12 +562,12 @@ namespace nc //============================================================================ // Method Description: - /// Assignment operator, performs a deep copy + /// Assignment operator, performs a deep copy /// /// @param - /// rhs + /// rhs /// @return - /// NdArray + /// NdArray /// NdArray& operator=(const NdArray& rhs) { @@ -587,13 +587,13 @@ namespace nc //============================================================================ // Method Description: - /// Assignment operator, sets the entire array to a single - /// scaler value. + /// Assignment operator, sets the entire array to a single + /// scaler value. /// /// @param - /// inValue + /// inValue /// @return - /// NdArray + /// NdArray /// NdArray& operator=(value_type inValue) noexcept { @@ -607,12 +607,12 @@ namespace nc //============================================================================ // Method Description: - /// Move operator, performs a deep move + /// Move operator, performs a deep move /// /// @param - /// rhs + /// rhs /// @return - /// NdArray + /// NdArray /// NdArray& operator=(NdArray&& rhs) noexcept { @@ -635,12 +635,12 @@ namespace nc //============================================================================ // Method Description: - /// 1D access operator with no bounds checking + /// 1D access operator with no bounds checking /// /// @param - /// inIndex + /// inIndex /// @return - /// value + /// value /// reference operator[](int32 inIndex) noexcept { @@ -654,12 +654,12 @@ namespace nc //============================================================================ // Method Description: - /// const 1D access operator with no bounds checking + /// const 1D access operator with no bounds checking /// /// @param - /// inIndex + /// inIndex /// @return - /// value + /// value /// const_reference operator[](int32 inIndex) const noexcept { @@ -673,12 +673,12 @@ namespace nc //============================================================================ // Method Description: - /// 2D access operator with no bounds checking + /// 2D access operator with no bounds checking /// /// @param inRowIndex /// @param inColIndex /// @return - /// value + /// value /// reference operator()(int32 inRowIndex, int32 inColIndex) noexcept { @@ -697,12 +697,12 @@ namespace nc //============================================================================ // Method Description: - /// const 2D access operator with no bounds checking + /// const 2D access operator with no bounds checking /// /// @param inRowIndex /// @param inColIndex /// @return - /// value + /// value /// const_reference operator()(int32 inRowIndex, int32 inColIndex) const noexcept { @@ -721,13 +721,13 @@ namespace nc //============================================================================ // Method Description: - /// 1D Slicing access operator with bounds checking. - /// returned array is of the range [start, stop). + /// 1D Slicing access operator with bounds checking. + /// returned array is of the range [start, stop). /// /// @param - /// inSlice + /// inSlice /// @return - /// NdArray + /// NdArray /// NdArray operator[](const Slice& inSlice) const { @@ -745,12 +745,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns the values from the input mask + /// Returns the values from the input mask /// /// @param - /// inMask + /// inMask /// @return - /// NdArray + /// NdArray /// NdArray operator[](const NdArray& inMask) const { @@ -771,12 +771,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns the values from the input indices + /// Returns the values from the input indices /// /// @param - /// inIndices + /// inIndices /// @return - /// NdArray + /// NdArray /// /// template operator()(Slice inRowSlice, Slice inColSlice) const { @@ -829,13 +829,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D Slicing access operator with bounds checking. - /// returned array is of the range [start, stop). + /// 2D Slicing access operator with bounds checking. + /// returned array is of the range [start, stop). /// /// @param inRowSlice /// @param inColIndex /// @return - /// NdArray + /// NdArray /// NdArray operator()(Slice inRowSlice, int32 inColIndex) const { @@ -852,13 +852,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D Slicing access operator with bounds checking. - /// returned array is of the range [start, stop). + /// 2D Slicing access operator with bounds checking. + /// returned array is of the range [start, stop). /// /// @param inRowIndex /// @param inColSlice /// @return - /// NdArray + /// NdArray /// NdArray operator()(int32 inRowIndex, Slice inColSlice) const { @@ -875,13 +875,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D index access operator with bounds checking. - /// returned array is of the range. + /// 2D index access operator with bounds checking. + /// returned array is of the range. /// /// @param rowIndices /// @param colIndex /// @return - /// NdArray + /// NdArray /// template> || is_same_v>, int> = 0> @@ -893,13 +893,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D index access operator with bounds checking. - /// returned array is of the range. + /// 2D index access operator with bounds checking. + /// returned array is of the range. /// /// @param rowIndices /// @param colSlice /// @return - /// NdArray + /// NdArray /// template> || is_same_v>, int> = 0> @@ -910,13 +910,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D index access operator with bounds checking. - /// returned array is of the range. + /// 2D index access operator with bounds checking. + /// returned array is of the range. /// /// @param rowIndex /// @param colIndices /// @return - /// NdArray + /// NdArray /// template> || is_same_v>, int> = 0> @@ -928,13 +928,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D index access operator with bounds checking. - /// returned array is of the range. + /// 2D index access operator with bounds checking. + /// returned array is of the range. /// /// @param rowSlice /// @param colIndices /// @return - /// NdArray + /// NdArray /// template> || is_same_v>, int> = 0> @@ -945,13 +945,13 @@ namespace nc //============================================================================ // Method Description: - /// 2D index access operator with bounds checking. - /// returned array is of the range. + /// 2D index access operator with bounds checking. + /// returned array is of the range. /// /// @param rowIndices /// @param colIndices /// @return - /// NdArray + /// NdArray /// template> || is_same_v>, int> = 0, @@ -987,13 +987,13 @@ namespace nc //============================================================================ // Method Description: - /// Returns a Slice object for slicing a row to the end of - /// array. + /// Returns a Slice object for slicing a row to the end of + /// array. /// /// @param inStartIdx (default 0) /// @param inStepSize (default 1) /// @return - /// Slice + /// Slice /// Slice cSlice(int32 inStartIdx = 0, uint32 inStepSize = 1) const noexcept { @@ -1002,13 +1002,13 @@ namespace nc //============================================================================ // Method Description: - /// Returns a Slice object for slicing a column to the end - /// of the array. + /// Returns a Slice object for slicing a column to the end + /// of the array. /// /// @param inStartIdx (default 0) /// @param inStepSize (default 1) /// @return - /// Slice + /// Slice /// Slice rSlice(int32 inStartIdx = 0, uint32 inStepSize = 1) const noexcept { @@ -1017,12 +1017,12 @@ namespace nc //============================================================================ // Method Description: - /// 1D access method with bounds checking + /// 1D access method with bounds checking /// /// @param - /// inIndex + /// inIndex /// @return - /// value + /// value /// reference at(int32 inIndex) { @@ -1040,12 +1040,12 @@ namespace nc //============================================================================ // Method Description: - /// const 1D access method with bounds checking + /// const 1D access method with bounds checking /// /// @param - /// inIndex + /// inIndex /// @return - /// value + /// value /// const_reference at(int32 inIndex) const { @@ -1063,12 +1063,12 @@ namespace nc //============================================================================ // Method Description: - /// 2D access method with bounds checking + /// 2D access method with bounds checking /// /// @param inRowIndex /// @param inColIndex /// @return - /// value + /// value /// reference at(int32 inRowIndex, int32 inColIndex) { @@ -1095,12 +1095,12 @@ namespace nc //============================================================================ // Method Description: - /// const 2D access method with bounds checking + /// const 2D access method with bounds checking /// /// @param inRowIndex /// @param inColIndex /// @return - /// value + /// value /// const_reference at(int32 inRowIndex, int32 inColIndex) const { @@ -1127,12 +1127,12 @@ namespace nc //============================================================================ // Method Description: - /// const 1D access method with bounds checking + /// const 1D access method with bounds checking /// /// @param - /// inSlice + /// inSlice /// @return - /// Ndarray + /// Ndarray /// NdArray at(const Slice& inSlice) const { @@ -1143,12 +1143,12 @@ namespace nc //============================================================================ // Method Description: - /// const 2D access method with bounds checking + /// const 2D access method with bounds checking /// /// @param inRowSlice /// @param inColSlice /// @return - /// Ndarray + /// Ndarray /// NdArray at(const Slice& inRowSlice, const Slice& inColSlice) const { @@ -1159,12 +1159,12 @@ namespace nc //============================================================================ // Method Description: - /// const 2D access method with bounds checking + /// const 2D access method with bounds checking /// /// @param inRowSlice /// @param inColIndex /// @return - /// Ndarray + /// Ndarray /// NdArray at(const Slice& inRowSlice, int32 inColIndex) const { @@ -1175,12 +1175,12 @@ namespace nc //============================================================================ // Method Description: - /// const 2D access method with bounds checking + /// const 2D access method with bounds checking /// /// @param inRowIndex /// @param inColSlice /// @return - /// Ndarray + /// Ndarray /// NdArray at(int32 inRowIndex, const Slice& inColSlice) const { @@ -1191,12 +1191,12 @@ namespace nc //============================================================================ // Method Description: - /// const 2D access method with bounds checking + /// const 2D access method with bounds checking /// /// @param rowIndices /// @param colIndices /// @return - /// Ndarray + /// Ndarray /// NdArray at(const NdArray& rowIndices, const NdArray& colIndices) const { @@ -1207,9 +1207,9 @@ namespace nc //============================================================================ // Method Description: - /// iterator to the beginning of the flattened array + /// iterator to the beginning of the flattened array /// @return - /// iterator + /// iterator /// iterator begin() noexcept { @@ -1218,12 +1218,12 @@ namespace nc //============================================================================ // Method Description: - /// iterator to the beginning of the input row + /// iterator to the beginning of the input row /// /// @param - /// inRow + /// inRow /// @return - /// iterator + /// iterator /// iterator begin(size_type inRow) { @@ -1237,9 +1237,9 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the flattened array + /// const iterator to the beginning of the flattened array /// @return - /// const_iterator + /// const_iterator /// const_iterator begin() const noexcept { @@ -1248,12 +1248,12 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the input row + /// const iterator to the beginning of the input row /// /// @param - /// inRow + /// inRow /// @return - /// const_iterator + /// const_iterator /// const_iterator begin(size_type inRow) const { @@ -1262,10 +1262,10 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the flattened array + /// const iterator to the beginning of the flattened array /// /// @return - /// const_iterator + /// const_iterator /// const_iterator cbegin() const noexcept { @@ -1274,12 +1274,12 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the input row + /// const iterator to the beginning of the input row /// /// @param - /// inRow + /// inRow /// @return - /// const_iterator + /// const_iterator /// const_iterator cbegin(size_type inRow) const { @@ -1293,9 +1293,9 @@ namespace nc //============================================================================ // Method Description: - /// column_iterator to the beginning of the flattened array + /// column_iterator to the beginning of the flattened array /// @return - /// column_iterator + /// column_iterator /// column_iterator colbegin() noexcept { @@ -1304,12 +1304,12 @@ namespace nc //============================================================================ // Method Description: - /// column_iterator to the beginning of the input column + /// column_iterator to the beginning of the input column /// /// @param - /// inCol + /// inCol /// @return - /// column_iterator + /// column_iterator /// column_iterator colbegin(size_type inCol) { @@ -1323,9 +1323,9 @@ namespace nc //============================================================================ // Method Description: - /// const column_iterator to the beginning of the flattened array + /// const column_iterator to the beginning of the flattened array /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator colbegin() const noexcept { @@ -1334,12 +1334,12 @@ namespace nc //============================================================================ // Method Description: - /// const column_iterator to the beginning of the input column + /// const column_iterator to the beginning of the input column /// /// @param - /// inCol + /// inCol /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator colbegin(size_type inCol) const { @@ -1348,10 +1348,10 @@ namespace nc //============================================================================ // Method Description: - /// const_column_iterator to the beginning of the flattened array + /// const_column_iterator to the beginning of the flattened array /// /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator ccolbegin() const noexcept { @@ -1360,12 +1360,12 @@ namespace nc //============================================================================ // Method Description: - /// const_column_iterator to the beginning of the input column + /// const_column_iterator to the beginning of the input column /// /// @param - /// inCol + /// inCol /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator ccolbegin(size_type inCol) const { @@ -1379,9 +1379,9 @@ namespace nc //============================================================================ // Method Description: - /// reverse_iterator to the beginning of the flattened array + /// reverse_iterator to the beginning of the flattened array /// @return - /// reverse_iterator + /// reverse_iterator /// reverse_iterator rbegin() noexcept { @@ -1390,12 +1390,12 @@ namespace nc //============================================================================ // Method Description: - /// reverse_iterator to the beginning of the input row + /// reverse_iterator to the beginning of the input row /// /// @param - /// inRow + /// inRow /// @return - /// reverse_iterator + /// reverse_iterator /// reverse_iterator rbegin(size_type inRow) { @@ -1409,9 +1409,9 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the flattened array + /// const iterator to the beginning of the flattened array /// @return - /// const_iterator + /// const_iterator /// const_reverse_iterator rbegin() const noexcept { @@ -1420,12 +1420,12 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the input row + /// const iterator to the beginning of the input row /// /// @param - /// inRow + /// inRow /// @return - /// const_iterator + /// const_iterator /// const_reverse_iterator rbegin(size_type inRow) const { @@ -1434,10 +1434,10 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_iterator to the beginning of the flattened array + /// const_reverse_iterator to the beginning of the flattened array /// /// @return - /// const_reverse_iterator + /// const_reverse_iterator /// const_reverse_iterator crbegin() const noexcept { @@ -1446,12 +1446,12 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_iterator to the beginning of the input row + /// const_reverse_iterator to the beginning of the input row /// /// @param - /// inRow + /// inRow /// @return - /// const_reverse_iterator + /// const_reverse_iterator /// const_reverse_iterator crbegin(size_type inRow) const { @@ -1465,9 +1465,9 @@ namespace nc //============================================================================ // Method Description: - /// reverse_column_iterator to the beginning of the flattened array + /// reverse_column_iterator to the beginning of the flattened array /// @return - /// reverse_column_iterator + /// reverse_column_iterator /// reverse_column_iterator rcolbegin() noexcept { @@ -1476,12 +1476,12 @@ namespace nc //============================================================================ // Method Description: - /// reverse_column_iterator to the beginning of the input column + /// reverse_column_iterator to the beginning of the input column /// /// @param - /// inCol + /// inCol /// @return - /// reverse_column_iterator + /// reverse_column_iterator /// reverse_column_iterator rcolbegin(size_type inCol) { @@ -1495,9 +1495,9 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the flattened array + /// const iterator to the beginning of the flattened array /// @return - /// const_iterator + /// const_iterator /// const_reverse_column_iterator rcolbegin() const noexcept { @@ -1506,12 +1506,12 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the beginning of the input column + /// const iterator to the beginning of the input column /// /// @param - /// inCol + /// inCol /// @return - /// const_iterator + /// const_iterator /// const_reverse_column_iterator rcolbegin(size_type inCol) const { @@ -1520,10 +1520,10 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_column_iterator to the beginning of the flattened array + /// const_reverse_column_iterator to the beginning of the flattened array /// /// @return - /// const_reverse_column_iterator + /// const_reverse_column_iterator /// const_reverse_column_iterator crcolbegin() const noexcept { @@ -1532,12 +1532,12 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_column_iterator to the beginning of the input column + /// const_reverse_column_iterator to the beginning of the input column /// /// @param - /// inCol + /// inCol /// @return - /// const_reverse_column_iterator + /// const_reverse_column_iterator /// const_reverse_column_iterator crcolbegin(size_type inCol) const { @@ -1551,9 +1551,9 @@ namespace nc //============================================================================ // Method Description: - /// iterator to 1 past the end of the flattened array + /// iterator to 1 past the end of the flattened array /// @return - /// iterator + /// iterator /// iterator end() noexcept { @@ -1562,12 +1562,12 @@ namespace nc //============================================================================ // Method Description: - /// iterator to the 1 past end of the row + /// iterator to the 1 past end of the row /// /// @param - /// inRow + /// inRow /// @return - /// iterator + /// iterator /// iterator end(size_type inRow) { @@ -1581,9 +1581,9 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to 1 past the end of the flattened array + /// const iterator to 1 past the end of the flattened array /// @return - /// const_iterator + /// const_iterator /// const_iterator end() const noexcept { @@ -1592,12 +1592,12 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to the 1 past end of the row + /// const iterator to the 1 past end of the row /// /// @param - /// inRow + /// inRow /// @return - /// const_iterator + /// const_iterator /// const_iterator end(size_type inRow) const { @@ -1606,10 +1606,10 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to 1 past the end of the flattened array + /// const iterator to 1 past the end of the flattened array /// /// @return - /// const_iterator + /// const_iterator /// const_iterator cend() const noexcept { @@ -1618,12 +1618,12 @@ namespace nc //============================================================================ // Method Description: - /// const iterator to 1 past the end of the input row + /// const iterator to 1 past the end of the input row /// /// @param - /// inRow + /// inRow /// @return - /// const_iterator + /// const_iterator /// const_iterator cend(size_type inRow) const { @@ -1637,9 +1637,9 @@ namespace nc //============================================================================ // Method Description: - /// reverse_iterator to 1 past the end of the flattened array + /// reverse_iterator to 1 past the end of the flattened array /// @return - /// reverse_iterator + /// reverse_iterator /// reverse_iterator rend() noexcept { @@ -1648,12 +1648,12 @@ namespace nc //============================================================================ // Method Description: - /// reverse_iterator to the 1 past end of the row + /// reverse_iterator to the 1 past end of the row /// /// @param - /// inRow + /// inRow /// @return - /// reverse_iterator + /// reverse_iterator /// reverse_iterator rend(size_type inRow) { @@ -1667,9 +1667,9 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_iterator to 1 past the end of the flattened array + /// const_reverse_iterator to 1 past the end of the flattened array /// @return - /// const_reverse_iterator + /// const_reverse_iterator /// const_reverse_iterator rend() const noexcept { @@ -1678,12 +1678,12 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_iterator to the 1 past end of the row + /// const_reverse_iterator to the 1 past end of the row /// /// @param - /// inRow + /// inRow /// @return - /// const_reverse_iterator + /// const_reverse_iterator /// const_reverse_iterator rend(size_type inRow) const { @@ -1692,10 +1692,10 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_iterator to 1 past the end of the flattened array + /// const_reverse_iterator to 1 past the end of the flattened array /// /// @return - /// const_reverse_iterator + /// const_reverse_iterator /// const_reverse_iterator crend() const noexcept { @@ -1704,12 +1704,12 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_iterator to 1 past the end of the input row + /// const_reverse_iterator to 1 past the end of the input row /// /// @param - /// inRow + /// inRow /// @return - /// const_reverse_iterator + /// const_reverse_iterator /// const_reverse_iterator crend(size_type inRow) const { @@ -1723,9 +1723,9 @@ namespace nc //============================================================================ // Method Description: - /// column_iterator to 1 past the end of the flattened array + /// column_iterator to 1 past the end of the flattened array /// @return - /// column_iterator + /// column_iterator /// column_iterator colend() noexcept { @@ -1734,12 +1734,12 @@ namespace nc //============================================================================ // Method Description: - /// column_iterator to the 1 past end of the column + /// column_iterator to the 1 past end of the column /// /// @param - /// inCol + /// inCol /// @return - /// column_iterator + /// column_iterator /// column_iterator colend(size_type inCol) { @@ -1753,9 +1753,9 @@ namespace nc //============================================================================ // Method Description: - /// const column_iterator to 1 past the end of the flattened array + /// const column_iterator to 1 past the end of the flattened array /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator colend() const noexcept { @@ -1764,12 +1764,12 @@ namespace nc //============================================================================ // Method Description: - /// const column_iterator to the 1 past end of the column + /// const column_iterator to the 1 past end of the column /// /// @param - /// inCol + /// inCol /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator colend(size_type inCol) const { @@ -1778,10 +1778,10 @@ namespace nc //============================================================================ // Method Description: - /// const_column_iterator to 1 past the end of the flattened array + /// const_column_iterator to 1 past the end of the flattened array /// /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator ccolend() const noexcept { @@ -1790,12 +1790,12 @@ namespace nc //============================================================================ // Method Description: - /// const_column_iterator to 1 past the end of the input col + /// const_column_iterator to 1 past the end of the input col /// /// @param - /// inCol + /// inCol /// @return - /// const_column_iterator + /// const_column_iterator /// const_column_iterator ccolend(size_type inCol) const { @@ -1809,9 +1809,9 @@ namespace nc //============================================================================ // Method Description: - /// reverse_column_iterator to 1 past the end of the flattened array + /// reverse_column_iterator to 1 past the end of the flattened array /// @return - /// reverse_column_iterator + /// reverse_column_iterator /// reverse_column_iterator rcolend() noexcept { @@ -1820,12 +1820,12 @@ namespace nc //============================================================================ // Method Description: - /// reverse_column_iterator to the 1 past end of the column + /// reverse_column_iterator to the 1 past end of the column /// /// @param - /// inCol + /// inCol /// @return - /// reverse_column_iterator + /// reverse_column_iterator /// reverse_column_iterator rcolend(size_type inCol) { @@ -1839,9 +1839,9 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_column_iterator to 1 past the end of the flattened array + /// const_reverse_column_iterator to 1 past the end of the flattened array /// @return - /// const_reverse_column_iterator + /// const_reverse_column_iterator /// const_reverse_column_iterator rcolend() const noexcept { @@ -1850,12 +1850,12 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_column_iterator to the 1 past end of the column + /// const_reverse_column_iterator to the 1 past end of the column /// /// @param - /// inCol + /// inCol /// @return - /// const_reverse_column_iterator + /// const_reverse_column_iterator /// const_reverse_column_iterator rcolend(size_type inCol) const { @@ -1864,10 +1864,10 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_column_iterator to 1 past the end of the flattened array + /// const_reverse_column_iterator to 1 past the end of the flattened array /// /// @return - /// const_reverse_column_iterator + /// const_reverse_column_iterator /// const_reverse_column_iterator crcolend() const noexcept { @@ -1876,12 +1876,12 @@ namespace nc //============================================================================ // Method Description: - /// const_reverse_column_iterator to 1 past the end of the input col + /// const_reverse_column_iterator to 1 past the end of the input col /// /// @param - /// inCol + /// inCol /// @return - /// const_reverse_column_iterator + /// const_reverse_column_iterator /// const_reverse_column_iterator crcolend(size_type inCol) const { @@ -1895,14 +1895,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns True if all elements evaluate to True or non zero + /// Returns True if all elements evaluate to True or non zero /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.all.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.all.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray all(Axis inAxis = Axis::NONE) const { @@ -1951,14 +1951,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns True if any elements evaluate to True or non zero + /// Returns True if any elements evaluate to True or non zero /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.any.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.any.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray any(Axis inAxis = Axis::NONE) const { @@ -2007,15 +2007,15 @@ namespace nc //============================================================================ // Method Description: - /// Return indices of the maximum values along the given axis. - /// Only the first index is returned. + /// Return indices of the maximum values along the given axis. + /// Only the first index is returned. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argmax.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argmax.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray argmax(Axis inAxis = Axis::NONE) const { @@ -2067,15 +2067,15 @@ namespace nc //============================================================================ // Method Description: - /// Return indices of the minimum values along the given axis. - /// Only the first index is returned. + /// Return indices of the minimum values along the given axis. + /// Only the first index is returned. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argmin.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argmin.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray argmin(Axis inAxis = Axis::NONE) const { @@ -2127,14 +2127,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns the indices that would sort this array. + /// Returns the indices that would sort this array. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argsort.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argsort.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray argsort(Axis inAxis = Axis::NONE) const { @@ -2212,13 +2212,13 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the array, cast to a specified type. - /// Arithmetic to Arithmetic + /// Returns a copy of the array, cast to a specified type. + /// Arithmetic to Arithmetic /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// /// @return - /// NdArray + /// NdArray /// template, int> = 0, @@ -2239,13 +2239,13 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the array, cast to a specified type. - /// Arithmetic to Complex + /// Returns a copy of the array, cast to a specified type. + /// Arithmetic to Complex /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// /// @return - /// NdArray + /// NdArray /// template, int> = 0, @@ -2267,13 +2267,13 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the array, cast to a specified type. - /// Complex to Complex + /// Returns a copy of the array, cast to a specified type. + /// Complex to Complex /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// /// @return - /// NdArray + /// NdArray /// template, int> = 0, @@ -2302,13 +2302,13 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the array, cast to a specified type. - /// Complex to Arithmetic + /// Returns a copy of the array, cast to a specified type. + /// Complex to Arithmetic /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// /// @return - /// NdArray + /// NdArray /// template, int> = 0, @@ -2330,10 +2330,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the last element of the flattened array. + /// Returns a copy of the last element of the flattened array. /// /// @return - /// dtype + /// dtype /// const_reference back() const noexcept { @@ -2342,10 +2342,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a reference the last element of the flattened array. + /// Returns a reference the last element of the flattened array. /// /// @return - /// dtype + /// dtype /// reference back() noexcept { @@ -2354,10 +2354,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the last element of the input row. + /// Returns a copy of the last element of the input row. /// /// @return - /// dtype + /// dtype /// const_reference back(size_type row) const { @@ -2366,10 +2366,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a reference the last element of the input row. + /// Returns a reference the last element of the input row. /// /// @return - /// dtype + /// dtype /// reference back(size_type row) { @@ -2378,12 +2378,12 @@ namespace nc //============================================================================ // Method Description: - /// Swap the bytes of the array elements in place + /// Swap the bytes of the array elements in place /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.byteswap.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.byteswap.html /// /// @return - /// NdArray + /// NdArray /// NdArray& byteswap() noexcept { @@ -2420,14 +2420,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array whose values are limited to [min, max]. + /// Returns an array whose values are limited to [min, max]. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.clip.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.clip.html /// /// @param inMin: min value to clip to /// @param inMax: max value to clip to /// @return - /// clipped value + /// clipped value /// NdArray clip(value_type inMin, value_type inMax) const { @@ -2463,11 +2463,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns the full column of the array + /// Returns the full column of the array /// /// /// @return - /// Shape + /// Shape /// NdArray column(uint32 inColumn) { @@ -2476,12 +2476,12 @@ namespace nc //============================================================================ // Method Description: - /// returns whether or not a value is included the array + /// returns whether or not a value is included the array /// /// @param inValue /// @param inAxis (Optional, default NONE) /// @return - /// bool + /// bool /// NdArray contains(value_type inValue, Axis inAxis = Axis::NONE) const { @@ -2525,12 +2525,12 @@ namespace nc //============================================================================ // Method Description: - /// Return a copy of the array + /// Return a copy of the array /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.copy.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.copy.html /// /// @return - /// NdArray + /// NdArray /// NdArray copy() const { @@ -2539,14 +2539,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the cumulative product of the elements along the given axis. + /// Return the cumulative product of the elements along the given axis. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.cumprod.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.cumprod.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray cumprod(Axis inAxis = Axis::NONE) const { @@ -2603,14 +2603,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the cumulative sum of the elements along the given axis. + /// Return the cumulative sum of the elements along the given axis. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.cumsum.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.cumsum.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray cumsum(Axis inAxis = Axis::NONE) const { @@ -2667,7 +2667,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the raw pointer to the underlying data + /// Returns the raw pointer to the underlying data /// @return pointer /// pointer data() noexcept @@ -2677,7 +2677,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the raw pointer to the underlying data + /// Returns the raw pointer to the underlying data /// @return const_pointer /// const_pointer data() const noexcept @@ -2687,9 +2687,9 @@ namespace nc //============================================================================ // Method Description: - /// Releases the internal data pointer so that the destructor - /// will not call delete on it, and returns the raw pointer - /// to the underlying data. + /// Releases the internal data pointer so that the destructor + /// will not call delete on it, and returns the raw pointer + /// to the underlying data. /// @return pointer /// pointer dataRelease() noexcept @@ -2700,14 +2700,14 @@ namespace nc //============================================================================ // Method Description: - /// Return specified diagonals. + /// Return specified diagonals. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.diagonal.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.diagonal.html /// /// @param inOffset: Offset of the diagonal from the main diagonal. Can be both positive and negative. Defaults to 0. /// @param inAxis: (Optional, default ROW) axis the offset is applied to /// @return - /// NdArray + /// NdArray /// NdArray diagonal(int32 inOffset = 0, Axis inAxis = Axis::ROW) const { @@ -2767,17 +2767,17 @@ namespace nc //============================================================================ // Method Description: - /// Dot product of two arrays. + /// Dot product of two arrays. /// - /// For 2-D arrays it is equivalent to matrix multiplication, - /// and for 1-D arrays to inner product of vectors. + /// For 2-D arrays it is equivalent to matrix multiplication, + /// and for 1-D arrays to inner product of vectors. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html /// /// @param - /// inOtherArray + /// inOtherArray /// @return - /// dot product + /// dot product /// NdArray dot(const NdArray& inOtherArray) const { @@ -2816,10 +2816,10 @@ namespace nc //============================================================================ // Method Description: - /// Dump a binary file of the array to the specified file. - /// The array can be read back with nc::load. + /// Dump a binary file of the array to the specified file. + /// The array can be read back with nc::load. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dump.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dump.html /// /// @param inFilename /// @@ -2846,10 +2846,10 @@ namespace nc //============================================================================ // Method Description: - /// Return the NdArrays endianess + /// Return the NdArrays endianess /// /// @return - /// Endian + /// Endian /// Endian endianess() const noexcept { @@ -2860,14 +2860,14 @@ namespace nc //============================================================================ // Method Description: - /// Fill the array with a scaler value. + /// Fill the array with a scaler value. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.fill.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.fill.html /// /// @param - /// inFillValue + /// inFillValue /// @return - /// None + /// None /// NdArray& fill(value_type inFillValue) noexcept { @@ -2877,11 +2877,11 @@ namespace nc //============================================================================ // Method Description: - /// Return the indices of the flattened array of the - /// elements that are non-zero. + /// Return the indices of the flattened array of the + /// elements that are non-zero. /// /// @return - /// NdArray + /// NdArray /// NdArray flatnonzero() const { @@ -2903,12 +2903,12 @@ namespace nc //============================================================================ // Method Description: - /// Return a copy of the array collapsed into one dimension. + /// Return a copy of the array collapsed into one dimension. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.flatten.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.flatten.html /// /// @return - /// NdArray + /// NdArray /// NdArray flatten() const { @@ -2919,10 +2919,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the first element of the flattened array. + /// Returns a copy of the first element of the flattened array. /// /// @return - /// dtype + /// dtype /// const_reference front() const noexcept { @@ -2931,10 +2931,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a reference to the first element of the flattened array. + /// Returns a reference to the first element of the flattened array. /// /// @return - /// dtype + /// dtype /// reference front() noexcept { @@ -2943,10 +2943,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the first element of the input row. + /// Returns a copy of the first element of the input row. /// /// @return - /// dtype + /// dtype /// const_reference front(size_type row) const { @@ -2955,10 +2955,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns a reference to the first element of the input row. + /// Returns a reference to the first element of the input row. /// /// @return - /// dtype + /// dtype /// reference front(size_type row) { @@ -2967,12 +2967,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns a new flat array with the givin flat input indices. + /// Returns a new flat array with the givin flat input indices. /// /// @param - /// inIndices + /// inIndices /// @return - /// values + /// values /// NdArray getByIndices(const NdArray& inIndices) const { @@ -2981,14 +2981,14 @@ namespace nc //============================================================================ // Method Description: - /// Takes in a boolean mask the same size as the array - /// and returns a flattened array with the values cooresponding - /// to the input mask. + /// Takes in a boolean mask the same size as the array + /// and returns a flattened array with the values cooresponding + /// to the input mask. /// /// @param - /// inMask + /// inMask /// @return - /// values + /// values /// NdArray getByMask(const NdArray& inMask) const { @@ -2997,11 +2997,11 @@ namespace nc //============================================================================ // Method Description: - /// Return if the NdArray is empty. ie the default construtor - /// was used. + /// Return if the NdArray is empty. ie the default construtor + /// was used. /// /// @return - /// boolean + /// boolean /// bool isempty() const noexcept { @@ -3010,11 +3010,11 @@ namespace nc //============================================================================ // Method Description: - /// Return if the NdArray is empty. ie the default construtor - /// was used. + /// Return if the NdArray is empty. ie the default construtor + /// was used. /// /// @return - /// boolean + /// boolean /// bool isflat() const noexcept { @@ -3023,7 +3023,7 @@ namespace nc //============================================================================ // Method Description: - /// Return if the NdArray is sorted. + /// Return if the NdArray is sorted. /// /// @param inAxis /// @return boolean @@ -3075,7 +3075,7 @@ namespace nc //============================================================================ // Method Description: - /// Return if the NdArray is sorted. + /// Return if the NdArray is sorted. /// /// @return boolean /// @@ -3086,12 +3086,12 @@ namespace nc //============================================================================ // Method Description: - /// Copy an element of an array to a standard C++ scaler and return it. + /// Copy an element of an array to a standard C++ scaler and return it. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.item.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.item.html /// /// @return - /// array element + /// array element /// value_type item() const { @@ -3105,14 +3105,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the maximum along a given axis. + /// Return the maximum along a given axis. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.max.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.max.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray max(Axis inAxis = Axis::NONE) const { @@ -3162,14 +3162,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the minimum along a given axis. + /// Return the minimum along a given axis. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.min.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.min.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray min(Axis inAxis = Axis::NONE) const { @@ -3219,16 +3219,16 @@ namespace nc //============================================================================ // Method Description: - /// Return the median along a given axis. - /// If the dtype is floating point then the middle elements will be - /// averaged for arrays of even number of elements. - /// If the dtype is integral then the middle elements will be intager - /// averaged (rounded down to integer) for arrays of even number of elements. + /// Return the median along a given axis. + /// If the dtype is floating point then the middle elements will be + /// averaged for arrays of even number of elements. + /// If the dtype is integral then the middle elements will be intager + /// averaged (rounded down to integer) for arrays of even number of elements. /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray median(Axis inAxis = Axis::NONE) const { @@ -3325,7 +3325,7 @@ namespace nc //============================================================================ // Method Description: - /// Fills the array with nans. + /// Fills the array with nans. /// /// NdArray& nans() noexcept @@ -3338,12 +3338,12 @@ namespace nc //============================================================================ // Method Description: - /// Returns the number of bytes held by the array + /// Returns the number of bytes held by the array /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.nbytes.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.nbytes.html /// /// @return - /// number of bytes + /// number of bytes /// uint64 nbytes() const noexcept { @@ -3352,15 +3352,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the array with the same data viewed with a - /// different byte order. only works for integer types. + /// Return the array with the same data viewed with a + /// different byte order. only works for integer types. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.newbyteorder.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.newbyteorder.html /// /// @param - /// inEndianess + /// inEndianess /// @return - /// NdArray + /// NdArray /// NdArray newbyteorder(Endian inEndianess) const { @@ -3518,14 +3518,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns True if none elements evaluate to True or non zero + /// Returns True if none elements evaluate to True or non zero /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.any.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.any.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray none(Axis inAxis = Axis::NONE) const { @@ -3574,24 +3574,24 @@ namespace nc //============================================================================ // Method Description: - /// Return the row/col indices of the array of the - /// elements that are non-zero. + /// Return the row/col indices of the array of the + /// elements that are non-zero. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.nonzero.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.nonzero.html /// /// @return - /// std::pair where first is the row indices and second is the - /// column indices + /// std::pair where first is the row indices and second is the + /// column indices /// std::pair, NdArray> nonzero() const; //============================================================================ // Method Description: - /// Returns the number of columns in the array + /// Returns the number of columns in the array /// /// /// @return - /// uint32 + /// uint32 /// uint32 numCols() const noexcept { @@ -3600,11 +3600,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns the number of rows in the array + /// Returns the number of rows in the array /// /// /// @return - /// uint32 + /// uint32 /// uint32 numRows() const noexcept { @@ -3613,7 +3613,7 @@ namespace nc //============================================================================ // Method Description: - /// Fills the array with ones + /// Fills the array with ones /// /// NdArray& ones() noexcept @@ -3626,7 +3626,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns whether or not the array object owns the underlying data + /// Returns whether or not the array object owns the underlying data /// /// @return bool /// @@ -3637,19 +3637,19 @@ namespace nc //============================================================================ // Method Description: - /// Rearranges the elements in the array in such a way that - /// value of the element in kth position is in the position it - /// would be in a sorted array. All elements smaller than the kth - /// element are moved before this element and all equal or greater - /// are moved behind it. The ordering of the elements in the two - /// partitions is undefined. + /// Rearranges the elements in the array in such a way that + /// value of the element in kth position is in the position it + /// would be in a sorted array. All elements smaller than the kth + /// element are moved before this element and all equal or greater + /// are moved behind it. The ordering of the elements in the two + /// partitions is undefined. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.partition.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.partition.html /// /// @param inKth: kth element /// @param inAxis (Optional, default NONE) /// @return - /// None + /// None /// NdArray& partition(uint32 inKth, Axis inAxis = Axis::NONE) { @@ -3714,7 +3714,7 @@ namespace nc //============================================================================ // Method Description: - /// Prints the array to the console. + /// Prints the array to the console. /// /// void print() const @@ -3726,14 +3726,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the product of the array elements over the given axis + /// Return the product of the array elements over the given axis /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.prod.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.prod.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray prod(Axis inAxis = Axis::NONE) const { @@ -3781,14 +3781,14 @@ namespace nc //============================================================================ // Method Description: - /// Peak to peak (maximum - minimum) value along a given axis. + /// Peak to peak (maximum - minimum) value along a given axis. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.ptp.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.ptp.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray ptp(Axis inAxis = Axis::NONE) const { @@ -3840,9 +3840,9 @@ namespace nc //============================================================================ // Method Description: - /// set the flat index element to the value + /// set the flat index element to the value /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inIndex /// @param inValue @@ -3856,9 +3856,9 @@ namespace nc //============================================================================ // Method Description: - /// set the 2D row/col index element to the value + /// set the 2D row/col index element to the value /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRow /// @param inCol @@ -3873,9 +3873,9 @@ namespace nc //============================================================================ // Method Description: - /// Set a.flat[n] = values for all n in indices. + /// Set a.flat[n] = values for all n in indices. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inIndices /// @param inValue @@ -3892,9 +3892,9 @@ namespace nc //============================================================================ // Method Description: - /// Set a.flat[n] = values[n] for all n in indices. + /// Set a.flat[n] = values[n] for all n in indices. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inIndices /// @param inValues @@ -3917,9 +3917,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input value. + /// Set the slice indices to the input value. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inSlice /// @param inValue @@ -3939,9 +3939,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input values. + /// Set the slice indices to the input values. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inSlice /// @param inValues @@ -3962,9 +3962,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input value. + /// Set the slice indices to the input value. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRowSlice /// @param inColSlice @@ -3992,9 +3992,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input value. + /// Set the slice indices to the input value. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRowSlice /// @param inColIndex @@ -4016,9 +4016,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input value. + /// Set the slice indices to the input value. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRowIndex /// @param inColSlice @@ -4040,9 +4040,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input values. + /// Set the slice indices to the input values. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRowSlice /// @param inColSlice @@ -4071,9 +4071,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input values. + /// Set the slice indices to the input values. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRowSlice /// @param inColIndex @@ -4096,9 +4096,9 @@ namespace nc //============================================================================ // Method Description: - /// Set the slice indices to the input values. + /// Set the slice indices to the input values. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// /// @param inRowIndex /// @param inColSlice @@ -4121,7 +4121,7 @@ namespace nc //============================================================================ // Method Description: - /// Set the mask indices to the input value. + /// Set the mask indices to the input value. /// /// @param inMask /// @param inValue @@ -4138,7 +4138,7 @@ namespace nc //============================================================================ // Method Description: - /// Set the mask indices to the input values. + /// Set the mask indices to the input values. /// /// @param inMask /// @param inValues @@ -4155,7 +4155,7 @@ namespace nc //============================================================================ // Method Description: - /// Flattens the array but does not make a copy. + /// Flattens the array but does not make a copy. /// /// Numpy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.ravel.html /// @@ -4169,14 +4169,14 @@ namespace nc //============================================================================ // Method Description: - /// Repeat elements of an array. + /// Repeat elements of an array. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.repeat.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.repeat.html /// /// @param inNumRows /// @param inNumCols /// @return - /// NdArray + /// NdArray /// NdArray repeat(uint32 inNumRows, uint32 inNumCols) const { @@ -4212,14 +4212,14 @@ namespace nc //============================================================================ // Method Description: - /// Repeat elements of an array. + /// Repeat elements of an array. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.repeat.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.repeat.html /// /// @param - /// inRepeatShape + /// inRepeatShape /// @return - /// NdArray + /// NdArray /// NdArray repeat(const Shape& inRepeatShape) const { @@ -4228,7 +4228,7 @@ namespace nc //============================================================================ // Method Description: - /// Replaces a value of the array with another value + /// Replaces a value of the array with another value /// /// @param oldValue: the value to replace /// @param newValue: the value to replace with @@ -4242,7 +4242,7 @@ namespace nc //============================================================================ // Method Description: - /// The new shape should be compatible with the original shape. If an single integer, + /// The new shape should be compatible with the original shape. If an single integer, /// then the result will be a 1-D array of that length. One shape dimension /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. @@ -4268,7 +4268,7 @@ namespace nc //============================================================================ // Method Description: - /// The new shape should be compatible with the original shape. If an single integer, + /// The new shape should be compatible with the original shape. If an single integer, /// then the result will be a 1-D array of that length. One shape dimension /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. @@ -4321,7 +4321,7 @@ namespace nc //============================================================================ // Method Description: - /// The new shape should be compatible with the original shape. If an single integer, + /// The new shape should be compatible with the original shape. If an single integer, /// then the result will be a 1-D array of that length. One shape dimension /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. @@ -4329,7 +4329,7 @@ namespace nc /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.reshape.html /// /// @param - /// inShape + /// inShape /// NdArray& reshape(const Shape& inShape) { @@ -4338,10 +4338,10 @@ namespace nc //============================================================================ // Method Description: - /// Change shape and size of array in-place. All previous - /// data of the array is lost. + /// Change shape and size of array in-place. All previous + /// data of the array is lost. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// /// @param inNumRows /// @param inNumCols @@ -4354,13 +4354,13 @@ namespace nc //============================================================================ // Method Description: - /// Change shape and size of array in-place. All previous - /// data of the array is lost. + /// Change shape and size of array in-place. All previous + /// data of the array is lost. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// /// @param - /// inShape + /// inShape /// NdArray& resizeFast(const Shape& inShape) { @@ -4369,12 +4369,12 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array with the specified shape. If new shape - /// is larger than old shape then array will be padded with zeros. - /// If new shape is smaller than the old shape then the data will - /// be discarded. + /// Return a new array with the specified shape. If new shape + /// is larger than old shape then array will be padded with zeros. + /// If new shape is smaller than the old shape then the data will + /// be discarded. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// /// @param inNumRows /// @param inNumCols @@ -4409,15 +4409,15 @@ namespace nc //============================================================================ // Method Description: - /// Return a new array with the specified shape. If new shape - /// is larger than old shape then array will be padded with zeros. - /// If new shape is smaller than the old shape then the data will - /// be discarded. + /// Return a new array with the specified shape. If new shape + /// is larger than old shape then array will be padded with zeros. + /// If new shape is smaller than the old shape then the data will + /// be discarded. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// /// @param - /// inShape + /// inShape /// NdArray& resizeSlow(const Shape& inShape) { @@ -4426,15 +4426,15 @@ namespace nc //============================================================================ // Method Description: - /// Return a with each element rounded to the given number - /// of decimals. + /// Return a with each element rounded to the given number + /// of decimals. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.round.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.round.html /// /// @param - /// inNumDecimals (default 0) + /// inNumDecimals (default 0) /// @return - /// NdArray + /// NdArray /// NdArray round(uint8 inNumDecimals = 0) const { @@ -4454,11 +4454,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns the full row of the array + /// Returns the full row of the array /// /// /// @return - /// Shape + /// Shape /// NdArray row(uint32 inRow) { @@ -4467,12 +4467,12 @@ namespace nc //============================================================================ // Method Description: - /// Return the shape of the array + /// Return the shape of the array /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.shape.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.shape.html /// /// @return - /// Shape + /// Shape /// Shape shape() const noexcept { @@ -4481,12 +4481,12 @@ namespace nc //============================================================================ // Method Description: - /// Return the size of the array + /// Return the size of the array /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.size.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.size.html /// /// @return - /// size + /// size /// size_type size() const noexcept { @@ -4495,14 +4495,14 @@ namespace nc //============================================================================ // Method Description: - /// Sort an array, in-place. + /// Sort an array, in-place. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.sort.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.sort.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// size + /// size /// NdArray& sort(Axis inAxis = Axis::NONE) { @@ -4546,10 +4546,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the NdArray as a string representation + /// returns the NdArray as a string representation /// /// @return - /// string + /// string /// std::string str() const { @@ -4580,14 +4580,14 @@ namespace nc //============================================================================ // Method Description: - /// Return the sum of the array elements over the given axis. + /// Return the sum of the array elements over the given axis. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.sum.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.sum.html /// /// @param - /// inAxis (Optional, default NONE) + /// inAxis (Optional, default NONE) /// @return - /// NdArray + /// NdArray /// NdArray sum(Axis inAxis = Axis::NONE) const { @@ -4632,12 +4632,12 @@ namespace nc //============================================================================ // Method Description: - /// Interchange two axes of an array. Equivalent to transpose... + /// Interchange two axes of an array. Equivalent to transpose... /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.swapaxes.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.swapaxes.html /// /// @return - /// NdArray + /// NdArray /// NdArray swapaxes() const { @@ -4646,16 +4646,16 @@ namespace nc //============================================================================ // Method Description: - /// Write array to a file as binary. - /// The data produced by this method can be recovered - /// using the function fromfile(). + /// Write array to a file as binary. + /// The data produced by this method can be recovered + /// using the function fromfile(). /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.tofile.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.tofile.html /// /// @param inFilename /// @return - /// None + /// None /// void tofile(const std::string& inFilename) const { @@ -4664,16 +4664,16 @@ namespace nc //============================================================================ // Method Description: - /// Write array to a file as text. - /// The data produced by this method can be recovered - /// using the function fromfile(). + /// Write array to a file as text. + /// The data produced by this method can be recovered + /// using the function fromfile(). /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.tofile.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.tofile.html /// /// @param inFilename /// @param inSep: Separator between array items for text output. /// @return - /// None + /// None /// void tofile(const std::string& inFilename, const char inSep) const { @@ -4705,7 +4705,7 @@ namespace nc //============================================================================ // Method Description: - /// Converts the slice object to an NdArray of indices for this array + /// Converts the slice object to an NdArray of indices for this array /// /// @param inSlice: the slice object /// @param inAxis: the array axis @@ -4756,10 +4756,10 @@ namespace nc //============================================================================ // Method Description: - /// Write flattened array to an STL vector + /// Write flattened array to an STL vector /// /// @return - /// std::vector + /// std::vector /// std::vector toStlVector() const { @@ -4768,15 +4768,15 @@ namespace nc //============================================================================ // Method Description: - /// Return the sum along diagonals of the array. + /// Return the sum along diagonals of the array. /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.trace.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.trace.html /// /// @param inOffset: Offset of the diagonal from the main diagonal. Can be both positive and negative. Defaults to 0. /// @param inAxis: (Optional, default ROW) Axis to offset from /// /// @return - /// value + /// value /// value_type trace(uint32 inOffset = 0, Axis inAxis = Axis::ROW) const noexcept { @@ -4825,12 +4825,12 @@ namespace nc //============================================================================ // Method Description: - /// Tranpose the rows and columns of an array + /// Tranpose the rows and columns of an array /// - /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.transpose.html + /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.transpose.html /// /// @return - /// NdArray + /// NdArray /// NdArray transpose() const { @@ -4847,7 +4847,7 @@ namespace nc //============================================================================ // Method Description: - /// Fills the array with zeros + /// Fills the array with zeros /// /// NdArray& zeros() noexcept @@ -4869,7 +4869,7 @@ namespace nc //============================================================================ // Method Description: - /// Deletes the internal array + /// Deletes the internal array /// void deleteArray() noexcept { @@ -4887,7 +4887,7 @@ namespace nc //============================================================================ // Method Description: - /// Creates a new internal array + /// Creates a new internal array /// void newArray() { @@ -4900,10 +4900,10 @@ namespace nc //============================================================================ // Method Description: - /// Creates a new internal array + /// Creates a new internal array /// /// @param - /// inShape + /// inShape /// void newArray(const Shape& inShape) { diff --git a/include/NumCpp/NdArray/NdArrayIterators.hpp b/include/NumCpp/NdArray/NdArrayIterators.hpp index 017ad0b52..d67e1aa50 100644 --- a/include/NumCpp/NdArray/NdArrayIterators.hpp +++ b/include/NumCpp/NdArray/NdArrayIterators.hpp @@ -36,7 +36,7 @@ namespace nc { //================================================================================ // Class Description: - /// Custom const_iterator for NdArray + /// Custom const_iterator for NdArray template @@ -54,13 +54,13 @@ namespace nc //============================================================================ // Method Description: - /// Default Constructor + /// Default Constructor /// NdArrayConstIterator() = default; //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param ptr: the iterator pointer /// @@ -75,7 +75,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator dereference + /// Iterator dereference /// /// @return reference /// @@ -86,7 +86,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator pointer operator + /// Iterator pointer operator /// /// @return pointer /// @@ -97,7 +97,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator prefix incrament operator + /// Iterator prefix incrament operator /// /// @return NdArrayConstIterator& /// @@ -109,7 +109,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator postfix incrament operator + /// Iterator postfix incrament operator /// /// @return NdArrayConstIterator /// @@ -122,7 +122,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator prefix decrament operator + /// Iterator prefix decrament operator /// /// @return NdArrayConstIterator& /// @@ -134,7 +134,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator postfix decrament operator + /// Iterator postfix decrament operator /// /// @return NdArrayConstIterator /// @@ -147,7 +147,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator addition assignement operator + /// Iterator addition assignement operator /// /// @param offset /// @return NdArrayConstIterator& @@ -160,7 +160,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator addition operator + /// Iterator addition operator /// /// @param offset /// @return NdArrayConstIterator @@ -173,7 +173,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator subtraction assignement operator + /// Iterator subtraction assignement operator /// /// @param offset /// @return NdArrayConstIterator& @@ -185,7 +185,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator subtraction operator + /// Iterator subtraction operator /// /// @param offset /// @return NdArrayConstIterator @@ -198,7 +198,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator difference operator + /// Iterator difference operator /// /// @param rhs /// @return difference_type @@ -210,7 +210,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator access operator + /// Iterator access operator /// /// @param offset /// @return reference @@ -222,7 +222,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator equality operator + /// Iterator equality operator /// /// @param rhs /// @return bool @@ -234,7 +234,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator not-equality operator + /// Iterator not-equality operator /// /// @param rhs /// @return bool @@ -246,7 +246,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator less than operator + /// Iterator less than operator /// /// @param rhs /// @return bool @@ -258,7 +258,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator greater than operator + /// Iterator greater than operator /// /// @param rhs /// @return bool @@ -270,7 +270,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator less than equal operator + /// Iterator less than equal operator /// /// @param rhs /// @return bool @@ -282,7 +282,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator greater than equal operator + /// Iterator greater than equal operator /// /// @param rhs /// @return bool @@ -298,7 +298,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator addition operator + /// Iterator addition operator /// /// @param offset /// @param next @@ -316,7 +316,7 @@ namespace nc //================================================================================ // Class Description: - /// Custom iterator for NdArray + /// Custom iterator for NdArray template @@ -337,7 +337,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator dereference + /// Iterator dereference /// /// @return reference /// @@ -348,7 +348,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator pointer operator + /// Iterator pointer operator /// /// @return pointer /// @@ -359,7 +359,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator prefix incrament operator + /// Iterator prefix incrament operator /// /// @return NdArrayConstIterator& /// @@ -371,7 +371,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator postfix incrament operator + /// Iterator postfix incrament operator /// /// @return NdArrayConstIterator /// @@ -384,7 +384,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator prefix decrament operator + /// Iterator prefix decrament operator /// /// @return NdArrayConstIterator& /// @@ -396,7 +396,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator postfix decrament operator + /// Iterator postfix decrament operator /// /// @return NdArrayConstIterator /// @@ -409,7 +409,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator addition assignement operator + /// Iterator addition assignement operator /// /// @param offset /// @return NdArrayConstIterator& @@ -422,7 +422,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator addition operator + /// Iterator addition operator /// /// @param offset /// @return NdArrayConstIterator @@ -435,7 +435,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator subtraction assignement operator + /// Iterator subtraction assignement operator /// /// @param offset /// @return NdArrayConstIterator& @@ -450,7 +450,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator difference operator + /// Iterator difference operator /// /// @param offset /// @return NdArrayConstIterator @@ -463,7 +463,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator access operator + /// Iterator access operator /// /// @param offset /// @return reference @@ -476,7 +476,7 @@ namespace nc //============================================================================ // Method Description: - /// Iterator addition operator + /// Iterator addition operator /// /// @param offset /// @param next @@ -494,7 +494,7 @@ namespace nc //================================================================================ // Class Description: - /// Custom column const_iterator for NdArray + /// Custom column const_iterator for NdArray template NdArray& operator+=(NdArray& lhs, dtype rhs) @@ -122,12 +122,12 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (4) + /// Adds the scaler to the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray>& operator+=(NdArray>& lhs, dtype rhs) @@ -146,7 +146,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the elements of two arrays (1) + /// Adds the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -172,7 +172,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the elements of two arrays (2) + /// Adds the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -203,7 +203,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the elements of two arrays (3) + /// Adds the elements of two arrays (3) /// /// @param lhs /// @param rhs @@ -217,10 +217,10 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (4) + /// Adds the scaler to the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -242,9 +242,9 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (5) + /// Adds the scaler to the array (5) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -256,10 +256,10 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (6) + /// Adds the scaler to the array (6) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -281,9 +281,9 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (7) + /// Adds the scaler to the array (7) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -295,10 +295,10 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (8) + /// Adds the scaler to the array (8) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -320,9 +320,9 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the array (9) + /// Adds the scaler to the array (9) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -334,7 +334,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the elements of two arrays (1) + /// Subtracts the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -358,7 +358,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the elements of two arrays (2) + /// Subtracts the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -387,12 +387,12 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (3) + /// Subtracts the scaler from the array (3) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray& operator-=(NdArray& lhs, dtype rhs) @@ -411,12 +411,12 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (4) + /// Subtracts the scaler from the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray>& operator-=(NdArray>& lhs, dtype rhs) @@ -435,7 +435,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the elements of two arrays (1) + /// Subtracts the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -461,7 +461,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the elements of two arrays (2) + /// Subtracts the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -492,7 +492,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the elements of two arrays (3) + /// Subtracts the elements of two arrays (3) /// /// @param lhs /// @param rhs @@ -523,10 +523,10 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (4) + /// Subtracts the scaler from the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -548,9 +548,9 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (5) + /// Subtracts the scaler from the array (5) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -573,10 +573,10 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (6) + /// Subtracts the scaler from the array (6) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -598,9 +598,9 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (7) + /// Subtracts the scaler from the array (7) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -623,10 +623,10 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (8) + /// Subtracts the scaler from the array (8) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -648,9 +648,9 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the array (9) + /// Subtracts the scaler from the array (9) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -673,7 +673,7 @@ namespace nc //============================================================================ // Method Description: - /// Negative Operator + /// Negative Operator /// /// @return NdArray /// @@ -692,7 +692,7 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the elements of two arrays (1) + /// Multiplies the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -716,7 +716,7 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the elements of two arrays (2) + /// Multiplies the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -745,12 +745,12 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (3) + /// Multiplies the scaler to the array (3) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray& operator*=(NdArray& lhs, dtype rhs) @@ -769,12 +769,12 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (4) + /// Multiplies the scaler to the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray>& operator*=(NdArray>& lhs, dtype rhs) @@ -793,7 +793,7 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the elements of two arrays (1) + /// Multiplies the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -819,7 +819,7 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the elements of two arrays (2) + /// Multiplies the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -850,7 +850,7 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the elements of two arrays (3) + /// Multiplies the elements of two arrays (3) /// /// @param lhs /// @param rhs @@ -864,10 +864,10 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (4) + /// Multiplies the scaler to the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -889,9 +889,9 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (5) + /// Multiplies the scaler to the array (5) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -903,10 +903,10 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (6) + /// Multiplies the scaler to the array (6) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -928,9 +928,9 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (7) + /// Multiplies the scaler to the array (7) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -942,10 +942,10 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (8) + /// Multiplies the scaler to the array (8) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -967,9 +967,9 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the scaler to the array (9) + /// Multiplies the scaler to the array (9) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -981,7 +981,7 @@ namespace nc //============================================================================ // Method Description: - /// Divides the elements of two arrays (1) + /// Divides the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -1005,7 +1005,7 @@ namespace nc //============================================================================ // Method Description: - /// Divides the elements of two arrays (2) + /// Divides the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -1034,12 +1034,12 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (3) + /// Divides the scaler from the array (3) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray& operator/=(NdArray& lhs, dtype rhs) @@ -1058,12 +1058,12 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (4) + /// Divides the scaler from the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray>& operator/=(NdArray>& lhs, dtype rhs) @@ -1082,7 +1082,7 @@ namespace nc //============================================================================ // Method Description: - /// Divides the elements of two arrays (1) + /// Divides the elements of two arrays (1) /// /// @param lhs /// @param rhs @@ -1108,7 +1108,7 @@ namespace nc //============================================================================ // Method Description: - /// Divides the elements of two arrays (2) + /// Divides the elements of two arrays (2) /// /// @param lhs /// @param rhs @@ -1139,7 +1139,7 @@ namespace nc //============================================================================ // Method Description: - /// Divides the elements of two arrays (3) + /// Divides the elements of two arrays (3) /// /// @param lhs /// @param rhs @@ -1170,10 +1170,10 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (4) + /// Divides the scaler from the array (4) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1195,9 +1195,9 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (5) + /// Divides the scaler from the array (5) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1220,10 +1220,10 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (6) + /// Divides the scaler from the array (6) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1245,9 +1245,9 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (7) + /// Divides the scaler from the array (7) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1270,10 +1270,10 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (8) + /// Divides the scaler from the array (8) /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1295,9 +1295,9 @@ namespace nc //============================================================================ // Method Description: - /// Divides the scaler from the array (9) + /// Divides the scaler from the array (9) /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1320,7 +1320,7 @@ namespace nc //============================================================================ // Method Description: - /// Modulus the elements of two arrays + /// Modulus the elements of two arrays /// /// @param lhs /// @param rhs @@ -1342,7 +1342,7 @@ namespace nc //============================================================================ // Method Description: - /// Modulus the elements of two arrays + /// Modulus the elements of two arrays /// /// @param lhs /// @param rhs @@ -1369,12 +1369,12 @@ namespace nc //============================================================================ // Method Description: - /// Modulus the scaler to the array + /// Modulus the scaler to the array /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template::value, int> = 0> @@ -1392,12 +1392,12 @@ namespace nc //============================================================================ // Method Description: - /// Modulus the scaler to the array + /// Modulus the scaler to the array /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template::value, int> = 0> @@ -1415,7 +1415,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the modulus of the elements of two arrays + /// Takes the modulus of the elements of two arrays /// /// @param lhs /// @param rhs @@ -1431,10 +1431,10 @@ namespace nc //============================================================================ // Method Description: - /// Modulus of the array and the scaler + /// Modulus of the array and the scaler /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1447,9 +1447,9 @@ namespace nc //============================================================================ // Method Description: - /// Modulus of the scaler and the array + /// Modulus of the scaler and the array /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1469,9 +1469,9 @@ namespace nc //============================================================================ // Method Description: - /// Modulus of the scaler and the array + /// Modulus of the scaler and the array /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1491,7 +1491,7 @@ namespace nc //============================================================================ // Method Description: - /// Bitwise or the elements of two arrays + /// Bitwise or the elements of two arrays /// /// @param lhs /// @param rhs @@ -1515,12 +1515,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitwise or the scaler to the array + /// Bitwise or the scaler to the array /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray& operator|=(NdArray& lhs, dtype rhs) @@ -1539,7 +1539,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise or of the elements of two arrays + /// Takes the bitwise or of the elements of two arrays /// /// @param lhs /// @param rhs @@ -1555,10 +1555,10 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise or of the array and the scaler + /// Takes the bitwise or of the array and the scaler /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1571,9 +1571,9 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise or of the sclar and the array + /// Takes the bitwise or of the sclar and the array /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1585,7 +1585,7 @@ namespace nc //============================================================================ // Method Description: - /// Bitwise and the elements of two arrays + /// Bitwise and the elements of two arrays /// /// @param lhs /// @param rhs @@ -1609,12 +1609,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitwise and the scaler to the array + /// Bitwise and the scaler to the array /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray& operator&=(NdArray& lhs, dtype rhs) @@ -1633,7 +1633,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise and of the elements of two arrays + /// Takes the bitwise and of the elements of two arrays /// /// @param lhs /// @param rhs @@ -1649,10 +1649,10 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise and of the array and the scaler + /// Takes the bitwise and of the array and the scaler /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1665,9 +1665,9 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise and of the sclar and the array + /// Takes the bitwise and of the sclar and the array /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1679,7 +1679,7 @@ namespace nc //============================================================================ // Method Description: - /// Bitwise xor the elements of two arrays + /// Bitwise xor the elements of two arrays /// /// @param lhs /// @param rhs @@ -1703,12 +1703,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitwise xor the scaler to the array + /// Bitwise xor the scaler to the array /// /// @param lhs - /// @param rhs + /// @param rhs /// @return - /// NdArray + /// NdArray /// template NdArray& operator^=(NdArray& lhs, dtype rhs) @@ -1727,7 +1727,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise xor of the elements of two arrays + /// Takes the bitwise xor of the elements of two arrays /// /// @param lhs /// @param rhs @@ -1743,10 +1743,10 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise xor of the array and the scaler + /// Takes the bitwise xor of the array and the scaler /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1759,9 +1759,9 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise xor of the sclar and the array + /// Takes the bitwise xor of the sclar and the array /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1773,7 +1773,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the bitwise not of the array + /// Takes the bitwise not of the array /// /// @param inArray /// @return NdArray @@ -1798,7 +1798,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the and of the elements of two arrays + /// Takes the and of the elements of two arrays /// /// @param lhs /// @param rhs @@ -1828,10 +1828,10 @@ namespace nc //============================================================================ // Method Description: - /// Takes the and of the array and the scaler + /// Takes the and of the array and the scaler /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1854,9 +1854,9 @@ namespace nc //============================================================================ // Method Description: - /// Takes the and of the array and the scaler + /// Takes the and of the array and the scaler /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1868,7 +1868,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the or of the elements of two arrays + /// Takes the or of the elements of two arrays /// /// @param lhs /// @param rhs @@ -1898,10 +1898,10 @@ namespace nc //============================================================================ // Method Description: - /// Takes the or of the array and the scaler + /// Takes the or of the array and the scaler /// /// @param lhs - /// @param rhs + /// @param rhs /// @return NdArray /// template @@ -1924,9 +1924,9 @@ namespace nc //============================================================================ // Method Description: - /// Takes the or of the array and the scaler + /// Takes the or of the array and the scaler /// - /// @param lhs + /// @param lhs /// @param rhs /// @return NdArray /// @@ -1938,7 +1938,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the not of the array + /// Takes the not of the array /// /// @param inArray /// @return NdArray @@ -1963,8 +1963,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// of two arrays + /// Returns an array of booleans of element wise comparison + /// of two arrays /// /// @param lhs /// @param rhs @@ -1993,11 +1993,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// an array and a scaler + /// Returns an array of booleans of element wise comparison + /// an array and a scaler /// /// @param lhs - /// @param inValue + /// @param inValue /// @return NdArray /// template @@ -2018,10 +2018,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// an array and a scaler + /// Returns an array of booleans of element wise comparison + /// an array and a scaler /// - /// @param inValue + /// @param inValue /// @param inArray /// @return NdArray /// @@ -2033,8 +2033,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// of two arrays + /// Returns an array of booleans of element wise comparison + /// of two arrays /// /// @param lhs /// @param rhs @@ -2063,11 +2063,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// an array and a scaler + /// Returns an array of booleans of element wise comparison + /// an array and a scaler /// /// @param lhs - /// @param inValue + /// @param inValue /// @return NdArray /// template @@ -2088,10 +2088,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// an array and a scaler + /// Returns an array of booleans of element wise comparison + /// an array and a scaler /// - /// @param inValue + /// @param inValue /// @param inArray /// @return NdArray /// @@ -2103,8 +2103,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// of two arrays + /// Returns an array of booleans of element wise comparison + /// of two arrays /// /// @param lhs /// @param rhs @@ -2135,11 +2135,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// /// @param lhs - /// @param inValue + /// @param inValue /// @return NdArray /// template @@ -2162,10 +2162,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// - /// @param inValue + /// @param inValue /// @param inArray /// @return NdArray /// @@ -2189,8 +2189,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// of two arrays + /// Returns an array of booleans of element wise comparison + /// of two arrays /// /// @param lhs /// @param rhs @@ -2224,11 +2224,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// /// @param lhs - /// @param inValue + /// @param inValue /// @return NdArray /// template @@ -2251,10 +2251,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// - /// @param inValue + /// @param inValue /// @param inArray /// @return NdArray /// @@ -2278,8 +2278,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// of two arrays + /// Returns an array of booleans of element wise comparison + /// of two arrays /// /// @param lhs /// @param rhs @@ -2310,11 +2310,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// /// @param lhs - /// @param inValue + /// @param inValue /// @return NdArray /// template @@ -2337,10 +2337,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// - /// @param inValue + /// @param inValue /// @param inArray /// @return NdArray /// @@ -2364,8 +2364,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// of two arrays + /// Returns an array of booleans of element wise comparison + /// of two arrays /// /// @param lhs /// @param rhs @@ -2396,11 +2396,11 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// /// @param lhs - /// @param inValue + /// @param inValue /// @return NdArray /// template @@ -2423,10 +2423,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns an array of booleans of element wise comparison - /// the array and a scaler + /// Returns an array of booleans of element wise comparison + /// the array and a scaler /// - /// @param inValue + /// @param inValue /// @param inArray /// @return NdArray /// @@ -2450,12 +2450,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitshifts left the elements of the array + /// Bitshifts left the elements of the array /// /// @param lhs /// @param inNumBits /// @return - /// NdArray + /// NdArray /// template NdArray& operator<<=(NdArray& lhs, uint8 inNumBits) @@ -2474,12 +2474,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitshifts left the elements of the array + /// Bitshifts left the elements of the array /// /// @param lhs /// @param inNumBits /// @return - /// NdArray + /// NdArray /// template NdArray operator<<(const NdArray& lhs, uint8 inNumBits) @@ -2493,12 +2493,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitshifts right the elements of the array + /// Bitshifts right the elements of the array /// /// @param lhs /// @param inNumBits /// @return - /// NdArray + /// NdArray /// template NdArray& operator>>=(NdArray& lhs, uint8 inNumBits) @@ -2517,12 +2517,12 @@ namespace nc //============================================================================ // Method Description: - /// Bitshifts right the elements of the array - /// + /// Bitshifts right the elements of the array + /// /// @param lhs /// @param inNumBits /// @return - /// NdArray + /// NdArray /// template NdArray operator>>(const NdArray& lhs, uint8 inNumBits) @@ -2536,10 +2536,10 @@ namespace nc //============================================================================ // Method Description: - /// prefix incraments the elements of an array + /// prefix incraments the elements of an array /// /// @return - /// NdArray + /// NdArray /// template NdArray& operator++(NdArray& rhs) @@ -2558,11 +2558,11 @@ namespace nc //============================================================================ // Method Description: - /// postfix increments the elements of an array + /// postfix increments the elements of an array /// /// @param lhs /// @return - /// NdArray + /// NdArray /// template NdArray operator++(NdArray& lhs, int) @@ -2574,10 +2574,10 @@ namespace nc //============================================================================ // Method Description: - /// prefix decrements the elements of an array + /// prefix decrements the elements of an array /// /// @return - /// NdArray + /// NdArray /// template NdArray& operator--(NdArray& rhs) @@ -2596,11 +2596,11 @@ namespace nc //============================================================================ // Method Description: - /// postfix decrements the elements of an array + /// postfix decrements the elements of an array /// /// @param lhs /// @return - /// NdArray + /// NdArray /// template NdArray operator--(NdArray& lhs, int) @@ -2612,12 +2612,12 @@ namespace nc //============================================================================ // Method Description: - /// io operator for the NdArray class + /// io operator for the NdArray class /// /// @param inOStream /// @param inArray /// @return - /// std::ostream + /// std::ostream /// template std::ostream& operator<<(std::ostream& inOStream, const NdArray& inArray) diff --git a/include/NumCpp/Polynomial/Poly1d.hpp b/include/NumCpp/Polynomial/Poly1d.hpp index 316275a7f..780c4bac2 100644 --- a/include/NumCpp/Polynomial/Poly1d.hpp +++ b/include/NumCpp/Polynomial/Poly1d.hpp @@ -50,9 +50,9 @@ namespace nc namespace polynomial { //================================================================================ - /// A one-dimensional polynomial class. - /// A convenience class, used to encapsulate "natural" - /// operations on polynomials + /// A one-dimensional polynomial class. + /// A convenience class, used to encapsulate "natural" + /// operations on polynomials template class Poly1d { @@ -62,17 +62,17 @@ namespace nc public: //============================================================================ // Method Description: - /// Default Constructor (not very usefull, but needed for other - /// containers. + /// Default Constructor (not very usefull, but needed for other + /// containers. /// Poly1d() = default; //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inValues: (polynomial coefficients in ascending order of power if second input is false, - /// polynomial roots if second input is true) + /// polynomial roots if second input is true) /// @param isRoots /// Poly1d(const NdArray& inValues, bool isRoots = false) @@ -102,7 +102,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the area under the curve between the two bounds + /// Returns the area under the curve between the two bounds /// /// @param a: the lower bound /// @param b: the upper bound @@ -121,7 +121,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the polynomial of the new type + /// Returns a copy of the polynomial of the new type /// /// @return Poly1d /// @@ -142,10 +142,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns the Poly1d coefficients + /// Returns the Poly1d coefficients /// /// @return - /// NdArray + /// NdArray /// NdArray coefficients() const { @@ -155,7 +155,7 @@ namespace nc //============================================================================ // Method Description: - /// Takes the derivative of the polynomial + /// Takes the derivative of the polynomial /// /// @return Poly1d Poly1d deriv() const @@ -183,7 +183,7 @@ namespace nc //============================================================================ // Method Description: - /// Polynomial linear least squares regression: Ax = b + /// Polynomial linear least squares regression: Ax = b /// /// @param xValues: the x measurements [1, n] or [n, 1] array /// @param yValues: the y measurements [n, 1] array @@ -237,7 +237,7 @@ namespace nc //============================================================================ // Method Description: - /// Polynomial linear least squares regression: Ax = b + /// Polynomial linear least squares regression: Ax = b /// /// @param xValues: the x measurements [1, n] or [n, 1] array /// @param yValues: the y measurements [n, 1] array @@ -317,7 +317,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the integral of the polynomial + /// Calculates the integral of the polynomial /// /// @return Poly1d Poly1d integ() const @@ -341,10 +341,10 @@ namespace nc //============================================================================ // Method Description: - /// Returns the order of the Poly1d + /// Returns the order of the Poly1d /// /// @return - /// NdArray + /// NdArray /// uint32 order() const noexcept { @@ -353,8 +353,8 @@ namespace nc //============================================================================ // Method Description: - /// Prints the string representation of the Poly1d object - /// to the console + /// Prints the string representation of the Poly1d object + /// to the console /// void print() const { @@ -363,10 +363,10 @@ namespace nc //============================================================================ // Method Description: - /// Converts the polynomial to a string representation + /// Converts the polynomial to a string representation /// /// @return - /// Poly1d + /// Poly1d /// std::string str() const { @@ -417,12 +417,12 @@ namespace nc //============================================================================ // Method Description: - /// Evaluates the Poly1D object for the input value + /// Evaluates the Poly1D object for the input value /// /// @param - /// inValue + /// inValue /// @return - /// Poly1d + /// Poly1d /// dtype operator()(dtype inValue) const noexcept { @@ -438,12 +438,12 @@ namespace nc //============================================================================ // Method Description: - /// Adds the two Poly1d objects + /// Adds the two Poly1d objects /// /// @param - /// inOtherPoly + /// inOtherPoly /// @return - /// Poly1d + /// Poly1d /// Poly1d operator+(const Poly1d& inOtherPoly) const { @@ -452,12 +452,12 @@ namespace nc //============================================================================ // Method Description: - /// Adds the two Poly1d objects + /// Adds the two Poly1d objects /// /// @param - /// inOtherPoly + /// inOtherPoly /// @return - /// Poly1d + /// Poly1d /// Poly1d& operator+=(const Poly1d& inOtherPoly) { @@ -485,12 +485,12 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the two Poly1d objects + /// Subtracts the two Poly1d objects /// /// @param - /// inOtherPoly + /// inOtherPoly /// @return - /// Poly1d + /// Poly1d /// Poly1d operator-(const Poly1d& inOtherPoly) const { @@ -499,12 +499,12 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the two Poly1d objects + /// Subtracts the two Poly1d objects /// /// @param - /// inOtherPoly + /// inOtherPoly /// @return - /// Poly1d + /// Poly1d /// Poly1d& operator-=(const Poly1d& inOtherPoly) { @@ -532,12 +532,12 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the two Poly1d objects + /// Multiplies the two Poly1d objects /// /// @param - /// inOtherPoly + /// inOtherPoly /// @return - /// Poly1d + /// Poly1d /// Poly1d operator*(const Poly1d& inOtherPoly) const { @@ -546,12 +546,12 @@ namespace nc //============================================================================ // Method Description: - /// Multiplies the two Poly1d objects + /// Multiplies the two Poly1d objects /// /// @param - /// inOtherPoly + /// inOtherPoly /// @return - /// Poly1d + /// Poly1d /// Poly1d& operator*=(const Poly1d& inOtherPoly) { @@ -577,12 +577,12 @@ namespace nc //============================================================================ // Method Description: - /// Raise the Poly1d to an integer power + /// Raise the Poly1d to an integer power /// /// @param - /// inPower + /// inPower /// @return - /// Poly1d + /// Poly1d /// Poly1d operator^(uint32 inPower) const { @@ -591,12 +591,12 @@ namespace nc //============================================================================ // Method Description: - /// Raise the Poly1d to an integer power + /// Raise the Poly1d to an integer power /// /// @param - /// inPower + /// inPower /// @return - /// Poly1d + /// Poly1d /// Poly1d& operator^=(uint32 inPower) { @@ -622,12 +622,12 @@ namespace nc //============================================================================ // Method Description: - /// io operator for the Poly1d class + /// io operator for the Poly1d class /// /// @param inOStream /// @param inPoly /// @return - /// std::ostream + /// std::ostream /// friend std::ostream& operator<<(std::ostream& inOStream, const Poly1d& inPoly) { diff --git a/include/NumCpp/Polynomial/chebyshev_t.hpp b/include/NumCpp/Polynomial/chebyshev_t.hpp index 8b5e778d5..18f880fff 100644 --- a/include/NumCpp/Polynomial/chebyshev_t.hpp +++ b/include/NumCpp/Polynomial/chebyshev_t.hpp @@ -41,13 +41,13 @@ namespace nc { //============================================================================ // Method Description: - /// Chebyshev Polynomial of the first kind. + /// Chebyshev Polynomial of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param n: the order of the chebyshev polynomial /// @param x: the input value /// @return - /// double + /// double /// template double chebyshev_t(uint32 n, dtype x) @@ -59,13 +59,13 @@ namespace nc //============================================================================ // Method Description: - /// Chebyshev Polynomial of the first kind. + /// Chebyshev Polynomial of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param n: the order of the chebyshev polynomial /// @param inArrayX: the input value /// @return - /// NdArray + /// NdArray /// template NdArray chebyshev_t(uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/chebyshev_u.hpp b/include/NumCpp/Polynomial/chebyshev_u.hpp index 3b4509fb8..0e5545d95 100644 --- a/include/NumCpp/Polynomial/chebyshev_u.hpp +++ b/include/NumCpp/Polynomial/chebyshev_u.hpp @@ -41,13 +41,13 @@ namespace nc { //============================================================================ // Method Description: - /// Chebyshev Polynomial of the second kind. + /// Chebyshev Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param n: the order of the chebyshev polynomial /// @param x: the input value /// @return - /// double + /// double /// template double chebyshev_u(uint32 n, dtype x) @@ -59,13 +59,13 @@ namespace nc //============================================================================ // Method Description: - /// Chebyshev Polynomial of the second kind. + /// Chebyshev Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param n: the order of the chebyshev polynomial /// @param inArrayX: the input value /// @return - /// NdArray + /// NdArray /// template NdArray chebyshev_u(uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/hermite.hpp b/include/NumCpp/Polynomial/hermite.hpp index 2f99bcdbc..8ef642c5b 100644 --- a/include/NumCpp/Polynomial/hermite.hpp +++ b/include/NumCpp/Polynomial/hermite.hpp @@ -45,14 +45,14 @@ namespace nc { //============================================================================ // Method Description: - /// Hermite Polynomial + /// Hermite Polynomial /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param n: the order of the hermite polynomial /// @param x: the input value /// @return - /// double + /// double /// template double hermite(uint32 n, dtype x) @@ -68,14 +68,14 @@ namespace nc //============================================================================ // Method Description: - /// Hermite Polynomial. + /// Hermite Polynomial. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param n: the order of the hermite polynomial /// @param inArrayX: the input value /// @return - /// NdArray + /// NdArray /// template NdArray hermite(uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/laguerre.hpp b/include/NumCpp/Polynomial/laguerre.hpp index 3e03643d5..4330abdd5 100644 --- a/include/NumCpp/Polynomial/laguerre.hpp +++ b/include/NumCpp/Polynomial/laguerre.hpp @@ -45,14 +45,14 @@ namespace nc { //============================================================================ // Method Description: - /// Laguerre Polynomial. + /// Laguerre Polynomial. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param n: the order of the leguerre polynomial /// @param x: the input value /// @return - /// double + /// double /// template double laguerre(uint32 n, dtype x) @@ -68,7 +68,7 @@ namespace nc //============================================================================ // Method Description: - /// Associated Laguerre Polynomial. + /// Associated Laguerre Polynomial. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// @@ -76,7 +76,7 @@ namespace nc /// @param m: the degree of the legendre polynomial /// @param x: the input value /// @return - /// double + /// double /// template double laguerre(uint32 n, uint32 m, dtype x) @@ -92,14 +92,14 @@ namespace nc //============================================================================ // Method Description: - /// Laguerre Polynomial. + /// Laguerre Polynomial. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param n: the order of the leguerre polynomial /// @param inArrayX: the input value /// @return - /// NdArray + /// NdArray /// template NdArray laguerre(uint32 n, const NdArray& inArrayX) @@ -118,7 +118,7 @@ namespace nc //============================================================================ // Method Description: - /// Associated Laguerre Polynomial. + /// Associated Laguerre Polynomial. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// @@ -126,7 +126,7 @@ namespace nc /// @param m: the degree of the legendre polynomial /// @param inArrayX: the input value /// @return - /// NdArray + /// NdArray /// template NdArray laguerre(uint32 n, uint32 m, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/legendre_p.hpp b/include/NumCpp/Polynomial/legendre_p.hpp index 0836ef6f3..89252c2fa 100644 --- a/include/NumCpp/Polynomial/legendre_p.hpp +++ b/include/NumCpp/Polynomial/legendre_p.hpp @@ -46,14 +46,14 @@ namespace nc { //============================================================================ // Method Description: - /// Legendre Polynomial of the first kind. + /// Legendre Polynomial of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param n: the degree of the legendre polynomial /// @param x: the input value. Requires -1 <= x <= 1 /// @return - /// double + /// double /// template double legendre_p(uint32 n, dtype x) @@ -74,7 +74,7 @@ namespace nc //============================================================================ // Method Description: - /// Associated Legendre Polynomial of the first kind. + /// Associated Legendre Polynomial of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// @@ -82,7 +82,7 @@ namespace nc /// @param n: the degree of the legendre polynomial /// @param x: the input value. Requires -1 <= x <= 1 /// @return - /// double + /// double /// template double legendre_p(uint32 m, uint32 n, dtype x) @@ -133,14 +133,14 @@ namespace nc //============================================================================ // Method Description: - /// Legendre Polynomial of the first kind. + /// Legendre Polynomial of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param n: the degree of the legendre polynomial /// @param inArrayX: the input value. Requires -1 <= x <= 1 /// @return - /// NdArray + /// NdArray /// template NdArray legendre_p(uint32 n, const NdArray& inArrayX) @@ -159,7 +159,7 @@ namespace nc //============================================================================ // Method Description: - /// Associated Legendre Polynomial of the first kind. + /// Associated Legendre Polynomial of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// @@ -167,7 +167,7 @@ namespace nc /// @param n: the degree of the legendre polynomial /// @param inArrayX: the input value. Requires -1 <= x <= 1 /// @return - /// NdArray + /// NdArray /// template NdArray legendre_p(uint32 m, uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/legendre_q.hpp b/include/NumCpp/Polynomial/legendre_q.hpp index 2cd086600..38a9e8b0d 100644 --- a/include/NumCpp/Polynomial/legendre_q.hpp +++ b/include/NumCpp/Polynomial/legendre_q.hpp @@ -41,13 +41,13 @@ namespace nc { //============================================================================ // Method Description: - /// Legendre Polynomial of the second kind. + /// Legendre Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param n: the order of the legendre polynomial /// @param x: the input value. Requires -1 <= x <= 1 /// @return - /// double + /// double /// template double legendre_q(int32 n, dtype x) @@ -64,13 +64,13 @@ namespace nc //============================================================================ // Method Description: - /// Legendre Polynomial of the second kind. + /// Legendre Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param n: the order of the legendre polynomial /// @param inArrayX: the input value. Requires -1 <= x <= 1 /// @return - /// NdArray + /// NdArray /// template NdArray legendre_q(int32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/spherical_harmonic.hpp b/include/NumCpp/Polynomial/spherical_harmonic.hpp index dbf57d8aa..cc108a952 100644 --- a/include/NumCpp/Polynomial/spherical_harmonic.hpp +++ b/include/NumCpp/Polynomial/spherical_harmonic.hpp @@ -42,7 +42,7 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the value of the Spherical Harmonic Ynm(theta, phi). + /// Returns the value of the Spherical Harmonic Ynm(theta, phi). /// The spherical harmonics Ynm(theta, phi) are the angular portion of the /// solution to Laplace's equation in spherical coordinates where azimuthal /// symmetry is not present. @@ -53,7 +53,7 @@ namespace nc /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. /// @return - /// double + /// double /// template std::complex spherical_harmonic(uint32 n, int32 m, dtype1 theta, dtype2 phi) @@ -66,7 +66,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the real part of the Spherical Harmonic Ynm(theta, phi). + /// Returns the real part of the Spherical Harmonic Ynm(theta, phi). /// The spherical harmonics Ynm(theta, phi) are the angular portion of the /// solution to Laplace's equation in spherical coordinates where azimuthal /// symmetry is not present. @@ -77,7 +77,7 @@ namespace nc /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. /// @return - /// double + /// double /// template double spherical_harmonic_r(uint32 n, int32 m, dtype1 theta, dtype2 phi) @@ -90,7 +90,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the imaginary part of the Spherical Harmonic Ynm(theta, phi). + /// Returns the imaginary part of the Spherical Harmonic Ynm(theta, phi). /// The spherical harmonics Ynm(theta, phi) are the angular portion of the /// solution to Laplace's equation in spherical coordinates where azimuthal /// symmetry is not present. @@ -101,7 +101,7 @@ namespace nc /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. /// @return - /// double + /// double /// template double spherical_harmonic_i(uint32 n, int32 m, dtype1 theta, dtype2 phi) diff --git a/include/NumCpp/PythonInterface/BoostInterface.hpp b/include/NumCpp/PythonInterface/BoostInterface.hpp index 8b51fe1e7..121accdce 100644 --- a/include/NumCpp/PythonInterface/BoostInterface.hpp +++ b/include/NumCpp/PythonInterface/BoostInterface.hpp @@ -45,7 +45,7 @@ namespace nc namespace boostPythonInterface { //============================================================================ - /// Converts from a boost ndarray to a NumCpp NdArray + /// Converts from a boost ndarray to a NumCpp NdArray /// /// @param inArray /// @@ -91,7 +91,7 @@ namespace nc } //============================================================================ - /// Converts from a NumCpp NdArray to a boost ndarray + /// Converts from a NumCpp NdArray to a boost ndarray /// /// @param inArray /// @@ -115,7 +115,7 @@ namespace nc } //============================================================================ - /// converts a boost python list to a std::vector + /// converts a boost python list to a std::vector /// /// @param inList /// @@ -128,7 +128,7 @@ namespace nc } //============================================================================ - /// converts a std::vector to a boost python list + /// converts a std::vector to a boost python list /// /// @param inVector /// @@ -147,7 +147,7 @@ namespace nc } //============================================================================ - /// converts a std::map in to a boost python dictionary + /// converts a std::map in to a boost python dictionary /// /// @param inMap /// diff --git a/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp b/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp index cda131117..7204ce9ab 100644 --- a/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp +++ b/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp @@ -47,17 +47,17 @@ namespace nc namespace boostPythonInterface { //================================================================================ - /// Helper class for ndarray + /// Helper class for ndarray template class BoostNdarrayHelper { public: //================================================================================ - /// C or Fortran ordering from python + /// C or Fortran ordering from python enum class Order { F, C }; //============================================================================ - /// Constructor + /// Constructor /// /// @param inArray: ndarray /// @@ -83,7 +83,7 @@ namespace nc } //============================================================================ - /// Constructor + /// Constructor /// /// @param inShape /// @@ -110,7 +110,7 @@ namespace nc //============================================================================ - /// Returns the internaly held ndarray + /// Returns the internaly held ndarray /// /// @return reference to the held ndarray /// @@ -120,7 +120,7 @@ namespace nc } //============================================================================ - /// Returns the internaly held ndarray as a numpy matrix + /// Returns the internaly held ndarray as a numpy matrix /// /// @return matrix /// @@ -130,7 +130,7 @@ namespace nc } //============================================================================ - /// Returns the number of dimensions of the array + /// Returns the number of dimensions of the array /// /// @return num dimensions /// @@ -140,7 +140,7 @@ namespace nc } //============================================================================ - /// Returns the shape of the array + /// Returns the shape of the array /// /// @return vector /// @@ -150,7 +150,7 @@ namespace nc } //============================================================================ - /// Returns the size of the array + /// Returns the size of the array /// /// @return size /// @@ -166,7 +166,7 @@ namespace nc //============================================================================ - /// Returns the strides of the array + /// Returns the strides of the array /// /// @return vector /// @@ -176,7 +176,7 @@ namespace nc } //============================================================================ - /// Returns the memory order of the array (C or Fortran) + /// Returns the memory order of the array (C or Fortran) /// /// @return Order /// @@ -186,7 +186,7 @@ namespace nc } //============================================================================ - /// Returns if the shapes of the two array helpers are equal + /// Returns if the shapes of the two array helpers are equal /// /// @param otherNdarrayHelper /// @@ -203,7 +203,7 @@ namespace nc } //============================================================================ - /// 1D access operator + /// 1D access operator /// /// @param index /// @@ -217,7 +217,7 @@ namespace nc } //============================================================================ - /// 2D access operator + /// 2D access operator /// /// @param index1 /// @param index2 @@ -232,7 +232,7 @@ namespace nc } //============================================================================ - /// Prints a 1D array + /// Prints a 1D array /// void printArray1D() { @@ -250,7 +250,7 @@ namespace nc } //============================================================================ - /// Prints a 2D array + /// Prints a 2D array /// void printArray2D() { @@ -280,7 +280,7 @@ namespace nc Order order_; //============================================================================ - /// Generic check of input indices + /// Generic check of input indices /// /// @param indices /// @@ -306,7 +306,7 @@ namespace nc } //============================================================================ - /// Checks 1D input indices + /// Checks 1D input indices /// /// @param index /// @@ -317,7 +317,7 @@ namespace nc } //============================================================================ - /// Checks 2D input indices + /// Checks 2D input indices /// /// @param index1 /// @param index2 diff --git a/include/NumCpp/PythonInterface/PybindInterface.hpp b/include/NumCpp/PythonInterface/PybindInterface.hpp index 63a9edc2b..126b9a903 100644 --- a/include/NumCpp/PythonInterface/PybindInterface.hpp +++ b/include/NumCpp/PythonInterface/PybindInterface.hpp @@ -55,8 +55,8 @@ namespace nc using pbArrayGeneric = pybind11::array; //============================================================================ - /// converts a numpy array to a numcpp NdArray using pybind bindings - /// Python will still own the underlying data. + /// converts a numpy array to a numcpp NdArray using pybind bindings + /// Python will still own the underlying data. /// /// @param numpyArray /// @@ -92,8 +92,8 @@ namespace nc } //============================================================================ - /// converts a numpy array to a numcpp NdArray using pybind bindings - /// Python will still own the underlying data. + /// converts a numpy array to a numcpp NdArray using pybind bindings + /// Python will still own the underlying data. /// /// @param numpyArray /// @@ -129,7 +129,7 @@ namespace nc } //============================================================================ - /// converts a numcpp NdArray to numpy array using pybind bindings + /// converts a numcpp NdArray to numpy array using pybind bindings /// /// @param inArray: the input array /// @@ -147,7 +147,7 @@ namespace nc } //============================================================================ - /// converts a numcpp NdArray to numpy array using pybind bindings + /// converts a numcpp NdArray to numpy array using pybind bindings /// /// @param inArray: the input array /// @param returnPolicy: the return policy diff --git a/include/NumCpp/Random/bernoilli.hpp b/include/NumCpp/Random/bernoilli.hpp index 2a482d28e..0de5bc30c 100644 --- a/include/NumCpp/Random/bernoilli.hpp +++ b/include/NumCpp/Random/bernoilli.hpp @@ -43,11 +43,11 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "bernoulli" distribution. + /// Single random value sampled from the "bernoulli" distribution. /// /// @param inP (probability of success [0, 1]). Default 0.5 /// @return - /// NdArray + /// NdArray /// inline bool bernoulli(double inP = 0.5) { @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "bernoulli" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "bernoulli" distribution. /// /// @param inShape /// @param inP (probability of success [0, 1]). Default 0.5 /// @return - /// NdArray + /// NdArray /// inline NdArray bernoulli(const Shape& inShape, double inP = 0.5) { diff --git a/include/NumCpp/Random/beta.hpp b/include/NumCpp/Random/beta.hpp index fb6bb68fb..e3090f54d 100644 --- a/include/NumCpp/Random/beta.hpp +++ b/include/NumCpp/Random/beta.hpp @@ -46,7 +46,7 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the from the "beta" distribution. + /// Single random value sampled from the from the "beta" distribution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.beta.html#numpy.random.beta @@ -54,7 +54,7 @@ namespace nc /// @param inAlpha /// @param inBeta /// @return - /// NdArray + /// NdArray /// template dtype beta(dtype inAlpha, dtype inBeta) @@ -77,8 +77,8 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "beta" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "beta" distribution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.beta.html#numpy.random.beta @@ -87,7 +87,7 @@ namespace nc /// @param inAlpha /// @param inBeta /// @return - /// NdArray + /// NdArray /// template NdArray beta(const Shape& inShape, dtype inAlpha, dtype inBeta) diff --git a/include/NumCpp/Random/binomial.hpp b/include/NumCpp/Random/binomial.hpp index 08a996bb5..d5baac131 100644 --- a/include/NumCpp/Random/binomial.hpp +++ b/include/NumCpp/Random/binomial.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the from the "binomial" distribution. + /// Single random value sampled from the from the "binomial" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.binomial.html#numpy.random.binomial + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.binomial.html#numpy.random.binomial /// /// @param inN (number of trials) /// @param inP (probablity of success [0, 1]) /// @return - /// NdArray + /// NdArray /// template dtype binomial(dtype inN, double inP = 0.5) @@ -73,16 +73,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "binomial" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "binomial" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.binomial.html#numpy.random.binomial + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.binomial.html#numpy.random.binomial /// /// @param inShape /// @param inN (number of trials) /// @param inP (probablity of success [0, 1]) /// @return - /// NdArray + /// NdArray /// template NdArray binomial(const Shape& inShape, dtype inN, double inP = 0.5) diff --git a/include/NumCpp/Random/cauchy.hpp b/include/NumCpp/Random/cauchy.hpp index 3c83c38ae..8da95e7f2 100644 --- a/include/NumCpp/Random/cauchy.hpp +++ b/include/NumCpp/Random/cauchy.hpp @@ -43,12 +43,12 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the from the "cauchy" distrubution. + /// Single random value sampled from the from the "cauchy" distrubution. /// /// @param inMean: Mean value of the underlying normal distribution. Default is 0. /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. /// @return - /// NdArray + /// NdArray /// template dtype cauchy(dtype inMean = 0, dtype inSigma = 1) @@ -66,14 +66,14 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "cauchy" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "cauchy" distrubution. /// /// @param inShape /// @param inMean: Mean value of the underlying normal distribution. Default is 0. /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. /// @return - /// NdArray + /// NdArray /// template NdArray cauchy(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1) diff --git a/include/NumCpp/Random/chiSquare.hpp b/include/NumCpp/Random/chiSquare.hpp index d4ff74e8d..13cad910f 100644 --- a/include/NumCpp/Random/chiSquare.hpp +++ b/include/NumCpp/Random/chiSquare.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the from the "chi square" distribution. + /// Single random value sampled from the from the "chi square" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.chisquare.html#numpy.random.chisquare + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.chisquare.html#numpy.random.chisquare /// /// @param inDof (independent random variables) /// @return - /// NdArray + /// NdArray /// template dtype chiSquare(dtype inDof) @@ -67,15 +67,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "chi square" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "chi square" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.chisquare.html#numpy.random.chisquare + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.chisquare.html#numpy.random.chisquare /// /// @param inShape /// @param inDof (independent random variables) /// @return - /// NdArray + /// NdArray /// template NdArray chiSquare(const Shape& inShape, dtype inDof) diff --git a/include/NumCpp/Random/choice.hpp b/include/NumCpp/Random/choice.hpp index c9561549d..69c528515 100644 --- a/include/NumCpp/Random/choice.hpp +++ b/include/NumCpp/Random/choice.hpp @@ -42,11 +42,11 @@ namespace nc { //============================================================================ // Method Description: - /// Chooses a random sample from an input array. + /// Chooses a random sample from an input array. /// /// @param inArray /// @return - /// NdArray + /// NdArray /// template dtype choice(const NdArray& inArray) @@ -57,13 +57,13 @@ namespace nc //============================================================================ // Method Description: - /// Chooses inNum random samples from an input array. + /// Chooses inNum random samples from an input array. /// /// @param inArray /// @param inNum /// @param replace: Whether the sample is with or without replacement /// @return - /// NdArray + /// NdArray /// template NdArray choice(const NdArray& inArray, uint32 inNum, bool replace = true) diff --git a/include/NumCpp/Random/discrete.hpp b/include/NumCpp/Random/discrete.hpp index 74971cc69..b29d17864 100644 --- a/include/NumCpp/Random/discrete.hpp +++ b/include/NumCpp/Random/discrete.hpp @@ -42,14 +42,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the from the - /// "discrete" distrubution. It produces integers in the - /// range [0, n) with the probability of producing each value - /// is specified by the parameters of the distribution. + /// Single random value sampled from the from the + /// "discrete" distrubution. It produces integers in the + /// range [0, n) with the probability of producing each value + /// is specified by the parameters of the distribution. /// - /// @param inWeights + /// @param inWeights /// @return - /// NdArray + /// NdArray /// template dtype discrete(const NdArray& inWeights) @@ -62,16 +62,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "discrete" distrubution. It produces - /// integers in the range [0, n) with the probability of - /// producing each value is specified by the parameters - /// of the distribution. + /// Create an array of the given shape and populate it with + /// random samples from a "discrete" distrubution. It produces + /// integers in the range [0, n) with the probability of + /// producing each value is specified by the parameters + /// of the distribution. /// /// @param inShape - /// @param inWeights + /// @param inWeights /// @return - /// NdArray + /// NdArray /// template NdArray discrete(const Shape& inShape, const NdArray& inWeights) diff --git a/include/NumCpp/Random/exponential.hpp b/include/NumCpp/Random/exponential.hpp index 845c9c207..f39d5af2f 100644 --- a/include/NumCpp/Random/exponential.hpp +++ b/include/NumCpp/Random/exponential.hpp @@ -41,13 +41,13 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "exponential" distrubution. + /// Single random value sampled from the "exponential" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.exponential.html#numpy.random.exponential + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.exponential.html#numpy.random.exponential /// /// @param inScaleValue (default 1) /// @return - /// NdArray + /// NdArray /// template dtype exponential(dtype inScaleValue = 1) @@ -60,15 +60,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "exponential" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "exponential" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.exponential.html#numpy.random.exponential + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.exponential.html#numpy.random.exponential /// /// @param inShape /// @param inScaleValue (default 1) /// @return - /// NdArray + /// NdArray /// template NdArray exponential(const Shape& inShape, dtype inScaleValue = 1) diff --git a/include/NumCpp/Random/extremeValue.hpp b/include/NumCpp/Random/extremeValue.hpp index cf07bbc98..c7b022ec6 100644 --- a/include/NumCpp/Random/extremeValue.hpp +++ b/include/NumCpp/Random/extremeValue.hpp @@ -43,12 +43,12 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "extreme value" distrubution. + /// Single random value sampled from the "extreme value" distrubution. /// /// @param inA (default 1) /// @param inB (default 1) /// @return - /// NdArray + /// NdArray /// template dtype extremeValue(dtype inA = 1, dtype inB = 1) @@ -71,14 +71,14 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "extreme value" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "extreme value" distrubution. /// /// @param inShape /// @param inA (default 1) /// @param inB (default 1) /// @return - /// NdArray + /// NdArray /// template NdArray extremeValue(const Shape& inShape, dtype inA = 1, dtype inB = 1) diff --git a/include/NumCpp/Random/f.hpp b/include/NumCpp/Random/f.hpp index df8f6f333..15e8dd4ae 100644 --- a/include/NumCpp/Random/f.hpp +++ b/include/NumCpp/Random/f.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "F" distrubution. + /// Single random value sampled from the "F" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.f.html#numpy.random.f + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.f.html#numpy.random.f /// /// @param inDofN: Degrees of freedom in numerator. Should be greater than zero. /// @param inDofD: Degrees of freedom in denominator. Should be greater than zero. /// @return - /// NdArray + /// NdArray /// template dtype f(dtype inDofN, dtype inDofD) @@ -73,16 +73,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "F" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "F" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.f.html#numpy.random.f + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.f.html#numpy.random.f /// /// @param inShape /// @param inDofN: Degrees of freedom in numerator. Should be greater than zero. /// @param inDofD: Degrees of freedom in denominator. Should be greater than zero. /// @return - /// NdArray + /// NdArray /// template NdArray f(const Shape& inShape, dtype inDofN, dtype inDofD) diff --git a/include/NumCpp/Random/gamma.hpp b/include/NumCpp/Random/gamma.hpp index f665165a0..01cab9c4a 100644 --- a/include/NumCpp/Random/gamma.hpp +++ b/include/NumCpp/Random/gamma.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "gamma" distrubution. + /// Single random value sampled from the "gamma" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.gamma.html#numpy.random.gamma + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.gamma.html#numpy.random.gamma /// /// @param inGammaShape /// @param inScaleValue (default 1) /// @return - /// NdArray + /// NdArray /// template dtype gamma(dtype inGammaShape, dtype inScaleValue = 1) @@ -73,16 +73,16 @@ namespace nc } //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "gamma" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "gamma" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.gamma.html#numpy.random.gamma + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.gamma.html#numpy.random.gamma /// /// @param inShape /// @param inGammaShape /// @param inScaleValue (default 1) /// @return - /// NdArray + /// NdArray /// template NdArray gamma(const Shape& inShape, dtype inGammaShape, dtype inScaleValue = 1) diff --git a/include/NumCpp/Random/generator.hpp b/include/NumCpp/Random/generator.hpp index 971ea05d1..93d8331bb 100644 --- a/include/NumCpp/Random/generator.hpp +++ b/include/NumCpp/Random/generator.hpp @@ -40,12 +40,12 @@ namespace nc //============================================================================ // Method Description: - /// Seeds the random number generator + /// Seeds the random number generator /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.seed.html#numpy.random.seed + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.seed.html#numpy.random.seed /// /// @param - /// inSeed + /// inSeed /// inline void seed(uint32 inSeed) { diff --git a/include/NumCpp/Random/geometric.hpp b/include/NumCpp/Random/geometric.hpp index 3af486f4f..12ee27584 100644 --- a/include/NumCpp/Random/geometric.hpp +++ b/include/NumCpp/Random/geometric.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "geometric" distrubution. + /// Single random value sampled from the "geometric" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.geometric.html#numpy.random.geometric + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.geometric.html#numpy.random.geometric /// /// @param inP (probablity of success [0, 1]) /// @return - /// NdArray + /// NdArray /// template dtype geometric(double inP = 0.5) @@ -67,15 +67,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "geometric" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "geometric" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.geometric.html#numpy.random.geometric + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.geometric.html#numpy.random.geometric /// /// @param inShape /// @param inP (probablity of success [0, 1]) /// @return - /// NdArray + /// NdArray /// template NdArray geometric(const Shape& inShape, double inP = 0.5) diff --git a/include/NumCpp/Random/laplace.hpp b/include/NumCpp/Random/laplace.hpp index bbbb7abf2..a6700ccff 100644 --- a/include/NumCpp/Random/laplace.hpp +++ b/include/NumCpp/Random/laplace.hpp @@ -44,7 +44,7 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "laplace" distrubution. + /// Single random value sampled from the "laplace" distrubution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.laplace.html#numpy.random.laplace @@ -52,7 +52,7 @@ namespace nc /// @param inLoc: (The position, mu, of the distribution peak. Default is 0) /// @param inScale: (float optional the exponential decay. Default is 1) /// @return - /// NdArray + /// NdArray /// template dtype laplace(dtype inLoc = 0, dtype inScale = 1) @@ -65,8 +65,8 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "laplace" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "laplace" distrubution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.laplace.html#numpy.random.laplace @@ -75,7 +75,7 @@ namespace nc /// @param inLoc: (The position, mu, of the distribution peak. Default is 0) /// @param inScale: (float optional the exponential decay. Default is 1) /// @return - /// NdArray + /// NdArray /// template NdArray laplace(const Shape& inShape, dtype inLoc = 0, dtype inScale = 1) diff --git a/include/NumCpp/Random/lognormal.hpp b/include/NumCpp/Random/lognormal.hpp index a75fef2f3..4cd85d53e 100644 --- a/include/NumCpp/Random/lognormal.hpp +++ b/include/NumCpp/Random/lognormal.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "lognormal" distrubution. + /// Single random value sampled from the "lognormal" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html#numpy.random.lognormal + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html#numpy.random.lognormal /// /// @param inMean: Mean value of the underlying normal distribution. Default is 0. /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. /// @return - /// NdArray + /// NdArray /// template dtype lognormal(dtype inMean = 0, dtype inSigma = 1) @@ -68,16 +68,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "lognormal" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "lognormal" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html#numpy.random.lognormal + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html#numpy.random.lognormal /// /// @param inShape /// @param inMean: Mean value of the underlying normal distribution. Default is 0. /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. /// @return - /// NdArray + /// NdArray /// template NdArray lognormal(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1) diff --git a/include/NumCpp/Random/negativeBinomial.hpp b/include/NumCpp/Random/negativeBinomial.hpp index e9c65cac5..d6cc3deed 100644 --- a/include/NumCpp/Random/negativeBinomial.hpp +++ b/include/NumCpp/Random/negativeBinomial.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "negative Binomial" distribution. + /// Single random value sampled from the "negative Binomial" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.negative_binomial.html#numpy.random.negative_binomial + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.negative_binomial.html#numpy.random.negative_binomial /// /// @param inN: number of trials /// @param inP: probablity of success [0, 1] /// @return - /// NdArray + /// NdArray /// template dtype negativeBinomial(dtype inN, double inP = 0.5) @@ -73,16 +73,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "negative Binomial" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "negative Binomial" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.negative_binomial.html#numpy.random.negative_binomial + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.negative_binomial.html#numpy.random.negative_binomial /// /// @param inShape /// @param inN: number of trials /// @param inP: probablity of success [0, 1] /// @return - /// NdArray + /// NdArray /// template NdArray negativeBinomial(const Shape& inShape, dtype inN, double inP = 0.5) diff --git a/include/NumCpp/Random/nonCentralChiSquared.hpp b/include/NumCpp/Random/nonCentralChiSquared.hpp index 16ec7e68e..36b98780b 100644 --- a/include/NumCpp/Random/nonCentralChiSquared.hpp +++ b/include/NumCpp/Random/nonCentralChiSquared.hpp @@ -46,7 +46,7 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "non central chi squared" distrubution. + /// Single random value sampled from the "non central chi squared" distrubution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.noncentral_chisquare.html#numpy.random.noncentral_chisquare @@ -54,7 +54,7 @@ namespace nc /// @param inK (default 1) /// @param inLambda (default 1) /// @return - /// NdArray + /// NdArray /// template dtype nonCentralChiSquared(dtype inK = 1, dtype inLambda = 1) @@ -77,8 +77,8 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "non central chi squared" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "non central chi squared" distrubution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.noncentral_chisquare.html#numpy.random.noncentral_chisquare @@ -87,7 +87,7 @@ namespace nc /// @param inK (default 1) /// @param inLambda (default 1) /// @return - /// NdArray + /// NdArray /// template NdArray nonCentralChiSquared(const Shape& inShape, dtype inK = 1, dtype inLambda = 1) diff --git a/include/NumCpp/Random/normal.hpp b/include/NumCpp/Random/normal.hpp index d924567dd..179a1a4a1 100644 --- a/include/NumCpp/Random/normal.hpp +++ b/include/NumCpp/Random/normal.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "normal" distrubution. + /// Single random value sampled from the "normal" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.normal.html#numpy.random.normal + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.normal.html#numpy.random.normal /// /// @param inMean: Mean value of the underlying normal distribution. Default is 0. /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. /// @return - /// NdArray + /// NdArray /// template dtype normal(dtype inMean = 0, dtype inSigma = 1) @@ -68,16 +68,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "normal" distrubution. + /// Create an array of the given shape and populate it with + /// random samples from a "normal" distrubution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.normal.html#numpy.random.normal + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.normal.html#numpy.random.normal /// /// @param inShape /// @param inMean: Mean value of the underlying normal distribution. Default is 0. /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. /// @return - /// NdArray + /// NdArray /// template NdArray normal(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1) diff --git a/include/NumCpp/Random/permutation.hpp b/include/NumCpp/Random/permutation.hpp index 4c7b4a4e0..9e4c43609 100644 --- a/include/NumCpp/Random/permutation.hpp +++ b/include/NumCpp/Random/permutation.hpp @@ -39,14 +39,14 @@ namespace nc { //============================================================================ // Method Description: - /// Randomly permute a sequence, or return a permuted range. - /// If x is an integer, randomly permute np.arange(x). - /// If x is an array, make a copy and shuffle the elements randomly. + /// Randomly permute a sequence, or return a permuted range. + /// If x is an integer, randomly permute np.arange(x). + /// If x is an array, make a copy and shuffle the elements randomly. /// /// @param - /// inValue + /// inValue /// @return - /// NdArray + /// NdArray /// template NdArray permutation(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// Randomly permute a sequence, or return a permuted range. - /// If x is an integer, randomly permute np.arange(x). - /// If x is an array, make a copy and shuffle the elements randomly. + /// Randomly permute a sequence, or return a permuted range. + /// If x is an integer, randomly permute np.arange(x). + /// If x is an array, make a copy and shuffle the elements randomly. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template NdArray permutation(const NdArray& inArray) diff --git a/include/NumCpp/Random/poisson.hpp b/include/NumCpp/Random/poisson.hpp index d92872795..e0f0d979f 100644 --- a/include/NumCpp/Random/poisson.hpp +++ b/include/NumCpp/Random/poisson.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "poisson" distribution. + /// Single random value sampled from the "poisson" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.poisson.html#numpy.random.poisson + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.poisson.html#numpy.random.poisson /// /// @param inMean (default 1) /// @return - /// NdArray + /// NdArray /// template dtype poisson(double inMean = 1) @@ -67,15 +67,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "poisson" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "poisson" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.poisson.html#numpy.random.poisson + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.poisson.html#numpy.random.poisson /// /// @param inShape /// @param inMean (default 1) /// @return - /// NdArray + /// NdArray /// template NdArray poisson(const Shape& inShape, double inMean = 1) diff --git a/include/NumCpp/Random/rand.hpp b/include/NumCpp/Random/rand.hpp index cb6eb5397..fcb1e354b 100644 --- a/include/NumCpp/Random/rand.hpp +++ b/include/NumCpp/Random/rand.hpp @@ -24,7 +24,7 @@ /// /// Description /// Create an array of the given shape and populate it with -/// random samples from a uniform distribution over [0, 1). +/// random samples from a uniform distribution over [0, 1). /// #pragma once @@ -42,12 +42,12 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the uniform distribution over [0, 1). + /// Single random value sampled from the uniform distribution over [0, 1). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand /// /// @return - /// NdArray + /// NdArray /// template dtype rand() @@ -61,15 +61,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a uniform distribution over [0, 1). + /// Create an array of the given shape and populate it with + /// random samples from a uniform distribution over [0, 1). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// template NdArray rand(const Shape& inShape) diff --git a/include/NumCpp/Random/randFloat.hpp b/include/NumCpp/Random/randFloat.hpp index 741fcb7f9..a7d814eba 100644 --- a/include/NumCpp/Random/randFloat.hpp +++ b/include/NumCpp/Random/randFloat.hpp @@ -24,7 +24,7 @@ /// /// Description /// Return random floats from low (inclusive) to high (exclusive), -/// with the given shape +/// with the given shape /// #pragma once @@ -45,16 +45,16 @@ namespace nc { //============================================================================ // Method Description: - /// Return a single random float from low (inclusive) to high (exclusive), - /// with the given shape. If no high value is input then the range will - /// go from [0, low). + /// Return a single random float from low (inclusive) to high (exclusive), + /// with the given shape. If no high value is input then the range will + /// go from [0, low). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.ranf.html#numpy.random.ranf + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.ranf.html#numpy.random.ranf /// /// @param inLow /// @param inHigh default 0. /// @return - /// NdArray + /// NdArray /// template dtype randFloat(dtype inLow, dtype inHigh = 0.0) @@ -76,17 +76,17 @@ namespace nc //============================================================================ // Method Description: - /// Return random floats from low (inclusive) to high (exclusive), - /// with the given shape. If no high value is input then the range will - /// go from [0, low). + /// Return random floats from low (inclusive) to high (exclusive), + /// with the given shape. If no high value is input then the range will + /// go from [0, low). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.ranf.html#numpy.random.ranf + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.ranf.html#numpy.random.ranf /// /// @param inShape /// @param inLow /// @param inHigh default 0. /// @return - /// NdArray + /// NdArray /// template NdArray randFloat(const Shape& inShape, dtype inLow, dtype inHigh = 0.0) diff --git a/include/NumCpp/Random/randInt.hpp b/include/NumCpp/Random/randInt.hpp index 7d80cd34c..0257661ac 100644 --- a/include/NumCpp/Random/randInt.hpp +++ b/include/NumCpp/Random/randInt.hpp @@ -25,7 +25,7 @@ /// /// Description /// Return random integers from low (inclusive) to high (exclusive), -/// with the given shape +/// with the given shape /// #pragma once @@ -45,16 +45,16 @@ namespace nc { //============================================================================ // Method Description: - /// Return random integer from low (inclusive) to high (exclusive), - /// with the given shape. If no high value is input then the range will - /// go from [0, low). + /// Return random integer from low (inclusive) to high (exclusive), + /// with the given shape. If no high value is input then the range will + /// go from [0, low). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html#numpy.random.randint + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html#numpy.random.randint /// /// @param inLow /// @param inHigh default 0. /// @return - /// NdArray + /// NdArray /// template dtype randInt(dtype inLow, dtype inHigh = 0) @@ -76,17 +76,17 @@ namespace nc //============================================================================ // Method Description: - /// Return random integers from low (inclusive) to high (exclusive), - /// with the given shape. If no high value is input then the range will - /// go from [0, low). + /// Return random integers from low (inclusive) to high (exclusive), + /// with the given shape. If no high value is input then the range will + /// go from [0, low). /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html#numpy.random.randint + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html#numpy.random.randint /// /// @param inShape /// @param inLow /// @param inHigh default 0. /// @return - /// NdArray + /// NdArray /// template NdArray randInt(const Shape& inShape, dtype inLow, dtype inHigh = 0) diff --git a/include/NumCpp/Random/randN.hpp b/include/NumCpp/Random/randN.hpp index 2920e6d65..009668e84 100644 --- a/include/NumCpp/Random/randN.hpp +++ b/include/NumCpp/Random/randN.hpp @@ -41,9 +41,9 @@ namespace nc { //============================================================================ // Method Description: - /// Returns a single random value sampled from the "standard normal" distribution. + /// Returns a single random value sampled from the "standard normal" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn /// /// @return dtype /// @@ -58,15 +58,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "standard normal" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "standard normal" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// template NdArray randN(const Shape& inShape) diff --git a/include/NumCpp/Random/shuffle.hpp b/include/NumCpp/Random/shuffle.hpp index 9ef259d9a..e312dcfb3 100644 --- a/include/NumCpp/Random/shuffle.hpp +++ b/include/NumCpp/Random/shuffle.hpp @@ -39,10 +39,10 @@ namespace nc { //============================================================================ // Method Description: - /// Modify a sequence in-place by shuffling its contents. + /// Modify a sequence in-place by shuffling its contents. /// /// @param - /// inArray + /// inArray /// template void shuffle(NdArray& inArray) diff --git a/include/NumCpp/Random/standardNormal.hpp b/include/NumCpp/Random/standardNormal.hpp index 05b409fb4..47bf72b8d 100644 --- a/include/NumCpp/Random/standardNormal.hpp +++ b/include/NumCpp/Random/standardNormal.hpp @@ -38,13 +38,13 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "standard normal" distrubution with - /// mean = 0 and std = 1 + /// Single random value sampled from the "standard normal" distrubution with + /// mean = 0 and std = 1 /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_normal.html#numpy.random.standard_normal + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_normal.html#numpy.random.standard_normal /// /// @return - /// NdArray + /// NdArray /// template dtype standardNormal() @@ -56,16 +56,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from a "standard normal" distrubution with - /// mean = 0 and std = 1 + /// Create an array of the given shape and populate it with + /// random samples from a "standard normal" distrubution with + /// mean = 0 and std = 1 /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_normal.html#numpy.random.standard_normal + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_normal.html#numpy.random.standard_normal /// /// @param - /// inShape + /// inShape /// @return - /// NdArray + /// NdArray /// template NdArray standardNormal(const Shape& inShape) diff --git a/include/NumCpp/Random/studentT.hpp b/include/NumCpp/Random/studentT.hpp index 66744bb16..ba7e3438b 100644 --- a/include/NumCpp/Random/studentT.hpp +++ b/include/NumCpp/Random/studentT.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "student-T" distribution. + /// Single random value sampled from the "student-T" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_t.html#numpy.random.standard_t + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_t.html#numpy.random.standard_t /// /// @param inDof independent random variables /// @return - /// NdArray + /// NdArray /// template dtype studentT(dtype inDof) @@ -67,15 +67,15 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "student-T" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "student-T" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_t.html#numpy.random.standard_t + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_t.html#numpy.random.standard_t /// /// @param inShape /// @param inDof independent random variables /// @return - /// NdArray + /// NdArray /// template NdArray studentT(const Shape& inShape, dtype inDof) diff --git a/include/NumCpp/Random/triangle.hpp b/include/NumCpp/Random/triangle.hpp index 5c7e152c7..cba8c6183 100644 --- a/include/NumCpp/Random/triangle.hpp +++ b/include/NumCpp/Random/triangle.hpp @@ -24,7 +24,7 @@ /// /// Description /// Create an array of the given shape and populate it with -/// random samples from the "triangle" distribution. +/// random samples from the "triangle" distribution. /// #pragma once @@ -47,7 +47,7 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "triangle" distribution. + /// Single random value sampled from the "triangle" distribution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.triangular.html#numpy.random.triangular @@ -56,7 +56,7 @@ namespace nc /// @param inB /// @param inC /// @return - /// NdArray + /// NdArray /// template dtype triangle(dtype inA = 0, dtype inB = 0.5, dtype inC = 1) @@ -91,8 +91,8 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "triangle" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "triangle" distribution. /// NOTE: Use of this function requires using the Boost includes. /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.triangular.html#numpy.random.triangular @@ -102,7 +102,7 @@ namespace nc /// @param inB /// @param inC /// @return - /// NdArray + /// NdArray /// template NdArray triangle(const Shape& inShape, dtype inA = 0, dtype inB = 0.5, dtype inC = 1) diff --git a/include/NumCpp/Random/uniform.hpp b/include/NumCpp/Random/uniform.hpp index 00787ad37..cd3e025ad 100644 --- a/include/NumCpp/Random/uniform.hpp +++ b/include/NumCpp/Random/uniform.hpp @@ -37,17 +37,17 @@ namespace nc { //============================================================================ // Method Description: - /// Draw sample from a uniform distribution. + /// Draw sample from a uniform distribution. /// - /// Samples are uniformly distributed over the half - - /// open interval[low, high) (includes low, but excludes high) + /// Samples are uniformly distributed over the half - + /// open interval[low, high) (includes low, but excludes high) /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.uniform.html#numpy.random.uniform + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.uniform.html#numpy.random.uniform /// /// @param inLow /// @param inHigh /// @return - /// NdArray + /// NdArray /// template dtype uniform(dtype inLow, dtype inHigh) @@ -59,18 +59,18 @@ namespace nc //============================================================================ // Method Description: - /// Draw samples from a uniform distribution. + /// Draw samples from a uniform distribution. /// - /// Samples are uniformly distributed over the half - - /// open interval[low, high) (includes low, but excludes high) + /// Samples are uniformly distributed over the half - + /// open interval[low, high) (includes low, but excludes high) /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.uniform.html#numpy.random.uniform + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.uniform.html#numpy.random.uniform /// /// @param inShape /// @param inLow /// @param inHigh /// @return - /// NdArray + /// NdArray /// template NdArray uniform(const Shape& inShape, dtype inLow, dtype inHigh) diff --git a/include/NumCpp/Random/uniformOnSphere.hpp b/include/NumCpp/Random/uniformOnSphere.hpp index d6167c65b..c46c08c50 100644 --- a/include/NumCpp/Random/uniformOnSphere.hpp +++ b/include/NumCpp/Random/uniformOnSphere.hpp @@ -24,7 +24,7 @@ /// /// Description /// Such a distribution produces random numbers uniformly -/// distributed on the unit sphere of arbitrary dimension dim. +/// distributed on the unit sphere of arbitrary dimension dim. /// #pragma once @@ -47,14 +47,14 @@ namespace nc { //============================================================================ // Method Description: - /// Such a distribution produces random numbers uniformly - /// distributed on the unit sphere of arbitrary dimension dim. + /// Such a distribution produces random numbers uniformly + /// distributed on the unit sphere of arbitrary dimension dim. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inNumPoints /// @param inDims: dimension of the sphere (default 2) /// @return - /// NdArray + /// NdArray /// template NdArray uniformOnSphere(uint32 inNumPoints, uint32 inDims = 2) diff --git a/include/NumCpp/Random/weibull.hpp b/include/NumCpp/Random/weibull.hpp index c6d341cbc..ac8272747 100644 --- a/include/NumCpp/Random/weibull.hpp +++ b/include/NumCpp/Random/weibull.hpp @@ -43,14 +43,14 @@ namespace nc { //============================================================================ // Method Description: - /// Single random value sampled from the "weibull" distribution. + /// Single random value sampled from the "weibull" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.weibull.html#numpy.random.weibull + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.weibull.html#numpy.random.weibull /// /// @param inA (default 1) /// @param inB (default 1) /// @return - /// NdArray + /// NdArray /// template dtype weibull(dtype inA = 1, dtype inB = 1) @@ -73,16 +73,16 @@ namespace nc //============================================================================ // Method Description: - /// Create an array of the given shape and populate it with - /// random samples from the "weibull" distribution. + /// Create an array of the given shape and populate it with + /// random samples from the "weibull" distribution. /// - /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.weibull.html#numpy.random.weibull + /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.weibull.html#numpy.random.weibull /// /// @param inShape /// @param inA (default 1) /// @param inB (default 1) /// @return - /// NdArray + /// NdArray /// template NdArray weibull(const Shape& inShape, dtype inA = 1, dtype inB = 1) diff --git a/include/NumCpp/Roots/Bisection.hpp b/include/NumCpp/Roots/Bisection.hpp index 6a4fa851e..c9f4e40a4 100644 --- a/include/NumCpp/Roots/Bisection.hpp +++ b/include/NumCpp/Roots/Bisection.hpp @@ -44,14 +44,14 @@ namespace nc { //================================================================================ // Class Description: - /// Bisection root finding method + /// Bisection root finding method /// class Bisection : public Iteration { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param f: the function @@ -64,7 +64,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param maxNumIterations: the maximum number of iterations to perform @@ -79,13 +79,13 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// ~Bisection() override = default; //============================================================================ // Method Description: - /// Solves for the root in the range [a, b] + /// Solves for the root in the range [a, b] /// /// @param a: the lower bound /// @param b: the upper bound @@ -116,7 +116,7 @@ namespace nc //============================================================================ // Method Description: - /// Checks the bounds criteria + /// Checks the bounds criteria /// /// @param a: the lower bound /// @param b: the upper bound @@ -132,7 +132,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the bisection point + /// Calculates the bisection point /// /// @param x: the evaluation point /// @param a: the lower bound diff --git a/include/NumCpp/Roots/Brent.hpp b/include/NumCpp/Roots/Brent.hpp index e6cffbd26..bd79a2357 100644 --- a/include/NumCpp/Roots/Brent.hpp +++ b/include/NumCpp/Roots/Brent.hpp @@ -45,14 +45,14 @@ namespace nc { //================================================================================ // Class Description: - /// Brent root finding method + /// Brent root finding method /// class Brent : public Iteration { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param f: the function @@ -65,7 +65,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param maxNumIterations: the maximum number of iterations to perform @@ -80,13 +80,13 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// ~Brent() override = default; //============================================================================ // Method Description: - /// Solves for the root in the range [a, b] + /// Solves for the root in the range [a, b] /// /// @param a: the lower bound /// @param b: the upper bound @@ -158,7 +158,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the bisection point + /// Calculates the bisection point /// /// @param a: the lower bound /// @param b: the upper bound @@ -171,7 +171,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the secant point + /// Calculates the secant point /// /// @param a: the lower bound /// @param b: the upper bound @@ -187,7 +187,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates the inverse quadratic interpolation + /// Calculates the inverse quadratic interpolation /// /// @param a: the lower bound /// @param b: the upper bound @@ -207,7 +207,7 @@ namespace nc //============================================================================ // Method Description: - /// Uses the inverse quadratic interpolation + /// Uses the inverse quadratic interpolation /// /// @param fa: the function evaluated at a /// @param fb: the function evaluated at b @@ -221,7 +221,7 @@ namespace nc //============================================================================ // Method Description: - /// Checks the algorithm criteria + /// Checks the algorithm criteria /// /// @param a: the lower bound /// @param b: the upper bound @@ -240,7 +240,7 @@ namespace nc //============================================================================ // Method Description: - /// Uses the bisection + /// Uses the bisection /// /// @param bisection: the bisection point /// @param b: the upper bound diff --git a/include/NumCpp/Roots/Dekker.hpp b/include/NumCpp/Roots/Dekker.hpp index 6b372ebb3..294a9e838 100644 --- a/include/NumCpp/Roots/Dekker.hpp +++ b/include/NumCpp/Roots/Dekker.hpp @@ -44,14 +44,14 @@ namespace nc { //================================================================================ // Class Description: - /// Dekker root finding method + /// Dekker root finding method /// class Dekker : public Iteration { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param f: the function @@ -64,7 +64,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param maxNumIterations: the maximum number of iterations to perform @@ -79,13 +79,13 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// ~Dekker() override = default; //============================================================================ // Method Description: - /// Solves for the root in the range [a, b] + /// Solves for the root in the range [a, b] /// /// @param a: the lower bound /// @param b: the upper bound @@ -135,7 +135,7 @@ namespace nc //============================================================================ // Method Description: - /// Checks the bounds criteria + /// Checks the bounds criteria /// /// @param a: the lower bound /// @param b: the upper bound @@ -154,7 +154,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates secant + /// Calculates secant /// /// @param b: the upper bound /// @param fb: the function evalulated at the upper bound @@ -170,7 +170,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculate the bisection point + /// Calculate the bisection point /// /// @param a: the lower bound /// @param b: the upper bound @@ -183,7 +183,7 @@ namespace nc //============================================================================ // Method Description: - /// Whether or not to use the secant method + /// Whether or not to use the secant method /// /// @param b: the upper bound /// @param s: diff --git a/include/NumCpp/Roots/Iteration.hpp b/include/NumCpp/Roots/Iteration.hpp index 4ebef991f..82b75162a 100644 --- a/include/NumCpp/Roots/Iteration.hpp +++ b/include/NumCpp/Roots/Iteration.hpp @@ -42,13 +42,13 @@ namespace nc { //================================================================================ // Class Description: - /// ABC for iteration classes to derive from + /// ABC for iteration classes to derive from class Iteration { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @@ -58,7 +58,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param maxNumIterations: the maximum number of iterations to perform @@ -70,13 +70,13 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// virtual ~Iteration() noexcept = default; //============================================================================ // Method Description: - /// Returns the number of iterations + /// Returns the number of iterations /// /// @return: number of iterations /// @@ -88,7 +88,7 @@ namespace nc protected: //============================================================================ // Method Description: - /// Resets the number of iterations + /// Resets the number of iterations /// void resetNumberOfIterations() noexcept { @@ -97,7 +97,7 @@ namespace nc //============================================================================ // Method Description: - /// Incraments the number of iterations + /// Incraments the number of iterations /// /// @return the number of iterations prior to incramenting /// diff --git a/include/NumCpp/Roots/Newton.hpp b/include/NumCpp/Roots/Newton.hpp index 32aba7603..a6b63b32a 100644 --- a/include/NumCpp/Roots/Newton.hpp +++ b/include/NumCpp/Roots/Newton.hpp @@ -44,14 +44,14 @@ namespace nc { //================================================================================ // Class Description: - /// Newton root finding method + /// Newton root finding method /// class Newton : public Iteration { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param f: the function @@ -67,7 +67,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param maxNumIterations: the maximum number of iterations to perform @@ -85,13 +85,13 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// ~Newton()noexcept override = default; //============================================================================ // Method Description: - /// Solves for the root in the range [a, b] + /// Solves for the root in the range [a, b] /// /// @param x: the starting point /// @return root nearest the starting point @@ -123,7 +123,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates x + /// Calculates x /// /// @param x: the current x value /// @param fx: the function evaluated at the current x value diff --git a/include/NumCpp/Roots/Secant.hpp b/include/NumCpp/Roots/Secant.hpp index 95730905d..04187abbb 100644 --- a/include/NumCpp/Roots/Secant.hpp +++ b/include/NumCpp/Roots/Secant.hpp @@ -45,14 +45,14 @@ namespace nc { //================================================================================ // Class Description: - /// Secant root finding method + /// Secant root finding method /// class Secant : public Iteration { public: //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param f: the function @@ -65,7 +65,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param epsilon: the epsilon value /// @param maxNumIterations: the maximum number of iterations to perform @@ -80,13 +80,13 @@ namespace nc //============================================================================ // Method Description: - /// Destructor + /// Destructor /// ~Secant() override = default; //============================================================================ // Method Description: - /// Solves for the root in the range [a, b] + /// Solves for the root in the range [a, b] /// /// @param a: the lower bound /// @param b: the upper bound @@ -128,7 +128,7 @@ namespace nc //============================================================================ // Method Description: - /// Calculates x + /// Calculates x /// /// @param x: the current x value /// @param lastX: the previous x value diff --git a/include/NumCpp/Rotations/DCM.hpp b/include/NumCpp/Rotations/DCM.hpp index 43012b079..027f1ad4c 100644 --- a/include/NumCpp/Rotations/DCM.hpp +++ b/include/NumCpp/Rotations/DCM.hpp @@ -46,14 +46,14 @@ namespace nc public: //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates according - /// to the input euler angles + /// returns a direction cosine matrix that rotates according + /// to the input euler angles /// /// @param roll: euler roll angle in radians /// @param pitch: euler pitch angle in radians /// @param yaw: euler yaw angle in radians /// @return - /// NdArray + /// NdArray /// static NdArray eulerAngles(double roll, double pitch, double yaw) { @@ -62,12 +62,12 @@ namespace nc //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates according - /// to the input euler angles + /// returns a direction cosine matrix that rotates according + /// to the input euler angles /// /// @param angles: euler roll, pitch, angles /// @return - /// NdArray + /// NdArray /// static NdArray eulerAngles(const NdArray& angles) { @@ -76,13 +76,13 @@ namespace nc //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates about - /// the input axis by the input angle + /// returns a direction cosine matrix that rotates about + /// the input axis by the input angle /// /// @param inAxis: euler axis cartesian vector with x,y,z components /// @param inAngle: euler angle in radians /// @return - /// NdArray + /// NdArray /// static NdArray eulerAxisAngle(const NdArray& inAxis, double inAngle) { @@ -91,13 +91,13 @@ namespace nc //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates about - /// the input axis by the input angle + /// returns a direction cosine matrix that rotates about + /// the input axis by the input angle /// /// @param inAxis: euler axis cartesian vector with x,y,z components /// @param inAngle: euler angle in radians /// @return - /// NdArray + /// NdArray /// static NdArray eulerAxisAngle(const Vec3& inAxis, double inAngle) { @@ -106,13 +106,13 @@ namespace nc //============================================================================ // Method Description: - /// returns whether the input array is a direction cosine - /// matrix + /// returns whether the input array is a direction cosine + /// matrix /// /// @param - /// inArray + /// inArray /// @return - /// bool + /// bool /// static bool isValid(const NdArray& inArray) { @@ -124,7 +124,7 @@ namespace nc //============================================================================ // Method Description: - /// The euler roll angle in radians + /// The euler roll angle in radians /// /// @param dcm: a valid direction cosine matrix /// @return euler roll angle in radians @@ -136,7 +136,7 @@ namespace nc //============================================================================ // Method Description: - /// The euler pitch angle in radians + /// The euler pitch angle in radians /// /// @param dcm: a valid direction cosine matrix /// @return euler pitch angle in radians @@ -148,7 +148,7 @@ namespace nc //============================================================================ // Method Description: - /// The euler yaw angle in radians + /// The euler yaw angle in radians /// /// @param dcm: a valid direction cosine matrix /// @return euler yaw angle in radians @@ -160,13 +160,13 @@ namespace nc //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates about - /// the x axis by the input angle + /// returns a direction cosine matrix that rotates about + /// the x axis by the input angle /// /// @param - /// inAngle (in radians) + /// inAngle (in radians) /// @return - /// NdArray + /// NdArray /// static NdArray xRotation(double inAngle) { @@ -175,13 +175,13 @@ namespace nc //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates about - /// the x axis by the input angle + /// returns a direction cosine matrix that rotates about + /// the x axis by the input angle /// /// @param - /// inAngle (in radians) + /// inAngle (in radians) /// @return - /// NdArray + /// NdArray /// static NdArray yRotation(double inAngle) { @@ -190,13 +190,13 @@ namespace nc //============================================================================ // Method Description: - /// returns a direction cosine matrix that rotates about - /// the x axis by the input angle + /// returns a direction cosine matrix that rotates about + /// the x axis by the input angle /// /// @param - /// inAngle (in radians) + /// inAngle (in radians) /// @return - /// NdArray + /// NdArray /// static NdArray zRotation(double inAngle) { diff --git a/include/NumCpp/Rotations/Quaternion.hpp b/include/NumCpp/Rotations/Quaternion.hpp index 0e2275717..615f4dcef 100644 --- a/include/NumCpp/Rotations/Quaternion.hpp +++ b/include/NumCpp/Rotations/Quaternion.hpp @@ -53,19 +53,19 @@ namespace nc { //================================================================================ // Class Description: - /// Holds a unit quaternion + /// Holds a unit quaternion class Quaternion { public: //============================================================================ // Method Description: - /// Default Constructor + /// Default Constructor /// Quaternion() = default; //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param roll: euler roll angle in radians /// @param pitch: euler pitch angle in radians @@ -78,7 +78,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inI /// @param inJ @@ -93,11 +93,11 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inArray: if size = 3 the roll, pitch, yaw euler angles - /// if size = 4 the i, j, k, s components - /// if shape = [3, 3] then direction cosine matrix + /// if size = 4 the i, j, k, s components + /// if shape = [3, 3] then direction cosine matrix /// Quaternion(const NdArray& inArray) : components_{ 0.0, 0.0, 0.0, 0.0 } @@ -126,7 +126,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inAxis: Euler axis /// @param inAngle: Euler angle in radians @@ -147,7 +147,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inAxis: Euler axis x,y,z vector components /// @param inAngle: Euler angle in radians @@ -158,14 +158,14 @@ namespace nc //============================================================================ // Method Description: - /// angular velocity vector between the two quaternions. The norm - /// of the array is the magnitude + /// angular velocity vector between the two quaternions. The norm + /// of the array is the magnitude /// /// @param inQuat1 /// @param inQuat2 /// @param inTime (seperation time) /// @return - /// NdArray + /// NdArray /// static NdArray angularVelocity(const Quaternion& inQuat1, const Quaternion& inQuat2, double inTime) { @@ -194,13 +194,13 @@ namespace nc //============================================================================ // Method Description: - /// angular velocity vector between the two quaternions. The norm - /// of the array is the magnitude + /// angular velocity vector between the two quaternions. The norm + /// of the array is the magnitude /// /// @param inQuat2 /// @param inTime (seperation time) /// @return - /// NdArray + /// NdArray /// NdArray angularVelocity(const Quaternion& inQuat2, double inTime) const { @@ -209,10 +209,10 @@ namespace nc //============================================================================ // Method Description: - /// quaternion conjugate + /// quaternion conjugate /// /// @return - /// Quaternion + /// Quaternion /// Quaternion conjugate() const noexcept { @@ -221,10 +221,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the i component + /// returns the i component /// /// @return - /// double + /// double /// double i() const noexcept { @@ -233,10 +233,10 @@ namespace nc //============================================================================ // Method Description: - /// quaternion identity (0,0,0,1) + /// quaternion identity (0,0,0,1) /// /// @return - /// Quaternion + /// Quaternion /// static Quaternion identity() noexcept { @@ -245,10 +245,10 @@ namespace nc //============================================================================ // Method Description: - /// quaternion inverse + /// quaternion inverse /// /// @return - /// Quaterion + /// Quaterion /// Quaternion inverse() const noexcept { @@ -258,10 +258,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the j component + /// returns the j component /// /// @return - /// double + /// double /// double j() const noexcept { @@ -270,10 +270,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the k component + /// returns the k component /// /// @return - /// double + /// double /// double k() const noexcept { @@ -282,13 +282,13 @@ namespace nc //============================================================================ // Method Description: - /// linearly interpolates between the two quaternions + /// linearly interpolates between the two quaternions /// /// @param inQuat1 /// @param inQuat2 /// @param inPercent [0, 1] /// @return - /// Quaternion + /// Quaternion /// static Quaternion nlerp(const Quaternion& inQuat1, const Quaternion& inQuat2, double inPercent) { @@ -321,12 +321,12 @@ namespace nc //============================================================================ // Method Description: - /// linearly interpolates between the two quaternions + /// linearly interpolates between the two quaternions /// /// @param inQuat2 /// @param inPercent (0, 1) /// @return - /// Quaternion + /// Quaternion /// Quaternion nlerp(const Quaternion& inQuat2, double inPercent) const { @@ -335,7 +335,7 @@ namespace nc //============================================================================ // Method Description: - /// The euler pitch angle in radians + /// The euler pitch angle in radians /// /// @return euler pitch angle in radians /// @@ -346,7 +346,7 @@ namespace nc //============================================================================ // Method Description: - /// prints the Quaternion to the console + /// prints the Quaternion to the console /// void print() const { @@ -355,7 +355,7 @@ namespace nc //============================================================================ // Method Description: - /// The euler roll angle in radians + /// The euler roll angle in radians /// /// @return euler roll angle in radians /// @@ -367,12 +367,12 @@ namespace nc //============================================================================ // Method Description: - /// rotate a vector using the quaternion + /// rotate a vector using the quaternion /// /// @param - /// inVector (cartesian vector with x,y,z components) + /// inVector (cartesian vector with x,y,z components) /// @return - /// NdArray (cartesian vector with x,y,z components) + /// NdArray (cartesian vector with x,y,z components) /// NdArray rotate(const NdArray& inVector) const { @@ -386,12 +386,12 @@ namespace nc //============================================================================ // Method Description: - /// rotate a vector using the quaternion + /// rotate a vector using the quaternion /// /// @param - /// inVec3 + /// inVec3 /// @return - /// Vec3 + /// Vec3 /// Vec3 rotate(const Vec3& inVec3) const { @@ -400,10 +400,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the s component + /// returns the s component /// /// @return - /// double + /// double /// double s() const noexcept { @@ -412,13 +412,13 @@ namespace nc //============================================================================ // Method Description: - /// spherical linear interpolates between the two quaternions + /// spherical linear interpolates between the two quaternions /// /// @param inQuat1 /// @param inQuat2 /// @param inPercent (0, 1) /// @return - /// Quaternion + /// Quaternion /// static Quaternion slerp(const Quaternion& inQuat1, const Quaternion& inQuat2, double inPercent) { @@ -468,12 +468,12 @@ namespace nc //============================================================================ // Method Description: - /// spherical linear interpolates between the two quaternions + /// spherical linear interpolates between the two quaternions /// /// @param inQuat2 /// @param inPercent (0, 1) /// @return - /// Quaternion + /// Quaternion /// Quaternion slerp(const Quaternion& inQuat2, double inPercent) const { @@ -482,10 +482,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the quaternion as a string representation + /// returns the quaternion as a string representation /// /// @return - /// std::string + /// std::string /// std::string str() const { @@ -497,10 +497,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the direction cosine matrix + /// returns the direction cosine matrix /// /// @return - /// NdArray + /// NdArray /// NdArray toDCM() const { @@ -531,10 +531,10 @@ namespace nc //============================================================================ // Method Description: - /// returns the quaternion as an NdArray + /// returns the quaternion as an NdArray /// /// @return - /// NdArray + /// NdArray /// NdArray toNdArray() const { @@ -544,12 +544,12 @@ namespace nc //============================================================================ // Method Description: - /// returns a quaternion to rotate about the x-axis by the input angle + /// returns a quaternion to rotate about the x-axis by the input angle /// /// @param - /// inAngle (radians) + /// inAngle (radians) /// @return - /// Quaternion + /// Quaternion /// static Quaternion xRotation(double inAngle) noexcept { @@ -559,7 +559,7 @@ namespace nc //============================================================================ // Method Description: - /// The euler yaw angle in radians + /// The euler yaw angle in radians /// /// @return euler yaw angle in radians /// @@ -571,12 +571,12 @@ namespace nc //============================================================================ // Method Description: - /// returns a quaternion to rotate about the y-axis by the input angle + /// returns a quaternion to rotate about the y-axis by the input angle /// /// @param - /// inAngle (radians) + /// inAngle (radians) /// @return - /// Quaternion + /// Quaternion /// static Quaternion yRotation(double inAngle) noexcept { @@ -586,12 +586,12 @@ namespace nc //============================================================================ // Method Description: - /// returns a quaternion to rotate about the y-axis by the input angle + /// returns a quaternion to rotate about the y-axis by the input angle /// /// @param - /// inAngle (radians) + /// inAngle (radians) /// @return - /// Quaternion + /// Quaternion /// static Quaternion zRotation(double inAngle) noexcept { @@ -601,12 +601,12 @@ namespace nc //============================================================================ // Method Description: - /// equality operator + /// equality operator /// /// @param - /// inRhs + /// inRhs /// @return - /// bool + /// bool /// bool operator==(const Quaternion& inRhs) const noexcept { @@ -621,12 +621,12 @@ namespace nc //============================================================================ // Method Description: - /// equality operator + /// equality operator /// /// @param - /// inRhs + /// inRhs /// @return - /// bool + /// bool /// bool operator!=(const Quaternion& inRhs) const noexcept { @@ -635,12 +635,12 @@ namespace nc //============================================================================ // Method Description: - /// addition assignment operator + /// addition assignment operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion& operator+=(const Quaternion& inRhs) noexcept { @@ -654,12 +654,12 @@ namespace nc //============================================================================ // Method Description: - /// addition operator + /// addition operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion operator+(const Quaternion& inRhs) const noexcept { @@ -668,12 +668,12 @@ namespace nc //============================================================================ // Method Description: - /// subtraction assignment operator + /// subtraction assignment operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion& operator-=(const Quaternion& inRhs) noexcept { @@ -687,12 +687,12 @@ namespace nc //============================================================================ // Method Description: - /// subtraction operator + /// subtraction operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion operator-(const Quaternion& inRhs) const noexcept { @@ -701,10 +701,10 @@ namespace nc //============================================================================ // Method Description: - /// negative operator + /// negative operator /// /// @return - /// Quaternion + /// Quaternion /// Quaternion operator-() const noexcept { @@ -713,12 +713,12 @@ namespace nc //============================================================================ // Method Description: - /// multiplication assignment operator + /// multiplication assignment operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion& operator*=(const Quaternion& inRhs) noexcept { @@ -754,13 +754,13 @@ namespace nc //============================================================================ // Method Description: - /// multiplication operator, only useful for multiplying - /// by negative 1, all others will be renormalized back out + /// multiplication operator, only useful for multiplying + /// by negative 1, all others will be renormalized back out /// /// @param - /// inScalar + /// inScalar /// @return - /// Quaternion + /// Quaternion /// Quaternion& operator*=(double inScalar) noexcept { @@ -777,12 +777,12 @@ namespace nc //============================================================================ // Method Description: - /// multiplication operator + /// multiplication operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion operator*(const Quaternion& inRhs) const noexcept { @@ -791,13 +791,13 @@ namespace nc //============================================================================ // Method Description: - /// multiplication operator, only useful for multiplying - /// by negative 1, all others will be renormalized back out + /// multiplication operator, only useful for multiplying + /// by negative 1, all others will be renormalized back out /// /// @param - /// inScalar + /// inScalar /// @return - /// Quaternion + /// Quaternion /// Quaternion operator*(double inScalar) const noexcept { @@ -806,12 +806,12 @@ namespace nc //============================================================================ // Method Description: - /// multiplication operator + /// multiplication operator /// /// @param - /// inVec + /// inVec /// @return - /// NdArray + /// NdArray /// NdArray operator*(const NdArray& inVec) const { @@ -830,12 +830,12 @@ namespace nc //============================================================================ // Method Description: - /// multiplication operator + /// multiplication operator /// /// @param - /// inVec3 + /// inVec3 /// @return - /// Vec3 + /// Vec3 /// Vec3 operator*(const Vec3& inVec3) const { @@ -844,12 +844,12 @@ namespace nc //============================================================================ // Method Description: - /// division assignment operator + /// division assignment operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion& operator/=(const Quaternion& inRhs) noexcept { @@ -858,12 +858,12 @@ namespace nc //============================================================================ // Method Description: - /// division operator + /// division operator /// /// @param - /// inRhs + /// inRhs /// @return - /// Quaternion + /// Quaternion /// Quaternion operator/(const Quaternion& inRhs) const noexcept { @@ -872,12 +872,12 @@ namespace nc //============================================================================ // Method Description: - /// IO operator for the Quaternion class + /// IO operator for the Quaternion class /// /// @param inOStream /// @param inQuat /// @return - /// std::ostream& + /// std::ostream& /// friend std::ostream& operator<<(std::ostream& inOStream, const Quaternion& inQuat) { @@ -891,7 +891,7 @@ namespace nc //============================================================================ // Method Description: - /// renormalizes the quaternion + /// renormalizes the quaternion /// void normalize() noexcept { @@ -912,7 +912,7 @@ namespace nc //============================================================================ // Method Description: - /// Converts the euler roll, pitch, yaw angles to quaternion components + /// Converts the euler roll, pitch, yaw angles to quaternion components /// /// @ param roll: the euler roll angle in radians /// @ param pitch: the euler pitch angle in radians @@ -939,7 +939,7 @@ namespace nc //============================================================================ // Method Description: - /// Converts the direction cosine matrix to quaternion components + /// Converts the direction cosine matrix to quaternion components /// /// @ param dcm: the direction cosine matrix /// diff --git a/include/NumCpp/Rotations/rodriguesRotation.hpp b/include/NumCpp/Rotations/rodriguesRotation.hpp index d3ac9fadf..90a2de6a3 100644 --- a/include/NumCpp/Rotations/rodriguesRotation.hpp +++ b/include/NumCpp/Rotations/rodriguesRotation.hpp @@ -39,7 +39,7 @@ namespace nc { //============================================================================ // Method Description: - /// Performs Rodriques' rotation formula + /// Performs Rodriques' rotation formula /// https://en.wikipedia.org/wiki/Rodrigues%27_rotation_formula /// /// @param k: the axis to rotate around @@ -69,7 +69,7 @@ namespace nc //============================================================================ // Method Description: - /// Performs Rodriques' rotation formula + /// Performs Rodriques' rotation formula /// https://en.wikipedia.org/wiki/Rodrigues%27_rotation_formula /// /// @param k: the axis to rotate around diff --git a/include/NumCpp/Rotations/wahbasProblem.hpp b/include/NumCpp/Rotations/wahbasProblem.hpp index b0d36f351..8de1bfc30 100644 --- a/include/NumCpp/Rotations/wahbasProblem.hpp +++ b/include/NumCpp/Rotations/wahbasProblem.hpp @@ -48,7 +48,7 @@ namespace nc { //============================================================================ // Method Description: - /// Finds a rotation matrix (special orthogonal matrix) between two coordinate + /// Finds a rotation matrix (special orthogonal matrix) between two coordinate /// systems from a set of (weighted) vector observations. Solutions to Wahba's /// problem are often used in satellite attitude determination utilising sensors /// such as magnetometers and multi-antenna GPS receivers @@ -112,7 +112,7 @@ namespace nc //============================================================================ // Method Description: - /// Finds a rotation matrix (special orthogonal matrix) between two coordinate + /// Finds a rotation matrix (special orthogonal matrix) between two coordinate /// systems from a set of (weighted) vector observations. Solutions to Wahba's /// problem are often used in satellite attitude determination utilising sensors /// such as magnetometers and multi-antenna GPS receivers diff --git a/include/NumCpp/Special/airy_ai.hpp b/include/NumCpp/Special/airy_ai.hpp index d74c88c92..7e88047ae 100644 --- a/include/NumCpp/Special/airy_ai.hpp +++ b/include/NumCpp/Special/airy_ai.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// The first linearly independent solution to the differential equation y'' - yz = 0. + /// The first linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto airy_ai(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// The first linearly independent solution to the differential equation y'' - yz = 0. + /// The first linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto airy_ai(const NdArray& inArray) diff --git a/include/NumCpp/Special/airy_ai_prime.hpp b/include/NumCpp/Special/airy_ai_prime.hpp index f37270038..b7210ca84 100644 --- a/include/NumCpp/Special/airy_ai_prime.hpp +++ b/include/NumCpp/Special/airy_ai_prime.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// The derivative of the first linearly independent solution to the differential equation y'' - yz = 0. + /// The derivative of the first linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto airy_ai_prime(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// The derivative of the first linearly independent solution to the differential equation y'' - yz = 0. + /// The derivative of the first linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto airy_ai_prime(const NdArray& inArray) diff --git a/include/NumCpp/Special/airy_bi.hpp b/include/NumCpp/Special/airy_bi.hpp index e49e39a3c..39928cc5d 100644 --- a/include/NumCpp/Special/airy_bi.hpp +++ b/include/NumCpp/Special/airy_bi.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// The second linearly independent solution to the differential equation y'' - yz = 0. + /// The second linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto airy_bi(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// The second linearly independent solution to the differential equation y'' - yz = 0. + /// The second linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto airy_bi(const NdArray& inArray) diff --git a/include/NumCpp/Special/airy_bi_prime.hpp b/include/NumCpp/Special/airy_bi_prime.hpp index 6365603c9..da4112755 100644 --- a/include/NumCpp/Special/airy_bi_prime.hpp +++ b/include/NumCpp/Special/airy_bi_prime.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// The derivative of the second linearly independent solution to the differential equation y'' - yz = 0. + /// The derivative of the second linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto airy_bi_prime(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// The derivative of the second linearly independent solution to the differential equation y'' - yz = 0. + /// The derivative of the second linearly independent solution to the differential equation y'' - yz = 0. /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto airy_bi_prime(const NdArray& inArray) diff --git a/include/NumCpp/Special/bernoulli.hpp b/include/NumCpp/Special/bernoulli.hpp index 5315d02b1..4ac65117b 100644 --- a/include/NumCpp/Special/bernoulli.hpp +++ b/include/NumCpp/Special/bernoulli.hpp @@ -41,13 +41,13 @@ namespace nc { //============================================================================ // Method Description: - /// Both return the nth Bernoulli number B2n. + /// Both return the nth Bernoulli number B2n. /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// n + /// n /// @return - /// double + /// double /// inline double bernoilli(uint32 n) { @@ -65,13 +65,13 @@ namespace nc //============================================================================ // Method Description: - /// Both return the nth Bernoulli number B2n. + /// Both return the nth Bernoulli number B2n. /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// inline NdArray bernoilli(const NdArray& inArray) { diff --git a/include/NumCpp/Special/bessel_in.hpp b/include/NumCpp/Special/bessel_in.hpp index 1edcfdae9..ef9d9be1a 100644 --- a/include/NumCpp/Special/bessel_in.hpp +++ b/include/NumCpp/Special/bessel_in.hpp @@ -47,14 +47,14 @@ namespace nc { //============================================================================ // Method Description: - /// Modified Cylindrical Bessel function of the first kind. + /// Modified Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_in(dtype1 inV, dtype2 inX) @@ -71,14 +71,14 @@ namespace nc //============================================================================ // Method Description: - /// Modified Cylindrical Bessel function of the first kind. + /// Modified Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_in(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_in_prime.hpp b/include/NumCpp/Special/bessel_in_prime.hpp index 8cd8d1471..125b8fcae 100644 --- a/include/NumCpp/Special/bessel_in_prime.hpp +++ b/include/NumCpp/Special/bessel_in_prime.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Derivcative of the Modified Cylindrical Bessel function of the first kind. + /// Derivcative of the Modified Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_in_prime(dtype1 inV, dtype2 inX) @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Derivcative of the Modified Cylindrical Bessel function of the first kind. + /// Derivcative of the Modified Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_in_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_jn.hpp b/include/NumCpp/Special/bessel_jn.hpp index 25ed7f548..ede412b75 100644 --- a/include/NumCpp/Special/bessel_jn.hpp +++ b/include/NumCpp/Special/bessel_jn.hpp @@ -47,14 +47,14 @@ namespace nc { //============================================================================ // Method Description: - /// Cylindrical Bessel function of the first kind. + /// Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_jn(dtype1 inV, dtype2 inX) @@ -71,14 +71,14 @@ namespace nc //============================================================================ // Method Description: - /// Cylindrical Bessel function of the first kind. + /// Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_jn(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_jn_prime.hpp b/include/NumCpp/Special/bessel_jn_prime.hpp index 5a253b915..b5d94cb6b 100644 --- a/include/NumCpp/Special/bessel_jn_prime.hpp +++ b/include/NumCpp/Special/bessel_jn_prime.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Derivcative of the Cylindrical Bessel function of the first kind. + /// Derivcative of the Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_jn_prime(dtype1 inV, dtype2 inX) @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Derivcative of the Cylindrical Bessel function of the first kind. + /// Derivcative of the Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_jn_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_kn.hpp b/include/NumCpp/Special/bessel_kn.hpp index 664aaa817..aeaefb96c 100644 --- a/include/NumCpp/Special/bessel_kn.hpp +++ b/include/NumCpp/Special/bessel_kn.hpp @@ -47,14 +47,14 @@ namespace nc { //============================================================================ // Method Description: - /// Modified Cylindrical Bessel function of the second kind. + /// Modified Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_kn(dtype1 inV, dtype2 inX) @@ -71,14 +71,14 @@ namespace nc //============================================================================ // Method Description: - /// Modified Cylindrical Bessel function of the second kind. + /// Modified Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_kn(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_kn_prime.hpp b/include/NumCpp/Special/bessel_kn_prime.hpp index daba1b2d8..dc8266dc3 100644 --- a/include/NumCpp/Special/bessel_kn_prime.hpp +++ b/include/NumCpp/Special/bessel_kn_prime.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Derivcative of the Modified Cylindrical Bessel function of the second kind. + /// Derivcative of the Modified Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_kn_prime(dtype1 inV, dtype2 inX) @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Derivcative of the Modified Cylindrical Bessel function of the second kind + /// Derivcative of the Modified Cylindrical Bessel function of the second kind /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_kn_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_yn.hpp b/include/NumCpp/Special/bessel_yn.hpp index 82231ea02..cc749a425 100644 --- a/include/NumCpp/Special/bessel_yn.hpp +++ b/include/NumCpp/Special/bessel_yn.hpp @@ -47,14 +47,14 @@ namespace nc { //============================================================================ // Method Description: - /// Cylindrical Bessel function of the second kind. + /// Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_yn(dtype1 inV, dtype2 inX) @@ -71,14 +71,14 @@ namespace nc //============================================================================ // Method Description: - /// Cylindrical Bessel function of the second kind. + /// Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_yn(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_yn_prime.hpp b/include/NumCpp/Special/bessel_yn_prime.hpp index 994eba93c..5f95fc373 100644 --- a/include/NumCpp/Special/bessel_yn_prime.hpp +++ b/include/NumCpp/Special/bessel_yn_prime.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Derivcative of the Cylindrical Bessel function of the second kind. + /// Derivcative of the Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto bessel_yn_prime(dtype1 inV, dtype2 inX) @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Derivcative of the Cylindrical Bessel function of the second kind. + /// Derivcative of the Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto bessel_yn_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/beta.hpp b/include/NumCpp/Special/beta.hpp index cc52fb70b..32595f567 100644 --- a/include/NumCpp/Special/beta.hpp +++ b/include/NumCpp/Special/beta.hpp @@ -47,14 +47,14 @@ namespace nc { //============================================================================ // Method Description: - /// The beta function. + /// The beta function. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param a /// @param b /// @return - /// calculated-result-type + /// calculated-result-type /// template auto beta(dtype1 a, dtype2 b) @@ -71,14 +71,14 @@ namespace nc //============================================================================ // Method Description: - /// The beta function. + /// The beta function. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inArrayA /// @param inArrayB /// @return - /// NdArray + /// NdArray /// template auto beta(const NdArray& inArrayA, const NdArray& inArrayB) diff --git a/include/NumCpp/Special/cnr.hpp b/include/NumCpp/Special/cnr.hpp index 43bba6656..25165a71e 100644 --- a/include/NumCpp/Special/cnr.hpp +++ b/include/NumCpp/Special/cnr.hpp @@ -46,7 +46,7 @@ namespace nc /// @param n: the total number of items /// @param r: the number of items taken /// @return - /// double + /// double /// inline double cnr(uint32 n, uint32 r) { diff --git a/include/NumCpp/Special/comp_ellint_1.hpp b/include/NumCpp/Special/comp_ellint_1.hpp index 3b2dfea16..927a19fe1 100644 --- a/include/NumCpp/Special/comp_ellint_1.hpp +++ b/include/NumCpp/Special/comp_ellint_1.hpp @@ -47,13 +47,13 @@ namespace nc { //============================================================================ // Method Description: - /// Computes the complete elliptic integral of the first kind of k. + /// Computes the complete elliptic integral of the first kind of k. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inK: elliptic modulus or eccentricity /// @return - /// calculated-result-type + /// calculated-result-type /// template auto comp_ellint_1(dtype inK) @@ -69,13 +69,13 @@ namespace nc //============================================================================ // Method Description: - /// Computes the complete elliptic integral of the first kind of k. + /// Computes the complete elliptic integral of the first kind of k. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inArrayK: elliptic modulus or eccentricity /// @return - /// NdArray + /// NdArray /// template auto comp_ellint_1(const NdArray& inArrayK) diff --git a/include/NumCpp/Special/comp_ellint_2.hpp b/include/NumCpp/Special/comp_ellint_2.hpp index 0a726db29..f430db8fd 100644 --- a/include/NumCpp/Special/comp_ellint_2.hpp +++ b/include/NumCpp/Special/comp_ellint_2.hpp @@ -47,13 +47,13 @@ namespace nc { //============================================================================ // Method Description: - /// Computes the complete elliptic integral of the second kind of k. + /// Computes the complete elliptic integral of the second kind of k. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inK: elliptic modulus or eccentricity /// @return - /// calculated-result-type + /// calculated-result-type /// template auto comp_ellint_2(dtype inK) @@ -69,13 +69,13 @@ namespace nc //============================================================================ // Method Description: - /// Computes the complete elliptic integral of the second kind of k. + /// Computes the complete elliptic integral of the second kind of k. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inArrayK: elliptic modulus or eccentricity /// @return - /// NdArray + /// NdArray /// template auto comp_ellint_2(const NdArray& inArrayK) diff --git a/include/NumCpp/Special/comp_ellint_3.hpp b/include/NumCpp/Special/comp_ellint_3.hpp index 60f02b221..525c81f65 100644 --- a/include/NumCpp/Special/comp_ellint_3.hpp +++ b/include/NumCpp/Special/comp_ellint_3.hpp @@ -55,7 +55,7 @@ namespace nc /// @param inK: elliptic modulus or eccentricity /// @param inV: elliptic characteristic /// @return - /// calculated-result-type + /// calculated-result-type /// template auto comp_ellint_3(dtype1 inK, dtype2 inV) @@ -79,7 +79,7 @@ namespace nc /// @param inArrayK: the order of the bessel function /// @param inArrayV: elliptic characteristic /// @return - /// NdArray + /// NdArray /// template auto comp_ellint_3(const NdArray& inArrayK, const NdArray& inArrayV) diff --git a/include/NumCpp/Special/cyclic_hankel_1.hpp b/include/NumCpp/Special/cyclic_hankel_1.hpp index bef46d989..5ef9b5a47 100644 --- a/include/NumCpp/Special/cyclic_hankel_1.hpp +++ b/include/NumCpp/Special/cyclic_hankel_1.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Hankel funcion of the first kind. + /// Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// std::complex + /// std::complex /// template auto cyclic_hankel_1(dtype1 inV, dtype2 inX) @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Hankel funcion of the first kind. + /// Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input array /// @return - /// NdArray + /// NdArray /// template auto cyclic_hankel_1(dtype1 inV, const NdArray& inX) diff --git a/include/NumCpp/Special/cyclic_hankel_2.hpp b/include/NumCpp/Special/cyclic_hankel_2.hpp index aa6a7e91d..0e7a052f5 100644 --- a/include/NumCpp/Special/cyclic_hankel_2.hpp +++ b/include/NumCpp/Special/cyclic_hankel_2.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Hankel funcion of the second kind. + /// Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// std::complex<> + /// std::complex<> /// template auto cyclic_hankel_2(dtype1 inV, dtype2 inX) @@ -62,13 +62,13 @@ namespace nc //============================================================================ // Method Description: - /// Hankel funcion of the second kind. + /// Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input array /// @return - /// NdArray + /// NdArray /// template auto cyclic_hankel_2(dtype1 inV, const NdArray& inX) diff --git a/include/NumCpp/Special/digamma.hpp b/include/NumCpp/Special/digamma.hpp index 74ab6e06e..6d459da3e 100644 --- a/include/NumCpp/Special/digamma.hpp +++ b/include/NumCpp/Special/digamma.hpp @@ -46,9 +46,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto digamma(dtype inValue) @@ -65,9 +65,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto digamma(const NdArray& inArray) diff --git a/include/NumCpp/Special/ellint_1.hpp b/include/NumCpp/Special/ellint_1.hpp index 1cf93c87f..7742d44cf 100644 --- a/include/NumCpp/Special/ellint_1.hpp +++ b/include/NumCpp/Special/ellint_1.hpp @@ -55,7 +55,7 @@ namespace nc /// @param inK: elliptic modulus or eccentricity /// @param inP: Jacobi amplitude (measured in radians) /// @return - /// calculated-result-type + /// calculated-result-type /// template auto ellint_1(dtype1 inK, dtype2 inP) @@ -79,7 +79,7 @@ namespace nc /// @param inArrayK: elliptic modulus or eccentricity /// @param inArrayP: Jacobi amplitude (measured in radians) /// @return - /// NdArray + /// NdArray /// template auto ellint_1(const NdArray& inArrayK, const NdArray& inArrayP) diff --git a/include/NumCpp/Special/ellint_2.hpp b/include/NumCpp/Special/ellint_2.hpp index 792adcd42..3996f15ca 100644 --- a/include/NumCpp/Special/ellint_2.hpp +++ b/include/NumCpp/Special/ellint_2.hpp @@ -55,7 +55,7 @@ namespace nc /// @param inK: elliptic modulus or eccentricity /// @param inP: Jacobi amplitude (measured in radians) /// @return - /// calculated-result-type + /// calculated-result-type /// template auto ellint_2(dtype1 inK, dtype2 inP) @@ -79,7 +79,7 @@ namespace nc /// @param inArrayK: elliptic modulus or eccentricity /// @param inArrayP: Jacobi amplitude (measured in radians) /// @return - /// NdArray + /// NdArray /// template auto ellint_2(const NdArray& inArrayK, const NdArray& inArrayP) diff --git a/include/NumCpp/Special/ellint_3.hpp b/include/NumCpp/Special/ellint_3.hpp index a7d8ad25d..fd4afb654 100644 --- a/include/NumCpp/Special/ellint_3.hpp +++ b/include/NumCpp/Special/ellint_3.hpp @@ -56,7 +56,7 @@ namespace nc /// @param inV: elliptic characteristic /// @param inP: Jacobi amplitude (measured in radians) /// @return - /// calculated-result-type + /// calculated-result-type /// template auto ellint_3(dtype1 inK, dtype2 inV, dtype3 inP) @@ -82,7 +82,7 @@ namespace nc /// @param inArrayV: elliptic characteristic /// @param inArrayP: Jacobi amplitude (measured in radians) /// @return - /// NdArray + /// NdArray /// template auto ellint_3(const NdArray& inArrayK, const NdArray& inArrayV, const NdArray& inArrayP) diff --git a/include/NumCpp/Special/erf.hpp b/include/NumCpp/Special/erf.hpp index 38c29f999..667ae563e 100644 --- a/include/NumCpp/Special/erf.hpp +++ b/include/NumCpp/Special/erf.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// Calculate the error function of all elements in the input array. - /// Integral (from [-x, x]) of np.exp(np.power(-t, 2)) dt, multiplied by 1/np.pi. + /// Calculate the error function of all elements in the input array. + /// Integral (from [-x, x]) of np.exp(np.power(-t, 2)) dt, multiplied by 1/np.pi. /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto erf(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// Calculate the error function of all elements in the input array. - /// Integral (from [-x, x]) of np.exp(np.power(-t, 2)) dt, multiplied by 1/np.pi. + /// Calculate the error function of all elements in the input array. + /// Integral (from [-x, x]) of np.exp(np.power(-t, 2)) dt, multiplied by 1/np.pi. /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto erf(const NdArray& inArray) diff --git a/include/NumCpp/Special/erf_inv.hpp b/include/NumCpp/Special/erf_inv.hpp index 359f05665..e73b5fc11 100644 --- a/include/NumCpp/Special/erf_inv.hpp +++ b/include/NumCpp/Special/erf_inv.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the inverse error function of z, that is a value x such that: + /// Returns the inverse error function of z, that is a value x such that: /// z = erf(x). /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto erf_inv(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns the inverse error function of z, that is a value x such that: + /// Returns the inverse error function of z, that is a value x such that: /// z = erf(x). /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto erf_inv(const NdArray& inArray) diff --git a/include/NumCpp/Special/erfc.hpp b/include/NumCpp/Special/erfc.hpp index cff04c5d4..b6d2b8a95 100644 --- a/include/NumCpp/Special/erfc.hpp +++ b/include/NumCpp/Special/erfc.hpp @@ -41,13 +41,13 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the complement of the error function of inValue. + /// Returns the complement of the error function of inValue. /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto erfc(dtype inValue) @@ -59,14 +59,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns the element-wise complement of the error - /// function of inValue. + /// Returns the element-wise complement of the error + /// function of inValue. /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto erfc(const NdArray& inArray) diff --git a/include/NumCpp/Special/erfc_inv.hpp b/include/NumCpp/Special/erfc_inv.hpp index e2589f167..042d762b5 100644 --- a/include/NumCpp/Special/erfc_inv.hpp +++ b/include/NumCpp/Special/erfc_inv.hpp @@ -41,14 +41,14 @@ namespace nc { //============================================================================ // Method Description: - /// Returns the inverse complentary error function of z, that is a value x such that: + /// Returns the inverse complentary error function of z, that is a value x such that: /// z = erfc(x). /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto erfc_inv(dtype inValue) @@ -60,14 +60,14 @@ namespace nc //============================================================================ // Method Description: - /// Returns the inverse complementary error function of z, that is a value x such that: + /// Returns the inverse complementary error function of z, that is a value x such that: /// z = erfc(x). /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto erfc_inv(const NdArray& inArray) diff --git a/include/NumCpp/Special/expint.hpp b/include/NumCpp/Special/expint.hpp index c139ccbd5..459e62e7d 100644 --- a/include/NumCpp/Special/expint.hpp +++ b/include/NumCpp/Special/expint.hpp @@ -47,13 +47,13 @@ namespace nc { //============================================================================ // Method Description: - /// Exponential integral Ei. + /// Exponential integral Ei. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inX: value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto expint(dtype inX) @@ -69,13 +69,13 @@ namespace nc //============================================================================ // Method Description: - /// Exponential integral Ei. + /// Exponential integral Ei. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inArrayX: value /// @return - /// NdArray + /// NdArray /// template auto expint(const NdArray& inArrayX) diff --git a/include/NumCpp/Special/factorial.hpp b/include/NumCpp/Special/factorial.hpp index 6031605d4..da4200793 100644 --- a/include/NumCpp/Special/factorial.hpp +++ b/include/NumCpp/Special/factorial.hpp @@ -46,9 +46,9 @@ namespace nc /// Returns the factorial of the input value /// /// @param - /// inValue + /// inValue /// @return - /// double + /// double /// inline double factorial(uint32 inValue) { @@ -75,9 +75,9 @@ namespace nc /// Returns the factorial of the input value /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// inline NdArray factorial(const NdArray& inArray) { diff --git a/include/NumCpp/Special/gamma.hpp b/include/NumCpp/Special/gamma.hpp index 6f9c76e74..93a3b379f 100644 --- a/include/NumCpp/Special/gamma.hpp +++ b/include/NumCpp/Special/gamma.hpp @@ -45,9 +45,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto gamma(dtype inValue) @@ -63,9 +63,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto gamma(const NdArray& inArray) diff --git a/include/NumCpp/Special/gamma1pm1.hpp b/include/NumCpp/Special/gamma1pm1.hpp index 4135170fe..584ecfd63 100644 --- a/include/NumCpp/Special/gamma1pm1.hpp +++ b/include/NumCpp/Special/gamma1pm1.hpp @@ -45,9 +45,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto gamma1pm1(dtype inValue) @@ -63,9 +63,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto gamma1pm1(const NdArray& inArray) diff --git a/include/NumCpp/Special/log_gamma.hpp b/include/NumCpp/Special/log_gamma.hpp index 8a8fb5443..dd83e3ce4 100644 --- a/include/NumCpp/Special/log_gamma.hpp +++ b/include/NumCpp/Special/log_gamma.hpp @@ -45,9 +45,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto log_gamma(dtype inValue) @@ -63,9 +63,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto log_gamma(const NdArray& inArray) diff --git a/include/NumCpp/Special/pnr.hpp b/include/NumCpp/Special/pnr.hpp index 673740fc0..72cae6b9c 100644 --- a/include/NumCpp/Special/pnr.hpp +++ b/include/NumCpp/Special/pnr.hpp @@ -46,7 +46,7 @@ namespace nc /// @param n: the total number of items /// @param r: the number of items taken /// @return - /// double + /// double /// inline double pnr(uint32 n, uint32 r) { diff --git a/include/NumCpp/Special/polygamma.hpp b/include/NumCpp/Special/polygamma.hpp index 4da25dab0..8b2cc3eb3 100644 --- a/include/NumCpp/Special/polygamma.hpp +++ b/include/NumCpp/Special/polygamma.hpp @@ -48,7 +48,7 @@ namespace nc /// @param n: the nth derivative /// @param inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto polygamma(uint32 n, dtype inValue) @@ -67,7 +67,7 @@ namespace nc /// @param n: the nth derivative /// @param inArray /// @return - /// NdArray + /// NdArray /// template auto polygamma(uint32 n, const NdArray& inArray) diff --git a/include/NumCpp/Special/prime.hpp b/include/NumCpp/Special/prime.hpp index ec9ebf3bf..886063f4c 100644 --- a/include/NumCpp/Special/prime.hpp +++ b/include/NumCpp/Special/prime.hpp @@ -49,9 +49,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// n: the nth prime number to return + /// n: the nth prime number to return /// @return - /// uint32 + /// uint32 /// inline uint32 prime(uint32 n) { @@ -70,9 +70,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// inline NdArray prime(const NdArray& inArray) { diff --git a/include/NumCpp/Special/riemann_zeta.hpp b/include/NumCpp/Special/riemann_zeta.hpp index 0a8639af2..68576b411 100644 --- a/include/NumCpp/Special/riemann_zeta.hpp +++ b/include/NumCpp/Special/riemann_zeta.hpp @@ -45,15 +45,15 @@ namespace nc { //============================================================================ // Method Description: - /// The Riemann Zeta function + /// The Riemann Zeta function /// https://en.wikipedia.org/wiki/Riemann_zeta_function /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto riemann_zeta(dtype inValue) @@ -69,15 +69,15 @@ namespace nc //============================================================================ // Method Description: - /// The Riemann Zeta function + /// The Riemann Zeta function /// https://en.wikipedia.org/wiki/Riemann_zeta_function /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto riemann_zeta(const NdArray& inArray) diff --git a/include/NumCpp/Special/softmax.hpp b/include/NumCpp/Special/softmax.hpp index 40ff478f8..9a433138d 100644 --- a/include/NumCpp/Special/softmax.hpp +++ b/include/NumCpp/Special/softmax.hpp @@ -39,7 +39,7 @@ namespace nc { //============================================================================ // Method Description: - /// The softmax function transforms each element of a collection by computing + /// The softmax function transforms each element of a collection by computing /// the exponential of each element divided by the sum of the exponentials of all /// the elements. That is, if x is a one-dimensional numpy array: /// softmax(x) = np.exp(x)/sum(np.exp(x)) diff --git a/include/NumCpp/Special/spherical_bessel_jn.hpp b/include/NumCpp/Special/spherical_bessel_jn.hpp index 496415b44..a0cb5dd8d 100644 --- a/include/NumCpp/Special/spherical_bessel_jn.hpp +++ b/include/NumCpp/Special/spherical_bessel_jn.hpp @@ -45,14 +45,14 @@ namespace nc { //============================================================================ // Method Description: - /// Spherical Bessel function of the first kind. + /// Spherical Bessel function of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto spherical_bessel_jn(uint32 inV, dtype inX) @@ -68,14 +68,14 @@ namespace nc //============================================================================ // Method Description: - /// Spherical Bessel function of the first kind. + /// Spherical Bessel function of the first kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto spherical_bessel_jn(uint32 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/spherical_bessel_yn.hpp b/include/NumCpp/Special/spherical_bessel_yn.hpp index c862adb7f..541021509 100644 --- a/include/NumCpp/Special/spherical_bessel_yn.hpp +++ b/include/NumCpp/Special/spherical_bessel_yn.hpp @@ -45,14 +45,14 @@ namespace nc { //============================================================================ // Method Description: - /// Spherical Bessel function of the second kind. + /// Spherical Bessel function of the second kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto spherical_bessel_yn(uint32 inV, dtype inX) @@ -68,14 +68,14 @@ namespace nc //============================================================================ // Method Description: - /// Spherical Bessel function of the second kind. + /// Spherical Bessel function of the second kind. /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// /// @param inV: the order of the bessel function /// @param inArrayX: the input values /// @return - /// NdArray + /// NdArray /// template auto spherical_bessel_yn(uint32 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/spherical_hankel_1.hpp b/include/NumCpp/Special/spherical_hankel_1.hpp index dffc2ad85..bef234911 100644 --- a/include/NumCpp/Special/spherical_hankel_1.hpp +++ b/include/NumCpp/Special/spherical_hankel_1.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Spherical Hankel funcion of the first kind. + /// Spherical Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// calculated-result-type + /// calculated-result-type /// template auto spherical_hankel_1(dtype1 inV, dtype2 inX) @@ -68,7 +68,7 @@ namespace nc /// @param inV: the order of the bessel function /// @param inArray: the input values /// @return - /// NdArray + /// NdArray /// template auto spherical_hankel_1(dtype1 inV, const NdArray& inArray) diff --git a/include/NumCpp/Special/spherical_hankel_2.hpp b/include/NumCpp/Special/spherical_hankel_2.hpp index fccb9e489..cf5e5c374 100644 --- a/include/NumCpp/Special/spherical_hankel_2.hpp +++ b/include/NumCpp/Special/spherical_hankel_2.hpp @@ -43,13 +43,13 @@ namespace nc { //============================================================================ // Method Description: - /// Spherical Hankel funcion of the second kind. + /// Spherical Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// /// @param inV: the order of the bessel function /// @param inX: the input value /// @return - /// double + /// double /// template std::complex spherical_hankel_2(dtype1 inV, dtype2 inX) @@ -68,7 +68,7 @@ namespace nc /// @param inV: the order of the bessel function /// @param inArray: the input value /// @return - /// NdArray + /// NdArray /// template auto spherical_hankel_2(dtype1 inV, const NdArray& inArray) diff --git a/include/NumCpp/Special/trigamma.hpp b/include/NumCpp/Special/trigamma.hpp index e86a859d2..1c3a055ca 100644 --- a/include/NumCpp/Special/trigamma.hpp +++ b/include/NumCpp/Special/trigamma.hpp @@ -46,9 +46,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inValue + /// inValue /// @return - /// calculated-result-type + /// calculated-result-type /// template auto trigamma(dtype inValue) @@ -65,9 +65,9 @@ namespace nc /// NOTE: Use of this function requires using the Boost includes. /// /// @param - /// inArray + /// inArray /// @return - /// NdArray + /// NdArray /// template auto trigamma(const NdArray& inArray) diff --git a/include/NumCpp/Utils/cube.hpp b/include/NumCpp/Utils/cube.hpp index e29e3d32d..bf5c03001 100644 --- a/include/NumCpp/Utils/cube.hpp +++ b/include/NumCpp/Utils/cube.hpp @@ -34,7 +34,7 @@ namespace nc namespace utils { //============================================================================ - /// Cubes in input value + /// Cubes in input value /// /// @param inValue /// diff --git a/include/NumCpp/Utils/essentiallyEqual.hpp b/include/NumCpp/Utils/essentiallyEqual.hpp index 54f60e67c..d163ed11c 100644 --- a/include/NumCpp/Utils/essentiallyEqual.hpp +++ b/include/NumCpp/Utils/essentiallyEqual.hpp @@ -40,7 +40,7 @@ namespace nc namespace utils { //============================================================================ - /// tests that 2 floating point values are "essentially equal" + /// tests that 2 floating point values are "essentially equal" /// /// @param inValue1 /// @param inValue2 @@ -55,7 +55,7 @@ namespace nc } //============================================================================ - /// tests that 2 floating point values are "essentially equal" + /// tests that 2 floating point values are "essentially equal" /// /// @param inValue1 /// @param inValue2 @@ -72,7 +72,7 @@ namespace nc } //============================================================================ - /// tests that 2 floating point values are "essentially equal" + /// tests that 2 floating point values are "essentially equal" /// /// @param inValue1 /// @param inValue2 @@ -87,7 +87,7 @@ namespace nc } //============================================================================ - /// tests that 2 floating point values are "essentially equal" + /// tests that 2 floating point values are "essentially equal" /// /// @param inValue1 /// @param inValue2 @@ -105,7 +105,7 @@ namespace nc } //============================================================================ - /// tests that 2 floating point values are "essentially equal" + /// tests that 2 floating point values are "essentially equal" /// /// @param inValue1 /// @param inValue2 @@ -120,7 +120,7 @@ namespace nc } //============================================================================ - /// tests that 2 floating point values are "essentially equal" + /// tests that 2 floating point values are "essentially equal" /// /// @param inValue1 /// @param inValue2 diff --git a/include/NumCpp/Utils/gaussian.hpp b/include/NumCpp/Utils/gaussian.hpp index 57589f0a0..856264a61 100644 --- a/include/NumCpp/Utils/gaussian.hpp +++ b/include/NumCpp/Utils/gaussian.hpp @@ -23,7 +23,7 @@ /// DEALINGS IN THE SOFTWARE. /// /// Description -/// samples a 2D gaussian of mean zero and input STD sigma +/// samples a 2D gaussian of mean zero and input STD sigma /// #pragma once @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// samples a 2D gaussian of mean zero and input STD sigma + /// samples a 2D gaussian of mean zero and input STD sigma /// /// @param inX /// @param inY diff --git a/include/NumCpp/Utils/gaussian1d.hpp b/include/NumCpp/Utils/gaussian1d.hpp index 7e0b82161..559da8586 100644 --- a/include/NumCpp/Utils/gaussian1d.hpp +++ b/include/NumCpp/Utils/gaussian1d.hpp @@ -37,7 +37,7 @@ namespace nc { //============================================================================ // Method Description: - /// samples a 1D gaussian of input mean and sigma + /// samples a 1D gaussian of input mean and sigma /// /// @param inX /// @param inMu diff --git a/include/NumCpp/Utils/interp.hpp b/include/NumCpp/Utils/interp.hpp index acd249ca9..b49d0b389 100644 --- a/include/NumCpp/Utils/interp.hpp +++ b/include/NumCpp/Utils/interp.hpp @@ -32,7 +32,7 @@ namespace nc namespace utils { //============================================================================ - /// Returns the linear interpolation between two points + /// Returns the linear interpolation between two points /// /// @param inValue1 /// @param inValue2 diff --git a/include/NumCpp/Utils/num2str.hpp b/include/NumCpp/Utils/num2str.hpp index 7dd47d53d..db5f3e0f1 100644 --- a/include/NumCpp/Utils/num2str.hpp +++ b/include/NumCpp/Utils/num2str.hpp @@ -36,7 +36,7 @@ namespace nc namespace utils { //============================================================================ - /// Converts the number into a string + /// Converts the number into a string /// /// @param inNumber /// diff --git a/include/NumCpp/Utils/power.hpp b/include/NumCpp/Utils/power.hpp index f26c4ef62..0406d5da1 100644 --- a/include/NumCpp/Utils/power.hpp +++ b/include/NumCpp/Utils/power.hpp @@ -37,7 +37,7 @@ namespace nc namespace utils { //============================================================================ - /// Raises the input value to an integer power + /// Raises the input value to an integer power /// /// @param inValue /// @param inPower diff --git a/include/NumCpp/Utils/powerf.hpp b/include/NumCpp/Utils/powerf.hpp index c458d4d75..2200d032e 100644 --- a/include/NumCpp/Utils/powerf.hpp +++ b/include/NumCpp/Utils/powerf.hpp @@ -38,7 +38,7 @@ namespace nc namespace utils { //============================================================================ - /// Raises the input value to a floating point power + /// Raises the input value to a floating point power /// /// @param inValue /// @param inPower diff --git a/include/NumCpp/Utils/sqr.hpp b/include/NumCpp/Utils/sqr.hpp index 5536168de..c8049ad47 100644 --- a/include/NumCpp/Utils/sqr.hpp +++ b/include/NumCpp/Utils/sqr.hpp @@ -34,7 +34,7 @@ namespace nc namespace utils { //============================================================================ - /// Squares in input value + /// Squares in input value /// /// @param inValue /// diff --git a/include/NumCpp/Utils/value2str.hpp b/include/NumCpp/Utils/value2str.hpp index c2aacc44b..1d4e32f0e 100644 --- a/include/NumCpp/Utils/value2str.hpp +++ b/include/NumCpp/Utils/value2str.hpp @@ -38,7 +38,7 @@ namespace nc namespace utils { //============================================================================ - /// Converts the value into a string + /// Converts the value into a string /// /// @param inValue /// diff --git a/include/NumCpp/Vector/Vec2.hpp b/include/NumCpp/Vector/Vec2.hpp index 2d8bd9032..f63b26840 100644 --- a/include/NumCpp/Vector/Vec2.hpp +++ b/include/NumCpp/Vector/Vec2.hpp @@ -44,7 +44,7 @@ namespace nc { //================================================================================ // Class Description: - /// Holds a 2D vector + /// Holds a 2D vector class Vec2 { public: @@ -54,13 +54,13 @@ namespace nc //============================================================================ // Method Description: - /// Default Constructor + /// Default Constructor /// constexpr Vec2() = default; //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inX: the x component /// @param inY: the y component @@ -72,7 +72,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inList /// @@ -89,7 +89,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param ndArray /// @@ -106,7 +106,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the angle between the two vectors + /// Returns the angle between the two vectors /// /// @param otherVec /// @return the angle in radians @@ -125,8 +125,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the vector with its magnitude clamped - /// to maxLength + /// Returns a copy of the vector with its magnitude clamped + /// to maxLength /// /// @param maxLength /// @return Vec2 @@ -146,7 +146,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the distance between the two vectors + /// Returns the distance between the two vectors /// /// @param otherVec /// @return the distance (equivalent to (a - b).norm() @@ -158,7 +158,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the dot product of the two vectors + /// Returns the dot product of the two vectors /// /// @param otherVec /// @return the dot product @@ -170,7 +170,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [0, -1] + /// Returns the unit vector [0, -1] /// /// @return Vec2 /// @@ -181,7 +181,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [-1, 0] + /// Returns the unit vector [-1, 0] /// /// @return Vec2 /// @@ -192,7 +192,7 @@ namespace nc //============================================================================ // Method Description: - /// Linearly interpolates between two vectors + /// Linearly interpolates between two vectors /// /// @param otherVec /// @param t the amount to interpolate by (clamped from [0, 1]); @@ -212,7 +212,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the magnitude of the vector + /// Returns the magnitude of the vector /// /// @return magnitude of the vector /// @@ -223,7 +223,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns a new normalized Vec2 + /// Returns a new normalized Vec2 /// /// @return Vec2 /// @@ -234,7 +234,7 @@ namespace nc //============================================================================ // Method Description: - /// Projects the vector onto the input vector + /// Projects the vector onto the input vector /// /// @param otherVec /// @return Vec2 @@ -247,7 +247,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [1, 0] + /// Returns the unit vector [1, 0] /// /// @return Vec2 /// @@ -258,7 +258,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the Vec2 as a string + /// Returns the Vec2 as a string /// /// @return std::string /// @@ -271,7 +271,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the Vec2 as an NdArray + /// Returns the Vec2 as an NdArray /// /// @return NdArray /// @@ -283,7 +283,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [0, 1] + /// Returns the unit vector [0, 1] /// /// @return Vec2 /// @@ -294,7 +294,7 @@ namespace nc //============================================================================ // Method Description: - /// Equality operator + /// Equality operator /// /// @param rhs /// @return bool @@ -306,7 +306,7 @@ namespace nc //============================================================================ // Method Description: - /// Not Equality operator + /// Not Equality operator /// /// @param rhs /// @return bool @@ -318,7 +318,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the vector + /// Adds the scaler to the vector /// /// @param scaler /// @return Vec2 @@ -332,7 +332,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the two vectors + /// Adds the two vectors /// /// @param rhs /// @return Vec2 @@ -346,7 +346,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the vector + /// Subtracts the scaler from the vector /// /// @param scaler /// @return Vec2 @@ -360,7 +360,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the two vectors + /// Subtracts the two vectors /// /// @param rhs /// @return Vec2 @@ -374,7 +374,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar mulitplication + /// Scalar mulitplication /// /// @param scaler /// @return Vec2 @@ -388,7 +388,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar division + /// Scalar division /// /// @param scaler /// @return Vec2 @@ -403,7 +403,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the vector + /// Adds the scaler to the vector /// /// @param lhs /// @param rhs @@ -416,7 +416,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the vector + /// Adds the scaler to the vector /// /// @param lhs /// @param rhs @@ -429,7 +429,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the two vectors + /// Adds the two vectors /// /// @param lhs /// @param rhs @@ -442,7 +442,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the negative vector + /// Returns the negative vector /// /// @return Vec2 /// @@ -453,7 +453,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the vector + /// Subtracts the scaler from the vector /// /// @param lhs /// @param rhs @@ -466,7 +466,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the vector + /// Subtracts the scaler from the vector /// /// @param lhs /// @param rhs @@ -479,7 +479,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the two vectors + /// Subtracts the two vectors /// /// @param lhs /// @param rhs @@ -492,7 +492,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar mulitplication + /// Scalar mulitplication /// /// @param lhs /// @param rhs @@ -505,7 +505,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar mulitplication + /// Scalar mulitplication /// /// @param lhs /// @param rhs @@ -518,12 +518,12 @@ namespace nc //============================================================================ // Method Description: - /// Vector mulitplication (dot product) + /// Vector mulitplication (dot product) /// /// @param lhs /// @param rhs /// @return dot product - /// + /// /// inline double operator*(const Vec2& lhs, const Vec2& rhs) noexcept { @@ -532,7 +532,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar division + /// Scalar division /// /// @param lhs /// @param rhs @@ -545,7 +545,7 @@ namespace nc //============================================================================ // Method Description: - /// stream output operator + /// stream output operator /// /// @param stream /// @param vec diff --git a/include/NumCpp/Vector/Vec3.hpp b/include/NumCpp/Vector/Vec3.hpp index 012829c2f..9f34cb63e 100644 --- a/include/NumCpp/Vector/Vec3.hpp +++ b/include/NumCpp/Vector/Vec3.hpp @@ -45,7 +45,7 @@ namespace nc { //================================================================================ // Class Description: - /// Holds a 3D vector + /// Holds a 3D vector class Vec3 { public: @@ -56,13 +56,13 @@ namespace nc //============================================================================ // Method Description: - /// Default Constructor + /// Default Constructor /// constexpr Vec3() = default; //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inX: the x component /// @param inY: the y component @@ -76,7 +76,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param inList /// @@ -94,7 +94,7 @@ namespace nc //============================================================================ // Method Description: - /// Constructor + /// Constructor /// /// @param ndArray /// @@ -112,7 +112,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the angle between the two vectors + /// Returns the angle between the two vectors /// /// @param otherVec /// @return the angle in radians @@ -131,7 +131,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [0, 0, -1] + /// Returns the unit vector [0, 0, -1] /// /// @return Vec3 /// @@ -142,8 +142,8 @@ namespace nc //============================================================================ // Method Description: - /// Returns a copy of the vector with its magnitude clamped - /// to maxLength + /// Returns a copy of the vector with its magnitude clamped + /// to maxLength /// /// @param maxLength /// @return Vec3 @@ -163,7 +163,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the cross product of the two vectors + /// Returns the cross product of the two vectors /// /// @param otherVec /// @return the dot product @@ -179,7 +179,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the distance between the two vectors + /// Returns the distance between the two vectors /// /// @param otherVec /// @return the distance (equivalent to (a - b).norm() @@ -191,7 +191,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the dot product of the two vectors + /// Returns the dot product of the two vectors /// /// @param otherVec /// @return the dot product @@ -203,7 +203,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [0, -1, 0] + /// Returns the unit vector [0, -1, 0] /// /// @return Vec3 /// @@ -214,7 +214,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [0, 0, 1] + /// Returns the unit vector [0, 0, 1] /// /// @return Vec3 /// @@ -225,7 +225,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [-1, 0, 0] + /// Returns the unit vector [-1, 0, 0] /// /// @return Vec3 /// @@ -236,7 +236,7 @@ namespace nc //============================================================================ // Method Description: - /// Linearly interpolates between two vectors + /// Linearly interpolates between two vectors /// /// @param otherVec /// @param t the amount to interpolate by (clamped from [0, 1]); @@ -257,7 +257,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the magnitude of the vector + /// Returns the magnitude of the vector /// /// @return magnitude of the vector /// @@ -268,7 +268,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns a new normalized Vec3 + /// Returns a new normalized Vec3 /// /// @return Vec3 /// @@ -279,7 +279,7 @@ namespace nc //============================================================================ // Method Description: - /// Projects the vector onto the input vector + /// Projects the vector onto the input vector /// /// @param otherVec /// @return Vec3 @@ -292,7 +292,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [1, 0, 0] + /// Returns the unit vector [1, 0, 0] /// /// @return Vec3 /// @@ -303,7 +303,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the Vec3 as a string + /// Returns the Vec3 as a string /// /// @return std::string /// @@ -316,7 +316,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the Vec2 as an NdArray + /// Returns the Vec2 as an NdArray /// /// @return NdArray /// @@ -328,7 +328,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the unit vector [0, 1, 0] + /// Returns the unit vector [0, 1, 0] /// /// @return Vec3 /// @@ -339,7 +339,7 @@ namespace nc //============================================================================ // Method Description: - /// Equality operator + /// Equality operator /// /// @param rhs /// @return bool @@ -353,7 +353,7 @@ namespace nc //============================================================================ // Method Description: - /// Not Equality operator + /// Not Equality operator /// /// @param rhs /// @return bool @@ -365,7 +365,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the vector + /// Adds the scaler to the vector /// /// @param scaler /// @return Vec3 @@ -380,7 +380,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the two vectors + /// Adds the two vectors /// /// @param rhs /// @return Vec3 @@ -395,7 +395,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the vector + /// Subtracts the scaler from the vector /// /// @param scaler /// @return Vec3 @@ -410,7 +410,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the two vectors + /// Subtracts the two vectors /// /// @param rhs /// @return Vec3 @@ -425,7 +425,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar mulitplication + /// Scalar mulitplication /// /// @param scaler /// @return Vec3 @@ -440,7 +440,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar division + /// Scalar division /// /// @param scaler /// @return Vec3 @@ -456,7 +456,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the vector + /// Adds the scaler to the vector /// /// @param lhs /// @param rhs @@ -469,7 +469,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the scaler to the vector + /// Adds the scaler to the vector /// /// @param lhs /// @param rhs @@ -482,7 +482,7 @@ namespace nc //============================================================================ // Method Description: - /// Adds the two vectors + /// Adds the two vectors /// /// @param lhs /// @param rhs @@ -495,7 +495,7 @@ namespace nc //============================================================================ // Method Description: - /// Returns the negative vector + /// Returns the negative vector /// /// @return Vec3 /// @@ -506,7 +506,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the vector + /// Subtracts the scaler from the vector /// /// @param lhs /// @param rhs @@ -519,7 +519,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the scaler from the vector + /// Subtracts the scaler from the vector /// /// @param lhs /// @param rhs @@ -532,7 +532,7 @@ namespace nc //============================================================================ // Method Description: - /// Subtracts the two vectors + /// Subtracts the two vectors /// /// @param lhs /// @param rhs @@ -545,7 +545,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar mulitplication + /// Scalar mulitplication /// /// @param lhs /// @param rhs @@ -558,7 +558,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar mulitplication + /// Scalar mulitplication /// /// @param lhs /// @param rhs @@ -571,12 +571,12 @@ namespace nc //============================================================================ // Method Description: - /// Vector mulitplication (dot product) + /// Vector mulitplication (dot product) /// /// @param lhs /// @param rhs /// @return dot product - /// + /// /// inline double operator*(const Vec3& lhs, const Vec3& rhs) noexcept { @@ -585,7 +585,7 @@ namespace nc //============================================================================ // Method Description: - /// Scalar division + /// Scalar division /// /// @param lhs /// @param rhs @@ -598,7 +598,7 @@ namespace nc //============================================================================ // Method Description: - /// stream output operator + /// stream output operator /// /// @param stream /// @param vec From 3f9648a8520f3bf22fec4f6ce8b3ff32c185c785 Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 16:03:55 -0700 Subject: [PATCH 27/31] some more doxygen doc string cleanup --- include/NumCpp/Coordinates/Coordinate.hpp | 74 +- include/NumCpp/Coordinates/Dec.hpp | 38 +- include/NumCpp/Coordinates/RA.hpp | 32 +- .../NumCpp/Coordinates/degreeSeperation.hpp | 12 +- .../NumCpp/Coordinates/radianSeperation.hpp | 12 +- include/NumCpp/Core/DataCube.hpp | 172 ++-- include/NumCpp/Core/DtypeInfo.hpp | 24 +- include/NumCpp/Core/Internal/Endian.hpp | 2 +- include/NumCpp/Core/Internal/Error.hpp | 8 +- include/NumCpp/Core/Internal/Filesystem.hpp | 12 +- .../Core/Internal/StdComplexOperators.hpp | 28 +- include/NumCpp/Core/Shape.hpp | 28 +- include/NumCpp/Core/Slice.hpp | 32 +- include/NumCpp/Core/Timer.hpp | 8 +- .../Boundaries/Boundaries1d/addBoundary1d.hpp | 11 +- .../Boundaries/Boundaries1d/constant1d.hpp | 9 +- .../Boundaries/Boundaries1d/mirror1d.hpp | 7 +- .../Boundaries/Boundaries1d/nearest1d.hpp | 7 +- .../Boundaries/Boundaries1d/reflect1d.hpp | 6 +- .../Boundaries1d/trimBoundary1d.hpp | 7 +- .../Filter/Boundaries/Boundaries1d/wrap1d.hpp | 7 +- .../Boundaries/Boundaries2d/addBoundary2d.hpp | 11 +- .../Boundaries/Boundaries2d/constant2d.hpp | 9 +- .../Boundaries/Boundaries2d/fillCorners.hpp | 10 +- .../Boundaries/Boundaries2d/mirror2d.hpp | 7 +- .../Boundaries/Boundaries2d/nearest2d.hpp | 7 +- .../Boundaries/Boundaries2d/reflect2d.hpp | 7 +- .../Boundaries2d/trimBoundary2d.hpp | 7 +- .../Filter/Boundaries/Boundaries2d/wrap2d.hpp | 7 +- .../Filters1d/complementaryMedianFilter1d.hpp | 11 +- .../Filter/Filters/Filters1d/convolve1d.hpp | 11 +- .../Filters/Filters1d/gaussianFilter1d.hpp | 11 +- .../Filters/Filters1d/maximumFilter1d.hpp | 11 +- .../Filters/Filters1d/medianFilter1d.hpp | 11 +- .../Filters/Filters1d/minimumFilter1d.hpp | 11 +- .../Filters/Filters1d/percentileFilter1d.hpp | 13 +- .../Filter/Filters/Filters1d/rankFilter1d.hpp | 13 +- .../Filters/Filters1d/uniformFilter1d.hpp | 11 +- .../Filters2d/complementaryMedianFilter.hpp | 11 +- .../Filter/Filters/Filters2d/convolve.hpp | 13 +- .../Filters/Filters2d/gaussianFilter.hpp | 11 +- .../Filter/Filters/Filters2d/laplace.hpp | 9 +- .../Filters/Filters2d/maximumFilter.hpp | 11 +- .../Filter/Filters/Filters2d/medianFilter.hpp | 11 +- .../Filters/Filters2d/minimumFilter.hpp | 11 +- .../Filters/Filters2d/percentileFilter.hpp | 13 +- .../Filter/Filters/Filters2d/rankFilter.hpp | 13 +- .../Filters/Filters2d/uniformFilter.hpp | 11 +- include/NumCpp/Functions/abs.hpp | 12 +- include/NumCpp/Functions/add.hpp | 63 +- include/NumCpp/Functions/alen.hpp | 6 +- include/NumCpp/Functions/all.hpp | 7 +- include/NumCpp/Functions/allclose.hpp | 9 +- include/NumCpp/Functions/amax.hpp | 7 +- include/NumCpp/Functions/amin.hpp | 7 +- include/NumCpp/Functions/angle.hpp | 12 +- include/NumCpp/Functions/any.hpp | 7 +- include/NumCpp/Functions/append.hpp | 9 +- include/NumCpp/Functions/applyFunction.hpp | 7 +- include/NumCpp/Functions/applyPoly1d.hpp | 7 +- include/NumCpp/Functions/arange.hpp | 21 +- include/NumCpp/Functions/arccos.hpp | 12 +- include/NumCpp/Functions/arccosh.hpp | 12 +- include/NumCpp/Functions/arcsin.hpp | 12 +- include/NumCpp/Functions/arcsinh.hpp | 12 +- include/NumCpp/Functions/arctan.hpp | 12 +- include/NumCpp/Functions/arctan2.hpp | 14 +- include/NumCpp/Functions/arctanh.hpp | 12 +- include/NumCpp/Functions/argmax.hpp | 7 +- include/NumCpp/Functions/argmin.hpp | 7 +- include/NumCpp/Functions/argsort.hpp | 7 +- include/NumCpp/Functions/argwhere.hpp | 5 +- include/NumCpp/Functions/around.hpp | 14 +- include/NumCpp/Functions/array_equal.hpp | 7 +- include/NumCpp/Functions/array_equiv.hpp | 7 +- include/NumCpp/Functions/asarray.hpp | 117 +-- include/NumCpp/Functions/astype.hpp | 6 +- include/NumCpp/Functions/average.hpp | 25 +- include/NumCpp/Functions/bartlett.hpp | 2 +- include/NumCpp/Functions/binaryRepr.hpp | 5 +- include/NumCpp/Functions/bincount.hpp | 16 +- include/NumCpp/Functions/bitwise_and.hpp | 7 +- include/NumCpp/Functions/bitwise_not.hpp | 3 +- include/NumCpp/Functions/bitwise_or.hpp | 7 +- include/NumCpp/Functions/bitwise_xor.hpp | 7 +- include/NumCpp/Functions/blackman.hpp | 2 +- include/NumCpp/Functions/byteswap.hpp | 5 +- include/NumCpp/Functions/cbrt.hpp | 10 +- include/NumCpp/Functions/ceil.hpp | 4 +- include/NumCpp/Functions/centerOfMass.hpp | 6 +- include/NumCpp/Functions/clip.hpp | 18 +- include/NumCpp/Functions/column_stack.hpp | 6 +- include/NumCpp/Functions/complex.hpp | 24 +- include/NumCpp/Functions/concatenate.hpp | 7 +- include/NumCpp/Functions/conj.hpp | 12 +- include/NumCpp/Functions/contains.hpp | 9 +- include/NumCpp/Functions/copy.hpp | 6 +- include/NumCpp/Functions/copySign.hpp | 7 +- include/NumCpp/Functions/copyto.hpp | 7 +- include/NumCpp/Functions/corrcoef.hpp | 2 +- include/NumCpp/Functions/cos.hpp | 12 +- include/NumCpp/Functions/cosh.hpp | 12 +- include/NumCpp/Functions/count_nonzero.hpp | 7 +- include/NumCpp/Functions/cov.hpp | 2 +- include/NumCpp/Functions/cov_inv.hpp | 2 +- include/NumCpp/Functions/cross.hpp | 9 +- include/NumCpp/Functions/cube.hpp | 12 +- include/NumCpp/Functions/cumprod.hpp | 7 +- include/NumCpp/Functions/cumsum.hpp | 7 +- include/NumCpp/Functions/deg2rad.hpp | 12 +- include/NumCpp/Functions/degrees.hpp | 12 +- include/NumCpp/Functions/deleteIndices.hpp | 27 +- include/NumCpp/Functions/diag.hpp | 6 +- include/NumCpp/Functions/diagflat.hpp | 6 +- include/NumCpp/Functions/diagonal.hpp | 9 +- include/NumCpp/Functions/diff.hpp | 7 +- include/NumCpp/Functions/divide.hpp | 63 +- include/NumCpp/Functions/dot.hpp | 18 +- include/NumCpp/Functions/dump.hpp | 7 +- include/NumCpp/Functions/empty.hpp | 13 +- include/NumCpp/Functions/empty_like.hpp | 6 +- include/NumCpp/Functions/endianess.hpp | 6 +- include/NumCpp/Functions/equal.hpp | 7 +- include/NumCpp/Functions/exp.hpp | 12 +- include/NumCpp/Functions/exp2.hpp | 12 +- include/NumCpp/Functions/expm1.hpp | 12 +- include/NumCpp/Functions/eye.hpp | 23 +- include/NumCpp/Functions/fillDiagnol.hpp | 4 +- include/NumCpp/Functions/find.hpp | 7 +- include/NumCpp/Functions/fix.hpp | 12 +- include/NumCpp/Functions/flatnonzero.hpp | 6 +- include/NumCpp/Functions/flatten.hpp | 6 +- include/NumCpp/Functions/flip.hpp | 7 +- include/NumCpp/Functions/fliplr.hpp | 6 +- include/NumCpp/Functions/flipud.hpp | 6 +- include/NumCpp/Functions/floor.hpp | 4 +- include/NumCpp/Functions/floor_divide.hpp | 14 +- include/NumCpp/Functions/fmax.hpp | 14 +- include/NumCpp/Functions/fmin.hpp | 14 +- include/NumCpp/Functions/fmod.hpp | 21 +- include/NumCpp/Functions/frombuffer.hpp | 7 +- include/NumCpp/Functions/fromfile.hpp | 12 +- include/NumCpp/Functions/fromiter.hpp | 7 +- include/NumCpp/Functions/full.hpp | 23 +- include/NumCpp/Functions/full_like.hpp | 7 +- include/NumCpp/Functions/gcd.hpp | 12 +- include/NumCpp/Functions/gradient.hpp | 14 +- include/NumCpp/Functions/greater.hpp | 7 +- include/NumCpp/Functions/greater_equal.hpp | 7 +- include/NumCpp/Functions/hamming.hpp | 2 +- include/NumCpp/Functions/hanning.hpp | 2 +- include/NumCpp/Functions/histogram.hpp | 14 +- include/NumCpp/Functions/hstack.hpp | 6 +- include/NumCpp/Functions/hypot.hpp | 23 +- include/NumCpp/Functions/identity.hpp | 6 +- include/NumCpp/Functions/imag.hpp | 12 +- include/NumCpp/Functions/inner.hpp | 4 +- include/NumCpp/Functions/interp.hpp | 17 +- include/NumCpp/Functions/intersect1d.hpp | 7 +- include/NumCpp/Functions/invert.hpp | 6 +- include/NumCpp/Functions/isclose.hpp | 11 +- include/NumCpp/Functions/isinf.hpp | 12 +- include/NumCpp/Functions/isnan.hpp | 12 +- include/NumCpp/Functions/isneginf.hpp | 12 +- include/NumCpp/Functions/isposinf.hpp | 12 +- include/NumCpp/Functions/lcm.hpp | 12 +- include/NumCpp/Functions/ldexp.hpp | 14 +- include/NumCpp/Functions/left_shift.hpp | 7 +- include/NumCpp/Functions/less.hpp | 7 +- include/NumCpp/Functions/less_equal.hpp | 7 +- include/NumCpp/Functions/linspace.hpp | 11 +- include/NumCpp/Functions/load.hpp | 6 +- include/NumCpp/Functions/log.hpp | 12 +- include/NumCpp/Functions/log10.hpp | 12 +- include/NumCpp/Functions/log1p.hpp | 12 +- include/NumCpp/Functions/log2.hpp | 12 +- include/NumCpp/Functions/logical_and.hpp | 7 +- include/NumCpp/Functions/logical_not.hpp | 6 +- include/NumCpp/Functions/logical_or.hpp | 7 +- include/NumCpp/Functions/logical_xor.hpp | 7 +- include/NumCpp/Functions/matmul.hpp | 21 +- include/NumCpp/Functions/max.hpp | 7 +- include/NumCpp/Functions/maximum.hpp | 7 +- include/NumCpp/Functions/mean.hpp | 14 +- include/NumCpp/Functions/median.hpp | 7 +- include/NumCpp/Functions/meshgrid.hpp | 32 +- include/NumCpp/Functions/min.hpp | 7 +- include/NumCpp/Functions/minimum.hpp | 7 +- include/NumCpp/Functions/mod.hpp | 7 +- include/NumCpp/Functions/multiply.hpp | 63 +- include/NumCpp/Functions/nan_to_num.hpp | 11 +- include/NumCpp/Functions/nanargmax.hpp | 7 +- include/NumCpp/Functions/nanargmin.hpp | 7 +- include/NumCpp/Functions/nancumprod.hpp | 7 +- include/NumCpp/Functions/nancumsum.hpp | 7 +- include/NumCpp/Functions/nanmax.hpp | 7 +- include/NumCpp/Functions/nanmean.hpp | 7 +- include/NumCpp/Functions/nanmedian.hpp | 7 +- include/NumCpp/Functions/nanmin.hpp | 7 +- include/NumCpp/Functions/nanpercentile.hpp | 11 +- include/NumCpp/Functions/nanprod.hpp | 7 +- include/NumCpp/Functions/nans.hpp | 19 +- include/NumCpp/Functions/nans_like.hpp | 6 +- include/NumCpp/Functions/nanstdev.hpp | 7 +- include/NumCpp/Functions/nansum.hpp | 7 +- include/NumCpp/Functions/nanvar.hpp | 7 +- include/NumCpp/Functions/nbytes.hpp | 6 +- include/NumCpp/Functions/negative.hpp | 6 +- include/NumCpp/Functions/newbyteorder.hpp | 14 +- include/NumCpp/Functions/none.hpp | 7 +- include/NumCpp/Functions/nonzero.hpp | 6 +- include/NumCpp/Functions/norm.hpp | 14 +- include/NumCpp/Functions/not_equal.hpp | 7 +- include/NumCpp/Functions/ones.hpp | 18 +- include/NumCpp/Functions/ones_like.hpp | 6 +- include/NumCpp/Functions/outer.hpp | 6 +- include/NumCpp/Functions/pad.hpp | 9 +- include/NumCpp/Functions/partition.hpp | 9 +- include/NumCpp/Functions/percentile.hpp | 11 +- include/NumCpp/Functions/polar.hpp | 14 +- include/NumCpp/Functions/power.hpp | 21 +- include/NumCpp/Functions/powerf.hpp | 21 +- include/NumCpp/Functions/print.hpp | 6 +- include/NumCpp/Functions/prod.hpp | 7 +- include/NumCpp/Functions/proj.hpp | 12 +- include/NumCpp/Functions/ptp.hpp | 7 +- include/NumCpp/Functions/put.hpp | 18 +- include/NumCpp/Functions/putmask.hpp | 18 +- include/NumCpp/Functions/rad2deg.hpp | 12 +- include/NumCpp/Functions/radians.hpp | 12 +- include/NumCpp/Functions/ravel.hpp | 2 +- include/NumCpp/Functions/real.hpp | 12 +- include/NumCpp/Functions/reciprocal.hpp | 12 +- include/NumCpp/Functions/remainder.hpp | 14 +- include/NumCpp/Functions/repeat.hpp | 16 +- include/NumCpp/Functions/replace.hpp | 6 +- include/NumCpp/Functions/reshape.hpp | 23 +- include/NumCpp/Functions/resizeFast.hpp | 16 +- include/NumCpp/Functions/resizeSlow.hpp | 16 +- include/NumCpp/Functions/right_shift.hpp | 7 +- include/NumCpp/Functions/rint.hpp | 12 +- include/NumCpp/Functions/rms.hpp | 14 +- include/NumCpp/Functions/roll.hpp | 9 +- include/NumCpp/Functions/rot90.hpp | 7 +- include/NumCpp/Functions/round.hpp | 14 +- include/NumCpp/Functions/row_stack.hpp | 6 +- include/NumCpp/Functions/setdiff1d.hpp | 7 +- include/NumCpp/Functions/shape.hpp | 6 +- include/NumCpp/Functions/sign.hpp | 12 +- include/NumCpp/Functions/signbit.hpp | 12 +- include/NumCpp/Functions/sin.hpp | 12 +- include/NumCpp/Functions/sinc.hpp | 12 +- include/NumCpp/Functions/sinh.hpp | 12 +- include/NumCpp/Functions/size.hpp | 6 +- include/NumCpp/Functions/sort.hpp | 7 +- include/NumCpp/Functions/sqrt.hpp | 12 +- include/NumCpp/Functions/square.hpp | 12 +- include/NumCpp/Functions/stack.hpp | 7 +- include/NumCpp/Functions/stdev.hpp | 14 +- include/NumCpp/Functions/subtract.hpp | 63 +- include/NumCpp/Functions/sum.hpp | 7 +- include/NumCpp/Functions/swap.hpp | 4 +- include/NumCpp/Functions/swapaxes.hpp | 6 +- include/NumCpp/Functions/tan.hpp | 12 +- include/NumCpp/Functions/tanh.hpp | 12 +- include/NumCpp/Functions/tile.hpp | 16 +- include/NumCpp/Functions/toStlVector.hpp | 6 +- include/NumCpp/Functions/tofile.hpp | 16 +- include/NumCpp/Functions/trace.hpp | 9 +- include/NumCpp/Functions/transpose.hpp | 6 +- include/NumCpp/Functions/trapz.hpp | 18 +- include/NumCpp/Functions/tri.hpp | 46 +- include/NumCpp/Functions/trim_zeros.hpp | 7 +- include/NumCpp/Functions/trunc.hpp | 12 +- include/NumCpp/Functions/union1d.hpp | 7 +- include/NumCpp/Functions/unique.hpp | 6 +- include/NumCpp/Functions/unwrap.hpp | 12 +- include/NumCpp/Functions/var.hpp | 14 +- include/NumCpp/Functions/vstack.hpp | 6 +- include/NumCpp/Functions/where.hpp | 32 +- include/NumCpp/Functions/zeros.hpp | 19 +- include/NumCpp/Functions/zeros_like.hpp | 6 +- include/NumCpp/ImageProcessing/Centroid.hpp | 45 +- include/NumCpp/ImageProcessing/Cluster.hpp | 79 +- .../NumCpp/ImageProcessing/ClusterMaker.hpp | 58 +- include/NumCpp/ImageProcessing/Pixel.hpp | 34 +- .../NumCpp/ImageProcessing/applyThreshold.hpp | 7 +- .../ImageProcessing/centroidClusters.hpp | 5 +- .../NumCpp/ImageProcessing/clusterPixels.hpp | 9 +- .../ImageProcessing/generateCentroids.hpp | 11 +- .../ImageProcessing/generateThreshold.hpp | 7 +- .../ImageProcessing/windowExceedances.hpp | 7 +- include/NumCpp/Integrate/gauss_legendre.hpp | 16 +- include/NumCpp/Integrate/romberg.hpp | 10 +- include/NumCpp/Integrate/simpson.hpp | 10 +- include/NumCpp/Integrate/trapazoidal.hpp | 10 +- include/NumCpp/Linalg/cholesky.hpp | 4 +- include/NumCpp/Linalg/det.hpp | 6 +- include/NumCpp/Linalg/gaussNewtonNlls.hpp | 14 +- include/NumCpp/Linalg/hat.hpp | 21 +- include/NumCpp/Linalg/inv.hpp | 6 +- include/NumCpp/Linalg/lstsq.hpp | 9 +- include/NumCpp/Linalg/lu_decomposition.hpp | 4 +- include/NumCpp/Linalg/matrix_power.hpp | 7 +- include/NumCpp/Linalg/multi_dot.hpp | 6 +- .../NumCpp/Linalg/pivotLU_decomposition.hpp | 4 +- include/NumCpp/Linalg/svd.hpp | 8 +- include/NumCpp/Linalg/svd/SVDClass.hpp | 33 +- include/NumCpp/NdArray/NdArrayCore.hpp | 867 +++++++----------- include/NumCpp/NdArray/NdArrayOperators.hpp | 668 +++++++------- include/NumCpp/Polynomial/Poly1d.hpp | 74 +- include/NumCpp/Polynomial/chebyshev_t.hpp | 14 +- include/NumCpp/Polynomial/chebyshev_u.hpp | 14 +- include/NumCpp/Polynomial/hermite.hpp | 14 +- include/NumCpp/Polynomial/laguerre.hpp | 32 +- include/NumCpp/Polynomial/legendre_p.hpp | 32 +- include/NumCpp/Polynomial/legendre_q.hpp | 14 +- .../NumCpp/Polynomial/spherical_harmonic.hpp | 33 +- .../NumCpp/PythonInterface/BoostInterface.hpp | 20 +- .../BoostNumpyNdarrayHelper.hpp | 40 +- .../PythonInterface/PybindInterface.hpp | 18 +- include/NumCpp/Random/bernoilli.hpp | 12 +- include/NumCpp/Random/beta.hpp | 16 +- include/NumCpp/Random/binomial.hpp | 16 +- include/NumCpp/Random/cauchy.hpp | 16 +- include/NumCpp/Random/chiSquare.hpp | 12 +- include/NumCpp/Random/choice.hpp | 14 +- include/NumCpp/Random/discrete.hpp | 12 +- include/NumCpp/Random/exponential.hpp | 12 +- include/NumCpp/Random/extremeValue.hpp | 16 +- include/NumCpp/Random/f.hpp | 16 +- include/NumCpp/Random/gamma.hpp | 16 +- include/NumCpp/Random/generator.hpp | 3 +- include/NumCpp/Random/geometric.hpp | 12 +- include/NumCpp/Random/laplace.hpp | 16 +- include/NumCpp/Random/lognormal.hpp | 16 +- include/NumCpp/Random/negativeBinomial.hpp | 16 +- .../NumCpp/Random/nonCentralChiSquared.hpp | 16 +- include/NumCpp/Random/normal.hpp | 16 +- include/NumCpp/Random/permutation.hpp | 12 +- include/NumCpp/Random/poisson.hpp | 12 +- include/NumCpp/Random/rand.hpp | 9 +- include/NumCpp/Random/randFloat.hpp | 16 +- include/NumCpp/Random/randInt.hpp | 16 +- include/NumCpp/Random/randN.hpp | 6 +- include/NumCpp/Random/shuffle.hpp | 3 +- include/NumCpp/Random/standardNormal.hpp | 9 +- include/NumCpp/Random/studentT.hpp | 12 +- include/NumCpp/Random/triangle.hpp | 20 +- include/NumCpp/Random/uniform.hpp | 16 +- include/NumCpp/Random/uniformOnSphere.hpp | 7 +- include/NumCpp/Random/weibull.hpp | 16 +- include/NumCpp/Rotations/DCM.hpp | 64 +- include/NumCpp/Rotations/Quaternion.hpp | 232 ++--- .../NumCpp/Rotations/rodriguesRotation.hpp | 12 +- include/NumCpp/Rotations/wahbasProblem.hpp | 10 +- include/NumCpp/Special/airy_ai.hpp | 12 +- include/NumCpp/Special/airy_ai_prime.hpp | 12 +- include/NumCpp/Special/airy_bi.hpp | 12 +- include/NumCpp/Special/airy_bi_prime.hpp | 12 +- include/NumCpp/Special/bernoulli.hpp | 12 +- include/NumCpp/Special/bessel_in.hpp | 14 +- include/NumCpp/Special/bessel_in_prime.hpp | 14 +- include/NumCpp/Special/bessel_jn.hpp | 14 +- include/NumCpp/Special/bessel_jn_prime.hpp | 14 +- include/NumCpp/Special/bessel_kn.hpp | 14 +- include/NumCpp/Special/bessel_kn_prime.hpp | 14 +- include/NumCpp/Special/bessel_yn.hpp | 14 +- include/NumCpp/Special/bessel_yn_prime.hpp | 14 +- include/NumCpp/Special/beta.hpp | 14 +- include/NumCpp/Special/cnr.hpp | 7 +- include/NumCpp/Special/comp_ellint_1.hpp | 10 +- include/NumCpp/Special/comp_ellint_2.hpp | 10 +- include/NumCpp/Special/comp_ellint_3.hpp | 14 +- include/NumCpp/Special/cyclic_hankel_1.hpp | 14 +- include/NumCpp/Special/cyclic_hankel_2.hpp | 14 +- include/NumCpp/Special/digamma.hpp | 12 +- include/NumCpp/Special/ellint_1.hpp | 14 +- include/NumCpp/Special/ellint_2.hpp | 14 +- include/NumCpp/Special/ellint_3.hpp | 18 +- include/NumCpp/Special/erf.hpp | 12 +- include/NumCpp/Special/erf_inv.hpp | 12 +- include/NumCpp/Special/erfc.hpp | 12 +- include/NumCpp/Special/erfc_inv.hpp | 12 +- include/NumCpp/Special/expint.hpp | 10 +- include/NumCpp/Special/factorial.hpp | 12 +- include/NumCpp/Special/gamma.hpp | 12 +- include/NumCpp/Special/gamma1pm1.hpp | 12 +- include/NumCpp/Special/log_gamma.hpp | 12 +- include/NumCpp/Special/pnr.hpp | 7 +- include/NumCpp/Special/polygamma.hpp | 6 +- include/NumCpp/Special/prime.hpp | 12 +- include/NumCpp/Special/riemann_zeta.hpp | 12 +- include/NumCpp/Special/softmax.hpp | 6 +- .../NumCpp/Special/spherical_bessel_jn.hpp | 14 +- .../NumCpp/Special/spherical_bessel_yn.hpp | 14 +- include/NumCpp/Special/spherical_hankel_1.hpp | 14 +- include/NumCpp/Special/spherical_hankel_2.hpp | 14 +- include/NumCpp/Special/trigamma.hpp | 12 +- include/NumCpp/Utils/cube.hpp | 4 +- include/NumCpp/Utils/essentiallyEqual.hpp | 40 +- include/NumCpp/Utils/gaussian.hpp | 8 +- include/NumCpp/Utils/gaussian1d.hpp | 8 +- include/NumCpp/Utils/interp.hpp | 8 +- include/NumCpp/Utils/num2str.hpp | 4 +- include/NumCpp/Utils/power.hpp | 6 +- include/NumCpp/Utils/powerf.hpp | 6 +- include/NumCpp/Utils/sqr.hpp | 4 +- include/NumCpp/Utils/value2str.hpp | 4 +- include/NumCpp/Vector/Vec2.hpp | 120 +-- include/NumCpp/Vector/Vec3.hpp | 126 +-- 411 files changed, 3124 insertions(+), 4262 deletions(-) diff --git a/include/NumCpp/Coordinates/Coordinate.hpp b/include/NumCpp/Coordinates/Coordinate.hpp index 859a438c6..b9a785bc0 100644 --- a/include/NumCpp/Coordinates/Coordinate.hpp +++ b/include/NumCpp/Coordinates/Coordinate.hpp @@ -58,8 +58,8 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inRaDegrees - /// @param inDecDegrees + /// @param inRaDegrees + /// @param inDecDegrees /// Coordinate(double inRaDegrees, double inDecDegrees) : ra_(inRaDegrees), @@ -71,13 +71,13 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inRaHours - /// @param inRaMinutes - /// @param inRaSeconds - /// @param inSign - /// @param inDecDegreesWhole - /// @param inDecMinutes - /// @param inDecSeconds + /// @param inRaHours + /// @param inRaMinutes + /// @param inRaSeconds + /// @param inSign + /// @param inDecDegreesWhole + /// @param inDecMinutes + /// @param inDecSeconds /// Coordinate(uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds) : @@ -90,8 +90,8 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inRA - /// @param inDec + /// @param inRA + /// @param inDec /// Coordinate(const RA& inRA, const Dec& inDec) noexcept : ra_(inRA), @@ -103,9 +103,9 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inX - /// @param inY - /// @param inZ + /// @param inX + /// @param inY + /// @param inZ /// Coordinate(double inX, double inY, double inZ) noexcept : x_(inX), @@ -118,7 +118,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inCartesianVector + /// @param inCartesianVector /// Coordinate(const NdArray& inCartesianVector) { @@ -137,7 +137,7 @@ namespace nc //============================================================================ /// Returns the Dec object /// - /// @return Dec + /// @return Dec /// const Dec& dec() const noexcept { @@ -147,7 +147,7 @@ namespace nc //============================================================================ /// Returns the RA object /// - /// @return RA + /// @return RA /// const RA& ra() const noexcept { @@ -157,7 +157,7 @@ namespace nc //============================================================================ /// Returns the cartesian x value /// - /// @return x + /// @return x /// double x() const noexcept { @@ -167,7 +167,7 @@ namespace nc //============================================================================ /// Returns the cartesian y value /// - /// @return y + /// @return y /// double y() const noexcept { @@ -177,7 +177,7 @@ namespace nc //============================================================================ /// Returns the cartesian z value /// - /// @return z + /// @return z /// double z() const noexcept { @@ -187,7 +187,7 @@ namespace nc //============================================================================ /// Returns the cartesian xyz triplet as an NdArray /// - /// @return NdArray + /// @return NdArray /// NdArray xyz() const { @@ -198,9 +198,9 @@ namespace nc //============================================================================ /// Returns the degree seperation between the two Coordinates /// - /// @param inOtherCoordinate + /// @param inOtherCoordinate /// - /// @return degrees + /// @return degrees /// double degreeSeperation(const Coordinate& inOtherCoordinate) const { @@ -211,9 +211,9 @@ namespace nc /// Returns the degree seperation between the Coordinate /// and the input vector /// - /// @param inVector + /// @param inVector /// - /// @return degrees + /// @return degrees /// double degreeSeperation(const NdArray& inVector) const { @@ -223,9 +223,9 @@ namespace nc //============================================================================ /// Returns the radian seperation between the two Coordinates /// - /// @param inOtherCoordinate + /// @param inOtherCoordinate /// - /// @return radians + /// @return radians /// double radianSeperation(const Coordinate& inOtherCoordinate) const { @@ -236,9 +236,9 @@ namespace nc /// Returns the radian seperation between the Coordinate /// and the input vector /// - /// @param inVector + /// @param inVector /// - /// @return radians + /// @return radians /// double radianSeperation(const NdArray& inVector) const { @@ -253,7 +253,7 @@ namespace nc //============================================================================ /// Returns coordinate as a string representation /// - /// @return string + /// @return string /// std::string str() const { @@ -275,9 +275,9 @@ namespace nc //============================================================================ /// Equality operator /// - /// @param inRhs + /// @param inRhs /// - /// @return bool + /// @return bool /// bool operator==(const Coordinate& inRhs) const noexcept { @@ -287,9 +287,9 @@ namespace nc //============================================================================ /// Not equality operator /// - /// @param inRhs + /// @param inRhs /// - /// @return bool + /// @return bool /// bool operator!=(const Coordinate& inRhs) const noexcept { @@ -299,10 +299,10 @@ namespace nc //============================================================================ /// Ostream operator /// - /// @param inStream - /// @param inCoord + /// @param inStream + /// @param inCoord /// - /// @return std::ostream + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Coordinate& inCoord) { diff --git a/include/NumCpp/Coordinates/Dec.hpp b/include/NumCpp/Coordinates/Dec.hpp index 1c81e7295..552724308 100644 --- a/include/NumCpp/Coordinates/Dec.hpp +++ b/include/NumCpp/Coordinates/Dec.hpp @@ -58,7 +58,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inDegrees + /// @param inDegrees /// explicit Dec(double inDegrees) : degrees_(inDegrees), @@ -81,10 +81,10 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inSign - /// @param inDegrees - /// @param inMinutes - /// @param inSeconds + /// @param inSign + /// @param inDegrees + /// @param inMinutes + /// @param inSeconds /// Dec(Sign inSign, uint8 inDegrees, uint8 inMinutes, double inSeconds) noexcept : sign_(inSign), @@ -101,7 +101,7 @@ namespace nc //============================================================================ /// Get the sign of the degrees (positive or negative) /// - /// @return Sign + /// @return Sign /// Sign sign() const noexcept { @@ -111,7 +111,7 @@ namespace nc //============================================================================ /// Get the degrees value /// - /// @return degrees + /// @return degrees /// double degrees() const noexcept { @@ -121,7 +121,7 @@ namespace nc //============================================================================ /// Get the radians value /// - /// @return minutes + /// @return minutes /// double radians() const noexcept { @@ -131,7 +131,7 @@ namespace nc //============================================================================ /// Get the whole degrees value /// - /// @return whole degrees + /// @return whole degrees /// uint8 degreesWhole() const noexcept { @@ -141,7 +141,7 @@ namespace nc //============================================================================ /// Get the minute value /// - /// @return minutes + /// @return minutes /// uint8 minutes() const noexcept { @@ -151,7 +151,7 @@ namespace nc //============================================================================ /// Get the seconds value /// - /// @return seconds + /// @return seconds /// double seconds() const noexcept { @@ -161,7 +161,7 @@ namespace nc //============================================================================ /// Return the dec object as a string representation /// - /// @return std::string + /// @return std::string /// std::string str() const { @@ -182,9 +182,9 @@ namespace nc //============================================================================ /// Equality operator /// - /// @param inRhs + /// @param inRhs /// - /// @return bool + /// @return bool /// bool operator==(const Dec& inRhs) const noexcept { @@ -194,9 +194,9 @@ namespace nc //============================================================================ /// Not equality operator /// - /// @param inRhs + /// @param inRhs /// - /// @return bool + /// @return bool /// bool operator!=(const Dec& inRhs) const noexcept { @@ -206,10 +206,10 @@ namespace nc //============================================================================ /// Ostream operator /// - /// @param inStream - /// @param inDec + /// @param inStream + /// @param inDec /// - /// @return std::ostream + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Dec& inDec) { diff --git a/include/NumCpp/Coordinates/RA.hpp b/include/NumCpp/Coordinates/RA.hpp index 9f2658909..fb1fc7365 100644 --- a/include/NumCpp/Coordinates/RA.hpp +++ b/include/NumCpp/Coordinates/RA.hpp @@ -54,7 +54,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inDegrees + /// @param inDegrees /// explicit RA(double inDegrees) : degrees_(inDegrees), @@ -74,9 +74,9 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inHours - /// @param inMinutes - /// @param inSeconds + /// @param inHours + /// @param inMinutes + /// @param inSeconds /// RA(uint8 inHours, uint8 inMinutes, double inSeconds) noexcept : hours_(inHours), @@ -90,7 +90,7 @@ namespace nc //============================================================================ /// Get the radians value /// - /// @return radians + /// @return radians /// double radians() const noexcept { @@ -100,7 +100,7 @@ namespace nc //============================================================================ /// Get the degrees value /// - /// @return degrees + /// @return degrees /// double degrees() const noexcept { @@ -110,7 +110,7 @@ namespace nc //============================================================================ /// Get the hour value /// - /// @return hours + /// @return hours /// uint8 hours() const noexcept { @@ -120,7 +120,7 @@ namespace nc //============================================================================ /// Get the minute value /// - /// @return minutes + /// @return minutes /// uint8 minutes() const noexcept { @@ -130,7 +130,7 @@ namespace nc //============================================================================ /// Get the seconds value /// - /// @return seconds + /// @return seconds /// double seconds() const noexcept { @@ -140,7 +140,7 @@ namespace nc //============================================================================ /// Return the RA object as a string representation /// - /// @return std::string + /// @return std::string /// std::string str() const { @@ -160,9 +160,9 @@ namespace nc //============================================================================ /// Equality operator /// - /// @param inRhs + /// @param inRhs /// - /// @return bool + /// @return bool /// bool operator==(const RA& inRhs) const noexcept { @@ -172,9 +172,9 @@ namespace nc //============================================================================ /// Not equality operator /// - /// @param inRhs + /// @param inRhs /// - /// @return bool + /// @return bool /// bool operator!=(const RA& inRhs) const noexcept { @@ -184,8 +184,8 @@ namespace nc //============================================================================ /// Ostream operator /// - /// @param inStream - /// @param inRa + /// @param inStream + /// @param inRa /// friend std::ostream& operator<<(std::ostream& inStream, const RA& inRa) { diff --git a/include/NumCpp/Coordinates/degreeSeperation.hpp b/include/NumCpp/Coordinates/degreeSeperation.hpp index 84247ebcb..f6c93ae49 100644 --- a/include/NumCpp/Coordinates/degreeSeperation.hpp +++ b/include/NumCpp/Coordinates/degreeSeperation.hpp @@ -37,10 +37,10 @@ namespace nc //============================================================================ /// Returns the degree seperation between the two Coordinates /// - /// @param inCoordinate1 - /// @param inCoordinate2 + /// @param inCoordinate1 + /// @param inCoordinate2 /// - /// @return degrees + /// @return degrees /// inline double degreeSeperation(const Coordinate& inCoordinate1, const Coordinate& inCoordinate2) { @@ -51,10 +51,10 @@ namespace nc /// Returns the degree seperation between the Coordinate /// and the input vector /// - /// @param inVector1 - /// @param inVector2 + /// @param inVector1 + /// @param inVector2 /// - /// @return degrees + /// @return degrees /// inline double degreeSeperation(const NdArray& inVector1, const NdArray& inVector2) { diff --git a/include/NumCpp/Coordinates/radianSeperation.hpp b/include/NumCpp/Coordinates/radianSeperation.hpp index 0dc7ad778..1738fb227 100644 --- a/include/NumCpp/Coordinates/radianSeperation.hpp +++ b/include/NumCpp/Coordinates/radianSeperation.hpp @@ -37,10 +37,10 @@ namespace nc //============================================================================ /// Returns the radian seperation between the two Coordinates /// - /// @param inCoordinate1 - /// @param inCoordinate2 + /// @param inCoordinate1 + /// @param inCoordinate2 /// - /// @return radians + /// @return radians /// inline double radianSeperation(const Coordinate& inCoordinate1, const Coordinate& inCoordinate2) { @@ -51,10 +51,10 @@ namespace nc /// Returns the radian seperation between the Coordinate /// and the input vector /// - /// @param inVector1 - /// @param inVector2 + /// @param inVector1 + /// @param inVector2 /// - /// @return radians + /// @return radians /// inline double radianSeperation(const NdArray& inVector1, const NdArray& inVector2) { diff --git a/include/NumCpp/Core/DataCube.hpp b/include/NumCpp/Core/DataCube.hpp index a2dc95038..4b5d44f8a 100644 --- a/include/NumCpp/Core/DataCube.hpp +++ b/include/NumCpp/Core/DataCube.hpp @@ -58,7 +58,7 @@ namespace nc //============================================================================ /// Constructor, preallocates to the input size /// - /// @param inSize + /// @param inSize /// explicit DataCube(uint32 inSize) { @@ -68,9 +68,9 @@ namespace nc //============================================================================ /// Access method, with bounds checking. Returns the 2d z "slice" element of the cube. /// - /// @param inIndex + /// @param inIndex /// - /// @return NdArray + /// @return NdArray /// NdArray& at(uint32 inIndex) { @@ -80,9 +80,9 @@ namespace nc //============================================================================ /// Const access method, with bounds checking. Returns the 2d z "slice" element of the cube. /// - /// @param inIndex + /// @param inIndex /// - /// @return NdArray + /// @return NdArray /// const NdArray& at(uint32 inIndex) const { @@ -92,7 +92,7 @@ namespace nc //============================================================================ /// Returns a reference to the last 2d "slice" of the cube in the z-axis /// - /// @return NdArray& + /// @return NdArray& /// NdArray& back() noexcept { @@ -102,7 +102,7 @@ namespace nc //============================================================================ /// Returns an iterator to the first 2d z "slice" of the cube. /// - /// @return iterator + /// @return iterator /// iterator begin() noexcept { @@ -112,7 +112,7 @@ namespace nc //============================================================================ /// Returns an const_iterator to the first 2d z "slice" of the cube. /// - /// @return const_iterator + /// @return const_iterator /// const_iterator cbegin() const noexcept { @@ -122,7 +122,7 @@ namespace nc //============================================================================ /// Outputs the DataCube as a .bin file /// - /// @param inFilename + /// @param inFilename /// void dump(const std::string& inFilename) const { @@ -149,7 +149,7 @@ namespace nc //============================================================================ /// Tests whether or not the container is empty /// - /// @return bool + /// @return bool /// bool isempty() noexcept { @@ -159,7 +159,7 @@ namespace nc //============================================================================ /// Returns an iterator to 1 past the last 2d z "slice" of the cube. /// - /// @return iterator + /// @return iterator /// iterator end() noexcept { @@ -169,7 +169,7 @@ namespace nc //============================================================================ /// Returns an const_iterator to 1 past the last 2d z "slice" of the cube. /// - /// @return const_iterator + /// @return const_iterator /// const_iterator cend() const noexcept { @@ -179,7 +179,7 @@ namespace nc //============================================================================ /// Returns a reference to the front 2d "slice" of the cube in the z-axis /// - /// @return NdArray& + /// @return NdArray& /// NdArray& front() noexcept { @@ -189,7 +189,7 @@ namespace nc //============================================================================ /// Returns the x/y shape of the cube /// - /// @return Shape + /// @return Shape /// const Shape& shape() const noexcept { @@ -199,7 +199,7 @@ namespace nc //============================================================================ /// Returns the size of the z-axis of the cube /// - /// @return size + /// @return size /// uint32 sizeZ() const noexcept { @@ -217,7 +217,7 @@ namespace nc //============================================================================ /// Adds a new z "slice" to the end of the cube /// - /// @param inArray + /// @param inArray /// void push_back(const NdArray& inArray) { @@ -241,8 +241,8 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube /// - /// @param inIndex: the flattend 2d index (row, col) to slice - /// @return NdArray + /// @param inIndex: the flattend 2d index (row, col) to slice + /// @return NdArray /// NdArray sliceZAll(int32 inIndex) const { @@ -264,9 +264,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube /// - /// @param inIndex: the flattend 2d index (row, col) to slice - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inIndex: the flattend 2d index (row, col) to slice + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZ(int32 inIndex, Slice inSliceZ) const { @@ -289,9 +289,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @return NdArray + /// @param inRow + /// @param inCol + /// @return NdArray /// NdArray sliceZAll(int32 inRow, int32 inCol) const { @@ -318,10 +318,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZ(int32 inRow, int32 inCol, Slice inSliceZ) const { @@ -349,9 +349,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @return NdArray + /// @param inRow + /// @param inCol + /// @return NdArray /// NdArray sliceZAll(Slice inRow, int32 inCol) const { @@ -372,10 +372,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZ(Slice inRow, int32 inCol, Slice inSliceZ) const { @@ -397,9 +397,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @return NdArray + /// @param inRow + /// @param inCol + /// @return NdArray /// NdArray sliceZAll(int32 inRow, Slice inCol) const { @@ -420,10 +420,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZ(int32 inRow, Slice inCol, Slice inSliceZ) const { @@ -445,9 +445,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @return DataCube + /// @param inRow + /// @param inCol + /// @return DataCube /// DataCube sliceZAll(Slice inRow, Slice inCol) const { @@ -463,10 +463,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with NO bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return DataCube + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return DataCube /// DataCube sliceZ(Slice inRow, Slice inCol, Slice inSliceZ) const { @@ -482,8 +482,8 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inIndex: the flattend 2d index (row, col) to slice - /// @return NdArray + /// @param inIndex: the flattend 2d index (row, col) to slice + /// @return NdArray /// NdArray sliceZAllat(int32 inIndex) const { @@ -503,9 +503,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inIndex: the flattend 2d index (row, col) to slice - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inIndex: the flattend 2d index (row, col) to slice + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZat(int32 inIndex, Slice inSliceZ) const { @@ -531,9 +531,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @return NdArray + /// @param inRow + /// @param inCol + /// @return NdArray /// NdArray sliceZAllat(int32 inRow, int32 inCol) const { @@ -563,10 +563,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZat(int32 inRow, int32 inCol, Slice inSliceZ) const { @@ -601,9 +601,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @return NdArray + /// @param inRow + /// @param inCol + /// @return NdArray /// NdArray sliceZAllat(Slice inRow, int32 inCol) const { @@ -629,10 +629,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZat(Slice inRow, int32 inCol, Slice inSliceZ) const { @@ -664,9 +664,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @return NdArray + /// @param inRow + /// @param inCol + /// @return NdArray /// NdArray sliceZAllat(int32 inRow, Slice inCol) const { @@ -692,10 +692,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return NdArray + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return NdArray /// NdArray sliceZat(int32 inRow, Slice inCol, Slice inSliceZ) const { @@ -727,9 +727,9 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @return DataCube + /// @param inRow + /// @param inCol + /// @return DataCube /// DataCube sliceZAllat(Slice inRow, Slice inCol) const { @@ -749,10 +749,10 @@ namespace nc //============================================================================ /// Slices the z dimension of the cube with bounds checking /// - /// @param inRow - /// @param inCol - /// @param inSliceZ: the slice dimensions of the z-axis - /// @return DataCube + /// @param inRow + /// @param inCol + /// @param inSliceZ: the slice dimensions of the z-axis + /// @return DataCube /// DataCube sliceZat(Slice inRow, Slice inCol, Slice inSliceZ) const { @@ -778,9 +778,9 @@ namespace nc //============================================================================ /// Access operator, no bounds checking. Returns the 2d z "slice" element of the cube. /// - /// @param inIndex + /// @param inIndex /// - /// @return NdArray + /// @return NdArray /// NdArray& operator[](uint32 inIndex) noexcept { @@ -790,9 +790,9 @@ namespace nc //============================================================================ /// Const access operator, no bounds checking. Returns the 2d z "slice" element of the cube. /// - /// @param inIndex + /// @param inIndex /// - /// @return NdArray + /// @return NdArray /// const NdArray& operator[](uint32 inIndex) const noexcept { diff --git a/include/NumCpp/Core/DtypeInfo.hpp b/include/NumCpp/Core/DtypeInfo.hpp index 503d8b618..2bee1bdac 100644 --- a/include/NumCpp/Core/DtypeInfo.hpp +++ b/include/NumCpp/Core/DtypeInfo.hpp @@ -44,7 +44,7 @@ namespace nc /// For integer types: number of non-sign bits in the representation. /// For floating types : number of digits(in radix base) in the mantissa /// - /// @return number of bits + /// @return number of bits /// static constexpr int bits() noexcept { @@ -57,7 +57,7 @@ namespace nc /// Machine epsilon (the difference between 1 and the least /// value greater than 1 that is representable). /// - /// @return dtype + /// @return dtype /// static constexpr dtype epsilon() noexcept { @@ -69,7 +69,7 @@ namespace nc //============================================================================ /// True if type is integer. /// - /// @return bool + /// @return bool /// static constexpr bool isInteger() noexcept { @@ -81,7 +81,7 @@ namespace nc //============================================================================ /// True if type is signed. /// - /// @return bool + /// @return bool /// static constexpr bool isSigned() noexcept { @@ -93,7 +93,7 @@ namespace nc //============================================================================ /// Returns the minimum value of the dtype /// - /// @return min value + /// @return min value /// static constexpr dtype min() noexcept { @@ -105,7 +105,7 @@ namespace nc //============================================================================ /// Returns the maximum value of the dtype /// - /// @return max value + /// @return max value /// static constexpr dtype max() noexcept { @@ -125,7 +125,7 @@ namespace nc /// For integer types: number of non-sign bits in the representation. /// For floating types : number of digits(in radix base) in the mantissa /// - /// @return number of bits + /// @return number of bits /// static constexpr int bits() noexcept { @@ -138,7 +138,7 @@ namespace nc /// Machine epsilon (the difference between 1 and the least /// value greater than 1 that is representable). /// - /// @return dtype + /// @return dtype /// static constexpr std::complex epsilon() noexcept { @@ -150,7 +150,7 @@ namespace nc //============================================================================ /// True if type is integer. /// - /// @return bool + /// @return bool /// static constexpr bool isInteger() noexcept { @@ -162,7 +162,7 @@ namespace nc //============================================================================ /// True if type is signed. /// - /// @return bool + /// @return bool /// static constexpr bool isSigned() noexcept { @@ -174,7 +174,7 @@ namespace nc //============================================================================ /// Returns the minimum value of the dtype /// - /// @return min value + /// @return min value /// static constexpr std::complex min() noexcept { @@ -186,7 +186,7 @@ namespace nc //============================================================================ /// Returns the maximum value of the dtype /// - /// @return max value + /// @return max value /// static constexpr std::complex max() noexcept { diff --git a/include/NumCpp/Core/Internal/Endian.hpp b/include/NumCpp/Core/Internal/Endian.hpp index 07d28330d..b462f2a2e 100644 --- a/include/NumCpp/Core/Internal/Endian.hpp +++ b/include/NumCpp/Core/Internal/Endian.hpp @@ -56,7 +56,7 @@ namespace nc // Function Description: /// Swaps the bytes of the input value /// - /// @param value + /// @param value /// @return byte swapped value /// template diff --git a/include/NumCpp/Core/Internal/Error.hpp b/include/NumCpp/Core/Internal/Error.hpp index 6b52e1061..3e35c561e 100644 --- a/include/NumCpp/Core/Internal/Error.hpp +++ b/include/NumCpp/Core/Internal/Error.hpp @@ -43,10 +43,10 @@ namespace nc //============================================================================ /// Makes the full error message string /// - /// @param file: the file - /// @param function: the function - /// @param line: the line of the file - /// @param msg: the message to throw (default "") + /// @param file: the file + /// @param function: the function + /// @param line: the line of the file + /// @param msg: the message to throw (default "") /// template void throwError(const std::string& file, diff --git a/include/NumCpp/Core/Internal/Filesystem.hpp b/include/NumCpp/Core/Internal/Filesystem.hpp index bbcb6a9ef..76ac6f415 100644 --- a/include/NumCpp/Core/Internal/Filesystem.hpp +++ b/include/NumCpp/Core/Internal/Filesystem.hpp @@ -65,7 +65,7 @@ namespace nc // Method Description: /// Tests whether or not the file exists /// - /// @return bool + /// @return bool /// bool exists() const noexcept { @@ -76,7 +76,7 @@ namespace nc // Method Description: /// Returns the file extension without the dot /// - /// @return std::string + /// @return std::string /// const std::string& ext() const noexcept { @@ -87,7 +87,7 @@ namespace nc // Method Description: /// Returns the input full filename /// - /// @return std::string + /// @return std::string /// std::string fullName() const { @@ -98,7 +98,7 @@ namespace nc // Method Description: /// Returns true if the file has an extension /// - /// @return bool + /// @return bool /// bool hasExt() const { @@ -109,7 +109,7 @@ namespace nc // Method Description: /// Returns the filename /// - /// @return std::string + /// @return std::string /// const std::string& name() const noexcept { @@ -121,7 +121,7 @@ namespace nc /// Sets the extension to the input extension. Do not input the dot. /// E.g. input "txt", not ".txt" /// - /// @return std::string + /// @return std::string /// std::string withExt(const std::string& ext) { diff --git a/include/NumCpp/Core/Internal/StdComplexOperators.hpp b/include/NumCpp/Core/Internal/StdComplexOperators.hpp index 8eef74887..0de04ffa1 100644 --- a/include/NumCpp/Core/Internal/StdComplexOperators.hpp +++ b/include/NumCpp/Core/Internal/StdComplexOperators.hpp @@ -37,9 +37,9 @@ namespace nc // Method Description: /// Less than operator for std::complex /// - /// @param lhs - /// @param rhs - /// @return bool true if lhs < rhs + /// @param lhs + /// @param rhs + /// @return bool true if lhs < rhs /// template bool operator<(const std::complex& lhs, const std::complex& rhs) noexcept @@ -56,9 +56,9 @@ namespace nc // Method Description: /// Less than or equal operator for std::complex /// - /// @param lhs - /// @param rhs - /// @return bool true if lhs <= rhs + /// @param lhs + /// @param rhs + /// @return bool true if lhs <= rhs /// template bool operator<=(const std::complex& lhs, const std::complex& rhs) noexcept @@ -75,9 +75,9 @@ namespace nc // Method Description: /// Greater than operator for std::complex /// - /// @param lhs - /// @param rhs - /// @return bool true if lhs > rhs + /// @param lhs + /// @param rhs + /// @return bool true if lhs > rhs /// template bool operator>(const std::complex& lhs, const std::complex& rhs) noexcept @@ -89,9 +89,9 @@ namespace nc // Method Description: /// Greater than or equal operator for std::complex /// - /// @param lhs - /// @param rhs - /// @return bool true if lhs >= rhs + /// @param lhs + /// @param rhs + /// @return bool true if lhs >= rhs /// template bool operator>=(const std::complex& lhs, const std::complex& rhs) noexcept @@ -103,8 +103,8 @@ namespace nc // Method Description: /// Greater than or equal operator for std::complex /// - /// @param value - /// @return std::complex + /// @param value + /// @return std::complex /// template std::complex complex_cast(const std::complex& value) noexcept diff --git a/include/NumCpp/Core/Shape.hpp b/include/NumCpp/Core/Shape.hpp index c7f1ea28e..ba78f5367 100644 --- a/include/NumCpp/Core/Shape.hpp +++ b/include/NumCpp/Core/Shape.hpp @@ -52,7 +52,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inSquareSize + /// @param inSquareSize /// constexpr explicit Shape(uint32 inSquareSize) noexcept : rows(inSquareSize), @@ -62,8 +62,8 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inRows - /// @param inCols + /// @param inRows + /// @param inCols /// constexpr Shape(uint32 inRows, uint32 inCols) noexcept : rows(inRows), @@ -73,9 +73,9 @@ namespace nc //============================================================================ /// Equality operator /// - /// @param inOtherShape + /// @param inOtherShape /// - /// @return bool + /// @return bool /// bool operator==(const Shape& inOtherShape) const noexcept { @@ -85,9 +85,9 @@ namespace nc //============================================================================ /// Not equality operator /// - /// @param inOtherShape + /// @param inOtherShape /// - /// @return bool + /// @return bool /// bool operator!=(const Shape& inOtherShape) const noexcept { @@ -97,7 +97,7 @@ namespace nc //============================================================================ /// Returns the size of the shape /// - /// @return size + /// @return size /// uint32 size() const noexcept { @@ -108,7 +108,7 @@ namespace nc /// Returns whether the shape is null (constructed with the /// default constructor). /// - /// @return bool + /// @return bool /// bool isnull() const noexcept { @@ -118,7 +118,7 @@ namespace nc //============================================================================ /// Returns whether the shape is square or not. /// - /// @return bool + /// @return bool /// bool issquare() const noexcept { @@ -128,7 +128,7 @@ namespace nc //============================================================================ /// Returns the shape as a string representation /// - /// @return std::string + /// @return std::string /// std::string str() const { @@ -147,10 +147,10 @@ namespace nc //============================================================================ /// IO operator for the Shape class /// - /// @param inOStream - /// @param inShape + /// @param inOStream + /// @param inShape /// - /// @return std::ostream + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inOStream, const Shape& inShape) { diff --git a/include/NumCpp/Core/Slice.hpp b/include/NumCpp/Core/Slice.hpp index 548d0fbac..70d9605ce 100644 --- a/include/NumCpp/Core/Slice.hpp +++ b/include/NumCpp/Core/Slice.hpp @@ -56,7 +56,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inStop (index not included) + /// @param inStop (index not included) /// constexpr explicit Slice(int32 inStop) noexcept : stop(inStop) @@ -65,8 +65,8 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inStart - /// @param inStop (index not included) + /// @param inStart + /// @param inStop (index not included) /// constexpr Slice(int32 inStart, int32 inStop) noexcept : start(inStart), @@ -76,9 +76,9 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inStart - /// @param inStop (not included) - /// @param inStep + /// @param inStart + /// @param inStop (not included) + /// @param inStep /// constexpr Slice(int32 inStart, int32 inStop, int32 inStep) noexcept : start(inStart), @@ -89,9 +89,9 @@ namespace nc //============================================================================ /// Equality operator /// - /// @param inOtherSlice + /// @param inOtherSlice /// - /// @return bool + /// @return bool /// bool operator==(const Slice& inOtherSlice) const noexcept { @@ -101,9 +101,9 @@ namespace nc //============================================================================ /// Not equality operator /// - /// @param inOtherSlice + /// @param inOtherSlice /// - /// @return bool + /// @return bool /// bool operator!=(const Slice& inOtherSlice) const noexcept { @@ -113,7 +113,7 @@ namespace nc //============================================================================ /// Prints the shape to the console /// - /// @return std::string + /// @return std::string /// std::string str() const { @@ -132,7 +132,7 @@ namespace nc //============================================================================ /// Make the slice all positive and does some error checking /// - /// @param inArraySize + /// @param inArraySize /// void makePositiveAndValidate(uint32 inArraySize) { @@ -183,7 +183,7 @@ namespace nc /// be aware that this method will also make the slice all /// positive! /// - /// @param inArraySize + /// @param inArraySize /// uint32 numElements(uint32 inArraySize) { @@ -200,10 +200,10 @@ namespace nc //============================================================================ /// IO operator for the Slice class /// - /// @param inOStream - /// @param inSlice + /// @param inOStream + /// @param inSlice /// - /// @return std::ostream + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inOStream, const Slice& inSlice) { diff --git a/include/NumCpp/Core/Timer.hpp b/include/NumCpp/Core/Timer.hpp index 00193ab1a..f4aaeed5d 100644 --- a/include/NumCpp/Core/Timer.hpp +++ b/include/NumCpp/Core/Timer.hpp @@ -61,7 +61,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param inName + /// @param inName /// explicit Timer(const std::string& inName) : name_(inName + " "), @@ -74,7 +74,7 @@ namespace nc // Method Description: /// Sets/changes the timer name /// - /// @param inName + /// @param inName /// void setName(const std::string& inName) { @@ -105,9 +105,9 @@ namespace nc // Method Description: /// Stops the timer /// - /// @param printElapsedTime: bool whether or not to print the elapsed time to + /// @param printElapsedTime: bool whether or not to print the elapsed time to /// the console - /// @return ellapsed time in specified time units + /// @return ellapsed time in specified time units /// uint64 toc(bool printElapsedTime = true) { diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp index c8353daea..652d387d6 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/addBoundary1d.hpp @@ -50,12 +50,11 @@ namespace nc // Method Description: /// Wrap boundary /// - /// @param inImage - /// @param inBoundaryType - /// @param inKernalSize - /// @param inConstantValue (default 0) - /// @return - /// NdArray + /// @param inImage + /// @param inBoundaryType + /// @param inKernalSize + /// @param inConstantValue (default 0) + /// @return NdArray /// template NdArray addBoundary1d(const NdArray& inImage, Boundary inBoundaryType, uint32 inKernalSize, dtype inConstantValue = 0) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp index 31a37d55f..1fee1d352 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/constant1d.hpp @@ -42,11 +42,10 @@ namespace nc // Method Description: /// Constant boundary1d /// - /// @param inImage - /// @param inBoundarySize - /// @param inConstantValue - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @param inConstantValue + /// @return NdArray /// template NdArray constant1d(const NdArray& inImage, uint32 inBoundarySize, dtype inConstantValue) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp index 02c868124..1fdcf1035 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/mirror1d.hpp @@ -43,10 +43,9 @@ namespace nc // Method Description: /// Mirror boundary1d /// - /// @param inImage - /// @param inBoundarySize - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @return NdArray /// template NdArray mirror1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp index 318c865ad..ef06fe2f3 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/nearest1d.hpp @@ -41,10 +41,9 @@ namespace nc // Method Description: /// Nearest boundary1d /// - /// @param inImage - /// @param inBoundarySize - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @return NdArray /// template NdArray nearest1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp index f891b31dc..456a9059c 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/reflect1d.hpp @@ -43,10 +43,10 @@ namespace nc // Method Description: /// Reflects the boundaries /// - /// @param inImage - /// @param inBoundarySize + /// @param inImage + /// @param inBoundarySize /// - /// @return NdArray + /// @return NdArray /// template NdArray reflect1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp index 1a54d37fa..6129513f7 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/trimBoundary1d.hpp @@ -42,10 +42,9 @@ namespace nc // Method Description: /// trims the boundary off to make the image back to the original size /// - /// @param inImageWithBoundary - /// @param inSize - /// @return - /// NdArray + /// @param inImageWithBoundary + /// @param inSize + /// @return NdArray /// template NdArray trimBoundary1d(const NdArray& inImageWithBoundary, uint32 inSize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp index 882393981..a00b6b449 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries1d/wrap1d.hpp @@ -42,10 +42,9 @@ namespace nc // Method Description: /// Wrap boundary1d /// - /// @param inImage - /// @param inBoundarySize - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @return NdArray /// template NdArray wrap1d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp index 40c77e4af..c4ffbf050 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/addBoundary2d.hpp @@ -50,12 +50,11 @@ namespace nc // Method Description: /// Wrap boundary /// - /// @param inImage - /// @param inBoundaryType - /// @param inKernalSize - /// @param inConstantValue (default 0) - /// @return - /// NdArray + /// @param inImage + /// @param inBoundaryType + /// @param inKernalSize + /// @param inConstantValue (default 0) + /// @return NdArray /// template NdArray addBoundary2d(const NdArray& inImage, Boundary inBoundaryType, uint32 inKernalSize, dtype inConstantValue = 0) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp index 18471cb50..5a3eccd06 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/constant2d.hpp @@ -44,11 +44,10 @@ namespace nc // Method Description: /// Constant boundary /// - /// @param inImage - /// @param inBoundarySize - /// @param inConstantValue - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @param inConstantValue + /// @return NdArray /// template NdArray constant2d(const NdArray& inImage, uint32 inBoundarySize, dtype inConstantValue) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp index 9111a5345..01e8dd8a6 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/fillCorners.hpp @@ -43,8 +43,8 @@ namespace nc // Method Description: /// extends the corner values /// - /// @param inArray - /// @param inBorderWidth + /// @param inArray + /// @param inBorderWidth /// template void fillCorners(NdArray& inArray, uint32 inBorderWidth) @@ -76,9 +76,9 @@ namespace nc // Method Description: /// extends the corner values /// - /// @param inArray - /// @param inBorderWidth - /// @param inFillValue + /// @param inArray + /// @param inBorderWidth + /// @param inFillValue /// template void fillCorners(NdArray& inArray, uint32 inBorderWidth, dtype inFillValue) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp index 83a739e82..d5153145b 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/mirror2d.hpp @@ -44,10 +44,9 @@ namespace nc // Method Description: /// Mirror boundary /// - /// @param inImage - /// @param inBoundarySize - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @return NdArray /// template NdArray mirror2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp index 628d41598..54171e035 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/nearest2d.hpp @@ -44,10 +44,9 @@ namespace nc // Method Description: /// Nearest boundary /// - /// @param inImage - /// @param inBoundarySize - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @return NdArray /// template NdArray nearest2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp index bc66bcd40..3fea539a7 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/reflect2d.hpp @@ -44,11 +44,10 @@ namespace nc // Method Description: /// Reflects the boundaries /// - /// @param inImage - /// @param inBoundarySize + /// @param inImage + /// @param inBoundarySize /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray reflect2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp index 5418fdeaf..f3292212f 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/trimBoundary2d.hpp @@ -43,10 +43,9 @@ namespace nc // Method Description: /// trims the boundary off to make the image back to the original size /// - /// @param inImageWithBoundary - /// @param inSize - /// @return - /// NdArray + /// @param inImageWithBoundary + /// @param inSize + /// @return NdArray /// template NdArray trimBoundary2d(const NdArray& inImageWithBoundary, uint32 inSize) diff --git a/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp b/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp index b5bcb2569..ad6834182 100644 --- a/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp +++ b/include/NumCpp/Filter/Boundaries/Boundaries2d/wrap2d.hpp @@ -44,10 +44,9 @@ namespace nc // Method Description: /// Wrap boundary /// - /// @param inImage - /// @param inBoundarySize - /// @return - /// NdArray + /// @param inImage + /// @param inBoundarySize + /// @return NdArray /// template NdArray wrap2d(const NdArray& inImage, uint32 inBoundarySize) diff --git a/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp index 3cac2fdb0..fc2d3c30c 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/complementaryMedianFilter1d.hpp @@ -40,12 +40,11 @@ namespace nc // Method Description: /// Calculate a one-dimensional complemenatry median filter. /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray complementaryMedianFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp index b039981e5..5a93dc87e 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/convolve1d.hpp @@ -45,12 +45,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.convolve1d.html#scipy.ndimage.convolve1d /// - /// @param inImageArray - /// @param inWeights - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inWeights + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray convolve1d(const NdArray& inImageArray, const NdArray& inWeights, diff --git a/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp index 0410fd15f..d95ab4196 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/gaussianFilter1d.hpp @@ -47,12 +47,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.generic_filter1d.html#scipy.ndimage.generic_filter1d /// - /// @param inImageArray - /// @param inSigma: Standard deviation for Gaussian kernel - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSigma: Standard deviation for Gaussian kernel + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray gaussianFilter1d(const NdArray& inImageArray, double inSigma, diff --git a/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp index ca9064bfe..f87d0637d 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/maximumFilter1d.hpp @@ -43,12 +43,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.maximum_filter1d.html#scipy.ndimage.maximum_filter1d /// - /// @param inImageArray - /// @param inSize: linear size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: linear size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray maximumFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp index 018cb4ba4..14467ec33 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/medianFilter1d.hpp @@ -43,12 +43,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.median_filter.html#scipy.ndimage.median_filter /// - /// @param inImageArray - /// @param inSize: linear size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: linear size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray medianFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp index c82069a08..a81681fc2 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/minimumFilter1d.hpp @@ -43,12 +43,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.minimum_filter1d.html#scipy.ndimage.minimum_filter1d /// - /// @param inImageArray - /// @param inSize: linear size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: linear size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray minumumFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp index 056a70612..409ce0f88 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/percentileFilter1d.hpp @@ -44,13 +44,12 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.percentile_filter.html#scipy.ndimage.percentile_filter /// - /// @param inImageArray - /// @param inSize: linear size of the kernel to apply - /// @param inPercentile: percentile [0, 100] - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: linear size of the kernel to apply + /// @param inPercentile: percentile [0, 100] + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray percentileFilter1d(const NdArray& inImageArray, uint32 inSize, double inPercentile, diff --git a/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp index 474725d1b..9547b828e 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/rankFilter1d.hpp @@ -44,13 +44,12 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.rank_filter.html#scipy.ndimage.rank_filter /// - /// @param inImageArray - /// @param inSize: linear size of the kernel to apply - /// @param inRank: ([0, inSize^2 - 1]) - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: linear size of the kernel to apply + /// @param inRank: ([0, inSize^2 - 1]) + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray rankFilter1d(const NdArray& inImageArray, uint32 inSize, uint8 inRank, diff --git a/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp b/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp index 9197733ba..28e9f6631 100644 --- a/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp +++ b/include/NumCpp/Filter/Filters/Filters1d/uniformFilter1d.hpp @@ -44,12 +44,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.uniform_filter1d.html#scipy.ndimage.uniform_filter1d /// - /// @param inImageArray - /// @param inSize: linear size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: linear size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray uniformFilter1d(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp index a2e85edfe..68a727268 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/complementaryMedianFilter.hpp @@ -40,12 +40,11 @@ namespace nc // Method Description: /// Calculates a multidimensional complemenatry median filter. /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray complementaryMedianFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp b/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp index 7fa7cb00e..a927a1dae 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/convolve.hpp @@ -50,13 +50,12 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.convolve.html#scipy.ndimage.convolve /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inWeights - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inWeights + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray convolve(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp index 2ead49bf9..455ff523a 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/gaussianFilter.hpp @@ -47,12 +47,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.gaussian_filter.html#scipy.ndimage.gaussian_filter /// - /// @param inImageArray - /// @param inSigma: Standard deviation for Gaussian kernel - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSigma: Standard deviation for Gaussian kernel + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray gaussianFilter(const NdArray& inImageArray, double inSigma, diff --git a/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp b/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp index 588655d5d..49be4396d 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/laplace.hpp @@ -40,11 +40,10 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.laplace.html#scipy.ndimage.laplace /// - /// @param inImageArray - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray laplace(const NdArray& inImageArray, Boundary inBoundaryType = Boundary::REFLECT, dtype inConstantValue = 0) diff --git a/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp index 2991daf1b..c1599a8a4 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/maximumFilter.hpp @@ -43,12 +43,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.maximum_filter.html#scipy.ndimage.maximum_filter /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray maximumFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp index 8f91e5af3..c8ea3a20f 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/medianFilter.hpp @@ -43,12 +43,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.median_filter.html#scipy.ndimage.median_filter /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray medianFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp index 9e4f912ef..55e83e16d 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/minimumFilter.hpp @@ -43,12 +43,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.minimum_filter.html#scipy.ndimage.minimum_filter /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray minimumFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp index e07b2c189..1e77b321a 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/percentileFilter.hpp @@ -44,13 +44,12 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.percentile_filter.html#scipy.ndimage.percentile_filter /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inPercentile: percentile [0, 100] - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inPercentile: percentile [0, 100] + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray percentileFilter(const NdArray& inImageArray, uint32 inSize, double inPercentile, diff --git a/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp index e45893cff..c5dda709a 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/rankFilter.hpp @@ -47,13 +47,12 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.rank_filter.html#scipy.ndimage.rank_filter /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inRank: ([0, inSize^2 - 1]) - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inRank: ([0, inSize^2 - 1]) + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray rankFilter(const NdArray& inImageArray, uint32 inSize, uint32 inRank, diff --git a/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp b/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp index 8bf12c3bc..f0694b29e 100644 --- a/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp +++ b/include/NumCpp/Filter/Filters/Filters2d/uniformFilter.hpp @@ -44,12 +44,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.uniform_filter.html#scipy.ndimage.uniform_filter /// - /// @param inImageArray - /// @param inSize: square size of the kernel to apply - /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) - /// @param inConstantValue: contant value if boundary = 'constant' (default 0) - /// @return - /// NdArray + /// @param inImageArray + /// @param inSize: square size of the kernel to apply + /// @param inBoundaryType: boundary mode (default Reflect) options (reflect, constant, nearest, mirror, wrap) + /// @param inConstantValue: contant value if boundary = 'constant' (default 0) + /// @return NdArray /// template NdArray uniformFilter(const NdArray& inImageArray, uint32 inSize, diff --git a/include/NumCpp/Functions/abs.hpp b/include/NumCpp/Functions/abs.hpp index 0838b049e..ab38caad6 100644 --- a/include/NumCpp/Functions/abs.hpp +++ b/include/NumCpp/Functions/abs.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.absolute.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto abs(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.absolute.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto abs(const NdArray& inArray) diff --git a/include/NumCpp/Functions/add.hpp b/include/NumCpp/Functions/add.hpp index fb18a6f05..5c958af07 100644 --- a/include/NumCpp/Functions/add.hpp +++ b/include/NumCpp/Functions/add.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray add(const NdArray& inArray1, const NdArray& inArray2) @@ -56,10 +55,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray add(const NdArray& inArray, dtype value) @@ -73,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray add(dtype value, const NdArray& inArray) @@ -90,10 +87,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> add(const NdArray& inArray1, const NdArray>& inArray2) @@ -107,10 +103,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> add(const NdArray>& inArray1, const NdArray& inArray2) @@ -124,10 +119,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> add(const NdArray& inArray, const std::complex& value) @@ -141,10 +135,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> add(const std::complex& value, const NdArray& inArray) @@ -158,10 +151,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> add(const NdArray>& inArray, dtype value) @@ -175,10 +167,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.add.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> add(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/alen.hpp b/include/NumCpp/Functions/alen.hpp index 6dbb142af..e80f96983 100644 --- a/include/NumCpp/Functions/alen.hpp +++ b/include/NumCpp/Functions/alen.hpp @@ -36,10 +36,8 @@ namespace nc // Method Description: /// Return the length of the first dimension of the input array. /// - /// @param - /// inArray - /// @return - /// length uint16 + /// @param inArray + /// @return length uint16 /// template uint32 alen(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/all.hpp b/include/NumCpp/Functions/all.hpp index 66818f8a5..55e4f572a 100644 --- a/include/NumCpp/Functions/all.hpp +++ b/include/NumCpp/Functions/all.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.all.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// bool + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return bool /// template NdArray all(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/allclose.hpp b/include/NumCpp/Functions/allclose.hpp index 030b7ba48..6bc069032 100644 --- a/include/NumCpp/Functions/allclose.hpp +++ b/include/NumCpp/Functions/allclose.hpp @@ -45,11 +45,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.allclose.html /// - /// @param inArray1 - /// @param inArray2 - /// @param inTolerance: (Optional, default 1e-5) - /// @return - /// bool + /// @param inArray1 + /// @param inArray2 + /// @param inTolerance: (Optional, default 1e-5) + /// @return bool /// template bool allclose(const NdArray& inArray1, const NdArray& inArray2, double inTolerance = 1e-5) diff --git a/include/NumCpp/Functions/amax.hpp b/include/NumCpp/Functions/amax.hpp index 77060d3f5..55d9c830f 100644 --- a/include/NumCpp/Functions/amax.hpp +++ b/include/NumCpp/Functions/amax.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.amax.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// max value + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return max value /// template NdArray amax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/amin.hpp b/include/NumCpp/Functions/amin.hpp index e9c470398..fcd1e50bf 100644 --- a/include/NumCpp/Functions/amin.hpp +++ b/include/NumCpp/Functions/amin.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.amin.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// min value + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return min value /// template NdArray amin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/angle.hpp b/include/NumCpp/Functions/angle.hpp index 82490970b..398475332 100644 --- a/include/NumCpp/Functions/angle.hpp +++ b/include/NumCpp/Functions/angle.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.angle.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto angle(const std::complex& inValue) @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.angle.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto angle(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/any.hpp b/include/NumCpp/Functions/any.hpp index 503010b3e..7d149de18 100644 --- a/include/NumCpp/Functions/any.hpp +++ b/include/NumCpp/Functions/any.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.any.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray any(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/append.hpp b/include/NumCpp/Functions/append.hpp index 4f7486f53..c2b89e3ea 100644 --- a/include/NumCpp/Functions/append.hpp +++ b/include/NumCpp/Functions/append.hpp @@ -42,13 +42,12 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.append.html /// - /// @param inArray - /// @param inAppendValues - /// @param inAxis (Optional, default NONE): The axis along which values are appended. + /// @param inArray + /// @param inAppendValues + /// @param inAxis (Optional, default NONE): The axis along which values are appended. /// If axis is not given, both inArray and inAppendValues /// are flattened before use. - /// @return - /// NdArray + /// @return NdArray /// template NdArray append(const NdArray& inArray, const NdArray& inAppendValues, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/applyFunction.hpp b/include/NumCpp/Functions/applyFunction.hpp index ec0985cf1..a2c0a7d0d 100644 --- a/include/NumCpp/Functions/applyFunction.hpp +++ b/include/NumCpp/Functions/applyFunction.hpp @@ -39,10 +39,9 @@ namespace nc /// Apply the input function element wise to the input /// array in place. /// - /// @param inArray - /// @param inFunc - /// @return - /// NdArray + /// @param inArray + /// @param inFunc + /// @return NdArray /// template void applyFunction(NdArray& inArray, const std::function& inFunc) diff --git a/include/NumCpp/Functions/applyPoly1d.hpp b/include/NumCpp/Functions/applyPoly1d.hpp index 744b6c4af..703bcf011 100644 --- a/include/NumCpp/Functions/applyPoly1d.hpp +++ b/include/NumCpp/Functions/applyPoly1d.hpp @@ -37,10 +37,9 @@ namespace nc // Method Description: /// Apply polynomial elemnt wise to the input values. /// - /// @param inArray - /// @param inPoly - /// @return - /// NdArray + /// @param inArray + /// @param inPoly + /// @return NdArray /// template void applyPoly1d(NdArray& inArray, const polynomial::Poly1d& inPoly) diff --git a/include/NumCpp/Functions/arange.hpp b/include/NumCpp/Functions/arange.hpp index bae66f305..1d53c6b33 100644 --- a/include/NumCpp/Functions/arange.hpp +++ b/include/NumCpp/Functions/arange.hpp @@ -50,11 +50,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html /// - /// @param inStart - /// @param inStop - /// @param inStep: (Optional, defaults to 1) - /// @return - /// NdArray + /// @param inStart + /// @param inStop + /// @param inStep: (Optional, defaults to 1) + /// @return NdArray /// template NdArray arange(dtype inStart, dtype inStop, dtype inStep = 1) @@ -110,10 +109,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html /// - /// @param - /// inStop: start is 0 and step is 1 - /// @return - /// NdArray + /// @param inStop: start is 0 and step is 1 + /// @return NdArray /// template NdArray arange(dtype inStop) @@ -140,10 +137,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arange.html /// - /// @param - /// inSlice - /// @return - /// NdArray + /// @param inSlice + /// @return NdArray /// template NdArray arange(const Slice& inSlice) diff --git a/include/NumCpp/Functions/arccos.hpp b/include/NumCpp/Functions/arccos.hpp index 174c10b61..5b40e483e 100644 --- a/include/NumCpp/Functions/arccos.hpp +++ b/include/NumCpp/Functions/arccos.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccos.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto arccos(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccos.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto arccos(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arccosh.hpp b/include/NumCpp/Functions/arccosh.hpp index 811ac12ff..887c041e6 100644 --- a/include/NumCpp/Functions/arccosh.hpp +++ b/include/NumCpp/Functions/arccosh.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccosh.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto arccosh(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arccosh.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto arccosh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arcsin.hpp b/include/NumCpp/Functions/arcsin.hpp index c764f64e9..eba6f02f7 100644 --- a/include/NumCpp/Functions/arcsin.hpp +++ b/include/NumCpp/Functions/arcsin.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsin.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto arcsin(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsin.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto arcsin(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arcsinh.hpp b/include/NumCpp/Functions/arcsinh.hpp index e00b5b0fd..cacd2b5c9 100644 --- a/include/NumCpp/Functions/arcsinh.hpp +++ b/include/NumCpp/Functions/arcsinh.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsinh.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto arcsinh(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arcsinh.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto arcsinh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arctan.hpp b/include/NumCpp/Functions/arctan.hpp index e11fd0df4..5a1396544 100644 --- a/include/NumCpp/Functions/arctan.hpp +++ b/include/NumCpp/Functions/arctan.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto arctan(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto arctan(const NdArray& inArray) diff --git a/include/NumCpp/Functions/arctan2.hpp b/include/NumCpp/Functions/arctan2.hpp index 2d481ab8d..d6611dce0 100644 --- a/include/NumCpp/Functions/arctan2.hpp +++ b/include/NumCpp/Functions/arctan2.hpp @@ -43,10 +43,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan2.html /// - /// @param inY - /// @param inX - /// @return - /// value + /// @param inY + /// @param inX + /// @return value /// template auto arctan2(dtype inY, dtype inX) noexcept @@ -62,10 +61,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctan2.html /// - /// @param inY - /// @param inX - /// @return - /// NdArray + /// @param inY + /// @param inX + /// @return NdArray /// template auto arctan2(const NdArray& inY, const NdArray& inX) diff --git a/include/NumCpp/Functions/arctanh.hpp b/include/NumCpp/Functions/arctanh.hpp index d3dd209a0..ca6061134 100644 --- a/include/NumCpp/Functions/arctanh.hpp +++ b/include/NumCpp/Functions/arctanh.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctanh.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto arctanh(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.arctanh.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto arctanh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/argmax.hpp b/include/NumCpp/Functions/argmax.hpp index 01c4a028d..f77c2d99f 100644 --- a/include/NumCpp/Functions/argmax.hpp +++ b/include/NumCpp/Functions/argmax.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argmax.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray argmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/argmin.hpp b/include/NumCpp/Functions/argmin.hpp index bbbce3529..473320f68 100644 --- a/include/NumCpp/Functions/argmin.hpp +++ b/include/NumCpp/Functions/argmin.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argmin.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray argmin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/argsort.hpp b/include/NumCpp/Functions/argsort.hpp index 3aedb5a1d..b8627e08d 100644 --- a/include/NumCpp/Functions/argsort.hpp +++ b/include/NumCpp/Functions/argsort.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argsort.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray argsort(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/argwhere.hpp b/include/NumCpp/Functions/argwhere.hpp index 3a9fd388b..618beb030 100644 --- a/include/NumCpp/Functions/argwhere.hpp +++ b/include/NumCpp/Functions/argwhere.hpp @@ -38,9 +38,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.argwhere.html /// - /// @param inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray argwhere(const NdArray& inArray) diff --git a/include/NumCpp/Functions/around.hpp b/include/NumCpp/Functions/around.hpp index e54327839..0f2a71925 100644 --- a/include/NumCpp/Functions/around.hpp +++ b/include/NumCpp/Functions/around.hpp @@ -37,10 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.around.html /// - /// @param inValue - /// @param inNumDecimals: (Optional, default = 0) - /// @return - /// value + /// @param inValue + /// @param inNumDecimals: (Optional, default = 0) + /// @return value /// template dtype around(dtype inValue, uint8 inNumDecimals = 0) @@ -55,10 +54,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.around.html /// - /// @param inArray - /// @param inNumDecimals: (Optional, default = 0) - /// @return - /// NdArray + /// @param inArray + /// @param inNumDecimals: (Optional, default = 0) + /// @return NdArray /// template NdArray around(const NdArray& inArray, uint8 inNumDecimals = 0) diff --git a/include/NumCpp/Functions/array_equal.hpp b/include/NumCpp/Functions/array_equal.hpp index f688d76cb..b2a13706d 100644 --- a/include/NumCpp/Functions/array_equal.hpp +++ b/include/NumCpp/Functions/array_equal.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.array_equal.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// bool + /// @return bool /// template bool array_equal(const NdArray& inArray1, const NdArray& inArray2) noexcept diff --git a/include/NumCpp/Functions/array_equiv.hpp b/include/NumCpp/Functions/array_equiv.hpp index af2176ba2..1e557510d 100644 --- a/include/NumCpp/Functions/array_equiv.hpp +++ b/include/NumCpp/Functions/array_equiv.hpp @@ -45,11 +45,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.array_equiv.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// bool + /// @return bool /// template bool array_equiv(const NdArray& inArray1, const NdArray& inArray2) noexcept diff --git a/include/NumCpp/Functions/asarray.hpp b/include/NumCpp/Functions/asarray.hpp index 81e3181c8..0779ad53d 100644 --- a/include/NumCpp/Functions/asarray.hpp +++ b/include/NumCpp/Functions/asarray.hpp @@ -48,10 +48,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param - /// inList - /// @return - /// NdArray + /// @param inList + /// @return NdArray /// template, int> = 0> @@ -67,10 +65,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param - /// inList - /// @return - /// NdArray + /// @param inList + /// @return NdArray /// template NdArray asarray(std::initializer_list > inList) @@ -84,11 +80,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param inArray + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. - /// @return - /// NdArray + /// @return NdArray /// template, int> = 0> @@ -103,11 +98,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param inArray + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. - /// @return - /// NdArray + /// @return NdArray /// template NdArray asarray(std::array, Dim0Size>& inArray, bool copy = true) @@ -121,11 +115,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inVector - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param inVector + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. - /// @return - /// NdArray + /// @return NdArray /// template, int> = 0> @@ -140,9 +133,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inVector - /// @return - /// NdArray + /// @param inVector + /// @return NdArray /// template NdArray asarray(const std::vector>& inVector) @@ -156,11 +148,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inVector - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param inVector + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. - /// @return - /// NdArray + /// @return NdArray /// template NdArray asarray(std::vector>& inVector, bool copy = true) @@ -174,9 +165,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inDeque - /// @return - /// NdArray + /// @param inDeque + /// @return NdArray /// template, int> = 0> @@ -191,9 +181,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param inDeque - /// @return - /// NdArray + /// @param inDeque + /// @return NdArray /// template NdArray asarray(const std::deque>& inDeque) @@ -207,10 +196,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param - /// inSet - /// @return - /// NdArray + /// @param inSet + /// @return NdArray /// template NdArray asarray(const std::set& inSet) @@ -224,10 +211,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param - /// inList - /// @return - /// NdArray + /// @param inList + /// @return NdArray /// template NdArray asarray(const std::list& inList) @@ -241,10 +226,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param iterBegin - /// @param iterEnd - /// @return - /// NdArray + /// @param iterBegin + /// @param iterEnd + /// @return NdArray /// template auto asarray(Iterator iterBegin, Iterator iterEnd) @@ -258,10 +242,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param iterBegin - /// @param iterEnd - /// @return - /// NdArray + /// @param iterBegin + /// @param iterEnd + /// @return NdArray /// template NdArray asarray(const dtype* iterBegin, const dtype* iterEnd) @@ -275,10 +258,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param ptr to array - /// @param size: the number of elements in the array - /// @return - /// NdArray + /// @param ptr to array + /// @param size: the number of elements in the array + /// @return NdArray /// template NdArray asarray(const dtype* ptr, uint32 size) @@ -292,11 +274,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param ptr to array - /// @param numRows: number of rows of the buffer - /// @param numCols: number of cols of the buffer - /// @return - /// NdArray + /// @param ptr to array + /// @param numRows: number of rows of the buffer + /// @param numCols: number of cols of the buffer + /// @return NdArray /// template NdArray asarray(const dtype* ptr, uint32 numRows, uint32 numCols) @@ -310,12 +291,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param ptr to array - /// @param size: the number of elements in the array - /// @param takeOwnership: whether or not to take ownership of the data + /// @param ptr to array + /// @param size: the number of elements in the array + /// @param takeOwnership: whether or not to take ownership of the data /// and call delete[] in the destructor. - /// @return - /// NdArray + /// @return NdArray /// template::value, int> = 0> @@ -330,13 +310,12 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.asarray.html /// - /// @param ptr to array - /// @param numRows: number of rows of the buffer - /// @param numCols: number of cols of the buffer - /// @param takeOwnership: whether or not to take ownership of the data + /// @param ptr to array + /// @param numRows: number of rows of the buffer + /// @param numCols: number of cols of the buffer + /// @param takeOwnership: whether or not to take ownership of the data /// and call delete[] in the destructor. - /// @return - /// NdArray + /// @return NdArray /// template::value, int> = 0> diff --git a/include/NumCpp/Functions/astype.hpp b/include/NumCpp/Functions/astype.hpp index a7f48489d..0d6910e99 100644 --- a/include/NumCpp/Functions/astype.hpp +++ b/include/NumCpp/Functions/astype.hpp @@ -38,10 +38,8 @@ namespace nc // Method Description: /// Returns a copy of the array, cast to a specified type. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray astype(const NdArray inArray) diff --git a/include/NumCpp/Functions/average.hpp b/include/NumCpp/Functions/average.hpp index 6960d2c35..b44064a49 100644 --- a/include/NumCpp/Functions/average.hpp +++ b/include/NumCpp/Functions/average.hpp @@ -48,10 +48,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template auto average(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -65,11 +64,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html /// - /// @param inArray - /// @param inWeights - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inWeights + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray average(const NdArray& inArray, const NdArray& inWeights, Axis inAxis = Axis::NONE) @@ -154,11 +152,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.average.html /// - /// @param inArray - /// @param inWeights - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inWeights + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray> average(const NdArray>& inArray, diff --git a/include/NumCpp/Functions/bartlett.hpp b/include/NumCpp/Functions/bartlett.hpp index eb2f9a8e5..a0bae81fc 100644 --- a/include/NumCpp/Functions/bartlett.hpp +++ b/include/NumCpp/Functions/bartlett.hpp @@ -42,7 +42,7 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.bartlett.html /// - /// @param m: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// inline NdArray bartlett(int32 m) diff --git a/include/NumCpp/Functions/binaryRepr.hpp b/include/NumCpp/Functions/binaryRepr.hpp index 38919b36f..4fd4ffe63 100644 --- a/include/NumCpp/Functions/binaryRepr.hpp +++ b/include/NumCpp/Functions/binaryRepr.hpp @@ -41,9 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.binary_repr.html /// - /// @param inValue - /// @return - /// std::string + /// @param inValue + /// @return std::string /// template std::string binaryRepr(dtype inValue) diff --git a/include/NumCpp/Functions/bincount.hpp b/include/NumCpp/Functions/bincount.hpp index 023601f53..418bc91cf 100644 --- a/include/NumCpp/Functions/bincount.hpp +++ b/include/NumCpp/Functions/bincount.hpp @@ -50,10 +50,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bincount.html /// - /// @param inArray - /// @param inMinLength - /// @return - /// NdArray + /// @param inArray + /// @param inMinLength + /// @return NdArray /// template NdArray bincount(const NdArray& inArray, uint16 inMinLength = 1) @@ -101,11 +100,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bincount.html /// - /// @param inArray - /// @param inWeights - /// @param inMinLength - /// @return - /// NdArray + /// @param inArray + /// @param inWeights + /// @param inMinLength + /// @return NdArray /// template NdArray bincount(const NdArray& inArray, const NdArray& inWeights, uint16 inMinLength = 1) diff --git a/include/NumCpp/Functions/bitwise_and.hpp b/include/NumCpp/Functions/bitwise_and.hpp index 962ff2fe7..89f924a41 100644 --- a/include/NumCpp/Functions/bitwise_and.hpp +++ b/include/NumCpp/Functions/bitwise_and.hpp @@ -37,10 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_and.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray bitwise_and(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/bitwise_not.hpp b/include/NumCpp/Functions/bitwise_not.hpp index a9ac8612c..db30226cd 100644 --- a/include/NumCpp/Functions/bitwise_not.hpp +++ b/include/NumCpp/Functions/bitwise_not.hpp @@ -36,8 +36,7 @@ namespace nc /// Compute the bit-wise NOT the input array element-wise. /// /// inArray - /// @return - /// NdArray + /// @return NdArray /// template NdArray bitwise_not(const NdArray& inArray) diff --git a/include/NumCpp/Functions/bitwise_or.hpp b/include/NumCpp/Functions/bitwise_or.hpp index 684f686c5..f4bf89696 100644 --- a/include/NumCpp/Functions/bitwise_or.hpp +++ b/include/NumCpp/Functions/bitwise_or.hpp @@ -37,10 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_or.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray bitwise_or(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/bitwise_xor.hpp b/include/NumCpp/Functions/bitwise_xor.hpp index 1ecff5d6b..a8abc8cfb 100644 --- a/include/NumCpp/Functions/bitwise_xor.hpp +++ b/include/NumCpp/Functions/bitwise_xor.hpp @@ -37,10 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.bitwise_xor.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray bitwise_xor(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/blackman.hpp b/include/NumCpp/Functions/blackman.hpp index 8ded1cfa5..98aaea5d7 100644 --- a/include/NumCpp/Functions/blackman.hpp +++ b/include/NumCpp/Functions/blackman.hpp @@ -43,7 +43,7 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.blackman.html /// - /// @param m: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// inline NdArray blackman(int32 m) diff --git a/include/NumCpp/Functions/byteswap.hpp b/include/NumCpp/Functions/byteswap.hpp index 3cca460ed..c2dd674ad 100644 --- a/include/NumCpp/Functions/byteswap.hpp +++ b/include/NumCpp/Functions/byteswap.hpp @@ -36,10 +36,9 @@ namespace nc /// Return a new array with the bytes of the array elements /// swapped. /// - /// @param inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray byteswap(const NdArray& inArray) diff --git a/include/NumCpp/Functions/cbrt.hpp b/include/NumCpp/Functions/cbrt.hpp index e4711d9b2..c0a007a0a 100644 --- a/include/NumCpp/Functions/cbrt.hpp +++ b/include/NumCpp/Functions/cbrt.hpp @@ -41,9 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cbrt.html /// - /// @param inValue - /// @return - /// value + /// @param inValue + /// @return value /// template double cbrt(dtype inValue) noexcept @@ -59,9 +58,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cbrt.html /// - /// @param inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray cbrt(const NdArray& inArray) diff --git a/include/NumCpp/Functions/ceil.hpp b/include/NumCpp/Functions/ceil.hpp index 4e1b17e77..9363475f8 100644 --- a/include/NumCpp/Functions/ceil.hpp +++ b/include/NumCpp/Functions/ceil.hpp @@ -41,7 +41,7 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ceil.html /// - /// @param inValue + /// @param inValue /// @return value /// template @@ -58,7 +58,7 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ceil.html /// - /// @param inArray + /// @param inArray /// @return NdArray /// template diff --git a/include/NumCpp/Functions/centerOfMass.hpp b/include/NumCpp/Functions/centerOfMass.hpp index d566d5d78..e5e9d8d2e 100644 --- a/include/NumCpp/Functions/centerOfMass.hpp +++ b/include/NumCpp/Functions/centerOfMass.hpp @@ -39,9 +39,9 @@ namespace nc // Method Description: /// Returns the center of mass of the array values along an axis. /// - /// @param inArray - /// @param inAxis (Optional, default NONE which is a 2d center of mass) - /// @return NdArray: if axis is NONE then a 1x2 array of the centroid row/col is returned. + /// @param inArray + /// @param inAxis (Optional, default NONE which is a 2d center of mass) + /// @return NdArray: if axis is NONE then a 1x2 array of the centroid row/col is returned. /// template NdArray centerOfMass(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/clip.hpp b/include/NumCpp/Functions/clip.hpp index 1c4092720..5e0bef9f2 100644 --- a/include/NumCpp/Functions/clip.hpp +++ b/include/NumCpp/Functions/clip.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.clip.html /// - /// @param inValue - /// @param inMinValue - /// @param inMaxValue - /// @return - /// NdArray + /// @param inValue + /// @param inMinValue + /// @param inMaxValue + /// @return NdArray /// template dtype clip(dtype inValue, dtype inMinValue, dtype inMaxValue) @@ -81,11 +80,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.clip.html /// - /// @param inArray - /// @param inMinValue - /// @param inMaxValue - /// @return - /// NdArray + /// @param inArray + /// @param inMinValue + /// @param inMaxValue + /// @return NdArray /// template NdArray clip(const NdArray& inArray, dtype inMinValue, dtype inMaxValue) diff --git a/include/NumCpp/Functions/column_stack.hpp b/include/NumCpp/Functions/column_stack.hpp index d723e0963..b31dffba8 100644 --- a/include/NumCpp/Functions/column_stack.hpp +++ b/include/NumCpp/Functions/column_stack.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.column_stack.html /// - /// @param - /// inArrayList: {list} of arrays to stack - /// @return - /// NdArray + /// @param inArrayList: {list} of arrays to stack + /// @return NdArray /// template NdArray column_stack(const std::initializer_list >& inArrayList) diff --git a/include/NumCpp/Functions/complex.hpp b/include/NumCpp/Functions/complex.hpp index aeb52cf49..2d81bff1a 100644 --- a/include/NumCpp/Functions/complex.hpp +++ b/include/NumCpp/Functions/complex.hpp @@ -40,9 +40,8 @@ namespace nc // Method Description: /// Returns a std::complex from the input real and imag components /// - /// @param inReal: the real component of the complex number - /// @return - /// value + /// @param inReal: the real component of the complex number + /// @return value /// template auto complex(dtype inReal) @@ -56,10 +55,9 @@ namespace nc // Method Description: /// Returns a std::complex from the input real and imag components /// - /// @param inReal: the real component of the complex number - /// @param inImag: the imaginary component of the complex number - /// @return - /// value + /// @param inReal: the real component of the complex number + /// @param inImag: the imaginary component of the complex number + /// @return value /// template auto complex(dtype inReal, dtype inImag) @@ -73,9 +71,8 @@ namespace nc // Method Description: /// Returns a std::complex from the input real and imag components /// - /// @param inReal: the real component of the complex number - /// @return - /// NdArray + /// @param inReal: the real component of the complex number + /// @return NdArray /// template auto complex(const NdArray& inReal) @@ -94,10 +91,9 @@ namespace nc // Method Description: /// Returns a std::complex from the input real and imag components /// - /// @param inReal: the real component of the complex number - /// @param inImag: the imaginary component of the complex number - /// @return - /// NdArray + /// @param inReal: the real component of the complex number + /// @param inImag: the imaginary component of the complex number + /// @return NdArray /// template auto complex(const NdArray& inReal, const NdArray& inImag) diff --git a/include/NumCpp/Functions/concatenate.hpp b/include/NumCpp/Functions/concatenate.hpp index 8c0cfc867..2f4939b2e 100644 --- a/include/NumCpp/Functions/concatenate.hpp +++ b/include/NumCpp/Functions/concatenate.hpp @@ -43,10 +43,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.concatenate.html /// - /// @param inArrayList - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArrayList + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray concatenate(const std::initializer_list >& inArrayList, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/conj.hpp b/include/NumCpp/Functions/conj.hpp index 2b5076e21..9ea11c29e 100644 --- a/include/NumCpp/Functions/conj.hpp +++ b/include/NumCpp/Functions/conj.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.conj.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto conj(const std::complex& inValue) @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.conj.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto conj(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/contains.hpp b/include/NumCpp/Functions/contains.hpp index d6831c4f4..1b62dde81 100644 --- a/include/NumCpp/Functions/contains.hpp +++ b/include/NumCpp/Functions/contains.hpp @@ -36,11 +36,10 @@ namespace nc // Method Description: /// returns whether or not a value is included the array /// - /// @param inArray - /// @param inValue - /// @param inAxis (Optional, default NONE) - /// @return - /// bool + /// @param inArray + /// @param inValue + /// @param inAxis (Optional, default NONE) + /// @return bool /// template NdArray contains(const NdArray& inArray, dtype inValue, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/copy.hpp b/include/NumCpp/Functions/copy.hpp index f4138136a..9c3cefd78 100644 --- a/include/NumCpp/Functions/copy.hpp +++ b/include/NumCpp/Functions/copy.hpp @@ -37,10 +37,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copy.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray copy(const NdArray& inArray) diff --git a/include/NumCpp/Functions/copySign.hpp b/include/NumCpp/Functions/copySign.hpp index f800b2997..f0dcc850a 100644 --- a/include/NumCpp/Functions/copySign.hpp +++ b/include/NumCpp/Functions/copySign.hpp @@ -43,10 +43,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copysign.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray copySign(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/copyto.hpp b/include/NumCpp/Functions/copyto.hpp index 795eb9823..069885cea 100644 --- a/include/NumCpp/Functions/copyto.hpp +++ b/include/NumCpp/Functions/copyto.hpp @@ -37,10 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.copyto.html /// - /// @param inDestArray - /// @param inSrcArray - /// @return - /// NdArray + /// @param inDestArray + /// @param inSrcArray + /// @return NdArray /// template NdArray& copyto(NdArray& inDestArray, const NdArray& inSrcArray) diff --git a/include/NumCpp/Functions/corrcoef.hpp b/include/NumCpp/Functions/corrcoef.hpp index 03335f044..9b2c1436b 100644 --- a/include/NumCpp/Functions/corrcoef.hpp +++ b/include/NumCpp/Functions/corrcoef.hpp @@ -41,7 +41,7 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.corrcoef.html /// - /// @param x: A 1-D or 2-D array containing multiple variables and observations. + /// @param x: A 1-D or 2-D array containing multiple variables and observations. /// Each row of x represents a variable, and each column a single observation /// of all those variables. /// @return NdArray diff --git a/include/NumCpp/Functions/cos.hpp b/include/NumCpp/Functions/cos.hpp index d9d23197e..e4cd8c041 100644 --- a/include/NumCpp/Functions/cos.hpp +++ b/include/NumCpp/Functions/cos.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cos.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto cos(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cos.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto cos(const NdArray& inArray) diff --git a/include/NumCpp/Functions/cosh.hpp b/include/NumCpp/Functions/cosh.hpp index 76d579404..7cd5863c8 100644 --- a/include/NumCpp/Functions/cosh.hpp +++ b/include/NumCpp/Functions/cosh.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cosh.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto cosh(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cosh.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto cosh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/count_nonzero.hpp b/include/NumCpp/Functions/count_nonzero.hpp index cc11c21b5..6b4ae0683 100644 --- a/include/NumCpp/Functions/count_nonzero.hpp +++ b/include/NumCpp/Functions/count_nonzero.hpp @@ -41,10 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.count_nonzero.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray count_nonzero(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/cov.hpp b/include/NumCpp/Functions/cov.hpp index 4630de4b9..5a08116ac 100644 --- a/include/NumCpp/Functions/cov.hpp +++ b/include/NumCpp/Functions/cov.hpp @@ -41,7 +41,7 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.cov.html /// - /// @param x: A 1-D or 2-D array containing multiple variables and observations. + /// @param x: A 1-D or 2-D array containing multiple variables and observations. /// Each row of x represents a variable, and each column a single observation /// of all those variables. /// @param bias: Default normalization (false) is by (N - 1), where N is the number of observations diff --git a/include/NumCpp/Functions/cov_inv.hpp b/include/NumCpp/Functions/cov_inv.hpp index 714ca8e25..50e08932c 100644 --- a/include/NumCpp/Functions/cov_inv.hpp +++ b/include/NumCpp/Functions/cov_inv.hpp @@ -38,7 +38,7 @@ namespace nc // Method Description: /// Estimate an inverse covariance matrix, aka the concentration matrix /// - /// @param x: A 1-D or 2-D array containing multiple variables and observations. + /// @param x: A 1-D or 2-D array containing multiple variables and observations. /// Each row of x represents a variable, and each column a single observation /// of all those variables. /// @param bias: Default normalization (false) is by (N - 1), where N is the number of observations diff --git a/include/NumCpp/Functions/cross.hpp b/include/NumCpp/Functions/cross.hpp index 6465693b0..6d7610e94 100644 --- a/include/NumCpp/Functions/cross.hpp +++ b/include/NumCpp/Functions/cross.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cross.html /// - /// @param inArray1 - /// @param inArray2 - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray cross(const NdArray& inArray1, const NdArray& inArray2, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/cube.hpp b/include/NumCpp/Functions/cube.hpp index 5ff4e2d11..7a27b42d8 100644 --- a/include/NumCpp/Functions/cube.hpp +++ b/include/NumCpp/Functions/cube.hpp @@ -38,10 +38,8 @@ namespace nc // Method Description: /// Cubes the input /// - /// @param - /// inValue - /// @return - /// cubed value + /// @param inValue + /// @return cubed value /// template constexpr dtype cube(dtype inValue) noexcept @@ -55,10 +53,8 @@ namespace nc // Method Description: /// Cubes the elements of the array /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray cube(const NdArray& inArray) diff --git a/include/NumCpp/Functions/cumprod.hpp b/include/NumCpp/Functions/cumprod.hpp index ad68b4358..a37cf056e 100644 --- a/include/NumCpp/Functions/cumprod.hpp +++ b/include/NumCpp/Functions/cumprod.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cumprod.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray cumprod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/cumsum.hpp b/include/NumCpp/Functions/cumsum.hpp index d3fbfd0f5..8e909381f 100644 --- a/include/NumCpp/Functions/cumsum.hpp +++ b/include/NumCpp/Functions/cumsum.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.cumsum.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray cumsum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/deg2rad.hpp b/include/NumCpp/Functions/deg2rad.hpp index 8f292c079..1809adc1b 100644 --- a/include/NumCpp/Functions/deg2rad.hpp +++ b/include/NumCpp/Functions/deg2rad.hpp @@ -40,10 +40,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.deg2rad.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template constexpr auto deg2rad(dtype inValue) noexcept @@ -59,10 +57,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.deg2rad.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto deg2rad(const NdArray& inArray) diff --git a/include/NumCpp/Functions/degrees.hpp b/include/NumCpp/Functions/degrees.hpp index 1987bfefc..c9109a8b8 100644 --- a/include/NumCpp/Functions/degrees.hpp +++ b/include/NumCpp/Functions/degrees.hpp @@ -38,10 +38,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.degrees.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template constexpr auto degrees(dtype inValue) noexcept @@ -55,10 +53,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.degrees.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto degrees(const NdArray& inArray) diff --git a/include/NumCpp/Functions/deleteIndices.hpp b/include/NumCpp/Functions/deleteIndices.hpp index 642cb89ac..dc67dd28d 100644 --- a/include/NumCpp/Functions/deleteIndices.hpp +++ b/include/NumCpp/Functions/deleteIndices.hpp @@ -42,11 +42,10 @@ namespace nc // Method Description: /// Return a new array with sub-arrays along an axis deleted. /// - /// @param inArray - /// @param inArrayIdxs - /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array - /// @return - /// NdArray + /// @param inArray + /// @param inArrayIdxs + /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array + /// @return NdArray /// template NdArray deleteIndices(const NdArray& inArray, const NdArray& inArrayIdxs, Axis inAxis = Axis::NONE) @@ -140,11 +139,10 @@ namespace nc // Method Description: /// Return a new array with sub-arrays along an axis deleted. /// - /// @param inArray - /// @param inIndicesSlice - /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array - /// @return - /// NdArray + /// @param inArray + /// @param inIndicesSlice + /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array + /// @return NdArray /// template NdArray deleteIndices(const NdArray& inArray, const Slice& inIndicesSlice, Axis inAxis = Axis::NONE) @@ -183,11 +181,10 @@ namespace nc // Method Description: /// Return a new array with sub-arrays along an axis deleted. /// - /// @param inArray - /// @param inIndex - /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array - /// @return - /// NdArray + /// @param inArray + /// @param inIndex + /// @param inAxis (Optional, default NONE) if none the indices will be applied to the flattened array + /// @return NdArray /// template NdArray deleteIndices(const NdArray& inArray, uint32 inIndex, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/diag.hpp b/include/NumCpp/Functions/diag.hpp index 6e4a5208e..d56b19f62 100644 --- a/include/NumCpp/Functions/diag.hpp +++ b/include/NumCpp/Functions/diag.hpp @@ -40,12 +40,12 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diag.html /// - /// @param inArray - /// @param k Diagonal in question. The default is 0. + /// @param inArray + /// @param k Diagonal in question. The default is 0. /// Use k>0 for diagonals above the main diagonal, and k<0 /// for diagonals below the main diagonal. /// - /// @return NdArray + /// @return NdArray /// template NdArray diag(const NdArray& inArray, int32 k = 0) diff --git a/include/NumCpp/Functions/diagflat.hpp b/include/NumCpp/Functions/diagflat.hpp index 2404c3d61..8a7270ca4 100644 --- a/include/NumCpp/Functions/diagflat.hpp +++ b/include/NumCpp/Functions/diagflat.hpp @@ -41,11 +41,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diagflat.html /// - /// @param inArray - /// @param k Diagonal to set; 0, the default, corresponds to the �main� diagonal, + /// @param inArray + /// @param k Diagonal to set; 0, the default, corresponds to the �main� diagonal, /// a positive (negative) k giving the number of the diagonal above (below) the main. /// - /// @return NdArray + /// @return NdArray /// template NdArray diagflat(const NdArray& inArray, int32 k = 0) diff --git a/include/NumCpp/Functions/diagonal.hpp b/include/NumCpp/Functions/diagonal.hpp index 271247423..2822ea11a 100644 --- a/include/NumCpp/Functions/diagonal.hpp +++ b/include/NumCpp/Functions/diagonal.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diagonal.html /// - /// @param inArray - /// @param inOffset (Defaults to 0) - /// @param inAxis (Optional, default ROW) axis the offset is applied to - /// @return - /// NdArray + /// @param inArray + /// @param inOffset (Defaults to 0) + /// @param inAxis (Optional, default ROW) axis the offset is applied to + /// @return NdArray /// template NdArray diagonal(const NdArray& inArray, int32 inOffset = 0, Axis inAxis = Axis::ROW) diff --git a/include/NumCpp/Functions/diff.hpp b/include/NumCpp/Functions/diff.hpp index 0e3728e6c..10d8bc569 100644 --- a/include/NumCpp/Functions/diff.hpp +++ b/include/NumCpp/Functions/diff.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.diff.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray diff(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/divide.hpp b/include/NumCpp/Functions/divide.hpp index 7ddd046fd..953134c90 100644 --- a/include/NumCpp/Functions/divide.hpp +++ b/include/NumCpp/Functions/divide.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray divide(const NdArray& inArray1, const NdArray& inArray2) @@ -56,10 +55,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray divide(const NdArray& inArray, dtype value) @@ -73,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray divide(dtype value, const NdArray& inArray) @@ -90,10 +87,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> divide(const NdArray& inArray1, const NdArray>& inArray2) @@ -107,10 +103,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> divide(const NdArray>& inArray1, const NdArray& inArray2) @@ -124,10 +119,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> divide(const NdArray& inArray, const std::complex& value) @@ -141,10 +135,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> divide(const std::complex& value, const NdArray& inArray) @@ -158,10 +151,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> divide(const NdArray>& inArray, dtype value) @@ -175,10 +167,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.divide.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> divide(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/dot.hpp b/include/NumCpp/Functions/dot.hpp index da082c85d..1b3c60516 100644 --- a/include/NumCpp/Functions/dot.hpp +++ b/include/NumCpp/Functions/dot.hpp @@ -39,9 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.dot.html /// - /// @param inArray1 - /// @param inArray2 - /// @return NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray dot(const NdArray& inArray1, const NdArray& inArray2) @@ -58,9 +58,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html /// - /// @param inArray1 - /// @param inArray2 - /// @return NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> dot(const NdArray& inArray1, const NdArray>& inArray2) @@ -112,9 +112,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html /// - /// @param inArray1 - /// @param inArray2 - /// @return NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> dot(const NdArray>& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/dump.hpp b/include/NumCpp/Functions/dump.hpp index 8c971a9ef..981ad8ea8 100644 --- a/include/NumCpp/Functions/dump.hpp +++ b/include/NumCpp/Functions/dump.hpp @@ -38,10 +38,9 @@ namespace nc /// Dump a binary file of the array to the specified file. /// The array can be read back with or NC::load. /// - /// @param inArray - /// @param inFilename - /// @return - /// NdArray + /// @param inArray + /// @param inFilename + /// @return NdArray /// template void dump(const NdArray& inArray, const std::string& inFilename) diff --git a/include/NumCpp/Functions/empty.hpp b/include/NumCpp/Functions/empty.hpp index b84a12056..635b2e381 100644 --- a/include/NumCpp/Functions/empty.hpp +++ b/include/NumCpp/Functions/empty.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty.html /// - /// @param inNumRows - /// @param inNumCols - /// @return - /// NdArray + /// @param inNumRows + /// @param inNumCols + /// @return NdArray /// template NdArray empty(uint32 inNumRows, uint32 inNumCols) @@ -56,10 +55,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty.html /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// template NdArray empty(const Shape& inShape) diff --git a/include/NumCpp/Functions/empty_like.hpp b/include/NumCpp/Functions/empty_like.hpp index 7d7ef14d4..efdf0854b 100644 --- a/include/NumCpp/Functions/empty_like.hpp +++ b/include/NumCpp/Functions/empty_like.hpp @@ -37,10 +37,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.empty_like.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray empty_like(const NdArray& inArray) diff --git a/include/NumCpp/Functions/endianess.hpp b/include/NumCpp/Functions/endianess.hpp index 856570219..b0c6e4ca1 100644 --- a/include/NumCpp/Functions/endianess.hpp +++ b/include/NumCpp/Functions/endianess.hpp @@ -35,10 +35,8 @@ namespace nc // Method Description: /// Return the endianess of the array values. /// - /// @param - /// inArray - /// @return - /// Endian + /// @param inArray + /// @return Endian /// template Endian endianess(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/equal.hpp b/include/NumCpp/Functions/equal.hpp index 0ebd28ae6..980820988 100644 --- a/include/NumCpp/Functions/equal.hpp +++ b/include/NumCpp/Functions/equal.hpp @@ -37,10 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.equal.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/exp.hpp b/include/NumCpp/Functions/exp.hpp index 4031f993e..852e4bb70 100644 --- a/include/NumCpp/Functions/exp.hpp +++ b/include/NumCpp/Functions/exp.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto exp(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto exp(const NdArray& inArray) diff --git a/include/NumCpp/Functions/exp2.hpp b/include/NumCpp/Functions/exp2.hpp index 0d0361361..74fe6bebd 100644 --- a/include/NumCpp/Functions/exp2.hpp +++ b/include/NumCpp/Functions/exp2.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp2.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto exp2(dtype inValue) noexcept @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.exp2.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto exp2(const NdArray& inArray) diff --git a/include/NumCpp/Functions/expm1.hpp b/include/NumCpp/Functions/expm1.hpp index 62d5a469e..45083ed03 100644 --- a/include/NumCpp/Functions/expm1.hpp +++ b/include/NumCpp/Functions/expm1.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.expm1.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto expm1(dtype inValue) noexcept @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.expm1.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto expm1(const NdArray& inArray) diff --git a/include/NumCpp/Functions/eye.hpp b/include/NumCpp/Functions/eye.hpp index 70787553b..b0bac7650 100644 --- a/include/NumCpp/Functions/eye.hpp +++ b/include/NumCpp/Functions/eye.hpp @@ -40,13 +40,12 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html /// - /// @param inN: number of rows (N) - /// @param inM: number of columns (M) - /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, + /// @param inN: number of rows (N) + /// @param inM: number of columns (M) + /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray eye(uint32 inN, uint32 inM, int32 inK = 0) @@ -92,12 +91,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html /// - /// @param inN: number of rows and columns (N) - /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, + /// @param inN: number of rows and columns (N) + /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray eye(uint32 inN, int32 inK = 0) @@ -111,12 +109,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.eye.html /// - /// @param inShape - /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, + /// @param inShape + /// @param inK: Index of the diagonal: 0 (the default) refers to the main diagonal, /// a positive value refers to an upper diagonal, and a negative value to a lower diagonal. /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray eye(const Shape& inShape, int32 inK = 0) diff --git a/include/NumCpp/Functions/fillDiagnol.hpp b/include/NumCpp/Functions/fillDiagnol.hpp index c147c52c4..9b2fe155f 100644 --- a/include/NumCpp/Functions/fillDiagnol.hpp +++ b/include/NumCpp/Functions/fillDiagnol.hpp @@ -39,8 +39,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fill_diagonal.html /// - /// @param inArray - /// @param inValue + /// @param inArray + /// @param inValue /// template void fillDiagonal(NdArray& inArray, dtype inValue) noexcept diff --git a/include/NumCpp/Functions/find.hpp b/include/NumCpp/Functions/find.hpp index e8a078446..9027ba5ba 100644 --- a/include/NumCpp/Functions/find.hpp +++ b/include/NumCpp/Functions/find.hpp @@ -38,11 +38,10 @@ namespace nc // Method Description: /// Find flat indices of nonzero elements. /// - /// @param mask: the mask to apply to the array - /// @param n: the first n indices to return (optional, default all) + /// @param mask: the mask to apply to the array + /// @param n: the first n indices to return (optional, default all) /// - /// @return - /// NdArray + /// @return NdArray /// inline NdArray find(const NdArray& mask, uint32 n = std::numeric_limits::max()) { diff --git a/include/NumCpp/Functions/fix.hpp b/include/NumCpp/Functions/fix.hpp index 25c5ee5cf..ce749d8af 100644 --- a/include/NumCpp/Functions/fix.hpp +++ b/include/NumCpp/Functions/fix.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fix.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template dtype fix(dtype inValue) noexcept @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fix.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray fix(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flatnonzero.hpp b/include/NumCpp/Functions/flatnonzero.hpp index 7ea456efc..fbdb74722 100644 --- a/include/NumCpp/Functions/flatnonzero.hpp +++ b/include/NumCpp/Functions/flatnonzero.hpp @@ -37,10 +37,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flatnonzero.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray flatnonzero(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flatten.hpp b/include/NumCpp/Functions/flatten.hpp index 15b5b4f69..30c5ec47c 100644 --- a/include/NumCpp/Functions/flatten.hpp +++ b/include/NumCpp/Functions/flatten.hpp @@ -35,11 +35,9 @@ namespace nc // Method Description: /// Return a copy of the array collapsed into one dimension. /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray flatten(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flip.hpp b/include/NumCpp/Functions/flip.hpp index db82c33cb..7c49340dc 100644 --- a/include/NumCpp/Functions/flip.hpp +++ b/include/NumCpp/Functions/flip.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flip.html /// - /// @param inArray - /// @param inAxis - /// @return - /// NdArray + /// @param inArray + /// @param inAxis + /// @return NdArray /// template NdArray flip(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/fliplr.hpp b/include/NumCpp/Functions/fliplr.hpp index 371ad5462..9d84303f4 100644 --- a/include/NumCpp/Functions/fliplr.hpp +++ b/include/NumCpp/Functions/fliplr.hpp @@ -39,10 +39,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fliplr.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray fliplr(const NdArray& inArray) diff --git a/include/NumCpp/Functions/flipud.hpp b/include/NumCpp/Functions/flipud.hpp index b62ad115a..f4aecbcb2 100644 --- a/include/NumCpp/Functions/flipud.hpp +++ b/include/NumCpp/Functions/flipud.hpp @@ -39,10 +39,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.flipud.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray flipud(const NdArray& inArray) diff --git a/include/NumCpp/Functions/floor.hpp b/include/NumCpp/Functions/floor.hpp index ad53ed31a..51a51a640 100644 --- a/include/NumCpp/Functions/floor.hpp +++ b/include/NumCpp/Functions/floor.hpp @@ -41,7 +41,7 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor.html /// - /// @param inValue + /// @param inValue /// @return value /// template @@ -58,7 +58,7 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor.html /// - /// @param inArray + /// @param inArray /// @return NdArray /// template diff --git a/include/NumCpp/Functions/floor_divide.hpp b/include/NumCpp/Functions/floor_divide.hpp index b7fa3c23c..935e3acea 100644 --- a/include/NumCpp/Functions/floor_divide.hpp +++ b/include/NumCpp/Functions/floor_divide.hpp @@ -41,10 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor_divide.html /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// value + /// @param inValue1 + /// @param inValue2 + /// @return value /// template dtype floor_divide(dtype inValue1, dtype inValue2) noexcept @@ -60,10 +59,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.floor_divide.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray floor_divide(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/fmax.hpp b/include/NumCpp/Functions/fmax.hpp index 855608b55..0a4d2b882 100644 --- a/include/NumCpp/Functions/fmax.hpp +++ b/include/NumCpp/Functions/fmax.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmax.html /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// value + /// @param inValue1 + /// @param inValue2 + /// @return value /// template dtype fmax(dtype inValue1, dtype inValue2) noexcept @@ -73,10 +72,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmax.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray fmax(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/fmin.hpp b/include/NumCpp/Functions/fmin.hpp index 859e53f21..a9ddbaf78 100644 --- a/include/NumCpp/Functions/fmin.hpp +++ b/include/NumCpp/Functions/fmin.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmin.html /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// value + /// @param inValue1 + /// @param inValue2 + /// @return value /// template dtype fmin(dtype inValue1, dtype inValue2) noexcept @@ -73,10 +72,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmin.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray fmin(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/fmod.hpp b/include/NumCpp/Functions/fmod.hpp index 424c46942..3343303cc 100644 --- a/include/NumCpp/Functions/fmod.hpp +++ b/include/NumCpp/Functions/fmod.hpp @@ -44,10 +44,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html /// /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// value + /// @param inValue1 + /// @param inValue2 + /// @return value /// template, int> = 0> @@ -63,10 +62,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html /// /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// value + /// @param inValue1 + /// @param inValue2 + /// @return value /// template, int> = 0> @@ -82,10 +80,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fmod.html /// /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray fmod(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/frombuffer.hpp b/include/NumCpp/Functions/frombuffer.hpp index d230002eb..aee12f637 100644 --- a/include/NumCpp/Functions/frombuffer.hpp +++ b/include/NumCpp/Functions/frombuffer.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.frombuffer.html /// - /// @param inBufferPtr - /// @param inNumBytes - /// @return - /// NdArray + /// @param inBufferPtr + /// @param inNumBytes + /// @return NdArray /// template NdArray frombuffer(const char* inBufferPtr, uint32 inNumBytes) diff --git a/include/NumCpp/Functions/fromfile.hpp b/include/NumCpp/Functions/fromfile.hpp index 6864b00ab..5c773bf43 100644 --- a/include/NumCpp/Functions/fromfile.hpp +++ b/include/NumCpp/Functions/fromfile.hpp @@ -46,9 +46,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromfile.html /// - /// @param inFilename - /// @return - /// NdArray + /// @param inFilename + /// @return NdArray /// template NdArray fromfile(const std::string& inFilename) @@ -91,10 +90,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromfile.html /// - /// @param inFilename - /// @param inSep: Delimiter separator between values in the file - /// @return - /// NdArray + /// @param inFilename + /// @param inSep: Delimiter separator between values in the file + /// @return NdArray /// template NdArray fromfile(const std::string& inFilename, const char inSep) diff --git a/include/NumCpp/Functions/fromiter.hpp b/include/NumCpp/Functions/fromiter.hpp index a48eca9c1..1d6881b51 100644 --- a/include/NumCpp/Functions/fromiter.hpp +++ b/include/NumCpp/Functions/fromiter.hpp @@ -40,10 +40,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.fromiter.html /// - /// @param inBegin - /// @param inEnd - /// @return - /// NdArray + /// @param inBegin + /// @param inEnd + /// @return NdArray /// template NdArray fromiter(Iter inBegin, Iter inEnd) diff --git a/include/NumCpp/Functions/full.hpp b/include/NumCpp/Functions/full.hpp index f31ae1e8c..6494ac5a2 100644 --- a/include/NumCpp/Functions/full.hpp +++ b/include/NumCpp/Functions/full.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html /// - /// @param inSquareSize - /// @param inFillValue - /// @return - /// NdArray + /// @param inSquareSize + /// @param inFillValue + /// @return NdArray /// template NdArray full(uint32 inSquareSize, dtype inFillValue) @@ -58,11 +57,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html /// - /// @param inNumRows - /// @param inNumCols - /// @param inFillValue - /// @return - /// NdArray + /// @param inNumRows + /// @param inNumCols + /// @param inFillValue + /// @return NdArray /// template NdArray full(uint32 inNumRows, uint32 inNumCols, dtype inFillValue) @@ -78,10 +76,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full.html /// - /// @param inShape - /// @param inFillValue - /// @return - /// NdArray + /// @param inShape + /// @param inFillValue + /// @return NdArray /// template NdArray full(const Shape& inShape, dtype inFillValue) diff --git a/include/NumCpp/Functions/full_like.hpp b/include/NumCpp/Functions/full_like.hpp index 7985ed115..94243c340 100644 --- a/include/NumCpp/Functions/full_like.hpp +++ b/include/NumCpp/Functions/full_like.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.full_like.html /// - /// @param inArray - /// @param inFillValue - /// @return - /// NdArray + /// @param inArray + /// @param inFillValue + /// @return NdArray /// template NdArray full_like(const NdArray& inArray, dtype inFillValue) diff --git a/include/NumCpp/Functions/gcd.hpp b/include/NumCpp/Functions/gcd.hpp index 14759871a..645fef98e 100644 --- a/include/NumCpp/Functions/gcd.hpp +++ b/include/NumCpp/Functions/gcd.hpp @@ -51,10 +51,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gcd.html /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// dtype + /// @param inValue1 + /// @param inValue2 + /// @return dtype /// template dtype gcd(dtype inValue1, dtype inValue2) noexcept @@ -77,9 +76,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gcd.html /// - /// @param inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template dtype gcd(const NdArray& inArray) diff --git a/include/NumCpp/Functions/gradient.hpp b/include/NumCpp/Functions/gradient.hpp index fd93fabb6..8230a1f96 100644 --- a/include/NumCpp/Functions/gradient.hpp +++ b/include/NumCpp/Functions/gradient.hpp @@ -47,10 +47,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gradient.html /// /// - /// @param inArray - /// @param inAxis (default ROW) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (default ROW) + /// @return NdArray /// template NdArray gradient(const NdArray& inArray, Axis inAxis = Axis::ROW) @@ -143,10 +142,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.gradient.html /// /// - /// @param inArray - /// @param inAxis (default ROW) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (default ROW) + /// @return NdArray /// template NdArray> gradient(const NdArray>& inArray, Axis inAxis = Axis::ROW) diff --git a/include/NumCpp/Functions/greater.hpp b/include/NumCpp/Functions/greater.hpp index 4b80e1f6b..08d8a08a8 100644 --- a/include/NumCpp/Functions/greater.hpp +++ b/include/NumCpp/Functions/greater.hpp @@ -38,10 +38,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.greater.html /// /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray greater(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/greater_equal.hpp b/include/NumCpp/Functions/greater_equal.hpp index 92a197866..581a096b6 100644 --- a/include/NumCpp/Functions/greater_equal.hpp +++ b/include/NumCpp/Functions/greater_equal.hpp @@ -38,10 +38,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.greater_equal.html /// /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray greater_equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/hamming.hpp b/include/NumCpp/Functions/hamming.hpp index a2d2c1272..2830f65c1 100644 --- a/include/NumCpp/Functions/hamming.hpp +++ b/include/NumCpp/Functions/hamming.hpp @@ -42,7 +42,7 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.hamming.html /// - /// @param m: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// inline NdArray hamming(int32 m) diff --git a/include/NumCpp/Functions/hanning.hpp b/include/NumCpp/Functions/hanning.hpp index c0ca54197..b931a2d4d 100644 --- a/include/NumCpp/Functions/hanning.hpp +++ b/include/NumCpp/Functions/hanning.hpp @@ -42,7 +42,7 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.hanning.html /// - /// @param m: Number of points in the output window. If zero or less, an empty array is returned. + /// @param m: Number of points in the output window. If zero or less, an empty array is returned. /// @return NdArray /// inline NdArray hanning(int32 m) diff --git a/include/NumCpp/Functions/histogram.hpp b/include/NumCpp/Functions/histogram.hpp index bcc619188..a5e385c2b 100644 --- a/include/NumCpp/Functions/histogram.hpp +++ b/include/NumCpp/Functions/histogram.hpp @@ -47,12 +47,11 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.histogram.html /// /// - /// @param inArray - /// @param inBinEdges: monotonically increasing array of bin edges, including the + /// @param inArray + /// @param inBinEdges: monotonically increasing array of bin edges, including the /// rightmost edge, allowing for non-uniform bin widths. /// - /// @return - /// array of histogram counts + /// @return array of histogram counts /// template NdArray histogram(const NdArray& inArray, const NdArray& inBinEdges) @@ -116,11 +115,10 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.histogram.html /// /// - /// @param inArray - /// @param inNumBins( default 10) + /// @param inArray + /// @param inNumBins( default 10) /// - /// @return - /// std::pair of NdArrays; first is histogram counts, seconds is the bin edges + /// @return std::pair of NdArrays; first is histogram counts, seconds is the bin edges /// template std::pair, NdArray > histogram(const NdArray& inArray, uint32 inNumBins = 10) diff --git a/include/NumCpp/Functions/hstack.hpp b/include/NumCpp/Functions/hstack.hpp index b23cb84b5..eb6e736d8 100644 --- a/include/NumCpp/Functions/hstack.hpp +++ b/include/NumCpp/Functions/hstack.hpp @@ -41,11 +41,9 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hstack.html /// /// - /// @param - /// inArrayList: {list} of arrays to stack + /// @param inArrayList: {list} of arrays to stack /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray hstack(std::initializer_list > inArrayList) diff --git a/include/NumCpp/Functions/hypot.hpp b/include/NumCpp/Functions/hypot.hpp index 2f66a8d27..892d4e26f 100644 --- a/include/NumCpp/Functions/hypot.hpp +++ b/include/NumCpp/Functions/hypot.hpp @@ -47,11 +47,10 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html /// /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return - /// value + /// @return value /// template double hypot(dtype inValue1, dtype inValue2) noexcept @@ -70,12 +69,11 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html /// /// - /// @param inValue1 - /// @param inValue2 - /// @param inValue3 + /// @param inValue1 + /// @param inValue2 + /// @param inValue3 /// - /// @return - /// value + /// @return value /// template double hypot(dtype inValue1, dtype inValue2, dtype inValue3) noexcept @@ -102,11 +100,10 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.hypot.html /// /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray hypot(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/identity.hpp b/include/NumCpp/Functions/identity.hpp index f5b8dad44..351c49de3 100644 --- a/include/NumCpp/Functions/identity.hpp +++ b/include/NumCpp/Functions/identity.hpp @@ -39,11 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.identity.html /// - /// @param - /// inSquareSize + /// @param inSquareSize /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray identity(uint32 inSquareSize) diff --git a/include/NumCpp/Functions/imag.hpp b/include/NumCpp/Functions/imag.hpp index 9417efdf4..cc5e201bb 100644 --- a/include/NumCpp/Functions/imag.hpp +++ b/include/NumCpp/Functions/imag.hpp @@ -40,10 +40,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.imag.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto imag(const std::complex& inValue) @@ -59,10 +57,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.imag.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto imag(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/inner.hpp b/include/NumCpp/Functions/inner.hpp index 18f7e859b..20a6a2571 100644 --- a/include/NumCpp/Functions/inner.hpp +++ b/include/NumCpp/Functions/inner.hpp @@ -40,8 +40,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.inner.html /// - /// @param a: array 1 - /// @param b: array 2 + /// @param a: array 1 + /// @param b: array 2 /// @return NdArray /// template diff --git a/include/NumCpp/Functions/interp.hpp b/include/NumCpp/Functions/interp.hpp index 9443c4865..971680394 100644 --- a/include/NumCpp/Functions/interp.hpp +++ b/include/NumCpp/Functions/interp.hpp @@ -38,11 +38,11 @@ namespace nc //============================================================================ /// Returns the linear interpolation between two points /// - /// @param inValue1 - /// @param inValue2 - /// @param inPercent + /// @param inValue1 + /// @param inValue2 + /// @param inPercent /// - /// @return linear interpolated point + /// @return linear interpolated point /// template constexpr double interp(dtype inValue1, dtype inValue2, double inPercent) noexcept @@ -61,12 +61,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.interp.html /// - /// @param inX: The x-coordinates at which to evaluate the interpolated values. - /// @param inXp: The x-coordinates of the data points, must be increasing. Otherwise, xp is internally sorted. - /// @param inFp: The y-coordinates of the data points, same length as inXp. + /// @param inX: The x-coordinates at which to evaluate the interpolated values. + /// @param inXp: The x-coordinates of the data points, must be increasing. Otherwise, xp is internally sorted. + /// @param inFp: The y-coordinates of the data points, same length as inXp. /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray interp(const NdArray& inX, const NdArray& inXp, const NdArray& inFp) diff --git a/include/NumCpp/Functions/intersect1d.hpp b/include/NumCpp/Functions/intersect1d.hpp index a4e33b11d..51321cb94 100644 --- a/include/NumCpp/Functions/intersect1d.hpp +++ b/include/NumCpp/Functions/intersect1d.hpp @@ -44,11 +44,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.intersect1d.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray intersect1d(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/invert.hpp b/include/NumCpp/Functions/invert.hpp index 8027a89c3..dda467c89 100644 --- a/include/NumCpp/Functions/invert.hpp +++ b/include/NumCpp/Functions/invert.hpp @@ -37,11 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.invert.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray invert(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isclose.hpp b/include/NumCpp/Functions/isclose.hpp index 7ec74d3c1..5975919aa 100644 --- a/include/NumCpp/Functions/isclose.hpp +++ b/include/NumCpp/Functions/isclose.hpp @@ -47,13 +47,12 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isclose.html /// - /// @param inArray1 - /// @param inArray2 - /// @param inRtol: relative tolerance (default 1e-5) - /// @param inAtol: absolute tolerance (default 1e-9) + /// @param inArray1 + /// @param inArray2 + /// @param inRtol: relative tolerance (default 1e-5) + /// @param inAtol: absolute tolerance (default 1e-9) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray isclose(const NdArray& inArray1, const NdArray& inArray2, double inRtol = 1e-05, double inAtol = 1e-08) diff --git a/include/NumCpp/Functions/isinf.hpp b/include/NumCpp/Functions/isinf.hpp index 2c494b839..957a8b5b2 100644 --- a/include/NumCpp/Functions/isinf.hpp +++ b/include/NumCpp/Functions/isinf.hpp @@ -41,11 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isinf.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// bool + /// @return bool /// template bool isinf(dtype inValue) noexcept @@ -61,11 +59,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isinf.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray isinf(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isnan.hpp b/include/NumCpp/Functions/isnan.hpp index 47b136236..15007b6c8 100644 --- a/include/NumCpp/Functions/isnan.hpp +++ b/include/NumCpp/Functions/isnan.hpp @@ -41,11 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isnan.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// bool + /// @return bool /// template bool isnan(dtype inValue) noexcept @@ -66,11 +64,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isnan.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray isnan(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isneginf.hpp b/include/NumCpp/Functions/isneginf.hpp index da7d97189..5a5dd9826 100644 --- a/include/NumCpp/Functions/isneginf.hpp +++ b/include/NumCpp/Functions/isneginf.hpp @@ -39,11 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isneginf.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// bool + /// @return bool /// template bool isneginf(dtype inValue) noexcept @@ -59,11 +57,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isneginf.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray isneginf(const NdArray& inArray) diff --git a/include/NumCpp/Functions/isposinf.hpp b/include/NumCpp/Functions/isposinf.hpp index fddcfb1fd..645c5bf54 100644 --- a/include/NumCpp/Functions/isposinf.hpp +++ b/include/NumCpp/Functions/isposinf.hpp @@ -39,11 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isposinf.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// bool + /// @return bool /// template bool isposinf(dtype inValue) noexcept @@ -59,11 +57,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.isposinf.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray isposinf(const NdArray& inArray) diff --git a/include/NumCpp/Functions/lcm.hpp b/include/NumCpp/Functions/lcm.hpp index 47da81b2e..3d711c366 100644 --- a/include/NumCpp/Functions/lcm.hpp +++ b/include/NumCpp/Functions/lcm.hpp @@ -51,10 +51,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.lcm.html /// - /// @param inValue1 - /// @param inValue2 - /// @return - /// dtype + /// @param inValue1 + /// @param inValue2 + /// @return dtype /// template dtype lcm(dtype inValue1, dtype inValue2) noexcept @@ -76,9 +75,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.lcm.html /// - /// @param inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template dtype lcm(const NdArray& inArray) diff --git a/include/NumCpp/Functions/ldexp.hpp b/include/NumCpp/Functions/ldexp.hpp index d0eded719..eb0241405 100644 --- a/include/NumCpp/Functions/ldexp.hpp +++ b/include/NumCpp/Functions/ldexp.hpp @@ -44,11 +44,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ldexp.html /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return - /// value + /// @return value /// template dtype ldexp(dtype inValue1, uint8 inValue2) noexcept @@ -64,11 +63,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ldexp.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray ldexp(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/left_shift.hpp b/include/NumCpp/Functions/left_shift.hpp index 17ec426e6..64d84eabb 100644 --- a/include/NumCpp/Functions/left_shift.hpp +++ b/include/NumCpp/Functions/left_shift.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.left_shift.html /// - /// @param inArray - /// @param inNumBits + /// @param inArray + /// @param inNumBits /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray left_shift(const NdArray& inArray, uint8 inNumBits) diff --git a/include/NumCpp/Functions/less.hpp b/include/NumCpp/Functions/less.hpp index 038f643d3..ea8f4d045 100644 --- a/include/NumCpp/Functions/less.hpp +++ b/include/NumCpp/Functions/less.hpp @@ -37,11 +37,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.less.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray less(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/less_equal.hpp b/include/NumCpp/Functions/less_equal.hpp index b196898fc..34bf6f799 100644 --- a/include/NumCpp/Functions/less_equal.hpp +++ b/include/NumCpp/Functions/less_equal.hpp @@ -37,11 +37,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.less_equal.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray less_equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/linspace.hpp b/include/NumCpp/Functions/linspace.hpp index c534b02b8..601ab08a0 100644 --- a/include/NumCpp/Functions/linspace.hpp +++ b/include/NumCpp/Functions/linspace.hpp @@ -50,13 +50,12 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.linspace.html /// - /// @param inStart - /// @param inStop - /// @param inNum: number of points (default = 50) - /// @param endPoint: include endPoint (default = true) + /// @param inStart + /// @param inStop + /// @param inNum: number of points (default = 50) + /// @param endPoint: include endPoint (default = true) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray linspace(dtype inStart, dtype inStop, uint32 inNum = 50, bool endPoint = true) diff --git a/include/NumCpp/Functions/load.hpp b/include/NumCpp/Functions/load.hpp index 3cf187c79..b6a04ca9c 100644 --- a/include/NumCpp/Functions/load.hpp +++ b/include/NumCpp/Functions/load.hpp @@ -40,11 +40,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.load.html /// - /// @param - /// inFilename + /// @param inFilename /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray load(const std::string& inFilename) diff --git a/include/NumCpp/Functions/log.hpp b/include/NumCpp/Functions/log.hpp index 995f402ef..899f79488 100644 --- a/include/NumCpp/Functions/log.hpp +++ b/include/NumCpp/Functions/log.hpp @@ -42,11 +42,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template auto log(dtype inValue) noexcept @@ -62,11 +60,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template auto log(const NdArray& inArray) diff --git a/include/NumCpp/Functions/log10.hpp b/include/NumCpp/Functions/log10.hpp index aec8393de..d2e1385e7 100644 --- a/include/NumCpp/Functions/log10.hpp +++ b/include/NumCpp/Functions/log10.hpp @@ -42,11 +42,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log10.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template auto log10(dtype inValue) noexcept @@ -62,11 +60,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log10.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template auto log10(const NdArray& inArray) diff --git a/include/NumCpp/Functions/log1p.hpp b/include/NumCpp/Functions/log1p.hpp index f3ae54f65..9a5e87ae0 100644 --- a/include/NumCpp/Functions/log1p.hpp +++ b/include/NumCpp/Functions/log1p.hpp @@ -43,11 +43,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log1p.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template auto log1p(dtype inValue) noexcept @@ -65,11 +63,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log1p.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template auto log1p(const NdArray& inArray) diff --git a/include/NumCpp/Functions/log2.hpp b/include/NumCpp/Functions/log2.hpp index 633e73bbd..55343a551 100644 --- a/include/NumCpp/Functions/log2.hpp +++ b/include/NumCpp/Functions/log2.hpp @@ -41,11 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log2.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template auto log2(dtype inValue) noexcept @@ -61,11 +59,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.log2.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template auto log2(const NdArray& inArray) diff --git a/include/NumCpp/Functions/logical_and.hpp b/include/NumCpp/Functions/logical_and.hpp index 3ef959324..79e12e7ea 100644 --- a/include/NumCpp/Functions/logical_and.hpp +++ b/include/NumCpp/Functions/logical_and.hpp @@ -41,11 +41,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_and.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray logical_and(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/logical_not.hpp b/include/NumCpp/Functions/logical_not.hpp index 26cb2b323..1bab22656 100644 --- a/include/NumCpp/Functions/logical_not.hpp +++ b/include/NumCpp/Functions/logical_not.hpp @@ -39,11 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_not.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray logical_not(const NdArray& inArray) diff --git a/include/NumCpp/Functions/logical_or.hpp b/include/NumCpp/Functions/logical_or.hpp index ddc4baa5b..db1b84b3c 100644 --- a/include/NumCpp/Functions/logical_or.hpp +++ b/include/NumCpp/Functions/logical_or.hpp @@ -41,11 +41,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_or.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray logical_or(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/logical_xor.hpp b/include/NumCpp/Functions/logical_xor.hpp index 0dc9bbe6d..e4fa11676 100644 --- a/include/NumCpp/Functions/logical_xor.hpp +++ b/include/NumCpp/Functions/logical_xor.hpp @@ -42,11 +42,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.logical_xor.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray logical_xor(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/matmul.hpp b/include/NumCpp/Functions/matmul.hpp index 213f9f0c5..65eac176d 100644 --- a/include/NumCpp/Functions/matmul.hpp +++ b/include/NumCpp/Functions/matmul.hpp @@ -40,11 +40,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray matmul(const NdArray& inArray1, const NdArray& inArray2) @@ -58,11 +57,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> matmul(const NdArray& inArray1, const NdArray>& inArray2) @@ -76,11 +74,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.matmul.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> matmul(const NdArray>& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/max.hpp b/include/NumCpp/Functions/max.hpp index c869f7981..a32c9e39f 100644 --- a/include/NumCpp/Functions/max.hpp +++ b/include/NumCpp/Functions/max.hpp @@ -35,11 +35,10 @@ namespace nc // Method Description: /// Return the maximum of an array or maximum along an axis. /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray max(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/maximum.hpp b/include/NumCpp/Functions/maximum.hpp index 0420d1add..1a7a8d953 100644 --- a/include/NumCpp/Functions/maximum.hpp +++ b/include/NumCpp/Functions/maximum.hpp @@ -45,11 +45,10 @@ namespace nc /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.maximum.html /// /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray maximum(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/mean.hpp b/include/NumCpp/Functions/mean.hpp index 522de05aa..b50115f43 100644 --- a/include/NumCpp/Functions/mean.hpp +++ b/include/NumCpp/Functions/mean.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mean.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray mean(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -100,11 +99,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mean.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> mean(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/median.hpp b/include/NumCpp/Functions/median.hpp index fd2cba913..8aa2a8469 100644 --- a/include/NumCpp/Functions/median.hpp +++ b/include/NumCpp/Functions/median.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.median.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray median(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/meshgrid.hpp b/include/NumCpp/Functions/meshgrid.hpp index 72ab0c47e..efea03d93 100644 --- a/include/NumCpp/Functions/meshgrid.hpp +++ b/include/NumCpp/Functions/meshgrid.hpp @@ -44,11 +44,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html /// - /// @param inICoords - /// @param inJCoords + /// @param inICoords + /// @param inJCoords /// - /// @return - /// std::pair, NdArray >, i and j matrices + /// @return std::pair, NdArray >, i and j matrices /// template std::pair, NdArray > meshgrid(const NdArray& inICoords, const NdArray& inJCoords) @@ -82,19 +81,18 @@ namespace nc } //============================================================================ -// Method Description: -/// Return coordinate matrices from coordinate vectors. -/// Make 2D coordinate arrays for vectorized evaluations of 2D scaler -/// vector fields over 2D grids, given one - dimensional coordinate arrays x1, x2, ..., xn. -/// -/// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html -/// -/// @param inSlice1 -/// @param inSlice2 -/// -/// @return -/// std::pair, NdArray >, i and j matrices -/// + // Method Description: + /// Return coordinate matrices from coordinate vectors. + /// Make 2D coordinate arrays for vectorized evaluations of 2D scaler + /// vector fields over 2D grids, given one - dimensional coordinate arrays x1, x2, ..., xn. + /// + /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.meshgrid.html + /// + /// @param inSlice1 + /// @param inSlice2 + /// + /// @return std::pair, NdArray >, i and j matrices + /// template std::pair, NdArray > meshgrid(const Slice& inSlice1, const Slice& inSlice2) { diff --git a/include/NumCpp/Functions/min.hpp b/include/NumCpp/Functions/min.hpp index ec09c6194..7d9dc5c53 100644 --- a/include/NumCpp/Functions/min.hpp +++ b/include/NumCpp/Functions/min.hpp @@ -35,11 +35,10 @@ namespace nc // Method Description: /// Return the minimum of an array or minimum along an axis. /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray min(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/minimum.hpp b/include/NumCpp/Functions/minimum.hpp index 1c720bded..ccb0774f8 100644 --- a/include/NumCpp/Functions/minimum.hpp +++ b/include/NumCpp/Functions/minimum.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.minimum.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray minimum(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/mod.hpp b/include/NumCpp/Functions/mod.hpp index 1757eda4c..6c3653afd 100644 --- a/include/NumCpp/Functions/mod.hpp +++ b/include/NumCpp/Functions/mod.hpp @@ -37,11 +37,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.mod.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray mod(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/multiply.hpp b/include/NumCpp/Functions/multiply.hpp index db9b29942..ada697a1a 100644 --- a/include/NumCpp/Functions/multiply.hpp +++ b/include/NumCpp/Functions/multiply.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray multiply(const NdArray& inArray1, const NdArray& inArray2) @@ -56,10 +55,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray multiply(const NdArray& inArray, dtype value) @@ -73,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray multiply(dtype value, const NdArray& inArray) @@ -90,10 +87,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> multiply(const NdArray& inArray1, const NdArray>& inArray2) @@ -107,10 +103,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> multiply(const NdArray>& inArray1, const NdArray& inArray2) @@ -124,10 +119,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> multiply(const NdArray& inArray, const std::complex& value) @@ -141,10 +135,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> multiply(const std::complex& value, const NdArray& inArray) @@ -158,10 +151,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> multiply(const NdArray>& inArray, dtype value) @@ -175,10 +167,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.multiply.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> multiply(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/nan_to_num.hpp b/include/NumCpp/Functions/nan_to_num.hpp index 3a1eebcd3..6d0fc83a9 100644 --- a/include/NumCpp/Functions/nan_to_num.hpp +++ b/include/NumCpp/Functions/nan_to_num.hpp @@ -45,12 +45,11 @@ namespace nc /// /// NumPy Reference: https://numpy.org/doc/stable/reference/generated/numpy.nan_to_num.html /// - /// @param inArray - /// @param nan: value to be used to fill NaN values, default 0 - /// @param posInf: value to be used to fill positive infinity values, default a very large number - /// @param negInf: value to be used to fill negative infinity values, default a very large negative number - /// @return - /// NdArray + /// @param inArray + /// @param nan: value to be used to fill NaN values, default 0 + /// @param posInf: value to be used to fill positive infinity values, default a very large number + /// @param negInf: value to be used to fill negative infinity values, default a very large negative number + /// @return NdArray /// template NdArray nan_to_num(NdArray inArray, diff --git a/include/NumCpp/Functions/nanargmax.hpp b/include/NumCpp/Functions/nanargmax.hpp index 1de70bbfc..35dc44f5c 100644 --- a/include/NumCpp/Functions/nanargmax.hpp +++ b/include/NumCpp/Functions/nanargmax.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanargmax.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray nanargmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanargmin.hpp b/include/NumCpp/Functions/nanargmin.hpp index b1ade6653..6103c76f4 100644 --- a/include/NumCpp/Functions/nanargmin.hpp +++ b/include/NumCpp/Functions/nanargmin.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanargmin.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray nanargmin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nancumprod.hpp b/include/NumCpp/Functions/nancumprod.hpp index 7c3b6c2a5..b4fe873e3 100644 --- a/include/NumCpp/Functions/nancumprod.hpp +++ b/include/NumCpp/Functions/nancumprod.hpp @@ -43,10 +43,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nancumprod.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray nancumprod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nancumsum.hpp b/include/NumCpp/Functions/nancumsum.hpp index eb5765502..ab05f6dd8 100644 --- a/include/NumCpp/Functions/nancumsum.hpp +++ b/include/NumCpp/Functions/nancumsum.hpp @@ -43,10 +43,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nancumsum.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray nancumsum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmax.hpp b/include/NumCpp/Functions/nanmax.hpp index a400dc8c6..215f0aef8 100644 --- a/include/NumCpp/Functions/nanmax.hpp +++ b/include/NumCpp/Functions/nanmax.hpp @@ -44,11 +44,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmax.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmean.hpp b/include/NumCpp/Functions/nanmean.hpp index 233c225ed..e06a59699 100644 --- a/include/NumCpp/Functions/nanmean.hpp +++ b/include/NumCpp/Functions/nanmean.hpp @@ -45,11 +45,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmean.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanmean(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmedian.hpp b/include/NumCpp/Functions/nanmedian.hpp index be731d2f3..272f10cf3 100644 --- a/include/NumCpp/Functions/nanmedian.hpp +++ b/include/NumCpp/Functions/nanmedian.hpp @@ -46,11 +46,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmedian.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanmedian(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanmin.hpp b/include/NumCpp/Functions/nanmin.hpp index b195616b4..08b9e98af 100644 --- a/include/NumCpp/Functions/nanmin.hpp +++ b/include/NumCpp/Functions/nanmin.hpp @@ -44,11 +44,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanmin.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanmin(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanpercentile.hpp b/include/NumCpp/Functions/nanpercentile.hpp index 1bb296a0e..30beacb76 100644 --- a/include/NumCpp/Functions/nanpercentile.hpp +++ b/include/NumCpp/Functions/nanpercentile.hpp @@ -52,12 +52,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanpercentile.html /// - /// @param inArray - /// @param inPercentile - /// @param inAxis (Optional, default NONE) - /// @param inInterpMethod (default linear) choices = ['linear','lower','higher','nearest','midpoint'] - /// @return - /// NdArray + /// @param inArray + /// @param inPercentile + /// @param inAxis (Optional, default NONE) + /// @param inInterpMethod (default linear) choices = ['linear','lower','higher','nearest','midpoint'] + /// @return NdArray /// template NdArray nanpercentile(const NdArray& inArray, double inPercentile, diff --git a/include/NumCpp/Functions/nanprod.hpp b/include/NumCpp/Functions/nanprod.hpp index 290840fb0..6476704b5 100644 --- a/include/NumCpp/Functions/nanprod.hpp +++ b/include/NumCpp/Functions/nanprod.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanprod.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanprod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nans.hpp b/include/NumCpp/Functions/nans.hpp index ad98e0f13..b0c3308ca 100644 --- a/include/NumCpp/Functions/nans.hpp +++ b/include/NumCpp/Functions/nans.hpp @@ -39,10 +39,8 @@ namespace nc /// Return a new array of given shape and type, filled with nans. /// Only really works for dtype = float/double /// - /// @param - /// inSquareSize - /// @return - /// NdArray + /// @param inSquareSize + /// @return NdArray /// inline NdArray nans(uint32 inSquareSize) { @@ -54,10 +52,9 @@ namespace nc /// Return a new array of given shape and type, filled with nans. /// Only really works for dtype = float/double /// - /// @param inNumRows - /// @param inNumCols - /// @return - /// NdArray + /// @param inNumRows + /// @param inNumCols + /// @return NdArray /// inline NdArray nans(uint32 inNumRows, uint32 inNumCols) { @@ -69,10 +66,8 @@ namespace nc /// Return a new array of given shape and type, filled with nans. /// Only really works for dtype = float/double /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// inline NdArray nans(const Shape& inShape) { diff --git a/include/NumCpp/Functions/nans_like.hpp b/include/NumCpp/Functions/nans_like.hpp index 553701098..77dd333fd 100644 --- a/include/NumCpp/Functions/nans_like.hpp +++ b/include/NumCpp/Functions/nans_like.hpp @@ -35,10 +35,8 @@ namespace nc // Method Description: /// Return a new array of given shape and type, filled with nans. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray nans_like(const NdArray& inArray) diff --git a/include/NumCpp/Functions/nanstdev.hpp b/include/NumCpp/Functions/nanstdev.hpp index effccb571..3da8afb8b 100644 --- a/include/NumCpp/Functions/nanstdev.hpp +++ b/include/NumCpp/Functions/nanstdev.hpp @@ -45,11 +45,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanstd.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanstdev(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nansum.hpp b/include/NumCpp/Functions/nansum.hpp index fed538921..29bc93c19 100644 --- a/include/NumCpp/Functions/nansum.hpp +++ b/include/NumCpp/Functions/nansum.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nansum.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nansum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nanvar.hpp b/include/NumCpp/Functions/nanvar.hpp index 2d5a155d1..5881b7f85 100644 --- a/include/NumCpp/Functions/nanvar.hpp +++ b/include/NumCpp/Functions/nanvar.hpp @@ -41,11 +41,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nanvar.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray nanvar(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nbytes.hpp b/include/NumCpp/Functions/nbytes.hpp index 6b4955b18..bbd099811 100644 --- a/include/NumCpp/Functions/nbytes.hpp +++ b/include/NumCpp/Functions/nbytes.hpp @@ -35,10 +35,8 @@ namespace nc // Method Description: /// Returns the number of bytes held by the array /// - /// @param - /// inArray - /// @return - /// number of bytes + /// @param inArray + /// @return number of bytes /// template uint64 nbytes(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/negative.hpp b/include/NumCpp/Functions/negative.hpp index b400b313f..5c011066d 100644 --- a/include/NumCpp/Functions/negative.hpp +++ b/include/NumCpp/Functions/negative.hpp @@ -37,11 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.negative.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray negative(const NdArray& inArray) diff --git a/include/NumCpp/Functions/newbyteorder.hpp b/include/NumCpp/Functions/newbyteorder.hpp index a279ca6bb..a5ace762e 100644 --- a/include/NumCpp/Functions/newbyteorder.hpp +++ b/include/NumCpp/Functions/newbyteorder.hpp @@ -40,11 +40,10 @@ namespace nc /// be confused as to why... /// /// - /// @param inValue - /// @param inEndianess + /// @param inValue + /// @param inEndianess /// - /// @return - /// inValue + /// @return inValue /// template dtype newbyteorder(dtype inValue, Endian inEndianess) @@ -61,11 +60,10 @@ namespace nc /// be confused as to why... /// /// - /// @param inArray - /// @param inEndianess + /// @param inArray + /// @param inEndianess /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray newbyteorder(const NdArray& inArray, Endian inEndianess) diff --git a/include/NumCpp/Functions/none.hpp b/include/NumCpp/Functions/none.hpp index 8e60414d8..b1186c94e 100644 --- a/include/NumCpp/Functions/none.hpp +++ b/include/NumCpp/Functions/none.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.all.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// bool + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return bool /// template NdArray none(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/nonzero.hpp b/include/NumCpp/Functions/nonzero.hpp index 5522eb03d..6f3d676ab 100644 --- a/include/NumCpp/Functions/nonzero.hpp +++ b/include/NumCpp/Functions/nonzero.hpp @@ -40,11 +40,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.nonzero.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template std::pair, NdArray > nonzero(const NdArray& inArray) diff --git a/include/NumCpp/Functions/norm.hpp b/include/NumCpp/Functions/norm.hpp index 1d85ae1a4..19653fa2e 100644 --- a/include/NumCpp/Functions/norm.hpp +++ b/include/NumCpp/Functions/norm.hpp @@ -42,11 +42,10 @@ namespace nc // Method Description: /// Matrix or vector norm. /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray norm(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -105,11 +104,10 @@ namespace nc // Method Description: /// Matrix or vector norm. /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> norm(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/not_equal.hpp b/include/NumCpp/Functions/not_equal.hpp index e31f222f9..9a9cfd16d 100644 --- a/include/NumCpp/Functions/not_equal.hpp +++ b/include/NumCpp/Functions/not_equal.hpp @@ -37,11 +37,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.not_equal.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray not_equal(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/ones.hpp b/include/NumCpp/Functions/ones.hpp index c305df82d..ebb8d6cca 100644 --- a/include/NumCpp/Functions/ones.hpp +++ b/include/NumCpp/Functions/ones.hpp @@ -41,9 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html /// - /// @param inSquareSize - /// @return - /// NdArray + /// @param inSquareSize + /// @return NdArray /// template NdArray ones(uint32 inSquareSize) @@ -59,10 +58,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html /// - /// @param inNumRows - /// @param inNumCols - /// @return - /// NdArray + /// @param inNumRows + /// @param inNumCols + /// @return NdArray /// template NdArray ones(uint32 inNumRows, uint32 inNumCols) @@ -78,10 +76,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones.html /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// template NdArray ones(const Shape& inShape) diff --git a/include/NumCpp/Functions/ones_like.hpp b/include/NumCpp/Functions/ones_like.hpp index 38477eb68..812801d77 100644 --- a/include/NumCpp/Functions/ones_like.hpp +++ b/include/NumCpp/Functions/ones_like.hpp @@ -38,10 +38,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ones_like.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray ones_like(const NdArray& inArray) diff --git a/include/NumCpp/Functions/outer.hpp b/include/NumCpp/Functions/outer.hpp index 0b76b8ae9..8ccce85bb 100644 --- a/include/NumCpp/Functions/outer.hpp +++ b/include/NumCpp/Functions/outer.hpp @@ -41,10 +41,10 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.outer.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return NdArray + /// @return NdArray /// template NdArray outer(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/pad.hpp b/include/NumCpp/Functions/pad.hpp index 2cb387154..c03c5d5b2 100644 --- a/include/NumCpp/Functions/pad.hpp +++ b/include/NumCpp/Functions/pad.hpp @@ -40,11 +40,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.pad.html /// - /// @param inArray - /// @param inPadWidth - /// @param inPadValue - /// @return - /// NdArray + /// @param inArray + /// @param inPadWidth + /// @param inPadValue + /// @return NdArray /// template NdArray pad(const NdArray& inArray, uint16 inPadWidth, dtype inPadValue) diff --git a/include/NumCpp/Functions/partition.hpp b/include/NumCpp/Functions/partition.hpp index 3ece35b32..929f97740 100644 --- a/include/NumCpp/Functions/partition.hpp +++ b/include/NumCpp/Functions/partition.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.partition.html /// - /// @param inArray - /// @param inKth: kth element - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inKth: kth element + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray partition(const NdArray& inArray, uint32 inKth, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/percentile.hpp b/include/NumCpp/Functions/percentile.hpp index d1dcc484b..73778231e 100644 --- a/include/NumCpp/Functions/percentile.hpp +++ b/include/NumCpp/Functions/percentile.hpp @@ -50,17 +50,16 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.percentile.html /// - /// @param inArray - /// @param inPercentile: percentile must be in the range [0, 100] - /// @param inAxis (Optional, default NONE) - /// @param inInterpMethod (Optional) interpolation method + /// @param inArray + /// @param inPercentile: percentile must be in the range [0, 100] + /// @param inAxis (Optional, default NONE) + /// @param inInterpMethod (Optional) interpolation method /// linear: i + (j - i) * fraction, where fraction is the fractional part of the index surrounded by i and j. /// lower : i. /// higher : j. /// nearest : i or j, whichever is nearest. /// midpoint : (i + j) / 2. - /// @return - /// NdArray + /// @return NdArray /// template NdArray percentile(const NdArray& inArray, double inPercentile, diff --git a/include/NumCpp/Functions/polar.hpp b/include/NumCpp/Functions/polar.hpp index 0219c023d..dd2269d39 100644 --- a/include/NumCpp/Functions/polar.hpp +++ b/include/NumCpp/Functions/polar.hpp @@ -40,11 +40,10 @@ namespace nc // Method Description: /// Returns a complex number with magnitude r and phase angle theta. /// - /// @param magnitude - /// @param phaseAngle + /// @param magnitude + /// @param phaseAngle /// - /// @return - /// std::complex + /// @return std::complex /// template auto polar(dtype magnitude, dtype phaseAngle) @@ -58,10 +57,9 @@ namespace nc // Method Description: /// Returns a complex number with magnitude r and phase angle theta. /// - /// @param magnitude - /// @param phaseAngle - /// @return - /// NdArray + /// @param magnitude + /// @param phaseAngle + /// @return NdArray /// template auto polar(const NdArray& magnitude, const NdArray& phaseAngle) diff --git a/include/NumCpp/Functions/power.hpp b/include/NumCpp/Functions/power.hpp index 04640f58f..d5141dd46 100644 --- a/include/NumCpp/Functions/power.hpp +++ b/include/NumCpp/Functions/power.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// - /// @param inValue - /// @param inExponent - /// @return - /// value raised to the power + /// @param inValue + /// @param inExponent + /// @return value raised to the power /// template constexpr dtype power(dtype inValue, uint8 inExponent) noexcept @@ -61,10 +60,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// - /// @param inArray - /// @param inExponent - /// @return - /// NdArray + /// @param inArray + /// @param inExponent + /// @return NdArray /// template NdArray power(const NdArray& inArray, uint8 inExponent) @@ -85,10 +83,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// - /// @param inArray - /// @param inExponents - /// @return - /// NdArray + /// @param inArray + /// @param inExponents + /// @return NdArray /// template NdArray power(const NdArray& inArray, const NdArray& inExponents) diff --git a/include/NumCpp/Functions/powerf.hpp b/include/NumCpp/Functions/powerf.hpp index 179731657..ff3ecf080 100644 --- a/include/NumCpp/Functions/powerf.hpp +++ b/include/NumCpp/Functions/powerf.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// - /// @param inValue - /// @param inExponent - /// @return - /// value raised to the power + /// @param inValue + /// @param inExponent + /// @return value raised to the power /// template auto powerf(dtype1 inValue, dtype2 inExponent) noexcept @@ -61,10 +60,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// - /// @param inArray - /// @param inExponent - /// @return - /// NdArray + /// @param inArray + /// @param inExponent + /// @return NdArray /// template auto powerf(const NdArray& inArray, dtype2 inExponent) @@ -85,10 +83,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.power.html /// - /// @param inArray - /// @param inExponents - /// @return - /// NdArray + /// @param inArray + /// @param inExponents + /// @return NdArray /// template auto powerf(const NdArray& inArray, const NdArray& inExponents) diff --git a/include/NumCpp/Functions/print.hpp b/include/NumCpp/Functions/print.hpp index b68bf46bc..e95f0e53f 100644 --- a/include/NumCpp/Functions/print.hpp +++ b/include/NumCpp/Functions/print.hpp @@ -38,10 +38,8 @@ namespace nc // Method Description: /// Prints the array to the console. /// - /// @param - /// inArray - /// @return - /// None + /// @param inArray + /// @return None /// template void print(const NdArray& inArray) diff --git a/include/NumCpp/Functions/prod.hpp b/include/NumCpp/Functions/prod.hpp index 2a4d1a5c7..8ad126fa4 100644 --- a/include/NumCpp/Functions/prod.hpp +++ b/include/NumCpp/Functions/prod.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.prod.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray prod(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/proj.hpp b/include/NumCpp/Functions/proj.hpp index a4fc9847c..6803a1d04 100644 --- a/include/NumCpp/Functions/proj.hpp +++ b/include/NumCpp/Functions/proj.hpp @@ -39,10 +39,8 @@ namespace nc // Method Description: /// Returns the projection of the complex number z onto the Riemann sphere. /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto proj(const std::complex& inValue) @@ -56,10 +54,8 @@ namespace nc // Method Description: /// Returns the projection of the complex number z onto the Riemann sphere. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto proj(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/ptp.hpp b/include/NumCpp/Functions/ptp.hpp index 417306593..a913b4a11 100644 --- a/include/NumCpp/Functions/ptp.hpp +++ b/include/NumCpp/Functions/ptp.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ptp.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray ptp(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/put.hpp b/include/NumCpp/Functions/put.hpp index 70b0ac4b7..be311a5d4 100644 --- a/include/NumCpp/Functions/put.hpp +++ b/include/NumCpp/Functions/put.hpp @@ -39,11 +39,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.put.html /// - /// @param inArray - /// @param inIndices - /// @param inValue - /// @return - /// NdArray + /// @param inArray + /// @param inIndices + /// @param inValue + /// @return NdArray /// template NdArray& put(NdArray& inArray, const NdArray& inIndices, dtype inValue) @@ -59,11 +58,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.put.html /// - /// @param inArray - /// @param inIndices - /// @param inValues - /// @return - /// NdArray + /// @param inArray + /// @param inIndices + /// @param inValues + /// @return NdArray /// template NdArray& put(NdArray& inArray, const NdArray& inIndices, const NdArray& inValues) diff --git a/include/NumCpp/Functions/putmask.hpp b/include/NumCpp/Functions/putmask.hpp index b2cf5dd24..c8c8d8057 100644 --- a/include/NumCpp/Functions/putmask.hpp +++ b/include/NumCpp/Functions/putmask.hpp @@ -41,11 +41,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.putmask.html /// - /// @param inArray - /// @param inMask - /// @param inValue - /// @return - /// NdArray + /// @param inArray + /// @param inMask + /// @param inValue + /// @return NdArray /// template NdArray& putmask(NdArray& inArray, const NdArray& inMask, dtype inValue) @@ -64,11 +63,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.putmask.html /// - /// @param inArray - /// @param inMask - /// @param inValues - /// @return - /// NdArray + /// @param inArray + /// @param inMask + /// @param inValues + /// @return NdArray /// template NdArray& putmask(NdArray& inArray, const NdArray& inMask, const NdArray& inValues) diff --git a/include/NumCpp/Functions/rad2deg.hpp b/include/NumCpp/Functions/rad2deg.hpp index 7a2aed4c3..6c4a270fb 100644 --- a/include/NumCpp/Functions/rad2deg.hpp +++ b/include/NumCpp/Functions/rad2deg.hpp @@ -40,11 +40,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rad2deg.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template constexpr auto rad2deg(dtype inValue) noexcept @@ -60,11 +58,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rad2deg.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template auto rad2deg(const NdArray& inArray) diff --git a/include/NumCpp/Functions/radians.hpp b/include/NumCpp/Functions/radians.hpp index 30f34cbe5..a4c21e78c 100644 --- a/include/NumCpp/Functions/radians.hpp +++ b/include/NumCpp/Functions/radians.hpp @@ -38,10 +38,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.radians.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template constexpr auto radians(dtype inValue) noexcept @@ -55,10 +53,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.radians.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto radians(const NdArray& inArray) diff --git a/include/NumCpp/Functions/ravel.hpp b/include/NumCpp/Functions/ravel.hpp index 7a33bc911..11a36e1a0 100644 --- a/include/NumCpp/Functions/ravel.hpp +++ b/include/NumCpp/Functions/ravel.hpp @@ -37,7 +37,7 @@ namespace nc /// /// Numpy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.ravel.html /// - /// @param inArray + /// @param inArray /// /// @return NdArray /// diff --git a/include/NumCpp/Functions/real.hpp b/include/NumCpp/Functions/real.hpp index 9186017da..798595812 100644 --- a/include/NumCpp/Functions/real.hpp +++ b/include/NumCpp/Functions/real.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.real.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto real(const std::complex& inValue) @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://numpy.org/devdocs/reference/generated/numpy.real.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto real(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/reciprocal.hpp b/include/NumCpp/Functions/reciprocal.hpp index 35212d367..2d5e5ce11 100644 --- a/include/NumCpp/Functions/reciprocal.hpp +++ b/include/NumCpp/Functions/reciprocal.hpp @@ -45,11 +45,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.reciprocal.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray reciprocal(const NdArray& inArray) @@ -76,11 +74,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.reciprocal.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> reciprocal(const NdArray>& inArray) diff --git a/include/NumCpp/Functions/remainder.hpp b/include/NumCpp/Functions/remainder.hpp index d92bf562a..1ee73ba8c 100644 --- a/include/NumCpp/Functions/remainder.hpp +++ b/include/NumCpp/Functions/remainder.hpp @@ -44,11 +44,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.remainder.html /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return - /// NdArray + /// @return NdArray /// template double remainder(dtype inValue1, dtype inValue2) noexcept @@ -64,11 +63,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.remainder.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray remainder(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/repeat.hpp b/include/NumCpp/Functions/repeat.hpp index 2b2fb8c52..465a53d4a 100644 --- a/include/NumCpp/Functions/repeat.hpp +++ b/include/NumCpp/Functions/repeat.hpp @@ -39,12 +39,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.repeat.html /// - /// @param inArray - /// @param inNumRows - /// @param inNumCols + /// @param inArray + /// @param inNumRows + /// @param inNumCols /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray repeat(const NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -58,11 +57,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.repeat.html /// - /// @param inArray - /// @param inRepeatShape + /// @param inArray + /// @param inRepeatShape /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray repeat(const NdArray& inArray, const Shape& inRepeatShape) diff --git a/include/NumCpp/Functions/replace.hpp b/include/NumCpp/Functions/replace.hpp index f543ae9cd..88990d686 100644 --- a/include/NumCpp/Functions/replace.hpp +++ b/include/NumCpp/Functions/replace.hpp @@ -35,9 +35,9 @@ namespace nc // Method Description: /// Replaces the matching elements of an array with the new value /// - /// @param inArray - /// @param oldValue: the value to replace - /// @param newValue: the value to replace with + /// @param inArray + /// @param oldValue: the value to replace + /// @param newValue: the value to replace with /// /// @return NdArray /// diff --git a/include/NumCpp/Functions/reshape.hpp b/include/NumCpp/Functions/reshape.hpp index d5115ad9e..7eeab7478 100644 --- a/include/NumCpp/Functions/reshape.hpp +++ b/include/NumCpp/Functions/reshape.hpp @@ -42,11 +42,10 @@ namespace nc /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. /// - /// @param inArray - /// @param inSize + /// @param inArray + /// @param inSize /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& reshape(NdArray& inArray, uint32 inSize) @@ -64,12 +63,11 @@ namespace nc /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. /// - /// @param inArray - /// @param inNumRows - /// @param inNumCols + /// @param inArray + /// @param inNumRows + /// @param inNumCols /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& reshape(NdArray& inArray, int32 inNumRows, int32 inNumCols) @@ -87,11 +85,10 @@ namespace nc /// can be -1. In this case, the value is inferred from the length of the /// array and remaining dimensions. /// - /// @param inArray - /// @param inNewShape + /// @param inArray + /// @param inNewShape /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& reshape(NdArray& inArray, const Shape& inNewShape) diff --git a/include/NumCpp/Functions/resizeFast.hpp b/include/NumCpp/Functions/resizeFast.hpp index 4397bb4ed..c4dd17c0e 100644 --- a/include/NumCpp/Functions/resizeFast.hpp +++ b/include/NumCpp/Functions/resizeFast.hpp @@ -40,12 +40,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// - /// @param inArray - /// @param inNumRows - /// @param inNumCols + /// @param inArray + /// @param inNumRows + /// @param inNumCols /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& resizeFast(NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -61,11 +60,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// - /// @param inArray - /// @param inNewShape + /// @param inArray + /// @param inNewShape /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& resizeFast(NdArray& inArray, const Shape& inNewShape) diff --git a/include/NumCpp/Functions/resizeSlow.hpp b/include/NumCpp/Functions/resizeSlow.hpp index a9e2e5c9d..a66fa92da 100644 --- a/include/NumCpp/Functions/resizeSlow.hpp +++ b/include/NumCpp/Functions/resizeSlow.hpp @@ -42,12 +42,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// - /// @param inArray - /// @param inNumRows - /// @param inNumCols + /// @param inArray + /// @param inNumRows + /// @param inNumCols /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& resizeSlow(NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -65,11 +64,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.resize.html /// - /// @param inArray - /// @param inNewShape + /// @param inArray + /// @param inNewShape /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& resizeSlow(NdArray& inArray, const Shape& inNewShape) diff --git a/include/NumCpp/Functions/right_shift.hpp b/include/NumCpp/Functions/right_shift.hpp index 1b243366d..75b39168b 100644 --- a/include/NumCpp/Functions/right_shift.hpp +++ b/include/NumCpp/Functions/right_shift.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.right_shift.html /// - /// @param inArray - /// @param inNumBits + /// @param inArray + /// @param inNumBits /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray right_shift(const NdArray& inArray, uint8 inNumBits) diff --git a/include/NumCpp/Functions/rint.hpp b/include/NumCpp/Functions/rint.hpp index c9f45e36a..e8a6a18f0 100644 --- a/include/NumCpp/Functions/rint.hpp +++ b/include/NumCpp/Functions/rint.hpp @@ -41,11 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rint.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template dtype rint(dtype inValue) noexcept @@ -61,11 +59,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rint.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray rint(const NdArray& inArray) diff --git a/include/NumCpp/Functions/rms.hpp b/include/NumCpp/Functions/rms.hpp index 94f53efe6..8002f887a 100644 --- a/include/NumCpp/Functions/rms.hpp +++ b/include/NumCpp/Functions/rms.hpp @@ -42,11 +42,10 @@ namespace nc // Method Description: /// Compute the root mean square (RMS) along the specified axis. /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray rms(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -104,11 +103,10 @@ namespace nc // Method Description: /// Compute the root mean square (RMS) along the specified axis. /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> rms(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/roll.hpp b/include/NumCpp/Functions/roll.hpp index ef3ab6e3a..4e7581859 100644 --- a/include/NumCpp/Functions/roll.hpp +++ b/include/NumCpp/Functions/roll.hpp @@ -42,12 +42,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.roll.html /// - /// @param inArray - /// @param inShift: (elements to shift, positive means forward, negative means backwards) - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inShift: (elements to shift, positive means forward, negative means backwards) + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray roll(const NdArray& inArray, int32 inShift, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/rot90.hpp b/include/NumCpp/Functions/rot90.hpp index 307b19c65..2639a6f50 100644 --- a/include/NumCpp/Functions/rot90.hpp +++ b/include/NumCpp/Functions/rot90.hpp @@ -41,11 +41,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.rot90.html /// - /// @param inArray - /// @param inK: the number of times to rotate 90 degrees + /// @param inArray + /// @param inK: the number of times to rotate 90 degrees /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray rot90(const NdArray& inArray, uint8 inK = 1) diff --git a/include/NumCpp/Functions/round.hpp b/include/NumCpp/Functions/round.hpp index 49ef1b8de..d3194724d 100644 --- a/include/NumCpp/Functions/round.hpp +++ b/include/NumCpp/Functions/round.hpp @@ -36,11 +36,10 @@ namespace nc // Method Description: /// Round value to the given number of decimals. /// - /// @param inValue - /// @param inDecimals + /// @param inValue + /// @param inDecimals /// - /// @return - /// value + /// @return value /// template dtype round(dtype inValue, uint8 inDecimals = 0) @@ -53,11 +52,10 @@ namespace nc // Method Description: /// Round an array to the given number of decimals. /// - /// @param inArray - /// @param inDecimals + /// @param inArray + /// @param inDecimals /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray round(const NdArray& inArray, uint8 inDecimals = 0) diff --git a/include/NumCpp/Functions/row_stack.hpp b/include/NumCpp/Functions/row_stack.hpp index 91e4997d7..66d709899 100644 --- a/include/NumCpp/Functions/row_stack.hpp +++ b/include/NumCpp/Functions/row_stack.hpp @@ -41,11 +41,9 @@ namespace nc // Method Description: /// Stack arrays in sequence vertically (row wise). /// - /// @param - /// inArrayList: {list} of arrays to stack + /// @param inArrayList: {list} of arrays to stack /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray row_stack(const std::initializer_list >& inArrayList) diff --git a/include/NumCpp/Functions/setdiff1d.hpp b/include/NumCpp/Functions/setdiff1d.hpp index f13e918bd..880728e04 100644 --- a/include/NumCpp/Functions/setdiff1d.hpp +++ b/include/NumCpp/Functions/setdiff1d.hpp @@ -46,10 +46,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.setdiff1d.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray setdiff1d(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/shape.hpp b/include/NumCpp/Functions/shape.hpp index 6f69275c1..f7a325611 100644 --- a/include/NumCpp/Functions/shape.hpp +++ b/include/NumCpp/Functions/shape.hpp @@ -35,10 +35,8 @@ namespace nc // Method Description: /// Return the shape of the array /// - /// @param - /// inArray - /// @return - /// Shape + /// @param inArray + /// @return Shape /// template Shape shape(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/sign.hpp b/include/NumCpp/Functions/sign.hpp index 142522a1c..b3e88ef5a 100644 --- a/include/NumCpp/Functions/sign.hpp +++ b/include/NumCpp/Functions/sign.hpp @@ -45,10 +45,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sign.html /// - /// @param - /// inValue - /// @return - /// NdArray + /// @param inValue + /// @return NdArray /// template int8 sign(dtype inValue) noexcept @@ -77,10 +75,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sign.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray sign(const NdArray& inArray) diff --git a/include/NumCpp/Functions/signbit.hpp b/include/NumCpp/Functions/signbit.hpp index b0085b425..e0077f54c 100644 --- a/include/NumCpp/Functions/signbit.hpp +++ b/include/NumCpp/Functions/signbit.hpp @@ -39,10 +39,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.signbit.html /// - /// @param - /// inValue - /// @return - /// NdArray + /// @param inValue + /// @return NdArray /// template bool signbit(dtype inValue) noexcept @@ -58,10 +56,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.signbit.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray signbit(const NdArray& inArray) diff --git a/include/NumCpp/Functions/sin.hpp b/include/NumCpp/Functions/sin.hpp index 63fe3203c..92a889f73 100644 --- a/include/NumCpp/Functions/sin.hpp +++ b/include/NumCpp/Functions/sin.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sin.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto sin(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sin.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto sin(const NdArray& inArray) diff --git a/include/NumCpp/Functions/sinc.hpp b/include/NumCpp/Functions/sinc.hpp index b3049ddd3..37aa258b7 100644 --- a/include/NumCpp/Functions/sinc.hpp +++ b/include/NumCpp/Functions/sinc.hpp @@ -43,10 +43,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinc.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto sinc(dtype inValue) noexcept @@ -64,10 +62,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinc.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto sinc(const NdArray& inArray) diff --git a/include/NumCpp/Functions/sinh.hpp b/include/NumCpp/Functions/sinh.hpp index 6041df55e..b6176dd9c 100644 --- a/include/NumCpp/Functions/sinh.hpp +++ b/include/NumCpp/Functions/sinh.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinh.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto sinh(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sinh.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto sinh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/size.hpp b/include/NumCpp/Functions/size.hpp index 5a54b6114..90e7ff665 100644 --- a/include/NumCpp/Functions/size.hpp +++ b/include/NumCpp/Functions/size.hpp @@ -36,10 +36,8 @@ namespace nc // Method Description: /// Return the number of elements. /// - /// @param - /// inArray - /// @return - /// uint32 size + /// @param inArray + /// @return uint32 size /// template uint32 size(const NdArray& inArray) noexcept diff --git a/include/NumCpp/Functions/sort.hpp b/include/NumCpp/Functions/sort.hpp index 3464938a4..0b337d6c5 100644 --- a/include/NumCpp/Functions/sort.hpp +++ b/include/NumCpp/Functions/sort.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sort.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray sort(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/sqrt.hpp b/include/NumCpp/Functions/sqrt.hpp index 1b778fe2b..90eb77e80 100644 --- a/include/NumCpp/Functions/sqrt.hpp +++ b/include/NumCpp/Functions/sqrt.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sqrt.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto sqrt(dtype inValue) noexcept @@ -60,10 +58,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sqrt.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto sqrt(const NdArray& inArray) diff --git a/include/NumCpp/Functions/square.hpp b/include/NumCpp/Functions/square.hpp index 7c52294a2..15d0a3a3b 100644 --- a/include/NumCpp/Functions/square.hpp +++ b/include/NumCpp/Functions/square.hpp @@ -40,10 +40,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.square.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template constexpr dtype square(dtype inValue) noexcept @@ -59,10 +57,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.square.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray square(const NdArray& inArray) diff --git a/include/NumCpp/Functions/stack.hpp b/include/NumCpp/Functions/stack.hpp index 5ef75f7d0..ab69c38eb 100644 --- a/include/NumCpp/Functions/stack.hpp +++ b/include/NumCpp/Functions/stack.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.stack.html /// - /// @param inArrayList: {list} of arrays to stack - /// @param inAxis: axis to stack the input NdArrays - /// @return - /// NdArray + /// @param inArrayList: {list} of arrays to stack + /// @param inAxis: axis to stack the input NdArrays + /// @return NdArray /// template NdArray stack(std::initializer_list > inArrayList, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/stdev.hpp b/include/NumCpp/Functions/stdev.hpp index 1d39f6508..31c095b2e 100644 --- a/include/NumCpp/Functions/stdev.hpp +++ b/include/NumCpp/Functions/stdev.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.std.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray stdev(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -117,10 +116,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.std.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray> stdev(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/subtract.hpp b/include/NumCpp/Functions/subtract.hpp index 9a430d468..71bc47e96 100644 --- a/include/NumCpp/Functions/subtract.hpp +++ b/include/NumCpp/Functions/subtract.hpp @@ -39,10 +39,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray subtract(const NdArray& inArray1, const NdArray& inArray2) @@ -56,10 +55,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray subtract(const NdArray& inArray, dtype value) @@ -73,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray subtract(dtype value, const NdArray& inArray) @@ -90,10 +87,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> subtract(const NdArray& inArray1, const NdArray>& inArray2) @@ -107,10 +103,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param inArray1 - /// @param inArray2 - /// @return - /// NdArray + /// @param inArray1 + /// @param inArray2 + /// @return NdArray /// template NdArray> subtract(const NdArray>& inArray1, const NdArray& inArray2) @@ -124,10 +119,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> subtract(const NdArray& inArray, const std::complex& value) @@ -141,10 +135,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> subtract(const std::complex& value, const NdArray& inArray) @@ -158,10 +151,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param inArray - /// @param value - /// @return - /// NdArray + /// @param inArray + /// @param value + /// @return NdArray /// template NdArray> subtract(const NdArray>& inArray, dtype value) @@ -175,10 +167,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.subtract.html /// - /// @param value - /// @param inArray - /// @return - /// NdArray + /// @param value + /// @param inArray + /// @return NdArray /// template NdArray> subtract(dtype value, const NdArray>& inArray) diff --git a/include/NumCpp/Functions/sum.hpp b/include/NumCpp/Functions/sum.hpp index c3e4951de..8bf4e0f03 100644 --- a/include/NumCpp/Functions/sum.hpp +++ b/include/NumCpp/Functions/sum.hpp @@ -38,10 +38,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.sum.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray sum(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/swap.hpp b/include/NumCpp/Functions/swap.hpp index 62ea7afdc..7dadda441 100644 --- a/include/NumCpp/Functions/swap.hpp +++ b/include/NumCpp/Functions/swap.hpp @@ -35,8 +35,8 @@ namespace nc // Method Description: /// Swaps the contents of two arrays /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// template void swap(NdArray& inArray1, NdArray& inArray2) noexcept diff --git a/include/NumCpp/Functions/swapaxes.hpp b/include/NumCpp/Functions/swapaxes.hpp index d35df29a7..0f762e2bf 100644 --- a/include/NumCpp/Functions/swapaxes.hpp +++ b/include/NumCpp/Functions/swapaxes.hpp @@ -37,10 +37,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.swapaxes.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray swapaxes(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tan.hpp b/include/NumCpp/Functions/tan.hpp index ba6c6d157..132fe54d4 100644 --- a/include/NumCpp/Functions/tan.hpp +++ b/include/NumCpp/Functions/tan.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tan.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto tan(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tan.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto tan(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tanh.hpp b/include/NumCpp/Functions/tanh.hpp index 04c371980..3a35a1934 100644 --- a/include/NumCpp/Functions/tanh.hpp +++ b/include/NumCpp/Functions/tanh.hpp @@ -42,10 +42,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tanh.html /// - /// @param - /// inValue - /// @return - /// value + /// @param inValue + /// @return value /// template auto tanh(dtype inValue) noexcept @@ -61,10 +59,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tanh.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto tanh(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tile.hpp b/include/NumCpp/Functions/tile.hpp index 8348aefee..83666f0ba 100644 --- a/include/NumCpp/Functions/tile.hpp +++ b/include/NumCpp/Functions/tile.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tile.html /// - /// @param inArray - /// @param inNumRows - /// @param inNumCols - /// @return - /// NdArray + /// @param inArray + /// @param inNumRows + /// @param inNumCols + /// @return NdArray /// template NdArray tile(const NdArray& inArray, uint32 inNumRows, uint32 inNumCols) @@ -56,10 +55,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tile.html /// - /// @param inArray - /// @param inReps - /// @return - /// NdArray + /// @param inArray + /// @param inReps + /// @return NdArray /// template NdArray tile(const NdArray& inArray, const Shape& inReps) diff --git a/include/NumCpp/Functions/toStlVector.hpp b/include/NumCpp/Functions/toStlVector.hpp index 25476fa45..6497113b6 100644 --- a/include/NumCpp/Functions/toStlVector.hpp +++ b/include/NumCpp/Functions/toStlVector.hpp @@ -35,10 +35,8 @@ namespace nc // Method Description: /// Write flattened array to an STL vector /// - /// @param - /// inArray - /// @return - /// std::vector + /// @param inArray + /// @return std::vector /// template std::vector toStlVector(const NdArray& inArray) diff --git a/include/NumCpp/Functions/tofile.hpp b/include/NumCpp/Functions/tofile.hpp index 0a1f957da..ee94d4efb 100644 --- a/include/NumCpp/Functions/tofile.hpp +++ b/include/NumCpp/Functions/tofile.hpp @@ -39,10 +39,9 @@ namespace nc /// The data produced by this method can be recovered /// using the function fromfile(). /// - /// @param inArray - /// @param inFilename - /// @return - /// None + /// @param inArray + /// @param inFilename + /// @return None /// template void tofile(const NdArray& inArray, const std::string& inFilename) @@ -56,11 +55,10 @@ namespace nc /// The data produced by this method can be recovered /// using the function fromfile(). /// - /// @param inArray - /// @param inFilename - /// @param inSep: Separator between array items for text output. - /// @return - /// None + /// @param inArray + /// @param inFilename + /// @param inSep: Separator between array items for text output. + /// @return None /// template void tofile(const NdArray& inArray, const std::string& inFilename, const char inSep) diff --git a/include/NumCpp/Functions/trace.hpp b/include/NumCpp/Functions/trace.hpp index c86bb1c5b..7393274ca 100644 --- a/include/NumCpp/Functions/trace.hpp +++ b/include/NumCpp/Functions/trace.hpp @@ -38,11 +38,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trace.html /// - /// @param inArray - /// @param inOffset: (Offset from main diaganol, default = 0, negative=above, positve=below) - /// @param inAxis (Optional, default ROW) - /// @return - /// NdArray + /// @param inArray + /// @param inOffset: (Offset from main diaganol, default = 0, negative=above, positve=below) + /// @param inAxis (Optional, default ROW) + /// @return NdArray /// template dtype trace(const NdArray& inArray, int16 inOffset = 0, Axis inAxis = Axis::ROW) noexcept diff --git a/include/NumCpp/Functions/transpose.hpp b/include/NumCpp/Functions/transpose.hpp index 64e444f7c..e1510670d 100644 --- a/include/NumCpp/Functions/transpose.hpp +++ b/include/NumCpp/Functions/transpose.hpp @@ -37,11 +37,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.transpose.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray transpose(const NdArray& inArray) diff --git a/include/NumCpp/Functions/trapz.hpp b/include/NumCpp/Functions/trapz.hpp index cd0c322d5..e6201376d 100644 --- a/include/NumCpp/Functions/trapz.hpp +++ b/include/NumCpp/Functions/trapz.hpp @@ -43,12 +43,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trapz.html /// - /// @param inArray - /// @param dx: (Optional defaults to 1.0) - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param dx: (Optional defaults to 1.0) + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray trapz(const NdArray& inArray, double dx = 1.0, Axis inAxis = Axis::NONE) @@ -119,12 +118,11 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trapz.html /// - /// @param inArrayY - /// @param inArrayX - /// @param inAxis (Optional, default NONE) + /// @param inArrayY + /// @param inArrayX + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray trapz(const NdArray& inArrayY, const NdArray& inArrayX, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/tri.hpp b/include/NumCpp/Functions/tri.hpp index 2a12c0ed6..c94146a59 100644 --- a/include/NumCpp/Functions/tri.hpp +++ b/include/NumCpp/Functions/tri.hpp @@ -38,14 +38,13 @@ namespace nc // Method Description: /// An array with ones at and below the given diagonal and zeros elsewhere. /// - /// @param inN: number of rows and cols - /// @param inOffset: (the sub-diagonal at and below which the array is filled. + /// @param inN: number of rows and cols + /// @param inOffset: (the sub-diagonal at and below which the array is filled. /// k = 0 is the main diagonal, while k < 0 is below it, /// and k > 0 is above. The default is 0.) /// /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray tril(uint32 inN, int32 inOffset = 0) @@ -85,15 +84,14 @@ namespace nc // Method Description: /// An array with ones at and below the given diagonal and zeros elsewhere. /// - /// @param inN: number of rows - /// @param inM: number of columns - /// @param inOffset: (the sub-diagonal at and below which the array is filled. + /// @param inN: number of rows + /// @param inM: number of columns + /// @param inOffset: (the sub-diagonal at and below which the array is filled. /// k = 0 is the main diagonal, while k < 0 is below it, /// and k > 0 is above. The default is 0.) /// /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray tril(uint32 inN, uint32 inM, int32 inOffset = 0) @@ -141,14 +139,13 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.tril.html /// - /// @param inArray: number of rows and cols - /// @param inOffset: (the sub-diagonal at and below which the array is filled. + /// @param inArray: number of rows and cols + /// @param inOffset: (the sub-diagonal at and below which the array is filled. /// k = 0 is the main diagonal, while k < 0 is below it, /// and k > 0 is above. The default is 0.) /// /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray tril(const NdArray& inArray, int32 inOffset = 0) @@ -165,15 +162,14 @@ namespace nc // Method Description: /// An array with ones at and above the given diagonal and zeros elsewhere. /// - /// @param inN: number of rows - /// @param inM: number of columns - /// @param inOffset: (the sub-diagonal at and above which the array is filled. + /// @param inN: number of rows + /// @param inM: number of columns + /// @param inOffset: (the sub-diagonal at and above which the array is filled. /// k = 0 is the main diagonal, while k < 0 is below it, /// and k > 0 is above. The default is 0.) /// /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray triu(uint32 inN, uint32 inM, int32 inOffset) @@ -216,14 +212,13 @@ namespace nc // Method Description: /// An array with ones at and above the given diagonal and zeros elsewhere. /// - /// @param inN: number of rows and cols - /// @param inOffset: (the sub-diagonal at and above which the array is filled. + /// @param inN: number of rows and cols + /// @param inOffset: (the sub-diagonal at and above which the array is filled. /// k = 0 is the main diagonal, while k < 0 is below it, /// and k > 0 is above. The default is 0.) /// /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray triu(uint32 inN, int32 inOffset = 0) @@ -241,14 +236,13 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.triu.html /// - /// @param inArray: number of rows and cols - /// @param inOffset: (the sub-diagonal at and below which the array is filled. + /// @param inArray: number of rows and cols + /// @param inOffset: (the sub-diagonal at and below which the array is filled. /// k = 0 is the main diagonal, while k < 0 is below it, /// and k > 0 is above. The default is 0.) /// /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray triu(const NdArray& inArray, int32 inOffset = 0) diff --git a/include/NumCpp/Functions/trim_zeros.hpp b/include/NumCpp/Functions/trim_zeros.hpp index 948a9af40..316965214 100644 --- a/include/NumCpp/Functions/trim_zeros.hpp +++ b/include/NumCpp/Functions/trim_zeros.hpp @@ -43,11 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trim_zeros.html /// - /// @param inArray - /// @param inTrim: ("f" = front, "b" = back, "fb" = front and back) + /// @param inArray + /// @param inTrim: ("f" = front, "b" = back, "fb" = front and back) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray trim_zeros(const NdArray& inArray, const std::string& inTrim = "fb") diff --git a/include/NumCpp/Functions/trunc.hpp b/include/NumCpp/Functions/trunc.hpp index f3e7d9051..f0c9e8400 100644 --- a/include/NumCpp/Functions/trunc.hpp +++ b/include/NumCpp/Functions/trunc.hpp @@ -41,11 +41,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trunc.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template dtype trunc(dtype inValue) noexcept @@ -61,11 +59,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.trunc.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray trunc(const NdArray& inArray) diff --git a/include/NumCpp/Functions/union1d.hpp b/include/NumCpp/Functions/union1d.hpp index 56bac3266..84c435348 100644 --- a/include/NumCpp/Functions/union1d.hpp +++ b/include/NumCpp/Functions/union1d.hpp @@ -42,11 +42,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.union1d.html /// - /// @param inArray1 - /// @param inArray2 + /// @param inArray1 + /// @param inArray2 /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray union1d(const NdArray& inArray1, const NdArray& inArray2) diff --git a/include/NumCpp/Functions/unique.hpp b/include/NumCpp/Functions/unique.hpp index bb7f4c44b..af70fbfb5 100644 --- a/include/NumCpp/Functions/unique.hpp +++ b/include/NumCpp/Functions/unique.hpp @@ -46,11 +46,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unique.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray unique(const NdArray& inArray) diff --git a/include/NumCpp/Functions/unwrap.hpp b/include/NumCpp/Functions/unwrap.hpp index c87b26d30..48409a74a 100644 --- a/include/NumCpp/Functions/unwrap.hpp +++ b/include/NumCpp/Functions/unwrap.hpp @@ -42,11 +42,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unwrap.html /// - /// @param - /// inValue + /// @param inValue /// - /// @return - /// value + /// @return value /// template dtype unwrap(dtype inValue) noexcept @@ -63,11 +61,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.unwrap.html /// - /// @param - /// inArray + /// @param inArray /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray unwrap(const NdArray& inArray) diff --git a/include/NumCpp/Functions/var.hpp b/include/NumCpp/Functions/var.hpp index 3c5ec40dc..2757f177e 100644 --- a/include/NumCpp/Functions/var.hpp +++ b/include/NumCpp/Functions/var.hpp @@ -42,11 +42,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.var.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray var(const NdArray& inArray, Axis inAxis = Axis::NONE) @@ -69,11 +68,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.var.html /// - /// @param inArray - /// @param inAxis (Optional, default NONE) + /// @param inArray + /// @param inAxis (Optional, default NONE) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray> var(const NdArray>& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Functions/vstack.hpp b/include/NumCpp/Functions/vstack.hpp index 523b90c0e..af1bb6181 100644 --- a/include/NumCpp/Functions/vstack.hpp +++ b/include/NumCpp/Functions/vstack.hpp @@ -40,11 +40,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.vstack.html /// - /// @param - /// inArrayList: {list} of arrays to stack + /// @param inArrayList: {list} of arrays to stack /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray vstack(std::initializer_list > inArrayList) diff --git a/include/NumCpp/Functions/where.hpp b/include/NumCpp/Functions/where.hpp index 601a5b081..dcf8186f9 100644 --- a/include/NumCpp/Functions/where.hpp +++ b/include/NumCpp/Functions/where.hpp @@ -43,10 +43,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// - /// @param inMask - /// @param inA - /// @param inB - /// @return NdArray + /// @param inMask + /// @param inA + /// @param inB + /// @return NdArray /// template NdArray where(const NdArray& inMask, const NdArray& inA, const NdArray& inB) @@ -90,10 +90,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// - /// @param inMask - /// @param inA - /// @param inB - /// @return NdArray + /// @param inMask + /// @param inA + /// @param inB + /// @return NdArray /// template NdArray where(const NdArray& inMask, const NdArray& inA, dtype inB) @@ -132,10 +132,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// - /// @param inMask - /// @param inA - /// @param inB - /// @return NdArray + /// @param inMask + /// @param inA + /// @param inB + /// @return NdArray /// template NdArray where(const NdArray& inMask, dtype inA, const NdArray& inB) @@ -174,10 +174,10 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.where.html /// - /// @param inMask - /// @param inA - /// @param inB - /// @return NdArray + /// @param inMask + /// @param inA + /// @param inB + /// @return NdArray /// template NdArray where(const NdArray& inMask, dtype inA, dtype inB) diff --git a/include/NumCpp/Functions/zeros.hpp b/include/NumCpp/Functions/zeros.hpp index aa95f166b..d4e587895 100644 --- a/include/NumCpp/Functions/zeros.hpp +++ b/include/NumCpp/Functions/zeros.hpp @@ -41,10 +41,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html /// - /// @param - /// inSquareSize - /// @return - /// NdArray + /// @param inSquareSize + /// @return NdArray /// template NdArray zeros(uint32 inSquareSize) @@ -60,10 +58,9 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html /// - /// @param inNumRows - /// @param inNumCols - /// @return - /// NdArray + /// @param inNumRows + /// @param inNumCols + /// @return NdArray /// template NdArray zeros(uint32 inNumRows, uint32 inNumCols) @@ -79,10 +76,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros.html /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// template NdArray zeros(const Shape& inShape) diff --git a/include/NumCpp/Functions/zeros_like.hpp b/include/NumCpp/Functions/zeros_like.hpp index 444637b55..3e4010b83 100644 --- a/include/NumCpp/Functions/zeros_like.hpp +++ b/include/NumCpp/Functions/zeros_like.hpp @@ -38,10 +38,8 @@ namespace nc /// /// NumPy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.zeros_like.html /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray zeros_like(const NdArray& inArray) diff --git a/include/NumCpp/ImageProcessing/Centroid.hpp b/include/NumCpp/ImageProcessing/Centroid.hpp index e7684d916..5a5a28ca1 100644 --- a/include/NumCpp/ImageProcessing/Centroid.hpp +++ b/include/NumCpp/ImageProcessing/Centroid.hpp @@ -61,7 +61,7 @@ namespace nc // Description: /// constructor /// - /// @param inCluster + /// @param inCluster /// explicit Centroid(const Cluster& inCluster) : intensity_(inCluster.intensity()), @@ -74,8 +74,7 @@ namespace nc // Description: /// gets the centroid row /// - /// @return - /// centroid row + /// @return centroid row /// double row() const noexcept { @@ -86,8 +85,7 @@ namespace nc // Description: /// gets the centroid col /// - /// @return - /// centroid col + /// @return centroid col /// double col() const noexcept { @@ -98,8 +96,7 @@ namespace nc // Description: /// gets the centroid intensity /// - /// @return - /// centroid intensity + /// @return centroid intensity /// dtype intensity() const noexcept { @@ -110,8 +107,7 @@ namespace nc // Description: /// returns the estimated eod of the centroid /// - /// @return - /// star id + /// @return star id /// double eod() const noexcept { @@ -122,8 +118,7 @@ namespace nc // Description: /// returns the centroid as a string representation /// - /// @return - /// std::string + /// @return std::string /// std::string str() const { @@ -147,11 +142,9 @@ namespace nc // Description: /// equality operator /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// bool operator==(const Centroid& rhs) const noexcept { @@ -162,11 +155,9 @@ namespace nc // Description: /// not equality operator /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// bool operator!=(const Centroid& rhs) const noexcept { @@ -180,11 +171,9 @@ namespace nc /// the centroids in descensing order, I am purposefully defining /// this operator backwards! /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// bool operator<(const Centroid& rhs) const noexcept { @@ -195,10 +184,9 @@ namespace nc // Description: /// ostream operator /// - /// @param inStream - /// @param inCentriod - /// @return - /// std::ostream + /// @param inStream + /// @param inCentriod + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Centroid& inCentriod) { @@ -219,8 +207,7 @@ namespace nc /// WARNING: if both positive and negative values are present in the cluster, /// it can lead to an undefined COM. /// - /// @param - /// inCluster + /// @param inCluster /// void centerOfMass(const Cluster& inCluster) { diff --git a/include/NumCpp/ImageProcessing/Cluster.hpp b/include/NumCpp/ImageProcessing/Cluster.hpp index 6ee03c578..2e36b3166 100644 --- a/include/NumCpp/ImageProcessing/Cluster.hpp +++ b/include/NumCpp/ImageProcessing/Cluster.hpp @@ -69,8 +69,7 @@ namespace nc // Description: /// constructor /// - /// @param - /// inClusterId + /// @param inClusterId /// explicit Cluster(uint32 inClusterId) noexcept : clusterId_(inClusterId) @@ -80,11 +79,9 @@ namespace nc // Description: /// equality operator /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// bool operator==(const Cluster& rhs) const noexcept { @@ -100,11 +97,9 @@ namespace nc // Description: /// not equality operator /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// bool operator!=(const Cluster& rhs) const noexcept { @@ -115,11 +110,9 @@ namespace nc // Description: /// access operator, no bounds checking /// - /// @param - /// inIndex + /// @param inIndex /// - /// @return - /// Pixel + /// @return Pixel /// const Pixel& operator[](uint32 inIndex) const noexcept { @@ -130,11 +123,9 @@ namespace nc // Description: /// access method with bounds checking /// - /// @param - /// inIndex + /// @param inIndex /// - /// @return - /// Pixel + /// @return Pixel /// const Pixel& at(uint32 inIndex) const { @@ -149,8 +140,7 @@ namespace nc // Description: /// returns in iterator to the beginning pixel of the cluster /// - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator begin() const noexcept { @@ -161,8 +151,7 @@ namespace nc // Description: /// returns in iterator to the 1 past the end pixel of the cluster /// - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator end() const noexcept { @@ -173,8 +162,7 @@ namespace nc // Description: /// returns the number of pixels in the cluster /// - /// @return - /// number of pixels in the cluster + /// @return number of pixels in the cluster /// uint32 size() const noexcept { @@ -185,8 +173,7 @@ namespace nc // Description: /// returns the minimum row number of the cluster /// - /// @return - /// minimum row number of the cluster + /// @return minimum row number of the cluster /// uint32 clusterId() const noexcept { @@ -197,8 +184,7 @@ namespace nc // Description: /// returns the minimum row number of the cluster /// - /// @return - /// minimum row number of the cluster + /// @return minimum row number of the cluster /// uint32 rowMin() const noexcept { @@ -209,8 +195,7 @@ namespace nc // Description: /// returns the maximum row number of the cluster /// - /// @return - /// maximum row number of the cluster + /// @return maximum row number of the cluster /// uint32 rowMax() const noexcept { @@ -221,8 +206,7 @@ namespace nc // Description: /// returns the minimum column number of the cluster /// - /// @return - /// minimum column number of the cluster + /// @return minimum column number of the cluster /// uint32 colMin() const noexcept { @@ -233,8 +217,7 @@ namespace nc // Description: /// returns the maximum column number of the cluster /// - /// @return - /// maximum column number of the cluster + /// @return maximum column number of the cluster /// uint32 colMax() const noexcept { @@ -245,8 +228,7 @@ namespace nc // Description: /// returns the number of rows the cluster spans /// - /// @return - /// number of rows + /// @return number of rows /// uint32 height() const noexcept { @@ -257,8 +239,7 @@ namespace nc // Description: /// returns the number of columns the cluster spans /// - /// @return - /// number of columns + /// @return number of columns /// uint32 width() const noexcept { @@ -269,8 +250,7 @@ namespace nc // Description: /// returns the summed intensity of the cluster /// - /// @return - /// summed cluster intensity + /// @return summed cluster intensity /// dtype intensity() const noexcept { @@ -281,8 +261,7 @@ namespace nc // Description: /// returns the intensity of the peak pixel in the cluster /// - /// @return - /// peak pixel intensity + /// @return peak pixel intensity /// dtype peakPixelIntensity() const noexcept { @@ -293,8 +272,7 @@ namespace nc // Description: /// returns the cluster estimated energy on detector (EOD) /// - /// @return - /// eod + /// @return eod /// double eod() const noexcept { @@ -305,8 +283,7 @@ namespace nc // Description: /// adds a pixel to the cluster /// - /// @param - /// inPixel + /// @param inPixel /// void addPixel(const Pixel& inPixel) { @@ -328,8 +305,7 @@ namespace nc // Description: /// returns a string representation of the cluster /// - /// @return - /// string + /// @return string /// std::string str() const { @@ -357,10 +333,9 @@ namespace nc // Description: /// osstream operator /// - /// @param inStream - /// @param inCluster - /// @return - /// std::ostream + /// @param inStream + /// @param inCluster + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Cluster& inCluster) { diff --git a/include/NumCpp/ImageProcessing/ClusterMaker.hpp b/include/NumCpp/ImageProcessing/ClusterMaker.hpp index c34869acb..9bf1978db 100644 --- a/include/NumCpp/ImageProcessing/ClusterMaker.hpp +++ b/include/NumCpp/ImageProcessing/ClusterMaker.hpp @@ -62,12 +62,11 @@ namespace nc // Description: /// constructor /// - /// @param inXcdArrayPtr: pointer to exceedance array - /// @param inIntensityArrayPtr: pointer to intensity array - /// @param inBorderWidth: border to apply around exceedance pixels post clustering (default 0) + /// @param inXcdArrayPtr: pointer to exceedance array + /// @param inIntensityArrayPtr: pointer to intensity array + /// @param inBorderWidth: border to apply around exceedance pixels post clustering (default 0) /// - /// @return - /// None + /// @return None /// ClusterMaker(const NdArray* const inXcdArrayPtr, const NdArray* const inIntensityArrayPtr, uint8 inBorderWidth = 0) : xcds_(inXcdArrayPtr), @@ -105,8 +104,7 @@ namespace nc // Description: /// returns the number of clusters in the frame /// - /// @return - /// number of clusters + /// @return number of clusters /// uint32 size() noexcept { @@ -117,11 +115,9 @@ namespace nc // Description: /// access operator, no bounds checking /// - /// @param - /// inIndex + /// @param inIndex /// - /// @return - /// Cluster + /// @return Cluster /// const Cluster& operator[](uint32 inIndex) const noexcept { @@ -132,11 +128,9 @@ namespace nc // Description: /// access method with bounds checking /// - /// @param - /// inIndex + /// @param inIndex /// - /// @return - /// Cluster + /// @return Cluster /// const Cluster& at(uint32 inIndex) const { @@ -151,8 +145,7 @@ namespace nc // Description: /// returns in iterator to the beginning cluster of the container /// - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator begin() const noexcept { @@ -163,8 +156,7 @@ namespace nc // Description: /// returns in iterator to the 1 past the end cluster of the container /// - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator end() const noexcept { @@ -185,11 +177,10 @@ namespace nc // Description: /// checks that the input row and column have not fallen off of the edge /// - /// @param inRow - /// @param inCol + /// @param inRow + /// @param inCol /// - /// @return - /// returns a pixel object clipped to the image boundaries + /// @return returns a pixel object clipped to the image boundaries /// Pixel makePixel(int32 inRow, int32 inCol) noexcept { @@ -206,10 +197,9 @@ namespace nc // Description: /// finds all of the neighboring pixels to the input pixel /// - /// @param inPixel - /// @param outNeighbors - /// @return - /// None + /// @param inPixel + /// @param outNeighbors + /// @return None /// void findNeighbors(const Pixel& inPixel, std::set >& outNeighbors) { @@ -233,11 +223,10 @@ namespace nc // Description: /// finds all of the neighboring pixels to the input pixel that are NOT exceedances /// - /// @param inPixel - /// @param outNeighbors + /// @param inPixel + /// @param outNeighbors /// - /// @return - /// vector of non exceedance neighboring pixels + /// @return vector of non exceedance neighboring pixels /// void findNeighborNotXcds(const Pixel& inPixel, std::vector >& outNeighbors) { @@ -258,11 +247,10 @@ namespace nc // Description: /// finds the pixel index of neighboring pixels /// - /// @param inPixel - /// @param outNeighbors + /// @param inPixel + /// @param outNeighbors /// - /// @return - /// vector of neighboring pixel indices + /// @return vector of neighboring pixel indices /// void findNeighborXcds(const Pixel& inPixel, std::vector& outNeighbors) { diff --git a/include/NumCpp/ImageProcessing/Pixel.hpp b/include/NumCpp/ImageProcessing/Pixel.hpp index 9bcaf10b0..76c98bf8e 100644 --- a/include/NumCpp/ImageProcessing/Pixel.hpp +++ b/include/NumCpp/ImageProcessing/Pixel.hpp @@ -65,9 +65,9 @@ namespace nc // Description: /// constructor /// - /// @param inRow: pixel row - /// @param inCol: pixel column - /// @param inIntensity: pixel intensity + /// @param inRow: pixel row + /// @param inCol: pixel column + /// @param inIntensity: pixel intensity /// constexpr Pixel(uint32 inRow, uint32 inCol, dtype inIntensity) noexcept : row(inRow), @@ -79,11 +79,9 @@ namespace nc // Description: /// equality operator /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// constexpr bool operator==(const Pixel& rhs) const noexcept { @@ -94,11 +92,9 @@ namespace nc // Description: /// not equality operator /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// constexpr bool operator!=(const Pixel& rhs) const noexcept { @@ -112,11 +108,9 @@ namespace nc /// the centroids in descensing order, I am purposefully defining /// this operator backwards! /// - /// @param - /// rhs + /// @param rhs /// - /// @return - /// bool + /// @return bool /// bool operator<(const Pixel& rhs) const noexcept { @@ -136,8 +130,7 @@ namespace nc // Description: /// returns the pixel information as a string /// - /// @return - /// std::string + /// @return std::string /// std::string str() const { @@ -159,10 +152,9 @@ namespace nc // Description: /// osstream operator /// - /// @param inStream - /// @param inPixel - /// @return - /// std::ostream + /// @param inStream + /// @param inPixel + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inStream, const Pixel& inPixel) { diff --git a/include/NumCpp/ImageProcessing/applyThreshold.hpp b/include/NumCpp/ImageProcessing/applyThreshold.hpp index 8bd636a52..08259b165 100644 --- a/include/NumCpp/ImageProcessing/applyThreshold.hpp +++ b/include/NumCpp/ImageProcessing/applyThreshold.hpp @@ -38,10 +38,9 @@ namespace nc // Method Description: /// Applies a threshold to an image /// - /// @param inImageArray - /// @param inThreshold - /// @return - /// NdArray of booleans of pixels that exceeded the threshold + /// @param inImageArray + /// @param inThreshold + /// @return NdArray of booleans of pixels that exceeded the threshold /// template NdArray applyThreshold(const NdArray& inImageArray, dtype inThreshold) diff --git a/include/NumCpp/ImageProcessing/centroidClusters.hpp b/include/NumCpp/ImageProcessing/centroidClusters.hpp index 7b0047284..cba0e4420 100644 --- a/include/NumCpp/ImageProcessing/centroidClusters.hpp +++ b/include/NumCpp/ImageProcessing/centroidClusters.hpp @@ -43,9 +43,8 @@ namespace nc // Method Description: /// Center of Mass centroids clusters /// - /// @param inClusters - /// @return - /// std::vector + /// @param inClusters + /// @return std::vector /// template std::vector > centroidClusters(const std::vector >& inClusters) diff --git a/include/NumCpp/ImageProcessing/clusterPixels.hpp b/include/NumCpp/ImageProcessing/clusterPixels.hpp index 6a8360921..ec0538c92 100644 --- a/include/NumCpp/ImageProcessing/clusterPixels.hpp +++ b/include/NumCpp/ImageProcessing/clusterPixels.hpp @@ -44,11 +44,10 @@ namespace nc // Method Description: /// Clusters exceedance pixels from an image /// - /// @param inImageArray - /// @param inExceedances - /// @param inBorderWidth: border to apply around exceedance pixels post clustering (default 0) - /// @return - /// std::vector + /// @param inImageArray + /// @param inExceedances + /// @param inBorderWidth: border to apply around exceedance pixels post clustering (default 0) + /// @return std::vector /// template std::vector > clusterPixels(const NdArray& inImageArray, const NdArray& inExceedances, uint8 inBorderWidth = 0) diff --git a/include/NumCpp/ImageProcessing/generateCentroids.hpp b/include/NumCpp/ImageProcessing/generateCentroids.hpp index 055dbc3ff..5e8a9345d 100644 --- a/include/NumCpp/ImageProcessing/generateCentroids.hpp +++ b/include/NumCpp/ImageProcessing/generateCentroids.hpp @@ -50,12 +50,11 @@ namespace nc /// Generates a list of centroids givin an input exceedance /// rate /// - /// @param inImageArray - /// @param inRate: exceedance rate - /// @param inWindowType: (string "pre", or "post" for where to apply the exceedance windowing) - /// @param inBorderWidth: border to apply (default 0) - /// @return - /// std::vector + /// @param inImageArray + /// @param inRate: exceedance rate + /// @param inWindowType: (string "pre", or "post" for where to apply the exceedance windowing) + /// @param inBorderWidth: border to apply (default 0) + /// @return std::vector /// template std::vector > generateCentroids(const NdArray& inImageArray, double inRate, const std::string& inWindowType, uint8 inBorderWidth = 0) diff --git a/include/NumCpp/ImageProcessing/generateThreshold.hpp b/include/NumCpp/ImageProcessing/generateThreshold.hpp index dce03daac..46a580a37 100644 --- a/include/NumCpp/ImageProcessing/generateThreshold.hpp +++ b/include/NumCpp/ImageProcessing/generateThreshold.hpp @@ -48,10 +48,9 @@ namespace nc /// exceeds the threshold. Really should only be used for integer /// input array values. If using floating point data, user beware... /// - /// @param inImageArray - /// @param inRate - /// @return - /// dtype + /// @param inImageArray + /// @param inRate + /// @return dtype /// template dtype generateThreshold(const NdArray& inImageArray, double inRate) diff --git a/include/NumCpp/ImageProcessing/windowExceedances.hpp b/include/NumCpp/ImageProcessing/windowExceedances.hpp index e2beec8f2..ead380b46 100644 --- a/include/NumCpp/ImageProcessing/windowExceedances.hpp +++ b/include/NumCpp/ImageProcessing/windowExceedances.hpp @@ -42,10 +42,9 @@ namespace nc // Method Description: /// Window expand around exceedance pixels /// - /// @param inExceedances - /// @param inBorderWidth - /// @return - /// NdArray + /// @param inExceedances + /// @param inBorderWidth + /// @return NdArray /// inline NdArray windowExceedances(const NdArray& inExceedances, uint8 inBorderWidth) noexcept { diff --git a/include/NumCpp/Integrate/gauss_legendre.hpp b/include/NumCpp/Integrate/gauss_legendre.hpp index a00792c24..2a7672905 100644 --- a/include/NumCpp/Integrate/gauss_legendre.hpp +++ b/include/NumCpp/Integrate/gauss_legendre.hpp @@ -54,7 +54,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param numIterations: the number of iterations to perform + /// @param numIterations: the number of iterations to perform /// explicit LegendrePolynomial(const uint32 numIterations) noexcept : numIterations_(numIterations), @@ -68,7 +68,7 @@ namespace nc // Method Description: /// Returns the weights vector /// - /// @return weights vector + /// @return weights vector /// const std::vector& getWeight() const noexcept { @@ -79,7 +79,7 @@ namespace nc // Method Description: /// Returns the roots vector /// - /// @return roots vector + /// @return roots vector /// const std::vector& getRoot() const noexcept { @@ -172,12 +172,12 @@ namespace nc // Method Description: /// Performs Gauss-Legendre integration of the input function /// - /// @param low: the lower bound of the integration - /// @param high: the upper bound of the integration - /// @param n: the number of iterations to perform - /// @param f: the function to integrate over + /// @param low: the lower bound of the integration + /// @param high: the upper bound of the integration + /// @param n: the number of iterations to perform + /// @param f: the function to integrate over /// - /// @return double + /// @return double /// inline double gauss_legendre(const double low, const double high, const uint32 n, const std::function& f) diff --git a/include/NumCpp/Integrate/romberg.hpp b/include/NumCpp/Integrate/romberg.hpp index 2f8c04cca..15e16ed96 100644 --- a/include/NumCpp/Integrate/romberg.hpp +++ b/include/NumCpp/Integrate/romberg.hpp @@ -46,12 +46,12 @@ namespace nc // Method Description: /// Performs Newton-Cotes Romberg integration of the input function /// - /// @param low: the lower bound of the integration - /// @param high: the upper bound of the integration - /// @param n: the number of iterations - /// @param f: the function to integrate over + /// @param low: the lower bound of the integration + /// @param high: the upper bound of the integration + /// @param n: the number of iterations + /// @param f: the function to integrate over /// - /// @return double + /// @return double /// inline double romberg(const double low, const double high, const uint8 n, const std::function& f) diff --git a/include/NumCpp/Integrate/simpson.hpp b/include/NumCpp/Integrate/simpson.hpp index 0948c7914..19a1857e5 100644 --- a/include/NumCpp/Integrate/simpson.hpp +++ b/include/NumCpp/Integrate/simpson.hpp @@ -43,12 +43,12 @@ namespace nc // Method Description: /// Performs Newton-Cotes Simpson integration of the input function /// - /// @param low: the lower bound of the integration - /// @param high: the upper bound of the integration - /// @param n: the number of subdivisions - /// @param f: the function to integrate over + /// @param low: the lower bound of the integration + /// @param high: the upper bound of the integration + /// @param n: the number of subdivisions + /// @param f: the function to integrate over /// - /// @return double + /// @return double /// inline double simpson(const double low, const double high, const uint32 n, const std::function& f) noexcept diff --git a/include/NumCpp/Integrate/trapazoidal.hpp b/include/NumCpp/Integrate/trapazoidal.hpp index 6b76478a3..7981886b4 100644 --- a/include/NumCpp/Integrate/trapazoidal.hpp +++ b/include/NumCpp/Integrate/trapazoidal.hpp @@ -43,12 +43,12 @@ namespace nc // Method Description: /// Performs Newton-Cotes trapazoidal integration of the input function /// - /// @param low: the lower bound of the integration - /// @param high: the upper bound of the integration - /// @param n: the number of subdivisions - /// @param f: the function to integrate over + /// @param low: the lower bound of the integration + /// @param high: the upper bound of the integration + /// @param n: the number of subdivisions + /// @param f: the function to integrate over /// - /// @return double + /// @return double /// inline double trapazoidal(const double low, const double high, const uint32 n, const std::function& f) noexcept diff --git a/include/NumCpp/Linalg/cholesky.hpp b/include/NumCpp/Linalg/cholesky.hpp index adb0b68ad..820c51a22 100644 --- a/include/NumCpp/Linalg/cholesky.hpp +++ b/include/NumCpp/Linalg/cholesky.hpp @@ -46,9 +46,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.cholesky.html#numpy.linalg.cholesky /// - /// @param inMatrix: NdArray to be decomposed + /// @param inMatrix: NdArray to be decomposed /// - /// @return NdArray of the decomposed L matrix + /// @return NdArray of the decomposed L matrix /// template NdArray cholesky(const NdArray& inMatrix) diff --git a/include/NumCpp/Linalg/det.hpp b/include/NumCpp/Linalg/det.hpp index 2cba77b5c..58fcd7600 100644 --- a/include/NumCpp/Linalg/det.hpp +++ b/include/NumCpp/Linalg/det.hpp @@ -47,10 +47,8 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.det.html#scipy.linalg.det /// - /// @param - /// inArray - /// @return - /// matrix determinant + /// @param inArray + /// @return matrix determinant /// template dtype det(const NdArray& inArray) diff --git a/include/NumCpp/Linalg/gaussNewtonNlls.hpp b/include/NumCpp/Linalg/gaussNewtonNlls.hpp index 012660792..023e3588a 100644 --- a/include/NumCpp/Linalg/gaussNewtonNlls.hpp +++ b/include/NumCpp/Linalg/gaussNewtonNlls.hpp @@ -53,22 +53,22 @@ namespace nc /// It is a modification of Newton's method for finding a minimum of a function. /// https://en.wikipedia.org/wiki/Gauss%E2%80%93Newton_algorithm /// - /// @param numIterations: the number of iterations to perform - /// @param coordinates: the coordinate values. The shape needs to be [n x d], where d is + /// @param numIterations: the number of iterations to perform + /// @param coordinates: the coordinate values. The shape needs to be [n x d], where d is /// the number of diminsions of the fit function (f(x) is one dimensional, /// f(x, y) is two dimensions, etc), and n is the number of observations /// that are being fit to. - /// @param measurements: the measured values that are being fit - /// @param function: a std::function of the function that is being fit. The function takes as + /// @param measurements: the measured values that are being fit + /// @param function: a std::function of the function that is being fit. The function takes as /// inputs an NdArray of a single set of the coordinate values, and an NdArray /// of the current values of the fit parameters - /// @param derivatives: array of std::functions to calculate the function + /// @param derivatives: array of std::functions to calculate the function /// derivatives. The function that is being fit. The function takes as /// inputs an NdArray of a single set of the coordinate values, and an NdArray /// of the current values of the fit parameters - /// @param initialGuess: the initial guess of the parameters to be solved for + /// @param initialGuess: the initial guess of the parameters to be solved for /// - /// @return std::pair of NdArray of solved parameter values, and rms of the residuals value + /// @return std::pair of NdArray of solved parameter values, and rms of the residuals value /// template, int> = 0, diff --git a/include/NumCpp/Linalg/hat.hpp b/include/NumCpp/Linalg/hat.hpp index 5748ae032..0b6e1e245 100644 --- a/include/NumCpp/Linalg/hat.hpp +++ b/include/NumCpp/Linalg/hat.hpp @@ -42,11 +42,10 @@ namespace nc // Method Description: /// vector hat operator /// - /// @param inX - /// @param inY - /// @param inZ - /// @return - /// 3x3 NdArray + /// @param inX + /// @param inY + /// @param inZ + /// @return 3x3 NdArray /// template NdArray hat(dtype inX, dtype inY, dtype inZ) @@ -71,10 +70,8 @@ namespace nc // Method Description: /// vector hat operator /// - /// @param - /// inVec (3x1, or 1x3 cartesian vector) - /// @return - /// 3x3 NdArray + /// @param inVec (3x1, or 1x3 cartesian vector) + /// @return 3x3 NdArray /// template NdArray hat(const NdArray& inVec) @@ -93,10 +90,8 @@ namespace nc // Method Description: /// vector hat operator /// - /// @param - /// inVec - /// @return - /// 3x3 NdArray + /// @param inVec + /// @return 3x3 NdArray /// inline NdArray hat(const Vec3& inVec) { diff --git a/include/NumCpp/Linalg/inv.hpp b/include/NumCpp/Linalg/inv.hpp index cd404db89..bbe0a505e 100644 --- a/include/NumCpp/Linalg/inv.hpp +++ b/include/NumCpp/Linalg/inv.hpp @@ -45,10 +45,8 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.inv.html#scipy.linalg.inv /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray inv(const NdArray& inArray) diff --git a/include/NumCpp/Linalg/lstsq.hpp b/include/NumCpp/Linalg/lstsq.hpp index 2d0b9e690..200c4807a 100644 --- a/include/NumCpp/Linalg/lstsq.hpp +++ b/include/NumCpp/Linalg/lstsq.hpp @@ -48,12 +48,11 @@ namespace nc /// /// SciPy Reference: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.lstsq.html#scipy.linalg.lstsq /// - /// @param inA: coefficient matrix - /// @param inB: Ordinate or "dependent variable" values - /// @param inTolerance (default 1e-12) + /// @param inA: coefficient matrix + /// @param inB: Ordinate or "dependent variable" values + /// @param inTolerance (default 1e-12) /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray lstsq(const NdArray& inA, const NdArray& inB, double inTolerance = 1e-12) diff --git a/include/NumCpp/Linalg/lu_decomposition.hpp b/include/NumCpp/Linalg/lu_decomposition.hpp index 192423af5..6e0bb5ee1 100644 --- a/include/NumCpp/Linalg/lu_decomposition.hpp +++ b/include/NumCpp/Linalg/lu_decomposition.hpp @@ -49,9 +49,9 @@ namespace nc // Method Description: /// matrix LU decomposition A = LU /// - /// @param inMatrix: NdArray to be decomposed + /// @param inMatrix: NdArray to be decomposed /// - /// @return std::pair of the decomposed L and U matrices + /// @return std::pair of the decomposed L and U matrices /// template std::pair, NdArray > lu_decomposition(const NdArray& inMatrix) diff --git a/include/NumCpp/Linalg/matrix_power.hpp b/include/NumCpp/Linalg/matrix_power.hpp index 69bbb397e..ff3eb6f6d 100644 --- a/include/NumCpp/Linalg/matrix_power.hpp +++ b/include/NumCpp/Linalg/matrix_power.hpp @@ -52,11 +52,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.matrix_power.html#numpy.linalg.matrix_power /// - /// @param inArray - /// @param inPower + /// @param inArray + /// @param inPower /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray matrix_power(const NdArray& inArray, int16 inPower) diff --git a/include/NumCpp/Linalg/multi_dot.hpp b/include/NumCpp/Linalg/multi_dot.hpp index a3921c665..eb277f223 100644 --- a/include/NumCpp/Linalg/multi_dot.hpp +++ b/include/NumCpp/Linalg/multi_dot.hpp @@ -46,11 +46,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.multi_dot.html#numpy.linalg.multi_dot /// - /// @param - /// inList: list of arrays + /// @param inList: list of arrays /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray multi_dot(const std::initializer_list >& inList) diff --git a/include/NumCpp/Linalg/pivotLU_decomposition.hpp b/include/NumCpp/Linalg/pivotLU_decomposition.hpp index 42fbce0fd..187672158 100644 --- a/include/NumCpp/Linalg/pivotLU_decomposition.hpp +++ b/include/NumCpp/Linalg/pivotLU_decomposition.hpp @@ -50,9 +50,9 @@ namespace nc // Method Description: /// matrix pivot LU decomposition PA = LU /// - /// @param inMatrix: NdArray to be decomposed + /// @param inMatrix: NdArray to be decomposed /// - /// @return std::tuple of the decomposed L, U, and P matrices + /// @return std::tuple of the decomposed L, U, and P matrices /// template std::tuple, NdArray, NdArray > pivotLU_decomposition(const NdArray& inMatrix) diff --git a/include/NumCpp/Linalg/svd.hpp b/include/NumCpp/Linalg/svd.hpp index b0dbf0f09..40e8bae31 100644 --- a/include/NumCpp/Linalg/svd.hpp +++ b/include/NumCpp/Linalg/svd.hpp @@ -44,10 +44,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.svd.html#numpy.linalg.svd /// - /// @param inArray: NdArray to be SVDed - /// @param outU: NdArray output U - /// @param outS: NdArray output S - /// @param outVt: NdArray output V transpose + /// @param inArray: NdArray to be SVDed + /// @param outU: NdArray output U + /// @param outS: NdArray output S + /// @param outVt: NdArray output V transpose /// template void svd(const NdArray& inArray, NdArray& outU, NdArray& outS, NdArray& outVt) diff --git a/include/NumCpp/Linalg/svd/SVDClass.hpp b/include/NumCpp/Linalg/svd/SVDClass.hpp index 52a16ed23..77fe500f2 100644 --- a/include/NumCpp/Linalg/svd/SVDClass.hpp +++ b/include/NumCpp/Linalg/svd/SVDClass.hpp @@ -51,8 +51,7 @@ namespace nc // Description: /// Constructor /// - /// @param - /// inMatrix: matrix to perform SVD on + /// @param inMatrix: matrix to perform SVD on /// explicit SVD(const NdArray& inMatrix) : m_(inMatrix.shape().rows), @@ -71,8 +70,7 @@ namespace nc // Description: /// the resultant u matrix /// - /// @return - /// u matrix + /// @return u matrix /// const NdArray& u() noexcept { @@ -83,8 +81,7 @@ namespace nc // Description: /// the resultant v matrix /// - /// @return - /// v matrix + /// @return v matrix /// const NdArray& v() noexcept { @@ -95,8 +92,7 @@ namespace nc // Description: /// the resultant w matrix /// - /// @return - /// s matrix + /// @return s matrix /// const NdArray& s() noexcept { @@ -107,11 +103,10 @@ namespace nc // Description: /// solves the linear least squares problem /// - /// @param inInput - /// @param inThresh (default -1.0) + /// @param inInput + /// @param inThresh (default -1.0) /// - /// @return - /// NdArray + /// @return NdArray /// NdArray solve(const NdArray& inInput, double inThresh = -1.0) { @@ -161,11 +156,10 @@ namespace nc // Description: /// returns the SIGN of two values /// - /// @param inA - /// @param inB + /// @param inA + /// @param inB /// - /// @return - /// value + /// @return value /// static double SIGN(double inA, double inB) noexcept { @@ -628,11 +622,10 @@ namespace nc // Description: /// performs pythag of input values /// - /// @param inA - /// @param inB + /// @param inA + /// @param inB /// - /// @return - /// resultant value + /// @return resultant value /// static double pythag(double inA, double inB) noexcept { diff --git a/include/NumCpp/NdArray/NdArrayCore.hpp b/include/NumCpp/NdArray/NdArrayCore.hpp index 7d6c9e63d..d26d2cd21 100644 --- a/include/NumCpp/NdArray/NdArrayCore.hpp +++ b/include/NumCpp/NdArray/NdArrayCore.hpp @@ -107,8 +107,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param - /// inSquareSize: square number of rows and columns + /// @param inSquareSize: square number of rows and columns /// explicit NdArray(size_type inSquareSize) : shape_(inSquareSize, inSquareSize), @@ -121,8 +120,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inNumRows - /// @param inNumCols + /// @param inNumRows + /// @param inNumCols /// NdArray(size_type inNumRows, size_type inNumCols) : shape_(inNumRows, inNumCols), @@ -135,8 +134,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param - /// inShape + /// @param inShape /// explicit NdArray(const Shape& inShape) : shape_(inShape), @@ -149,8 +147,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param - /// inList + /// @param inList /// NdArray(std::initializer_list inList) : shape_(1, static_cast(inList.size())), @@ -167,8 +164,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param - /// inList: 2D initializer list + /// @param inList: 2D initializer list /// NdArray(const std::initializer_list >& inList) : shape_(static_cast(inList.size()), 0) @@ -200,8 +196,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param inArray + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. /// template @@ -258,8 +254,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inVector - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param inVector + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. /// template, int> = 0> @@ -286,7 +282,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param in2dVector + /// @param in2dVector /// explicit NdArray(const std::vector>& in2dVector) : shape_(static_cast(in2dVector.size()), 0) @@ -318,8 +314,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param in2dArray - /// @param copy: (optional) boolean for whether to make a copy and own the data, or + /// @param in2dArray + /// @param copy: (optional) boolean for whether to make a copy and own the data, or /// act as a non-owning shell. Default true. /// template @@ -347,7 +343,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param inDeque + /// @param inDeque /// template, int> = 0> explicit NdArray(const std::deque& inDeque) : @@ -365,7 +361,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param in2dDeque + /// @param in2dDeque /// explicit NdArray(const std::deque>& in2dDeque) : shape_(static_cast(in2dDeque.size()), 0) @@ -397,8 +393,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param - /// inList + /// @param inList /// explicit NdArray(const std::list& inList) : shape_(1, static_cast(inList.size())), @@ -415,8 +410,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inFirst - /// @param inLast + /// @param inFirst + /// @param inLast /// template::value_type, dtype>, int> = 0> @@ -436,8 +431,8 @@ namespace nc /// Constructor. Copies the contents of the buffer into /// the array. /// - /// @param inPtr: const_pointer to beginning of buffer - /// @param size: number of elements in buffer + /// @param inPtr: const_pointer to beginning of buffer + /// @param size: number of elements in buffer /// NdArray(const_pointer inPtr, size_type size) : shape_(1, size), @@ -455,9 +450,9 @@ namespace nc /// Constructor. Copies the contents of the buffer into /// the array. /// - /// @param inPtr: const_pointer to beginning of buffer - /// @param numRows: number of rows of the buffer - /// @param numCols: number of cols of the buffer + /// @param inPtr: const_pointer to beginning of buffer + /// @param numRows: number of rows of the buffer + /// @param numCols: number of cols of the buffer /// template, int> = 0, @@ -478,9 +473,9 @@ namespace nc /// Constructor. Operates as a shell around an already existing /// array of data. /// - /// @param inPtr: pointer to beginning of the array - /// @param size: the number of elements in the array - /// @param takeOwnership: whether or not to take ownership of the data + /// @param inPtr: pointer to beginning of the array + /// @param size: the number of elements in the array + /// @param takeOwnership: whether or not to take ownership of the data /// and call delete[] in the destructor. /// template& inOtherArray) : shape_(inOtherArray.shape_), @@ -535,8 +529,7 @@ namespace nc // Method Description: /// Move Constructor /// - /// @param - /// inOtherArray + /// @param inOtherArray /// NdArray(NdArray&& inOtherArray) noexcept : shape_(inOtherArray.shape_), @@ -564,10 +557,8 @@ namespace nc // Method Description: /// Assignment operator, performs a deep copy /// - /// @param - /// rhs - /// @return - /// NdArray + /// @param rhs + /// @return NdArray /// NdArray& operator=(const NdArray& rhs) { @@ -590,10 +581,8 @@ namespace nc /// Assignment operator, sets the entire array to a single /// scaler value. /// - /// @param - /// inValue - /// @return - /// NdArray + /// @param inValue + /// @return NdArray /// NdArray& operator=(value_type inValue) noexcept { @@ -609,10 +598,8 @@ namespace nc // Method Description: /// Move operator, performs a deep move /// - /// @param - /// rhs - /// @return - /// NdArray + /// @param rhs + /// @return NdArray /// NdArray& operator=(NdArray&& rhs) noexcept { @@ -637,10 +624,8 @@ namespace nc // Method Description: /// 1D access operator with no bounds checking /// - /// @param - /// inIndex - /// @return - /// value + /// @param inIndex + /// @return value /// reference operator[](int32 inIndex) noexcept { @@ -656,10 +641,8 @@ namespace nc // Method Description: /// const 1D access operator with no bounds checking /// - /// @param - /// inIndex - /// @return - /// value + /// @param inIndex + /// @return value /// const_reference operator[](int32 inIndex) const noexcept { @@ -675,10 +658,9 @@ namespace nc // Method Description: /// 2D access operator with no bounds checking /// - /// @param inRowIndex - /// @param inColIndex - /// @return - /// value + /// @param inRowIndex + /// @param inColIndex + /// @return value /// reference operator()(int32 inRowIndex, int32 inColIndex) noexcept { @@ -699,10 +681,9 @@ namespace nc // Method Description: /// const 2D access operator with no bounds checking /// - /// @param inRowIndex - /// @param inColIndex - /// @return - /// value + /// @param inRowIndex + /// @param inColIndex + /// @return value /// const_reference operator()(int32 inRowIndex, int32 inColIndex) const noexcept { @@ -724,10 +705,8 @@ namespace nc /// 1D Slicing access operator with bounds checking. /// returned array is of the range [start, stop). /// - /// @param - /// inSlice - /// @return - /// NdArray + /// @param inSlice + /// @return NdArray /// NdArray operator[](const Slice& inSlice) const { @@ -747,10 +726,8 @@ namespace nc // Method Description: /// Returns the values from the input mask /// - /// @param - /// inMask - /// @return - /// NdArray + /// @param inMask + /// @return NdArray /// NdArray operator[](const NdArray& inMask) const { @@ -773,10 +750,8 @@ namespace nc // Method Description: /// Returns the values from the input indices /// - /// @param - /// inIndices - /// @return - /// NdArray + /// @param inIndices + /// @return NdArray /// /// template operator()(Slice inRowSlice, Slice inColSlice) const { @@ -832,10 +806,9 @@ namespace nc /// 2D Slicing access operator with bounds checking. /// returned array is of the range [start, stop). /// - /// @param inRowSlice - /// @param inColIndex - /// @return - /// NdArray + /// @param inRowSlice + /// @param inColIndex + /// @return NdArray /// NdArray operator()(Slice inRowSlice, int32 inColIndex) const { @@ -855,10 +828,9 @@ namespace nc /// 2D Slicing access operator with bounds checking. /// returned array is of the range [start, stop). /// - /// @param inRowIndex - /// @param inColSlice - /// @return - /// NdArray + /// @param inRowIndex + /// @param inColSlice + /// @return NdArray /// NdArray operator()(int32 inRowIndex, Slice inColSlice) const { @@ -878,10 +850,9 @@ namespace nc /// 2D index access operator with bounds checking. /// returned array is of the range. /// - /// @param rowIndices - /// @param colIndex - /// @return - /// NdArray + /// @param rowIndices + /// @param colIndex + /// @return NdArray /// template> || is_same_v>, int> = 0> @@ -896,10 +867,9 @@ namespace nc /// 2D index access operator with bounds checking. /// returned array is of the range. /// - /// @param rowIndices - /// @param colSlice - /// @return - /// NdArray + /// @param rowIndices + /// @param colSlice + /// @return NdArray /// template> || is_same_v>, int> = 0> @@ -913,10 +883,9 @@ namespace nc /// 2D index access operator with bounds checking. /// returned array is of the range. /// - /// @param rowIndex - /// @param colIndices - /// @return - /// NdArray + /// @param rowIndex + /// @param colIndices + /// @return NdArray /// template> || is_same_v>, int> = 0> @@ -931,10 +900,9 @@ namespace nc /// 2D index access operator with bounds checking. /// returned array is of the range. /// - /// @param rowSlice - /// @param colIndices - /// @return - /// NdArray + /// @param rowSlice + /// @param colIndices + /// @return NdArray /// template> || is_same_v>, int> = 0> @@ -948,10 +916,9 @@ namespace nc /// 2D index access operator with bounds checking. /// returned array is of the range. /// - /// @param rowIndices - /// @param colIndices - /// @return - /// NdArray + /// @param rowIndices + /// @param colIndices + /// @return NdArray /// template> || is_same_v>, int> = 0, @@ -990,10 +957,9 @@ namespace nc /// Returns a Slice object for slicing a row to the end of /// array. /// - /// @param inStartIdx (default 0) - /// @param inStepSize (default 1) - /// @return - /// Slice + /// @param inStartIdx (default 0) + /// @param inStepSize (default 1) + /// @return Slice /// Slice cSlice(int32 inStartIdx = 0, uint32 inStepSize = 1) const noexcept { @@ -1005,10 +971,9 @@ namespace nc /// Returns a Slice object for slicing a column to the end /// of the array. /// - /// @param inStartIdx (default 0) - /// @param inStepSize (default 1) - /// @return - /// Slice + /// @param inStartIdx (default 0) + /// @param inStepSize (default 1) + /// @return Slice /// Slice rSlice(int32 inStartIdx = 0, uint32 inStepSize = 1) const noexcept { @@ -1019,10 +984,8 @@ namespace nc // Method Description: /// 1D access method with bounds checking /// - /// @param - /// inIndex - /// @return - /// value + /// @param inIndex + /// @return value /// reference at(int32 inIndex) { @@ -1042,10 +1005,8 @@ namespace nc // Method Description: /// const 1D access method with bounds checking /// - /// @param - /// inIndex - /// @return - /// value + /// @param inIndex + /// @return value /// const_reference at(int32 inIndex) const { @@ -1065,10 +1026,9 @@ namespace nc // Method Description: /// 2D access method with bounds checking /// - /// @param inRowIndex - /// @param inColIndex - /// @return - /// value + /// @param inRowIndex + /// @param inColIndex + /// @return value /// reference at(int32 inRowIndex, int32 inColIndex) { @@ -1097,10 +1057,9 @@ namespace nc // Method Description: /// const 2D access method with bounds checking /// - /// @param inRowIndex - /// @param inColIndex - /// @return - /// value + /// @param inRowIndex + /// @param inColIndex + /// @return value /// const_reference at(int32 inRowIndex, int32 inColIndex) const { @@ -1129,10 +1088,8 @@ namespace nc // Method Description: /// const 1D access method with bounds checking /// - /// @param - /// inSlice - /// @return - /// Ndarray + /// @param inSlice + /// @return Ndarray /// NdArray at(const Slice& inSlice) const { @@ -1145,10 +1102,9 @@ namespace nc // Method Description: /// const 2D access method with bounds checking /// - /// @param inRowSlice - /// @param inColSlice - /// @return - /// Ndarray + /// @param inRowSlice + /// @param inColSlice + /// @return Ndarray /// NdArray at(const Slice& inRowSlice, const Slice& inColSlice) const { @@ -1161,10 +1117,9 @@ namespace nc // Method Description: /// const 2D access method with bounds checking /// - /// @param inRowSlice - /// @param inColIndex - /// @return - /// Ndarray + /// @param inRowSlice + /// @param inColIndex + /// @return Ndarray /// NdArray at(const Slice& inRowSlice, int32 inColIndex) const { @@ -1177,10 +1132,9 @@ namespace nc // Method Description: /// const 2D access method with bounds checking /// - /// @param inRowIndex - /// @param inColSlice - /// @return - /// Ndarray + /// @param inRowIndex + /// @param inColSlice + /// @return Ndarray /// NdArray at(int32 inRowIndex, const Slice& inColSlice) const { @@ -1193,10 +1147,9 @@ namespace nc // Method Description: /// const 2D access method with bounds checking /// - /// @param rowIndices - /// @param colIndices - /// @return - /// Ndarray + /// @param rowIndices + /// @param colIndices + /// @return Ndarray /// NdArray at(const NdArray& rowIndices, const NdArray& colIndices) const { @@ -1208,8 +1161,7 @@ namespace nc //============================================================================ // Method Description: /// iterator to the beginning of the flattened array - /// @return - /// iterator + /// @return iterator /// iterator begin() noexcept { @@ -1220,10 +1172,8 @@ namespace nc // Method Description: /// iterator to the beginning of the input row /// - /// @param - /// inRow - /// @return - /// iterator + /// @param inRow + /// @return iterator /// iterator begin(size_type inRow) { @@ -1238,8 +1188,7 @@ namespace nc //============================================================================ // Method Description: /// const iterator to the beginning of the flattened array - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator begin() const noexcept { @@ -1250,10 +1199,8 @@ namespace nc // Method Description: /// const iterator to the beginning of the input row /// - /// @param - /// inRow - /// @return - /// const_iterator + /// @param inRow + /// @return const_iterator /// const_iterator begin(size_type inRow) const { @@ -1264,8 +1211,7 @@ namespace nc // Method Description: /// const iterator to the beginning of the flattened array /// - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator cbegin() const noexcept { @@ -1276,10 +1222,8 @@ namespace nc // Method Description: /// const iterator to the beginning of the input row /// - /// @param - /// inRow - /// @return - /// const_iterator + /// @param inRow + /// @return const_iterator /// const_iterator cbegin(size_type inRow) const { @@ -1294,8 +1238,7 @@ namespace nc //============================================================================ // Method Description: /// column_iterator to the beginning of the flattened array - /// @return - /// column_iterator + /// @return column_iterator /// column_iterator colbegin() noexcept { @@ -1306,10 +1249,8 @@ namespace nc // Method Description: /// column_iterator to the beginning of the input column /// - /// @param - /// inCol - /// @return - /// column_iterator + /// @param inCol + /// @return column_iterator /// column_iterator colbegin(size_type inCol) { @@ -1324,8 +1265,7 @@ namespace nc //============================================================================ // Method Description: /// const column_iterator to the beginning of the flattened array - /// @return - /// const_column_iterator + /// @return const_column_iterator /// const_column_iterator colbegin() const noexcept { @@ -1336,10 +1276,8 @@ namespace nc // Method Description: /// const column_iterator to the beginning of the input column /// - /// @param - /// inCol - /// @return - /// const_column_iterator + /// @param inCol + /// @return const_column_iterator /// const_column_iterator colbegin(size_type inCol) const { @@ -1350,8 +1288,7 @@ namespace nc // Method Description: /// const_column_iterator to the beginning of the flattened array /// - /// @return - /// const_column_iterator + /// @return const_column_iterator /// const_column_iterator ccolbegin() const noexcept { @@ -1362,10 +1299,8 @@ namespace nc // Method Description: /// const_column_iterator to the beginning of the input column /// - /// @param - /// inCol - /// @return - /// const_column_iterator + /// @param inCol + /// @return const_column_iterator /// const_column_iterator ccolbegin(size_type inCol) const { @@ -1380,8 +1315,7 @@ namespace nc //============================================================================ // Method Description: /// reverse_iterator to the beginning of the flattened array - /// @return - /// reverse_iterator + /// @return reverse_iterator /// reverse_iterator rbegin() noexcept { @@ -1392,10 +1326,8 @@ namespace nc // Method Description: /// reverse_iterator to the beginning of the input row /// - /// @param - /// inRow - /// @return - /// reverse_iterator + /// @param inRow + /// @return reverse_iterator /// reverse_iterator rbegin(size_type inRow) { @@ -1410,8 +1342,7 @@ namespace nc //============================================================================ // Method Description: /// const iterator to the beginning of the flattened array - /// @return - /// const_iterator + /// @return const_iterator /// const_reverse_iterator rbegin() const noexcept { @@ -1422,10 +1353,8 @@ namespace nc // Method Description: /// const iterator to the beginning of the input row /// - /// @param - /// inRow - /// @return - /// const_iterator + /// @param inRow + /// @return const_iterator /// const_reverse_iterator rbegin(size_type inRow) const { @@ -1436,8 +1365,7 @@ namespace nc // Method Description: /// const_reverse_iterator to the beginning of the flattened array /// - /// @return - /// const_reverse_iterator + /// @return const_reverse_iterator /// const_reverse_iterator crbegin() const noexcept { @@ -1448,10 +1376,8 @@ namespace nc // Method Description: /// const_reverse_iterator to the beginning of the input row /// - /// @param - /// inRow - /// @return - /// const_reverse_iterator + /// @param inRow + /// @return const_reverse_iterator /// const_reverse_iterator crbegin(size_type inRow) const { @@ -1466,8 +1392,7 @@ namespace nc //============================================================================ // Method Description: /// reverse_column_iterator to the beginning of the flattened array - /// @return - /// reverse_column_iterator + /// @return reverse_column_iterator /// reverse_column_iterator rcolbegin() noexcept { @@ -1478,10 +1403,8 @@ namespace nc // Method Description: /// reverse_column_iterator to the beginning of the input column /// - /// @param - /// inCol - /// @return - /// reverse_column_iterator + /// @param inCol + /// @return reverse_column_iterator /// reverse_column_iterator rcolbegin(size_type inCol) { @@ -1496,8 +1419,7 @@ namespace nc //============================================================================ // Method Description: /// const iterator to the beginning of the flattened array - /// @return - /// const_iterator + /// @return const_iterator /// const_reverse_column_iterator rcolbegin() const noexcept { @@ -1508,10 +1430,8 @@ namespace nc // Method Description: /// const iterator to the beginning of the input column /// - /// @param - /// inCol - /// @return - /// const_iterator + /// @param inCol + /// @return const_iterator /// const_reverse_column_iterator rcolbegin(size_type inCol) const { @@ -1522,8 +1442,7 @@ namespace nc // Method Description: /// const_reverse_column_iterator to the beginning of the flattened array /// - /// @return - /// const_reverse_column_iterator + /// @return const_reverse_column_iterator /// const_reverse_column_iterator crcolbegin() const noexcept { @@ -1534,10 +1453,8 @@ namespace nc // Method Description: /// const_reverse_column_iterator to the beginning of the input column /// - /// @param - /// inCol - /// @return - /// const_reverse_column_iterator + /// @param inCol + /// @return const_reverse_column_iterator /// const_reverse_column_iterator crcolbegin(size_type inCol) const { @@ -1552,8 +1469,7 @@ namespace nc //============================================================================ // Method Description: /// iterator to 1 past the end of the flattened array - /// @return - /// iterator + /// @return iterator /// iterator end() noexcept { @@ -1564,10 +1480,8 @@ namespace nc // Method Description: /// iterator to the 1 past end of the row /// - /// @param - /// inRow - /// @return - /// iterator + /// @param inRow + /// @return iterator /// iterator end(size_type inRow) { @@ -1582,8 +1496,7 @@ namespace nc //============================================================================ // Method Description: /// const iterator to 1 past the end of the flattened array - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator end() const noexcept { @@ -1594,10 +1507,8 @@ namespace nc // Method Description: /// const iterator to the 1 past end of the row /// - /// @param - /// inRow - /// @return - /// const_iterator + /// @param inRow + /// @return const_iterator /// const_iterator end(size_type inRow) const { @@ -1608,8 +1519,7 @@ namespace nc // Method Description: /// const iterator to 1 past the end of the flattened array /// - /// @return - /// const_iterator + /// @return const_iterator /// const_iterator cend() const noexcept { @@ -1620,10 +1530,8 @@ namespace nc // Method Description: /// const iterator to 1 past the end of the input row /// - /// @param - /// inRow - /// @return - /// const_iterator + /// @param inRow + /// @return const_iterator /// const_iterator cend(size_type inRow) const { @@ -1638,8 +1546,7 @@ namespace nc //============================================================================ // Method Description: /// reverse_iterator to 1 past the end of the flattened array - /// @return - /// reverse_iterator + /// @return reverse_iterator /// reverse_iterator rend() noexcept { @@ -1650,10 +1557,8 @@ namespace nc // Method Description: /// reverse_iterator to the 1 past end of the row /// - /// @param - /// inRow - /// @return - /// reverse_iterator + /// @param inRow + /// @return reverse_iterator /// reverse_iterator rend(size_type inRow) { @@ -1668,8 +1573,7 @@ namespace nc //============================================================================ // Method Description: /// const_reverse_iterator to 1 past the end of the flattened array - /// @return - /// const_reverse_iterator + /// @return const_reverse_iterator /// const_reverse_iterator rend() const noexcept { @@ -1680,10 +1584,8 @@ namespace nc // Method Description: /// const_reverse_iterator to the 1 past end of the row /// - /// @param - /// inRow - /// @return - /// const_reverse_iterator + /// @param inRow + /// @return const_reverse_iterator /// const_reverse_iterator rend(size_type inRow) const { @@ -1694,8 +1596,7 @@ namespace nc // Method Description: /// const_reverse_iterator to 1 past the end of the flattened array /// - /// @return - /// const_reverse_iterator + /// @return const_reverse_iterator /// const_reverse_iterator crend() const noexcept { @@ -1706,10 +1607,8 @@ namespace nc // Method Description: /// const_reverse_iterator to 1 past the end of the input row /// - /// @param - /// inRow - /// @return - /// const_reverse_iterator + /// @param inRow + /// @return const_reverse_iterator /// const_reverse_iterator crend(size_type inRow) const { @@ -1724,8 +1623,7 @@ namespace nc //============================================================================ // Method Description: /// column_iterator to 1 past the end of the flattened array - /// @return - /// column_iterator + /// @return column_iterator /// column_iterator colend() noexcept { @@ -1736,10 +1634,8 @@ namespace nc // Method Description: /// column_iterator to the 1 past end of the column /// - /// @param - /// inCol - /// @return - /// column_iterator + /// @param inCol + /// @return column_iterator /// column_iterator colend(size_type inCol) { @@ -1754,8 +1650,7 @@ namespace nc //============================================================================ // Method Description: /// const column_iterator to 1 past the end of the flattened array - /// @return - /// const_column_iterator + /// @return const_column_iterator /// const_column_iterator colend() const noexcept { @@ -1766,10 +1661,8 @@ namespace nc // Method Description: /// const column_iterator to the 1 past end of the column /// - /// @param - /// inCol - /// @return - /// const_column_iterator + /// @param inCol + /// @return const_column_iterator /// const_column_iterator colend(size_type inCol) const { @@ -1780,8 +1673,7 @@ namespace nc // Method Description: /// const_column_iterator to 1 past the end of the flattened array /// - /// @return - /// const_column_iterator + /// @return const_column_iterator /// const_column_iterator ccolend() const noexcept { @@ -1792,10 +1684,8 @@ namespace nc // Method Description: /// const_column_iterator to 1 past the end of the input col /// - /// @param - /// inCol - /// @return - /// const_column_iterator + /// @param inCol + /// @return const_column_iterator /// const_column_iterator ccolend(size_type inCol) const { @@ -1810,8 +1700,7 @@ namespace nc //============================================================================ // Method Description: /// reverse_column_iterator to 1 past the end of the flattened array - /// @return - /// reverse_column_iterator + /// @return reverse_column_iterator /// reverse_column_iterator rcolend() noexcept { @@ -1822,10 +1711,8 @@ namespace nc // Method Description: /// reverse_column_iterator to the 1 past end of the column /// - /// @param - /// inCol - /// @return - /// reverse_column_iterator + /// @param inCol + /// @return reverse_column_iterator /// reverse_column_iterator rcolend(size_type inCol) { @@ -1840,8 +1727,7 @@ namespace nc //============================================================================ // Method Description: /// const_reverse_column_iterator to 1 past the end of the flattened array - /// @return - /// const_reverse_column_iterator + /// @return const_reverse_column_iterator /// const_reverse_column_iterator rcolend() const noexcept { @@ -1852,10 +1738,8 @@ namespace nc // Method Description: /// const_reverse_column_iterator to the 1 past end of the column /// - /// @param - /// inCol - /// @return - /// const_reverse_column_iterator + /// @param inCol + /// @return const_reverse_column_iterator /// const_reverse_column_iterator rcolend(size_type inCol) const { @@ -1866,8 +1750,7 @@ namespace nc // Method Description: /// const_reverse_column_iterator to 1 past the end of the flattened array /// - /// @return - /// const_reverse_column_iterator + /// @return const_reverse_column_iterator /// const_reverse_column_iterator crcolend() const noexcept { @@ -1878,10 +1761,8 @@ namespace nc // Method Description: /// const_reverse_column_iterator to 1 past the end of the input col /// - /// @param - /// inCol - /// @return - /// const_reverse_column_iterator + /// @param inCol + /// @return const_reverse_column_iterator /// const_reverse_column_iterator crcolend(size_type inCol) const { @@ -1899,10 +1780,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.all.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray all(Axis inAxis = Axis::NONE) const { @@ -1955,10 +1834,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.any.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray any(Axis inAxis = Axis::NONE) const { @@ -2012,10 +1889,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argmax.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray argmax(Axis inAxis = Axis::NONE) const { @@ -2072,10 +1947,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argmin.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray argmin(Axis inAxis = Axis::NONE) const { @@ -2131,10 +2004,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.argsort.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray argsort(Axis inAxis = Axis::NONE) const { @@ -2217,8 +2088,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// - /// @return - /// NdArray + /// @return NdArray /// template, int> = 0, @@ -2244,8 +2114,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// - /// @return - /// NdArray + /// @return NdArray /// template, int> = 0, @@ -2272,8 +2141,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// - /// @return - /// NdArray + /// @return NdArray /// template, int> = 0, @@ -2307,8 +2175,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.astype.html /// - /// @return - /// NdArray + /// @return NdArray /// template, int> = 0, @@ -2332,8 +2199,7 @@ namespace nc // Method Description: /// Returns a copy of the last element of the flattened array. /// - /// @return - /// dtype + /// @return dtype /// const_reference back() const noexcept { @@ -2344,8 +2210,7 @@ namespace nc // Method Description: /// Returns a reference the last element of the flattened array. /// - /// @return - /// dtype + /// @return dtype /// reference back() noexcept { @@ -2356,8 +2221,7 @@ namespace nc // Method Description: /// Returns a copy of the last element of the input row. /// - /// @return - /// dtype + /// @return dtype /// const_reference back(size_type row) const { @@ -2368,8 +2232,7 @@ namespace nc // Method Description: /// Returns a reference the last element of the input row. /// - /// @return - /// dtype + /// @return dtype /// reference back(size_type row) { @@ -2382,8 +2245,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.byteswap.html /// - /// @return - /// NdArray + /// @return NdArray /// NdArray& byteswap() noexcept { @@ -2424,10 +2286,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.clip.html /// - /// @param inMin: min value to clip to - /// @param inMax: max value to clip to - /// @return - /// clipped value + /// @param inMin: min value to clip to + /// @param inMax: max value to clip to + /// @return clipped value /// NdArray clip(value_type inMin, value_type inMax) const { @@ -2466,8 +2327,7 @@ namespace nc /// Returns the full column of the array /// /// - /// @return - /// Shape + /// @return Shape /// NdArray column(uint32 inColumn) { @@ -2478,10 +2338,9 @@ namespace nc // Method Description: /// returns whether or not a value is included the array /// - /// @param inValue - /// @param inAxis (Optional, default NONE) - /// @return - /// bool + /// @param inValue + /// @param inAxis (Optional, default NONE) + /// @return bool /// NdArray contains(value_type inValue, Axis inAxis = Axis::NONE) const { @@ -2529,8 +2388,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.copy.html /// - /// @return - /// NdArray + /// @return NdArray /// NdArray copy() const { @@ -2543,10 +2401,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.cumprod.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray cumprod(Axis inAxis = Axis::NONE) const { @@ -2607,10 +2463,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.cumsum.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray cumsum(Axis inAxis = Axis::NONE) const { @@ -2704,10 +2558,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.diagonal.html /// - /// @param inOffset: Offset of the diagonal from the main diagonal. Can be both positive and negative. Defaults to 0. - /// @param inAxis: (Optional, default ROW) axis the offset is applied to - /// @return - /// NdArray + /// @param inOffset: Offset of the diagonal from the main diagonal. Can be both positive and negative. Defaults to 0. + /// @param inAxis: (Optional, default ROW) axis the offset is applied to + /// @return NdArray /// NdArray diagonal(int32 inOffset = 0, Axis inAxis = Axis::ROW) const { @@ -2774,10 +2627,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dot.html /// - /// @param - /// inOtherArray - /// @return - /// dot product + /// @param inOtherArray + /// @return dot product /// NdArray dot(const NdArray& inOtherArray) const { @@ -2821,7 +2672,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.dump.html /// - /// @param inFilename + /// @param inFilename /// void dump(const std::string& inFilename) const { @@ -2848,8 +2699,7 @@ namespace nc // Method Description: /// Return the NdArrays endianess /// - /// @return - /// Endian + /// @return Endian /// Endian endianess() const noexcept { @@ -2864,10 +2714,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.fill.html /// - /// @param - /// inFillValue - /// @return - /// None + /// @param inFillValue + /// @return None /// NdArray& fill(value_type inFillValue) noexcept { @@ -2880,8 +2728,7 @@ namespace nc /// Return the indices of the flattened array of the /// elements that are non-zero. /// - /// @return - /// NdArray + /// @return NdArray /// NdArray flatnonzero() const { @@ -2907,8 +2754,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.flatten.html /// - /// @return - /// NdArray + /// @return NdArray /// NdArray flatten() const { @@ -2921,8 +2767,7 @@ namespace nc // Method Description: /// Returns a copy of the first element of the flattened array. /// - /// @return - /// dtype + /// @return dtype /// const_reference front() const noexcept { @@ -2933,8 +2778,7 @@ namespace nc // Method Description: /// Returns a reference to the first element of the flattened array. /// - /// @return - /// dtype + /// @return dtype /// reference front() noexcept { @@ -2945,8 +2789,7 @@ namespace nc // Method Description: /// Returns a copy of the first element of the input row. /// - /// @return - /// dtype + /// @return dtype /// const_reference front(size_type row) const { @@ -2957,8 +2800,7 @@ namespace nc // Method Description: /// Returns a reference to the first element of the input row. /// - /// @return - /// dtype + /// @return dtype /// reference front(size_type row) { @@ -2969,10 +2811,8 @@ namespace nc // Method Description: /// Returns a new flat array with the givin flat input indices. /// - /// @param - /// inIndices - /// @return - /// values + /// @param inIndices + /// @return values /// NdArray getByIndices(const NdArray& inIndices) const { @@ -2985,10 +2825,8 @@ namespace nc /// and returns a flattened array with the values cooresponding /// to the input mask. /// - /// @param - /// inMask - /// @return - /// values + /// @param inMask + /// @return values /// NdArray getByMask(const NdArray& inMask) const { @@ -3000,8 +2838,7 @@ namespace nc /// Return if the NdArray is empty. ie the default construtor /// was used. /// - /// @return - /// boolean + /// @return boolean /// bool isempty() const noexcept { @@ -3013,8 +2850,7 @@ namespace nc /// Return if the NdArray is empty. ie the default construtor /// was used. /// - /// @return - /// boolean + /// @return boolean /// bool isflat() const noexcept { @@ -3090,8 +2926,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.item.html /// - /// @return - /// array element + /// @return array element /// value_type item() const { @@ -3109,10 +2944,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.max.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray max(Axis inAxis = Axis::NONE) const { @@ -3166,10 +2999,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.min.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray min(Axis inAxis = Axis::NONE) const { @@ -3225,10 +3056,8 @@ namespace nc /// If the dtype is integral then the middle elements will be intager /// averaged (rounded down to integer) for arrays of even number of elements. /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray median(Axis inAxis = Axis::NONE) const { @@ -3342,8 +3171,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.nbytes.html /// - /// @return - /// number of bytes + /// @return number of bytes /// uint64 nbytes() const noexcept { @@ -3357,10 +3185,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.newbyteorder.html /// - /// @param - /// inEndianess - /// @return - /// NdArray + /// @param inEndianess + /// @return NdArray /// NdArray newbyteorder(Endian inEndianess) const { @@ -3522,10 +3348,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.any.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray none(Axis inAxis = Axis::NONE) const { @@ -3579,8 +3403,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.nonzero.html /// - /// @return - /// std::pair where first is the row indices and second is the + /// @return std::pair where first is the row indices and second is the /// column indices /// std::pair, NdArray> nonzero() const; @@ -3590,8 +3413,7 @@ namespace nc /// Returns the number of columns in the array /// /// - /// @return - /// uint32 + /// @return uint32 /// uint32 numCols() const noexcept { @@ -3603,8 +3425,7 @@ namespace nc /// Returns the number of rows in the array /// /// - /// @return - /// uint32 + /// @return uint32 /// uint32 numRows() const noexcept { @@ -3646,10 +3467,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.partition.html /// - /// @param inKth: kth element - /// @param inAxis (Optional, default NONE) - /// @return - /// None + /// @param inKth: kth element + /// @param inAxis (Optional, default NONE) + /// @return None /// NdArray& partition(uint32 inKth, Axis inAxis = Axis::NONE) { @@ -3730,10 +3550,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.prod.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray prod(Axis inAxis = Axis::NONE) const { @@ -3785,10 +3603,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.ptp.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray ptp(Axis inAxis = Axis::NONE) const { @@ -3844,8 +3660,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inIndex - /// @param inValue + /// @param inIndex + /// @param inValue /// NdArray& put(int32 inIndex, value_type inValue) { @@ -3860,9 +3676,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRow - /// @param inCol - /// @param inValue + /// @param inRow + /// @param inCol + /// @param inValue /// NdArray& put(int32 inRow, int32 inCol, value_type inValue) { @@ -3877,8 +3693,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inIndices - /// @param inValue + /// @param inIndices + /// @param inValue /// NdArray& put(const NdArray& inIndices, value_type inValue) { @@ -3896,8 +3712,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inIndices - /// @param inValues + /// @param inIndices + /// @param inValues /// NdArray& put(const NdArray& inIndices, const NdArray& inValues) { @@ -3921,8 +3737,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inSlice - /// @param inValue + /// @param inSlice + /// @param inValue /// NdArray& put(const Slice& inSlice, value_type inValue) { @@ -3943,8 +3759,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inSlice - /// @param inValues + /// @param inSlice + /// @param inValues /// NdArray& put(const Slice& inSlice, const NdArray& inValues) { @@ -3966,9 +3782,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRowSlice - /// @param inColSlice - /// @param inValue + /// @param inRowSlice + /// @param inColSlice + /// @param inValue /// NdArray& put(const Slice& inRowSlice, const Slice& inColSlice, value_type inValue) { @@ -3996,9 +3812,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRowSlice - /// @param inColIndex - /// @param inValue + /// @param inRowSlice + /// @param inColIndex + /// @param inValue /// NdArray& put(const Slice& inRowSlice, int32 inColIndex, value_type inValue) { @@ -4020,9 +3836,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRowIndex - /// @param inColSlice - /// @param inValue + /// @param inRowIndex + /// @param inColSlice + /// @param inValue /// NdArray& put(int32 inRowIndex, const Slice& inColSlice, value_type inValue) { @@ -4044,9 +3860,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRowSlice - /// @param inColSlice - /// @param inValues + /// @param inRowSlice + /// @param inColSlice + /// @param inValues /// NdArray& put(const Slice& inRowSlice, const Slice& inColSlice, const NdArray& inValues) { @@ -4075,9 +3891,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRowSlice - /// @param inColIndex - /// @param inValues + /// @param inRowSlice + /// @param inColIndex + /// @param inValues /// NdArray& put(const Slice& inRowSlice, int32 inColIndex, const NdArray& inValues) { @@ -4100,9 +3916,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.put.html /// - /// @param inRowIndex - /// @param inColSlice - /// @param inValues + /// @param inRowIndex + /// @param inColSlice + /// @param inValues /// NdArray& put(int32 inRowIndex, const Slice& inColSlice, const NdArray& inValues) { @@ -4123,8 +3939,8 @@ namespace nc // Method Description: /// Set the mask indices to the input value. /// - /// @param inMask - /// @param inValue + /// @param inMask + /// @param inValue /// NdArray& putMask(const NdArray& inMask, value_type inValue) { @@ -4140,8 +3956,8 @@ namespace nc // Method Description: /// Set the mask indices to the input values. /// - /// @param inMask - /// @param inValues + /// @param inMask + /// @param inValues /// NdArray& putMask(const NdArray& inMask, const NdArray& inValues) { @@ -4173,10 +3989,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.repeat.html /// - /// @param inNumRows - /// @param inNumCols - /// @return - /// NdArray + /// @param inNumRows + /// @param inNumCols + /// @return NdArray /// NdArray repeat(uint32 inNumRows, uint32 inNumCols) const { @@ -4216,10 +4031,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.repeat.html /// - /// @param - /// inRepeatShape - /// @return - /// NdArray + /// @param inRepeatShape + /// @return NdArray /// NdArray repeat(const Shape& inRepeatShape) const { @@ -4230,8 +4043,8 @@ namespace nc // Method Description: /// Replaces a value of the array with another value /// - /// @param oldValue: the value to replace - /// @param newValue: the value to replace with + /// @param oldValue: the value to replace + /// @param newValue: the value to replace with /// void replace(value_type oldValue, value_type newValue) { @@ -4249,7 +4062,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.reshape.html /// - /// @param inSize + /// @param inSize /// NdArray& reshape(size_type inSize) { @@ -4275,8 +4088,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.reshape.html /// - /// @param inNumRows - /// @param inNumCols + /// @param inNumRows + /// @param inNumCols /// NdArray& reshape(int32 inNumRows, int32 inNumCols) { @@ -4328,8 +4141,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.reshape.html /// - /// @param - /// inShape + /// @param inShape /// NdArray& reshape(const Shape& inShape) { @@ -4343,8 +4155,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// - /// @param inNumRows - /// @param inNumCols + /// @param inNumRows + /// @param inNumCols /// NdArray& resizeFast(uint32 inNumRows, uint32 inNumCols) { @@ -4359,8 +4171,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// - /// @param - /// inShape + /// @param inShape /// NdArray& resizeFast(const Shape& inShape) { @@ -4376,8 +4187,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// - /// @param inNumRows - /// @param inNumCols + /// @param inNumRows + /// @param inNumCols /// NdArray& resizeSlow(uint32 inNumRows, uint32 inNumCols) { @@ -4416,8 +4227,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.resize.html /// - /// @param - /// inShape + /// @param inShape /// NdArray& resizeSlow(const Shape& inShape) { @@ -4431,10 +4241,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.round.html /// - /// @param - /// inNumDecimals (default 0) - /// @return - /// NdArray + /// @param inNumDecimals (default 0) + /// @return NdArray /// NdArray round(uint8 inNumDecimals = 0) const { @@ -4457,8 +4265,7 @@ namespace nc /// Returns the full row of the array /// /// - /// @return - /// Shape + /// @return Shape /// NdArray row(uint32 inRow) { @@ -4471,8 +4278,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.shape.html /// - /// @return - /// Shape + /// @return Shape /// Shape shape() const noexcept { @@ -4485,8 +4291,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.size.html /// - /// @return - /// size + /// @return size /// size_type size() const noexcept { @@ -4499,10 +4304,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.sort.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// size + /// @param inAxis (Optional, default NONE) + /// @return size /// NdArray& sort(Axis inAxis = Axis::NONE) { @@ -4548,8 +4351,7 @@ namespace nc // Method Description: /// returns the NdArray as a string representation /// - /// @return - /// string + /// @return string /// std::string str() const { @@ -4584,10 +4386,8 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.sum.html /// - /// @param - /// inAxis (Optional, default NONE) - /// @return - /// NdArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// NdArray sum(Axis inAxis = Axis::NONE) const { @@ -4636,8 +4436,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.swapaxes.html /// - /// @return - /// NdArray + /// @return NdArray /// NdArray swapaxes() const { @@ -4652,10 +4451,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.tofile.html /// - /// @param inFilename + /// @param inFilename - /// @return - /// None + /// @return None /// void tofile(const std::string& inFilename) const { @@ -4670,10 +4468,9 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.tofile.html /// - /// @param inFilename - /// @param inSep: Separator between array items for text output. - /// @return - /// None + /// @param inFilename + /// @param inSep: Separator between array items for text output. + /// @return None /// void tofile(const std::string& inFilename, const char inSep) const { @@ -4758,8 +4555,7 @@ namespace nc // Method Description: /// Write flattened array to an STL vector /// - /// @return - /// std::vector + /// @return std::vector /// std::vector toStlVector() const { @@ -4772,11 +4568,10 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.trace.html /// - /// @param inOffset: Offset of the diagonal from the main diagonal. Can be both positive and negative. Defaults to 0. - /// @param inAxis: (Optional, default ROW) Axis to offset from + /// @param inOffset: Offset of the diagonal from the main diagonal. Can be both positive and negative. Defaults to 0. + /// @param inAxis: (Optional, default ROW) Axis to offset from /// - /// @return - /// value + /// @return value /// value_type trace(uint32 inOffset = 0, Axis inAxis = Axis::ROW) const noexcept { @@ -4829,8 +4624,7 @@ namespace nc /// /// Numpy Reference: https://www.numpy.org/devdocs/reference/generated/numpy.ndarray.transpose.html /// - /// @return - /// NdArray + /// @return NdArray /// NdArray transpose() const { @@ -4902,8 +4696,7 @@ namespace nc // Method Description: /// Creates a new internal array /// - /// @param - /// inShape + /// @param inShape /// void newArray(const Shape& inShape) { diff --git a/include/NumCpp/NdArray/NdArrayOperators.hpp b/include/NumCpp/NdArray/NdArrayOperators.hpp index 0b6eddeb2..59ad83bd2 100644 --- a/include/NumCpp/NdArray/NdArrayOperators.hpp +++ b/include/NumCpp/NdArray/NdArrayOperators.hpp @@ -47,9 +47,9 @@ namespace nc // Method Description: /// Adds the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator+=(NdArray& lhs, const NdArray& rhs) @@ -71,9 +71,9 @@ namespace nc // Method Description: /// Adds the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator+=(NdArray>& lhs, const NdArray& rhs) @@ -100,10 +100,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (3) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator+=(NdArray& lhs, dtype rhs) @@ -124,10 +123,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (4) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator+=(NdArray>& lhs, dtype rhs) @@ -148,9 +146,9 @@ namespace nc // Method Description: /// Adds the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator+(const NdArray& lhs, const NdArray& rhs) @@ -174,9 +172,9 @@ namespace nc // Method Description: /// Adds the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator+(const NdArray& lhs, const NdArray>& rhs) @@ -205,9 +203,9 @@ namespace nc // Method Description: /// Adds the elements of two arrays (3) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator+(const NdArray>& lhs, const NdArray& rhs) @@ -219,9 +217,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (4) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator+(const NdArray& lhs, dtype rhs) @@ -244,9 +242,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (5) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator+(dtype lhs, const NdArray& rhs) @@ -258,9 +256,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (6) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator+(const NdArray& lhs, const std::complex& rhs) @@ -283,9 +281,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (7) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator+(const std::complex& lhs, const NdArray& rhs) @@ -297,9 +295,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (8) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator+(const NdArray>& lhs, dtype rhs) @@ -322,9 +320,9 @@ namespace nc // Method Description: /// Adds the scaler to the array (9) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator+(dtype lhs, const NdArray>& rhs) @@ -336,9 +334,9 @@ namespace nc // Method Description: /// Subtracts the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator-=(NdArray& lhs, const NdArray& rhs) @@ -360,9 +358,9 @@ namespace nc // Method Description: /// Subtracts the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator-=(NdArray>& lhs, const NdArray& rhs) @@ -389,10 +387,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (3) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator-=(NdArray& lhs, dtype rhs) @@ -413,10 +410,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (4) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator-=(NdArray>& lhs, dtype rhs) @@ -437,9 +433,9 @@ namespace nc // Method Description: /// Subtracts the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator-(const NdArray& lhs, const NdArray& rhs) @@ -463,9 +459,9 @@ namespace nc // Method Description: /// Subtracts the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator-(const NdArray& lhs, const NdArray>& rhs) @@ -494,9 +490,9 @@ namespace nc // Method Description: /// Subtracts the elements of two arrays (3) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator-(const NdArray>& lhs, const NdArray& rhs) @@ -525,9 +521,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (4) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator-(const NdArray& lhs, dtype rhs) @@ -550,9 +546,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (5) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator-(dtype lhs, const NdArray& rhs) @@ -575,9 +571,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (6) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator-(const NdArray& lhs, const std::complex& rhs) @@ -600,9 +596,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (7) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator-(const std::complex& lhs, const NdArray& rhs) @@ -625,9 +621,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (8) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator-(const NdArray>& lhs, dtype rhs) @@ -650,9 +646,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the array (9) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator-(dtype lhs, const NdArray>& rhs) @@ -675,7 +671,7 @@ namespace nc // Method Description: /// Negative Operator /// - /// @return NdArray + /// @return NdArray /// template NdArray operator-(const NdArray& inArray) @@ -694,9 +690,9 @@ namespace nc // Method Description: /// Multiplies the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator*=(NdArray& lhs, const NdArray& rhs) @@ -718,9 +714,9 @@ namespace nc // Method Description: /// Multiplies the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator*=(NdArray>& lhs, const NdArray& rhs) @@ -747,10 +743,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (3) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator*=(NdArray& lhs, dtype rhs) @@ -771,10 +766,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (4) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator*=(NdArray>& lhs, dtype rhs) @@ -795,9 +789,9 @@ namespace nc // Method Description: /// Multiplies the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator*(const NdArray& lhs, const NdArray& rhs) @@ -821,9 +815,9 @@ namespace nc // Method Description: /// Multiplies the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator*(const NdArray& lhs, const NdArray>& rhs) @@ -852,9 +846,9 @@ namespace nc // Method Description: /// Multiplies the elements of two arrays (3) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator*(const NdArray>& lhs, const NdArray& rhs) @@ -866,9 +860,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (4) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator*(const NdArray& lhs, dtype rhs) @@ -891,9 +885,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (5) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator*(dtype lhs, const NdArray& rhs) @@ -905,9 +899,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (6) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator*(const NdArray& lhs, const std::complex& rhs) @@ -930,9 +924,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (7) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator*(const std::complex& lhs, const NdArray& rhs) @@ -944,9 +938,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (8) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator*(const NdArray>& lhs, dtype rhs) @@ -969,9 +963,9 @@ namespace nc // Method Description: /// Multiplies the scaler to the array (9) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator*(dtype lhs, const NdArray>& rhs) @@ -983,9 +977,9 @@ namespace nc // Method Description: /// Divides the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator/=(NdArray& lhs, const NdArray& rhs) @@ -1007,9 +1001,9 @@ namespace nc // Method Description: /// Divides the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator/=(NdArray>& lhs, const NdArray& rhs) @@ -1036,10 +1030,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (3) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator/=(NdArray& lhs, dtype rhs) @@ -1060,10 +1053,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (4) /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray>& operator/=(NdArray>& lhs, dtype rhs) @@ -1084,9 +1076,9 @@ namespace nc // Method Description: /// Divides the elements of two arrays (1) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator/(const NdArray& lhs, const NdArray& rhs) @@ -1110,9 +1102,9 @@ namespace nc // Method Description: /// Divides the elements of two arrays (2) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator/(const NdArray& lhs, const NdArray>& rhs) @@ -1141,9 +1133,9 @@ namespace nc // Method Description: /// Divides the elements of two arrays (3) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator/(const NdArray>& lhs, const NdArray& rhs) @@ -1172,9 +1164,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (4) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator/(const NdArray& lhs, dtype rhs) @@ -1197,9 +1189,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (5) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator/(dtype lhs, const NdArray& rhs) @@ -1222,9 +1214,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (6) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator/(const NdArray& lhs, const std::complex& rhs) @@ -1247,9 +1239,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (7) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator/(const std::complex& lhs, const NdArray& rhs) @@ -1272,9 +1264,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (8) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator/(const NdArray>& lhs, dtype rhs) @@ -1297,9 +1289,9 @@ namespace nc // Method Description: /// Divides the scaler from the array (9) /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray> operator/(dtype lhs, const NdArray>& rhs) @@ -1322,9 +1314,9 @@ namespace nc // Method Description: /// Modulus the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template::value, int> = 0> @@ -1344,9 +1336,9 @@ namespace nc // Method Description: /// Modulus the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template::value, int> = 0> @@ -1371,10 +1363,9 @@ namespace nc // Method Description: /// Modulus the scaler to the array /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template::value, int> = 0> @@ -1394,10 +1385,9 @@ namespace nc // Method Description: /// Modulus the scaler to the array /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template::value, int> = 0> @@ -1417,9 +1407,9 @@ namespace nc // Method Description: /// Takes the modulus of the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator%(const NdArray& lhs, const NdArray& rhs) @@ -1433,9 +1423,9 @@ namespace nc // Method Description: /// Modulus of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator%(const NdArray& lhs, dtype rhs) @@ -1449,9 +1439,9 @@ namespace nc // Method Description: /// Modulus of the scaler and the array /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template::value, int> = 0> @@ -1471,9 +1461,9 @@ namespace nc // Method Description: /// Modulus of the scaler and the array /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template::value, int> = 0> @@ -1493,9 +1483,9 @@ namespace nc // Method Description: /// Bitwise or the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator|=(NdArray& lhs, const NdArray& rhs) @@ -1517,10 +1507,9 @@ namespace nc // Method Description: /// Bitwise or the scaler to the array /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator|=(NdArray& lhs, dtype rhs) @@ -1541,9 +1530,9 @@ namespace nc // Method Description: /// Takes the bitwise or of the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator|(const NdArray& lhs, const NdArray& rhs) @@ -1557,9 +1546,9 @@ namespace nc // Method Description: /// Takes the bitwise or of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator|(const NdArray& lhs, dtype rhs) @@ -1573,9 +1562,9 @@ namespace nc // Method Description: /// Takes the bitwise or of the sclar and the array /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator|(dtype lhs, const NdArray& rhs) @@ -1587,9 +1576,9 @@ namespace nc // Method Description: /// Bitwise and the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator&=(NdArray& lhs, const NdArray& rhs) @@ -1611,10 +1600,9 @@ namespace nc // Method Description: /// Bitwise and the scaler to the array /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator&=(NdArray& lhs, dtype rhs) @@ -1635,9 +1623,9 @@ namespace nc // Method Description: /// Takes the bitwise and of the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator&(const NdArray& lhs, const NdArray& rhs) @@ -1651,9 +1639,9 @@ namespace nc // Method Description: /// Takes the bitwise and of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator&(const NdArray& lhs, dtype rhs) @@ -1667,9 +1655,9 @@ namespace nc // Method Description: /// Takes the bitwise and of the sclar and the array /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator&(dtype lhs, const NdArray& rhs) @@ -1681,9 +1669,9 @@ namespace nc // Method Description: /// Bitwise xor the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator^=(NdArray& lhs, const NdArray& rhs) @@ -1705,10 +1693,9 @@ namespace nc // Method Description: /// Bitwise xor the scaler to the array /// - /// @param lhs - /// @param rhs - /// @return - /// NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray& operator^=(NdArray& lhs, dtype rhs) @@ -1729,9 +1716,9 @@ namespace nc // Method Description: /// Takes the bitwise xor of the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator^(const NdArray& lhs, const NdArray& rhs) @@ -1745,9 +1732,9 @@ namespace nc // Method Description: /// Takes the bitwise xor of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator^(const NdArray& lhs, dtype rhs) @@ -1761,9 +1748,9 @@ namespace nc // Method Description: /// Takes the bitwise xor of the sclar and the array /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator^(dtype lhs, const NdArray& rhs) @@ -1775,8 +1762,8 @@ namespace nc // Method Description: /// Takes the bitwise not of the array /// - /// @param inArray - /// @return NdArray + /// @param inArray + /// @return NdArray /// template NdArray operator~(const NdArray& inArray) @@ -1800,9 +1787,9 @@ namespace nc // Method Description: /// Takes the and of the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator&&(const NdArray& lhs, const NdArray& rhs) @@ -1830,9 +1817,9 @@ namespace nc // Method Description: /// Takes the and of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator&&(const NdArray& lhs, dtype rhs) @@ -1856,9 +1843,9 @@ namespace nc // Method Description: /// Takes the and of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator&&(dtype lhs, const NdArray& rhs) @@ -1870,9 +1857,9 @@ namespace nc // Method Description: /// Takes the or of the elements of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator||(const NdArray& lhs, const NdArray& rhs) @@ -1900,9 +1887,9 @@ namespace nc // Method Description: /// Takes the or of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator||(const NdArray& lhs, dtype rhs) @@ -1926,9 +1913,9 @@ namespace nc // Method Description: /// Takes the or of the array and the scaler /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator||(dtype lhs, const NdArray& rhs) @@ -1940,8 +1927,8 @@ namespace nc // Method Description: /// Takes the not of the array /// - /// @param inArray - /// @return NdArray + /// @param inArray + /// @return NdArray /// template NdArray operator!(const NdArray& inArray) @@ -1966,9 +1953,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator==(const NdArray& lhs, const NdArray& rhs) @@ -1996,9 +1983,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// an array and a scaler /// - /// @param lhs - /// @param inValue - /// @return NdArray + /// @param lhs + /// @param inValue + /// @return NdArray /// template NdArray operator==(const NdArray& lhs, dtype inValue) @@ -2021,9 +2008,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// an array and a scaler /// - /// @param inValue - /// @param inArray - /// @return NdArray + /// @param inValue + /// @param inArray + /// @return NdArray /// template NdArray operator==(dtype inValue, const NdArray& inArray) @@ -2036,9 +2023,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator!=(const NdArray& lhs, const NdArray& rhs) @@ -2066,9 +2053,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// an array and a scaler /// - /// @param lhs - /// @param inValue - /// @return NdArray + /// @param lhs + /// @param inValue + /// @return NdArray /// template NdArray operator!=(const NdArray& lhs, dtype inValue) @@ -2091,9 +2078,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// an array and a scaler /// - /// @param inValue - /// @param inArray - /// @return NdArray + /// @param inValue + /// @param inArray + /// @return NdArray /// template NdArray operator!=(dtype inValue, const NdArray& inArray) @@ -2106,9 +2093,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator<(const NdArray& lhs, const NdArray& rhs) @@ -2138,9 +2125,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param lhs - /// @param inValue - /// @return NdArray + /// @param lhs + /// @param inValue + /// @return NdArray /// template NdArray operator<(const NdArray& lhs, dtype inValue) @@ -2165,9 +2152,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param inValue - /// @param inArray - /// @return NdArray + /// @param inValue + /// @param inArray + /// @return NdArray /// template NdArray operator<(dtype inValue, const NdArray& inArray) @@ -2192,9 +2179,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator>(const NdArray& lhs, const NdArray& rhs) @@ -2227,9 +2214,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param lhs - /// @param inValue - /// @return NdArray + /// @param lhs + /// @param inValue + /// @return NdArray /// template NdArray operator>(const NdArray& lhs, dtype inValue) @@ -2254,9 +2241,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param inValue - /// @param inArray - /// @return NdArray + /// @param inValue + /// @param inArray + /// @return NdArray /// template NdArray operator>(dtype inValue, const NdArray& inArray) @@ -2281,9 +2268,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator<=(const NdArray& lhs, const NdArray& rhs) @@ -2313,9 +2300,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param lhs - /// @param inValue - /// @return NdArray + /// @param lhs + /// @param inValue + /// @return NdArray /// template NdArray operator<=(const NdArray& lhs, dtype inValue) @@ -2340,9 +2327,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param inValue - /// @param inArray - /// @return NdArray + /// @param inValue + /// @param inArray + /// @return NdArray /// template NdArray operator<=(dtype inValue, const NdArray& inArray) @@ -2367,9 +2354,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// of two arrays /// - /// @param lhs - /// @param rhs - /// @return NdArray + /// @param lhs + /// @param rhs + /// @return NdArray /// template NdArray operator>=(const NdArray& lhs, const NdArray& rhs) @@ -2399,9 +2386,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param lhs - /// @param inValue - /// @return NdArray + /// @param lhs + /// @param inValue + /// @return NdArray /// template NdArray operator>=(const NdArray& lhs, dtype inValue) @@ -2426,9 +2413,9 @@ namespace nc /// Returns an array of booleans of element wise comparison /// the array and a scaler /// - /// @param inValue - /// @param inArray - /// @return NdArray + /// @param inValue + /// @param inArray + /// @return NdArray /// template NdArray operator>=(dtype inValue, const NdArray& inArray) @@ -2452,10 +2439,9 @@ namespace nc // Method Description: /// Bitshifts left the elements of the array /// - /// @param lhs - /// @param inNumBits - /// @return - /// NdArray + /// @param lhs + /// @param inNumBits + /// @return NdArray /// template NdArray& operator<<=(NdArray& lhs, uint8 inNumBits) @@ -2476,10 +2462,9 @@ namespace nc // Method Description: /// Bitshifts left the elements of the array /// - /// @param lhs - /// @param inNumBits - /// @return - /// NdArray + /// @param lhs + /// @param inNumBits + /// @return NdArray /// template NdArray operator<<(const NdArray& lhs, uint8 inNumBits) @@ -2495,10 +2480,9 @@ namespace nc // Method Description: /// Bitshifts right the elements of the array /// - /// @param lhs - /// @param inNumBits - /// @return - /// NdArray + /// @param lhs + /// @param inNumBits + /// @return NdArray /// template NdArray& operator>>=(NdArray& lhs, uint8 inNumBits) @@ -2519,10 +2503,9 @@ namespace nc // Method Description: /// Bitshifts right the elements of the array /// - /// @param lhs - /// @param inNumBits - /// @return - /// NdArray + /// @param lhs + /// @param inNumBits + /// @return NdArray /// template NdArray operator>>(const NdArray& lhs, uint8 inNumBits) @@ -2538,8 +2521,7 @@ namespace nc // Method Description: /// prefix incraments the elements of an array /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& operator++(NdArray& rhs) @@ -2560,9 +2542,8 @@ namespace nc // Method Description: /// postfix increments the elements of an array /// - /// @param lhs - /// @return - /// NdArray + /// @param lhs + /// @return NdArray /// template NdArray operator++(NdArray& lhs, int) @@ -2576,8 +2557,7 @@ namespace nc // Method Description: /// prefix decrements the elements of an array /// - /// @return - /// NdArray + /// @return NdArray /// template NdArray& operator--(NdArray& rhs) @@ -2598,9 +2578,8 @@ namespace nc // Method Description: /// postfix decrements the elements of an array /// - /// @param lhs - /// @return - /// NdArray + /// @param lhs + /// @return NdArray /// template NdArray operator--(NdArray& lhs, int) @@ -2614,10 +2593,9 @@ namespace nc // Method Description: /// io operator for the NdArray class /// - /// @param inOStream - /// @param inArray - /// @return - /// std::ostream + /// @param inOStream + /// @param inArray + /// @return std::ostream /// template std::ostream& operator<<(std::ostream& inOStream, const NdArray& inArray) diff --git a/include/NumCpp/Polynomial/Poly1d.hpp b/include/NumCpp/Polynomial/Poly1d.hpp index 780c4bac2..527362aa3 100644 --- a/include/NumCpp/Polynomial/Poly1d.hpp +++ b/include/NumCpp/Polynomial/Poly1d.hpp @@ -71,9 +71,9 @@ namespace nc // Method Description: /// Constructor /// - /// @param inValues: (polynomial coefficients in ascending order of power if second input is false, + /// @param inValues: (polynomial coefficients in ascending order of power if second input is false, /// polynomial roots if second input is true) - /// @param isRoots + /// @param isRoots /// Poly1d(const NdArray& inValues, bool isRoots = false) { @@ -144,8 +144,7 @@ namespace nc // Method Description: /// Returns the Poly1d coefficients /// - /// @return - /// NdArray + /// @return NdArray /// NdArray coefficients() const { @@ -343,8 +342,7 @@ namespace nc // Method Description: /// Returns the order of the Poly1d /// - /// @return - /// NdArray + /// @return NdArray /// uint32 order() const noexcept { @@ -365,8 +363,7 @@ namespace nc // Method Description: /// Converts the polynomial to a string representation /// - /// @return - /// Poly1d + /// @return Poly1d /// std::string str() const { @@ -419,10 +416,8 @@ namespace nc // Method Description: /// Evaluates the Poly1D object for the input value /// - /// @param - /// inValue - /// @return - /// Poly1d + /// @param inValue + /// @return Poly1d /// dtype operator()(dtype inValue) const noexcept { @@ -440,10 +435,8 @@ namespace nc // Method Description: /// Adds the two Poly1d objects /// - /// @param - /// inOtherPoly - /// @return - /// Poly1d + /// @param inOtherPoly + /// @return Poly1d /// Poly1d operator+(const Poly1d& inOtherPoly) const { @@ -454,10 +447,8 @@ namespace nc // Method Description: /// Adds the two Poly1d objects /// - /// @param - /// inOtherPoly - /// @return - /// Poly1d + /// @param inOtherPoly + /// @return Poly1d /// Poly1d& operator+=(const Poly1d& inOtherPoly) { @@ -487,10 +478,8 @@ namespace nc // Method Description: /// Subtracts the two Poly1d objects /// - /// @param - /// inOtherPoly - /// @return - /// Poly1d + /// @param inOtherPoly + /// @return Poly1d /// Poly1d operator-(const Poly1d& inOtherPoly) const { @@ -501,10 +490,8 @@ namespace nc // Method Description: /// Subtracts the two Poly1d objects /// - /// @param - /// inOtherPoly - /// @return - /// Poly1d + /// @param inOtherPoly + /// @return Poly1d /// Poly1d& operator-=(const Poly1d& inOtherPoly) { @@ -534,10 +521,8 @@ namespace nc // Method Description: /// Multiplies the two Poly1d objects /// - /// @param - /// inOtherPoly - /// @return - /// Poly1d + /// @param inOtherPoly + /// @return Poly1d /// Poly1d operator*(const Poly1d& inOtherPoly) const { @@ -548,10 +533,8 @@ namespace nc // Method Description: /// Multiplies the two Poly1d objects /// - /// @param - /// inOtherPoly - /// @return - /// Poly1d + /// @param inOtherPoly + /// @return Poly1d /// Poly1d& operator*=(const Poly1d& inOtherPoly) { @@ -579,10 +562,8 @@ namespace nc // Method Description: /// Raise the Poly1d to an integer power /// - /// @param - /// inPower - /// @return - /// Poly1d + /// @param inPower + /// @return Poly1d /// Poly1d operator^(uint32 inPower) const { @@ -593,10 +574,8 @@ namespace nc // Method Description: /// Raise the Poly1d to an integer power /// - /// @param - /// inPower - /// @return - /// Poly1d + /// @param inPower + /// @return Poly1d /// Poly1d& operator^=(uint32 inPower) { @@ -624,10 +603,9 @@ namespace nc // Method Description: /// io operator for the Poly1d class /// - /// @param inOStream - /// @param inPoly - /// @return - /// std::ostream + /// @param inOStream + /// @param inPoly + /// @return std::ostream /// friend std::ostream& operator<<(std::ostream& inOStream, const Poly1d& inPoly) { diff --git a/include/NumCpp/Polynomial/chebyshev_t.hpp b/include/NumCpp/Polynomial/chebyshev_t.hpp index 18f880fff..18cc8cf05 100644 --- a/include/NumCpp/Polynomial/chebyshev_t.hpp +++ b/include/NumCpp/Polynomial/chebyshev_t.hpp @@ -44,10 +44,9 @@ namespace nc /// Chebyshev Polynomial of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: the order of the chebyshev polynomial - /// @param x: the input value - /// @return - /// double + /// @param n: the order of the chebyshev polynomial + /// @param x: the input value + /// @return double /// template double chebyshev_t(uint32 n, dtype x) @@ -62,10 +61,9 @@ namespace nc /// Chebyshev Polynomial of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: the order of the chebyshev polynomial - /// @param inArrayX: the input value - /// @return - /// NdArray + /// @param n: the order of the chebyshev polynomial + /// @param inArrayX: the input value + /// @return NdArray /// template NdArray chebyshev_t(uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/chebyshev_u.hpp b/include/NumCpp/Polynomial/chebyshev_u.hpp index 0e5545d95..8711dfb70 100644 --- a/include/NumCpp/Polynomial/chebyshev_u.hpp +++ b/include/NumCpp/Polynomial/chebyshev_u.hpp @@ -44,10 +44,9 @@ namespace nc /// Chebyshev Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: the order of the chebyshev polynomial - /// @param x: the input value - /// @return - /// double + /// @param n: the order of the chebyshev polynomial + /// @param x: the input value + /// @return double /// template double chebyshev_u(uint32 n, dtype x) @@ -62,10 +61,9 @@ namespace nc /// Chebyshev Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: the order of the chebyshev polynomial - /// @param inArrayX: the input value - /// @return - /// NdArray + /// @param n: the order of the chebyshev polynomial + /// @param inArrayX: the input value + /// @return NdArray /// template NdArray chebyshev_u(uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/hermite.hpp b/include/NumCpp/Polynomial/hermite.hpp index 8ef642c5b..dabdfa7ee 100644 --- a/include/NumCpp/Polynomial/hermite.hpp +++ b/include/NumCpp/Polynomial/hermite.hpp @@ -49,10 +49,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the order of the hermite polynomial - /// @param x: the input value - /// @return - /// double + /// @param n: the order of the hermite polynomial + /// @param x: the input value + /// @return double /// template double hermite(uint32 n, dtype x) @@ -72,10 +71,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the order of the hermite polynomial - /// @param inArrayX: the input value - /// @return - /// NdArray + /// @param n: the order of the hermite polynomial + /// @param inArrayX: the input value + /// @return NdArray /// template NdArray hermite(uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/laguerre.hpp b/include/NumCpp/Polynomial/laguerre.hpp index 4330abdd5..71c3643b2 100644 --- a/include/NumCpp/Polynomial/laguerre.hpp +++ b/include/NumCpp/Polynomial/laguerre.hpp @@ -49,10 +49,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the order of the leguerre polynomial - /// @param x: the input value - /// @return - /// double + /// @param n: the order of the leguerre polynomial + /// @param x: the input value + /// @return double /// template double laguerre(uint32 n, dtype x) @@ -72,11 +71,10 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the order of the leguerre polynomial - /// @param m: the degree of the legendre polynomial - /// @param x: the input value - /// @return - /// double + /// @param n: the order of the leguerre polynomial + /// @param m: the degree of the legendre polynomial + /// @param x: the input value + /// @return double /// template double laguerre(uint32 n, uint32 m, dtype x) @@ -96,10 +94,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the order of the leguerre polynomial - /// @param inArrayX: the input value - /// @return - /// NdArray + /// @param n: the order of the leguerre polynomial + /// @param inArrayX: the input value + /// @return NdArray /// template NdArray laguerre(uint32 n, const NdArray& inArrayX) @@ -122,11 +119,10 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the order of the leguerre polynomial - /// @param m: the degree of the legendre polynomial - /// @param inArrayX: the input value - /// @return - /// NdArray + /// @param n: the order of the leguerre polynomial + /// @param m: the degree of the legendre polynomial + /// @param inArrayX: the input value + /// @return NdArray /// template NdArray laguerre(uint32 n, uint32 m, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/legendre_p.hpp b/include/NumCpp/Polynomial/legendre_p.hpp index 89252c2fa..55381495e 100644 --- a/include/NumCpp/Polynomial/legendre_p.hpp +++ b/include/NumCpp/Polynomial/legendre_p.hpp @@ -50,10 +50,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the degree of the legendre polynomial - /// @param x: the input value. Requires -1 <= x <= 1 - /// @return - /// double + /// @param n: the degree of the legendre polynomial + /// @param x: the input value. Requires -1 <= x <= 1 + /// @return double /// template double legendre_p(uint32 n, dtype x) @@ -78,11 +77,10 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param m: the order of the legendre polynomial - /// @param n: the degree of the legendre polynomial - /// @param x: the input value. Requires -1 <= x <= 1 - /// @return - /// double + /// @param m: the order of the legendre polynomial + /// @param n: the degree of the legendre polynomial + /// @param x: the input value. Requires -1 <= x <= 1 + /// @return double /// template double legendre_p(uint32 m, uint32 n, dtype x) @@ -137,10 +135,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param n: the degree of the legendre polynomial - /// @param inArrayX: the input value. Requires -1 <= x <= 1 - /// @return - /// NdArray + /// @param n: the degree of the legendre polynomial + /// @param inArrayX: the input value. Requires -1 <= x <= 1 + /// @return NdArray /// template NdArray legendre_p(uint32 n, const NdArray& inArrayX) @@ -163,11 +160,10 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param m: the order of the legendre polynomial - /// @param n: the degree of the legendre polynomial - /// @param inArrayX: the input value. Requires -1 <= x <= 1 - /// @return - /// NdArray + /// @param m: the order of the legendre polynomial + /// @param n: the degree of the legendre polynomial + /// @param inArrayX: the input value. Requires -1 <= x <= 1 + /// @return NdArray /// template NdArray legendre_p(uint32 m, uint32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/legendre_q.hpp b/include/NumCpp/Polynomial/legendre_q.hpp index 38a9e8b0d..f5fb78c96 100644 --- a/include/NumCpp/Polynomial/legendre_q.hpp +++ b/include/NumCpp/Polynomial/legendre_q.hpp @@ -44,10 +44,9 @@ namespace nc /// Legendre Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: the order of the legendre polynomial - /// @param x: the input value. Requires -1 <= x <= 1 - /// @return - /// double + /// @param n: the order of the legendre polynomial + /// @param x: the input value. Requires -1 <= x <= 1 + /// @return double /// template double legendre_q(int32 n, dtype x) @@ -67,10 +66,9 @@ namespace nc /// Legendre Polynomial of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: the order of the legendre polynomial - /// @param inArrayX: the input value. Requires -1 <= x <= 1 - /// @return - /// NdArray + /// @param n: the order of the legendre polynomial + /// @param inArrayX: the input value. Requires -1 <= x <= 1 + /// @return NdArray /// template NdArray legendre_q(int32 n, const NdArray& inArrayX) diff --git a/include/NumCpp/Polynomial/spherical_harmonic.hpp b/include/NumCpp/Polynomial/spherical_harmonic.hpp index cc108a952..fc18a28f7 100644 --- a/include/NumCpp/Polynomial/spherical_harmonic.hpp +++ b/include/NumCpp/Polynomial/spherical_harmonic.hpp @@ -48,12 +48,11 @@ namespace nc /// symmetry is not present. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: order of the harmonic - /// @param m: degree of the harmonic - /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. - /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. - /// @return - /// double + /// @param n: order of the harmonic + /// @param m: degree of the harmonic + /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. + /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. + /// @return double /// template std::complex spherical_harmonic(uint32 n, int32 m, dtype1 theta, dtype2 phi) @@ -72,12 +71,11 @@ namespace nc /// symmetry is not present. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: order of the harmonic - /// @param m: degree of the harmonic - /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. - /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. - /// @return - /// double + /// @param n: order of the harmonic + /// @param m: degree of the harmonic + /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. + /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. + /// @return double /// template double spherical_harmonic_r(uint32 n, int32 m, dtype1 theta, dtype2 phi) @@ -96,12 +94,11 @@ namespace nc /// symmetry is not present. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param n: order of the harmonic - /// @param m: degree of the harmonic - /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. - /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. - /// @return - /// double + /// @param n: order of the harmonic + /// @param m: degree of the harmonic + /// @param theta: Azimuthal (longitudinal) coordinate; must be in [0, 2*pi]. + /// @param phi: Polar (colatitudinal) coordinate; must be in [0, pi]. + /// @return double /// template double spherical_harmonic_i(uint32 n, int32 m, dtype1 theta, dtype2 phi) diff --git a/include/NumCpp/PythonInterface/BoostInterface.hpp b/include/NumCpp/PythonInterface/BoostInterface.hpp index 121accdce..1a25a60b7 100644 --- a/include/NumCpp/PythonInterface/BoostInterface.hpp +++ b/include/NumCpp/PythonInterface/BoostInterface.hpp @@ -47,9 +47,9 @@ namespace nc //============================================================================ /// Converts from a boost ndarray to a NumCpp NdArray /// - /// @param inArray + /// @param inArray /// - /// @return NdArray + /// @return NdArray /// template inline NdArray boost2Nc(const boost::python::numpy::ndarray& inArray) @@ -93,9 +93,9 @@ namespace nc //============================================================================ /// Converts from a NumCpp NdArray to a boost ndarray /// - /// @param inArray + /// @param inArray /// - /// @return ndarray + /// @return ndarray /// template inline boost::python::numpy::ndarray nc2Boost(const NdArray& inArray) @@ -117,9 +117,9 @@ namespace nc //============================================================================ /// converts a boost python list to a std::vector /// - /// @param inList + /// @param inList /// - /// @return std::vector + /// @return std::vector /// template inline std::vector list2vector(const boost::python::list& inList) @@ -130,9 +130,9 @@ namespace nc //============================================================================ /// converts a std::vector to a boost python list /// - /// @param inVector + /// @param inVector /// - /// @return boost::python::list + /// @return boost::python::list /// template inline boost::python::list vector2list(std::vector& inVector) @@ -149,9 +149,9 @@ namespace nc //============================================================================ /// converts a std::map in to a boost python dictionary /// - /// @param inMap + /// @param inMap /// - /// @return boost::python::dict + /// @return boost::python::dict /// template inline boost::python::dict map2dict(const std::map& inMap) diff --git a/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp b/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp index 7204ce9ab..12935423c 100644 --- a/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp +++ b/include/NumCpp/PythonInterface/BoostNumpyNdarrayHelper.hpp @@ -59,7 +59,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inArray: ndarray + /// @param inArray: ndarray /// explicit BoostNdarrayHelper(const boost::python::numpy::ndarray& inArray) : theArray_(inArray.astype(boost::python::numpy::dtype::get_builtin())), @@ -85,7 +85,7 @@ namespace nc //============================================================================ /// Constructor /// - /// @param inShape + /// @param inShape /// explicit BoostNdarrayHelper(boost::python::tuple inShape) : theArray_(boost::python::numpy::zeros(inShape, boost::python::numpy::dtype::get_builtin())), @@ -112,7 +112,7 @@ namespace nc //============================================================================ /// Returns the internaly held ndarray /// - /// @return reference to the held ndarray + /// @return reference to the held ndarray /// const boost::python::numpy::ndarray& getArray() noexcept { @@ -122,7 +122,7 @@ namespace nc //============================================================================ /// Returns the internaly held ndarray as a numpy matrix /// - /// @return matrix + /// @return matrix /// boost::python::numpy::matrix getArrayAsMatrix() { @@ -132,7 +132,7 @@ namespace nc //============================================================================ /// Returns the number of dimensions of the array /// - /// @return num dimensions + /// @return num dimensions /// uint8 numDimensions() noexcept { @@ -142,7 +142,7 @@ namespace nc //============================================================================ /// Returns the shape of the array /// - /// @return vector + /// @return vector /// const std::vector& shape() noexcept { @@ -152,7 +152,7 @@ namespace nc //============================================================================ /// Returns the size of the array /// - /// @return size + /// @return size /// uint32 size() { @@ -168,7 +168,7 @@ namespace nc //============================================================================ /// Returns the strides of the array /// - /// @return vector + /// @return vector /// const std::vector& strides() { @@ -178,7 +178,7 @@ namespace nc //============================================================================ /// Returns the memory order of the array (C or Fortran) /// - /// @return Order + /// @return Order /// Order order() { @@ -188,9 +188,9 @@ namespace nc //============================================================================ /// Returns if the shapes of the two array helpers are equal /// - /// @param otherNdarrayHelper + /// @param otherNdarrayHelper /// - /// @return boolean + /// @return boolean /// bool shapeEqual(BoostNdarrayHelper& otherNdarrayHelper) { @@ -205,9 +205,9 @@ namespace nc //============================================================================ /// 1D access operator /// - /// @param index + /// @param index /// - /// @return dtype + /// @return dtype /// dtype& operator()(uint32 index) { @@ -219,10 +219,10 @@ namespace nc //============================================================================ /// 2D access operator /// - /// @param index1 - /// @param index2 + /// @param index1 + /// @param index2 /// - /// @return dtype + /// @return dtype /// dtype& operator()(uint32 index1, uint32 index2) { @@ -282,7 +282,7 @@ namespace nc //============================================================================ /// Generic check of input indices /// - /// @param indices + /// @param indices /// void checkIndicesGeneric(boost::python::tuple indices) { @@ -308,7 +308,7 @@ namespace nc //============================================================================ /// Checks 1D input indices /// - /// @param index + /// @param index /// void checkIndices1D(uint32 index) { @@ -319,8 +319,8 @@ namespace nc //============================================================================ /// Checks 2D input indices /// - /// @param index1 - /// @param index2 + /// @param index1 + /// @param index2 /// void checkIndices2D(uint32 index1, uint32 index2) { diff --git a/include/NumCpp/PythonInterface/PybindInterface.hpp b/include/NumCpp/PythonInterface/PybindInterface.hpp index 126b9a903..07f0c1467 100644 --- a/include/NumCpp/PythonInterface/PybindInterface.hpp +++ b/include/NumCpp/PythonInterface/PybindInterface.hpp @@ -58,9 +58,9 @@ namespace nc /// converts a numpy array to a numcpp NdArray using pybind bindings /// Python will still own the underlying data. /// - /// @param numpyArray + /// @param numpyArray /// - /// @return NdArray + /// @return NdArray /// template NdArray pybind2nc(pbArray& numpyArray) @@ -95,9 +95,9 @@ namespace nc /// converts a numpy array to a numcpp NdArray using pybind bindings /// Python will still own the underlying data. /// - /// @param numpyArray + /// @param numpyArray /// - /// @return NdArray + /// @return NdArray /// template NdArray pybind2nc_copy(const pbArray& numpyArray) @@ -131,9 +131,9 @@ namespace nc //============================================================================ /// converts a numcpp NdArray to numpy array using pybind bindings /// - /// @param inArray: the input array + /// @param inArray: the input array /// - /// @return pybind11::array_t + /// @return pybind11::array_t /// template pbArrayGeneric nc2pybind(const NdArray& inArray) @@ -149,10 +149,10 @@ namespace nc //============================================================================ /// converts a numcpp NdArray to numpy array using pybind bindings /// - /// @param inArray: the input array - /// @param returnPolicy: the return policy + /// @param inArray: the input array + /// @param returnPolicy: the return policy /// - /// @return pybind11::array_t + /// @return pybind11::array_t /// template pbArrayGeneric nc2pybind(NdArray& inArray, ReturnPolicy returnPolicy) diff --git a/include/NumCpp/Random/bernoilli.hpp b/include/NumCpp/Random/bernoilli.hpp index 0de5bc30c..14d607a3c 100644 --- a/include/NumCpp/Random/bernoilli.hpp +++ b/include/NumCpp/Random/bernoilli.hpp @@ -45,9 +45,8 @@ namespace nc // Method Description: /// Single random value sampled from the "bernoulli" distribution. /// - /// @param inP (probability of success [0, 1]). Default 0.5 - /// @return - /// NdArray + /// @param inP (probability of success [0, 1]). Default 0.5 + /// @return NdArray /// inline bool bernoulli(double inP = 0.5) { @@ -65,10 +64,9 @@ namespace nc /// Create an array of the given shape and populate it with /// random samples from the "bernoulli" distribution. /// - /// @param inShape - /// @param inP (probability of success [0, 1]). Default 0.5 - /// @return - /// NdArray + /// @param inShape + /// @param inP (probability of success [0, 1]). Default 0.5 + /// @return NdArray /// inline NdArray bernoulli(const Shape& inShape, double inP = 0.5) { diff --git a/include/NumCpp/Random/beta.hpp b/include/NumCpp/Random/beta.hpp index e3090f54d..9bcce44c0 100644 --- a/include/NumCpp/Random/beta.hpp +++ b/include/NumCpp/Random/beta.hpp @@ -51,10 +51,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.beta.html#numpy.random.beta /// - /// @param inAlpha - /// @param inBeta - /// @return - /// NdArray + /// @param inAlpha + /// @param inBeta + /// @return NdArray /// template dtype beta(dtype inAlpha, dtype inBeta) @@ -83,11 +82,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.beta.html#numpy.random.beta /// - /// @param inShape - /// @param inAlpha - /// @param inBeta - /// @return - /// NdArray + /// @param inShape + /// @param inAlpha + /// @param inBeta + /// @return NdArray /// template NdArray beta(const Shape& inShape, dtype inAlpha, dtype inBeta) diff --git a/include/NumCpp/Random/binomial.hpp b/include/NumCpp/Random/binomial.hpp index d5baac131..c2999de9a 100644 --- a/include/NumCpp/Random/binomial.hpp +++ b/include/NumCpp/Random/binomial.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.binomial.html#numpy.random.binomial /// - /// @param inN (number of trials) - /// @param inP (probablity of success [0, 1]) - /// @return - /// NdArray + /// @param inN (number of trials) + /// @param inP (probablity of success [0, 1]) + /// @return NdArray /// template dtype binomial(dtype inN, double inP = 0.5) @@ -78,11 +77,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.binomial.html#numpy.random.binomial /// - /// @param inShape - /// @param inN (number of trials) - /// @param inP (probablity of success [0, 1]) - /// @return - /// NdArray + /// @param inShape + /// @param inN (number of trials) + /// @param inP (probablity of success [0, 1]) + /// @return NdArray /// template NdArray binomial(const Shape& inShape, dtype inN, double inP = 0.5) diff --git a/include/NumCpp/Random/cauchy.hpp b/include/NumCpp/Random/cauchy.hpp index 8da95e7f2..3e9e11ed1 100644 --- a/include/NumCpp/Random/cauchy.hpp +++ b/include/NumCpp/Random/cauchy.hpp @@ -45,10 +45,9 @@ namespace nc // Method Description: /// Single random value sampled from the from the "cauchy" distrubution. /// - /// @param inMean: Mean value of the underlying normal distribution. Default is 0. - /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. - /// @return - /// NdArray + /// @param inMean: Mean value of the underlying normal distribution. Default is 0. + /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. + /// @return NdArray /// template dtype cauchy(dtype inMean = 0, dtype inSigma = 1) @@ -69,11 +68,10 @@ namespace nc /// Create an array of the given shape and populate it with /// random samples from a "cauchy" distrubution. /// - /// @param inShape - /// @param inMean: Mean value of the underlying normal distribution. Default is 0. - /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. - /// @return - /// NdArray + /// @param inShape + /// @param inMean: Mean value of the underlying normal distribution. Default is 0. + /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. + /// @return NdArray /// template NdArray cauchy(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1) diff --git a/include/NumCpp/Random/chiSquare.hpp b/include/NumCpp/Random/chiSquare.hpp index 13cad910f..880e87135 100644 --- a/include/NumCpp/Random/chiSquare.hpp +++ b/include/NumCpp/Random/chiSquare.hpp @@ -47,9 +47,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.chisquare.html#numpy.random.chisquare /// - /// @param inDof (independent random variables) - /// @return - /// NdArray + /// @param inDof (independent random variables) + /// @return NdArray /// template dtype chiSquare(dtype inDof) @@ -72,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.chisquare.html#numpy.random.chisquare /// - /// @param inShape - /// @param inDof (independent random variables) - /// @return - /// NdArray + /// @param inShape + /// @param inDof (independent random variables) + /// @return NdArray /// template NdArray chiSquare(const Shape& inShape, dtype inDof) diff --git a/include/NumCpp/Random/choice.hpp b/include/NumCpp/Random/choice.hpp index 69c528515..87a4d8aac 100644 --- a/include/NumCpp/Random/choice.hpp +++ b/include/NumCpp/Random/choice.hpp @@ -44,9 +44,8 @@ namespace nc // Method Description: /// Chooses a random sample from an input array. /// - /// @param inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template dtype choice(const NdArray& inArray) @@ -59,11 +58,10 @@ namespace nc // Method Description: /// Chooses inNum random samples from an input array. /// - /// @param inArray - /// @param inNum - /// @param replace: Whether the sample is with or without replacement - /// @return - /// NdArray + /// @param inArray + /// @param inNum + /// @param replace: Whether the sample is with or without replacement + /// @return NdArray /// template NdArray choice(const NdArray& inArray, uint32 inNum, bool replace = true) diff --git a/include/NumCpp/Random/discrete.hpp b/include/NumCpp/Random/discrete.hpp index b29d17864..065bfea5c 100644 --- a/include/NumCpp/Random/discrete.hpp +++ b/include/NumCpp/Random/discrete.hpp @@ -47,9 +47,8 @@ namespace nc /// range [0, n) with the probability of producing each value /// is specified by the parameters of the distribution. /// - /// @param inWeights - /// @return - /// NdArray + /// @param inWeights + /// @return NdArray /// template dtype discrete(const NdArray& inWeights) @@ -68,10 +67,9 @@ namespace nc /// producing each value is specified by the parameters /// of the distribution. /// - /// @param inShape - /// @param inWeights - /// @return - /// NdArray + /// @param inShape + /// @param inWeights + /// @return NdArray /// template NdArray discrete(const Shape& inShape, const NdArray& inWeights) diff --git a/include/NumCpp/Random/exponential.hpp b/include/NumCpp/Random/exponential.hpp index f39d5af2f..c218f1319 100644 --- a/include/NumCpp/Random/exponential.hpp +++ b/include/NumCpp/Random/exponential.hpp @@ -45,9 +45,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.exponential.html#numpy.random.exponential /// - /// @param inScaleValue (default 1) - /// @return - /// NdArray + /// @param inScaleValue (default 1) + /// @return NdArray /// template dtype exponential(dtype inScaleValue = 1) @@ -65,10 +64,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.exponential.html#numpy.random.exponential /// - /// @param inShape - /// @param inScaleValue (default 1) - /// @return - /// NdArray + /// @param inShape + /// @param inScaleValue (default 1) + /// @return NdArray /// template NdArray exponential(const Shape& inShape, dtype inScaleValue = 1) diff --git a/include/NumCpp/Random/extremeValue.hpp b/include/NumCpp/Random/extremeValue.hpp index c7b022ec6..00a7aa329 100644 --- a/include/NumCpp/Random/extremeValue.hpp +++ b/include/NumCpp/Random/extremeValue.hpp @@ -45,10 +45,9 @@ namespace nc // Method Description: /// Single random value sampled from the "extreme value" distrubution. /// - /// @param inA (default 1) - /// @param inB (default 1) - /// @return - /// NdArray + /// @param inA (default 1) + /// @param inB (default 1) + /// @return NdArray /// template dtype extremeValue(dtype inA = 1, dtype inB = 1) @@ -74,11 +73,10 @@ namespace nc /// Create an array of the given shape and populate it with /// random samples from a "extreme value" distrubution. /// - /// @param inShape - /// @param inA (default 1) - /// @param inB (default 1) - /// @return - /// NdArray + /// @param inShape + /// @param inA (default 1) + /// @param inB (default 1) + /// @return NdArray /// template NdArray extremeValue(const Shape& inShape, dtype inA = 1, dtype inB = 1) diff --git a/include/NumCpp/Random/f.hpp b/include/NumCpp/Random/f.hpp index 15e8dd4ae..4412cade1 100644 --- a/include/NumCpp/Random/f.hpp +++ b/include/NumCpp/Random/f.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.f.html#numpy.random.f /// - /// @param inDofN: Degrees of freedom in numerator. Should be greater than zero. - /// @param inDofD: Degrees of freedom in denominator. Should be greater than zero. - /// @return - /// NdArray + /// @param inDofN: Degrees of freedom in numerator. Should be greater than zero. + /// @param inDofD: Degrees of freedom in denominator. Should be greater than zero. + /// @return NdArray /// template dtype f(dtype inDofN, dtype inDofD) @@ -78,11 +77,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.f.html#numpy.random.f /// - /// @param inShape - /// @param inDofN: Degrees of freedom in numerator. Should be greater than zero. - /// @param inDofD: Degrees of freedom in denominator. Should be greater than zero. - /// @return - /// NdArray + /// @param inShape + /// @param inDofN: Degrees of freedom in numerator. Should be greater than zero. + /// @param inDofD: Degrees of freedom in denominator. Should be greater than zero. + /// @return NdArray /// template NdArray f(const Shape& inShape, dtype inDofN, dtype inDofD) diff --git a/include/NumCpp/Random/gamma.hpp b/include/NumCpp/Random/gamma.hpp index 01cab9c4a..31366d1de 100644 --- a/include/NumCpp/Random/gamma.hpp +++ b/include/NumCpp/Random/gamma.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.gamma.html#numpy.random.gamma /// - /// @param inGammaShape - /// @param inScaleValue (default 1) - /// @return - /// NdArray + /// @param inGammaShape + /// @param inScaleValue (default 1) + /// @return NdArray /// template dtype gamma(dtype inGammaShape, dtype inScaleValue = 1) @@ -78,11 +77,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.gamma.html#numpy.random.gamma /// - /// @param inShape - /// @param inGammaShape - /// @param inScaleValue (default 1) - /// @return - /// NdArray + /// @param inShape + /// @param inGammaShape + /// @param inScaleValue (default 1) + /// @return NdArray /// template NdArray gamma(const Shape& inShape, dtype inGammaShape, dtype inScaleValue = 1) diff --git a/include/NumCpp/Random/generator.hpp b/include/NumCpp/Random/generator.hpp index 93d8331bb..fdb74a26d 100644 --- a/include/NumCpp/Random/generator.hpp +++ b/include/NumCpp/Random/generator.hpp @@ -44,8 +44,7 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.seed.html#numpy.random.seed /// - /// @param - /// inSeed + /// @param inSeed /// inline void seed(uint32 inSeed) { diff --git a/include/NumCpp/Random/geometric.hpp b/include/NumCpp/Random/geometric.hpp index 12ee27584..2f7a801b7 100644 --- a/include/NumCpp/Random/geometric.hpp +++ b/include/NumCpp/Random/geometric.hpp @@ -47,9 +47,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.geometric.html#numpy.random.geometric /// - /// @param inP (probablity of success [0, 1]) - /// @return - /// NdArray + /// @param inP (probablity of success [0, 1]) + /// @return NdArray /// template dtype geometric(double inP = 0.5) @@ -72,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.geometric.html#numpy.random.geometric /// - /// @param inShape - /// @param inP (probablity of success [0, 1]) - /// @return - /// NdArray + /// @param inShape + /// @param inP (probablity of success [0, 1]) + /// @return NdArray /// template NdArray geometric(const Shape& inShape, double inP = 0.5) diff --git a/include/NumCpp/Random/laplace.hpp b/include/NumCpp/Random/laplace.hpp index a6700ccff..8a37d7b79 100644 --- a/include/NumCpp/Random/laplace.hpp +++ b/include/NumCpp/Random/laplace.hpp @@ -49,10 +49,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.laplace.html#numpy.random.laplace /// - /// @param inLoc: (The position, mu, of the distribution peak. Default is 0) - /// @param inScale: (float optional the exponential decay. Default is 1) - /// @return - /// NdArray + /// @param inLoc: (The position, mu, of the distribution peak. Default is 0) + /// @param inScale: (float optional the exponential decay. Default is 1) + /// @return NdArray /// template dtype laplace(dtype inLoc = 0, dtype inScale = 1) @@ -71,11 +70,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.laplace.html#numpy.random.laplace /// - /// @param inShape - /// @param inLoc: (The position, mu, of the distribution peak. Default is 0) - /// @param inScale: (float optional the exponential decay. Default is 1) - /// @return - /// NdArray + /// @param inShape + /// @param inLoc: (The position, mu, of the distribution peak. Default is 0) + /// @param inScale: (float optional the exponential decay. Default is 1) + /// @return NdArray /// template NdArray laplace(const Shape& inShape, dtype inLoc = 0, dtype inScale = 1) diff --git a/include/NumCpp/Random/lognormal.hpp b/include/NumCpp/Random/lognormal.hpp index 4cd85d53e..758a8c7b2 100644 --- a/include/NumCpp/Random/lognormal.hpp +++ b/include/NumCpp/Random/lognormal.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html#numpy.random.lognormal /// - /// @param inMean: Mean value of the underlying normal distribution. Default is 0. - /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. - /// @return - /// NdArray + /// @param inMean: Mean value of the underlying normal distribution. Default is 0. + /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. + /// @return NdArray /// template dtype lognormal(dtype inMean = 0, dtype inSigma = 1) @@ -73,11 +72,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html#numpy.random.lognormal /// - /// @param inShape - /// @param inMean: Mean value of the underlying normal distribution. Default is 0. - /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. - /// @return - /// NdArray + /// @param inShape + /// @param inMean: Mean value of the underlying normal distribution. Default is 0. + /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. + /// @return NdArray /// template NdArray lognormal(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1) diff --git a/include/NumCpp/Random/negativeBinomial.hpp b/include/NumCpp/Random/negativeBinomial.hpp index d6cc3deed..a1ce30f25 100644 --- a/include/NumCpp/Random/negativeBinomial.hpp +++ b/include/NumCpp/Random/negativeBinomial.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.negative_binomial.html#numpy.random.negative_binomial /// - /// @param inN: number of trials - /// @param inP: probablity of success [0, 1] - /// @return - /// NdArray + /// @param inN: number of trials + /// @param inP: probablity of success [0, 1] + /// @return NdArray /// template dtype negativeBinomial(dtype inN, double inP = 0.5) @@ -78,11 +77,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.negative_binomial.html#numpy.random.negative_binomial /// - /// @param inShape - /// @param inN: number of trials - /// @param inP: probablity of success [0, 1] - /// @return - /// NdArray + /// @param inShape + /// @param inN: number of trials + /// @param inP: probablity of success [0, 1] + /// @return NdArray /// template NdArray negativeBinomial(const Shape& inShape, dtype inN, double inP = 0.5) diff --git a/include/NumCpp/Random/nonCentralChiSquared.hpp b/include/NumCpp/Random/nonCentralChiSquared.hpp index 36b98780b..6c8312764 100644 --- a/include/NumCpp/Random/nonCentralChiSquared.hpp +++ b/include/NumCpp/Random/nonCentralChiSquared.hpp @@ -51,10 +51,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.noncentral_chisquare.html#numpy.random.noncentral_chisquare /// - /// @param inK (default 1) - /// @param inLambda (default 1) - /// @return - /// NdArray + /// @param inK (default 1) + /// @param inLambda (default 1) + /// @return NdArray /// template dtype nonCentralChiSquared(dtype inK = 1, dtype inLambda = 1) @@ -83,11 +82,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.noncentral_chisquare.html#numpy.random.noncentral_chisquare /// - /// @param inShape - /// @param inK (default 1) - /// @param inLambda (default 1) - /// @return - /// NdArray + /// @param inShape + /// @param inK (default 1) + /// @param inLambda (default 1) + /// @return NdArray /// template NdArray nonCentralChiSquared(const Shape& inShape, dtype inK = 1, dtype inLambda = 1) diff --git a/include/NumCpp/Random/normal.hpp b/include/NumCpp/Random/normal.hpp index 179a1a4a1..ea8d8fe45 100644 --- a/include/NumCpp/Random/normal.hpp +++ b/include/NumCpp/Random/normal.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.normal.html#numpy.random.normal /// - /// @param inMean: Mean value of the underlying normal distribution. Default is 0. - /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. - /// @return - /// NdArray + /// @param inMean: Mean value of the underlying normal distribution. Default is 0. + /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. + /// @return NdArray /// template dtype normal(dtype inMean = 0, dtype inSigma = 1) @@ -73,11 +72,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.normal.html#numpy.random.normal /// - /// @param inShape - /// @param inMean: Mean value of the underlying normal distribution. Default is 0. - /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. - /// @return - /// NdArray + /// @param inShape + /// @param inMean: Mean value of the underlying normal distribution. Default is 0. + /// @param inSigma: Standard deviation of the underlying normal distribution. Should be greater than zero. Default is 1. + /// @return NdArray /// template NdArray normal(const Shape& inShape, dtype inMean = 0, dtype inSigma = 1) diff --git a/include/NumCpp/Random/permutation.hpp b/include/NumCpp/Random/permutation.hpp index 9e4c43609..b56b1e7d7 100644 --- a/include/NumCpp/Random/permutation.hpp +++ b/include/NumCpp/Random/permutation.hpp @@ -43,10 +43,8 @@ namespace nc /// If x is an integer, randomly permute np.arange(x). /// If x is an array, make a copy and shuffle the elements randomly. /// - /// @param - /// inValue - /// @return - /// NdArray + /// @param inValue + /// @return NdArray /// template NdArray permutation(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// If x is an integer, randomly permute np.arange(x). /// If x is an array, make a copy and shuffle the elements randomly. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template NdArray permutation(const NdArray& inArray) diff --git a/include/NumCpp/Random/poisson.hpp b/include/NumCpp/Random/poisson.hpp index e0f0d979f..22ee049ed 100644 --- a/include/NumCpp/Random/poisson.hpp +++ b/include/NumCpp/Random/poisson.hpp @@ -47,9 +47,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.poisson.html#numpy.random.poisson /// - /// @param inMean (default 1) - /// @return - /// NdArray + /// @param inMean (default 1) + /// @return NdArray /// template dtype poisson(double inMean = 1) @@ -72,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.poisson.html#numpy.random.poisson /// - /// @param inShape - /// @param inMean (default 1) - /// @return - /// NdArray + /// @param inShape + /// @param inMean (default 1) + /// @return NdArray /// template NdArray poisson(const Shape& inShape, double inMean = 1) diff --git a/include/NumCpp/Random/rand.hpp b/include/NumCpp/Random/rand.hpp index fcb1e354b..845d81bed 100644 --- a/include/NumCpp/Random/rand.hpp +++ b/include/NumCpp/Random/rand.hpp @@ -46,8 +46,7 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand /// - /// @return - /// NdArray + /// @return NdArray /// template dtype rand() @@ -66,10 +65,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// template NdArray rand(const Shape& inShape) diff --git a/include/NumCpp/Random/randFloat.hpp b/include/NumCpp/Random/randFloat.hpp index a7d814eba..21de28abf 100644 --- a/include/NumCpp/Random/randFloat.hpp +++ b/include/NumCpp/Random/randFloat.hpp @@ -51,10 +51,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.ranf.html#numpy.random.ranf /// - /// @param inLow - /// @param inHigh default 0. - /// @return - /// NdArray + /// @param inLow + /// @param inHigh default 0. + /// @return NdArray /// template dtype randFloat(dtype inLow, dtype inHigh = 0.0) @@ -82,11 +81,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.ranf.html#numpy.random.ranf /// - /// @param inShape - /// @param inLow - /// @param inHigh default 0. - /// @return - /// NdArray + /// @param inShape + /// @param inLow + /// @param inHigh default 0. + /// @return NdArray /// template NdArray randFloat(const Shape& inShape, dtype inLow, dtype inHigh = 0.0) diff --git a/include/NumCpp/Random/randInt.hpp b/include/NumCpp/Random/randInt.hpp index 0257661ac..a8d71d29a 100644 --- a/include/NumCpp/Random/randInt.hpp +++ b/include/NumCpp/Random/randInt.hpp @@ -51,10 +51,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html#numpy.random.randint /// - /// @param inLow - /// @param inHigh default 0. - /// @return - /// NdArray + /// @param inLow + /// @param inHigh default 0. + /// @return NdArray /// template dtype randInt(dtype inLow, dtype inHigh = 0) @@ -82,11 +81,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html#numpy.random.randint /// - /// @param inShape - /// @param inLow - /// @param inHigh default 0. - /// @return - /// NdArray + /// @param inShape + /// @param inLow + /// @param inHigh default 0. + /// @return NdArray /// template NdArray randInt(const Shape& inShape, dtype inLow, dtype inHigh = 0) diff --git a/include/NumCpp/Random/randN.hpp b/include/NumCpp/Random/randN.hpp index 009668e84..a84aeb89a 100644 --- a/include/NumCpp/Random/randN.hpp +++ b/include/NumCpp/Random/randN.hpp @@ -63,10 +63,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// template NdArray randN(const Shape& inShape) diff --git a/include/NumCpp/Random/shuffle.hpp b/include/NumCpp/Random/shuffle.hpp index e312dcfb3..992ef7ad9 100644 --- a/include/NumCpp/Random/shuffle.hpp +++ b/include/NumCpp/Random/shuffle.hpp @@ -41,8 +41,7 @@ namespace nc // Method Description: /// Modify a sequence in-place by shuffling its contents. /// - /// @param - /// inArray + /// @param inArray /// template void shuffle(NdArray& inArray) diff --git a/include/NumCpp/Random/standardNormal.hpp b/include/NumCpp/Random/standardNormal.hpp index 47bf72b8d..0fdc2dac2 100644 --- a/include/NumCpp/Random/standardNormal.hpp +++ b/include/NumCpp/Random/standardNormal.hpp @@ -43,8 +43,7 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_normal.html#numpy.random.standard_normal /// - /// @return - /// NdArray + /// @return NdArray /// template dtype standardNormal() @@ -62,10 +61,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_normal.html#numpy.random.standard_normal /// - /// @param - /// inShape - /// @return - /// NdArray + /// @param inShape + /// @return NdArray /// template NdArray standardNormal(const Shape& inShape) diff --git a/include/NumCpp/Random/studentT.hpp b/include/NumCpp/Random/studentT.hpp index ba7e3438b..2f0a1a141 100644 --- a/include/NumCpp/Random/studentT.hpp +++ b/include/NumCpp/Random/studentT.hpp @@ -47,9 +47,8 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_t.html#numpy.random.standard_t /// - /// @param inDof independent random variables - /// @return - /// NdArray + /// @param inDof independent random variables + /// @return NdArray /// template dtype studentT(dtype inDof) @@ -72,10 +71,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.standard_t.html#numpy.random.standard_t /// - /// @param inShape - /// @param inDof independent random variables - /// @return - /// NdArray + /// @param inShape + /// @param inDof independent random variables + /// @return NdArray /// template NdArray studentT(const Shape& inShape, dtype inDof) diff --git a/include/NumCpp/Random/triangle.hpp b/include/NumCpp/Random/triangle.hpp index cba8c6183..40de8dea8 100644 --- a/include/NumCpp/Random/triangle.hpp +++ b/include/NumCpp/Random/triangle.hpp @@ -52,11 +52,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.triangular.html#numpy.random.triangular /// - /// @param inA - /// @param inB - /// @param inC - /// @return - /// NdArray + /// @param inA + /// @param inB + /// @param inC + /// @return NdArray /// template dtype triangle(dtype inA = 0, dtype inB = 0.5, dtype inC = 1) @@ -97,12 +96,11 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.triangular.html#numpy.random.triangular /// - /// @param inShape - /// @param inA - /// @param inB - /// @param inC - /// @return - /// NdArray + /// @param inShape + /// @param inA + /// @param inB + /// @param inC + /// @return NdArray /// template NdArray triangle(const Shape& inShape, dtype inA = 0, dtype inB = 0.5, dtype inC = 1) diff --git a/include/NumCpp/Random/uniform.hpp b/include/NumCpp/Random/uniform.hpp index cd3e025ad..13da3b7aa 100644 --- a/include/NumCpp/Random/uniform.hpp +++ b/include/NumCpp/Random/uniform.hpp @@ -44,10 +44,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.uniform.html#numpy.random.uniform /// - /// @param inLow - /// @param inHigh - /// @return - /// NdArray + /// @param inLow + /// @param inHigh + /// @return NdArray /// template dtype uniform(dtype inLow, dtype inHigh) @@ -66,11 +65,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.uniform.html#numpy.random.uniform /// - /// @param inShape - /// @param inLow - /// @param inHigh - /// @return - /// NdArray + /// @param inShape + /// @param inLow + /// @param inHigh + /// @return NdArray /// template NdArray uniform(const Shape& inShape, dtype inLow, dtype inHigh) diff --git a/include/NumCpp/Random/uniformOnSphere.hpp b/include/NumCpp/Random/uniformOnSphere.hpp index c46c08c50..13f20bd1c 100644 --- a/include/NumCpp/Random/uniformOnSphere.hpp +++ b/include/NumCpp/Random/uniformOnSphere.hpp @@ -51,10 +51,9 @@ namespace nc /// distributed on the unit sphere of arbitrary dimension dim. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inNumPoints - /// @param inDims: dimension of the sphere (default 2) - /// @return - /// NdArray + /// @param inNumPoints + /// @param inDims: dimension of the sphere (default 2) + /// @return NdArray /// template NdArray uniformOnSphere(uint32 inNumPoints, uint32 inDims = 2) diff --git a/include/NumCpp/Random/weibull.hpp b/include/NumCpp/Random/weibull.hpp index ac8272747..fe6542120 100644 --- a/include/NumCpp/Random/weibull.hpp +++ b/include/NumCpp/Random/weibull.hpp @@ -47,10 +47,9 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.weibull.html#numpy.random.weibull /// - /// @param inA (default 1) - /// @param inB (default 1) - /// @return - /// NdArray + /// @param inA (default 1) + /// @param inB (default 1) + /// @return NdArray /// template dtype weibull(dtype inA = 1, dtype inB = 1) @@ -78,11 +77,10 @@ namespace nc /// /// NumPy Reference: https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.weibull.html#numpy.random.weibull /// - /// @param inShape - /// @param inA (default 1) - /// @param inB (default 1) - /// @return - /// NdArray + /// @param inShape + /// @param inA (default 1) + /// @param inB (default 1) + /// @return NdArray /// template NdArray weibull(const Shape& inShape, dtype inA = 1, dtype inB = 1) diff --git a/include/NumCpp/Rotations/DCM.hpp b/include/NumCpp/Rotations/DCM.hpp index 027f1ad4c..7766b4a8a 100644 --- a/include/NumCpp/Rotations/DCM.hpp +++ b/include/NumCpp/Rotations/DCM.hpp @@ -49,11 +49,10 @@ namespace nc /// returns a direction cosine matrix that rotates according /// to the input euler angles /// - /// @param roll: euler roll angle in radians - /// @param pitch: euler pitch angle in radians - /// @param yaw: euler yaw angle in radians - /// @return - /// NdArray + /// @param roll: euler roll angle in radians + /// @param pitch: euler pitch angle in radians + /// @param yaw: euler yaw angle in radians + /// @return NdArray /// static NdArray eulerAngles(double roll, double pitch, double yaw) { @@ -65,9 +64,8 @@ namespace nc /// returns a direction cosine matrix that rotates according /// to the input euler angles /// - /// @param angles: euler roll, pitch, angles - /// @return - /// NdArray + /// @param angles: euler roll, pitch, angles + /// @return NdArray /// static NdArray eulerAngles(const NdArray& angles) { @@ -79,10 +77,9 @@ namespace nc /// returns a direction cosine matrix that rotates about /// the input axis by the input angle /// - /// @param inAxis: euler axis cartesian vector with x,y,z components - /// @param inAngle: euler angle in radians - /// @return - /// NdArray + /// @param inAxis: euler axis cartesian vector with x,y,z components + /// @param inAngle: euler angle in radians + /// @return NdArray /// static NdArray eulerAxisAngle(const NdArray& inAxis, double inAngle) { @@ -94,10 +91,9 @@ namespace nc /// returns a direction cosine matrix that rotates about /// the input axis by the input angle /// - /// @param inAxis: euler axis cartesian vector with x,y,z components - /// @param inAngle: euler angle in radians - /// @return - /// NdArray + /// @param inAxis: euler axis cartesian vector with x,y,z components + /// @param inAngle: euler angle in radians + /// @return NdArray /// static NdArray eulerAxisAngle(const Vec3& inAxis, double inAngle) { @@ -109,10 +105,8 @@ namespace nc /// returns whether the input array is a direction cosine /// matrix /// - /// @param - /// inArray - /// @return - /// bool + /// @param inArray + /// @return bool /// static bool isValid(const NdArray& inArray) { @@ -126,8 +120,8 @@ namespace nc // Method Description: /// The euler roll angle in radians /// - /// @param dcm: a valid direction cosine matrix - /// @return euler roll angle in radians + /// @param dcm: a valid direction cosine matrix + /// @return euler roll angle in radians /// static double roll(const NdArray& dcm) { @@ -138,8 +132,8 @@ namespace nc // Method Description: /// The euler pitch angle in radians /// - /// @param dcm: a valid direction cosine matrix - /// @return euler pitch angle in radians + /// @param dcm: a valid direction cosine matrix + /// @return euler pitch angle in radians /// static double pitch(const NdArray& dcm) { @@ -150,8 +144,8 @@ namespace nc // Method Description: /// The euler yaw angle in radians /// - /// @param dcm: a valid direction cosine matrix - /// @return euler yaw angle in radians + /// @param dcm: a valid direction cosine matrix + /// @return euler yaw angle in radians /// static double yaw(const NdArray& dcm) { @@ -163,10 +157,8 @@ namespace nc /// returns a direction cosine matrix that rotates about /// the x axis by the input angle /// - /// @param - /// inAngle (in radians) - /// @return - /// NdArray + /// @param inAngle (in radians) + /// @return NdArray /// static NdArray xRotation(double inAngle) { @@ -178,10 +170,8 @@ namespace nc /// returns a direction cosine matrix that rotates about /// the x axis by the input angle /// - /// @param - /// inAngle (in radians) - /// @return - /// NdArray + /// @param inAngle (in radians) + /// @return NdArray /// static NdArray yRotation(double inAngle) { @@ -193,10 +183,8 @@ namespace nc /// returns a direction cosine matrix that rotates about /// the x axis by the input angle /// - /// @param - /// inAngle (in radians) - /// @return - /// NdArray + /// @param inAngle (in radians) + /// @return NdArray /// static NdArray zRotation(double inAngle) { diff --git a/include/NumCpp/Rotations/Quaternion.hpp b/include/NumCpp/Rotations/Quaternion.hpp index 615f4dcef..f00cf2aeb 100644 --- a/include/NumCpp/Rotations/Quaternion.hpp +++ b/include/NumCpp/Rotations/Quaternion.hpp @@ -67,9 +67,9 @@ namespace nc // Method Description: /// Constructor /// - /// @param roll: euler roll angle in radians - /// @param pitch: euler pitch angle in radians - /// @param yaw: euler yaw angle in radians + /// @param roll: euler roll angle in radians + /// @param pitch: euler pitch angle in radians + /// @param yaw: euler yaw angle in radians /// Quaternion(double roll, double pitch, double yaw) noexcept { @@ -80,10 +80,10 @@ namespace nc // Method Description: /// Constructor /// - /// @param inI - /// @param inJ - /// @param inK - /// @param inS + /// @param inI + /// @param inJ + /// @param inK + /// @param inS /// Quaternion(double inI, double inJ, double inK, double inS) noexcept : components_{ inI, inJ, inK, inS } @@ -95,7 +95,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param inArray: if size = 3 the roll, pitch, yaw euler angles + /// @param inArray: if size = 3 the roll, pitch, yaw euler angles /// if size = 4 the i, j, k, s components /// if shape = [3, 3] then direction cosine matrix /// @@ -128,8 +128,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inAxis: Euler axis - /// @param inAngle: Euler angle in radians + /// @param inAxis: Euler axis + /// @param inAngle: Euler angle in radians /// Quaternion(const Vec3& inAxis, double inAngle) noexcept { @@ -149,8 +149,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inAxis: Euler axis x,y,z vector components - /// @param inAngle: Euler angle in radians + /// @param inAxis: Euler axis x,y,z vector components + /// @param inAngle: Euler angle in radians /// Quaternion(const NdArray& inAxis, double inAngle) : Quaternion(Vec3(inAxis), inAngle) @@ -161,11 +161,10 @@ namespace nc /// angular velocity vector between the two quaternions. The norm /// of the array is the magnitude /// - /// @param inQuat1 - /// @param inQuat2 - /// @param inTime (seperation time) - /// @return - /// NdArray + /// @param inQuat1 + /// @param inQuat2 + /// @param inTime (seperation time) + /// @return NdArray /// static NdArray angularVelocity(const Quaternion& inQuat1, const Quaternion& inQuat2, double inTime) { @@ -197,10 +196,9 @@ namespace nc /// angular velocity vector between the two quaternions. The norm /// of the array is the magnitude /// - /// @param inQuat2 - /// @param inTime (seperation time) - /// @return - /// NdArray + /// @param inQuat2 + /// @param inTime (seperation time) + /// @return NdArray /// NdArray angularVelocity(const Quaternion& inQuat2, double inTime) const { @@ -211,8 +209,7 @@ namespace nc // Method Description: /// quaternion conjugate /// - /// @return - /// Quaternion + /// @return Quaternion /// Quaternion conjugate() const noexcept { @@ -223,8 +220,7 @@ namespace nc // Method Description: /// returns the i component /// - /// @return - /// double + /// @return double /// double i() const noexcept { @@ -235,8 +231,7 @@ namespace nc // Method Description: /// quaternion identity (0,0,0,1) /// - /// @return - /// Quaternion + /// @return Quaternion /// static Quaternion identity() noexcept { @@ -247,8 +242,7 @@ namespace nc // Method Description: /// quaternion inverse /// - /// @return - /// Quaterion + /// @return Quaterion /// Quaternion inverse() const noexcept { @@ -260,8 +254,7 @@ namespace nc // Method Description: /// returns the j component /// - /// @return - /// double + /// @return double /// double j() const noexcept { @@ -272,8 +265,7 @@ namespace nc // Method Description: /// returns the k component /// - /// @return - /// double + /// @return double /// double k() const noexcept { @@ -284,11 +276,10 @@ namespace nc // Method Description: /// linearly interpolates between the two quaternions /// - /// @param inQuat1 - /// @param inQuat2 - /// @param inPercent [0, 1] - /// @return - /// Quaternion + /// @param inQuat1 + /// @param inQuat2 + /// @param inPercent [0, 1] + /// @return Quaternion /// static Quaternion nlerp(const Quaternion& inQuat1, const Quaternion& inQuat2, double inPercent) { @@ -323,10 +314,9 @@ namespace nc // Method Description: /// linearly interpolates between the two quaternions /// - /// @param inQuat2 - /// @param inPercent (0, 1) - /// @return - /// Quaternion + /// @param inQuat2 + /// @param inPercent (0, 1) + /// @return Quaternion /// Quaternion nlerp(const Quaternion& inQuat2, double inPercent) const { @@ -337,7 +327,7 @@ namespace nc // Method Description: /// The euler pitch angle in radians /// - /// @return euler pitch angle in radians + /// @return euler pitch angle in radians /// double pitch() const noexcept { @@ -357,7 +347,7 @@ namespace nc // Method Description: /// The euler roll angle in radians /// - /// @return euler roll angle in radians + /// @return euler roll angle in radians /// double roll() const noexcept { @@ -369,10 +359,8 @@ namespace nc // Method Description: /// rotate a vector using the quaternion /// - /// @param - /// inVector (cartesian vector with x,y,z components) - /// @return - /// NdArray (cartesian vector with x,y,z components) + /// @param inVector (cartesian vector with x,y,z components) + /// @return NdArray (cartesian vector with x,y,z components) /// NdArray rotate(const NdArray& inVector) const { @@ -388,10 +376,8 @@ namespace nc // Method Description: /// rotate a vector using the quaternion /// - /// @param - /// inVec3 - /// @return - /// Vec3 + /// @param inVec3 + /// @return Vec3 /// Vec3 rotate(const Vec3& inVec3) const { @@ -402,8 +388,7 @@ namespace nc // Method Description: /// returns the s component /// - /// @return - /// double + /// @return double /// double s() const noexcept { @@ -414,11 +399,10 @@ namespace nc // Method Description: /// spherical linear interpolates between the two quaternions /// - /// @param inQuat1 - /// @param inQuat2 - /// @param inPercent (0, 1) - /// @return - /// Quaternion + /// @param inQuat1 + /// @param inQuat2 + /// @param inPercent (0, 1) + /// @return Quaternion /// static Quaternion slerp(const Quaternion& inQuat1, const Quaternion& inQuat2, double inPercent) { @@ -470,10 +454,9 @@ namespace nc // Method Description: /// spherical linear interpolates between the two quaternions /// - /// @param inQuat2 - /// @param inPercent (0, 1) - /// @return - /// Quaternion + /// @param inQuat2 + /// @param inPercent (0, 1) + /// @return Quaternion /// Quaternion slerp(const Quaternion& inQuat2, double inPercent) const { @@ -484,8 +467,7 @@ namespace nc // Method Description: /// returns the quaternion as a string representation /// - /// @return - /// std::string + /// @return std::string /// std::string str() const { @@ -499,8 +481,7 @@ namespace nc // Method Description: /// returns the direction cosine matrix /// - /// @return - /// NdArray + /// @return NdArray /// NdArray toDCM() const { @@ -533,8 +514,7 @@ namespace nc // Method Description: /// returns the quaternion as an NdArray /// - /// @return - /// NdArray + /// @return NdArray /// NdArray toNdArray() const { @@ -546,10 +526,8 @@ namespace nc // Method Description: /// returns a quaternion to rotate about the x-axis by the input angle /// - /// @param - /// inAngle (radians) - /// @return - /// Quaternion + /// @param inAngle (radians) + /// @return Quaternion /// static Quaternion xRotation(double inAngle) noexcept { @@ -561,7 +539,7 @@ namespace nc // Method Description: /// The euler yaw angle in radians /// - /// @return euler yaw angle in radians + /// @return euler yaw angle in radians /// double yaw() const noexcept { @@ -573,10 +551,8 @@ namespace nc // Method Description: /// returns a quaternion to rotate about the y-axis by the input angle /// - /// @param - /// inAngle (radians) - /// @return - /// Quaternion + /// @param inAngle (radians) + /// @return Quaternion /// static Quaternion yRotation(double inAngle) noexcept { @@ -588,10 +564,8 @@ namespace nc // Method Description: /// returns a quaternion to rotate about the y-axis by the input angle /// - /// @param - /// inAngle (radians) - /// @return - /// Quaternion + /// @param inAngle (radians) + /// @return Quaternion /// static Quaternion zRotation(double inAngle) noexcept { @@ -603,10 +577,8 @@ namespace nc // Method Description: /// equality operator /// - /// @param - /// inRhs - /// @return - /// bool + /// @param inRhs + /// @return bool /// bool operator==(const Quaternion& inRhs) const noexcept { @@ -623,10 +595,8 @@ namespace nc // Method Description: /// equality operator /// - /// @param - /// inRhs - /// @return - /// bool + /// @param inRhs + /// @return bool /// bool operator!=(const Quaternion& inRhs) const noexcept { @@ -637,10 +607,8 @@ namespace nc // Method Description: /// addition assignment operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion& operator+=(const Quaternion& inRhs) noexcept { @@ -656,10 +624,8 @@ namespace nc // Method Description: /// addition operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion operator+(const Quaternion& inRhs) const noexcept { @@ -670,10 +636,8 @@ namespace nc // Method Description: /// subtraction assignment operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion& operator-=(const Quaternion& inRhs) noexcept { @@ -689,10 +653,8 @@ namespace nc // Method Description: /// subtraction operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion operator-(const Quaternion& inRhs) const noexcept { @@ -703,8 +665,7 @@ namespace nc // Method Description: /// negative operator /// - /// @return - /// Quaternion + /// @return Quaternion /// Quaternion operator-() const noexcept { @@ -715,10 +676,8 @@ namespace nc // Method Description: /// multiplication assignment operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion& operator*=(const Quaternion& inRhs) noexcept { @@ -757,10 +716,8 @@ namespace nc /// multiplication operator, only useful for multiplying /// by negative 1, all others will be renormalized back out /// - /// @param - /// inScalar - /// @return - /// Quaternion + /// @param inScalar + /// @return Quaternion /// Quaternion& operator*=(double inScalar) noexcept { @@ -779,10 +736,8 @@ namespace nc // Method Description: /// multiplication operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion operator*(const Quaternion& inRhs) const noexcept { @@ -794,10 +749,8 @@ namespace nc /// multiplication operator, only useful for multiplying /// by negative 1, all others will be renormalized back out /// - /// @param - /// inScalar - /// @return - /// Quaternion + /// @param inScalar + /// @return Quaternion /// Quaternion operator*(double inScalar) const noexcept { @@ -808,10 +761,8 @@ namespace nc // Method Description: /// multiplication operator /// - /// @param - /// inVec - /// @return - /// NdArray + /// @param inVec + /// @return NdArray /// NdArray operator*(const NdArray& inVec) const { @@ -832,10 +783,8 @@ namespace nc // Method Description: /// multiplication operator /// - /// @param - /// inVec3 - /// @return - /// Vec3 + /// @param inVec3 + /// @return Vec3 /// Vec3 operator*(const Vec3& inVec3) const { @@ -846,10 +795,8 @@ namespace nc // Method Description: /// division assignment operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion& operator/=(const Quaternion& inRhs) noexcept { @@ -860,10 +807,8 @@ namespace nc // Method Description: /// division operator /// - /// @param - /// inRhs - /// @return - /// Quaternion + /// @param inRhs + /// @return Quaternion /// Quaternion operator/(const Quaternion& inRhs) const noexcept { @@ -874,10 +819,9 @@ namespace nc // Method Description: /// IO operator for the Quaternion class /// - /// @param inOStream - /// @param inQuat - /// @return - /// std::ostream& + /// @param inOStream + /// @param inQuat + /// @return std::ostream& /// friend std::ostream& operator<<(std::ostream& inOStream, const Quaternion& inQuat) { diff --git a/include/NumCpp/Rotations/rodriguesRotation.hpp b/include/NumCpp/Rotations/rodriguesRotation.hpp index 90a2de6a3..ed610665c 100644 --- a/include/NumCpp/Rotations/rodriguesRotation.hpp +++ b/include/NumCpp/Rotations/rodriguesRotation.hpp @@ -42,9 +42,9 @@ namespace nc /// Performs Rodriques' rotation formula /// https://en.wikipedia.org/wiki/Rodrigues%27_rotation_formula /// - /// @param k: the axis to rotate around - /// @param theta: the angle in radians to rotate - /// @param v: the vector to rotate + /// @param k: the axis to rotate around + /// @param theta: the angle in radians to rotate + /// @param v: the vector to rotate /// /// @return Vec3 /// @@ -72,9 +72,9 @@ namespace nc /// Performs Rodriques' rotation formula /// https://en.wikipedia.org/wiki/Rodrigues%27_rotation_formula /// - /// @param k: the axis to rotate around - /// @param theta: the angle in radians to rotate - /// @param v: the vector to rotate + /// @param k: the axis to rotate around + /// @param theta: the angle in radians to rotate + /// @param v: the vector to rotate /// /// @return NdArray /// diff --git a/include/NumCpp/Rotations/wahbasProblem.hpp b/include/NumCpp/Rotations/wahbasProblem.hpp index 8de1bfc30..33e642210 100644 --- a/include/NumCpp/Rotations/wahbasProblem.hpp +++ b/include/NumCpp/Rotations/wahbasProblem.hpp @@ -54,9 +54,9 @@ namespace nc /// such as magnetometers and multi-antenna GPS receivers /// https://en.wikipedia.org/wiki/Wahba%27s_problem /// - /// @param wk: k-th 3-vector measurement in the reference frame (n x 3 matrix) - /// @param vk: corresponding k-th 3-vector measurement in the body frame (n x 3 matrix) - /// @param ak: set of weights for each observation (1 x n or n x 1 matrix) + /// @param wk: k-th 3-vector measurement in the reference frame (n x 3 matrix) + /// @param vk: corresponding k-th 3-vector measurement in the body frame (n x 3 matrix) + /// @param ak: set of weights for each observation (1 x n or n x 1 matrix) /// /// @return NdArray rotation matrix /// @@ -118,8 +118,8 @@ namespace nc /// such as magnetometers and multi-antenna GPS receivers /// https://en.wikipedia.org/wiki/Wahba%27s_problem /// - /// @param wk: k-th 3-vector measurement in the reference frame - /// @param vk: corresponding k-th 3-vector measurement in the body frame + /// @param wk: k-th 3-vector measurement in the reference frame + /// @param vk: corresponding k-th 3-vector measurement in the body frame /// /// @return NdArray rotation matrix /// diff --git a/include/NumCpp/Special/airy_ai.hpp b/include/NumCpp/Special/airy_ai.hpp index 7e88047ae..270fe9a69 100644 --- a/include/NumCpp/Special/airy_ai.hpp +++ b/include/NumCpp/Special/airy_ai.hpp @@ -45,10 +45,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto airy_ai(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto airy_ai(const NdArray& inArray) diff --git a/include/NumCpp/Special/airy_ai_prime.hpp b/include/NumCpp/Special/airy_ai_prime.hpp index b7210ca84..ce5d430e0 100644 --- a/include/NumCpp/Special/airy_ai_prime.hpp +++ b/include/NumCpp/Special/airy_ai_prime.hpp @@ -45,10 +45,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto airy_ai_prime(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto airy_ai_prime(const NdArray& inArray) diff --git a/include/NumCpp/Special/airy_bi.hpp b/include/NumCpp/Special/airy_bi.hpp index 39928cc5d..a2d25a4a7 100644 --- a/include/NumCpp/Special/airy_bi.hpp +++ b/include/NumCpp/Special/airy_bi.hpp @@ -45,10 +45,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto airy_bi(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto airy_bi(const NdArray& inArray) diff --git a/include/NumCpp/Special/airy_bi_prime.hpp b/include/NumCpp/Special/airy_bi_prime.hpp index da4112755..7b058230b 100644 --- a/include/NumCpp/Special/airy_bi_prime.hpp +++ b/include/NumCpp/Special/airy_bi_prime.hpp @@ -45,10 +45,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto airy_bi_prime(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// http://mathworld.wolfram.com/AiryFunctions.html /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto airy_bi_prime(const NdArray& inArray) diff --git a/include/NumCpp/Special/bernoulli.hpp b/include/NumCpp/Special/bernoulli.hpp index 4ac65117b..1c561d445 100644 --- a/include/NumCpp/Special/bernoulli.hpp +++ b/include/NumCpp/Special/bernoulli.hpp @@ -44,10 +44,8 @@ namespace nc /// Both return the nth Bernoulli number B2n. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// n - /// @return - /// double + /// @param n + /// @return double /// inline double bernoilli(uint32 n) { @@ -68,10 +66,8 @@ namespace nc /// Both return the nth Bernoulli number B2n. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// inline NdArray bernoilli(const NdArray& inArray) { diff --git a/include/NumCpp/Special/bessel_in.hpp b/include/NumCpp/Special/bessel_in.hpp index ef9d9be1a..f62e2006f 100644 --- a/include/NumCpp/Special/bessel_in.hpp +++ b/include/NumCpp/Special/bessel_in.hpp @@ -51,10 +51,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_in(dtype1 inV, dtype2 inX) @@ -75,10 +74,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_in(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_in_prime.hpp b/include/NumCpp/Special/bessel_in_prime.hpp index 125b8fcae..9bcf6a2e9 100644 --- a/include/NumCpp/Special/bessel_in_prime.hpp +++ b/include/NumCpp/Special/bessel_in_prime.hpp @@ -46,10 +46,9 @@ namespace nc /// Derivcative of the Modified Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_in_prime(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Derivcative of the Modified Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_in_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_jn.hpp b/include/NumCpp/Special/bessel_jn.hpp index ede412b75..c5e51ac56 100644 --- a/include/NumCpp/Special/bessel_jn.hpp +++ b/include/NumCpp/Special/bessel_jn.hpp @@ -51,10 +51,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_jn(dtype1 inV, dtype2 inX) @@ -75,10 +74,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_jn(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_jn_prime.hpp b/include/NumCpp/Special/bessel_jn_prime.hpp index b5d94cb6b..513638d06 100644 --- a/include/NumCpp/Special/bessel_jn_prime.hpp +++ b/include/NumCpp/Special/bessel_jn_prime.hpp @@ -46,10 +46,9 @@ namespace nc /// Derivcative of the Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_jn_prime(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Derivcative of the Cylindrical Bessel function of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_jn_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_kn.hpp b/include/NumCpp/Special/bessel_kn.hpp index aeaefb96c..d909d2159 100644 --- a/include/NumCpp/Special/bessel_kn.hpp +++ b/include/NumCpp/Special/bessel_kn.hpp @@ -51,10 +51,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_kn(dtype1 inV, dtype2 inX) @@ -75,10 +74,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_kn(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_kn_prime.hpp b/include/NumCpp/Special/bessel_kn_prime.hpp index dc8266dc3..278b90450 100644 --- a/include/NumCpp/Special/bessel_kn_prime.hpp +++ b/include/NumCpp/Special/bessel_kn_prime.hpp @@ -46,10 +46,9 @@ namespace nc /// Derivcative of the Modified Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_kn_prime(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Derivcative of the Modified Cylindrical Bessel function of the second kind /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_kn_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_yn.hpp b/include/NumCpp/Special/bessel_yn.hpp index cc749a425..525e6ef2b 100644 --- a/include/NumCpp/Special/bessel_yn.hpp +++ b/include/NumCpp/Special/bessel_yn.hpp @@ -51,10 +51,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_yn(dtype1 inV, dtype2 inX) @@ -75,10 +74,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_yn(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/bessel_yn_prime.hpp b/include/NumCpp/Special/bessel_yn_prime.hpp index 5f95fc373..1c4283996 100644 --- a/include/NumCpp/Special/bessel_yn_prime.hpp +++ b/include/NumCpp/Special/bessel_yn_prime.hpp @@ -46,10 +46,9 @@ namespace nc /// Derivcative of the Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto bessel_yn_prime(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Derivcative of the Cylindrical Bessel function of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto bessel_yn_prime(dtype1 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/beta.hpp b/include/NumCpp/Special/beta.hpp index 32595f567..7e8a1f697 100644 --- a/include/NumCpp/Special/beta.hpp +++ b/include/NumCpp/Special/beta.hpp @@ -51,10 +51,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param a - /// @param b - /// @return - /// calculated-result-type + /// @param a + /// @param b + /// @return calculated-result-type /// template auto beta(dtype1 a, dtype2 b) @@ -75,10 +74,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayA - /// @param inArrayB - /// @return - /// NdArray + /// @param inArrayA + /// @param inArrayB + /// @return NdArray /// template auto beta(const NdArray& inArrayA, const NdArray& inArrayB) diff --git a/include/NumCpp/Special/cnr.hpp b/include/NumCpp/Special/cnr.hpp index 25165a71e..8e370574c 100644 --- a/include/NumCpp/Special/cnr.hpp +++ b/include/NumCpp/Special/cnr.hpp @@ -43,10 +43,9 @@ namespace nc // Method Description: /// Returns the number of combinations of n choose r. C(n, r) /// - /// @param n: the total number of items - /// @param r: the number of items taken - /// @return - /// double + /// @param n: the total number of items + /// @param r: the number of items taken + /// @return double /// inline double cnr(uint32 n, uint32 r) { diff --git a/include/NumCpp/Special/comp_ellint_1.hpp b/include/NumCpp/Special/comp_ellint_1.hpp index 927a19fe1..94fa7c657 100644 --- a/include/NumCpp/Special/comp_ellint_1.hpp +++ b/include/NumCpp/Special/comp_ellint_1.hpp @@ -51,9 +51,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inK: elliptic modulus or eccentricity - /// @return - /// calculated-result-type + /// @param inK: elliptic modulus or eccentricity + /// @return calculated-result-type /// template auto comp_ellint_1(dtype inK) @@ -73,9 +72,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayK: elliptic modulus or eccentricity - /// @return - /// NdArray + /// @param inArrayK: elliptic modulus or eccentricity + /// @return NdArray /// template auto comp_ellint_1(const NdArray& inArrayK) diff --git a/include/NumCpp/Special/comp_ellint_2.hpp b/include/NumCpp/Special/comp_ellint_2.hpp index f430db8fd..9e8d73cca 100644 --- a/include/NumCpp/Special/comp_ellint_2.hpp +++ b/include/NumCpp/Special/comp_ellint_2.hpp @@ -51,9 +51,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inK: elliptic modulus or eccentricity - /// @return - /// calculated-result-type + /// @param inK: elliptic modulus or eccentricity + /// @return calculated-result-type /// template auto comp_ellint_2(dtype inK) @@ -73,9 +72,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayK: elliptic modulus or eccentricity - /// @return - /// NdArray + /// @param inArrayK: elliptic modulus or eccentricity + /// @return NdArray /// template auto comp_ellint_2(const NdArray& inArrayK) diff --git a/include/NumCpp/Special/comp_ellint_3.hpp b/include/NumCpp/Special/comp_ellint_3.hpp index 525c81f65..70fc3ff6d 100644 --- a/include/NumCpp/Special/comp_ellint_3.hpp +++ b/include/NumCpp/Special/comp_ellint_3.hpp @@ -52,10 +52,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inK: elliptic modulus or eccentricity - /// @param inV: elliptic characteristic - /// @return - /// calculated-result-type + /// @param inK: elliptic modulus or eccentricity + /// @param inV: elliptic characteristic + /// @return calculated-result-type /// template auto comp_ellint_3(dtype1 inK, dtype2 inV) @@ -76,10 +75,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayK: the order of the bessel function - /// @param inArrayV: elliptic characteristic - /// @return - /// NdArray + /// @param inArrayK: the order of the bessel function + /// @param inArrayV: elliptic characteristic + /// @return NdArray /// template auto comp_ellint_3(const NdArray& inArrayK, const NdArray& inArrayV) diff --git a/include/NumCpp/Special/cyclic_hankel_1.hpp b/include/NumCpp/Special/cyclic_hankel_1.hpp index 5ef9b5a47..522c82371 100644 --- a/include/NumCpp/Special/cyclic_hankel_1.hpp +++ b/include/NumCpp/Special/cyclic_hankel_1.hpp @@ -46,10 +46,9 @@ namespace nc /// Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// std::complex + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return std::complex /// template auto cyclic_hankel_1(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input array - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inX: the input array + /// @return NdArray /// template auto cyclic_hankel_1(dtype1 inV, const NdArray& inX) diff --git a/include/NumCpp/Special/cyclic_hankel_2.hpp b/include/NumCpp/Special/cyclic_hankel_2.hpp index 0e7a052f5..ea717a3ee 100644 --- a/include/NumCpp/Special/cyclic_hankel_2.hpp +++ b/include/NumCpp/Special/cyclic_hankel_2.hpp @@ -46,10 +46,9 @@ namespace nc /// Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// std::complex<> + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return std::complex<> /// template auto cyclic_hankel_2(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input array - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inX: the input array + /// @return NdArray /// template auto cyclic_hankel_2(dtype1 inV, const NdArray& inX) diff --git a/include/NumCpp/Special/digamma.hpp b/include/NumCpp/Special/digamma.hpp index 6d459da3e..e50126c0e 100644 --- a/include/NumCpp/Special/digamma.hpp +++ b/include/NumCpp/Special/digamma.hpp @@ -45,10 +45,8 @@ namespace nc /// logarithmic derivative of the gamma function. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto digamma(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// logarithmic derivative of the gamma function. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto digamma(const NdArray& inArray) diff --git a/include/NumCpp/Special/ellint_1.hpp b/include/NumCpp/Special/ellint_1.hpp index 7742d44cf..e8fc49267 100644 --- a/include/NumCpp/Special/ellint_1.hpp +++ b/include/NumCpp/Special/ellint_1.hpp @@ -52,10 +52,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inK: elliptic modulus or eccentricity - /// @param inP: Jacobi amplitude (measured in radians) - /// @return - /// calculated-result-type + /// @param inK: elliptic modulus or eccentricity + /// @param inP: Jacobi amplitude (measured in radians) + /// @return calculated-result-type /// template auto ellint_1(dtype1 inK, dtype2 inP) @@ -76,10 +75,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayK: elliptic modulus or eccentricity - /// @param inArrayP: Jacobi amplitude (measured in radians) - /// @return - /// NdArray + /// @param inArrayK: elliptic modulus or eccentricity + /// @param inArrayP: Jacobi amplitude (measured in radians) + /// @return NdArray /// template auto ellint_1(const NdArray& inArrayK, const NdArray& inArrayP) diff --git a/include/NumCpp/Special/ellint_2.hpp b/include/NumCpp/Special/ellint_2.hpp index 3996f15ca..72e5ef011 100644 --- a/include/NumCpp/Special/ellint_2.hpp +++ b/include/NumCpp/Special/ellint_2.hpp @@ -52,10 +52,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inK: elliptic modulus or eccentricity - /// @param inP: Jacobi amplitude (measured in radians) - /// @return - /// calculated-result-type + /// @param inK: elliptic modulus or eccentricity + /// @param inP: Jacobi amplitude (measured in radians) + /// @return calculated-result-type /// template auto ellint_2(dtype1 inK, dtype2 inP) @@ -76,10 +75,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayK: elliptic modulus or eccentricity - /// @param inArrayP: Jacobi amplitude (measured in radians) - /// @return - /// NdArray + /// @param inArrayK: elliptic modulus or eccentricity + /// @param inArrayP: Jacobi amplitude (measured in radians) + /// @return NdArray /// template auto ellint_2(const NdArray& inArrayK, const NdArray& inArrayP) diff --git a/include/NumCpp/Special/ellint_3.hpp b/include/NumCpp/Special/ellint_3.hpp index fd4afb654..5eb496e0d 100644 --- a/include/NumCpp/Special/ellint_3.hpp +++ b/include/NumCpp/Special/ellint_3.hpp @@ -52,11 +52,10 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inK: elliptic modulus or eccentricity - /// @param inV: elliptic characteristic - /// @param inP: Jacobi amplitude (measured in radians) - /// @return - /// calculated-result-type + /// @param inK: elliptic modulus or eccentricity + /// @param inV: elliptic characteristic + /// @param inP: Jacobi amplitude (measured in radians) + /// @return calculated-result-type /// template auto ellint_3(dtype1 inK, dtype2 inV, dtype3 inP) @@ -78,11 +77,10 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayK: the order of the bessel function - /// @param inArrayV: elliptic characteristic - /// @param inArrayP: Jacobi amplitude (measured in radians) - /// @return - /// NdArray + /// @param inArrayK: the order of the bessel function + /// @param inArrayV: elliptic characteristic + /// @param inArrayP: Jacobi amplitude (measured in radians) + /// @return NdArray /// template auto ellint_3(const NdArray& inArrayK, const NdArray& inArrayV, const NdArray& inArrayP) diff --git a/include/NumCpp/Special/erf.hpp b/include/NumCpp/Special/erf.hpp index 667ae563e..8708da463 100644 --- a/include/NumCpp/Special/erf.hpp +++ b/include/NumCpp/Special/erf.hpp @@ -45,10 +45,8 @@ namespace nc /// Integral (from [-x, x]) of np.exp(np.power(-t, 2)) dt, multiplied by 1/np.pi. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto erf(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// Integral (from [-x, x]) of np.exp(np.power(-t, 2)) dt, multiplied by 1/np.pi. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto erf(const NdArray& inArray) diff --git a/include/NumCpp/Special/erf_inv.hpp b/include/NumCpp/Special/erf_inv.hpp index e73b5fc11..a5a11f1ab 100644 --- a/include/NumCpp/Special/erf_inv.hpp +++ b/include/NumCpp/Special/erf_inv.hpp @@ -45,10 +45,8 @@ namespace nc /// z = erf(x). /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto erf_inv(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// z = erf(x). /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto erf_inv(const NdArray& inArray) diff --git a/include/NumCpp/Special/erfc.hpp b/include/NumCpp/Special/erfc.hpp index b6d2b8a95..181710109 100644 --- a/include/NumCpp/Special/erfc.hpp +++ b/include/NumCpp/Special/erfc.hpp @@ -44,10 +44,8 @@ namespace nc /// Returns the complement of the error function of inValue. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto erfc(dtype inValue) @@ -63,10 +61,8 @@ namespace nc /// function of inValue. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto erfc(const NdArray& inArray) diff --git a/include/NumCpp/Special/erfc_inv.hpp b/include/NumCpp/Special/erfc_inv.hpp index 042d762b5..5f09d6eea 100644 --- a/include/NumCpp/Special/erfc_inv.hpp +++ b/include/NumCpp/Special/erfc_inv.hpp @@ -45,10 +45,8 @@ namespace nc /// z = erfc(x). /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto erfc_inv(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// z = erfc(x). /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto erfc_inv(const NdArray& inArray) diff --git a/include/NumCpp/Special/expint.hpp b/include/NumCpp/Special/expint.hpp index 459e62e7d..32e558e06 100644 --- a/include/NumCpp/Special/expint.hpp +++ b/include/NumCpp/Special/expint.hpp @@ -51,9 +51,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inX: value - /// @return - /// calculated-result-type + /// @param inX: value + /// @return calculated-result-type /// template auto expint(dtype inX) @@ -73,9 +72,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inArrayX: value - /// @return - /// NdArray + /// @param inArrayX: value + /// @return NdArray /// template auto expint(const NdArray& inArrayX) diff --git a/include/NumCpp/Special/factorial.hpp b/include/NumCpp/Special/factorial.hpp index da4200793..81d4a980b 100644 --- a/include/NumCpp/Special/factorial.hpp +++ b/include/NumCpp/Special/factorial.hpp @@ -45,10 +45,8 @@ namespace nc // Method Description: /// Returns the factorial of the input value /// - /// @param - /// inValue - /// @return - /// double + /// @param inValue + /// @return double /// inline double factorial(uint32 inValue) { @@ -74,10 +72,8 @@ namespace nc // Method Description: /// Returns the factorial of the input value /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// inline NdArray factorial(const NdArray& inArray) { diff --git a/include/NumCpp/Special/gamma.hpp b/include/NumCpp/Special/gamma.hpp index 93a3b379f..9b1fea933 100644 --- a/include/NumCpp/Special/gamma.hpp +++ b/include/NumCpp/Special/gamma.hpp @@ -44,10 +44,8 @@ namespace nc /// Returns the "true gamma" of value z. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto gamma(dtype inValue) @@ -62,10 +60,8 @@ namespace nc /// Returns the "true gamma" of values in array. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto gamma(const NdArray& inArray) diff --git a/include/NumCpp/Special/gamma1pm1.hpp b/include/NumCpp/Special/gamma1pm1.hpp index 584ecfd63..8f323dc4a 100644 --- a/include/NumCpp/Special/gamma1pm1.hpp +++ b/include/NumCpp/Special/gamma1pm1.hpp @@ -44,10 +44,8 @@ namespace nc /// Returns the true gamma(dz + 1) - 1 of value z. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto gamma1pm1(dtype inValue) @@ -62,10 +60,8 @@ namespace nc /// Returns the true gamma(dz + 1) - 1 of values in array. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto gamma1pm1(const NdArray& inArray) diff --git a/include/NumCpp/Special/log_gamma.hpp b/include/NumCpp/Special/log_gamma.hpp index dd83e3ce4..eeda0814f 100644 --- a/include/NumCpp/Special/log_gamma.hpp +++ b/include/NumCpp/Special/log_gamma.hpp @@ -44,10 +44,8 @@ namespace nc /// Returns natural log of the true gamma of value z. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto log_gamma(dtype inValue) @@ -62,10 +60,8 @@ namespace nc /// Returns natural log of the true gamma of values in array. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto log_gamma(const NdArray& inArray) diff --git a/include/NumCpp/Special/pnr.hpp b/include/NumCpp/Special/pnr.hpp index 72cae6b9c..d2f25f9c0 100644 --- a/include/NumCpp/Special/pnr.hpp +++ b/include/NumCpp/Special/pnr.hpp @@ -43,10 +43,9 @@ namespace nc // Method Description: /// Returns the number of permutaions of n choose r. P(n, r) /// - /// @param n: the total number of items - /// @param r: the number of items taken - /// @return - /// double + /// @param n: the total number of items + /// @param r: the number of items taken + /// @return double /// inline double pnr(uint32 n, uint32 r) { diff --git a/include/NumCpp/Special/polygamma.hpp b/include/NumCpp/Special/polygamma.hpp index 8b2cc3eb3..401eff273 100644 --- a/include/NumCpp/Special/polygamma.hpp +++ b/include/NumCpp/Special/polygamma.hpp @@ -47,8 +47,7 @@ namespace nc /// /// @param n: the nth derivative /// @param inValue - /// @return - /// calculated-result-type + /// @return calculated-result-type /// template auto polygamma(uint32 n, dtype inValue) @@ -66,8 +65,7 @@ namespace nc /// /// @param n: the nth derivative /// @param inArray - /// @return - /// NdArray + /// @return NdArray /// template auto polygamma(uint32 n, const NdArray& inArray) diff --git a/include/NumCpp/Special/prime.hpp b/include/NumCpp/Special/prime.hpp index 886063f4c..6a7d83217 100644 --- a/include/NumCpp/Special/prime.hpp +++ b/include/NumCpp/Special/prime.hpp @@ -48,10 +48,8 @@ namespace nc /// (starting from 2 as the zeroth prime: as 1 isn't terribly useful in practice). /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// n: the nth prime number to return - /// @return - /// uint32 + /// @param n: the nth prime number to return + /// @return uint32 /// inline uint32 prime(uint32 n) { @@ -69,10 +67,8 @@ namespace nc /// (starting from 2 as the zeroth prime: as 1 isn't terribly useful in practice). /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// inline NdArray prime(const NdArray& inArray) { diff --git a/include/NumCpp/Special/riemann_zeta.hpp b/include/NumCpp/Special/riemann_zeta.hpp index 68576b411..ea7e72d74 100644 --- a/include/NumCpp/Special/riemann_zeta.hpp +++ b/include/NumCpp/Special/riemann_zeta.hpp @@ -50,10 +50,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto riemann_zeta(dtype inValue) @@ -74,10 +72,8 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto riemann_zeta(const NdArray& inArray) diff --git a/include/NumCpp/Special/softmax.hpp b/include/NumCpp/Special/softmax.hpp index 9a433138d..3a6bde983 100644 --- a/include/NumCpp/Special/softmax.hpp +++ b/include/NumCpp/Special/softmax.hpp @@ -44,9 +44,9 @@ namespace nc /// the elements. That is, if x is a one-dimensional numpy array: /// softmax(x) = np.exp(x)/sum(np.exp(x)) /// - /// @param inArray - /// @param inAxis (Optional, default NONE) - /// @return NdArray + /// @param inArray + /// @param inAxis (Optional, default NONE) + /// @return NdArray /// template NdArray softmax(const NdArray& inArray, Axis inAxis = Axis::NONE) diff --git a/include/NumCpp/Special/spherical_bessel_jn.hpp b/include/NumCpp/Special/spherical_bessel_jn.hpp index a0cb5dd8d..f21c8f7b0 100644 --- a/include/NumCpp/Special/spherical_bessel_jn.hpp +++ b/include/NumCpp/Special/spherical_bessel_jn.hpp @@ -49,10 +49,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto spherical_bessel_jn(uint32 inV, dtype inX) @@ -72,10 +71,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto spherical_bessel_jn(uint32 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/spherical_bessel_yn.hpp b/include/NumCpp/Special/spherical_bessel_yn.hpp index 541021509..1e3e572b1 100644 --- a/include/NumCpp/Special/spherical_bessel_yn.hpp +++ b/include/NumCpp/Special/spherical_bessel_yn.hpp @@ -49,10 +49,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto spherical_bessel_yn(uint32 inV, dtype inX) @@ -72,10 +71,9 @@ namespace nc /// NOTE: Use of this function requires either using the Boost /// includes or a C++17 compliant compiler. /// - /// @param inV: the order of the bessel function - /// @param inArrayX: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArrayX: the input values + /// @return NdArray /// template auto spherical_bessel_yn(uint32 inV, const NdArray& inArrayX) diff --git a/include/NumCpp/Special/spherical_hankel_1.hpp b/include/NumCpp/Special/spherical_hankel_1.hpp index bef234911..e86b15e56 100644 --- a/include/NumCpp/Special/spherical_hankel_1.hpp +++ b/include/NumCpp/Special/spherical_hankel_1.hpp @@ -46,10 +46,9 @@ namespace nc /// Spherical Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// calculated-result-type + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return calculated-result-type /// template auto spherical_hankel_1(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Spherical Hankel funcion of the first kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inArray: the input values - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArray: the input values + /// @return NdArray /// template auto spherical_hankel_1(dtype1 inV, const NdArray& inArray) diff --git a/include/NumCpp/Special/spherical_hankel_2.hpp b/include/NumCpp/Special/spherical_hankel_2.hpp index cf5e5c374..6f7f5d9ed 100644 --- a/include/NumCpp/Special/spherical_hankel_2.hpp +++ b/include/NumCpp/Special/spherical_hankel_2.hpp @@ -46,10 +46,9 @@ namespace nc /// Spherical Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inX: the input value - /// @return - /// double + /// @param inV: the order of the bessel function + /// @param inX: the input value + /// @return double /// template std::complex spherical_hankel_2(dtype1 inV, dtype2 inX) @@ -65,10 +64,9 @@ namespace nc /// Spherical Hankel funcion of the second kind. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param inV: the order of the bessel function - /// @param inArray: the input value - /// @return - /// NdArray + /// @param inV: the order of the bessel function + /// @param inArray: the input value + /// @return NdArray /// template auto spherical_hankel_2(dtype1 inV, const NdArray& inArray) diff --git a/include/NumCpp/Special/trigamma.hpp b/include/NumCpp/Special/trigamma.hpp index 1c3a055ca..5bc65dcf1 100644 --- a/include/NumCpp/Special/trigamma.hpp +++ b/include/NumCpp/Special/trigamma.hpp @@ -45,10 +45,8 @@ namespace nc /// of the digamma function. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inValue - /// @return - /// calculated-result-type + /// @param inValue + /// @return calculated-result-type /// template auto trigamma(dtype inValue) @@ -64,10 +62,8 @@ namespace nc /// of the digamma function. /// NOTE: Use of this function requires using the Boost includes. /// - /// @param - /// inArray - /// @return - /// NdArray + /// @param inArray + /// @return NdArray /// template auto trigamma(const NdArray& inArray) diff --git a/include/NumCpp/Utils/cube.hpp b/include/NumCpp/Utils/cube.hpp index bf5c03001..8cbe0fe85 100644 --- a/include/NumCpp/Utils/cube.hpp +++ b/include/NumCpp/Utils/cube.hpp @@ -36,9 +36,9 @@ namespace nc //============================================================================ /// Cubes in input value /// - /// @param inValue + /// @param inValue /// - /// @return cubed value + /// @return cubed value /// template constexpr dtype cube(dtype inValue) noexcept diff --git a/include/NumCpp/Utils/essentiallyEqual.hpp b/include/NumCpp/Utils/essentiallyEqual.hpp index d163ed11c..7cfae5926 100644 --- a/include/NumCpp/Utils/essentiallyEqual.hpp +++ b/include/NumCpp/Utils/essentiallyEqual.hpp @@ -42,10 +42,10 @@ namespace nc //============================================================================ /// tests that 2 floating point values are "essentially equal" /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return bool + /// @return bool /// template::value, int> = 0> @@ -57,11 +57,11 @@ namespace nc //============================================================================ /// tests that 2 floating point values are "essentially equal" /// - /// @param inValue1 - /// @param inValue2 - /// @param inEpsilon + /// @param inValue1 + /// @param inValue2 + /// @param inEpsilon /// - /// @return bool + /// @return bool /// template::value, int> = 0> @@ -74,10 +74,10 @@ namespace nc //============================================================================ /// tests that 2 floating point values are "essentially equal" /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return bool + /// @return bool /// template::value, int> = 0> @@ -89,11 +89,11 @@ namespace nc //============================================================================ /// tests that 2 floating point values are "essentially equal" /// - /// @param inValue1 - /// @param inValue2 - /// @param inEpsilon + /// @param inValue1 + /// @param inValue2 + /// @param inEpsilon /// - /// @return bool + /// @return bool /// template::value, int> = 0> @@ -107,10 +107,10 @@ namespace nc //============================================================================ /// tests that 2 floating point values are "essentially equal" /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return bool + /// @return bool /// template::value, int> = 0> @@ -122,10 +122,10 @@ namespace nc //============================================================================ /// tests that 2 floating point values are "essentially equal" /// - /// @param inValue1 - /// @param inValue2 + /// @param inValue1 + /// @param inValue2 /// - /// @return bool + /// @return bool /// template::value, int> = 0> diff --git a/include/NumCpp/Utils/gaussian.hpp b/include/NumCpp/Utils/gaussian.hpp index 856264a61..b041c917b 100644 --- a/include/NumCpp/Utils/gaussian.hpp +++ b/include/NumCpp/Utils/gaussian.hpp @@ -39,11 +39,11 @@ namespace nc // Method Description: /// samples a 2D gaussian of mean zero and input STD sigma /// - /// @param inX - /// @param inY - /// @param inSigma + /// @param inX + /// @param inY + /// @param inSigma /// - /// @return dtype + /// @return dtype /// inline double gaussian(double inX, double inY, double inSigma) noexcept { diff --git a/include/NumCpp/Utils/gaussian1d.hpp b/include/NumCpp/Utils/gaussian1d.hpp index 559da8586..a3123b84c 100644 --- a/include/NumCpp/Utils/gaussian1d.hpp +++ b/include/NumCpp/Utils/gaussian1d.hpp @@ -39,11 +39,11 @@ namespace nc // Method Description: /// samples a 1D gaussian of input mean and sigma /// - /// @param inX - /// @param inMu - /// @param inSigma + /// @param inX + /// @param inMu + /// @param inSigma /// - /// @return dtype + /// @return dtype /// inline double gaussian1d(double inX, double inMu, double inSigma) noexcept { diff --git a/include/NumCpp/Utils/interp.hpp b/include/NumCpp/Utils/interp.hpp index b49d0b389..79efba618 100644 --- a/include/NumCpp/Utils/interp.hpp +++ b/include/NumCpp/Utils/interp.hpp @@ -34,11 +34,11 @@ namespace nc //============================================================================ /// Returns the linear interpolation between two points /// - /// @param inValue1 - /// @param inValue2 - /// @param inPercent + /// @param inValue1 + /// @param inValue2 + /// @param inPercent /// - /// @return linear interpolated point + /// @return linear interpolated point /// constexpr double interp(double inValue1, double inValue2, double inPercent) noexcept { diff --git a/include/NumCpp/Utils/num2str.hpp b/include/NumCpp/Utils/num2str.hpp index db5f3e0f1..52ba4a754 100644 --- a/include/NumCpp/Utils/num2str.hpp +++ b/include/NumCpp/Utils/num2str.hpp @@ -38,9 +38,9 @@ namespace nc //============================================================================ /// Converts the number into a string /// - /// @param inNumber + /// @param inNumber /// - /// @return std::string + /// @return std::string /// template std::string num2str(dtype inNumber) diff --git a/include/NumCpp/Utils/power.hpp b/include/NumCpp/Utils/power.hpp index 0406d5da1..f2a7b4d0c 100644 --- a/include/NumCpp/Utils/power.hpp +++ b/include/NumCpp/Utils/power.hpp @@ -39,10 +39,10 @@ namespace nc //============================================================================ /// Raises the input value to an integer power /// - /// @param inValue - /// @param inPower + /// @param inValue + /// @param inPower /// - /// @return inValue raised to inPower + /// @return inValue raised to inPower /// template dtype power(dtype inValue, uint8 inPower) noexcept diff --git a/include/NumCpp/Utils/powerf.hpp b/include/NumCpp/Utils/powerf.hpp index 2200d032e..2383afe2e 100644 --- a/include/NumCpp/Utils/powerf.hpp +++ b/include/NumCpp/Utils/powerf.hpp @@ -40,10 +40,10 @@ namespace nc //============================================================================ /// Raises the input value to a floating point power /// - /// @param inValue - /// @param inPower + /// @param inValue + /// @param inPower /// - /// @return inValue raised to inPower + /// @return inValue raised to inPower /// template auto powerf(dtype1 inValue, const dtype2 inPower) noexcept diff --git a/include/NumCpp/Utils/sqr.hpp b/include/NumCpp/Utils/sqr.hpp index c8049ad47..fd82d9148 100644 --- a/include/NumCpp/Utils/sqr.hpp +++ b/include/NumCpp/Utils/sqr.hpp @@ -36,9 +36,9 @@ namespace nc //============================================================================ /// Squares in input value /// - /// @param inValue + /// @param inValue /// - /// @return squared value + /// @return squared value /// template constexpr dtype sqr(dtype inValue) noexcept diff --git a/include/NumCpp/Utils/value2str.hpp b/include/NumCpp/Utils/value2str.hpp index 1d4e32f0e..7562183a0 100644 --- a/include/NumCpp/Utils/value2str.hpp +++ b/include/NumCpp/Utils/value2str.hpp @@ -40,9 +40,9 @@ namespace nc //============================================================================ /// Converts the value into a string /// - /// @param inValue + /// @param inValue /// - /// @return std::string + /// @return std::string /// template std::string value2str(dtype inValue) diff --git a/include/NumCpp/Vector/Vec2.hpp b/include/NumCpp/Vector/Vec2.hpp index f63b26840..ac9da14f4 100644 --- a/include/NumCpp/Vector/Vec2.hpp +++ b/include/NumCpp/Vector/Vec2.hpp @@ -62,8 +62,8 @@ namespace nc // Method Description: /// Constructor /// - /// @param inX: the x component - /// @param inY: the y component + /// @param inX: the x component + /// @param inY: the y component /// constexpr Vec2(double inX, double inY) noexcept : x(inX), @@ -74,7 +74,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param inList + /// @param inList /// Vec2(const std::initializer_list& inList) { @@ -91,7 +91,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param ndArray + /// @param ndArray /// Vec2(const NdArray& ndArray) { @@ -108,8 +108,8 @@ namespace nc // Method Description: /// Returns the angle between the two vectors /// - /// @param otherVec - /// @return the angle in radians + /// @param otherVec + /// @return the angle in radians /// double angle(const Vec2& otherVec) const noexcept { @@ -128,8 +128,8 @@ namespace nc /// Returns a copy of the vector with its magnitude clamped /// to maxLength /// - /// @param maxLength - /// @return Vec2 + /// @param maxLength + /// @return Vec2 /// Vec2 clampMagnitude(double maxLength) const noexcept { @@ -148,8 +148,8 @@ namespace nc // Method Description: /// Returns the distance between the two vectors /// - /// @param otherVec - /// @return the distance (equivalent to (a - b).norm() + /// @param otherVec + /// @return the distance (equivalent to (a - b).norm() /// double distance(const Vec2& otherVec) const noexcept { @@ -160,8 +160,8 @@ namespace nc // Method Description: /// Returns the dot product of the two vectors /// - /// @param otherVec - /// @return the dot product + /// @param otherVec + /// @return the dot product /// double dot(const Vec2& otherVec) const noexcept { @@ -214,7 +214,7 @@ namespace nc // Method Description: /// Returns the magnitude of the vector /// - /// @return magnitude of the vector + /// @return magnitude of the vector /// double norm() const noexcept { @@ -225,7 +225,7 @@ namespace nc // Method Description: /// Returns a new normalized Vec2 /// - /// @return Vec2 + /// @return Vec2 /// Vec2 normalize() const noexcept { @@ -236,8 +236,8 @@ namespace nc // Method Description: /// Projects the vector onto the input vector /// - /// @param otherVec - /// @return Vec2 + /// @param otherVec + /// @return Vec2 /// Vec2 project(const Vec2& otherVec) const noexcept { @@ -260,7 +260,7 @@ namespace nc // Method Description: /// Returns the Vec2 as a string /// - /// @return std::string + /// @return std::string /// std::string toString() const { @@ -273,7 +273,7 @@ namespace nc // Method Description: /// Returns the Vec2 as an NdArray /// - /// @return NdArray + /// @return NdArray /// NdArray toNdArray() const { @@ -296,7 +296,7 @@ namespace nc // Method Description: /// Equality operator /// - /// @param rhs + /// @param rhs /// @return bool /// bool operator==(const Vec2& rhs) const noexcept @@ -308,7 +308,7 @@ namespace nc // Method Description: /// Not Equality operator /// - /// @param rhs + /// @param rhs /// @return bool /// bool operator!=(const Vec2& rhs) const noexcept @@ -320,7 +320,7 @@ namespace nc // Method Description: /// Adds the scaler to the vector /// - /// @param scaler + /// @param scaler /// @return Vec2 /// Vec2& operator+=(double scaler) noexcept @@ -334,7 +334,7 @@ namespace nc // Method Description: /// Adds the two vectors /// - /// @param rhs + /// @param rhs /// @return Vec2 /// Vec2& operator+=(const Vec2& rhs) noexcept @@ -348,7 +348,7 @@ namespace nc // Method Description: /// Subtracts the scaler from the vector /// - /// @param scaler + /// @param scaler /// @return Vec2 /// Vec2& operator-=(double scaler) noexcept @@ -362,7 +362,7 @@ namespace nc // Method Description: /// Subtracts the two vectors /// - /// @param rhs + /// @param rhs /// @return Vec2 /// Vec2& operator-=(const Vec2& rhs) noexcept @@ -376,7 +376,7 @@ namespace nc // Method Description: /// Scalar mulitplication /// - /// @param scaler + /// @param scaler /// @return Vec2 /// Vec2& operator*=(double scaler) noexcept @@ -390,7 +390,7 @@ namespace nc // Method Description: /// Scalar division /// - /// @param scaler + /// @param scaler /// @return Vec2 /// Vec2& operator/=(double scaler) noexcept @@ -405,9 +405,9 @@ namespace nc // Method Description: /// Adds the scaler to the vector /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator+(const Vec2& lhs, double rhs) noexcept { @@ -418,9 +418,9 @@ namespace nc // Method Description: /// Adds the scaler to the vector /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator+(double lhs, const Vec2& rhs) noexcept { @@ -431,9 +431,9 @@ namespace nc // Method Description: /// Adds the two vectors /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator+(const Vec2& lhs, const Vec2& rhs) noexcept { @@ -444,7 +444,7 @@ namespace nc // Method Description: /// Returns the negative vector /// - /// @return Vec2 + /// @return Vec2 /// inline Vec2 operator-(const Vec2& vec) noexcept { @@ -455,9 +455,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the vector /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator-(const Vec2& lhs, double rhs) noexcept { @@ -468,9 +468,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the vector /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator-(double lhs, const Vec2& rhs) noexcept { @@ -481,9 +481,9 @@ namespace nc // Method Description: /// Subtracts the two vectors /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator-(const Vec2& lhs, const Vec2& rhs) noexcept { @@ -494,9 +494,9 @@ namespace nc // Method Description: /// Scalar mulitplication /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator*(const Vec2& lhs, double rhs) noexcept { @@ -507,9 +507,9 @@ namespace nc // Method Description: /// Scalar mulitplication /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator*(double lhs, const Vec2& rhs) noexcept { @@ -520,9 +520,9 @@ namespace nc // Method Description: /// Vector mulitplication (dot product) /// - /// @param lhs - /// @param rhs - /// @return dot product + /// @param lhs + /// @param rhs + /// @return dot product /// /// inline double operator*(const Vec2& lhs, const Vec2& rhs) noexcept @@ -534,9 +534,9 @@ namespace nc // Method Description: /// Scalar division /// - /// @param lhs - /// @param rhs - /// @return Vec2 + /// @param lhs + /// @param rhs + /// @return Vec2 /// inline Vec2 operator/(const Vec2& lhs, double rhs) noexcept { @@ -547,9 +547,9 @@ namespace nc // Method Description: /// stream output operator /// - /// @param stream - /// @param vec - /// @return std::ostream + /// @param stream + /// @param vec + /// @return std::ostream /// inline std::ostream& operator<<(std::ostream& stream, const Vec2& vec) { diff --git a/include/NumCpp/Vector/Vec3.hpp b/include/NumCpp/Vector/Vec3.hpp index 9f34cb63e..768c914d4 100644 --- a/include/NumCpp/Vector/Vec3.hpp +++ b/include/NumCpp/Vector/Vec3.hpp @@ -64,9 +64,9 @@ namespace nc // Method Description: /// Constructor /// - /// @param inX: the x component - /// @param inY: the y component - /// @param inZ: the y component + /// @param inX: the x component + /// @param inY: the y component + /// @param inZ: the y component /// constexpr Vec3(double inX, double inY, double inZ) noexcept : x(inX), @@ -78,7 +78,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param inList + /// @param inList /// Vec3(const std::initializer_list& inList) { @@ -96,7 +96,7 @@ namespace nc // Method Description: /// Constructor /// - /// @param ndArray + /// @param ndArray /// Vec3(const NdArray& ndArray) { @@ -114,8 +114,8 @@ namespace nc // Method Description: /// Returns the angle between the two vectors /// - /// @param otherVec - /// @return the angle in radians + /// @param otherVec + /// @return the angle in radians /// double angle(const Vec3& otherVec) const noexcept { @@ -145,8 +145,8 @@ namespace nc /// Returns a copy of the vector with its magnitude clamped /// to maxLength /// - /// @param maxLength - /// @return Vec3 + /// @param maxLength + /// @return Vec3 /// Vec3 clampMagnitude(double maxLength) const noexcept { @@ -165,8 +165,8 @@ namespace nc // Method Description: /// Returns the cross product of the two vectors /// - /// @param otherVec - /// @return the dot product + /// @param otherVec + /// @return the dot product /// Vec3 cross(const Vec3& otherVec) const noexcept { @@ -181,8 +181,8 @@ namespace nc // Method Description: /// Returns the distance between the two vectors /// - /// @param otherVec - /// @return the distance (equivalent to (a - b).norm() + /// @param otherVec + /// @return the distance (equivalent to (a - b).norm() /// double distance(const Vec3& otherVec) const noexcept { @@ -193,8 +193,8 @@ namespace nc // Method Description: /// Returns the dot product of the two vectors /// - /// @param otherVec - /// @return the dot product + /// @param otherVec + /// @return the dot product /// double dot(const Vec3& otherVec) const noexcept { @@ -259,7 +259,7 @@ namespace nc // Method Description: /// Returns the magnitude of the vector /// - /// @return magnitude of the vector + /// @return magnitude of the vector /// double norm() const noexcept { @@ -270,7 +270,7 @@ namespace nc // Method Description: /// Returns a new normalized Vec3 /// - /// @return Vec3 + /// @return Vec3 /// Vec3 normalize() const noexcept { @@ -281,8 +281,8 @@ namespace nc // Method Description: /// Projects the vector onto the input vector /// - /// @param otherVec - /// @return Vec3 + /// @param otherVec + /// @return Vec3 /// Vec3 project(const Vec3& otherVec) const noexcept { @@ -305,7 +305,7 @@ namespace nc // Method Description: /// Returns the Vec3 as a string /// - /// @return std::string + /// @return std::string /// std::string toString() const { @@ -318,7 +318,7 @@ namespace nc // Method Description: /// Returns the Vec2 as an NdArray /// - /// @return NdArray + /// @return NdArray /// NdArray toNdArray() const { @@ -341,7 +341,7 @@ namespace nc // Method Description: /// Equality operator /// - /// @param rhs + /// @param rhs /// @return bool /// bool operator==(const Vec3& rhs) const noexcept @@ -355,7 +355,7 @@ namespace nc // Method Description: /// Not Equality operator /// - /// @param rhs + /// @param rhs /// @return bool /// bool operator!=(const Vec3& rhs) const noexcept @@ -367,7 +367,7 @@ namespace nc // Method Description: /// Adds the scaler to the vector /// - /// @param scaler + /// @param scaler /// @return Vec3 /// Vec3& operator+=(double scaler) noexcept @@ -382,7 +382,7 @@ namespace nc // Method Description: /// Adds the two vectors /// - /// @param rhs + /// @param rhs /// @return Vec3 /// Vec3& operator+=(const Vec3& rhs) noexcept @@ -397,7 +397,7 @@ namespace nc // Method Description: /// Subtracts the scaler from the vector /// - /// @param scaler + /// @param scaler /// @return Vec3 /// Vec3& operator-=(double scaler) noexcept @@ -412,7 +412,7 @@ namespace nc // Method Description: /// Subtracts the two vectors /// - /// @param rhs + /// @param rhs /// @return Vec3 /// Vec3& operator-=(const Vec3& rhs) noexcept @@ -427,7 +427,7 @@ namespace nc // Method Description: /// Scalar mulitplication /// - /// @param scaler + /// @param scaler /// @return Vec3 /// Vec3& operator*=(double scaler) noexcept @@ -442,7 +442,7 @@ namespace nc // Method Description: /// Scalar division /// - /// @param scaler + /// @param scaler /// @return Vec3 /// Vec3& operator/=(double scaler) noexcept @@ -458,9 +458,9 @@ namespace nc // Method Description: /// Adds the scaler to the vector /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator+(const Vec3& lhs, double rhs) noexcept { @@ -471,9 +471,9 @@ namespace nc // Method Description: /// Adds the scaler to the vector /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator+(double lhs, const Vec3& rhs) noexcept { @@ -484,9 +484,9 @@ namespace nc // Method Description: /// Adds the two vectors /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator+(const Vec3& lhs, const Vec3& rhs) noexcept { @@ -497,7 +497,7 @@ namespace nc // Method Description: /// Returns the negative vector /// - /// @return Vec3 + /// @return Vec3 /// inline Vec3 operator-(const Vec3& vec) noexcept { @@ -508,9 +508,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the vector /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator-(const Vec3& lhs, double rhs) noexcept { @@ -521,9 +521,9 @@ namespace nc // Method Description: /// Subtracts the scaler from the vector /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator-(double lhs, const Vec3& rhs) noexcept { @@ -534,9 +534,9 @@ namespace nc // Method Description: /// Subtracts the two vectors /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator-(const Vec3& lhs, const Vec3& rhs) noexcept { @@ -547,9 +547,9 @@ namespace nc // Method Description: /// Scalar mulitplication /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator*(const Vec3& lhs, double rhs) noexcept { @@ -560,9 +560,9 @@ namespace nc // Method Description: /// Scalar mulitplication /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator*(double lhs, const Vec3& rhs) noexcept { @@ -573,9 +573,9 @@ namespace nc // Method Description: /// Vector mulitplication (dot product) /// - /// @param lhs - /// @param rhs - /// @return dot product + /// @param lhs + /// @param rhs + /// @return dot product /// /// inline double operator*(const Vec3& lhs, const Vec3& rhs) noexcept @@ -587,9 +587,9 @@ namespace nc // Method Description: /// Scalar division /// - /// @param lhs - /// @param rhs - /// @return Vec3 + /// @param lhs + /// @param rhs + /// @return Vec3 /// inline Vec3 operator/(const Vec3& lhs, double rhs) noexcept { @@ -600,9 +600,9 @@ namespace nc // Method Description: /// stream output operator /// - /// @param stream - /// @param vec - /// @return std::ostream + /// @param stream + /// @param vec + /// @return std::ostream /// inline std::ostream& operator<<(std::ostream& stream, const Vec3& vec) { From 423c2c569324e074a6a6c727ba4d11354eb84c9a Mon Sep 17 00:00:00 2001 From: "Pilger, David" Date: Tue, 4 Jan 2022 16:37:08 -0700 Subject: [PATCH 28/31] fixed a bug in uniformOnSphere --- develop/ToDo.md | 4 ---- docs/markdown/ReleaseNotes.md | 2 +- include/NumCpp/Random/uniformOnSphere.hpp | 11 ++++++++--- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/develop/ToDo.md b/develop/ToDo.md index 7e04ffc39..c7fe9acc7 100644 --- a/develop/ToDo.md +++ b/develop/ToDo.md @@ -1,7 +1,3 @@ ## Changes * should the indices operator() and [] sort and take unique of the indices? This is not inline with NumPy - -## Cleanup - - * cleanup all doxygen doc strings? diff --git a/docs/markdown/ReleaseNotes.md b/docs/markdown/ReleaseNotes.md index ab6235934..b46f7ad04 100644 --- a/docs/markdown/ReleaseNotes.md +++ b/docs/markdown/ReleaseNotes.md @@ -22,7 +22,7 @@ * added `select` function, https://numpy.org/doc/stable/reference/generated/numpy.select.html * `fmod` and the modulus `%` operator now work with float dtypes * added Hamming EDAC (Error Dectection and Correction) `encode` and `decode` functions, https://en.wikipedia.org/wiki/Hamming_code -* minor performance improvements +* various minor performance improvements and bug fixes ## Version 2.6.2 diff --git a/include/NumCpp/Random/uniformOnSphere.hpp b/include/NumCpp/Random/uniformOnSphere.hpp index 13f20bd1c..0a4cbd124 100644 --- a/include/NumCpp/Random/uniformOnSphere.hpp +++ b/include/NumCpp/Random/uniformOnSphere.hpp @@ -60,13 +60,18 @@ namespace nc { STATIC_ASSERT_FLOAT(dtype); - boost::random::uniform_on_sphere dist(inDims); + if (inNumPoints == 0) + { + return {}; + } + + boost::random::uniform_on_sphere dist(static_cast(inDims)); NdArray returnArray(inNumPoints, inDims); for (uint32 row = 0; row < inNumPoints; ++row) { - std::vector point = dist(generator_); - std::copy(returnArray.begin(row), returnArray.end(row), point.begin()); + const auto& point = dist(generator_); + std::copy(point.begin(), point.end(), returnArray.begin(row)); } return returnArray; From 988bbe34a35990b8a1ea52f8f3d86ee2c68d5ef0 Mon Sep 17 00:00:00 2001 From: David Pilger Date: Tue, 4 Jan 2022 20:42:16 -0700 Subject: [PATCH 29/31] updated doxygen docs --- docs/doxygen/html/_bisection_8hpp.html | 24 +- docs/doxygen/html/_bisection_8hpp_source.html | 13 +- docs/doxygen/html/_boost_interface_8hpp.html | 18 +- .../html/_boost_interface_8hpp_source.html | 13 +- .../_boost_numpy_ndarray_helper_8hpp.html | 18 +- ...oost_numpy_ndarray_helper_8hpp_source.html | 19 +- docs/doxygen/html/_boundary_8hpp.html | 22 +- docs/doxygen/html/_boundary_8hpp_source.html | 11 +- docs/doxygen/html/_brent_8hpp.html | 24 +- docs/doxygen/html/_brent_8hpp_source.html | 15 +- docs/doxygen/html/_building_8md.html | 8 +- docs/doxygen/html/_centroid_8hpp.html | 22 +- docs/doxygen/html/_centroid_8hpp_source.html | 235 +- docs/doxygen/html/_cluster_8hpp.html | 22 +- docs/doxygen/html/_cluster_8hpp_source.html | 427 +- docs/doxygen/html/_cluster_maker_8hpp.html | 22 +- .../html/_cluster_maker_8hpp_source.html | 504 +- docs/doxygen/html/_compiler_flags_8md.html | 8 +- docs/doxygen/html/_constants_8hpp.html | 22 +- docs/doxygen/html/_constants_8hpp_source.html | 11 +- docs/doxygen/html/_coordinate_8hpp.html | 22 +- .../doxygen/html/_coordinate_8hpp_source.html | 30 +- docs/doxygen/html/_coordinates_8hpp.html | 18 +- .../html/_coordinates_8hpp_source.html | 11 +- docs/doxygen/html/_core_2_shape_8hpp.html | 20 +- .../html/_core_2_shape_8hpp_source.html | 11 +- docs/doxygen/html/_core_8hpp.html | 18 +- docs/doxygen/html/_core_8hpp_source.html | 11 +- docs/doxygen/html/_d_c_m_8hpp.html | 22 +- docs/doxygen/html/_d_c_m_8hpp_source.html | 209 +- docs/doxygen/html/_data_cube_8hpp.html | 20 +- docs/doxygen/html/_data_cube_8hpp_source.html | 19 +- docs/doxygen/html/_dec_8hpp.html | 22 +- docs/doxygen/html/_dec_8hpp.js | 2 +- docs/doxygen/html/_dec_8hpp_source.html | 15 +- docs/doxygen/html/_dekker_8hpp.html | 24 +- docs/doxygen/html/_dekker_8hpp_source.html | 13 +- docs/doxygen/html/_dtype_info_8hpp.html | 20 +- .../doxygen/html/_dtype_info_8hpp_source.html | 17 +- docs/doxygen/html/_endian_8hpp.html | 22 +- docs/doxygen/html/_endian_8hpp_source.html | 11 +- docs/doxygen/html/_error_8hpp.html | 22 +- docs/doxygen/html/_error_8hpp_source.html | 11 +- docs/doxygen/html/_filesystem_8hpp.html | 22 +- .../doxygen/html/_filesystem_8hpp_source.html | 13 +- ...r_2_filters_2_filters2d_2laplace_8hpp.html | 22 +- ...ters_2_filters2d_2laplace_8hpp_source.html | 31 +- docs/doxygen/html/_filter_8hpp.html | 18 +- docs/doxygen/html/_filter_8hpp_source.html | 11 +- .../doxygen/html/_functions_2_shape_8hpp.html | 20 +- .../html/_functions_2_shape_8hpp_source.html | 25 +- docs/doxygen/html/_functions_2cube_8hpp.html | 20 +- .../html/_functions_2cube_8hpp_source.html | 67 +- .../doxygen/html/_functions_2interp_8hpp.html | 20 +- .../html/_functions_2interp_8hpp_source.html | 131 +- docs/doxygen/html/_functions_2power_8hpp.html | 20 +- .../html/_functions_2power_8hpp_source.html | 103 +- .../doxygen/html/_functions_2powerf_8hpp.html | 20 +- .../html/_functions_2powerf_8hpp_source.html | 103 +- docs/doxygen/html/_functions_8hpp.html | 37 +- docs/doxygen/html/_functions_8hpp_source.html | 474 +- .../html/_gauss_newton_nlls_8cpp-example.html | 56 +- docs/doxygen/html/_image_processing_8hpp.html | 18 +- .../html/_image_processing_8hpp_source.html | 11 +- docs/doxygen/html/_installation_8md.html | 8 +- docs/doxygen/html/_integrate_8hpp.html | 18 +- docs/doxygen/html/_integrate_8hpp_source.html | 11 +- .../_interface_with_eigen_8cpp-example.html | 12 +- ..._interface_with_open_c_v_8cpp-example.html | 14 +- docs/doxygen/html/_iteration_8hpp.html | 24 +- docs/doxygen/html/_iteration_8hpp_source.html | 11 +- docs/doxygen/html/_linalg_8hpp.html | 18 +- docs/doxygen/html/_linalg_8hpp_source.html | 11 +- docs/doxygen/html/_nd_array_8hpp.html | 18 +- docs/doxygen/html/_nd_array_8hpp_source.html | 11 +- docs/doxygen/html/_nd_array_core_8hpp.html | 20 +- .../html/_nd_array_core_8hpp_source.html | 7238 ++++++++--------- .../html/_nd_array_iterators_8hpp.html | 20 +- docs/doxygen/html/_nd_array_iterators_8hpp.js | 8 +- .../html/_nd_array_iterators_8hpp_source.html | 11 +- .../html/_nd_array_operators_8hpp.html | 40 +- docs/doxygen/html/_nd_array_operators_8hpp.js | 6 +- .../html/_nd_array_operators_8hpp_source.html | 3194 ++++---- docs/doxygen/html/_newton_8hpp.html | 24 +- docs/doxygen/html/_newton_8hpp_source.html | 13 +- docs/doxygen/html/_num_cpp_8hpp.html | 8 +- docs/doxygen/html/_num_cpp_8hpp_source.html | 11 +- docs/doxygen/html/_pixel_8hpp.html | 22 +- docs/doxygen/html/_pixel_8hpp_source.html | 127 +- docs/doxygen/html/_poly1d_8hpp.html | 22 +- docs/doxygen/html/_poly1d_8hpp_source.html | 845 +- docs/doxygen/html/_polynomial_8hpp.html | 18 +- .../doxygen/html/_polynomial_8hpp_source.html | 11 +- docs/doxygen/html/_pybind_interface_8hpp.html | 18 +- .../html/_pybind_interface_8hpp_source.html | 15 +- docs/doxygen/html/_python_interface_8hpp.html | 18 +- .../html/_python_interface_8hpp_source.html | 11 +- docs/doxygen/html/_quaternion_8hpp.html | 22 +- .../doxygen/html/_quaternion_8hpp_source.html | 1231 +-- docs/doxygen/html/_r_a_8hpp.html | 22 +- docs/doxygen/html/_r_a_8hpp_source.html | 13 +- docs/doxygen/html/_r_e_a_d_m_e_8md.html | 8 +- docs/doxygen/html/_random_2beta_8hpp.html | 22 +- .../html/_random_2beta_8hpp_source.html | 117 +- docs/doxygen/html/_random_2gamma_8hpp.html | 22 +- .../html/_random_2gamma_8hpp_source.html | 113 +- docs/doxygen/html/_random_2laplace_8hpp.html | 22 +- .../html/_random_2laplace_8hpp_source.html | 77 +- docs/doxygen/html/_random_8hpp.html | 18 +- docs/doxygen/html/_random_8hpp_source.html | 11 +- docs/doxygen/html/_read_me_8cpp-example.html | 246 +- docs/doxygen/html/_release_notes_8md.html | 8 +- docs/doxygen/html/_roots_8hpp.html | 18 +- docs/doxygen/html/_roots_8hpp_source.html | 11 +- docs/doxygen/html/_rotations_8hpp.html | 18 +- docs/doxygen/html/_rotations_8hpp_source.html | 11 +- docs/doxygen/html/_s_v_d_class_8hpp.html | 20 +- .../html/_s_v_d_class_8hpp_source.html | 1126 +-- docs/doxygen/html/_secant_8hpp.html | 24 +- docs/doxygen/html/_secant_8hpp_source.html | 13 +- docs/doxygen/html/_slice_8hpp.html | 20 +- docs/doxygen/html/_slice_8hpp_source.html | 9 +- docs/doxygen/html/_special_2beta_8hpp.html | 22 +- .../html/_special_2beta_8hpp_source.html | 87 +- docs/doxygen/html/_special_2gamma_8hpp.html | 22 +- .../html/_special_2gamma_8hpp_source.html | 75 +- docs/doxygen/html/_special_8hpp.html | 18 +- docs/doxygen/html/_special_8hpp_source.html | 11 +- docs/doxygen/html/_static_asserts_8hpp.html | 18 +- .../html/_static_asserts_8hpp_source.html | 11 +- .../html/_std_complex_operators_8hpp.html | 20 +- .../_std_complex_operators_8hpp_source.html | 11 +- docs/doxygen/html/_stl_algorithms_8hpp.html | 22 +- .../html/_stl_algorithms_8hpp_source.html | 13 +- docs/doxygen/html/_timer_8hpp.html | 20 +- docs/doxygen/html/_timer_8hpp_source.html | 11 +- docs/doxygen/html/_type_traits_8hpp.html | 25 +- docs/doxygen/html/_type_traits_8hpp.js | 16 +- .../html/_type_traits_8hpp_source.html | 31 +- docs/doxygen/html/_types_8hpp.html | 20 +- docs/doxygen/html/_types_8hpp_source.html | 11 +- docs/doxygen/html/_utils_2cube_8hpp.html | 22 +- .../html/_utils_2cube_8hpp_source.html | 11 +- docs/doxygen/html/_utils_2interp_8hpp.html | 22 +- .../html/_utils_2interp_8hpp_source.html | 11 +- docs/doxygen/html/_utils_2power_8hpp.html | 22 +- .../html/_utils_2power_8hpp_source.html | 11 +- docs/doxygen/html/_utils_2powerf_8hpp.html | 22 +- .../html/_utils_2powerf_8hpp_source.html | 11 +- docs/doxygen/html/_utils_8hpp.html | 18 +- docs/doxygen/html/_utils_8hpp_source.html | 11 +- docs/doxygen/html/_vec2_8hpp.html | 20 +- docs/doxygen/html/_vec2_8hpp.js | 2 +- docs/doxygen/html/_vec2_8hpp_source.html | 33 +- docs/doxygen/html/_vec3_8hpp.html | 20 +- docs/doxygen/html/_vec3_8hpp.js | 2 +- docs/doxygen/html/_vec3_8hpp_source.html | 33 +- docs/doxygen/html/_vector_8hpp.html | 18 +- docs/doxygen/html/_vector_8hpp_source.html | 11 +- docs/doxygen/html/_version_8hpp.html | 22 +- docs/doxygen/html/_version_8hpp_source.html | 13 +- docs/doxygen/html/abs_8hpp.html | 20 +- docs/doxygen/html/abs_8hpp_source.html | 69 +- docs/doxygen/html/add_8hpp.html | 20 +- docs/doxygen/html/add_8hpp_source.html | 153 +- docs/doxygen/html/add_boundary1d_8hpp.html | 24 +- .../html/add_boundary1d_8hpp_source.html | 113 +- docs/doxygen/html/add_boundary2d_8hpp.html | 24 +- .../html/add_boundary2d_8hpp_source.html | 111 +- docs/doxygen/html/airy__ai_8hpp.html | 22 +- docs/doxygen/html/airy__ai_8hpp_source.html | 77 +- docs/doxygen/html/airy__ai__prime_8hpp.html | 22 +- .../html/airy__ai__prime_8hpp_source.html | 77 +- docs/doxygen/html/airy__bi_8hpp.html | 22 +- docs/doxygen/html/airy__bi_8hpp_source.html | 77 +- docs/doxygen/html/airy__bi__prime_8hpp.html | 22 +- .../html/airy__bi__prime_8hpp_source.html | 77 +- docs/doxygen/html/alen_8hpp.html | 20 +- docs/doxygen/html/alen_8hpp_source.html | 25 +- docs/doxygen/html/all_8hpp.html | 20 +- docs/doxygen/html/all_8hpp_source.html | 29 +- docs/doxygen/html/allclose_8hpp.html | 20 +- docs/doxygen/html/allclose_8hpp_source.html | 61 +- docs/doxygen/html/amax_8hpp.html | 20 +- docs/doxygen/html/amax_8hpp_source.html | 27 +- docs/doxygen/html/amin_8hpp.html | 20 +- docs/doxygen/html/amin_8hpp_source.html | 27 +- docs/doxygen/html/angle_8hpp.html | 20 +- docs/doxygen/html/angle_8hpp_source.html | 61 +- docs/doxygen/html/annotated.html | 35 +- docs/doxygen/html/annotated_dup.js | 1 + docs/doxygen/html/any_8hpp.html | 20 +- docs/doxygen/html/any_8hpp_source.html | 29 +- docs/doxygen/html/append_8hpp.html | 20 +- docs/doxygen/html/append_8hpp_source.html | 131 +- docs/doxygen/html/apply_function_8hpp.html | 20 +- .../html/apply_function_8hpp_source.html | 29 +- docs/doxygen/html/apply_poly1d_8hpp.html | 20 +- .../html/apply_poly1d_8hpp_source.html | 25 +- docs/doxygen/html/apply_threshold_8hpp.html | 22 +- .../html/apply_threshold_8hpp_source.html | 33 +- docs/doxygen/html/arange_8hpp.html | 20 +- docs/doxygen/html/arange_8hpp_source.html | 133 +- docs/doxygen/html/arccos_8hpp.html | 20 +- docs/doxygen/html/arccos_8hpp_source.html | 67 +- docs/doxygen/html/arccosh_8hpp.html | 20 +- docs/doxygen/html/arccosh_8hpp_source.html | 67 +- docs/doxygen/html/arcsin_8hpp.html | 20 +- docs/doxygen/html/arcsin_8hpp_source.html | 67 +- docs/doxygen/html/arcsinh_8hpp.html | 20 +- docs/doxygen/html/arcsinh_8hpp_source.html | 67 +- docs/doxygen/html/arctan2_8hpp.html | 20 +- docs/doxygen/html/arctan2_8hpp_source.html | 77 +- docs/doxygen/html/arctan_8hpp.html | 20 +- docs/doxygen/html/arctan_8hpp_source.html | 67 +- docs/doxygen/html/arctanh_8hpp.html | 20 +- docs/doxygen/html/arctanh_8hpp_source.html | 67 +- docs/doxygen/html/argmax_8hpp.html | 20 +- docs/doxygen/html/argmax_8hpp_source.html | 27 +- docs/doxygen/html/argmin_8hpp.html | 20 +- docs/doxygen/html/argmin_8hpp_source.html | 27 +- docs/doxygen/html/argsort_8hpp.html | 20 +- docs/doxygen/html/argsort_8hpp_source.html | 27 +- docs/doxygen/html/argwhere_8hpp.html | 20 +- docs/doxygen/html/argwhere_8hpp_source.html | 27 +- docs/doxygen/html/around_8hpp.html | 20 +- docs/doxygen/html/around_8hpp_source.html | 45 +- docs/doxygen/html/array__equal_8hpp.html | 20 +- .../html/array__equal_8hpp_source.html | 37 +- docs/doxygen/html/array__equiv_8hpp.html | 20 +- .../html/array__equiv_8hpp_source.html | 61 +- docs/doxygen/html/asarray_8hpp.html | 20 +- docs/doxygen/html/asarray_8hpp_source.html | 269 +- docs/doxygen/html/astype_8hpp.html | 20 +- docs/doxygen/html/astype_8hpp_source.html | 25 +- docs/doxygen/html/average_8hpp.html | 20 +- docs/doxygen/html/average_8hpp_source.html | 373 +- docs/doxygen/html/bartlett_8hpp.html | 128 + docs/doxygen/html/bartlett_8hpp.js | 4 + docs/doxygen/html/bartlett_8hpp_source.html | 142 + docs/doxygen/html/bernoilli_8hpp.html | 22 +- docs/doxygen/html/bernoilli_8hpp_source.html | 83 +- docs/doxygen/html/bernoulli_8hpp.html | 22 +- docs/doxygen/html/bernoulli_8hpp_source.html | 87 +- docs/doxygen/html/bessel__in_8hpp.html | 22 +- docs/doxygen/html/bessel__in_8hpp_source.html | 85 +- docs/doxygen/html/bessel__in__prime_8hpp.html | 22 +- .../html/bessel__in__prime_8hpp_source.html | 77 +- docs/doxygen/html/bessel__jn_8hpp.html | 22 +- docs/doxygen/html/bessel__jn_8hpp_source.html | 85 +- docs/doxygen/html/bessel__jn__prime_8hpp.html | 22 +- .../html/bessel__jn__prime_8hpp_source.html | 77 +- docs/doxygen/html/bessel__kn_8hpp.html | 22 +- docs/doxygen/html/bessel__kn_8hpp_source.html | 85 +- docs/doxygen/html/bessel__kn__prime_8hpp.html | 22 +- .../html/bessel__kn__prime_8hpp_source.html | 77 +- docs/doxygen/html/bessel__yn_8hpp.html | 22 +- docs/doxygen/html/bessel__yn_8hpp_source.html | 85 +- docs/doxygen/html/bessel__yn__prime_8hpp.html | 22 +- .../html/bessel__yn__prime_8hpp_source.html | 77 +- docs/doxygen/html/binary_repr_8hpp.html | 20 +- .../doxygen/html/binary_repr_8hpp_source.html | 29 +- docs/doxygen/html/bincount_8hpp.html | 20 +- docs/doxygen/html/bincount_8hpp_source.html | 167 +- docs/doxygen/html/binomial_8hpp.html | 22 +- docs/doxygen/html/binomial_8hpp_source.html | 113 +- docs/doxygen/html/bitwise__and_8hpp.html | 20 +- .../html/bitwise__and_8hpp_source.html | 25 +- docs/doxygen/html/bitwise__not_8hpp.html | 20 +- .../html/bitwise__not_8hpp_source.html | 25 +- docs/doxygen/html/bitwise__or_8hpp.html | 20 +- .../doxygen/html/bitwise__or_8hpp_source.html | 25 +- docs/doxygen/html/bitwise__xor_8hpp.html | 20 +- .../html/bitwise__xor_8hpp_source.html | 25 +- docs/doxygen/html/blackman_8hpp.html | 129 + docs/doxygen/html/blackman_8hpp.js | 4 + docs/doxygen/html/blackman_8hpp_source.html | 145 + docs/doxygen/html/byteswap_8hpp.html | 20 +- docs/doxygen/html/byteswap_8hpp_source.html | 31 +- docs/doxygen/html/cauchy_8hpp.html | 22 +- docs/doxygen/html/cauchy_8hpp_source.html | 93 +- docs/doxygen/html/cbrt_8hpp.html | 20 +- docs/doxygen/html/cbrt_8hpp_source.html | 71 +- docs/doxygen/html/ceil_8hpp.html | 20 +- docs/doxygen/html/ceil_8hpp_source.html | 19 +- docs/doxygen/html/center_of_mass_8hpp.html | 20 +- .../html/center_of_mass_8hpp_source.html | 21 +- docs/doxygen/html/centroid_clusters_8hpp.html | 22 +- .../html/centroid_clusters_8hpp_source.html | 45 +- docs/doxygen/html/chebyshev__t_8hpp.html | 22 +- .../html/chebyshev__t_8hpp_source.html | 79 +- docs/doxygen/html/chebyshev__u_8hpp.html | 22 +- .../html/chebyshev__u_8hpp_source.html | 79 +- docs/doxygen/html/chi_square_8hpp.html | 22 +- docs/doxygen/html/chi_square_8hpp_source.html | 93 +- docs/doxygen/html/choice_8hpp.html | 22 +- docs/doxygen/html/choice_8hpp_source.html | 87 +- docs/doxygen/html/cholesky_8hpp.html | 24 +- docs/doxygen/html/cholesky_8hpp_source.html | 19 +- docs/doxygen/html/classes.html | 29 +- docs/doxygen/html/classnc_1_1_data_cube.html | 90 +- docs/doxygen/html/classnc_1_1_dtype_info.html | 26 +- ..._01std_1_1complex_3_01dtype_01_4_01_4.html | 26 +- docs/doxygen/html/classnc_1_1_nd_array.html | 618 +- docs/doxygen/html/classnc_1_1_nd_array.js | 2 +- .../classnc_1_1_nd_array_column_iterator.html | 54 +- ...nc_1_1_nd_array_const_column_iterator.html | 54 +- .../classnc_1_1_nd_array_const_iterator.html | 54 +- .../html/classnc_1_1_nd_array_iterator.html | 54 +- docs/doxygen/html/classnc_1_1_shape.html | 32 +- docs/doxygen/html/classnc_1_1_slice.html | 32 +- docs/doxygen/html/classnc_1_1_timer.html | 26 +- docs/doxygen/html/classnc_1_1_vec2.html | 62 +- docs/doxygen/html/classnc_1_1_vec3.html | 68 +- ...classnc_1_1coordinates_1_1_coordinate.html | 52 +- .../html/classnc_1_1coordinates_1_1_dec.html | 38 +- .../html/classnc_1_1coordinates_1_1_r_a.html | 36 +- .../html/classnc_1_1filesystem_1_1_file.html | 24 +- ...ssnc_1_1image_processing_1_1_centroid.html | 38 +- ...assnc_1_1image_processing_1_1_cluster.html | 60 +- ...1_1image_processing_1_1_cluster_maker.html | 26 +- ...classnc_1_1image_processing_1_1_pixel.html | 30 +- ..._1_1integrate_1_1_legendre_polynomial.html | 16 +- .../html/classnc_1_1linalg_1_1_s_v_d.html | 20 +- .../classnc_1_1polynomial_1_1_poly1d.html | 58 +- .../html/classnc_1_1roots_1_1_bisection.html | 24 +- .../html/classnc_1_1roots_1_1_brent.html | 24 +- .../html/classnc_1_1roots_1_1_dekker.html | 24 +- .../html/classnc_1_1roots_1_1_iteration.html | 22 +- .../html/classnc_1_1roots_1_1_newton.html | 24 +- .../html/classnc_1_1roots_1_1_secant.html | 24 +- .../html/classnc_1_1rotations_1_1_d_c_m.html | 38 +- .../classnc_1_1rotations_1_1_quaternion.html | 116 +- docs/doxygen/html/clip_8hpp.html | 20 +- docs/doxygen/html/clip_8hpp_source.html | 83 +- docs/doxygen/html/cluster_pixels_8hpp.html | 22 +- .../html/cluster_pixels_8hpp_source.html | 35 +- docs/doxygen/html/cnr_8hpp.html | 22 +- docs/doxygen/html/cnr_8hpp_source.html | 29 +- docs/doxygen/html/column__stack_8hpp.html | 20 +- .../html/column__stack_8hpp_source.html | 93 +- docs/doxygen/html/comp__ellint__1_8hpp.html | 22 +- .../html/comp__ellint__1_8hpp_source.html | 87 +- docs/doxygen/html/comp__ellint__2_8hpp.html | 22 +- .../html/comp__ellint__2_8hpp_source.html | 87 +- docs/doxygen/html/comp__ellint__3_8hpp.html | 22 +- .../html/comp__ellint__3_8hpp_source.html | 99 +- .../complementary_median_filter1d_8hpp.html | 22 +- ...lementary_median_filter1d_8hpp_source.html | 37 +- .../complementary_median_filter_8hpp.html | 22 +- ...mplementary_median_filter_8hpp_source.html | 37 +- docs/doxygen/html/complex_8hpp.html | 20 +- docs/doxygen/html/complex_8hpp_source.html | 129 +- docs/doxygen/html/concatenate_8hpp.html | 20 +- .../doxygen/html/concatenate_8hpp_source.html | 97 +- docs/doxygen/html/conj_8hpp.html | 20 +- docs/doxygen/html/conj_8hpp_source.html | 63 +- docs/doxygen/html/constant1d_8hpp.html | 24 +- docs/doxygen/html/constant1d_8hpp_source.html | 59 +- docs/doxygen/html/constant2d_8hpp.html | 24 +- docs/doxygen/html/constant2d_8hpp_source.html | 73 +- docs/doxygen/html/contains_8hpp.html | 20 +- docs/doxygen/html/contains_8hpp_source.html | 29 +- docs/doxygen/html/convolve1d_8hpp.html | 22 +- docs/doxygen/html/convolve1d_8hpp_source.html | 67 +- docs/doxygen/html/convolve_8hpp.html | 22 +- docs/doxygen/html/convolve_8hpp_source.html | 89 +- docs/doxygen/html/copy_8hpp.html | 20 +- docs/doxygen/html/copy_8hpp_source.html | 25 +- docs/doxygen/html/copy_sign_8hpp.html | 20 +- docs/doxygen/html/copy_sign_8hpp_source.html | 63 +- docs/doxygen/html/copyto_8hpp.html | 20 +- docs/doxygen/html/copyto_8hpp_source.html | 27 +- docs/doxygen/html/corrcoef_8hpp.html | 131 + docs/doxygen/html/corrcoef_8hpp.js | 4 + docs/doxygen/html/corrcoef_8hpp_source.html | 145 + docs/doxygen/html/cos_8hpp.html | 20 +- docs/doxygen/html/cos_8hpp_source.html | 69 +- docs/doxygen/html/cosh_8hpp.html | 20 +- docs/doxygen/html/cosh_8hpp_source.html | 69 +- docs/doxygen/html/count__nonzero_8hpp.html | 20 +- .../html/count__nonzero_8hpp_source.html | 117 +- docs/doxygen/html/cov_8hpp.html | 130 + docs/doxygen/html/cov_8hpp.js | 4 + docs/doxygen/html/cov_8hpp_source.html | 170 + docs/doxygen/html/cov__inv_8hpp.html | 130 + docs/doxygen/html/cov__inv_8hpp.js | 4 + docs/doxygen/html/cov__inv_8hpp_source.html | 131 + docs/doxygen/html/cross_8hpp.html | 20 +- docs/doxygen/html/cross_8hpp_source.html | 261 +- docs/doxygen/html/cumprod_8hpp.html | 20 +- docs/doxygen/html/cumprod_8hpp_source.html | 27 +- docs/doxygen/html/cumsum_8hpp.html | 20 +- docs/doxygen/html/cumsum_8hpp_source.html | 27 +- docs/doxygen/html/cyclic__hankel__1_8hpp.html | 22 +- .../html/cyclic__hankel__1_8hpp_source.html | 77 +- docs/doxygen/html/cyclic__hankel__2_8hpp.html | 22 +- .../html/cyclic__hankel__2_8hpp_source.html | 77 +- docs/doxygen/html/deg2rad_8hpp.html | 20 +- docs/doxygen/html/deg2rad_8hpp_source.html | 67 +- docs/doxygen/html/degree_seperation_8hpp.html | 22 +- .../html/degree_seperation_8hpp_source.html | 13 +- docs/doxygen/html/degrees_8hpp.html | 20 +- docs/doxygen/html/degrees_8hpp_source.html | 43 +- docs/doxygen/html/delete_indices_8hpp.html | 20 +- .../html/delete_indices_8hpp_source.html | 286 +- docs/doxygen/html/det_8hpp.html | 22 +- docs/doxygen/html/det_8hpp_source.html | 137 +- docs/doxygen/html/diag_8hpp.html | 20 +- docs/doxygen/html/diag_8hpp_source.html | 15 +- docs/doxygen/html/diagflat_8hpp.html | 20 +- docs/doxygen/html/diagflat_8hpp_source.html | 17 +- docs/doxygen/html/diagonal_8hpp.html | 20 +- docs/doxygen/html/diagonal_8hpp_source.html | 27 +- docs/doxygen/html/diff_8hpp.html | 20 +- docs/doxygen/html/diff_8hpp_source.html | 171 +- docs/doxygen/html/digamma_8hpp.html | 22 +- docs/doxygen/html/digamma_8hpp_source.html | 77 +- .../dir_093b14450e434accd2cde91cedff0d18.html | 8 +- .../dir_10b69f38d52e59bd23d9fc1937bea22a.html | 8 +- .../dir_135bbb5e4eb4ddbda27ac0540001f7fd.html | 8 +- .../dir_22368e90b3593b912515c50bf54c969c.html | 8 +- .../dir_2e8552338a5fe196f81c9ab4a461b773.html | 8 +- .../dir_34171bd951b13a53aa9f237277a18e40.html | 8 +- .../dir_3762e5d1d8eae0347117ff18be7f517d.html | 8 +- .../dir_49e56c817e5e54854c35e136979f97ca.html | 8 +- .../dir_5de075070a423c280ad6ed943802bf75.html | 8 +- .../dir_821f0d92e31f34ac47de77ab611d6024.html | 8 +- .../dir_8e10c5302eb28a2724f15da9a6fa6b15.html | 8 +- .../dir_9051d82ec7b39b1c992f5bf2868571ca.html | 46 +- .../dir_953ac13dcbfb3e70ef6edb1a0956b929.html | 8 +- .../dir_a0b3eef1c4a290b815c33ad6e7027cf3.html | 8 +- .../dir_ad9a75b0e29f8223a99c87bd9504b7c3.html | 8 +- .../dir_b095eef7754acf39fdbf777c56c024ce.html | 8 +- .../dir_b6a8313716ea291fbd26120862b344bc.html | 8 +- .../dir_cac3062759fc9841f0966ab05282555a.html | 8 +- .../dir_ccac4f9986402d0375bdb0274c573e10.html | 8 +- .../dir_d4391026049f7aede16e9c18d53d30b9.html | 8 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 8 +- .../dir_d784f51d362276329e5940df711baf3d.html | 8 +- .../dir_e70e3c350b58629b2f80cdf8725e71de.html | 8 +- .../dir_f27b6096a19b08ebde950a57474879cd.html | 8 +- .../dir_f7abd548f101bada8968797392787ec9.html | 8 +- .../dir_f80dee9f889b1b78f4bee16631eb7d22.html | 8 +- .../dir_fd15cf3044ef18c575a802718b3c6ac6.html | 8 +- .../dir_fda794c261a16a342ab8761046b335b7.html | 8 +- docs/doxygen/html/discrete_8hpp.html | 22 +- docs/doxygen/html/discrete_8hpp_source.html | 79 +- docs/doxygen/html/divide_8hpp.html | 20 +- docs/doxygen/html/divide_8hpp_source.html | 153 +- docs/doxygen/html/dot_8hpp.html | 20 +- docs/doxygen/html/dot_8hpp_source.html | 21 +- docs/doxygen/html/doxygen.css | 8 +- docs/doxygen/html/dump_8hpp.html | 20 +- docs/doxygen/html/dump_8hpp_source.html | 27 +- docs/doxygen/html/ellint__1_8hpp.html | 22 +- docs/doxygen/html/ellint__1_8hpp_source.html | 97 +- docs/doxygen/html/ellint__2_8hpp.html | 22 +- docs/doxygen/html/ellint__2_8hpp_source.html | 97 +- docs/doxygen/html/ellint__3_8hpp.html | 22 +- docs/doxygen/html/ellint__3_8hpp_source.html | 93 +- docs/doxygen/html/empty_8hpp.html | 20 +- docs/doxygen/html/empty_8hpp_source.html | 41 +- docs/doxygen/html/empty__like_8hpp.html | 20 +- .../doxygen/html/empty__like_8hpp_source.html | 27 +- docs/doxygen/html/endianess_8hpp.html | 20 +- docs/doxygen/html/endianess_8hpp_source.html | 25 +- docs/doxygen/html/equal_8hpp.html | 20 +- docs/doxygen/html/equal_8hpp_source.html | 27 +- docs/doxygen/html/erf_8hpp.html | 22 +- docs/doxygen/html/erf_8hpp_source.html | 77 +- docs/doxygen/html/erf__inv_8hpp.html | 22 +- docs/doxygen/html/erf__inv_8hpp_source.html | 77 +- docs/doxygen/html/erfc_8hpp.html | 22 +- docs/doxygen/html/erfc_8hpp_source.html | 77 +- docs/doxygen/html/erfc__inv_8hpp.html | 22 +- docs/doxygen/html/erfc__inv_8hpp_source.html | 77 +- docs/doxygen/html/essentially_equal_8hpp.html | 22 +- .../html/essentially_equal_8hpp_source.html | 13 +- docs/doxygen/html/examples.html | 8 +- docs/doxygen/html/exp2_8hpp.html | 20 +- docs/doxygen/html/exp2_8hpp_source.html | 71 +- docs/doxygen/html/exp_8hpp.html | 20 +- docs/doxygen/html/exp_8hpp_source.html | 71 +- docs/doxygen/html/expint_8hpp.html | 22 +- docs/doxygen/html/expint_8hpp_source.html | 85 +- docs/doxygen/html/expm1_8hpp.html | 20 +- docs/doxygen/html/expm1_8hpp_source.html | 71 +- docs/doxygen/html/exponential_8hpp.html | 22 +- .../doxygen/html/exponential_8hpp_source.html | 73 +- docs/doxygen/html/extract_8hpp.html | 129 + docs/doxygen/html/extract_8hpp.js | 4 + docs/doxygen/html/extract_8hpp_source.html | 140 + docs/doxygen/html/extreme_value_8hpp.html | 22 +- .../html/extreme_value_8hpp_source.html | 113 +- docs/doxygen/html/eye_8hpp.html | 20 +- docs/doxygen/html/eye_8hpp_source.html | 123 +- docs/doxygen/html/f_8hpp.html | 22 +- docs/doxygen/html/f_8hpp_source.html | 113 +- docs/doxygen/html/factorial_8hpp.html | 22 +- docs/doxygen/html/factorial_8hpp_source.html | 95 +- docs/doxygen/html/files.html | 819 +- docs/doxygen/html/files_dup.js | 67 +- docs/doxygen/html/fill_corners_8hpp.html | 24 +- .../html/fill_corners_8hpp_source.html | 15 +- docs/doxygen/html/fill_diagnol_8hpp.html | 20 +- .../html/fill_diagnol_8hpp_source.html | 11 +- docs/doxygen/html/find_8hpp.html | 20 +- docs/doxygen/html/find_8hpp_source.html | 43 +- docs/doxygen/html/fix_8hpp.html | 20 +- docs/doxygen/html/fix_8hpp_source.html | 69 +- docs/doxygen/html/flatnonzero_8hpp.html | 20 +- .../doxygen/html/flatnonzero_8hpp_source.html | 27 +- docs/doxygen/html/flatten_8hpp.html | 20 +- docs/doxygen/html/flatten_8hpp_source.html | 27 +- docs/doxygen/html/flip_8hpp.html | 20 +- docs/doxygen/html/flip_8hpp_source.html | 95 +- docs/doxygen/html/fliplr_8hpp.html | 20 +- docs/doxygen/html/fliplr_8hpp_source.html | 27 +- docs/doxygen/html/flipud_8hpp.html | 20 +- docs/doxygen/html/flipud_8hpp_source.html | 27 +- docs/doxygen/html/floor_8hpp.html | 20 +- docs/doxygen/html/floor_8hpp_source.html | 19 +- docs/doxygen/html/floor__divide_8hpp.html | 20 +- .../html/floor__divide_8hpp_source.html | 45 +- docs/doxygen/html/fmax_8hpp.html | 20 +- docs/doxygen/html/fmax_8hpp_source.html | 87 +- docs/doxygen/html/fmin_8hpp.html | 20 +- docs/doxygen/html/fmin_8hpp_source.html | 87 +- docs/doxygen/html/fmod_8hpp.html | 29 +- docs/doxygen/html/fmod_8hpp.js | 2 +- docs/doxygen/html/fmod_8hpp_source.html | 108 +- docs/doxygen/html/frombuffer_8hpp.html | 20 +- docs/doxygen/html/frombuffer_8hpp_source.html | 37 +- docs/doxygen/html/fromfile_8hpp.html | 20 +- docs/doxygen/html/fromfile_8hpp_source.html | 173 +- docs/doxygen/html/fromiter_8hpp.html | 20 +- docs/doxygen/html/fromiter_8hpp_source.html | 25 +- docs/doxygen/html/full_8hpp.html | 20 +- docs/doxygen/html/full_8hpp_source.html | 67 +- docs/doxygen/html/full__like_8hpp.html | 20 +- docs/doxygen/html/full__like_8hpp_source.html | 29 +- docs/doxygen/html/functions.html | 8 +- docs/doxygen/html/functions_b.html | 10 +- docs/doxygen/html/functions_c.html | 12 +- docs/doxygen/html/functions_d.html | 10 +- docs/doxygen/html/functions_e.html | 8 +- docs/doxygen/html/functions_f.html | 8 +- docs/doxygen/html/functions_func.html | 8 +- docs/doxygen/html/functions_func_b.html | 10 +- docs/doxygen/html/functions_func_c.html | 10 +- docs/doxygen/html/functions_func_d.html | 10 +- docs/doxygen/html/functions_func_e.html | 8 +- docs/doxygen/html/functions_func_f.html | 8 +- docs/doxygen/html/functions_func_g.html | 8 +- docs/doxygen/html/functions_func_h.html | 8 +- docs/doxygen/html/functions_func_i.html | 8 +- docs/doxygen/html/functions_func_j.html | 8 +- docs/doxygen/html/functions_func_k.html | 8 +- docs/doxygen/html/functions_func_l.html | 8 +- docs/doxygen/html/functions_func_m.html | 8 +- docs/doxygen/html/functions_func_n.html | 10 +- docs/doxygen/html/functions_func_o.html | 20 +- docs/doxygen/html/functions_func_p.html | 10 +- docs/doxygen/html/functions_func_q.html | 8 +- docs/doxygen/html/functions_func_r.html | 16 +- docs/doxygen/html/functions_func_s.html | 12 +- docs/doxygen/html/functions_func_t.html | 8 +- docs/doxygen/html/functions_func_u.html | 8 +- docs/doxygen/html/functions_func_v.html | 8 +- docs/doxygen/html/functions_func_w.html | 8 +- docs/doxygen/html/functions_func_x.html | 8 +- docs/doxygen/html/functions_func_y.html | 8 +- docs/doxygen/html/functions_func_z.html | 8 +- docs/doxygen/html/functions_func_~.html | 8 +- docs/doxygen/html/functions_g.html | 8 +- docs/doxygen/html/functions_h.html | 8 +- docs/doxygen/html/functions_i.html | 8 +- docs/doxygen/html/functions_j.html | 8 +- docs/doxygen/html/functions_k.html | 8 +- docs/doxygen/html/functions_l.html | 8 +- docs/doxygen/html/functions_m.html | 8 +- docs/doxygen/html/functions_n.html | 10 +- docs/doxygen/html/functions_o.html | 26 +- docs/doxygen/html/functions_p.html | 10 +- docs/doxygen/html/functions_q.html | 8 +- docs/doxygen/html/functions_r.html | 14 +- docs/doxygen/html/functions_rela.html | 8 +- docs/doxygen/html/functions_s.html | 16 +- docs/doxygen/html/functions_t.html | 8 +- docs/doxygen/html/functions_type.html | 8 +- docs/doxygen/html/functions_u.html | 8 +- docs/doxygen/html/functions_v.html | 9 +- docs/doxygen/html/functions_vars.html | 9 +- docs/doxygen/html/functions_w.html | 8 +- docs/doxygen/html/functions_x.html | 8 +- docs/doxygen/html/functions_y.html | 8 +- docs/doxygen/html/functions_z.html | 8 +- docs/doxygen/html/functions_~.html | 8 +- docs/doxygen/html/gamma1pm1_8hpp.html | 22 +- docs/doxygen/html/gamma1pm1_8hpp_source.html | 75 +- docs/doxygen/html/gauss__legendre_8hpp.html | 24 +- docs/doxygen/html/gauss__legendre_8hpp.js | 2 +- .../html/gauss__legendre_8hpp_source.html | 17 +- docs/doxygen/html/gauss_newton_nlls_8hpp.html | 26 +- .../html/gauss_newton_nlls_8hpp_source.html | 25 +- docs/doxygen/html/gaussian1d_8hpp.html | 22 +- docs/doxygen/html/gaussian1d_8hpp_source.html | 13 +- docs/doxygen/html/gaussian_8hpp.html | 22 +- docs/doxygen/html/gaussian_8hpp_source.html | 13 +- docs/doxygen/html/gaussian_filter1d_8hpp.html | 22 +- .../html/gaussian_filter1d_8hpp_source.html | 98 +- docs/doxygen/html/gaussian_filter_8hpp.html | 22 +- .../html/gaussian_filter_8hpp_source.html | 108 +- docs/doxygen/html/gcd_8hpp.html | 20 +- docs/doxygen/html/gcd_8hpp_source.html | 69 +- .../doxygen/html/generate_centroids_8hpp.html | 22 +- .../html/generate_centroids_8hpp_source.html | 101 +- .../doxygen/html/generate_threshold_8hpp.html | 22 +- .../html/generate_threshold_8hpp_source.html | 201 +- docs/doxygen/html/generator_8hpp.html | 22 +- docs/doxygen/html/generator_8hpp_source.html | 25 +- docs/doxygen/html/geometric_8hpp.html | 22 +- docs/doxygen/html/geometric_8hpp_source.html | 93 +- docs/doxygen/html/geomspace_8hpp.html | 133 + docs/doxygen/html/geomspace_8hpp.js | 4 + docs/doxygen/html/geomspace_8hpp_source.html | 158 + docs/doxygen/html/globals.html | 8 +- docs/doxygen/html/globals_defs.html | 8 +- docs/doxygen/html/gradient_8hpp.html | 20 +- docs/doxygen/html/gradient_8hpp_source.html | 369 +- docs/doxygen/html/greater_8hpp.html | 20 +- docs/doxygen/html/greater_8hpp_source.html | 27 +- docs/doxygen/html/greater__equal_8hpp.html | 20 +- .../html/greater__equal_8hpp_source.html | 27 +- docs/doxygen/html/hamming_8hpp.html | 128 + docs/doxygen/html/hamming_8hpp.js | 4 + docs/doxygen/html/hamming_8hpp_source.html | 142 + docs/doxygen/html/hamming_encode_8hpp.html | 171 + docs/doxygen/html/hamming_encode_8hpp.js | 15 + .../html/hamming_encode_8hpp_source.html | 429 + docs/doxygen/html/hanning_8hpp.html | 128 + docs/doxygen/html/hanning_8hpp.js | 4 + docs/doxygen/html/hanning_8hpp_source.html | 142 + docs/doxygen/html/hat_8hpp.html | 22 +- docs/doxygen/html/hat_8hpp_source.html | 97 +- docs/doxygen/html/hermite_8hpp.html | 22 +- docs/doxygen/html/hermite_8hpp_source.html | 87 +- docs/doxygen/html/hierarchy.html | 67 +- docs/doxygen/html/hierarchy.js | 5 +- docs/doxygen/html/histogram_8hpp.html | 20 +- docs/doxygen/html/histogram_8hpp_source.html | 173 +- docs/doxygen/html/hstack_8hpp.html | 26 +- docs/doxygen/html/hstack_8hpp.js | 2 +- docs/doxygen/html/hstack_8hpp_source.html | 27 +- docs/doxygen/html/hypot_8hpp.html | 20 +- docs/doxygen/html/hypot_8hpp_source.html | 121 +- docs/doxygen/html/identity_8hpp.html | 20 +- docs/doxygen/html/identity_8hpp_source.html | 41 +- docs/doxygen/html/imag_8hpp.html | 20 +- docs/doxygen/html/imag_8hpp_source.html | 63 +- docs/doxygen/html/index.html | 56 +- docs/doxygen/html/inner_8hpp.html | 130 + docs/doxygen/html/inner_8hpp.js | 4 + docs/doxygen/html/inner_8hpp_source.html | 137 + docs/doxygen/html/intersect1d_8hpp.html | 20 +- .../doxygen/html/intersect1d_8hpp_source.html | 49 +- docs/doxygen/html/inv_8hpp.html | 22 +- docs/doxygen/html/inv_8hpp_source.html | 167 +- docs/doxygen/html/invert_8hpp.html | 20 +- docs/doxygen/html/invert_8hpp_source.html | 25 +- docs/doxygen/html/isclose_8hpp.html | 20 +- docs/doxygen/html/isclose_8hpp_source.html | 63 +- docs/doxygen/html/isinf_8hpp.html | 20 +- docs/doxygen/html/isinf_8hpp_source.html | 71 +- docs/doxygen/html/isnan_8hpp.html | 20 +- docs/doxygen/html/isnan_8hpp_source.html | 81 +- docs/doxygen/html/isneginf_8hpp.html | 132 + docs/doxygen/html/isneginf_8hpp.js | 5 + docs/doxygen/html/isneginf_8hpp_source.html | 148 + docs/doxygen/html/isposinf_8hpp.html | 132 + docs/doxygen/html/isposinf_8hpp.js | 5 + docs/doxygen/html/isposinf_8hpp_source.html | 148 + docs/doxygen/html/kaiser_8hpp.html | 129 + docs/doxygen/html/kaiser_8hpp.js | 4 + docs/doxygen/html/kaiser_8hpp_source.html | 150 + docs/doxygen/html/laguerre_8hpp.html | 22 +- docs/doxygen/html/laguerre_8hpp_source.html | 149 +- docs/doxygen/html/lcm_8hpp.html | 20 +- docs/doxygen/html/lcm_8hpp_source.html | 71 +- docs/doxygen/html/ldexp_8hpp.html | 20 +- docs/doxygen/html/ldexp_8hpp_source.html | 79 +- docs/doxygen/html/left__shift_8hpp.html | 20 +- .../doxygen/html/left__shift_8hpp_source.html | 25 +- docs/doxygen/html/legendre__p_8hpp.html | 22 +- .../doxygen/html/legendre__p_8hpp_source.html | 217 +- docs/doxygen/html/legendre__q_8hpp.html | 22 +- .../doxygen/html/legendre__q_8hpp_source.html | 89 +- docs/doxygen/html/less_8hpp.html | 20 +- docs/doxygen/html/less_8hpp_source.html | 27 +- docs/doxygen/html/less__equal_8hpp.html | 20 +- .../doxygen/html/less__equal_8hpp_source.html | 27 +- docs/doxygen/html/linspace_8hpp.html | 20 +- docs/doxygen/html/linspace_8hpp_source.html | 143 +- docs/doxygen/html/load_8hpp.html | 20 +- docs/doxygen/html/load_8hpp_source.html | 25 +- docs/doxygen/html/log10_8hpp.html | 20 +- docs/doxygen/html/log10_8hpp_source.html | 69 +- docs/doxygen/html/log1p_8hpp.html | 20 +- docs/doxygen/html/log1p_8hpp_source.html | 69 +- docs/doxygen/html/log2_8hpp.html | 20 +- docs/doxygen/html/log2_8hpp_source.html | 69 +- docs/doxygen/html/log_8hpp.html | 20 +- docs/doxygen/html/log_8hpp_source.html | 69 +- docs/doxygen/html/log__gamma_8hpp.html | 22 +- docs/doxygen/html/log__gamma_8hpp_source.html | 75 +- docs/doxygen/html/logb_8hpp.html | 134 + docs/doxygen/html/logb_8hpp.js | 5 + docs/doxygen/html/logb_8hpp_source.html | 151 + docs/doxygen/html/logical__and_8hpp.html | 20 +- .../html/logical__and_8hpp_source.html | 27 +- docs/doxygen/html/logical__not_8hpp.html | 20 +- .../html/logical__not_8hpp_source.html | 53 +- docs/doxygen/html/logical__or_8hpp.html | 20 +- .../doxygen/html/logical__or_8hpp_source.html | 27 +- docs/doxygen/html/logical__xor_8hpp.html | 20 +- .../html/logical__xor_8hpp_source.html | 63 +- docs/doxygen/html/lognormal_8hpp.html | 22 +- docs/doxygen/html/lognormal_8hpp_source.html | 93 +- docs/doxygen/html/logspace_8hpp.html | 131 + docs/doxygen/html/logspace_8hpp.js | 4 + docs/doxygen/html/logspace_8hpp_source.html | 141 + docs/doxygen/html/lstsq_8hpp.html | 22 +- docs/doxygen/html/lstsq_8hpp_source.html | 44 +- docs/doxygen/html/lu__decomposition_8hpp.html | 24 +- .../html/lu__decomposition_8hpp_source.html | 17 +- docs/doxygen/html/matmul_8hpp.html | 20 +- docs/doxygen/html/matmul_8hpp_source.html | 57 +- docs/doxygen/html/matrix__power_8hpp.html | 22 +- .../html/matrix__power_8hpp_source.html | 115 +- docs/doxygen/html/max_8hpp.html | 20 +- docs/doxygen/html/max_8hpp_source.html | 27 +- docs/doxygen/html/maximum_8hpp.html | 20 +- docs/doxygen/html/maximum_8hpp_source.html | 71 +- docs/doxygen/html/maximum_filter1d_8hpp.html | 22 +- .../html/maximum_filter1d_8hpp_source.html | 61 +- docs/doxygen/html/maximum_filter_8hpp.html | 22 +- .../html/maximum_filter_8hpp_source.html | 73 +- ...thub__num_cpp_docs_markdown__building.html | 144 + ...num_cpp_docs_markdown__compiler_flags.html | 108 + ...__num_cpp_docs_markdown__installation.html | 116 + ..._num_cpp_docs_markdown__release_notes.html | 262 + docs/doxygen/html/mean_8hpp.html | 20 +- docs/doxygen/html/mean_8hpp_source.html | 215 +- docs/doxygen/html/median_8hpp.html | 20 +- docs/doxygen/html/median_8hpp_source.html | 27 +- docs/doxygen/html/median_filter1d_8hpp.html | 22 +- .../html/median_filter1d_8hpp_source.html | 61 +- docs/doxygen/html/median_filter_8hpp.html | 22 +- .../html/median_filter_8hpp_source.html | 73 +- docs/doxygen/html/menudata.js | 2 + docs/doxygen/html/meshgrid_8hpp.html | 20 +- docs/doxygen/html/meshgrid_8hpp_source.html | 95 +- docs/doxygen/html/min_8hpp.html | 20 +- docs/doxygen/html/min_8hpp_source.html | 27 +- docs/doxygen/html/minimum_8hpp.html | 20 +- docs/doxygen/html/minimum_8hpp_source.html | 71 +- docs/doxygen/html/minimum_filter1d_8hpp.html | 22 +- .../html/minimum_filter1d_8hpp_source.html | 61 +- docs/doxygen/html/minimum_filter_8hpp.html | 22 +- .../html/minimum_filter_8hpp_source.html | 73 +- docs/doxygen/html/mirror1d_8hpp.html | 24 +- docs/doxygen/html/mirror1d_8hpp_source.html | 63 +- docs/doxygen/html/mirror2d_8hpp.html | 24 +- docs/doxygen/html/mirror2d_8hpp_source.html | 147 +- docs/doxygen/html/mod_8hpp.html | 20 +- docs/doxygen/html/mod_8hpp_source.html | 25 +- docs/doxygen/html/multi__dot_8hpp.html | 22 +- docs/doxygen/html/multi__dot_8hpp_source.html | 65 +- docs/doxygen/html/multiply_8hpp.html | 20 +- docs/doxygen/html/multiply_8hpp_source.html | 153 +- docs/doxygen/html/namespacemembers.html | 14 +- docs/doxygen/html/namespacemembers_b.html | 18 +- docs/doxygen/html/namespacemembers_c.html | 25 +- docs/doxygen/html/namespacemembers_d.html | 16 +- docs/doxygen/html/namespacemembers_dup.js | 1 + docs/doxygen/html/namespacemembers_e.html | 19 +- docs/doxygen/html/namespacemembers_enum.html | 8 +- docs/doxygen/html/namespacemembers_f.html | 14 +- docs/doxygen/html/namespacemembers_func.html | 14 +- docs/doxygen/html/namespacemembers_func.js | 1 + .../doxygen/html/namespacemembers_func_b.html | 20 +- .../doxygen/html/namespacemembers_func_c.html | 29 +- .../doxygen/html/namespacemembers_func_d.html | 18 +- .../doxygen/html/namespacemembers_func_e.html | 27 +- .../doxygen/html/namespacemembers_func_f.html | 14 +- .../doxygen/html/namespacemembers_func_g.html | 13 +- .../doxygen/html/namespacemembers_func_h.html | 16 +- .../doxygen/html/namespacemembers_func_i.html | 20 +- .../doxygen/html/namespacemembers_func_k.html | 104 + .../doxygen/html/namespacemembers_func_l.html | 16 +- .../doxygen/html/namespacemembers_func_m.html | 12 +- .../doxygen/html/namespacemembers_func_n.html | 17 +- .../doxygen/html/namespacemembers_func_o.html | 24 +- .../doxygen/html/namespacemembers_func_p.html | 16 +- .../doxygen/html/namespacemembers_func_r.html | 14 +- .../doxygen/html/namespacemembers_func_s.html | 15 +- .../doxygen/html/namespacemembers_func_t.html | 12 +- .../doxygen/html/namespacemembers_func_u.html | 8 +- .../doxygen/html/namespacemembers_func_v.html | 10 +- .../doxygen/html/namespacemembers_func_w.html | 8 +- .../doxygen/html/namespacemembers_func_z.html | 8 +- docs/doxygen/html/namespacemembers_g.html | 16 +- docs/doxygen/html/namespacemembers_h.html | 16 +- docs/doxygen/html/namespacemembers_i.html | 20 +- docs/doxygen/html/namespacemembers_j.html | 8 +- docs/doxygen/html/namespacemembers_k.html | 104 + docs/doxygen/html/namespacemembers_l.html | 16 +- docs/doxygen/html/namespacemembers_m.html | 14 +- docs/doxygen/html/namespacemembers_n.html | 17 +- docs/doxygen/html/namespacemembers_o.html | 24 +- docs/doxygen/html/namespacemembers_p.html | 16 +- docs/doxygen/html/namespacemembers_r.html | 14 +- docs/doxygen/html/namespacemembers_s.html | 21 +- docs/doxygen/html/namespacemembers_t.html | 12 +- docs/doxygen/html/namespacemembers_type.html | 8 +- docs/doxygen/html/namespacemembers_u.html | 8 +- docs/doxygen/html/namespacemembers_v.html | 10 +- docs/doxygen/html/namespacemembers_vars.html | 11 +- docs/doxygen/html/namespacemembers_w.html | 8 +- docs/doxygen/html/namespacemembers_z.html | 8 +- docs/doxygen/html/namespacenc.html | 3156 ++++--- docs/doxygen/html/namespacenc.js | 40 +- .../html/namespacenc_1_1constants.html | 16 +- .../html/namespacenc_1_1coordinates.html | 16 +- docs/doxygen/html/namespacenc_1_1edac.html | 201 + docs/doxygen/html/namespacenc_1_1edac.js | 17 + .../html/namespacenc_1_1edac_1_1detail.html | 519 ++ docs/doxygen/html/namespacenc_1_1endian.html | 12 +- docs/doxygen/html/namespacenc_1_1error.html | 10 +- .../html/namespacenc_1_1filesystem.html | 8 +- docs/doxygen/html/namespacenc_1_1filter.html | 82 +- .../namespacenc_1_1filter_1_1boundary.html | 40 +- .../html/namespacenc_1_1image_processing.html | 22 +- .../html/namespacenc_1_1integrate.html | 16 +- docs/doxygen/html/namespacenc_1_1linalg.html | 68 +- .../html/namespacenc_1_1polynomial.html | 62 +- docs/doxygen/html/namespacenc_1_1random.html | 226 +- docs/doxygen/html/namespacenc_1_1roots.html | 8 +- .../html/namespacenc_1_1rotations.html | 18 +- docs/doxygen/html/namespacenc_1_1special.html | 180 +- .../html/namespacenc_1_1stl__algorithms.html | 82 +- docs/doxygen/html/namespacenc_1_1utils.html | 50 +- docs/doxygen/html/namespaces.html | 117 +- docs/doxygen/html/nan__to__num_8hpp.html | 20 +- .../html/nan__to__num_8hpp_source.html | 83 +- docs/doxygen/html/nanargmax_8hpp.html | 20 +- docs/doxygen/html/nanargmax_8hpp_source.html | 49 +- docs/doxygen/html/nanargmin_8hpp.html | 20 +- docs/doxygen/html/nanargmin_8hpp_source.html | 49 +- docs/doxygen/html/nancumprod_8hpp.html | 20 +- docs/doxygen/html/nancumprod_8hpp_source.html | 49 +- docs/doxygen/html/nancumsum_8hpp.html | 20 +- docs/doxygen/html/nancumsum_8hpp_source.html | 49 +- docs/doxygen/html/nanmax_8hpp.html | 20 +- docs/doxygen/html/nanmax_8hpp_source.html | 49 +- docs/doxygen/html/nanmean_8hpp.html | 20 +- docs/doxygen/html/nanmean_8hpp_source.html | 185 +- docs/doxygen/html/nanmedian_8hpp.html | 20 +- docs/doxygen/html/nanmedian_8hpp_source.html | 173 +- docs/doxygen/html/nanmin_8hpp.html | 20 +- docs/doxygen/html/nanmin_8hpp_source.html | 49 +- docs/doxygen/html/nanpercentile_8hpp.html | 20 +- .../html/nanpercentile_8hpp_source.html | 85 +- docs/doxygen/html/nanprod_8hpp.html | 20 +- docs/doxygen/html/nanprod_8hpp_source.html | 49 +- docs/doxygen/html/nans_8hpp.html | 20 +- docs/doxygen/html/nans_8hpp_source.html | 55 +- docs/doxygen/html/nans__like_8hpp.html | 20 +- docs/doxygen/html/nans__like_8hpp_source.html | 35 +- docs/doxygen/html/nanstdev_8hpp.html | 20 +- docs/doxygen/html/nanstdev_8hpp_source.html | 194 +- docs/doxygen/html/nansum_8hpp.html | 20 +- docs/doxygen/html/nansum_8hpp_source.html | 49 +- docs/doxygen/html/nanvar_8hpp.html | 20 +- docs/doxygen/html/nanvar_8hpp_source.html | 35 +- docs/doxygen/html/navtreedata.js | 34 +- docs/doxygen/html/navtreeindex0.js | 494 +- docs/doxygen/html/navtreeindex1.js | 336 +- docs/doxygen/html/navtreeindex10.js | 494 +- docs/doxygen/html/navtreeindex11.js | 500 +- docs/doxygen/html/navtreeindex12.js | 498 +- docs/doxygen/html/navtreeindex13.js | 480 +- docs/doxygen/html/navtreeindex14.js | 140 +- docs/doxygen/html/navtreeindex2.js | 246 +- docs/doxygen/html/navtreeindex3.js | 500 +- docs/doxygen/html/navtreeindex4.js | 314 +- docs/doxygen/html/navtreeindex5.js | 150 +- docs/doxygen/html/navtreeindex6.js | 496 +- docs/doxygen/html/navtreeindex7.js | 408 +- docs/doxygen/html/navtreeindex8.js | 450 +- docs/doxygen/html/navtreeindex9.js | 500 +- docs/doxygen/html/nbytes_8hpp.html | 20 +- docs/doxygen/html/nbytes_8hpp_source.html | 25 +- docs/doxygen/html/nearest1d_8hpp.html | 24 +- docs/doxygen/html/nearest1d_8hpp_source.html | 63 +- docs/doxygen/html/nearest2d_8hpp.html | 24 +- docs/doxygen/html/nearest2d_8hpp_source.html | 109 +- docs/doxygen/html/negative_8hpp.html | 20 +- docs/doxygen/html/negative_8hpp_source.html | 25 +- docs/doxygen/html/negative_binomial_8hpp.html | 22 +- .../html/negative_binomial_8hpp_source.html | 113 +- docs/doxygen/html/newbyteorder_8hpp.html | 20 +- .../html/newbyteorder_8hpp_source.html | 45 +- .../html/non_central_chi_squared_8hpp.html | 22 +- .../non_central_chi_squared_8hpp_source.html | 117 +- docs/doxygen/html/none_8hpp.html | 20 +- docs/doxygen/html/none_8hpp_source.html | 29 +- docs/doxygen/html/nonzero_8hpp.html | 20 +- docs/doxygen/html/nonzero_8hpp_source.html | 27 +- docs/doxygen/html/norm_8hpp.html | 20 +- docs/doxygen/html/norm_8hpp_source.html | 241 +- docs/doxygen/html/normal_8hpp.html | 22 +- docs/doxygen/html/normal_8hpp_source.html | 93 +- docs/doxygen/html/not__equal_8hpp.html | 20 +- docs/doxygen/html/not__equal_8hpp_source.html | 27 +- docs/doxygen/html/nth__root_8hpp.html | 133 + docs/doxygen/html/nth__root_8hpp.js | 5 + docs/doxygen/html/nth__root_8hpp_source.html | 151 + docs/doxygen/html/num2str_8hpp.html | 22 +- docs/doxygen/html/num2str_8hpp_source.html | 11 +- docs/doxygen/html/ones_8hpp.html | 20 +- docs/doxygen/html/ones_8hpp_source.html | 71 +- docs/doxygen/html/ones__like_8hpp.html | 20 +- docs/doxygen/html/ones__like_8hpp_source.html | 37 +- docs/doxygen/html/outer_8hpp.html | 20 +- docs/doxygen/html/outer_8hpp_source.html | 19 +- docs/doxygen/html/pad_8hpp.html | 20 +- docs/doxygen/html/pad_8hpp_source.html | 53 +- docs/doxygen/html/pages.html | 16 +- docs/doxygen/html/partition_8hpp.html | 20 +- docs/doxygen/html/partition_8hpp_source.html | 31 +- docs/doxygen/html/percentile_8hpp.html | 20 +- docs/doxygen/html/percentile_8hpp_source.html | 320 +- .../html/percentile_filter1d_8hpp.html | 22 +- .../html/percentile_filter1d_8hpp_source.html | 62 +- docs/doxygen/html/percentile_filter_8hpp.html | 22 +- .../html/percentile_filter_8hpp_source.html | 76 +- docs/doxygen/html/permutation_8hpp.html | 22 +- .../doxygen/html/permutation_8hpp_source.html | 67 +- .../html/pivot_l_u__decomposition_8hpp.html | 24 +- .../pivot_l_u__decomposition_8hpp_source.html | 19 +- docs/doxygen/html/place_8hpp.html | 128 + docs/doxygen/html/place_8hpp.js | 4 + docs/doxygen/html/place_8hpp_source.html | 142 + docs/doxygen/html/pnr_8hpp.html | 22 +- docs/doxygen/html/pnr_8hpp_source.html | 91 +- docs/doxygen/html/poisson_8hpp.html | 22 +- docs/doxygen/html/poisson_8hpp_source.html | 93 +- docs/doxygen/html/polar_8hpp.html | 20 +- docs/doxygen/html/polar_8hpp_source.html | 81 +- docs/doxygen/html/polygamma_8hpp.html | 22 +- docs/doxygen/html/polygamma_8hpp_source.html | 77 +- docs/doxygen/html/prime_8hpp.html | 22 +- docs/doxygen/html/prime_8hpp_source.html | 79 +- docs/doxygen/html/print_8hpp.html | 20 +- docs/doxygen/html/print_8hpp_source.html | 29 +- docs/doxygen/html/prod_8hpp.html | 20 +- docs/doxygen/html/prod_8hpp_source.html | 27 +- docs/doxygen/html/proj_8hpp.html | 20 +- docs/doxygen/html/proj_8hpp_source.html | 63 +- docs/doxygen/html/ptp_8hpp.html | 20 +- docs/doxygen/html/ptp_8hpp_source.html | 27 +- docs/doxygen/html/put_8hpp.html | 20 +- docs/doxygen/html/put_8hpp_source.html | 47 +- docs/doxygen/html/putmask_8hpp.html | 20 +- docs/doxygen/html/putmask_8hpp_source.html | 47 +- docs/doxygen/html/rad2deg_8hpp.html | 20 +- docs/doxygen/html/rad2deg_8hpp_source.html | 67 +- docs/doxygen/html/radian_seperation_8hpp.html | 22 +- .../html/radian_seperation_8hpp_source.html | 13 +- docs/doxygen/html/radians_8hpp.html | 20 +- docs/doxygen/html/radians_8hpp_source.html | 43 +- docs/doxygen/html/rand_8hpp.html | 22 +- docs/doxygen/html/rand_8hpp_source.html | 79 +- docs/doxygen/html/rand_float_8hpp.html | 22 +- docs/doxygen/html/rand_float_8hpp_source.html | 109 +- docs/doxygen/html/rand_int_8hpp.html | 22 +- docs/doxygen/html/rand_int_8hpp_source.html | 109 +- docs/doxygen/html/rand_n_8hpp.html | 22 +- docs/doxygen/html/rand_n_8hpp_source.html | 49 +- docs/doxygen/html/rank_filter1d_8hpp.html | 22 +- .../html/rank_filter1d_8hpp_source.html | 61 +- docs/doxygen/html/rank_filter_8hpp.html | 22 +- .../doxygen/html/rank_filter_8hpp_source.html | 83 +- docs/doxygen/html/ravel_8hpp.html | 20 +- docs/doxygen/html/ravel_8hpp_source.html | 11 +- docs/doxygen/html/real_8hpp.html | 20 +- docs/doxygen/html/real_8hpp_source.html | 63 +- docs/doxygen/html/reciprocal_8hpp.html | 20 +- docs/doxygen/html/reciprocal_8hpp_source.html | 91 +- docs/doxygen/html/reflect1d_8hpp.html | 24 +- docs/doxygen/html/reflect1d_8hpp_source.html | 17 +- docs/doxygen/html/reflect2d_8hpp.html | 24 +- docs/doxygen/html/reflect2d_8hpp_source.html | 147 +- docs/doxygen/html/remainder_8hpp.html | 20 +- docs/doxygen/html/remainder_8hpp_source.html | 81 +- docs/doxygen/html/repeat_8hpp.html | 20 +- docs/doxygen/html/repeat_8hpp_source.html | 43 +- docs/doxygen/html/replace_8hpp.html | 20 +- docs/doxygen/html/replace_8hpp_source.html | 13 +- docs/doxygen/html/reshape_8hpp.html | 20 +- docs/doxygen/html/reshape_8hpp_source.html | 65 +- docs/doxygen/html/resize_fast_8hpp.html | 20 +- .../doxygen/html/resize_fast_8hpp_source.html | 47 +- docs/doxygen/html/resize_slow_8hpp.html | 20 +- .../doxygen/html/resize_slow_8hpp_source.html | 47 +- docs/doxygen/html/riemann__zeta_8hpp.html | 22 +- .../html/riemann__zeta_8hpp_source.html | 85 +- docs/doxygen/html/right__shift_8hpp.html | 20 +- .../html/right__shift_8hpp_source.html | 25 +- docs/doxygen/html/rint_8hpp.html | 20 +- docs/doxygen/html/rint_8hpp_source.html | 69 +- docs/doxygen/html/rms_8hpp.html | 20 +- docs/doxygen/html/rms_8hpp_source.html | 241 +- .../doxygen/html/rodrigues_rotation_8hpp.html | 22 +- .../html/rodrigues_rotation_8hpp_source.html | 17 +- docs/doxygen/html/roll_8hpp.html | 20 +- docs/doxygen/html/roll_8hpp_source.html | 149 +- docs/doxygen/html/romberg_8hpp.html | 24 +- docs/doxygen/html/romberg_8hpp_source.html | 17 +- docs/doxygen/html/rot90_8hpp.html | 20 +- docs/doxygen/html/rot90_8hpp_source.html | 83 +- docs/doxygen/html/round_8hpp.html | 20 +- docs/doxygen/html/round_8hpp_source.html | 45 +- docs/doxygen/html/row__stack_8hpp.html | 20 +- docs/doxygen/html/row__stack_8hpp_source.html | 93 +- docs/doxygen/html/search/all_0.html | 2 +- docs/doxygen/html/search/all_0.js | 32 +- docs/doxygen/html/search/all_1.html | 2 +- docs/doxygen/html/search/all_1.js | 110 +- docs/doxygen/html/search/all_10.html | 2 +- docs/doxygen/html/search/all_10.js | 4 +- docs/doxygen/html/search/all_11.html | 2 +- docs/doxygen/html/search/all_11.js | 181 +- docs/doxygen/html/search/all_12.html | 2 +- docs/doxygen/html/search/all_12.js | 216 +- docs/doxygen/html/search/all_13.html | 2 +- docs/doxygen/html/search/all_13.js | 96 +- docs/doxygen/html/search/all_14.html | 2 +- docs/doxygen/html/search/all_14.js | 52 +- docs/doxygen/html/search/all_15.html | 2 +- docs/doxygen/html/search/all_15.js | 32 +- docs/doxygen/html/search/all_16.html | 2 +- docs/doxygen/html/search/all_16.js | 30 +- docs/doxygen/html/search/all_17.html | 2 +- docs/doxygen/html/search/all_17.js | 6 +- docs/doxygen/html/search/all_18.html | 2 +- docs/doxygen/html/search/all_18.js | 6 +- docs/doxygen/html/search/all_19.html | 2 +- docs/doxygen/html/search/all_19.js | 12 +- docs/doxygen/html/search/all_1a.html | 2 +- docs/doxygen/html/search/all_1a.js | 14 +- docs/doxygen/html/search/all_2.html | 2 +- docs/doxygen/html/search/all_2.js | 258 +- docs/doxygen/html/search/all_3.html | 2 +- docs/doxygen/html/search/all_3.js | 100 +- docs/doxygen/html/search/all_4.html | 2 +- docs/doxygen/html/search/all_4.js | 106 +- docs/doxygen/html/search/all_5.html | 2 +- docs/doxygen/html/search/all_5.js | 116 +- docs/doxygen/html/search/all_6.html | 2 +- docs/doxygen/html/search/all_6.js | 74 +- docs/doxygen/html/search/all_7.html | 2 +- docs/doxygen/html/search/all_7.js | 33 +- docs/doxygen/html/search/all_8.html | 2 +- docs/doxygen/html/search/all_8.js | 117 +- docs/doxygen/html/search/all_9.html | 2 +- docs/doxygen/html/search/all_9.js | 2 +- docs/doxygen/html/search/all_a.html | 2 +- docs/doxygen/html/search/all_a.js | 4 +- docs/doxygen/html/search/all_b.html | 2 +- docs/doxygen/html/search/all_b.js | 104 +- docs/doxygen/html/search/all_c.html | 2 +- docs/doxygen/html/search/all_c.js | 102 +- docs/doxygen/html/search/all_d.html | 2 +- docs/doxygen/html/search/all_d.js | 215 +- docs/doxygen/html/search/all_e.html | 2 +- docs/doxygen/html/search/all_e.js | 88 +- docs/doxygen/html/search/all_f.html | 2 +- docs/doxygen/html/search/all_f.js | 111 +- docs/doxygen/html/search/classes_0.html | 2 +- docs/doxygen/html/search/classes_0.js | 12 +- docs/doxygen/html/search/classes_1.html | 2 +- docs/doxygen/html/search/classes_1.js | 4 +- docs/doxygen/html/search/classes_2.html | 2 +- docs/doxygen/html/search/classes_2.js | 8 +- docs/doxygen/html/search/classes_3.html | 2 +- docs/doxygen/html/search/classes_3.js | 12 +- docs/doxygen/html/search/classes_4.html | 2 +- docs/doxygen/html/search/classes_4.js | 2 +- docs/doxygen/html/search/classes_5.html | 2 +- docs/doxygen/html/search/classes_5.js | 5 +- docs/doxygen/html/search/classes_6.html | 2 +- docs/doxygen/html/search/classes_6.js | 5 +- docs/doxygen/html/search/classes_7.html | 2 +- docs/doxygen/html/search/classes_7.js | 7 +- docs/doxygen/html/search/classes_8.html | 2 +- docs/doxygen/html/search/classes_8.js | 10 +- docs/doxygen/html/search/classes_9.html | 2 +- docs/doxygen/html/search/classes_9.js | 3 +- docs/doxygen/html/search/classes_a.html | 2 +- docs/doxygen/html/search/classes_a.js | 2 +- docs/doxygen/html/search/classes_b.html | 2 +- docs/doxygen/html/search/classes_b.js | 5 +- docs/doxygen/html/search/classes_c.html | 2 +- docs/doxygen/html/search/classes_c.js | 5 +- docs/doxygen/html/search/classes_d.html | 2 +- docs/doxygen/html/search/classes_d.js | 3 +- docs/doxygen/html/search/classes_e.html | 37 + docs/doxygen/html/search/classes_e.js | 5 + docs/doxygen/html/search/defines_0.html | 2 +- docs/doxygen/html/search/defines_0.js | 2 +- docs/doxygen/html/search/defines_1.html | 2 +- docs/doxygen/html/search/defines_1.js | 12 +- docs/doxygen/html/search/defines_2.html | 2 +- docs/doxygen/html/search/defines_2.js | 4 +- docs/doxygen/html/search/enums_0.html | 2 +- docs/doxygen/html/search/enums_0.js | 2 +- docs/doxygen/html/search/enums_1.html | 2 +- docs/doxygen/html/search/enums_1.js | 2 +- docs/doxygen/html/search/enums_2.html | 2 +- docs/doxygen/html/search/enums_2.js | 2 +- docs/doxygen/html/search/enums_3.html | 2 +- docs/doxygen/html/search/enums_3.js | 2 +- docs/doxygen/html/search/enumvalues_0.html | 2 +- docs/doxygen/html/search/enumvalues_0.js | 2 +- docs/doxygen/html/search/enumvalues_1.html | 2 +- docs/doxygen/html/search/enumvalues_1.js | 4 +- docs/doxygen/html/search/enumvalues_2.html | 2 +- docs/doxygen/html/search/enumvalues_2.js | 2 +- docs/doxygen/html/search/enumvalues_3.html | 2 +- docs/doxygen/html/search/enumvalues_3.js | 2 +- docs/doxygen/html/search/enumvalues_4.html | 2 +- docs/doxygen/html/search/enumvalues_4.js | 8 +- docs/doxygen/html/search/enumvalues_5.html | 2 +- docs/doxygen/html/search/enumvalues_5.js | 2 +- docs/doxygen/html/search/enumvalues_6.html | 2 +- docs/doxygen/html/search/enumvalues_6.js | 4 +- docs/doxygen/html/search/enumvalues_7.html | 2 +- docs/doxygen/html/search/enumvalues_7.js | 2 +- docs/doxygen/html/search/files_0.html | 2 +- docs/doxygen/html/search/files_0.js | 74 +- docs/doxygen/html/search/files_1.html | 2 +- docs/doxygen/html/search/files_1.js | 50 +- docs/doxygen/html/search/files_10.html | 2 +- docs/doxygen/html/search/files_10.js | 77 +- docs/doxygen/html/search/files_11.html | 2 +- docs/doxygen/html/search/files_11.js | 58 +- docs/doxygen/html/search/files_12.html | 2 +- docs/doxygen/html/search/files_12.js | 31 +- docs/doxygen/html/search/files_13.html | 2 +- docs/doxygen/html/search/files_13.js | 19 +- docs/doxygen/html/search/files_14.html | 2 +- docs/doxygen/html/search/files_14.js | 13 +- docs/doxygen/html/search/files_15.html | 2 +- docs/doxygen/html/search/files_15.js | 8 +- docs/doxygen/html/search/files_16.html | 37 + docs/doxygen/html/search/files_16.js | 5 + docs/doxygen/html/search/files_2.html | 2 +- docs/doxygen/html/search/files_2.js | 97 +- docs/doxygen/html/search/files_3.html | 2 +- docs/doxygen/html/search/files_3.js | 38 +- docs/doxygen/html/search/files_4.html | 2 +- docs/doxygen/html/search/files_4.js | 43 +- docs/doxygen/html/search/files_5.html | 2 +- docs/doxygen/html/search/files_5.js | 60 +- docs/doxygen/html/search/files_6.html | 2 +- docs/doxygen/html/search/files_6.js | 31 +- docs/doxygen/html/search/files_7.html | 2 +- docs/doxygen/html/search/files_7.js | 13 +- docs/doxygen/html/search/files_8.html | 2 +- docs/doxygen/html/search/files_8.js | 27 +- docs/doxygen/html/search/files_9.html | 2 +- docs/doxygen/html/search/files_9.js | 24 +- docs/doxygen/html/search/files_a.html | 2 +- docs/doxygen/html/search/files_a.js | 45 +- docs/doxygen/html/search/files_b.html | 2 +- docs/doxygen/html/search/files_b.js | 55 +- docs/doxygen/html/search/files_c.html | 2 +- docs/doxygen/html/search/files_c.js | 39 +- docs/doxygen/html/search/files_d.html | 2 +- docs/doxygen/html/search/files_d.js | 26 +- docs/doxygen/html/search/files_e.html | 2 +- docs/doxygen/html/search/files_e.js | 25 +- docs/doxygen/html/search/files_f.html | 2 +- docs/doxygen/html/search/files_f.js | 40 +- docs/doxygen/html/search/functions_0.html | 2 +- docs/doxygen/html/search/functions_0.js | 86 +- docs/doxygen/html/search/functions_1.html | 2 +- docs/doxygen/html/search/functions_1.js | 54 +- docs/doxygen/html/search/functions_10.html | 2 +- docs/doxygen/html/search/functions_10.js | 2 +- docs/doxygen/html/search/functions_11.html | 2 +- docs/doxygen/html/search/functions_11.js | 89 +- docs/doxygen/html/search/functions_12.html | 2 +- docs/doxygen/html/search/functions_12.js | 106 +- docs/doxygen/html/search/functions_13.html | 2 +- docs/doxygen/html/search/functions_13.js | 52 +- docs/doxygen/html/search/functions_14.html | 2 +- docs/doxygen/html/search/functions_14.js | 20 +- docs/doxygen/html/search/functions_15.html | 2 +- docs/doxygen/html/search/functions_15.js | 12 +- docs/doxygen/html/search/functions_16.html | 2 +- docs/doxygen/html/search/functions_16.js | 16 +- docs/doxygen/html/search/functions_17.html | 2 +- docs/doxygen/html/search/functions_17.js | 6 +- docs/doxygen/html/search/functions_18.html | 2 +- docs/doxygen/html/search/functions_18.js | 6 +- docs/doxygen/html/search/functions_19.html | 2 +- docs/doxygen/html/search/functions_19.js | 8 +- docs/doxygen/html/search/functions_1a.html | 2 +- docs/doxygen/html/search/functions_1a.js | 14 +- docs/doxygen/html/search/functions_2.html | 2 +- docs/doxygen/html/search/functions_2.js | 133 +- docs/doxygen/html/search/functions_3.html | 2 +- docs/doxygen/html/search/functions_3.js | 50 +- docs/doxygen/html/search/functions_4.html | 2 +- docs/doxygen/html/search/functions_4.js | 55 +- docs/doxygen/html/search/functions_5.html | 2 +- docs/doxygen/html/search/functions_5.js | 56 +- docs/doxygen/html/search/functions_6.html | 2 +- docs/doxygen/html/search/functions_6.js | 39 +- docs/doxygen/html/search/functions_7.html | 2 +- docs/doxygen/html/search/functions_7.js | 18 +- docs/doxygen/html/search/functions_8.html | 2 +- docs/doxygen/html/search/functions_8.js | 56 +- docs/doxygen/html/search/functions_9.html | 2 +- docs/doxygen/html/search/functions_9.js | 2 +- docs/doxygen/html/search/functions_a.html | 2 +- docs/doxygen/html/search/functions_a.js | 3 +- docs/doxygen/html/search/functions_b.html | 2 +- docs/doxygen/html/search/functions_b.js | 54 +- docs/doxygen/html/search/functions_c.html | 2 +- docs/doxygen/html/search/functions_c.js | 50 +- docs/doxygen/html/search/functions_d.html | 2 +- docs/doxygen/html/search/functions_d.js | 87 +- docs/doxygen/html/search/functions_e.html | 2 +- docs/doxygen/html/search/functions_e.js | 82 +- docs/doxygen/html/search/functions_f.html | 2 +- docs/doxygen/html/search/functions_f.js | 58 +- docs/doxygen/html/search/namespaces_0.html | 2 +- docs/doxygen/html/search/namespaces_0.js | 38 +- docs/doxygen/html/search/pages_0.html | 2 +- docs/doxygen/html/search/pages_0.js | 2 +- docs/doxygen/html/search/pages_1.html | 2 +- docs/doxygen/html/search/pages_1.js | 2 +- docs/doxygen/html/search/pages_2.html | 2 +- docs/doxygen/html/search/pages_2.js | 2 +- docs/doxygen/html/search/pages_3.html | 2 +- docs/doxygen/html/search/pages_3.js | 2 +- docs/doxygen/html/search/related_0.html | 2 +- docs/doxygen/html/search/related_0.js | 2 +- docs/doxygen/html/search/searchdata.js | 6 +- docs/doxygen/html/search/typedefs_0.html | 2 +- docs/doxygen/html/search/typedefs_0.js | 2 +- docs/doxygen/html/search/typedefs_1.html | 2 +- docs/doxygen/html/search/typedefs_1.js | 16 +- docs/doxygen/html/search/typedefs_2.html | 2 +- docs/doxygen/html/search/typedefs_2.js | 2 +- docs/doxygen/html/search/typedefs_3.html | 2 +- docs/doxygen/html/search/typedefs_3.js | 2 +- docs/doxygen/html/search/typedefs_4.html | 2 +- docs/doxygen/html/search/typedefs_4.js | 12 +- docs/doxygen/html/search/typedefs_5.html | 2 +- docs/doxygen/html/search/typedefs_5.js | 2 +- docs/doxygen/html/search/typedefs_6.html | 2 +- docs/doxygen/html/search/typedefs_6.js | 6 +- docs/doxygen/html/search/typedefs_7.html | 2 +- docs/doxygen/html/search/typedefs_7.js | 2 +- docs/doxygen/html/search/typedefs_8.html | 2 +- docs/doxygen/html/search/typedefs_8.js | 2 +- docs/doxygen/html/search/typedefs_9.html | 2 +- docs/doxygen/html/search/typedefs_9.js | 8 +- docs/doxygen/html/search/typedefs_a.html | 2 +- docs/doxygen/html/search/typedefs_a.js | 2 +- docs/doxygen/html/search/variables_0.html | 2 +- docs/doxygen/html/search/variables_0.js | 4 +- docs/doxygen/html/search/variables_1.html | 2 +- docs/doxygen/html/search/variables_1.js | 8 +- docs/doxygen/html/search/variables_10.html | 2 +- docs/doxygen/html/search/variables_10.js | 2 +- docs/doxygen/html/search/variables_2.html | 2 +- docs/doxygen/html/search/variables_2.js | 2 +- docs/doxygen/html/search/variables_3.html | 2 +- docs/doxygen/html/search/variables_3.js | 4 +- docs/doxygen/html/search/variables_4.html | 2 +- docs/doxygen/html/search/variables_4.js | 3 +- docs/doxygen/html/search/variables_5.html | 2 +- docs/doxygen/html/search/variables_5.js | 2 +- docs/doxygen/html/search/variables_6.html | 2 +- docs/doxygen/html/search/variables_6.js | 16 +- docs/doxygen/html/search/variables_7.html | 2 +- docs/doxygen/html/search/variables_7.js | 2 +- docs/doxygen/html/search/variables_8.html | 2 +- docs/doxygen/html/search/variables_8.js | 10 +- docs/doxygen/html/search/variables_9.html | 2 +- docs/doxygen/html/search/variables_9.js | 4 +- docs/doxygen/html/search/variables_a.html | 2 +- docs/doxygen/html/search/variables_a.js | 2 +- docs/doxygen/html/search/variables_b.html | 2 +- docs/doxygen/html/search/variables_b.js | 4 +- docs/doxygen/html/search/variables_c.html | 2 +- docs/doxygen/html/search/variables_c.js | 14 +- docs/doxygen/html/search/variables_d.html | 2 +- docs/doxygen/html/search/variables_d.js | 4 +- docs/doxygen/html/search/variables_e.html | 2 +- docs/doxygen/html/search/variables_e.js | 2 +- docs/doxygen/html/search/variables_f.html | 2 +- docs/doxygen/html/search/variables_f.js | 2 +- docs/doxygen/html/select_8hpp.html | 136 + docs/doxygen/html/select_8hpp.js | 5 + docs/doxygen/html/select_8hpp_source.html | 216 + docs/doxygen/html/setdiff1d_8hpp.html | 20 +- docs/doxygen/html/setdiff1d_8hpp_source.html | 55 +- docs/doxygen/html/shuffle_8hpp.html | 22 +- docs/doxygen/html/shuffle_8hpp_source.html | 31 +- docs/doxygen/html/sign_8hpp.html | 20 +- docs/doxygen/html/sign_8hpp_source.html | 87 +- docs/doxygen/html/signbit_8hpp.html | 20 +- docs/doxygen/html/signbit_8hpp_source.html | 69 +- docs/doxygen/html/simpson_8hpp.html | 24 +- docs/doxygen/html/simpson_8hpp_source.html | 13 +- docs/doxygen/html/sin_8hpp.html | 20 +- docs/doxygen/html/sin_8hpp_source.html | 69 +- docs/doxygen/html/sinc_8hpp.html | 20 +- docs/doxygen/html/sinc_8hpp_source.html | 69 +- docs/doxygen/html/sinh_8hpp.html | 20 +- docs/doxygen/html/sinh_8hpp_source.html | 69 +- docs/doxygen/html/size_8hpp.html | 20 +- docs/doxygen/html/size_8hpp_source.html | 25 +- docs/doxygen/html/softmax_8hpp.html | 22 +- docs/doxygen/html/softmax_8hpp_source.html | 17 +- docs/doxygen/html/solve_8hpp.html | 22 +- docs/doxygen/html/solve_8hpp_source.html | 27 +- docs/doxygen/html/sort_8hpp.html | 20 +- docs/doxygen/html/sort_8hpp_source.html | 31 +- .../html/spherical__bessel__jn_8hpp.html | 22 +- .../spherical__bessel__jn_8hpp_source.html | 83 +- .../html/spherical__bessel__yn_8hpp.html | 22 +- .../spherical__bessel__yn_8hpp_source.html | 85 +- .../html/spherical__hankel__1_8hpp.html | 22 +- .../spherical__hankel__1_8hpp_source.html | 77 +- .../html/spherical__hankel__2_8hpp.html | 22 +- .../spherical__hankel__2_8hpp_source.html | 77 +- .../html/spherical__harmonic_8hpp.html | 22 +- .../html/spherical__harmonic_8hpp_source.html | 85 +- docs/doxygen/html/sqr_8hpp.html | 22 +- docs/doxygen/html/sqr_8hpp_source.html | 11 +- docs/doxygen/html/sqrt_8hpp.html | 20 +- docs/doxygen/html/sqrt_8hpp_source.html | 69 +- docs/doxygen/html/square_8hpp.html | 20 +- docs/doxygen/html/square_8hpp_source.html | 67 +- docs/doxygen/html/stack_8hpp.html | 26 +- docs/doxygen/html/stack_8hpp.js | 2 +- docs/doxygen/html/stack_8hpp_source.html | 59 +- docs/doxygen/html/standard_normal_8hpp.html | 22 +- .../html/standard_normal_8hpp_source.html | 51 +- docs/doxygen/html/stdev_8hpp.html | 20 +- docs/doxygen/html/stdev_8hpp_source.html | 286 +- .../html/structnc_1_1all__arithmetic.html | 14 +- ...metic_3_01_head_00_01_tail_8_8_8_01_4.html | 14 +- ...ructnc_1_1all__arithmetic_3_01_t_01_4.html | 14 +- docs/doxygen/html/structnc_1_1all__same.html | 14 +- ...1_t1_00_01_head_00_01_tail_8_8_8_01_4.html | 14 +- ...nc_1_1all__same_3_01_t1_00_01_t2_01_4.html | 14 +- .../html/structnc_1_1greater_than.html | 145 + docs/doxygen/html/structnc_1_1greater_than.js | 4 + .../doxygen/html/structnc_1_1is__complex.html | 14 +- ...x_3_01std_1_1complex_3_01_t_01_4_01_4.html | 14 +- .../html/structnc_1_1is__valid__dtype.html | 14 +- docs/doxygen/html/student_t_8hpp.html | 22 +- docs/doxygen/html/student_t_8hpp_source.html | 93 +- docs/doxygen/html/subtract_8hpp.html | 20 +- docs/doxygen/html/subtract_8hpp_source.html | 153 +- docs/doxygen/html/sum_8hpp.html | 20 +- docs/doxygen/html/sum_8hpp_source.html | 27 +- docs/doxygen/html/svd_8hpp.html | 22 +- docs/doxygen/html/svd_8hpp_source.html | 20 +- docs/doxygen/html/swap_8hpp.html | 20 +- docs/doxygen/html/swap_8hpp_source.html | 11 +- docs/doxygen/html/swapaxes_8hpp.html | 20 +- docs/doxygen/html/swapaxes_8hpp_source.html | 27 +- docs/doxygen/html/tan_8hpp.html | 20 +- docs/doxygen/html/tan_8hpp_source.html | 69 +- docs/doxygen/html/tanh_8hpp.html | 20 +- docs/doxygen/html/tanh_8hpp_source.html | 69 +- docs/doxygen/html/tile_8hpp.html | 20 +- docs/doxygen/html/tile_8hpp_source.html | 43 +- docs/doxygen/html/to_stl_vector_8hpp.html | 20 +- .../html/to_stl_vector_8hpp_source.html | 27 +- docs/doxygen/html/tofile_8hpp.html | 20 +- docs/doxygen/html/tofile_8hpp_source.html | 43 +- docs/doxygen/html/trace_8hpp.html | 20 +- docs/doxygen/html/trace_8hpp_source.html | 25 +- docs/doxygen/html/transpose_8hpp.html | 20 +- docs/doxygen/html/transpose_8hpp_source.html | 27 +- docs/doxygen/html/trapazoidal_8hpp.html | 24 +- .../doxygen/html/trapazoidal_8hpp_source.html | 13 +- docs/doxygen/html/trapz_8hpp.html | 20 +- docs/doxygen/html/trapz_8hpp_source.html | 297 +- docs/doxygen/html/tri_8hpp.html | 20 +- docs/doxygen/html/tri_8hpp_source.html | 315 +- docs/doxygen/html/triangle_8hpp.html | 22 +- docs/doxygen/html/triangle_8hpp_source.html | 165 +- docs/doxygen/html/trigamma_8hpp.html | 22 +- docs/doxygen/html/trigamma_8hpp_source.html | 77 +- docs/doxygen/html/trim__zeros_8hpp.html | 20 +- .../doxygen/html/trim__zeros_8hpp_source.html | 214 +- docs/doxygen/html/trim_boundary1d_8hpp.html | 24 +- .../html/trim_boundary1d_8hpp_source.html | 41 +- docs/doxygen/html/trim_boundary2d_8hpp.html | 24 +- .../html/trim_boundary2d_8hpp_source.html | 47 +- docs/doxygen/html/trunc_8hpp.html | 20 +- docs/doxygen/html/trunc_8hpp_source.html | 69 +- docs/doxygen/html/uniform_8hpp.html | 22 +- docs/doxygen/html/uniform_8hpp_source.html | 53 +- docs/doxygen/html/uniform_filter1d_8hpp.html | 22 +- .../html/uniform_filter1d_8hpp_source.html | 62 +- docs/doxygen/html/uniform_filter_8hpp.html | 22 +- .../html/uniform_filter_8hpp_source.html | 74 +- docs/doxygen/html/uniform_on_sphere_8hpp.html | 22 +- .../html/uniform_on_sphere_8hpp_source.html | 61 +- docs/doxygen/html/union1d_8hpp.html | 20 +- docs/doxygen/html/union1d_8hpp_source.html | 55 +- docs/doxygen/html/unique_8hpp.html | 20 +- docs/doxygen/html/unique_8hpp_source.html | 49 +- docs/doxygen/html/unwrap_8hpp.html | 20 +- docs/doxygen/html/unwrap_8hpp_source.html | 71 +- docs/doxygen/html/value2str_8hpp.html | 22 +- docs/doxygen/html/value2str_8hpp_source.html | 11 +- docs/doxygen/html/var_8hpp.html | 20 +- docs/doxygen/html/var_8hpp_source.html | 85 +- docs/doxygen/html/vstack_8hpp.html | 26 +- docs/doxygen/html/vstack_8hpp.js | 2 +- docs/doxygen/html/vstack_8hpp_source.html | 27 +- docs/doxygen/html/wahbas_problem_8hpp.html | 22 +- .../html/wahbas_problem_8hpp_source.html | 23 +- docs/doxygen/html/weibull_8hpp.html | 22 +- docs/doxygen/html/weibull_8hpp_source.html | 113 +- docs/doxygen/html/where_8hpp.html | 20 +- docs/doxygen/html/where_8hpp_source.html | 13 +- .../doxygen/html/window_exceedances_8hpp.html | 22 +- .../html/window_exceedances_8hpp_source.html | 81 +- docs/doxygen/html/wrap1d_8hpp.html | 24 +- docs/doxygen/html/wrap1d_8hpp_source.html | 59 +- docs/doxygen/html/wrap2d_8hpp.html | 24 +- docs/doxygen/html/wrap2d_8hpp_source.html | 133 +- docs/doxygen/html/zeros_8hpp.html | 20 +- docs/doxygen/html/zeros_8hpp_source.html | 69 +- docs/doxygen/html/zeros__like_8hpp.html | 20 +- .../doxygen/html/zeros__like_8hpp_source.html | 37 +- include/NumCpp/Functions/geomspace.hpp | 2 +- include/NumCpp/Functions/logb.hpp | 2 +- include/NumCpp/Functions/logspace.hpp | 3 +- 1465 files changed, 44427 insertions(+), 35572 deletions(-) create mode 100644 docs/doxygen/html/bartlett_8hpp.html create mode 100644 docs/doxygen/html/bartlett_8hpp.js create mode 100644 docs/doxygen/html/bartlett_8hpp_source.html create mode 100644 docs/doxygen/html/blackman_8hpp.html create mode 100644 docs/doxygen/html/blackman_8hpp.js create mode 100644 docs/doxygen/html/blackman_8hpp_source.html create mode 100644 docs/doxygen/html/corrcoef_8hpp.html create mode 100644 docs/doxygen/html/corrcoef_8hpp.js create mode 100644 docs/doxygen/html/corrcoef_8hpp_source.html create mode 100644 docs/doxygen/html/cov_8hpp.html create mode 100644 docs/doxygen/html/cov_8hpp.js create mode 100644 docs/doxygen/html/cov_8hpp_source.html create mode 100644 docs/doxygen/html/cov__inv_8hpp.html create mode 100644 docs/doxygen/html/cov__inv_8hpp.js create mode 100644 docs/doxygen/html/cov__inv_8hpp_source.html create mode 100644 docs/doxygen/html/extract_8hpp.html create mode 100644 docs/doxygen/html/extract_8hpp.js create mode 100644 docs/doxygen/html/extract_8hpp_source.html create mode 100644 docs/doxygen/html/geomspace_8hpp.html create mode 100644 docs/doxygen/html/geomspace_8hpp.js create mode 100644 docs/doxygen/html/geomspace_8hpp_source.html create mode 100644 docs/doxygen/html/hamming_8hpp.html create mode 100644 docs/doxygen/html/hamming_8hpp.js create mode 100644 docs/doxygen/html/hamming_8hpp_source.html create mode 100644 docs/doxygen/html/hamming_encode_8hpp.html create mode 100644 docs/doxygen/html/hamming_encode_8hpp.js create mode 100644 docs/doxygen/html/hamming_encode_8hpp_source.html create mode 100644 docs/doxygen/html/hanning_8hpp.html create mode 100644 docs/doxygen/html/hanning_8hpp.js create mode 100644 docs/doxygen/html/hanning_8hpp_source.html create mode 100644 docs/doxygen/html/inner_8hpp.html create mode 100644 docs/doxygen/html/inner_8hpp.js create mode 100644 docs/doxygen/html/inner_8hpp_source.html create mode 100644 docs/doxygen/html/isneginf_8hpp.html create mode 100644 docs/doxygen/html/isneginf_8hpp.js create mode 100644 docs/doxygen/html/isneginf_8hpp_source.html create mode 100644 docs/doxygen/html/isposinf_8hpp.html create mode 100644 docs/doxygen/html/isposinf_8hpp.js create mode 100644 docs/doxygen/html/isposinf_8hpp_source.html create mode 100644 docs/doxygen/html/kaiser_8hpp.html create mode 100644 docs/doxygen/html/kaiser_8hpp.js create mode 100644 docs/doxygen/html/kaiser_8hpp_source.html create mode 100644 docs/doxygen/html/logb_8hpp.html create mode 100644 docs/doxygen/html/logb_8hpp.js create mode 100644 docs/doxygen/html/logb_8hpp_source.html create mode 100644 docs/doxygen/html/logspace_8hpp.html create mode 100644 docs/doxygen/html/logspace_8hpp.js create mode 100644 docs/doxygen/html/logspace_8hpp_source.html create mode 100644 docs/doxygen/html/md__c___github__num_cpp_docs_markdown__building.html create mode 100644 docs/doxygen/html/md__c___github__num_cpp_docs_markdown__compiler_flags.html create mode 100644 docs/doxygen/html/md__c___github__num_cpp_docs_markdown__installation.html create mode 100644 docs/doxygen/html/md__c___github__num_cpp_docs_markdown__release_notes.html create mode 100644 docs/doxygen/html/namespacemembers_func_k.html create mode 100644 docs/doxygen/html/namespacemembers_k.html create mode 100644 docs/doxygen/html/namespacenc_1_1edac.html create mode 100644 docs/doxygen/html/namespacenc_1_1edac.js create mode 100644 docs/doxygen/html/namespacenc_1_1edac_1_1detail.html create mode 100644 docs/doxygen/html/nth__root_8hpp.html create mode 100644 docs/doxygen/html/nth__root_8hpp.js create mode 100644 docs/doxygen/html/nth__root_8hpp_source.html create mode 100644 docs/doxygen/html/place_8hpp.html create mode 100644 docs/doxygen/html/place_8hpp.js create mode 100644 docs/doxygen/html/place_8hpp_source.html create mode 100644 docs/doxygen/html/search/classes_e.html create mode 100644 docs/doxygen/html/search/classes_e.js create mode 100644 docs/doxygen/html/search/files_16.html create mode 100644 docs/doxygen/html/search/files_16.js create mode 100644 docs/doxygen/html/select_8hpp.html create mode 100644 docs/doxygen/html/select_8hpp.js create mode 100644 docs/doxygen/html/select_8hpp_source.html create mode 100644 docs/doxygen/html/structnc_1_1greater_than.html create mode 100644 docs/doxygen/html/structnc_1_1greater_than.js diff --git a/docs/doxygen/html/_bisection_8hpp.html b/docs/doxygen/html/_bisection_8hpp.html index b562273fa..520e94fa3 100644 --- a/docs/doxygen/html/_bisection_8hpp.html +++ b/docs/doxygen/html/_bisection_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: Bisection.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
bartlett.hpp File Reference
+
+
+
#include <cmath>
+#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Functions/linspace.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + +

+Functions

NdArray< double > nc::bartlett (int32 m)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/bartlett_8hpp.js b/docs/doxygen/html/bartlett_8hpp.js new file mode 100644 index 000000000..d47f99054 --- /dev/null +++ b/docs/doxygen/html/bartlett_8hpp.js @@ -0,0 +1,4 @@ +var bartlett_8hpp = +[ + [ "bartlett", "bartlett_8hpp.html#a594225660881a1cd0caabba4946c07d4", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/bartlett_8hpp_source.html b/docs/doxygen/html/bartlett_8hpp_source.html new file mode 100644 index 000000000..0c5687f36 --- /dev/null +++ b/docs/doxygen/html/bartlett_8hpp_source.html @@ -0,0 +1,142 @@ + + + + + + + +NumCpp: bartlett.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
bartlett.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include <cmath>
+
31 
+
32 #include "NumCpp/NdArray.hpp"
+
33 #include "NumCpp/Functions/linspace.hpp"
+
34 
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
48  inline NdArray<double> bartlett(int32 m)
+
49  {
+
50  if (m < 1)
+
51  {
+
52  return {};
+
53  }
+
54 
+
55  const auto mDouble = static_cast<double>(m);
+
56  const auto mMinus1Over2 = (mDouble - 1.0) / 2.0;
+
57  const auto mMinus1Over2Inv = 1.0 / mMinus1Over2;
+
58 
+
59  NdArray<double> result(1, m);
+
60  int32 i = 0;
+
61  for (auto n : linspace(0.0, mDouble - 1.0, m, true))
+
62  {
+
63  result[i++] = mMinus1Over2Inv * (mMinus1Over2 - std::abs(n - mMinus1Over2));
+
64  }
+
65 
+
66  return result;
+
67  }
+
68 } // namespace nc
+ + + +
nc
Definition: Coordinate.hpp:45
+
nc::bartlett
NdArray< double > bartlett(int32 m)
Definition: bartlett.hpp:48
+
nc::linspace
NdArray< dtype > linspace(dtype inStart, dtype inStop, uint32 inNum=50, bool endPoint=true)
Definition: linspace.hpp:61
+
nc::abs
auto abs(dtype inValue) noexcept
Definition: abs.hpp:49
+
nc::int32
std::int32_t int32
Definition: Types.hpp:36
+
+
+ + + + diff --git a/docs/doxygen/html/bernoilli_8hpp.html b/docs/doxygen/html/bernoilli_8hpp.html index 5938450df..3948ac5dd 100644 --- a/docs/doxygen/html/bernoilli_8hpp.html +++ b/docs/doxygen/html/bernoilli_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: bernoilli.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
blackman.hpp File Reference
+
+
+
#include <cmath>
+#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Constants.hpp"
+#include "NumCpp/Functions/linspace.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + +

+Functions

NdArray< double > nc::blackman (int32 m)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/blackman_8hpp.js b/docs/doxygen/html/blackman_8hpp.js new file mode 100644 index 000000000..797c27f61 --- /dev/null +++ b/docs/doxygen/html/blackman_8hpp.js @@ -0,0 +1,4 @@ +var blackman_8hpp = +[ + [ "blackman", "blackman_8hpp.html#aab31b376c91a94e877f236177dbab4d0", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/blackman_8hpp_source.html b/docs/doxygen/html/blackman_8hpp_source.html new file mode 100644 index 000000000..a2fd5cecd --- /dev/null +++ b/docs/doxygen/html/blackman_8hpp_source.html @@ -0,0 +1,145 @@ + + + + + + + +NumCpp: blackman.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
blackman.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include <cmath>
+
31 
+
32 #include "NumCpp/NdArray.hpp"
+
33 #include "NumCpp/Core/Constants.hpp"
+
34 #include "NumCpp/Functions/linspace.hpp"
+
35 
+
36 namespace nc
+
37 {
+
38  //============================================================================
+
39  // Method Description:
+
49  inline NdArray<double> blackman(int32 m)
+
50  {
+
51  if (m < 1)
+
52  {
+
53  return {};
+
54  }
+
55 
+
56  const auto mDouble = static_cast<double>(m);
+
57 
+
58  NdArray<double> result(1, m);
+
59  int32 i = 0;
+
60  for (auto n : linspace(0.0, mDouble, m, true))
+
61  {
+
62  const auto nOverM = n / mDouble;
+
63  result[i++] = 0.42 - 0.5 * std::cos(2.0 * constants::pi * nOverM)
+
64  + 0.08 * std::cos(4.0 * constants::pi * nOverM);
+
65  }
+
66 
+
67  return result;
+
68  }
+
69 } // namespace nc
+ + + + +
nc::constants::pi
constexpr double pi
Pi.
Definition: Constants.hpp:43
+
nc
Definition: Coordinate.hpp:45
+
nc::linspace
NdArray< dtype > linspace(dtype inStart, dtype inStop, uint32 inNum=50, bool endPoint=true)
Definition: linspace.hpp:61
+
nc::cos
auto cos(dtype inValue) noexcept
Definition: cos.hpp:49
+
nc::int32
std::int32_t int32
Definition: Types.hpp:36
+
nc::blackman
NdArray< double > blackman(int32 m)
Definition: blackman.hpp:49
+
+
+ + + + diff --git a/docs/doxygen/html/byteswap_8hpp.html b/docs/doxygen/html/byteswap_8hpp.html index 87f94b8b0..0d41056c9 100644 --- a/docs/doxygen/html/byteswap_8hpp.html +++ b/docs/doxygen/html/byteswap_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: byteswap.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
corrcoef.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Functions/cov.hpp"
+#include "NumCpp/Functions/empty_like.hpp"
+#include "NumCpp/Functions/sqrt.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
NdArray< double > nc::corrcoef (const NdArray< dtype > &x)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/corrcoef_8hpp.js b/docs/doxygen/html/corrcoef_8hpp.js new file mode 100644 index 000000000..ef95b8667 --- /dev/null +++ b/docs/doxygen/html/corrcoef_8hpp.js @@ -0,0 +1,4 @@ +var corrcoef_8hpp = +[ + [ "corrcoef", "corrcoef_8hpp.html#a2232014b014afca61e5ebe93c5ba2c0c", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/corrcoef_8hpp_source.html b/docs/doxygen/html/corrcoef_8hpp_source.html new file mode 100644 index 000000000..75b2f090c --- /dev/null +++ b/docs/doxygen/html/corrcoef_8hpp_source.html @@ -0,0 +1,145 @@ + + + + + + + +NumCpp: corrcoef.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
corrcoef.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Functions/cov.hpp"
+
33 #include "NumCpp/Functions/empty_like.hpp"
+
34 #include "NumCpp/Functions/sqrt.hpp"
+
35 
+
36 namespace nc
+
37 {
+
38  //============================================================================
+
39  // Method Description:
+
49  template<typename dtype>
+
50  NdArray<double> corrcoef(const NdArray<dtype>& x)
+
51  {
+
52  STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype);
+
53 
+
54  const auto covariance = cov(x);
+
55  auto normalizedCovariance = empty_like(covariance);
+
56  for (decltype(covariance.numRows()) i = 0; i < covariance.numRows(); ++i)
+
57  {
+
58  for (decltype(covariance.numCols()) j = 0; j < covariance.numCols(); ++j)
+
59  {
+
60  normalizedCovariance(i, j) = covariance(i, j) / sqrt(covariance(i, i) * covariance(j, j));
+
61  }
+
62  }
+
63 
+
64  return normalizedCovariance;
+
65  }
+
66 } // namespace nc
+ + +
STATIC_ASSERT_ARITHMETIC_OR_COMPLEX
#define STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype)
Definition: StaticAsserts.hpp:50
+ + +
empty_like.hpp
+
nc::constants::j
constexpr auto j
Definition: Constants.hpp:45
+
nc
Definition: Coordinate.hpp:45
+
nc::corrcoef
NdArray< double > corrcoef(const NdArray< dtype > &x)
Definition: corrcoef.hpp:50
+
nc::cov
NdArray< double > cov(const NdArray< dtype > &x, bool bias=false)
Definition: cov.hpp:52
+
nc::sqrt
auto sqrt(dtype inValue) noexcept
Definition: sqrt.hpp:48
+
nc::empty_like
NdArray< dtype > empty_like(const NdArray< dtype > &inArray)
Definition: empty_like.hpp:44
+ +
+
+ + + + diff --git a/docs/doxygen/html/cos_8hpp.html b/docs/doxygen/html/cos_8hpp.html index c37d7f2aa..284eea533 100644 --- a/docs/doxygen/html/cos_8hpp.html +++ b/docs/doxygen/html/cos_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: cos.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
cov.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Functions/mean.hpp"
+#include <type_traits>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
NdArray< double > nc::cov (const NdArray< dtype > &x, bool bias=false)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/cov_8hpp.js b/docs/doxygen/html/cov_8hpp.js new file mode 100644 index 000000000..2dfe72ff2 --- /dev/null +++ b/docs/doxygen/html/cov_8hpp.js @@ -0,0 +1,4 @@ +var cov_8hpp = +[ + [ "cov", "cov_8hpp.html#a61dbb6e2f778525a305dc235a9a43c76", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/cov_8hpp_source.html b/docs/doxygen/html/cov_8hpp_source.html new file mode 100644 index 000000000..b0f447128 --- /dev/null +++ b/docs/doxygen/html/cov_8hpp_source.html @@ -0,0 +1,170 @@ + + + + + + + +NumCpp: cov.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
cov.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Functions/mean.hpp"
+
33 
+
34 #include <type_traits>
+
35 
+
36 namespace nc
+
37 {
+
38  //============================================================================
+
39  // Method Description:
+
51  template<typename dtype>
+
52  NdArray<double> cov(const NdArray<dtype>& x, bool bias = false)
+
53  {
+
54  STATIC_ASSERT_ARITHMETIC(dtype);
+
55 
+
56  const auto varMeans = mean(x, Axis::COL);
+
57  const auto numVars = x.numRows();
+
58  const auto numObs = x.numCols();
+
59  const auto normilizationFactor = bias ? static_cast<double>(numObs) : static_cast<double>(numObs - 1);
+
60  using IndexType = std::remove_const<decltype(numVars)>::type;
+
61 
+
62  // upper triangle
+
63  auto covariance = NdArray<double>(numVars);
+
64  for (IndexType i = 0; i < numVars; ++i)
+
65  {
+
66  const auto var1Mean = varMeans[i];
+
67 
+
68  for (IndexType j = i; j < numVars; ++j)
+
69  {
+
70  const auto var2Mean = varMeans[j];
+
71 
+
72  double sum = 0.0;
+
73  for (IndexType iObs = 0; iObs < numObs; ++iObs)
+
74  {
+
75  sum += (x(i, iObs) - var1Mean) * (x(j, iObs) - var2Mean);
+
76  }
+
77 
+
78  covariance(i, j) = sum / normilizationFactor;
+
79  }
+
80  }
+
81 
+
82  // fill in the rest of the symmetric matrix
+
83  for (IndexType j = 0; j < numVars; ++j)
+
84  {
+
85  for (IndexType i = j + 1; i < numVars; ++i)
+
86  {
+
87  covariance(i, j) = covariance(j, i);
+
88  }
+
89  }
+
90 
+
91  return covariance;
+
92  }
+
93 } // namespace nc
+ + +
STATIC_ASSERT_ARITHMETIC
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
+ +
nc::NdArray::numCols
uint32 numCols() const noexcept
Definition: NdArrayCore.hpp:3418
+
nc::NdArray::numRows
uint32 numRows() const noexcept
Definition: NdArrayCore.hpp:3430
+ +
nc::constants::j
constexpr auto j
Definition: Constants.hpp:45
+
nc
Definition: Coordinate.hpp:45
+ +
nc::cov
NdArray< double > cov(const NdArray< dtype > &x, bool bias=false)
Definition: cov.hpp:52
+
nc::sum
NdArray< dtype > sum(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: sum.hpp:46
+
nc::mean
NdArray< double > mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: mean.hpp:52
+
+
+ + + + diff --git a/docs/doxygen/html/cov__inv_8hpp.html b/docs/doxygen/html/cov__inv_8hpp.html new file mode 100644 index 000000000..08880a17a --- /dev/null +++ b/docs/doxygen/html/cov__inv_8hpp.html @@ -0,0 +1,130 @@ + + + + + + + +NumCpp: cov_inv.hpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
cov_inv.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Functions/cov.hpp"
+#include "NumCpp/Linalg/inv.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
NdArray< double > nc::cov_inv (const NdArray< dtype > &x, bool bias=false)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/cov__inv_8hpp.js b/docs/doxygen/html/cov__inv_8hpp.js new file mode 100644 index 000000000..fdb3e8e22 --- /dev/null +++ b/docs/doxygen/html/cov__inv_8hpp.js @@ -0,0 +1,4 @@ +var cov__inv_8hpp = +[ + [ "cov_inv", "cov__inv_8hpp.html#a2a45ff9db0b44932844a5d9cb13b2d38", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/cov__inv_8hpp_source.html b/docs/doxygen/html/cov__inv_8hpp_source.html new file mode 100644 index 000000000..eaebcab03 --- /dev/null +++ b/docs/doxygen/html/cov__inv_8hpp_source.html @@ -0,0 +1,131 @@ + + + + + + + +NumCpp: cov_inv.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
cov_inv.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Functions/cov.hpp"
+
33 #include "NumCpp/Linalg/inv.hpp"
+
34 
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
48  template<typename dtype>
+
49  NdArray<double> cov_inv(const NdArray<dtype>& x, bool bias = false)
+
50  {
+
51  STATIC_ASSERT_ARITHMETIC(dtype);
+
52 
+
53  return linalg::inv(cov(x, bias));
+
54  }
+
55 } // namespace nc
+ + +
STATIC_ASSERT_ARITHMETIC
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
+ + + +
nc::linalg::inv
NdArray< double > inv(const NdArray< dtype > &inArray)
Definition: inv.hpp:52
+
nc
Definition: Coordinate.hpp:45
+
nc::cov_inv
NdArray< double > cov_inv(const NdArray< dtype > &x, bool bias=false)
Definition: cov_inv.hpp:49
+
nc::cov
NdArray< double > cov(const NdArray< dtype > &x, bool bias=false)
Definition: cov.hpp:52
+
+
+ + + + diff --git a/docs/doxygen/html/cross_8hpp.html b/docs/doxygen/html/cross_8hpp.html index 0cf67ba31..7415fd252 100644 --- a/docs/doxygen/html/cross_8hpp.html +++ b/docs/doxygen/html/cross_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: cross.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
extract.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/Error.hpp"
+#include <vector>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
NdArray< dtype > nc::extract (const NdArray< bool > &condition, const NdArray< dtype > &arr)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/extract_8hpp.js b/docs/doxygen/html/extract_8hpp.js new file mode 100644 index 000000000..2bf77bca5 --- /dev/null +++ b/docs/doxygen/html/extract_8hpp.js @@ -0,0 +1,4 @@ +var extract_8hpp = +[ + [ "extract", "extract_8hpp.html#af75594a13a627d4b014cf04749324571", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/extract_8hpp_source.html b/docs/doxygen/html/extract_8hpp_source.html new file mode 100644 index 000000000..0bef0dba5 --- /dev/null +++ b/docs/doxygen/html/extract_8hpp_source.html @@ -0,0 +1,140 @@ + + + + + + + +NumCpp: extract.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
extract.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/Error.hpp"
+
32 
+
33 #include <vector>
+
34 
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
47  template<typename dtype>
+
48  NdArray<dtype> extract(const NdArray<bool>& condition, const NdArray<dtype>& arr)
+
49  {
+
50  if (condition.size() != arr.size())
+
51  {
+
52  THROW_INVALID_ARGUMENT_ERROR("Input arguments 'condition' and 'arr' must have the same size.");
+
53  }
+
54 
+
55  std::vector<dtype> values;
+
56  for (decltype(arr.size()) i = 0; i < arr.size(); ++i)
+
57  {
+
58  if (condition[i])
+
59  {
+
60  values.push_back(arr[i]);
+
61  }
+
62  }
+
63 
+
64  return NdArray<dtype>(values.begin(), values.end());
+
65  }
+
66 } // namespace nc
+ +
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
+ +
nc::NdArray
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
+
nc::NdArray::size
size_type size() const noexcept
Definition: NdArrayCore.hpp:4296
+
nc
Definition: Coordinate.hpp:45
+
nc::extract
NdArray< dtype > extract(const NdArray< bool > &condition, const NdArray< dtype > &arr)
Definition: extract.hpp:48
+
+
+ + + + diff --git a/docs/doxygen/html/extreme_value_8hpp.html b/docs/doxygen/html/extreme_value_8hpp.html index 276810bb0..be84ea8b1 100644 --- a/docs/doxygen/html/extreme_value_8hpp.html +++ b/docs/doxygen/html/extreme_value_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: extremeValue.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
geomspace.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/Error.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Functions/logb.hpp"
+#include "NumCpp/Functions/logspace.hpp"
+#include "NumCpp/Functions/nth_root.hpp"
+#include "NumCpp/Utils/essentiallyEqual.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
NdArray< double > nc::geomspace (dtype start, dtype stop, uint32 num=50, bool endPoint=true)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/geomspace_8hpp.js b/docs/doxygen/html/geomspace_8hpp.js new file mode 100644 index 000000000..3f2f532b2 --- /dev/null +++ b/docs/doxygen/html/geomspace_8hpp.js @@ -0,0 +1,4 @@ +var geomspace_8hpp = +[ + [ "geomspace", "geomspace_8hpp.html#aa5cdd68a27ae041c382eabfb07dfa9bc", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/geomspace_8hpp_source.html b/docs/doxygen/html/geomspace_8hpp_source.html new file mode 100644 index 000000000..bc29dd189 --- /dev/null +++ b/docs/doxygen/html/geomspace_8hpp_source.html @@ -0,0 +1,158 @@ + + + + + + + +NumCpp: geomspace.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
geomspace.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/Error.hpp"
+
32 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
33 #include "NumCpp/Functions/logb.hpp"
+
34 #include "NumCpp/Functions/logspace.hpp"
+
35 #include "NumCpp/Functions/nth_root.hpp"
+
36 #include "NumCpp/Utils/essentiallyEqual.hpp"
+
37 
+
38 namespace nc
+
39 {
+
40  //============================================================================
+
41  // Method Description:
+
57  template<typename dtype>
+
58  NdArray<double> geomspace(dtype start, dtype stop, uint32 num = 50, bool endPoint = true)
+
59  {
+
60  STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype);
+
61 
+
62  if (utils::essentiallyEqual(start, dtype{0}))
+
63  {
+
64  THROW_INVALID_ARGUMENT_ERROR("Geometric sequence cannot include zero");
+
65  }
+
66 
+
67  if (num == 1)
+
68  {
+
69  return { static_cast<double>(start) };
+
70  }
+
71  else if (num == 2 && endPoint)
+
72  {
+
73  return {static_cast<double>(start), static_cast<double>(stop)};
+
74  }
+
75 
+
76  const auto base = nth_root(stop / start, num - 1);
+
77  const auto logStart = logb(start, base);
+
78  const auto logStop = logb(stop, base);
+
79  return logspace(logStart, logStop, num, endPoint, base);
+
80  }
+
81 } // namespace nc
+ +
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
+ + +
STATIC_ASSERT_ARITHMETIC_OR_COMPLEX
#define STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype)
Definition: StaticAsserts.hpp:50
+ + + + +
nc::utils::essentiallyEqual
bool essentiallyEqual(dtype inValue1, dtype inValue2) noexcept
Definition: essentiallyEqual.hpp:52
+
nc
Definition: Coordinate.hpp:45
+
nc::logspace
NdArray< double > logspace(dtype start, dtype stop, uint32 num=50, bool endPoint=true, double base=10.0)
Definition: logspace.hpp:57
+
nc::logb
auto logb(dtype inValue, dtype inBase) noexcept
Definition: logb.hpp:49
+
nc::geomspace
NdArray< double > geomspace(dtype start, dtype stop, uint32 num=50, bool endPoint=true)
Definition: geomspace.hpp:58
+
nc::nth_root
double nth_root(dtype1 inValue, dtype2 inRoot) noexcept
Definition: nth_root.hpp:46
+
nc::uint32
std::uint32_t uint32
Definition: Types.hpp:40
+
nth_root.hpp
+
+
+ + + + diff --git a/docs/doxygen/html/globals.html b/docs/doxygen/html/globals.html index fbdee004e..4321c5aa3 100644 --- a/docs/doxygen/html/globals.html +++ b/docs/doxygen/html/globals.html @@ -3,7 +3,7 @@ - + NumCpp: Globals @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
hamming.hpp File Reference
+
+
+
#include <cmath>
+#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Constants.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + +

+Functions

NdArray< double > nc::hamming (int32 m)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/hamming_8hpp.js b/docs/doxygen/html/hamming_8hpp.js new file mode 100644 index 000000000..56aab8744 --- /dev/null +++ b/docs/doxygen/html/hamming_8hpp.js @@ -0,0 +1,4 @@ +var hamming_8hpp = +[ + [ "hamming", "hamming_8hpp.html#ad7fcd267d31bec0085f82959e3b5f9d3", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/hamming_8hpp_source.html b/docs/doxygen/html/hamming_8hpp_source.html new file mode 100644 index 000000000..6e80f453a --- /dev/null +++ b/docs/doxygen/html/hamming_8hpp_source.html @@ -0,0 +1,142 @@ + + + + + + + +NumCpp: hamming.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
hamming.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include <cmath>
+
31 
+
32 #include "NumCpp/NdArray.hpp"
+
33 #include "NumCpp/Core/Constants.hpp"
+
34 
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
48  inline NdArray<double> hamming(int32 m)
+
49  {
+
50  if (m < 1)
+
51  {
+
52  return {};
+
53  }
+
54 
+
55  const auto mDouble = static_cast<double>(m);
+
56  const auto twoPiDivMMinus1 = (2.0 * constants::pi) / (mDouble - 1.0);
+
57 
+
58  NdArray<double> result(1, m);
+
59  int32 i = 0;
+
60  for (auto n : linspace(0.0, mDouble - 1.0, m, true))
+
61  {
+
62  result[i++] = 0.54 - 0.46 * std::cos(twoPiDivMMinus1 * n);
+
63  }
+
64 
+
65  return result;
+
66  }
+
67 } // namespace nc
+ + + +
nc::constants::pi
constexpr double pi
Pi.
Definition: Constants.hpp:43
+
nc
Definition: Coordinate.hpp:45
+
nc::linspace
NdArray< dtype > linspace(dtype inStart, dtype inStop, uint32 inNum=50, bool endPoint=true)
Definition: linspace.hpp:61
+
nc::cos
auto cos(dtype inValue) noexcept
Definition: cos.hpp:49
+
nc::int32
std::int32_t int32
Definition: Types.hpp:36
+
nc::hamming
NdArray< double > hamming(int32 m)
Definition: hamming.hpp:48
+
+
+ + + + diff --git a/docs/doxygen/html/hamming_encode_8hpp.html b/docs/doxygen/html/hamming_encode_8hpp.html new file mode 100644 index 000000000..0d0707e60 --- /dev/null +++ b/docs/doxygen/html/hamming_encode_8hpp.html @@ -0,0 +1,171 @@ + + + + + + + +NumCpp: hammingEncode.hpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
hammingEncode.hpp File Reference
+
+
+
#include <bitset>
+#include <cmath>
+#include <cstdlib>
+#include <stdexcept>
+#include <type_traits>
+#include <vector>
+#include "boost/dynamic_bitset.hpp"
+#include "NumCpp/Core/Internal/TypeTraits.hpp"
+
+

Go to the source code of this file.

+ + + + + + + + +

+Namespaces

 nc
 
 nc::edac
 
 nc::edac::detail
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

bool nc::edac::detail::calculateParity (const boost::dynamic_bitset<> &data) noexcept
 
template<std::size_t DataBits>
constexpr bool nc::edac::detail::calculateParity (const std::bitset< DataBits > &data) noexcept
 
template<std::size_t DataBits, typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
bool nc::edac::detail::calculateParity (const std::bitset< DataBits > &data, IntType parityBit)
 
template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
std::size_t nc::edac::detail::checkBitsConsistent ()
 
template<typename IntType1 , typename IntType2 , std::enable_if_t< std::is_integral_v< IntType1 >, int > = 0, std::enable_if_t< std::is_integral_v< IntType2 >, int > = 0>
std::vector< std::size_t > nc::edac::detail::dataBitsCovered (IntType1 numDataBits, IntType2 parityBit)
 
template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
int nc::edac::decode (std::bitset< EncodedBits > encodedBits, std::bitset< DataBits > &decodedBits)
 
template<std::size_t DataBits>
boost::dynamic_bitset nc::edac::encode (const std::bitset< DataBits > &dataBits)
 
template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
std::bitset< DataBits > nc::edac::detail::extractData (const std::bitset< EncodedBits > &encodedBits) noexcept
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
constexpr bool nc::edac::detail::isPowerOfTwo (IntType n) noexcept
 Tests if value is a power of two. More...
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
std::size_t nc::edac::detail::nextPowerOfTwo (IntType n)
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
std::size_t nc::edac::detail::numSecdedParityBitsNeeded (IntType numDataBits)
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
std::vector< std::size_t > nc::edac::detail::powersOfTwo (IntType n)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Hamming EDAC encoding https://en.wikipedia.org/wiki/Hamming_code

+
+
+ + + + diff --git a/docs/doxygen/html/hamming_encode_8hpp.js b/docs/doxygen/html/hamming_encode_8hpp.js new file mode 100644 index 000000000..e05ed6c3b --- /dev/null +++ b/docs/doxygen/html/hamming_encode_8hpp.js @@ -0,0 +1,15 @@ +var hamming_encode_8hpp = +[ + [ "calculateParity", "hamming_encode_8hpp.html#abde37c852253de171988da5e4b775273", null ], + [ "calculateParity", "hamming_encode_8hpp.html#ad3215e8486eb3a544a483e5234c856d7", null ], + [ "calculateParity", "hamming_encode_8hpp.html#aea349d7b4d28ca91b85bcb3a2823c145", null ], + [ "checkBitsConsistent", "hamming_encode_8hpp.html#af386b23445a4942453c69cff80ee0e20", null ], + [ "dataBitsCovered", "hamming_encode_8hpp.html#aa8a14d5fd872ed0292631e57f5afe618", null ], + [ "decode", "hamming_encode_8hpp.html#aa24d4f99fd0739df7480845e96668e0f", null ], + [ "encode", "hamming_encode_8hpp.html#af5c36a1f2c74d632192cf9fe29cc5f03", null ], + [ "extractData", "hamming_encode_8hpp.html#a1c606c3f9302bb406021a50006898ebf", null ], + [ "isPowerOfTwo", "hamming_encode_8hpp.html#a7f066ec8b196c2943ae99382eb63e2fb", null ], + [ "nextPowerOfTwo", "hamming_encode_8hpp.html#a279241a794bffbea6920299cf8e5c4a1", null ], + [ "numSecdedParityBitsNeeded", "hamming_encode_8hpp.html#a6ee59971c08bfdc3e11a0245f17d5f9a", null ], + [ "powersOfTwo", "hamming_encode_8hpp.html#ad4328ffa9ba9949a9c4b494592496055", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/hamming_encode_8hpp_source.html b/docs/doxygen/html/hamming_encode_8hpp_source.html new file mode 100644 index 000000000..6a8949fdf --- /dev/null +++ b/docs/doxygen/html/hamming_encode_8hpp_source.html @@ -0,0 +1,429 @@ + + + + + + + +NumCpp: hammingEncode.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
hammingEncode.hpp
+
+
+Go to the documentation of this file.
1 
+
29 #pragma once
+
30 
+
31 #ifndef NUMCPP_NO_USE_BOOST
+
32 
+
33 #include <bitset>
+
34 #include <cmath>
+
35 #include <cstdlib>
+
36 #include <stdexcept>
+
37 #include <type_traits>
+
38 #include <vector>
+
39 
+
40 #include "boost/dynamic_bitset.hpp"
+
41 
+
42 #include "NumCpp/Core/Internal/TypeTraits.hpp"
+
43 
+
44 namespace nc
+
45 {
+
46  namespace edac::detail
+
47  {
+
48  //============================================================================
+
49  // Method Description:
+
55  template<
+
56  typename IntType,
+
57  std::enable_if_t<std::is_integral_v<IntType>, int> = 0
+
58  >
+
59  constexpr bool isPowerOfTwo(IntType n) noexcept
+
60  {
+
61  // Returns true if the given non-negative integer n is a power of two.
+
62  return n != 0 && (n & (n - 1)) == 0;
+
63  }
+
64 
+
65  //============================================================================
+
66  // Method Description:
+
77  template<
+
78  typename IntType,
+
79  std::enable_if_t<std::is_integral_v<IntType>, int> = 0
+
80  >
+
81  std::size_t nextPowerOfTwo(IntType n)
+
82  {
+
83  if (n < 0)
+
84  {
+
85  throw std::invalid_argument("Input value must be greater than or equal to zero.");
+
86  }
+
87 
+
88  if (isPowerOfTwo(n))
+
89  {
+
90  return static_cast<std::size_t>(n) << 1;
+
91  }
+
92 
+
93  return static_cast<std::size_t>(std::pow(2, std::ceil(std::log2(n))));
+
94  }
+
95 
+
96  //============================================================================
+
97  // Method Description:
+
104  template<
+
105  typename IntType,
+
106  std::enable_if_t<std::is_integral_v<IntType>, int> = 0
+
107  >
+
108  std::vector<std::size_t> powersOfTwo(IntType n)
+
109  {
+
110  auto i = std::size_t{ 0 };
+
111  auto power = std::size_t{ 1 };
+
112  auto powers = std::vector<std::size_t>();
+
113  powers.reserve(n);
+
114 
+
115  while (i < static_cast<std::size_t>(n))
+
116  {
+
117  powers.push_back(power);
+
118  power <<= 1;
+
119  ++i;
+
120  }
+
121 
+
122  return powers;
+
123  }
+
124 
+
125  //============================================================================
+
126  // Method Description:
+
134  template<
+
135  typename IntType,
+
136  std::enable_if_t<std::is_integral_v<IntType>, int> = 0
+
137  >
+
138  std::size_t numSecdedParityBitsNeeded(IntType numDataBits)
+
139  {
+
140  const auto n = nextPowerOfTwo(numDataBits);
+
141  const auto lowerBin = static_cast<std::size_t>(std::floor(std::log2(n)));
+
142  const auto upperBin = lowerBin + 1;
+
143  const auto dataBitBoundary = n - lowerBin - 1;
+
144  const auto numParityBits = numDataBits <= dataBitBoundary ? lowerBin + 1 : upperBin + 1;
+
145 
+
146  if (!isPowerOfTwo(numParityBits + numDataBits))
+
147  {
+
148  throw std::runtime_error("input number of data bits is not a valid Hamming SECDED code configuration.");
+
149  }
+
150 
+
151  return numParityBits;
+
152  }
+
153 
+
154  //============================================================================
+
155  // Method Description:
+
166  template<
+
167  typename IntType1,
+
168  typename IntType2,
+
169  std::enable_if_t<std::is_integral_v<IntType1>, int> = 0,
+
170  std::enable_if_t<std::is_integral_v<IntType2>, int> = 0
+
171  >
+
172  std::vector<std::size_t> dataBitsCovered(IntType1 numDataBits, IntType2 parityBit)
+
173  {
+
174  if (!isPowerOfTwo(parityBit))
+
175  {
+
176  throw std::invalid_argument("All hamming parity bits are indexed by powers of two.");
+
177  }
+
178 
+
179  std::size_t dataIndex = 1; // bit we're currently at in the DATA bitstring
+
180  std::size_t totalIndex = 3; // bit we're currently at in the OVERALL bitstring
+
181  auto parityBit_ = static_cast<std::size_t>(parityBit);
+
182 
+
183  auto indices = std::vector<std::size_t>();
+
184  indices.reserve(numDataBits); // worst case
+
185 
+
186  while (dataIndex <= static_cast<std::size_t>(numDataBits))
+
187  {
+
188  const auto currentBitIsData = !isPowerOfTwo(totalIndex);
+
189  if (currentBitIsData && (totalIndex % (parityBit_ << 1)) >= parityBit_)
+
190  {
+
191  indices.push_back(dataIndex - 1); // adjust output to be zero indexed
+
192  }
+
193 
+
194  dataIndex += currentBitIsData ? 1 : 0;
+
195  ++totalIndex;
+
196  }
+
197 
+
198  return indices;
+
199  }
+
200 
+
201  //============================================================================
+
202  // Method Description:
+
208  template<std::size_t DataBits>
+
209  constexpr bool calculateParity(const std::bitset<DataBits>& data) noexcept
+
210  {
+
211  bool parity = false;
+
212  for (std::size_t i = 0; i < DataBits - 1; ++i)
+
213  {
+
214  parity ^= data[i];
+
215  }
+
216 
+
217  return parity;
+
218  }
+
219 
+
220  //============================================================================
+
221  // Method Description:
+
227  inline bool calculateParity(const boost::dynamic_bitset<>& data) noexcept
+
228  {
+
229  bool parity = false;
+
230  for (std::size_t i = 0; i < data.size() - 1; ++i)
+
231  {
+
232  parity ^= data[i];
+
233  }
+
234 
+
235  return parity;
+
236  }
+
237 
+
238  //============================================================================
+
239  // Method Description:
+
249  template<
+
250  std::size_t DataBits,
+
251  typename IntType,
+
252  std::enable_if_t<std::is_integral_v<IntType>, int> = 0
+
253  >
+
254  bool calculateParity(const std::bitset<DataBits>& data, IntType parityBit)
+
255  {
+
256  bool parity = false;
+
257  for (const auto i : dataBitsCovered(DataBits, parityBit))
+
258  {
+
259  parity ^= data[i];
+
260  }
+
261 
+
262  return parity;
+
263  }
+
264 
+
265  //============================================================================
+
266  // Method Description:
+
273  template<
+
274  std::size_t DataBits,
+
275  std::size_t EncodedBits,
+
276  std::enable_if_t<greaterThan_v<EncodedBits, DataBits>, int> = 0
+
277  >
+
278  std::size_t checkBitsConsistent()
+
279  {
+
280  const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits);
+
281  if (numParityBits + DataBits != EncodedBits)
+
282  {
+
283  throw std::runtime_error("DataBits and EncodedBits are not consistent");
+
284  }
+
285 
+
286  return numParityBits;
+
287  }
+
288 
+
289  //============================================================================
+
290  // Method Description:
+
297  template<
+
298  std::size_t DataBits,
+
299  std::size_t EncodedBits,
+
300  std::enable_if_t<greaterThan_v<EncodedBits, DataBits>, int> = 0
+
301  >
+
302  std::bitset<DataBits> extractData(const std::bitset<EncodedBits>& encodedBits) noexcept
+
303  {
+
304  auto dataBits = std::bitset<DataBits>();
+
305 
+
306  std::size_t dataIndex = 0;
+
307  for (std::size_t encodedIndex = 0; encodedIndex < EncodedBits; ++encodedIndex)
+
308  {
+
309  if (!isPowerOfTwo(encodedIndex + 1))
+
310  {
+
311  dataBits[dataIndex++] = encodedBits[encodedIndex];
+
312  if (dataIndex == DataBits)
+
313  {
+
314  break;
+
315  }
+
316  }
+
317  }
+
318 
+
319  return dataBits;
+
320  }
+
321  } // namespace edac::detail
+
322 
+
323  namespace edac
+
324  {
+
325  //============================================================================
+
326  // Method Description:
+
333  template<std::size_t DataBits>
+
334  boost::dynamic_bitset<> encode(const std::bitset<DataBits>& dataBits)
+
335  {
+
336  const auto numParityBits = detail::numSecdedParityBitsNeeded(DataBits);
+
337  const auto numEncodedBits = numParityBits + DataBits;
+
338 
+
339  auto encodedBits = boost::dynamic_bitset<>(numEncodedBits);
+
340 
+
341  // set the parity bits
+
342  for (const auto parityBit : detail::powersOfTwo(numParityBits - 1)) // -1 because overall parity will be calculated seperately later
+
343  {
+
344  encodedBits[parityBit - 1] = detail::calculateParity(dataBits, parityBit);
+
345  }
+
346 
+
347  // set the data bits, switch to 1 based to make things easier for isPowerOfTwo
+
348  std::size_t dataBitIndex = 0;
+
349  for (std::size_t bitIndex = 1; bitIndex <= numEncodedBits - 1; ++bitIndex) // -1 to account for the overall parity bit
+
350  {
+
351  if (!detail::isPowerOfTwo(bitIndex))
+
352  {
+
353  encodedBits[bitIndex - 1] = dataBits[dataBitIndex++];
+
354  }
+
355  }
+
356 
+
357  // compute and set overall parity for the entire encoded data (not including the overall parity bit itself)
+
358  encodedBits[numEncodedBits - 1] = detail::calculateParity(encodedBits); // overall parity at the end
+
359 
+
360  // all done!
+
361  return encodedBits;
+
362  }
+
363 
+
364  //============================================================================
+
365  // Method Description:
+
375  template<
+
376  std::size_t DataBits,
+
377  std::size_t EncodedBits,
+
378  std::enable_if_t<greaterThan_v<EncodedBits, DataBits>, int> = 0
+
379  >
+
380  int decode(std::bitset<EncodedBits> encodedBits, std::bitset<DataBits>& decodedBits)
+
381  {
+
382  const auto numParityBits = detail::checkBitsConsistent<DataBits, EncodedBits>();
+
383 
+
384  // the data bits, which may be corrupted
+
385  decodedBits = detail::extractData<DataBits>(encodedBits);
+
386 
+
387  // check the overall parity bit
+
388  const auto overallExpected = detail::calculateParity(encodedBits);
+
389  const auto overallActual = encodedBits[EncodedBits - 1];
+
390  const auto overallCorrect = overallExpected == overallActual;
+
391 
+
392  // check individual parities - each parity bit's index (besides overall parity) is a power of two
+
393  std::size_t indexOfError = 0;
+
394  for (const auto parityBit : detail::powersOfTwo(numParityBits - 1))
+
395  {
+
396  const auto expected = detail::calculateParity(decodedBits, parityBit);
+
397  const auto actual = encodedBits[parityBit - 1]; // -1 because parityBit is 1 based
+
398  if (expected != actual)
+
399  {
+
400  indexOfError += parityBit;
+
401  }
+
402  }
+
403 
+
404  // attempt to repair a single flipped bit or throw exception if more than one
+
405  if (overallCorrect && indexOfError != 0)
+
406  {
+
407  // two errors found
+
408  return 2;
+
409  }
+
410  else if (!overallCorrect && indexOfError != 0)
+
411  {
+
412  // one error found, flip the bit in error and we're good
+
413  encodedBits.flip(indexOfError - 1);
+
414  decodedBits = detail::extractData<DataBits>(encodedBits);
+
415  return 1;
+
416  }
+
417 
+
418  return 0;
+
419  }
+
420  } // namespace edac
+
421 } // namespace nc
+
422 #endif // #ifndef NUMCPP_NO_USE_BOOST
+ +
nc::edac::detail::extractData
std::bitset< DataBits > extractData(const std::bitset< EncodedBits > &encodedBits) noexcept
Definition: hammingEncode.hpp:302
+
nc::edac::detail::nextPowerOfTwo
std::size_t nextPowerOfTwo(IntType n)
Definition: hammingEncode.hpp:81
+
nc::edac::detail::numSecdedParityBitsNeeded
std::size_t numSecdedParityBitsNeeded(IntType numDataBits)
Definition: hammingEncode.hpp:138
+
nc::edac::detail::isPowerOfTwo
constexpr bool isPowerOfTwo(IntType n) noexcept
Tests if value is a power of two.
Definition: hammingEncode.hpp:59
+
nc::edac::detail::dataBitsCovered
std::vector< std::size_t > dataBitsCovered(IntType1 numDataBits, IntType2 parityBit)
Definition: hammingEncode.hpp:172
+
nc::edac::detail::calculateParity
constexpr bool calculateParity(const std::bitset< DataBits > &data) noexcept
Definition: hammingEncode.hpp:209
+
nc::edac::detail::powersOfTwo
std::vector< std::size_t > powersOfTwo(IntType n)
Definition: hammingEncode.hpp:108
+
nc::edac::detail::checkBitsConsistent
std::size_t checkBitsConsistent()
Definition: hammingEncode.hpp:278
+
nc::edac::decode
int decode(std::bitset< EncodedBits > encodedBits, std::bitset< DataBits > &decodedBits)
Definition: hammingEncode.hpp:380
+
nc::edac::encode
boost::dynamic_bitset encode(const std::bitset< DataBits > &dataBits)
Definition: hammingEncode.hpp:334
+
nc
Definition: Coordinate.hpp:45
+
nc::power
constexpr dtype power(dtype inValue, uint8 inExponent) noexcept
Definition: Functions/power.hpp:52
+
nc::ceil
dtype ceil(dtype inValue) noexcept
Definition: ceil.hpp:48
+
nc::log2
auto log2(dtype inValue) noexcept
Definition: log2.hpp:49
+
nc::floor
dtype floor(dtype inValue) noexcept
Definition: floor.hpp:48
+
+
+ + + + diff --git a/docs/doxygen/html/hanning_8hpp.html b/docs/doxygen/html/hanning_8hpp.html new file mode 100644 index 000000000..5dcd6df1a --- /dev/null +++ b/docs/doxygen/html/hanning_8hpp.html @@ -0,0 +1,128 @@ + + + + + + + +NumCpp: hanning.hpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
hanning.hpp File Reference
+
+
+
#include <cmath>
+#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Constants.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + +

+Functions

NdArray< double > nc::hanning (int32 m)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/hanning_8hpp.js b/docs/doxygen/html/hanning_8hpp.js new file mode 100644 index 000000000..68a2fcdfd --- /dev/null +++ b/docs/doxygen/html/hanning_8hpp.js @@ -0,0 +1,4 @@ +var hanning_8hpp = +[ + [ "hanning", "hanning_8hpp.html#ab50f9ea31f882bd8121c1adf820798b3", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/hanning_8hpp_source.html b/docs/doxygen/html/hanning_8hpp_source.html new file mode 100644 index 000000000..8e44bb6d4 --- /dev/null +++ b/docs/doxygen/html/hanning_8hpp_source.html @@ -0,0 +1,142 @@ + + + + + + + +NumCpp: hanning.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
hanning.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include <cmath>
+
31 
+
32 #include "NumCpp/NdArray.hpp"
+
33 #include "NumCpp/Core/Constants.hpp"
+
34 
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
48  inline NdArray<double> hanning(int32 m)
+
49  {
+
50  if (m < 1)
+
51  {
+
52  return {};
+
53  }
+
54 
+
55  const auto mDouble = static_cast<double>(m);
+
56  const auto twoPiDivMMinus1 = (2.0 * constants::pi) / (mDouble - 1.0);
+
57 
+
58  NdArray<double> result(1, m);
+
59  int32 i = 0;
+
60  for (auto n : linspace(0.0, mDouble - 1.0, m, true))
+
61  {
+
62  result[i++] = 0.5 - 0.5 * std::cos(twoPiDivMMinus1 * n);
+
63  }
+
64 
+
65  return result;
+
66  }
+
67 } // namespace nc
+ + + +
nc::constants::pi
constexpr double pi
Pi.
Definition: Constants.hpp:43
+
nc
Definition: Coordinate.hpp:45
+
nc::linspace
NdArray< dtype > linspace(dtype inStart, dtype inStop, uint32 inNum=50, bool endPoint=true)
Definition: linspace.hpp:61
+
nc::cos
auto cos(dtype inValue) noexcept
Definition: cos.hpp:49
+
nc::int32
std::int32_t int32
Definition: Types.hpp:36
+
nc::hanning
NdArray< double > hanning(int32 m)
Definition: hanning.hpp:48
+
+
+ + + + diff --git a/docs/doxygen/html/hat_8hpp.html b/docs/doxygen/html/hat_8hpp.html index b8aff1a90..e79f82ba2 100644 --- a/docs/doxygen/html/hat_8hpp.html +++ b/docs/doxygen/html/hat_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: hat.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
inner.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/Error.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include <algorithm>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
dtype nc::inner (const NdArray< dtype > &a, const NdArray< dtype > &b)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/inner_8hpp.js b/docs/doxygen/html/inner_8hpp.js new file mode 100644 index 000000000..60c6a31e7 --- /dev/null +++ b/docs/doxygen/html/inner_8hpp.js @@ -0,0 +1,4 @@ +var inner_8hpp = +[ + [ "inner", "inner_8hpp.html#aa44cb1f69e57caf4a79ff92960ddaebd", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/inner_8hpp_source.html b/docs/doxygen/html/inner_8hpp_source.html new file mode 100644 index 000000000..72eae181d --- /dev/null +++ b/docs/doxygen/html/inner_8hpp_source.html @@ -0,0 +1,137 @@ + + + + + + + +NumCpp: inner.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
inner.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/Error.hpp"
+
32 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
33 
+
34 #include <algorithm>
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
47  template<typename dtype>
+
48  dtype inner(const NdArray<dtype>& a, const NdArray<dtype>& b)
+
49  {
+
50  STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype);
+
51 
+
52  if (a.size() != b.size())
+
53  {
+
54  THROW_INVALID_ARGUMENT_ERROR("Inputs 'a' and 'b' must have the same size");
+
55  }
+
56 
+
57  return std::inner_product(a.cbegin(), a.cend(), b.cbegin(), dtype{ 0 });
+
58  }
+
59 } // namespace nc
+ +
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
+ + +
STATIC_ASSERT_ARITHMETIC_OR_COMPLEX
#define STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype)
Definition: StaticAsserts.hpp:50
+
nc::NdArray
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
+
nc::NdArray::size
size_type size() const noexcept
Definition: NdArrayCore.hpp:4296
+
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1216
+
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1524
+
nc
Definition: Coordinate.hpp:45
+
nc::inner
dtype inner(const NdArray< dtype > &a, const NdArray< dtype > &b)
Definition: inner.hpp:48
+
+
+ + + + diff --git a/docs/doxygen/html/intersect1d_8hpp.html b/docs/doxygen/html/intersect1d_8hpp.html index 372c4beb8..e8589e3ce 100644 --- a/docs/doxygen/html/intersect1d_8hpp.html +++ b/docs/doxygen/html/intersect1d_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: intersect1d.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
isneginf.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Functions/isinf.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + + + + +

+Functions

template<typename dtype >
NdArray< bool > nc::isneginf (const NdArray< dtype > &inArray)
 
template<typename dtype >
bool nc::isneginf (dtype inValue) noexcept
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/isneginf_8hpp.js b/docs/doxygen/html/isneginf_8hpp.js new file mode 100644 index 000000000..b1f502d97 --- /dev/null +++ b/docs/doxygen/html/isneginf_8hpp.js @@ -0,0 +1,5 @@ +var isneginf_8hpp = +[ + [ "isneginf", "isneginf_8hpp.html#af02b9a27f4177ad1ccb9ecea6ab79f46", null ], + [ "isneginf", "isneginf_8hpp.html#abb8e6e08f1b4374017ef8e4cd1841ba6", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/isneginf_8hpp_source.html b/docs/doxygen/html/isneginf_8hpp_source.html new file mode 100644 index 000000000..c3452debd --- /dev/null +++ b/docs/doxygen/html/isneginf_8hpp_source.html @@ -0,0 +1,148 @@ + + + + + + + +NumCpp: isneginf.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
isneginf.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Functions/isinf.hpp"
+
33 
+
34 namespace nc
+
35 {
+
36  //============================================================================
+
37  // Method Description:
+
46  template<typename dtype>
+
47  bool isneginf(dtype inValue) noexcept
+
48  {
+
49  STATIC_ASSERT_FLOAT(dtype);
+
50 
+
51  return inValue < 0 && std::isinf(inValue);
+
52  }
+
53 
+
54  //============================================================================
+
55  // Method Description:
+
64  template<typename dtype>
+
65  NdArray<bool> isneginf(const NdArray<dtype>& inArray)
+
66  {
+
67  NdArray<bool> returnArray(inArray.shape());
+
68  stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(),
+
69  [](dtype inValue) noexcept -> bool
+
70  {
+
71  return isneginf(inValue);
+
72  });
+
73 
+
74  return returnArray;
+
75  }
+
76 } // namespace nc
+ + +
STATIC_ASSERT_FLOAT
#define STATIC_ASSERT_FLOAT(dtype)
Definition: StaticAsserts.hpp:43
+ +
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1216
+
nc::NdArray::shape
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4283
+
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1524
+
nc::NdArray::begin
iterator begin() noexcept
Definition: NdArrayCore.hpp:1166
+ +
nc::stl_algorithms::transform
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
+
nc
Definition: Coordinate.hpp:45
+
nc::isneginf
bool isneginf(dtype inValue) noexcept
Definition: isneginf.hpp:47
+
nc::isinf
bool isinf(dtype inValue) noexcept
Definition: isinf.hpp:49
+
+
+ + + + diff --git a/docs/doxygen/html/isposinf_8hpp.html b/docs/doxygen/html/isposinf_8hpp.html new file mode 100644 index 000000000..92b4d5100 --- /dev/null +++ b/docs/doxygen/html/isposinf_8hpp.html @@ -0,0 +1,132 @@ + + + + + + + +NumCpp: isposinf.hpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
isposinf.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Functions/isinf.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + + + + +

+Functions

template<typename dtype >
NdArray< bool > nc::isposinf (const NdArray< dtype > &inArray)
 
template<typename dtype >
bool nc::isposinf (dtype inValue) noexcept
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/isposinf_8hpp.js b/docs/doxygen/html/isposinf_8hpp.js new file mode 100644 index 000000000..5729644a5 --- /dev/null +++ b/docs/doxygen/html/isposinf_8hpp.js @@ -0,0 +1,5 @@ +var isposinf_8hpp = +[ + [ "isposinf", "isposinf_8hpp.html#a00f30f48ef39bc0fa8149cb09b286e07", null ], + [ "isposinf", "isposinf_8hpp.html#a7229b43ce1e19fb560d461b6beda24af", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/isposinf_8hpp_source.html b/docs/doxygen/html/isposinf_8hpp_source.html new file mode 100644 index 000000000..93cba930d --- /dev/null +++ b/docs/doxygen/html/isposinf_8hpp_source.html @@ -0,0 +1,148 @@ + + + + + + + +NumCpp: isposinf.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
isposinf.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Functions/isinf.hpp"
+
33 
+
34 namespace nc
+
35 {
+
36  //============================================================================
+
37  // Method Description:
+
46  template<typename dtype>
+
47  bool isposinf(dtype inValue) noexcept
+
48  {
+
49  STATIC_ASSERT_FLOAT(dtype);
+
50 
+
51  return inValue > 0 && std::isinf(inValue);
+
52  }
+
53 
+
54  //============================================================================
+
55  // Method Description:
+
64  template<typename dtype>
+
65  NdArray<bool> isposinf(const NdArray<dtype>& inArray)
+
66  {
+
67  NdArray<bool> returnArray(inArray.shape());
+
68  stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(),
+
69  [](dtype inValue) noexcept -> bool
+
70  {
+
71  return isposinf(inValue);
+
72  });
+
73 
+
74  return returnArray;
+
75  }
+
76 } // namespace nc
+ + +
STATIC_ASSERT_FLOAT
#define STATIC_ASSERT_FLOAT(dtype)
Definition: StaticAsserts.hpp:43
+ +
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1216
+
nc::NdArray::shape
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4283
+
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1524
+
nc::NdArray::begin
iterator begin() noexcept
Definition: NdArrayCore.hpp:1166
+ +
nc::stl_algorithms::transform
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
+
nc
Definition: Coordinate.hpp:45
+
nc::isposinf
bool isposinf(dtype inValue) noexcept
Definition: isposinf.hpp:47
+
nc::isinf
bool isinf(dtype inValue) noexcept
Definition: isinf.hpp:49
+
+
+ + + + diff --git a/docs/doxygen/html/kaiser_8hpp.html b/docs/doxygen/html/kaiser_8hpp.html new file mode 100644 index 000000000..ab92d1ae3 --- /dev/null +++ b/docs/doxygen/html/kaiser_8hpp.html @@ -0,0 +1,129 @@ + + + + + + + +NumCpp: kaiser.hpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
kaiser.hpp File Reference
+
+
+
#include <cmath>
+#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Special/bessel_in.hpp"
+#include "NumCpp/Utils/sqr.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + +

+Functions

NdArray< double > nc::kaiser (int32 m, double beta)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/kaiser_8hpp.js b/docs/doxygen/html/kaiser_8hpp.js new file mode 100644 index 000000000..5adfefea9 --- /dev/null +++ b/docs/doxygen/html/kaiser_8hpp.js @@ -0,0 +1,4 @@ +var kaiser_8hpp = +[ + [ "kaiser", "kaiser_8hpp.html#a40ad53a4a4ad1be06ca85bbf9f9e9d25", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/kaiser_8hpp_source.html b/docs/doxygen/html/kaiser_8hpp_source.html new file mode 100644 index 000000000..c6e128485 --- /dev/null +++ b/docs/doxygen/html/kaiser_8hpp_source.html @@ -0,0 +1,150 @@ + + + + + + + +NumCpp: kaiser.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
kaiser.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include <cmath>
+
31 
+
32 #include "NumCpp/NdArray.hpp"
+
33 #include "NumCpp/Special/bessel_in.hpp"
+
34 #include "NumCpp/Utils/sqr.hpp"
+
35 
+
36 namespace nc
+
37 {
+
38  //============================================================================
+
39  // Method Description:
+
48  inline NdArray<double> kaiser(int32 m, double beta)
+
49  {
+
50  if (m < 1)
+
51  {
+
52  return {};
+
53  }
+
54 
+
55  const auto mDouble = static_cast<double>(m);
+
56  const auto mMinus1 = mDouble - 1.0;
+
57  const auto mMinus1Over2 = mMinus1 / 2.0;
+
58  const auto mMinus1Squared = utils::sqr(mMinus1);
+
59  const auto i0Beta = special::bessel_in(0, beta);
+
60 
+
61  NdArray<double> result(1, m);
+
62  int32 i = 0;
+
63  for (auto n : linspace(-mMinus1Over2, mMinus1Over2, m, true))
+
64  {
+
65  auto value = beta * std::sqrt(1.0 - (4.0 * utils::sqr(n)) / mMinus1Squared);
+
66  result[i++] = special::bessel_in(0, value) / i0Beta;
+
67  }
+
68 
+
69  return result;
+
70  }
+
71 } // namespace nc
+ +
bessel_in.hpp
+ +
nc::random::beta
dtype beta(dtype inAlpha, dtype inBeta)
Definition: Random/beta.hpp:59
+
nc::special::bessel_in
auto bessel_in(dtype1 inV, dtype2 inX)
Definition: bessel_in.hpp:59
+
nc::utils::sqr
constexpr dtype sqr(dtype inValue) noexcept
Definition: sqr.hpp:44
+
nc
Definition: Coordinate.hpp:45
+
nc::kaiser
NdArray< double > kaiser(int32 m, double beta)
Definition: kaiser.hpp:48
+
nc::linspace
NdArray< dtype > linspace(dtype inStart, dtype inStop, uint32 inNum=50, bool endPoint=true)
Definition: linspace.hpp:61
+
nc::int32
std::int32_t int32
Definition: Types.hpp:36
+
nc::sqrt
auto sqrt(dtype inValue) noexcept
Definition: sqrt.hpp:48
+ +
+
+ + + + diff --git a/docs/doxygen/html/laguerre_8hpp.html b/docs/doxygen/html/laguerre_8hpp.html index 955a5333f..904856465 100644 --- a/docs/doxygen/html/laguerre_8hpp.html +++ b/docs/doxygen/html/laguerre_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: laguerre.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
logb.hpp File Reference
+
+
+
#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Core/Internal/StlAlgorithms.hpp"
+#include "NumCpp/NdArray.hpp"
+#include <cmath>
+#include <complex>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + + + + +

+Functions

template<typename dtype >
auto nc::logb (const NdArray< dtype > &inArray, dtype inBase)
 
template<typename dtype >
auto nc::logb (dtype inValue, dtype inBase) noexcept
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/logb_8hpp.js b/docs/doxygen/html/logb_8hpp.js new file mode 100644 index 000000000..a530923e6 --- /dev/null +++ b/docs/doxygen/html/logb_8hpp.js @@ -0,0 +1,5 @@ +var logb_8hpp = +[ + [ "logb", "logb_8hpp.html#a512c632dd9629cbc02ad96398f82ab2a", null ], + [ "logb", "logb_8hpp.html#a4925bc774ee8c671be4e15ba4305d230", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/logb_8hpp_source.html b/docs/doxygen/html/logb_8hpp_source.html new file mode 100644 index 000000000..96d0d623b --- /dev/null +++ b/docs/doxygen/html/logb_8hpp_source.html @@ -0,0 +1,151 @@ + + + + + + + +NumCpp: logb.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
logb.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
31 #include "NumCpp/Core/Internal/StlAlgorithms.hpp"
+
32 #include "NumCpp/NdArray.hpp"
+
33 
+
34 #include <cmath>
+
35 #include <complex>
+
36 
+
37 namespace nc
+
38 {
+
39  //============================================================================
+
40  // Method Description:
+
48  template<typename dtype>
+
49  auto logb(dtype inValue, dtype inBase) noexcept
+
50  {
+
51  STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype);
+
52 
+
53  return std::log(inValue) / std::log(inBase);
+
54  }
+
55 
+
56  //============================================================================
+
57  // Method Description:
+
65  template<typename dtype>
+
66  auto logb(const NdArray<dtype>& inArray, dtype inBase)
+
67  {
+
68  NdArray<decltype(logb(dtype{0}, dtype{0}))> returnArray(inArray.shape());
+
69  stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(),
+
70  [inBase](dtype inValue) noexcept -> auto
+
71  {
+
72  return logb(inValue, inBase);
+
73  });
+
74 
+
75  return returnArray;
+
76  }
+
77 } // namespace nc
+ + +
STATIC_ASSERT_ARITHMETIC_OR_COMPLEX
#define STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype)
Definition: StaticAsserts.hpp:50
+ +
nc::NdArray
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
+
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1216
+
nc::NdArray::shape
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4283
+
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1524
+
nc::NdArray::begin
iterator begin() noexcept
Definition: NdArrayCore.hpp:1166
+
nc::stl_algorithms::transform
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
+
nc
Definition: Coordinate.hpp:45
+
nc::log
auto log(dtype inValue) noexcept
Definition: log.hpp:50
+
nc::logb
auto logb(dtype inValue, dtype inBase) noexcept
Definition: logb.hpp:49
+
+
+ + + + diff --git a/docs/doxygen/html/logical__and_8hpp.html b/docs/doxygen/html/logical__and_8hpp.html index caafe981e..e7449dff7 100644 --- a/docs/doxygen/html/logical__and_8hpp.html +++ b/docs/doxygen/html/logical__and_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: logical_and.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
logspace.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Core/Internal/StlAlgorithms.hpp"
+#include "NumCpp/Functions/linspace.hpp"
+#include "NumCpp/Utils/powerf.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
NdArray< double > nc::logspace (dtype start, dtype stop, uint32 num=50, bool endPoint=true, double base=10.0)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/logspace_8hpp.js b/docs/doxygen/html/logspace_8hpp.js new file mode 100644 index 000000000..df2d0d1b0 --- /dev/null +++ b/docs/doxygen/html/logspace_8hpp.js @@ -0,0 +1,4 @@ +var logspace_8hpp = +[ + [ "logspace", "logspace_8hpp.html#a4342eee2bea5ed3c8ece78b9119efc31", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/logspace_8hpp_source.html b/docs/doxygen/html/logspace_8hpp_source.html new file mode 100644 index 000000000..713922dda --- /dev/null +++ b/docs/doxygen/html/logspace_8hpp_source.html @@ -0,0 +1,141 @@ + + + + + + + +NumCpp: logspace.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
logspace.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Core/Internal/StlAlgorithms.hpp"
+
33 #include "NumCpp/Functions/linspace.hpp"
+
34 #include "NumCpp/Utils/powerf.hpp"
+
35 
+
36 namespace nc
+
37 {
+
38  //============================================================================
+
39  // Method Description:
+
56  template<typename dtype>
+
57  NdArray<double> logspace(dtype start, dtype stop, uint32 num = 50, bool endPoint = true, double base = 10.0)
+
58  {
+
59  STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype);
+
60 
+
61  auto spacedValues = linspace(static_cast<double>(start), static_cast<double>(stop), num, endPoint);
+
62  stl_algorithms::for_each(spacedValues.begin(), spacedValues.end(),
+
63  [base](auto& value) -> void
+
64  {
+
65  value = utils::powerf(base, value);
+
66  });
+
67 
+
68  return spacedValues;
+
69  }
+
70 } // namespace nc
+ + +
STATIC_ASSERT_ARITHMETIC_OR_COMPLEX
#define STATIC_ASSERT_ARITHMETIC_OR_COMPLEX(dtype)
Definition: StaticAsserts.hpp:50
+ + + + +
nc::stl_algorithms::for_each
void for_each(InputIt first, InputIt last, UnaryFunction f)
Definition: StlAlgorithms.hpp:213
+
nc
Definition: Coordinate.hpp:45
+
nc::logspace
NdArray< double > logspace(dtype start, dtype stop, uint32 num=50, bool endPoint=true, double base=10.0)
Definition: logspace.hpp:57
+
nc::linspace
NdArray< dtype > linspace(dtype inStart, dtype inStop, uint32 inNum=50, bool endPoint=true)
Definition: linspace.hpp:61
+
nc::uint32
std::uint32_t uint32
Definition: Types.hpp:40
+
+
+ + + + diff --git a/docs/doxygen/html/lstsq_8hpp.html b/docs/doxygen/html/lstsq_8hpp.html index 2b899eb2b..5d19d0e35 100644 --- a/docs/doxygen/html/lstsq_8hpp.html +++ b/docs/doxygen/html/lstsq_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: lstsq.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Building
+
+
+

A NumCpp "Hello World" example

+

This example assumes you have followed the steps for installing NumCpp on your system. You will also need to have CMake installed.

+

1. Source File

+

main.cpp

+
#include "NumCpp.hpp"
+
+
#include <cstdlib>
+
#include <iostream>
+
+
int main()
+
{
+
auto a = nc::random::randInt<int>({10, 10}, 0, 100);
+
std::cout << a;
+
+
return EXIT_SUCCESS;
+
}
+ +

2. CMakeLists.txt file

+
cmake_minimum_required(VERSION 3.14)
+
+
project("HelloWorld" CXX)
+
+
add_executable(${PROJECT_NAME} main.cpp)
+
+
find_package(NumCpp 2.6.2 REQUIRED)
+
target_link_libraries(${PROJECT_NAME}
+
NumCpp::NumCpp
+
)
+

3. Build

+

SRC_DIRECTORY = directory containing main.cpp and CMakeLists.txt files

+
>> cd <SRC_DIRECTORY>
+
>> mkdir build
+
>> cd build
+
>> cmake ..
+
>> cmake --build . --config Release
+

4. Run

+

Linux

+
>> ./HelloWorld
+

Windows

+
>> HelloWorld.exe
+

Alternative

+

NumCpp is a header only library so you can of course simply add the NumCpp include directory to your build system's include directories and build that way. However, find_package(NumCpp) takes care of finding and linking in the Boost headers automatically, so if you add the NumCpp headers manually you will need to manually include the Boost headers as well.

+
+
+
+ + + + diff --git a/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__compiler_flags.html b/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__compiler_flags.html new file mode 100644 index 000000000..700c3cf0a --- /dev/null +++ b/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__compiler_flags.html @@ -0,0 +1,108 @@ + + + + + + + +NumCpp: Compiler Flags + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Compiler Flags
+
+
+
    +
  • NUMCPP_NO_USE_BOOST: disables all NumCpp features that require the Boost libraries as a dependency. When this compiler flag is defined NumCpp will have no external dependancies and is completely standalone
    • +
  • NUMCPP_USE_MULTITHREAD: enables STL parallel execution policies throughout the library. Using multi-threaded algorithms can have negative performace impact for "small" array operations and should usually only be used when dealing with large array operations. Benchmarking should be performed with your system and build tools to determine which works best for your setup and application
    • +
  • NUMCPP_INCLUDE_PYBIND_PYTHON_INTERFACE: includes the PyBind11 Python interface helper functions
    • +
  • NUMCPP_INCLUDE_BOOST_PYTHON_INTERFACE: includes the Boost Python interface helper functions
    • +
+
+
+
+ + + + diff --git a/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__installation.html b/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__installation.html new file mode 100644 index 000000000..9c9006386 --- /dev/null +++ b/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__installation.html @@ -0,0 +1,116 @@ + + + + + + + +NumCpp: Installation + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Installation
+
+
+

1. Clone the NumCpp repository from GitHub

+

NUMCPP_REPO_PATH = path to clone repository

+
>> cd <NUMCPP_REPO_PATH>
+
>> git clone https://github.com/dpilger26/NumCpp.git
+

2. Build the install products using CMake

+
>> cd NumCpp
+
>> mkdir build
+
>> cd build
+
>> cmake ..
+

3. Install the includes and CMake target files

+

On Linux run the following command with sudo. On Windows, you may need to open a cmd prompt or PowerShell with admin privileges.

+
>> cmake --build . --target install
+

Alternative

+

NumCpp is a header only library so you can of course simply add the NumCpp include directory (wherever it resides) to your build system's include directories and build that way.

+
+
+
+ + + + diff --git a/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__release_notes.html b/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__release_notes.html new file mode 100644 index 000000000..b2dfd53cb --- /dev/null +++ b/docs/doxygen/html/md__c___github__num_cpp_docs_markdown__release_notes.html @@ -0,0 +1,262 @@ + + + + + + + +NumCpp: Release Notes + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Release Notes
+
+
+

Version 2.7.0

+ +

Version 2.6.2

+
    +
  • tofile and fromfile will now work for generic struct dtypes
    • +
+

Version 2.6.1

+
    +
  • Added more delimiter support to fromfile method
    • +
+

Version 2.6.0

+
    +
  • Added linalg::solve
    • +
+

Version 2.5.1

+
    +
  • Made behavior of interp function consistent with NumPy when passing in non-sorted data
    • +
+

Version 2.5.0

+
    +
  • Added additional NdArray slice overloads
    • +
  • Removed NO_MULTITHREAD compiler flag and replaced with NUMCPP_USE_MULTITHREAD so that single threaded is now the default
    • +
  • renamed NO_USE_BOOST compiler flag to NUMCPP_NO_USE_BOOST
    • +
  • renamed INCLUDE_BOOST_PYTHON_INTERFACE compiler flat to NUMCPP_INCLUDE_BOOST_PYTHON_INTERFACE
    • +
  • renamed INCLUDE_PYBIND_PYTHON_INTERFACE compiler flag to NUMCPP_INCLUDE_PYBIND_PYTHON_INTERFACE
    • +
+

Version 2.4.2

+
    +
  • Fixed a type error with percentile and nanpercentile
    • +
  • Updated doxygen API css
    • +
+

Version 2.4.1

+
    +
  • Fixed a build error for multiply defined symbols of isLittleEndian
    • +
+

Version 2.4.0

+
    +
  • Compile with NO_USE_BOOST definition to remove the Boost libraries as a dependency, with reduced functionality:
      +
    • gcd with a pair of values (still available using a C++17 compliant compiler)
      • +
    • gcd array
      • +
    • lcm with a pair of values (still available using a C++17 compliant compiler)
      • +
    • lcm array
      • +
    • polynomial::chebyshev_t
      • +
    • polynomial::chebyshev_u
      • +
    • polynomial::hermite (still available using a C++17 compliant compiler)
      • +
    • polynomial::laguerre (still available using a C++17 compliant compiler)
      • +
    • polynomial::legendre_p (still available using a C++17 compliant compiler)
      • +
    • polynomial::legendre_q
      • +
    • polynomial::spherical_harmonic
      • +
    • random::beta
      • +
    • random::laplace
      • +
    • random::nonCentralChiSquared
      • +
    • random::triangle
      • +
    • random::uniformOnSphere
      • +
    • special::airy_ai
      • +
    • special::airy_ai_prime
      • +
    • special::airy_bi
      • +
    • special::airy_bi_prime
      • +
    • special::bernoulli
      • +
    • special::bessel_in (still available using a C++17 compliant compiler)
      • +
    • special::bessel_in_prime
      • +
    • special::bessel_jn (still available using a C++17 compliant compiler)
      • +
    • special::bessel_jn_prime
      • +
    • special::bessel_kn (still available using a C++17 compliant compiler)
      • +
    • special::bessel_kn_prime
      • +
    • special::bessel_yn (still available using a C++17 compliant compiler)
      • +
    • special::bessel_yn_prime
      • +
    • special::beta (still available using a C++17 compliant compiler)
      • +
    • special::cyclic_hankel_1
      • +
    • special::cyclic_hankel_2
      • +
    • special::digamma
      • +
    • special::erf
      • +
    • special::erf_inv
      • +
    • special::erfc
      • +
    • special::erfc_inv
      • +
    • special::gamma
      • +
    • special::gamma1pm1
      • +
    • special::log_gamma
      • +
    • special::polygamma
      • +
    • special::prime
      • +
    • special::riemann_zeta (still available using a C++17 compliant compiler)
      • +
    • special::spherical_bessel_jn (still available using a C++17 compliant compiler)
      • +
    • special::spherical_bessel_yn (still available using a C++17 compliant compiler)
      • +
    • special::spherical_hankel_1
      • +
    • special::spherical_hankel_2
      • +
    • special::trigamma
      • +
    +
    • +
  • Added replace option into random::choice
    • +
  • Added nan_to_num function
    • +
  • Added complete and incomplete elliptical integrals of the first, second, and third kind to special namespace (requires either Boost or C++17 compliant compiler)
    • +
  • Added exponential integral to special namespace (requires either Boost or C++17 compliant compiler)
    • +
  • Added NO_MULTITHREAD compile definition to turn off algorithm multithreading from compliant compilers
    • +
+

Version 2.3.1

+
    +
  • Added option for user defined bin edges in histogram() function
    • +
+

Version 2.3.0

+
    +
  • Added slicing to DataCube class
    +
    • +
+

Version 2.2.0

+
    +
  • Added additional where() overloads to match NumPy functionality
    +
    • +
+

Version 2.1.0

+
    +
  • Improved installation and usage with CMake find_package support
    • +
  • Various minor improvements
    • +
+

Version 2.0.0

+
    +
  • Dropped support of C++11, now requires a C++14 or higher compiler
    • +
  • Added support for std::complex<T>, closing Issue #58
    • +
  • Added more NdArray constructors for STL containers including std::vector<std::vector<T>>, closing Issue #59
    • +
  • Added polyfit routine inline with Numpy polyfit, closing Issue #61
    • +
  • Added ability to use NdArray as container for generic structs
    • +
  • Non-linear least squares fitting using Gauss-Newton
    • +
  • Root finding routines
    • +
  • Numerical integration routines
    • +
  • lu_decomposition and pivotLU_decomposition added to Linalg namespace
    • +
  • New STL iterators added to NdArray
      +
    • iterator
      • +
    • const_iterator
      • +
    • reverse_iterator
      • +
    • const_reverse_iterator
      • +
    • column_iterator
      • +
    • const_column_iterator
      • +
    • reverse_column_iterator
      • +
    • const_reverse_column_iterator
      • +
    +
    • +
  • Added rodriguesRotation and wahbasProblem to Rotations namespace
    • +
  • Various efficiency and/or bug fixes
    • +
+
+
+
+ + + + diff --git a/docs/doxygen/html/mean_8hpp.html b/docs/doxygen/html/mean_8hpp.html index 11e7b8964..f76e03afb 100644 --- a/docs/doxygen/html/mean_8hpp.html +++ b/docs/doxygen/html/mean_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: mean.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+  + +

- k -

    +
  • kaiser() +: nc +
    • +
+
+
+ + + + diff --git a/docs/doxygen/html/namespacemembers_func_l.html b/docs/doxygen/html/namespacemembers_func_l.html index a8bf264b7..7d96c6c3c 100644 --- a/docs/doxygen/html/namespacemembers_func_l.html +++ b/docs/doxygen/html/namespacemembers_func_l.html @@ -3,7 +3,7 @@ - + NumCpp: Namespace Members @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all namespace members with links to the namespace documentation for each member:
+ +

- k -

    +
  • kaiser() +: nc +
    • +
+
+
+ + + + diff --git a/docs/doxygen/html/namespacemembers_l.html b/docs/doxygen/html/namespacemembers_l.html index c471a9582..2d1ac7cd7 100644 --- a/docs/doxygen/html/namespacemembers_l.html +++ b/docs/doxygen/html/namespacemembers_l.html @@ -3,7 +3,7 @@ - + NumCpp: Namespace Members @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
nc::edac Namespace Reference
+
+
+ + + + +

+Namespaces

 detail
 
+ + + + + + + +

+Functions

template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
int decode (std::bitset< EncodedBits > encodedBits, std::bitset< DataBits > &decodedBits)
 
template<std::size_t DataBits>
boost::dynamic_bitset encode (const std::bitset< DataBits > &dataBits)
 
+

Function Documentation

+ +

◆ decode()

+ +
+
+
+template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
+ + + + + + + + + + + + + + + + + + +
int nc::edac::decode (std::bitset< EncodedBits > encodedBits,
std::bitset< DataBits > & decodedBits 
)
+
+

Returns the Hamming SECDED decoded bits for the enocoded bits https://en.wikipedia.org/wiki/Hamming_code

+
Parameters
+ + + +
encodedBitsthe encoded bits to decode
decodedBitsthe output decoded bits
+
+
+
Returns
int status (0=no errors, 1=1 corrected error, 2=2 errors detected)
+
Exceptions
+ + + +
std::runtime_errorif DataBits and EncodedBits are not consistent
std::runtime_errorif the number of data bits does not represent a valid Hamming SECDED code
+
+
+ +
+
+ +

◆ encode()

+ +
+
+
+template<std::size_t DataBits>
+ + + + + + + + +
boost::dynamic_bitset nc::edac::encode (const std::bitset< DataBits > & dataBits)
+
+

Returns the Hamming SECDED encoded bits for the data bits

+
Parameters
+ + +
dataBitsthe data bits to encode
+
+
+
Returns
encoded data bits
+
Exceptions
+ + +
std::runtime_errorif the number of data bits does not represent a valid Hamming SECDED code
+
+
+ +
+
+
+
+ + + + diff --git a/docs/doxygen/html/namespacenc_1_1edac.js b/docs/doxygen/html/namespacenc_1_1edac.js new file mode 100644 index 000000000..4e22ab24b --- /dev/null +++ b/docs/doxygen/html/namespacenc_1_1edac.js @@ -0,0 +1,17 @@ +var namespacenc_1_1edac = +[ + [ "detail", "namespacenc_1_1edac_1_1detail.html", [ + [ "calculateParity", "namespacenc_1_1edac_1_1detail.html#abde37c852253de171988da5e4b775273", null ], + [ "calculateParity", "namespacenc_1_1edac_1_1detail.html#ad3215e8486eb3a544a483e5234c856d7", null ], + [ "calculateParity", "namespacenc_1_1edac_1_1detail.html#aea349d7b4d28ca91b85bcb3a2823c145", null ], + [ "checkBitsConsistent", "namespacenc_1_1edac_1_1detail.html#af386b23445a4942453c69cff80ee0e20", null ], + [ "dataBitsCovered", "namespacenc_1_1edac_1_1detail.html#aa8a14d5fd872ed0292631e57f5afe618", null ], + [ "extractData", "namespacenc_1_1edac_1_1detail.html#a1c606c3f9302bb406021a50006898ebf", null ], + [ "isPowerOfTwo", "namespacenc_1_1edac_1_1detail.html#a7f066ec8b196c2943ae99382eb63e2fb", null ], + [ "nextPowerOfTwo", "namespacenc_1_1edac_1_1detail.html#a279241a794bffbea6920299cf8e5c4a1", null ], + [ "numSecdedParityBitsNeeded", "namespacenc_1_1edac_1_1detail.html#a6ee59971c08bfdc3e11a0245f17d5f9a", null ], + [ "powersOfTwo", "namespacenc_1_1edac_1_1detail.html#ad4328ffa9ba9949a9c4b494592496055", null ] + ] ], + [ "decode", "namespacenc_1_1edac.html#aa24d4f99fd0739df7480845e96668e0f", null ], + [ "encode", "namespacenc_1_1edac.html#af5c36a1f2c74d632192cf9fe29cc5f03", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/namespacenc_1_1edac_1_1detail.html b/docs/doxygen/html/namespacenc_1_1edac_1_1detail.html new file mode 100644 index 000000000..c68c8f15e --- /dev/null +++ b/docs/doxygen/html/namespacenc_1_1edac_1_1detail.html @@ -0,0 +1,519 @@ + + + + + + + +NumCpp: nc::edac::detail Namespace Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Functions
+
+
nc::edac::detail Namespace Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

bool calculateParity (const boost::dynamic_bitset<> &data) noexcept
 
template<std::size_t DataBits>
constexpr bool calculateParity (const std::bitset< DataBits > &data) noexcept
 
template<std::size_t DataBits, typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
bool calculateParity (const std::bitset< DataBits > &data, IntType parityBit)
 
template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
std::size_t checkBitsConsistent ()
 
template<typename IntType1 , typename IntType2 , std::enable_if_t< std::is_integral_v< IntType1 >, int > = 0, std::enable_if_t< std::is_integral_v< IntType2 >, int > = 0>
std::vector< std::size_t > dataBitsCovered (IntType1 numDataBits, IntType2 parityBit)
 
template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
std::bitset< DataBits > extractData (const std::bitset< EncodedBits > &encodedBits) noexcept
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
constexpr bool isPowerOfTwo (IntType n) noexcept
 Tests if value is a power of two. More...
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
std::size_t nextPowerOfTwo (IntType n)
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
std::size_t numSecdedParityBitsNeeded (IntType numDataBits)
 
template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
std::vector< std::size_t > powersOfTwo (IntType n)
 
+

Function Documentation

+ +

◆ calculateParity() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
bool nc::edac::detail::calculateParity (const boost::dynamic_bitset<> & data)
+ 		+inlinenoexcept
+
+

Calculates the overall parity of the data, assumes last bit is the parity bit itself

+
Parameters
+ + +
datathe data word
+
+
+
Returns
overall parity bit value
+ +
+
+ +

◆ calculateParity() [2/3]

+ +
+
+
+template<std::size_t DataBits>
+ + + + + +
+ + + + + + + + +
constexpr bool nc::edac::detail::calculateParity (const std::bitset< DataBits > & data)
+ 		+constexprnoexcept
+
+

Calculates the overall parity of the data, assumes last bit is the parity bit itself

+
Parameters
+ + +
datathe data word
+
+
+
Returns
overall parity bit value
+ +
+
+ +

◆ calculateParity() [3/3]

+ +
+
+
+template<std::size_t DataBits, typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
+ + + + + + + + + + + + + + + + + + +
bool nc::edac::detail::calculateParity (const std::bitset< DataBits > & data,
IntType parityBit 
)
+
+

Calculates the specified Hamming parity bit (1, 2, 4, 8, etc.) for the given data. Assumes even parity to allow for easier computation of parity using XOR.

+
Parameters
+ + + +
datathe data word
parityBitthe parity bit number
+
+
+
Returns
parity bit value
+
Exceptions
+ + + +
std::invalid_argumentif parityBit is not a power of two
std::bad_allocif unable to allocate return vector
+
+
+ +
+
+ +

◆ checkBitsConsistent()

+ +
+
+
+template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
+ + + + + + + +
std::size_t nc::edac::detail::checkBitsConsistent ()
+
+

Checks that the number of DataBits and EncodedBits are consistent

+
Returns
the number of parity bits
+
Exceptions
+ + + +
std::runtime_errorif DataBits and EncodedBits are not consistent
std::runtime_errorif the number of data bits does not represent a valid Hamming SECDED code
+
+
+ +
+
+ +

◆ dataBitsCovered()

+ +
+
+
+template<typename IntType1 , typename IntType2 , std::enable_if_t< std::is_integral_v< IntType1 >, int > = 0, std::enable_if_t< std::is_integral_v< IntType2 >, int > = 0>
+ + + + + + + + + + + + + + + + + + +
std::vector<std::size_t> nc::edac::detail::dataBitsCovered (IntType1 numDataBits,
IntType2 parityBit 
)
+
+

Returns the indices of all data bits covered by a specified parity bit in a bitstring of length numDataBits. The indices are relative to DATA BITSTRING ITSELF, NOT including parity bits.

+
Parameters
+ + + +
numDataBitsthe number of data bits to encode
parityBitthe parity bit number
+
+
+
Returns
number of Hamming SECDED parity bits
+
Exceptions
+ + + +
std::invalid_argumentif parityBit is not a power of two
std::bad_allocif unable to allocate return vector
+
+
+ +
+
+ +

◆ extractData()

+ +
+
+
+template<std::size_t DataBits, std::size_t EncodedBits, std::enable_if_t< greaterThan_v< EncodedBits, DataBits >, int > = 0>
+ + + + + +
+ + + + + + + + +
std::bitset<DataBits> nc::edac::detail::extractData (const std::bitset< EncodedBits > & encodedBits)
+ 		+noexcept
+
+

Returns the Hamming SECDED decoded bits from the endoded bits. Assumes that the DataBits and EncodedBits have been checks for consistancy already

+
Parameters
+ + +
encodedBitsthe Hamming SECDED encoded word
+
+
+
Returns
data bits from the encoded word
+ +
+
+ +

◆ isPowerOfTwo()

+ +
+
+
+template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
+ + + + + +
+ + + + + + + + +
constexpr bool nc::edac::detail::isPowerOfTwo (IntType n)
+ 		+constexprnoexcept
+
+ +

Tests if value is a power of two.

+
Parameters
+ + +
ninteger value
+
+
+
Returns
bool true if value is a power of two, else false
+ +
+
+ +

◆ nextPowerOfTwo()

+ +
+
+
+template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
+ + + + + + + + +
std::size_t nc::edac::detail::nextPowerOfTwo (IntType n)
+
+

Calculates the next power of two after n

+
+
+

_next_power_of_two(768)

+
+
+
+

1024

+
+
+

_next_power_of_two(4)

+
+
+
+

8

+
Parameters
+ + +
ninteger value
+
+
+
Returns
next power of two
+
Exceptions
+ + +
std::invalid_argumentif input value is less than zero
+
+
+ +
+
+ +

◆ numSecdedParityBitsNeeded()

+ +
+
+
+template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
+ + + + + + + + +
std::size_t nc::edac::detail::numSecdedParityBitsNeeded (IntType numDataBits)
+
+

Calculates the number of needed Hamming SECDED parity bits to encode the data

+
Parameters
+ + +
numDataBitsthe number of data bits to encode
+
+
+
Returns
number of Hamming SECDED parity bits
+
Exceptions
+ + + +
std::invalid_argumentif input value is less than zero
std::runtime_errorif the number of data bits does not represent a valid Hamming SECDED code
+
+
+ +
+
+ +

◆ powersOfTwo()

+ +
+
+
+template<typename IntType , std::enable_if_t< std::is_integral_v< IntType >, int > = 0>
+ + + + + + + + +
std::vector<std::size_t> nc::edac::detail::powersOfTwo (IntType n)
+
+

Calculates the first n powers of two

+
Parameters
+ + +
ninteger value
+
+
+
Returns
first n powers of two
+
Exceptions
+ + +
std::bad_allocif unable to allocate for return vector
+
+
+ +
+
+
+
+ + + + diff --git a/docs/doxygen/html/namespacenc_1_1endian.html b/docs/doxygen/html/namespacenc_1_1endian.html index e059b80d7..c31016cbb 100644 --- a/docs/doxygen/html/namespacenc_1_1endian.html +++ b/docs/doxygen/html/namespacenc_1_1endian.html @@ -3,7 +3,7 @@ - + NumCpp: nc::endian Namespace Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
nth_root.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/StaticAsserts.hpp"
+#include "NumCpp/Core/Internal/StlAlgorithms.hpp"
+#include "NumCpp/Utils/powerf.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + + + + +

+Functions

template<typename dtype1 , typename dtype2 >
NdArray< double > nc::nth_root (const NdArray< dtype1 > &inArray, dtype2 inRoot)
 
template<typename dtype1 , typename dtype2 >
double nc::nth_root (dtype1 inValue, dtype2 inRoot) noexcept
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/nth__root_8hpp.js b/docs/doxygen/html/nth__root_8hpp.js new file mode 100644 index 000000000..c41473294 --- /dev/null +++ b/docs/doxygen/html/nth__root_8hpp.js @@ -0,0 +1,5 @@ +var nth__root_8hpp = +[ + [ "nth_root", "nth__root_8hpp.html#a6da3daf9d73c1cea2e69c77f62b267b0", null ], + [ "nth_root", "nth__root_8hpp.html#aae5eb97b7313026b451ac4d7c01db027", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/nth__root_8hpp_source.html b/docs/doxygen/html/nth__root_8hpp_source.html new file mode 100644 index 000000000..e3804d6c0 --- /dev/null +++ b/docs/doxygen/html/nth__root_8hpp_source.html @@ -0,0 +1,151 @@ + + + + + + + +NumCpp: nth_root.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
nth_root.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/StaticAsserts.hpp"
+
32 #include "NumCpp/Core/Internal/StlAlgorithms.hpp"
+
33 #include "NumCpp/Utils/powerf.hpp"
+
34 
+
35 namespace nc
+
36 {
+
37  //============================================================================
+
38  // Method Description:
+
45  template<typename dtype1, typename dtype2>
+
46  double nth_root(dtype1 inValue, dtype2 inRoot) noexcept
+
47  {
+
48  STATIC_ASSERT_ARITHMETIC(dtype1);
+
49  STATIC_ASSERT_ARITHMETIC(dtype2);
+
50 
+
51  return utils::powerf(static_cast<double>(inValue), 1.0 / static_cast<double>(inRoot));
+
52  }
+
53 
+
54  //============================================================================
+
55  // Method Description:
+
62  template<typename dtype1, typename dtype2>
+
63  NdArray<double> nth_root(const NdArray<dtype1>& inArray, dtype2 inRoot)
+
64  {
+
65  NdArray<double> returnArray(inArray.shape());
+
66  stl_algorithms::transform(inArray.cbegin(), inArray.cend(), returnArray.begin(),
+
67  [inRoot](dtype1 inValue) noexcept -> double
+
68  {
+
69  return nth_root(inValue, inRoot);
+
70  });
+
71 
+
72  return returnArray;
+
73  }
+
74 } // namespace nc
+ + +
STATIC_ASSERT_ARITHMETIC
#define STATIC_ASSERT_ARITHMETIC(dtype)
Definition: StaticAsserts.hpp:37
+ + + +
nc::NdArray::cbegin
const_iterator cbegin() const noexcept
Definition: NdArrayCore.hpp:1216
+
nc::NdArray::shape
Shape shape() const noexcept
Definition: NdArrayCore.hpp:4283
+
nc::NdArray::cend
const_iterator cend() const noexcept
Definition: NdArrayCore.hpp:1524
+
nc::NdArray::begin
iterator begin() noexcept
Definition: NdArrayCore.hpp:1166
+
nc::stl_algorithms::transform
OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)
Definition: StlAlgorithms.hpp:702
+
nc::utils::powerf
auto powerf(dtype1 inValue, const dtype2 inPower) noexcept
Definition: Utils/powerf.hpp:49
+
nc
Definition: Coordinate.hpp:45
+
nc::nth_root
double nth_root(dtype1 inValue, dtype2 inRoot) noexcept
Definition: nth_root.hpp:46
+
+
+ + + + diff --git a/docs/doxygen/html/num2str_8hpp.html b/docs/doxygen/html/num2str_8hpp.html index 0dc2d6df2..37f991c1d 100644 --- a/docs/doxygen/html/num2str_8hpp.html +++ b/docs/doxygen/html/num2str_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: num2str.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
place.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Internal/Error.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + +

+Functions

template<typename dtype >
void nc::place (NdArray< dtype > &arr, const NdArray< bool > &mask, const NdArray< dtype > &vals)
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/place_8hpp.js b/docs/doxygen/html/place_8hpp.js new file mode 100644 index 000000000..955d20189 --- /dev/null +++ b/docs/doxygen/html/place_8hpp.js @@ -0,0 +1,4 @@ +var place_8hpp = +[ + [ "place", "place_8hpp.html#a171da00c79cfbc9500916b6ac4d3de70", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/place_8hpp_source.html b/docs/doxygen/html/place_8hpp_source.html new file mode 100644 index 000000000..f08ca5d55 --- /dev/null +++ b/docs/doxygen/html/place_8hpp_source.html @@ -0,0 +1,142 @@ + + + + + + + +NumCpp: place.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
place.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Internal/Error.hpp"
+
32 
+
33 namespace nc
+
34 {
+
35  //============================================================================
+
36  // Method Description:
+
47  template<typename dtype>
+
48  void place(NdArray<dtype>& arr, const NdArray<bool>& mask, const NdArray<dtype>& vals)
+
49  {
+
50  if (mask.size() != arr.size())
+
51  {
+
52  THROW_INVALID_ARGUMENT_ERROR("Input arguments 'arr' and 'mask' must have the same size.");
+
53  }
+
54 
+
55  if (vals.isempty())
+
56  {
+
57  return;
+
58  }
+
59 
+
60  auto valIdx = 0;
+
61  for (decltype(arr.size()) i = 0; i < arr.size(); ++i)
+
62  {
+
63  if (mask[i])
+
64  {
+
65  arr[i] = vals[valIdx++ % vals.size()];
+
66  }
+
67  }
+
68  }
+
69 } // namespace nc
+ +
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
+ +
nc::NdArray
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
+
nc::NdArray::size
size_type size() const noexcept
Definition: NdArrayCore.hpp:4296
+
nc::NdArray::isempty
bool isempty() const noexcept
Definition: NdArrayCore.hpp:2843
+
nc
Definition: Coordinate.hpp:45
+
nc::place
void place(NdArray< dtype > &arr, const NdArray< bool > &mask, const NdArray< dtype > &vals)
Definition: place.hpp:48
+
+
+ + + + diff --git a/docs/doxygen/html/pnr_8hpp.html b/docs/doxygen/html/pnr_8hpp.html index dc3474657..92ae6e36b 100644 --- a/docs/doxygen/html/pnr_8hpp.html +++ b/docs/doxygen/html/pnr_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: pnr.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + diff --git a/docs/doxygen/html/search/all_0.js b/docs/doxygen/html/search/all_0.js index 4b0e4bafd..d24089653 100644 --- a/docs/doxygen/html/search/all_0.js +++ b/docs/doxygen/html/search/all_0.js @@ -1,15 +1,15 @@ var searchData= [ - ['abs_0',['abs',['../namespacenc.html#a6c2c40c4efcd5018f84f9aca0c03c29d',1,'nc::abs(dtype inValue) noexcept'],['../namespacenc.html#ad701f25dc97cf57005869ccb83357689',1,'nc::abs(const NdArray< dtype > &inArray)']]], + ['abs_0',['abs',['../namespacenc.html#ad701f25dc97cf57005869ccb83357689',1,'nc::abs(const NdArray< dtype > &inArray)'],['../namespacenc.html#a6c2c40c4efcd5018f84f9aca0c03c29d',1,'nc::abs(dtype inValue) noexcept']]], ['abs_2ehpp_1',['abs.hpp',['../abs_8hpp.html',1,'']]], - ['add_2',['add',['../namespacenc.html#a3f02320424da5d350eba50dc83cbb4cf',1,'nc::add(dtype value, const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#af5a087b8c1a96061e09f940143eda94a',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#abf179f45ed80c33c4093bab65e87f9d5',1,'nc::add(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a37845dd28b36310f6dba5aa6ebba9cff',1,'nc::add(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a9e0ebe00c9b81a6acdd1bfb328ca1e15',1,'nc::add(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a179128257dbcede363ccf942fb32e42f',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a8d76aea45bc47a83ec108b24f82b75ab',1,'nc::add(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a315d6d9acfc7fb154ebac4bea533857a',1,'nc::add(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#afe0e003d201511287b8954aa5b1b0d05',1,'nc::add(const std::complex< dtype > &value, const NdArray< dtype > &inArray)']]], + ['add_2',['add',['../namespacenc.html#a9e0ebe00c9b81a6acdd1bfb328ca1e15',1,'nc::add(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#abf179f45ed80c33c4093bab65e87f9d5',1,'nc::add(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#af5a087b8c1a96061e09f940143eda94a',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a8d76aea45bc47a83ec108b24f82b75ab',1,'nc::add(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a315d6d9acfc7fb154ebac4bea533857a',1,'nc::add(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#afe0e003d201511287b8954aa5b1b0d05',1,'nc::add(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a37845dd28b36310f6dba5aa6ebba9cff',1,'nc::add(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a3f02320424da5d350eba50dc83cbb4cf',1,'nc::add(dtype value, const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a179128257dbcede363ccf942fb32e42f',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)']]], ['add_2ehpp_3',['add.hpp',['../add_8hpp.html',1,'']]], ['addboundary1d_4',['addBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#a794f239834d31e60ad7c9d5a552e3f7c',1,'nc::filter::boundary']]], ['addboundary1d_2ehpp_5',['addBoundary1d.hpp',['../add_boundary1d_8hpp.html',1,'']]], ['addboundary2d_6',['addBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#a43e1dba909451a24518231243181d79d',1,'nc::filter::boundary']]], ['addboundary2d_2ehpp_7',['addBoundary2d.hpp',['../add_boundary2d_8hpp.html',1,'']]], ['addpixel_8',['addPixel',['../classnc_1_1image_processing_1_1_cluster.html#a9cab13be79b63d9151e60a798ca39cb5',1,'nc::imageProcessing::Cluster']]], - ['airy_5fai_9',['airy_ai',['../namespacenc_1_1special.html#a90c6b73247014e03767ad66cefccc4d6',1,'nc::special::airy_ai(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#ae5fa8cc4efa56e60d061600b3f6903b2',1,'nc::special::airy_ai(dtype inValue)']]], + ['airy_5fai_9',['airy_ai',['../namespacenc_1_1special.html#ae5fa8cc4efa56e60d061600b3f6903b2',1,'nc::special::airy_ai(dtype inValue)'],['../namespacenc_1_1special.html#a90c6b73247014e03767ad66cefccc4d6',1,'nc::special::airy_ai(const NdArray< dtype > &inArray)']]], ['airy_5fai_2ehpp_10',['airy_ai.hpp',['../airy__ai_8hpp.html',1,'']]], ['airy_5fai_5fprime_11',['airy_ai_prime',['../namespacenc_1_1special.html#abd997d345e8fdf5440c0c16548113d4c',1,'nc::special::airy_ai_prime(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a10516c44f9bd0fb906dd12122401187a',1,'nc::special::airy_ai_prime(dtype inValue)']]], ['airy_5fai_5fprime_2ehpp_12',['airy_ai_prime.hpp',['../airy__ai__prime_8hpp.html',1,'']]], @@ -37,9 +37,9 @@ var searchData= ['amax_2ehpp_34',['amax.hpp',['../amax_8hpp.html',1,'']]], ['amin_35',['amin',['../namespacenc.html#a4ea471f5a3dc23f638a8499151351435',1,'nc']]], ['amin_2ehpp_36',['amin.hpp',['../amin_8hpp.html',1,'']]], - ['angle_37',['angle',['../namespacenc.html#aa2ad52b9ebde8a5404642b190adb1bad',1,'nc::angle(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a600c02680b7f5963cc305a4b5450f6f6',1,'nc::angle(const std::complex< dtype > &inValue)'],['../classnc_1_1_vec3.html#a523ca42cbdd088851cc5a299da988cee',1,'nc::Vec3::angle()'],['../classnc_1_1_vec2.html#a271ca2cae96a1df44486fbcc2c0f890f',1,'nc::Vec2::angle()']]], + ['angle_37',['angle',['../classnc_1_1_vec2.html#a271ca2cae96a1df44486fbcc2c0f890f',1,'nc::Vec2::angle()'],['../classnc_1_1_vec3.html#a523ca42cbdd088851cc5a299da988cee',1,'nc::Vec3::angle()'],['../namespacenc.html#a600c02680b7f5963cc305a4b5450f6f6',1,'nc::angle(const std::complex< dtype > &inValue)'],['../namespacenc.html#aa2ad52b9ebde8a5404642b190adb1bad',1,'nc::angle(const NdArray< std::complex< dtype >> &inArray)']]], ['angle_2ehpp_38',['angle.hpp',['../angle_8hpp.html',1,'']]], - ['angularvelocity_39',['angularVelocity',['../classnc_1_1rotations_1_1_quaternion.html#a13ac87f70271d1771301011887d9d51a',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat2, double inTime) const'],['../classnc_1_1rotations_1_1_quaternion.html#a7cbe975bfed4cd7e5b4606047a9ee7f9',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat1, const Quaternion &inQuat2, double inTime)']]], + ['angularvelocity_39',['angularVelocity',['../classnc_1_1rotations_1_1_quaternion.html#a7cbe975bfed4cd7e5b4606047a9ee7f9',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat1, const Quaternion &inQuat2, double inTime)'],['../classnc_1_1rotations_1_1_quaternion.html#a13ac87f70271d1771301011887d9d51a',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat2, double inTime) const']]], ['any_40',['any',['../namespacenc.html#a2101c957472f0cefeda9d6b2b7bc6935',1,'nc::any()'],['../classnc_1_1_nd_array.html#a1463c8f1cb95cb8546d02502d86bd91e',1,'nc::NdArray::any()']]], ['any_2ehpp_41',['any.hpp',['../any_8hpp.html',1,'']]], ['any_5fof_42',['any_of',['../namespacenc_1_1stl__algorithms.html#a0ae9c71c7298f83822ab49d270c867ba',1,'nc::stl_algorithms']]], @@ -51,42 +51,42 @@ var searchData= ['applypoly1d_2ehpp_48',['applyPoly1d.hpp',['../apply_poly1d_8hpp.html',1,'']]], ['applythreshold_49',['applyThreshold',['../namespacenc_1_1image_processing.html#afabcede2d9e7e67cc80fc822b30d70e6',1,'nc::imageProcessing']]], ['applythreshold_2ehpp_50',['applyThreshold.hpp',['../apply_threshold_8hpp.html',1,'']]], - ['arange_51',['arange',['../namespacenc.html#a724165d620d8bff96f8f004c18257ad6',1,'nc::arange(const Slice &inSlice)'],['../namespacenc.html#a2edad3e052b232bd9075c78aad3c9287',1,'nc::arange(dtype inStop)'],['../namespacenc.html#a465e2385ac78ca4cc23928a4a0cd9f53',1,'nc::arange(dtype inStart, dtype inStop, dtype inStep=1)']]], + ['arange_51',['arange',['../namespacenc.html#a465e2385ac78ca4cc23928a4a0cd9f53',1,'nc::arange(dtype inStart, dtype inStop, dtype inStep=1)'],['../namespacenc.html#a2edad3e052b232bd9075c78aad3c9287',1,'nc::arange(dtype inStop)'],['../namespacenc.html#a724165d620d8bff96f8f004c18257ad6',1,'nc::arange(const Slice &inSlice)']]], ['arange_2ehpp_52',['arange.hpp',['../arange_8hpp.html',1,'']]], ['arccos_53',['arccos',['../namespacenc.html#aa57707902e14b3f16aec516e183d5830',1,'nc::arccos(const NdArray< dtype > &inArray)'],['../namespacenc.html#a0a87e0681917bdd812e139e6d6ea4bf1',1,'nc::arccos(dtype inValue) noexcept']]], ['arccos_2ehpp_54',['arccos.hpp',['../arccos_8hpp.html',1,'']]], - ['arccosh_55',['arccosh',['../namespacenc.html#a725eab730b946eca5d197933b9f955fa',1,'nc::arccosh(dtype inValue) noexcept'],['../namespacenc.html#a9063e7275b83f3201f74a0014a9b54d5',1,'nc::arccosh(const NdArray< dtype > &inArray)']]], + ['arccosh_55',['arccosh',['../namespacenc.html#a9063e7275b83f3201f74a0014a9b54d5',1,'nc::arccosh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a725eab730b946eca5d197933b9f955fa',1,'nc::arccosh(dtype inValue) noexcept']]], ['arccosh_2ehpp_56',['arccosh.hpp',['../arccosh_8hpp.html',1,'']]], ['arcsin_57',['arcsin',['../namespacenc.html#a4b1b8fc9752c90328e3cadce151d6370',1,'nc::arcsin(const NdArray< dtype > &inArray)'],['../namespacenc.html#a6d18d24b8a33ec7df0e845d6a430d5f2',1,'nc::arcsin(dtype inValue) noexcept']]], ['arcsin_2ehpp_58',['arcsin.hpp',['../arcsin_8hpp.html',1,'']]], - ['arcsinh_59',['arcsinh',['../namespacenc.html#a74ebb0003f6cf0d0dc0fd8af1e983969',1,'nc::arcsinh(dtype inValue) noexcept'],['../namespacenc.html#abbf91db9344e5d1a53325990ef5535a0',1,'nc::arcsinh(const NdArray< dtype > &inArray)']]], + ['arcsinh_59',['arcsinh',['../namespacenc.html#abbf91db9344e5d1a53325990ef5535a0',1,'nc::arcsinh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a74ebb0003f6cf0d0dc0fd8af1e983969',1,'nc::arcsinh(dtype inValue) noexcept']]], ['arcsinh_2ehpp_60',['arcsinh.hpp',['../arcsinh_8hpp.html',1,'']]], - ['arctan_61',['arctan',['../namespacenc.html#a0f63f816e660b0a4b3da191c8584a21a',1,'nc::arctan(dtype inValue) noexcept'],['../namespacenc.html#ac7080b26d0d4d849197ae10ce6d94a53',1,'nc::arctan(const NdArray< dtype > &inArray)']]], + ['arctan_61',['arctan',['../namespacenc.html#ac7080b26d0d4d849197ae10ce6d94a53',1,'nc::arctan(const NdArray< dtype > &inArray)'],['../namespacenc.html#a0f63f816e660b0a4b3da191c8584a21a',1,'nc::arctan(dtype inValue) noexcept']]], ['arctan_2ehpp_62',['arctan.hpp',['../arctan_8hpp.html',1,'']]], - ['arctan2_63',['arctan2',['../namespacenc.html#abdec674ddb32540775e97e0fca6016aa',1,'nc::arctan2(dtype inY, dtype inX) noexcept'],['../namespacenc.html#a3d3c4c6b273e6eee45cf6359cf621980',1,'nc::arctan2(const NdArray< dtype > &inY, const NdArray< dtype > &inX)']]], + ['arctan2_63',['arctan2',['../namespacenc.html#a3d3c4c6b273e6eee45cf6359cf621980',1,'nc::arctan2(const NdArray< dtype > &inY, const NdArray< dtype > &inX)'],['../namespacenc.html#abdec674ddb32540775e97e0fca6016aa',1,'nc::arctan2(dtype inY, dtype inX) noexcept']]], ['arctan2_2ehpp_64',['arctan2.hpp',['../arctan2_8hpp.html',1,'']]], - ['arctanh_65',['arctanh',['../namespacenc.html#a01f43fad4032a2823fc3ed56137b93de',1,'nc::arctanh(dtype inValue) noexcept'],['../namespacenc.html#a1b71f03b842e44890312fa09ed1aa594',1,'nc::arctanh(const NdArray< dtype > &inArray)']]], + ['arctanh_65',['arctanh',['../namespacenc.html#a1b71f03b842e44890312fa09ed1aa594',1,'nc::arctanh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a01f43fad4032a2823fc3ed56137b93de',1,'nc::arctanh(dtype inValue) noexcept']]], ['arctanh_2ehpp_66',['arctanh.hpp',['../arctanh_8hpp.html',1,'']]], ['area_67',['area',['../classnc_1_1polynomial_1_1_poly1d.html#adcbfe7e5fe2ed3b73bc5c81a73ece1cb',1,'nc::polynomial::Poly1d']]], ['argmax_68',['argmax',['../namespacenc.html#a33dac7f03588175031847327655f0b5d',1,'nc::argmax()'],['../classnc_1_1_nd_array.html#ad4a41193c4f364a817f51ac7f6932b1f',1,'nc::NdArray::argmax()']]], ['argmax_2ehpp_69',['argmax.hpp',['../argmax_8hpp.html',1,'']]], - ['argmin_70',['argmin',['../namespacenc.html#ae26281f75850e9b94272228b56544bd5',1,'nc::argmin()'],['../classnc_1_1_nd_array.html#a62a38761f6f8fd005e225a5d3328e073',1,'nc::NdArray::argmin()']]], + ['argmin_70',['argmin',['../classnc_1_1_nd_array.html#a62a38761f6f8fd005e225a5d3328e073',1,'nc::NdArray::argmin()'],['../namespacenc.html#ae26281f75850e9b94272228b56544bd5',1,'nc::argmin()']]], ['argmin_2ehpp_71',['argmin.hpp',['../argmin_8hpp.html',1,'']]], ['argsort_72',['argsort',['../namespacenc.html#a88c217359f5e295649dd0cabe648ce6a',1,'nc::argsort()'],['../classnc_1_1_nd_array.html#ae0ec4abb78faecc68f8d7e2198894196',1,'nc::NdArray::argsort()']]], ['argsort_2ehpp_73',['argsort.hpp',['../argsort_8hpp.html',1,'']]], ['argwhere_74',['argwhere',['../namespacenc.html#aeddef72feba83e0c7d053093c74ed686',1,'nc']]], ['argwhere_2ehpp_75',['argwhere.hpp',['../argwhere_8hpp.html',1,'']]], - ['around_76',['around',['../namespacenc.html#a32e869df2216c793407d6addea9bf890',1,'nc::around(dtype inValue, uint8 inNumDecimals=0)'],['../namespacenc.html#a332fc87fa0bae7583b6a6ca3ceb8a8d4',1,'nc::around(const NdArray< dtype > &inArray, uint8 inNumDecimals=0)']]], + ['around_76',['around',['../namespacenc.html#a332fc87fa0bae7583b6a6ca3ceb8a8d4',1,'nc::around(const NdArray< dtype > &inArray, uint8 inNumDecimals=0)'],['../namespacenc.html#a32e869df2216c793407d6addea9bf890',1,'nc::around(dtype inValue, uint8 inNumDecimals=0)']]], ['around_2ehpp_77',['around.hpp',['../around_8hpp.html',1,'']]], ['array_5fequal_78',['array_equal',['../namespacenc.html#a0e8c1396cc01ccd9ec8ba549b6347e21',1,'nc']]], ['array_5fequal_2ehpp_79',['array_equal.hpp',['../array__equal_8hpp.html',1,'']]], ['array_5fequiv_80',['array_equiv',['../namespacenc.html#ac7cfdea4ac1caa81eabdb5dfe33b90b8',1,'nc']]], ['array_5fequiv_2ehpp_81',['array_equiv.hpp',['../array__equiv_8hpp.html',1,'']]], - ['asarray_82',['asarray',['../namespacenc.html#a37aab9b1478f5d5abea3d02029fb2f2d',1,'nc::asarray(std::vector< dtype > &inVector, bool copy=true)'],['../namespacenc.html#a5ac399ecf8e26717e118be6d04164d31',1,'nc::asarray(const std::vector< std::vector< dtype >> &inVector)'],['../namespacenc.html#a937b7ded9b21c92955e8ab137ad0b449',1,'nc::asarray(std::initializer_list< dtype > inList)'],['../namespacenc.html#a6a6f1083d41b9d345d6dae5093d7632b',1,'nc::asarray(std::initializer_list< std::initializer_list< dtype > > inList)'],['../namespacenc.html#ae2e0f4084163e9be08e324a6f3c10579',1,'nc::asarray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../namespacenc.html#a35116b2646ecd25b63586fa987991f21',1,'nc::asarray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &inArray, bool copy=true)'],['../namespacenc.html#aab50ba883dd36c374c2b0d34c22f7bc1',1,'nc::asarray(std::vector< std::array< dtype, Dim1Size >> &inVector, bool copy=true)'],['../namespacenc.html#a430dab2027f102a689a812134e1f9655',1,'nc::asarray(const std::deque< dtype > &inDeque)'],['../namespacenc.html#ac7a31dc08b1ea7cbdc71c22cad70e328',1,'nc::asarray(const std::deque< std::deque< dtype >> &inDeque)'],['../namespacenc.html#aaef8615d9fb222814f2849fb0915dd81',1,'nc::asarray(const std::set< dtype, dtypeComp > &inSet)'],['../namespacenc.html#a6280fea16d0710fe5e257c3d4cb3a85d',1,'nc::asarray(const std::list< dtype > &inList)'],['../namespacenc.html#aa0127b6d17a87db3f9deed78e90f54bd',1,'nc::asarray(Iterator iterBegin, Iterator iterEnd)'],['../namespacenc.html#a35bad04da98984458f265fc1dcd66b00',1,'nc::asarray(const dtype *iterBegin, const dtype *iterEnd)'],['../namespacenc.html#ac2c02eb2fd3b28ab815ab5d678649a13',1,'nc::asarray(const dtype *ptr, uint32 size)'],['../namespacenc.html#a49d751314929b591b3e1a9d79f81d6ff',1,'nc::asarray(const dtype *ptr, uint32 numRows, uint32 numCols)'],['../namespacenc.html#ae2b23e323b2d5e16933587ede8c5d115',1,'nc::asarray(dtype *ptr, uint32 size, Bool takeOwnership) noexcept'],['../namespacenc.html#a39a0d39388c73f10ab8b462108675e98',1,'nc::asarray(dtype *ptr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept']]], + ['asarray_82',['asarray',['../namespacenc.html#a37aab9b1478f5d5abea3d02029fb2f2d',1,'nc::asarray(std::vector< dtype > &inVector, bool copy=true)'],['../namespacenc.html#a5ac399ecf8e26717e118be6d04164d31',1,'nc::asarray(const std::vector< std::vector< dtype >> &inVector)'],['../namespacenc.html#aab50ba883dd36c374c2b0d34c22f7bc1',1,'nc::asarray(std::vector< std::array< dtype, Dim1Size >> &inVector, bool copy=true)'],['../namespacenc.html#a430dab2027f102a689a812134e1f9655',1,'nc::asarray(const std::deque< dtype > &inDeque)'],['../namespacenc.html#ac7a31dc08b1ea7cbdc71c22cad70e328',1,'nc::asarray(const std::deque< std::deque< dtype >> &inDeque)'],['../namespacenc.html#aaef8615d9fb222814f2849fb0915dd81',1,'nc::asarray(const std::set< dtype, dtypeComp > &inSet)'],['../namespacenc.html#a6280fea16d0710fe5e257c3d4cb3a85d',1,'nc::asarray(const std::list< dtype > &inList)'],['../namespacenc.html#aa0127b6d17a87db3f9deed78e90f54bd',1,'nc::asarray(Iterator iterBegin, Iterator iterEnd)'],['../namespacenc.html#a35bad04da98984458f265fc1dcd66b00',1,'nc::asarray(const dtype *iterBegin, const dtype *iterEnd)'],['../namespacenc.html#ac2c02eb2fd3b28ab815ab5d678649a13',1,'nc::asarray(const dtype *ptr, uint32 size)'],['../namespacenc.html#ae2b23e323b2d5e16933587ede8c5d115',1,'nc::asarray(dtype *ptr, uint32 size, Bool takeOwnership) noexcept'],['../namespacenc.html#a39a0d39388c73f10ab8b462108675e98',1,'nc::asarray(dtype *ptr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept'],['../namespacenc.html#a49d751314929b591b3e1a9d79f81d6ff',1,'nc::asarray(const dtype *ptr, uint32 numRows, uint32 numCols)'],['../namespacenc.html#a937b7ded9b21c92955e8ab137ad0b449',1,'nc::asarray(std::initializer_list< dtype > inList)'],['../namespacenc.html#a6a6f1083d41b9d345d6dae5093d7632b',1,'nc::asarray(std::initializer_list< std::initializer_list< dtype > > inList)'],['../namespacenc.html#ae2e0f4084163e9be08e324a6f3c10579',1,'nc::asarray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../namespacenc.html#a35116b2646ecd25b63586fa987991f21',1,'nc::asarray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &inArray, bool copy=true)']]], ['asarray_2ehpp_83',['asarray.hpp',['../asarray_8hpp.html',1,'']]], - ['astype_84',['astype',['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1polynomial_1_1_poly1d.html#a0cf03b40603f490af100cdc65140ab9f',1,'nc::polynomial::Poly1d::astype()'],['../namespacenc.html#a07250b272d24387fab405d29c14082e4',1,'nc::astype()']]], + ['astype_84',['astype',['../classnc_1_1polynomial_1_1_poly1d.html#a0cf03b40603f490af100cdc65140ab9f',1,'nc::polynomial::Poly1d::astype()'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../namespacenc.html#a07250b272d24387fab405d29c14082e4',1,'nc::astype()']]], ['astype_2ehpp_85',['astype.hpp',['../astype_8hpp.html',1,'']]], - ['at_86',['at',['../classnc_1_1_nd_array.html#a7b5c383337c887ddf537708b29b64afd',1,'nc::NdArray::at()'],['../classnc_1_1_data_cube.html#a8925f65b525c2b4fe04c711851b66828',1,'nc::DataCube::at()'],['../classnc_1_1_nd_array.html#a023bd56ee5fd8b58a4d0eb2acd71f67a',1,'nc::NdArray::at(const NdArray< int32 > &rowIndices, const NdArray< int32 > &colIndices) const'],['../classnc_1_1_nd_array.html#a1537e603e458ad93bdde061e476305d6',1,'nc::NdArray::at(const Slice &inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#adf7b073b906cd66e1c8a78df865b5679',1,'nc::NdArray::at(const Slice &inRowSlice, const Slice &inColSlice) const'],['../classnc_1_1_nd_array.html#a39dc0db6c17edef6642b55b4ce68df48',1,'nc::NdArray::at(const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#a77807cb1488da10f8654dc6331426ca6',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#ade8b486f8c2ffce283abea6126cb3a63',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex)'],['../classnc_1_1_nd_array.html#a10ef25d07c5761028091cda2c7f20d1f',1,'nc::NdArray::at(int32 inIndex) const'],['../classnc_1_1_nd_array.html#a3ae4c372620db7cf0211867dcb886b48',1,'nc::NdArray::at(int32 inIndex)'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a679db8e4b1f175af3db67c756c54d6b1',1,'nc::imageProcessing::ClusterMaker::at()'],['../classnc_1_1image_processing_1_1_cluster.html#a5a8d82d40cea566786e8f80ad72a6d10',1,'nc::imageProcessing::Cluster::at()'],['../classnc_1_1_data_cube.html#ab78c6fc396ea087819cdef43f316da4e',1,'nc::DataCube::at()']]], + ['at_86',['at',['../classnc_1_1_nd_array.html#a023bd56ee5fd8b58a4d0eb2acd71f67a',1,'nc::NdArray::at(const NdArray< int32 > &rowIndices, const NdArray< int32 > &colIndices) const'],['../classnc_1_1_nd_array.html#a7b5c383337c887ddf537708b29b64afd',1,'nc::NdArray::at(int32 inRowIndex, const Slice &inColSlice) const'],['../classnc_1_1_data_cube.html#a8925f65b525c2b4fe04c711851b66828',1,'nc::DataCube::at(uint32 inIndex)'],['../classnc_1_1_data_cube.html#ab78c6fc396ea087819cdef43f316da4e',1,'nc::DataCube::at(uint32 inIndex) const'],['../classnc_1_1image_processing_1_1_cluster.html#a5a8d82d40cea566786e8f80ad72a6d10',1,'nc::imageProcessing::Cluster::at()'],['../classnc_1_1_nd_array.html#adf7b073b906cd66e1c8a78df865b5679',1,'nc::NdArray::at(const Slice &inRowSlice, const Slice &inColSlice) const'],['../classnc_1_1_nd_array.html#a39dc0db6c17edef6642b55b4ce68df48',1,'nc::NdArray::at(const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#a77807cb1488da10f8654dc6331426ca6',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#ade8b486f8c2ffce283abea6126cb3a63',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex)'],['../classnc_1_1_nd_array.html#a10ef25d07c5761028091cda2c7f20d1f',1,'nc::NdArray::at(int32 inIndex) const'],['../classnc_1_1_nd_array.html#a3ae4c372620db7cf0211867dcb886b48',1,'nc::NdArray::at(int32 inIndex)'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a679db8e4b1f175af3db67c756c54d6b1',1,'nc::imageProcessing::ClusterMaker::at()'],['../classnc_1_1_nd_array.html#a1537e603e458ad93bdde061e476305d6',1,'nc::NdArray::at()']]], ['average_87',['average',['../namespacenc.html#a9025fe780f7cb82e65c21738672f1d41',1,'nc::average(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a08d310c2089324a7106ff509b862f5c7',1,'nc::average(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a4d65d31c652a1ab639089ab948d0d557',1,'nc::average(const NdArray< std::complex< dtype >> &inArray, const NdArray< dtype > &inWeights, Axis inAxis=Axis::NONE)']]], ['average_2ehpp_88',['average.hpp',['../average_8hpp.html',1,'']]], ['axis_89',['Axis',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84',1,'nc']]] diff --git a/docs/doxygen/html/search/all_1.html b/docs/doxygen/html/search/all_1.html index 6cbe23813..9f80e9043 100644 --- a/docs/doxygen/html/search/all_1.html +++ b/docs/doxygen/html/search/all_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_1.js b/docs/doxygen/html/search/all_1.js index 5cf329e7d..4b79b2230 100644 --- a/docs/doxygen/html/search/all_1.js +++ b/docs/doxygen/html/search/all_1.js @@ -1,56 +1,60 @@ var searchData= [ - ['back_90',['back',['../classnc_1_1_vec3.html#a44e50b4b49011ec94548558600c0b17c',1,'nc::Vec3::back()'],['../classnc_1_1_nd_array.html#a20fb268d9bd6c25dd70b6772f5ff5b89',1,'nc::NdArray::back(size_type row)'],['../classnc_1_1_nd_array.html#a563cf4dcecda39a0599cc13c87363677',1,'nc::NdArray::back(size_type row) const'],['../classnc_1_1_nd_array.html#a555efdc758b47b107c9c94593b6c2470',1,'nc::NdArray::back() noexcept'],['../classnc_1_1_nd_array.html#a6bb650c9e28ff25c9b58c9f4f08d78bb',1,'nc::NdArray::back() const noexcept'],['../classnc_1_1_data_cube.html#abc8860c7c767170d003da447e7618bee',1,'nc::DataCube::back() noexcept']]], - ['begin_91',['begin',['../classnc_1_1_data_cube.html#a430de05758db67815f957784b298b011',1,'nc::DataCube::begin()'],['../classnc_1_1_nd_array.html#ab3cdc446e55744b31d42dfb53fcdc7cf',1,'nc::NdArray::begin(size_type inRow) const'],['../classnc_1_1_nd_array.html#ae47b79d2054d83dc0c7deb617ab7d1c2',1,'nc::NdArray::begin() const noexcept'],['../classnc_1_1_nd_array.html#a57fa866d30c298337bfc906ae73b6a40',1,'nc::NdArray::begin(size_type inRow)'],['../classnc_1_1_nd_array.html#ab57282e02905eeb2a932eeb73983221f',1,'nc::NdArray::begin() noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a37c172d7253190e76b065ed2547c3020',1,'nc::imageProcessing::ClusterMaker::begin()'],['../classnc_1_1image_processing_1_1_cluster.html#a6e761b470453d5506015b9332b12e4a4',1,'nc::imageProcessing::Cluster::begin()']]], - ['bernoilli_92',['bernoilli',['../namespacenc_1_1special.html#a1af26e52a24fca2b572605ec4b2c1f1b',1,'nc::special::bernoilli(uint32 n)'],['../namespacenc_1_1special.html#a59caf35b816a219aa2782dd45df207ca',1,'nc::special::bernoilli(const NdArray< uint32 > &inArray)']]], - ['bernoilli_2ehpp_93',['bernoilli.hpp',['../bernoilli_8hpp.html',1,'']]], - ['bernoulli_94',['bernoulli',['../namespacenc_1_1random.html#a1a5af4283601fd8663dcdc34599aede3',1,'nc::random::bernoulli(double inP=0.5)'],['../namespacenc_1_1random.html#a8d4a1a62fc03a44cccfa4012413bd70f',1,'nc::random::bernoulli(const Shape &inShape, double inP=0.5)']]], - ['bernoulli_2ehpp_95',['bernoulli.hpp',['../bernoulli_8hpp.html',1,'']]], - ['bessel_5fin_96',['bessel_in',['../namespacenc_1_1special.html#a6e9dbda70e7c0732d0b63ea389e5af49',1,'nc::special::bessel_in(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a92141b6d9ffda6c68c7cb13dee3eae60',1,'nc::special::bessel_in(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fin_2ehpp_97',['bessel_in.hpp',['../bessel__in_8hpp.html',1,'']]], - ['bessel_5fin_5fprime_98',['bessel_in_prime',['../namespacenc_1_1special.html#a416353fb98d37ed2e1a8ab587a16f6f8',1,'nc::special::bessel_in_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a85979b28c3403361a3e818c9cf8cdf16',1,'nc::special::bessel_in_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fin_5fprime_2ehpp_99',['bessel_in_prime.hpp',['../bessel__in__prime_8hpp.html',1,'']]], - ['bessel_5fjn_100',['bessel_jn',['../namespacenc_1_1special.html#a3986d3b42ddcd747d40fb6772b49536e',1,'nc::special::bessel_jn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ab310a9680ad09bc52377898876a27620',1,'nc::special::bessel_jn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fjn_2ehpp_101',['bessel_jn.hpp',['../bessel__jn_8hpp.html',1,'']]], - ['bessel_5fjn_5fprime_102',['bessel_jn_prime',['../namespacenc_1_1special.html#a3eef0d1e8d31602e816578f778feefb5',1,'nc::special::bessel_jn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a6e4139a3ecc85275c4690d01453366dc',1,'nc::special::bessel_jn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fjn_5fprime_2ehpp_103',['bessel_jn_prime.hpp',['../bessel__jn__prime_8hpp.html',1,'']]], - ['bessel_5fkn_104',['bessel_kn',['../namespacenc_1_1special.html#a614d69a09535948c87124fe5662452dc',1,'nc::special::bessel_kn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a5727fa899a61975ffcb79d84fd2d231b',1,'nc::special::bessel_kn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fkn_2ehpp_105',['bessel_kn.hpp',['../bessel__kn_8hpp.html',1,'']]], - ['bessel_5fkn_5fprime_106',['bessel_kn_prime',['../namespacenc_1_1special.html#a98aad61d58f7d046091f6f569d2c97fb',1,'nc::special::bessel_kn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#aa3159d6cbb77b6bc1b913c25d969fa3c',1,'nc::special::bessel_kn_prime(dtype1 inV, dtype2 inX)']]], - ['bessel_5fkn_5fprime_2ehpp_107',['bessel_kn_prime.hpp',['../bessel__kn__prime_8hpp.html',1,'']]], - ['bessel_5fyn_108',['bessel_yn',['../namespacenc_1_1special.html#a2a215c5881fc0d98e444942d3a67ed5b',1,'nc::special::bessel_yn(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a55bbc44ffde64dfb7af7a803250cd2a6',1,'nc::special::bessel_yn(dtype1 inV, dtype2 inX)']]], - ['bessel_5fyn_2ehpp_109',['bessel_yn.hpp',['../bessel__yn_8hpp.html',1,'']]], - ['bessel_5fyn_5fprime_110',['bessel_yn_prime',['../namespacenc_1_1special.html#a129b71949a9659519aea36dc64d47020',1,'nc::special::bessel_yn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a742272fb70f0b85164b61409ad3f464f',1,'nc::special::bessel_yn_prime(dtype1 inV, dtype2 inX)']]], - ['bessel_5fyn_5fprime_2ehpp_111',['bessel_yn_prime.hpp',['../bessel__yn__prime_8hpp.html',1,'']]], - ['beta_112',['beta',['../namespacenc_1_1random.html#a9cf5ddddc350278c76e077c67b5254ab',1,'nc::random::beta(dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1random.html#ab7de94b949521786b7bde650b1e813fa',1,'nc::random::beta(const Shape &inShape, dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1special.html#a9b74f451f99338c909b7f73df6e5bff6',1,'nc::special::beta(dtype1 a, dtype2 b)'],['../namespacenc_1_1special.html#ad2ac5c7add77e243dc39899c15ad93e6',1,'nc::special::beta(const NdArray< dtype1 > &inArrayA, const NdArray< dtype2 > &inArrayB)']]], - ['big_113',['BIG',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152aa60c6c694491d75b439073b8cb05b139',1,'nc']]], - ['binaryrepr_114',['binaryRepr',['../namespacenc.html#a8c8a7dbf208bb2d31983140598e7cebe',1,'nc']]], - ['binaryrepr_2ehpp_115',['binaryRepr.hpp',['../binary_repr_8hpp.html',1,'']]], - ['bincount_116',['bincount',['../namespacenc.html#aa31a10ae8201c637ab3d203844b81904',1,'nc::bincount(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, uint16 inMinLength=1)'],['../namespacenc.html#a60bb0f9e8bed0fd6f5c0973cf3b918ca',1,'nc::bincount(const NdArray< dtype > &inArray, uint16 inMinLength=1)']]], - ['bincount_2ehpp_117',['bincount.hpp',['../bincount_8hpp.html',1,'']]], - ['binomial_118',['binomial',['../namespacenc_1_1random.html#a13657004ec565f15648a520e3d060002',1,'nc::random::binomial(dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#a83099ec22905c3ad69984a94d823a3d8',1,'nc::random::binomial(const Shape &inShape, dtype inN, double inP=0.5)']]], - ['binomial_2ehpp_119',['binomial.hpp',['../binomial_8hpp.html',1,'']]], - ['bisection_120',['Bisection',['../classnc_1_1roots_1_1_bisection.html#a05985162d3dac7a0919319c6cde74895',1,'nc::roots::Bisection::Bisection(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_bisection.html#ae9ccce420ccf01a829b0138f264956cb',1,'nc::roots::Bisection::Bisection(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_bisection.html',1,'nc::roots::Bisection']]], - ['bisection_2ehpp_121',['Bisection.hpp',['../_bisection_8hpp.html',1,'']]], - ['bits_122',['bits',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ae35570f524474adaa2315bead3f9be9e',1,'nc::DtypeInfo< std::complex< dtype > >::bits()'],['../classnc_1_1_dtype_info.html#a3f6aa0cc80e59dc331bc0e8dfe2f20bb',1,'nc::DtypeInfo::bits()']]], - ['bitwise_5fand_123',['bitwise_and',['../namespacenc.html#a4a7fa01dbe15029314c6204f930c09af',1,'nc']]], - ['bitwise_5fand_2ehpp_124',['bitwise_and.hpp',['../bitwise__and_8hpp.html',1,'']]], - ['bitwise_5fnot_125',['bitwise_not',['../namespacenc.html#a172096cafc950983ccbbb05eb5426722',1,'nc']]], - ['bitwise_5fnot_2ehpp_126',['bitwise_not.hpp',['../bitwise__not_8hpp.html',1,'']]], - ['bitwise_5for_127',['bitwise_or',['../namespacenc.html#a6203fb3929a9c533eba79b64342eaa3a',1,'nc']]], - ['bitwise_5for_2ehpp_128',['bitwise_or.hpp',['../bitwise__or_8hpp.html',1,'']]], - ['bitwise_5fxor_129',['bitwise_xor',['../namespacenc.html#a07c69919a1dc382fd2ae3ebf1b358319',1,'nc']]], - ['bitwise_5fxor_2ehpp_130',['bitwise_xor.hpp',['../bitwise__xor_8hpp.html',1,'']]], - ['boostinterface_2ehpp_131',['BoostInterface.hpp',['../_boost_interface_8hpp.html',1,'']]], - ['boostnumpyndarrayhelper_2ehpp_132',['BoostNumpyNdarrayHelper.hpp',['../_boost_numpy_ndarray_helper_8hpp.html',1,'']]], - ['boundary_133',['Boundary',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6',1,'nc::filter']]], - ['boundary_2ehpp_134',['Boundary.hpp',['../_boundary_8hpp.html',1,'']]], - ['brent_135',['Brent',['../classnc_1_1roots_1_1_brent.html#aecf6662d1b7128d38796cf4ab99143f4',1,'nc::roots::Brent::Brent(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_brent.html#a1e9cf8f7be13c7bbb42a073ec9eb5369',1,'nc::roots::Brent::Brent(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_brent.html',1,'nc::roots::Brent']]], - ['brent_2ehpp_136',['Brent.hpp',['../_brent_8hpp.html',1,'']]], - ['building_137',['Building',['../md__mnt_c__github__num_cpp_docs_markdown__building.html',1,'']]], - ['building_2emd_138',['Building.md',['../_building_8md.html',1,'']]], - ['byteswap_139',['byteswap',['../classnc_1_1_nd_array.html#a2d3f796540ca2966cd2964a358627630',1,'nc::NdArray']]], - ['byteswap_140',['byteSwap',['../namespacenc_1_1endian.html#a28d96487f9ac66755e2dd4925a459e0d',1,'nc::endian']]], - ['byteswap_141',['byteswap',['../namespacenc.html#a244a5b96158e15e74e2cc1e54c17edff',1,'nc']]], - ['byteswap_2ehpp_142',['byteswap.hpp',['../byteswap_8hpp.html',1,'']]] + ['back_90',['back',['../classnc_1_1_nd_array.html#a20fb268d9bd6c25dd70b6772f5ff5b89',1,'nc::NdArray::back()'],['../classnc_1_1_vec3.html#a44e50b4b49011ec94548558600c0b17c',1,'nc::Vec3::back()'],['../classnc_1_1_data_cube.html#abc8860c7c767170d003da447e7618bee',1,'nc::DataCube::back()'],['../classnc_1_1_nd_array.html#a563cf4dcecda39a0599cc13c87363677',1,'nc::NdArray::back(size_type row) const'],['../classnc_1_1_nd_array.html#a555efdc758b47b107c9c94593b6c2470',1,'nc::NdArray::back() noexcept'],['../classnc_1_1_nd_array.html#a6bb650c9e28ff25c9b58c9f4f08d78bb',1,'nc::NdArray::back() const noexcept']]], + ['bartlett_91',['bartlett',['../namespacenc.html#a594225660881a1cd0caabba4946c07d4',1,'nc']]], + ['bartlett_2ehpp_92',['bartlett.hpp',['../bartlett_8hpp.html',1,'']]], + ['begin_93',['begin',['../classnc_1_1_nd_array.html#ab3cdc446e55744b31d42dfb53fcdc7cf',1,'nc::NdArray::begin(size_type inRow) const'],['../classnc_1_1_nd_array.html#ae47b79d2054d83dc0c7deb617ab7d1c2',1,'nc::NdArray::begin() const noexcept'],['../classnc_1_1_nd_array.html#a57fa866d30c298337bfc906ae73b6a40',1,'nc::NdArray::begin(size_type inRow)'],['../classnc_1_1_nd_array.html#ab57282e02905eeb2a932eeb73983221f',1,'nc::NdArray::begin() noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a37c172d7253190e76b065ed2547c3020',1,'nc::imageProcessing::ClusterMaker::begin()'],['../classnc_1_1image_processing_1_1_cluster.html#a6e761b470453d5506015b9332b12e4a4',1,'nc::imageProcessing::Cluster::begin()'],['../classnc_1_1_data_cube.html#a430de05758db67815f957784b298b011',1,'nc::DataCube::begin()']]], + ['bernoilli_94',['bernoilli',['../namespacenc_1_1special.html#a59caf35b816a219aa2782dd45df207ca',1,'nc::special::bernoilli(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a1af26e52a24fca2b572605ec4b2c1f1b',1,'nc::special::bernoilli(uint32 n)']]], + ['bernoilli_2ehpp_95',['bernoilli.hpp',['../bernoilli_8hpp.html',1,'']]], + ['bernoulli_96',['bernoulli',['../namespacenc_1_1random.html#a8d4a1a62fc03a44cccfa4012413bd70f',1,'nc::random::bernoulli(const Shape &inShape, double inP=0.5)'],['../namespacenc_1_1random.html#a1a5af4283601fd8663dcdc34599aede3',1,'nc::random::bernoulli(double inP=0.5)']]], + ['bernoulli_2ehpp_97',['bernoulli.hpp',['../bernoulli_8hpp.html',1,'']]], + ['bessel_5fin_98',['bessel_in',['../namespacenc_1_1special.html#a92141b6d9ffda6c68c7cb13dee3eae60',1,'nc::special::bessel_in(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a6e9dbda70e7c0732d0b63ea389e5af49',1,'nc::special::bessel_in(dtype1 inV, dtype2 inX)']]], + ['bessel_5fin_2ehpp_99',['bessel_in.hpp',['../bessel__in_8hpp.html',1,'']]], + ['bessel_5fin_5fprime_100',['bessel_in_prime',['../namespacenc_1_1special.html#a416353fb98d37ed2e1a8ab587a16f6f8',1,'nc::special::bessel_in_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a85979b28c3403361a3e818c9cf8cdf16',1,'nc::special::bessel_in_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fin_5fprime_2ehpp_101',['bessel_in_prime.hpp',['../bessel__in__prime_8hpp.html',1,'']]], + ['bessel_5fjn_102',['bessel_jn',['../namespacenc_1_1special.html#ab310a9680ad09bc52377898876a27620',1,'nc::special::bessel_jn(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a3986d3b42ddcd747d40fb6772b49536e',1,'nc::special::bessel_jn(dtype1 inV, dtype2 inX)']]], + ['bessel_5fjn_2ehpp_103',['bessel_jn.hpp',['../bessel__jn_8hpp.html',1,'']]], + ['bessel_5fjn_5fprime_104',['bessel_jn_prime',['../namespacenc_1_1special.html#a3eef0d1e8d31602e816578f778feefb5',1,'nc::special::bessel_jn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a6e4139a3ecc85275c4690d01453366dc',1,'nc::special::bessel_jn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fjn_5fprime_2ehpp_105',['bessel_jn_prime.hpp',['../bessel__jn__prime_8hpp.html',1,'']]], + ['bessel_5fkn_106',['bessel_kn',['../namespacenc_1_1special.html#a614d69a09535948c87124fe5662452dc',1,'nc::special::bessel_kn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a5727fa899a61975ffcb79d84fd2d231b',1,'nc::special::bessel_kn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fkn_2ehpp_107',['bessel_kn.hpp',['../bessel__kn_8hpp.html',1,'']]], + ['bessel_5fkn_5fprime_108',['bessel_kn_prime',['../namespacenc_1_1special.html#aa3159d6cbb77b6bc1b913c25d969fa3c',1,'nc::special::bessel_kn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a98aad61d58f7d046091f6f569d2c97fb',1,'nc::special::bessel_kn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fkn_5fprime_2ehpp_109',['bessel_kn_prime.hpp',['../bessel__kn__prime_8hpp.html',1,'']]], + ['bessel_5fyn_110',['bessel_yn',['../namespacenc_1_1special.html#a55bbc44ffde64dfb7af7a803250cd2a6',1,'nc::special::bessel_yn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a2a215c5881fc0d98e444942d3a67ed5b',1,'nc::special::bessel_yn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fyn_2ehpp_111',['bessel_yn.hpp',['../bessel__yn_8hpp.html',1,'']]], + ['bessel_5fyn_5fprime_112',['bessel_yn_prime',['../namespacenc_1_1special.html#a742272fb70f0b85164b61409ad3f464f',1,'nc::special::bessel_yn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a129b71949a9659519aea36dc64d47020',1,'nc::special::bessel_yn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fyn_5fprime_2ehpp_113',['bessel_yn_prime.hpp',['../bessel__yn__prime_8hpp.html',1,'']]], + ['beta_114',['beta',['../namespacenc_1_1random.html#a9cf5ddddc350278c76e077c67b5254ab',1,'nc::random::beta(dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1random.html#ab7de94b949521786b7bde650b1e813fa',1,'nc::random::beta(const Shape &inShape, dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1special.html#a9b74f451f99338c909b7f73df6e5bff6',1,'nc::special::beta(dtype1 a, dtype2 b)'],['../namespacenc_1_1special.html#ad2ac5c7add77e243dc39899c15ad93e6',1,'nc::special::beta(const NdArray< dtype1 > &inArrayA, const NdArray< dtype2 > &inArrayB)']]], + ['big_115',['BIG',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152aa60c6c694491d75b439073b8cb05b139',1,'nc']]], + ['binaryrepr_116',['binaryRepr',['../namespacenc.html#a8c8a7dbf208bb2d31983140598e7cebe',1,'nc']]], + ['binaryrepr_2ehpp_117',['binaryRepr.hpp',['../binary_repr_8hpp.html',1,'']]], + ['bincount_118',['bincount',['../namespacenc.html#aa31a10ae8201c637ab3d203844b81904',1,'nc::bincount(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, uint16 inMinLength=1)'],['../namespacenc.html#a60bb0f9e8bed0fd6f5c0973cf3b918ca',1,'nc::bincount(const NdArray< dtype > &inArray, uint16 inMinLength=1)']]], + ['bincount_2ehpp_119',['bincount.hpp',['../bincount_8hpp.html',1,'']]], + ['binomial_120',['binomial',['../namespacenc_1_1random.html#a83099ec22905c3ad69984a94d823a3d8',1,'nc::random::binomial(const Shape &inShape, dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#a13657004ec565f15648a520e3d060002',1,'nc::random::binomial(dtype inN, double inP=0.5)']]], + ['binomial_2ehpp_121',['binomial.hpp',['../binomial_8hpp.html',1,'']]], + ['bisection_122',['Bisection',['../classnc_1_1roots_1_1_bisection.html#a05985162d3dac7a0919319c6cde74895',1,'nc::roots::Bisection::Bisection(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_bisection.html#ae9ccce420ccf01a829b0138f264956cb',1,'nc::roots::Bisection::Bisection(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_bisection.html',1,'nc::roots::Bisection']]], + ['bisection_2ehpp_123',['Bisection.hpp',['../_bisection_8hpp.html',1,'']]], + ['bits_124',['bits',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ae35570f524474adaa2315bead3f9be9e',1,'nc::DtypeInfo< std::complex< dtype > >::bits()'],['../classnc_1_1_dtype_info.html#a3f6aa0cc80e59dc331bc0e8dfe2f20bb',1,'nc::DtypeInfo::bits()']]], + ['bitwise_5fand_125',['bitwise_and',['../namespacenc.html#a4a7fa01dbe15029314c6204f930c09af',1,'nc']]], + ['bitwise_5fand_2ehpp_126',['bitwise_and.hpp',['../bitwise__and_8hpp.html',1,'']]], + ['bitwise_5fnot_127',['bitwise_not',['../namespacenc.html#a172096cafc950983ccbbb05eb5426722',1,'nc']]], + ['bitwise_5fnot_2ehpp_128',['bitwise_not.hpp',['../bitwise__not_8hpp.html',1,'']]], + ['bitwise_5for_129',['bitwise_or',['../namespacenc.html#a6203fb3929a9c533eba79b64342eaa3a',1,'nc']]], + ['bitwise_5for_2ehpp_130',['bitwise_or.hpp',['../bitwise__or_8hpp.html',1,'']]], + ['bitwise_5fxor_131',['bitwise_xor',['../namespacenc.html#a07c69919a1dc382fd2ae3ebf1b358319',1,'nc']]], + ['bitwise_5fxor_2ehpp_132',['bitwise_xor.hpp',['../bitwise__xor_8hpp.html',1,'']]], + ['blackman_133',['blackman',['../namespacenc.html#aab31b376c91a94e877f236177dbab4d0',1,'nc']]], + ['blackman_2ehpp_134',['blackman.hpp',['../blackman_8hpp.html',1,'']]], + ['boostinterface_2ehpp_135',['BoostInterface.hpp',['../_boost_interface_8hpp.html',1,'']]], + ['boostnumpyndarrayhelper_2ehpp_136',['BoostNumpyNdarrayHelper.hpp',['../_boost_numpy_ndarray_helper_8hpp.html',1,'']]], + ['boundary_137',['Boundary',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6',1,'nc::filter']]], + ['boundary_2ehpp_138',['Boundary.hpp',['../_boundary_8hpp.html',1,'']]], + ['brent_139',['Brent',['../classnc_1_1roots_1_1_brent.html#a1e9cf8f7be13c7bbb42a073ec9eb5369',1,'nc::roots::Brent::Brent(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_brent.html#aecf6662d1b7128d38796cf4ab99143f4',1,'nc::roots::Brent::Brent(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_brent.html',1,'nc::roots::Brent']]], + ['brent_2ehpp_140',['Brent.hpp',['../_brent_8hpp.html',1,'']]], + ['building_141',['Building',['../md__c___github__num_cpp_docs_markdown__building.html',1,'']]], + ['building_2emd_142',['Building.md',['../_building_8md.html',1,'']]], + ['byteswap_143',['byteswap',['../classnc_1_1_nd_array.html#a2d3f796540ca2966cd2964a358627630',1,'nc::NdArray']]], + ['byteswap_144',['byteSwap',['../namespacenc_1_1endian.html#a28d96487f9ac66755e2dd4925a459e0d',1,'nc::endian']]], + ['byteswap_145',['byteswap',['../namespacenc.html#a244a5b96158e15e74e2cc1e54c17edff',1,'nc']]], + ['byteswap_2ehpp_146',['byteswap.hpp',['../byteswap_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_10.html b/docs/doxygen/html/search/all_10.html index 54aed4c1c..3bf11961f 100644 --- a/docs/doxygen/html/search/all_10.html +++ b/docs/doxygen/html/search/all_10.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_10.js b/docs/doxygen/html/search/all_10.js index 2ca16ba65..d3b4c2ec8 100644 --- a/docs/doxygen/html/search/all_10.js +++ b/docs/doxygen/html/search/all_10.js @@ -1,5 +1,5 @@ var searchData= [ - ['quaternion_835',['Quaternion',['../classnc_1_1rotations_1_1_quaternion.html',1,'nc::rotations::Quaternion'],['../classnc_1_1rotations_1_1_quaternion.html#a3b6901fb3a079eb9249bd1bf3098c36c',1,'nc::rotations::Quaternion::Quaternion()=default'],['../classnc_1_1rotations_1_1_quaternion.html#a8c498c295071b8b787902044bf87d34d',1,'nc::rotations::Quaternion::Quaternion(double roll, double pitch, double yaw) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a3ba2fb2c68554ec78a0957dc1fd7752d',1,'nc::rotations::Quaternion::Quaternion(double inI, double inJ, double inK, double inS) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#addcc7fb7b4acd4201e7f5b90ef207f4d',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inArray)'],['../classnc_1_1rotations_1_1_quaternion.html#abbacae2cb36d4f7e93e1cf130f8ca6b4',1,'nc::rotations::Quaternion::Quaternion(const Vec3 &inAxis, double inAngle) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a81b7db9d5e593a61272e09ce7dcc1325',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inAxis, double inAngle)']]], - ['quaternion_2ehpp_836',['Quaternion.hpp',['../_quaternion_8hpp.html',1,'']]] + ['quaternion_885',['Quaternion',['../classnc_1_1rotations_1_1_quaternion.html',1,'nc::rotations::Quaternion'],['../classnc_1_1rotations_1_1_quaternion.html#a3b6901fb3a079eb9249bd1bf3098c36c',1,'nc::rotations::Quaternion::Quaternion()=default'],['../classnc_1_1rotations_1_1_quaternion.html#a8c498c295071b8b787902044bf87d34d',1,'nc::rotations::Quaternion::Quaternion(double roll, double pitch, double yaw) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a3ba2fb2c68554ec78a0957dc1fd7752d',1,'nc::rotations::Quaternion::Quaternion(double inI, double inJ, double inK, double inS) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#addcc7fb7b4acd4201e7f5b90ef207f4d',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inArray)'],['../classnc_1_1rotations_1_1_quaternion.html#abbacae2cb36d4f7e93e1cf130f8ca6b4',1,'nc::rotations::Quaternion::Quaternion(const Vec3 &inAxis, double inAngle) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a81b7db9d5e593a61272e09ce7dcc1325',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inAxis, double inAngle)']]], + ['quaternion_2ehpp_886',['Quaternion.hpp',['../_quaternion_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_11.html b/docs/doxygen/html/search/all_11.html index 2cb14d058..c9f79d289 100644 --- a/docs/doxygen/html/search/all_11.html +++ b/docs/doxygen/html/search/all_11.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_11.js b/docs/doxygen/html/search/all_11.js index db276d3f9..025153454 100644 --- a/docs/doxygen/html/search/all_11.js +++ b/docs/doxygen/html/search/all_11.js @@ -1,94 +1,93 @@ var searchData= [ - ['beta_2ehpp_837',['beta.hpp',['../_random_2beta_8hpp.html',1,'']]], - ['gamma_2ehpp_838',['gamma.hpp',['../_random_2gamma_8hpp.html',1,'']]], - ['laplace_2ehpp_839',['laplace.hpp',['../_random_2laplace_8hpp.html',1,'']]], - ['ra_840',['RA',['../classnc_1_1coordinates_1_1_r_a.html',1,'nc::coordinates']]], - ['ra_841',['ra',['../classnc_1_1coordinates_1_1_coordinate.html#abf447494a1d0a769af81aeab79041e5b',1,'nc::coordinates::Coordinate']]], - ['ra_842',['RA',['../classnc_1_1coordinates_1_1_r_a.html#a7566e8350b9075ae0f0406fce26b7900',1,'nc::coordinates::RA::RA(uint8 inHours, uint8 inMinutes, double inSeconds) noexcept'],['../classnc_1_1coordinates_1_1_r_a.html#ab14fd57fb6ab65c4d8ca668d549a507f',1,'nc::coordinates::RA::RA(double inDegrees)'],['../classnc_1_1coordinates_1_1_r_a.html#a632d150cc8009f1ab61053161046f553',1,'nc::coordinates::RA::RA()=default']]], - ['ra_2ehpp_843',['RA.hpp',['../_r_a_8hpp.html',1,'']]], - ['rad2deg_844',['rad2deg',['../namespacenc.html#a8c8fc041b633785104c583a8ce3d9cef',1,'nc::rad2deg(dtype inValue) noexcept'],['../namespacenc.html#a19a21c68cb53309ac33e9c1a7b5d2513',1,'nc::rad2deg(const NdArray< dtype > &inArray)']]], - ['rad2deg_2ehpp_845',['rad2deg.hpp',['../rad2deg_8hpp.html',1,'']]], - ['radians_846',['radians',['../namespacenc.html#ac0f2714a22ef5029abf0f3fee0028546',1,'nc::radians(dtype inValue) noexcept'],['../namespacenc.html#a746ecf69081dec55ceb2647726ee106b',1,'nc::radians(const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_r_a.html#a8a9f875774dd8375cbc72c7fbfbebc2a',1,'nc::coordinates::RA::radians()'],['../classnc_1_1coordinates_1_1_dec.html#af80282ccfb04054bbccb98735a28ac46',1,'nc::coordinates::Dec::radians()']]], - ['radians_2ehpp_847',['radians.hpp',['../radians_8hpp.html',1,'']]], - ['radianseperation_848',['radianSeperation',['../namespacenc_1_1coordinates.html#aa009e573b47b51d34d3aae0b152566c8',1,'nc::coordinates::radianSeperation(const Coordinate &inCoordinate1, const Coordinate &inCoordinate2)'],['../namespacenc_1_1coordinates.html#a712fd847123cfde7948c36ca59c6a435',1,'nc::coordinates::radianSeperation(const NdArray< double > &inVector1, const NdArray< double > &inVector2)'],['../classnc_1_1coordinates_1_1_coordinate.html#ae01f4143ae771a0f8bccefc4bba78b86',1,'nc::coordinates::Coordinate::radianSeperation(const NdArray< double > &inVector) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a169974783c87c9bbc89ccb4ea2ea4123',1,'nc::coordinates::Coordinate::radianSeperation(const Coordinate &inOtherCoordinate) const']]], - ['radianseperation_2ehpp_849',['radianSeperation.hpp',['../radian_seperation_8hpp.html',1,'']]], - ['rand_850',['rand',['../namespacenc_1_1random.html#a4552f49c72dc1a4d8426643fce14f214',1,'nc::random::rand(const Shape &inShape)'],['../namespacenc_1_1random.html#a0f5694167e15a8bc566a3fa6f842c3b4',1,'nc::random::rand()']]], - ['rand_2ehpp_851',['rand.hpp',['../rand_8hpp.html',1,'']]], - ['randfloat_852',['randFloat',['../namespacenc_1_1random.html#a4a261ae2a0f7783f2a5262a22b18412f',1,'nc::random::randFloat(dtype inLow, dtype inHigh=0.0)'],['../namespacenc_1_1random.html#a531b5487f2f3e54fab878340277f7283',1,'nc::random::randFloat(const Shape &inShape, dtype inLow, dtype inHigh=0.0)']]], - ['randfloat_2ehpp_853',['randFloat.hpp',['../rand_float_8hpp.html',1,'']]], - ['randint_854',['randInt',['../namespacenc_1_1random.html#a43201ec4ec8e0c99041647ab45ac0133',1,'nc::random::randInt(dtype inLow, dtype inHigh=0)'],['../namespacenc_1_1random.html#a2842db744ad52ca905a48cd281934fd3',1,'nc::random::randInt(const Shape &inShape, dtype inLow, dtype inHigh=0)']]], - ['randint_2ehpp_855',['randInt.hpp',['../rand_int_8hpp.html',1,'']]], - ['randn_856',['randN',['../namespacenc_1_1random.html#a3c6b8fb355a9ec0bd4c9e9bb8062d1f2',1,'nc::random::randN(const Shape &inShape)'],['../namespacenc_1_1random.html#aeffa74d48c1fb2603f83eaa358f17501',1,'nc::random::randN()']]], - ['randn_2ehpp_857',['randN.hpp',['../rand_n_8hpp.html',1,'']]], - ['random_2ehpp_858',['Random.hpp',['../_random_8hpp.html',1,'']]], - ['rankfilter_859',['rankFilter',['../namespacenc_1_1filter.html#a0c2cbe33d4d1ef4f6a1a10320db1c059',1,'nc::filter']]], - ['rankfilter_2ehpp_860',['rankFilter.hpp',['../rank_filter_8hpp.html',1,'']]], - ['rankfilter1d_861',['rankFilter1d',['../namespacenc_1_1filter.html#ac46eab01f172d2fb3818e0d1cfaf1274',1,'nc::filter']]], - ['rankfilter1d_2ehpp_862',['rankFilter1d.hpp',['../rank_filter1d_8hpp.html',1,'']]], - ['ravel_863',['ravel',['../namespacenc.html#a3e7af5d797200117ddc5e5e3e2a46ee9',1,'nc::ravel()'],['../classnc_1_1_nd_array.html#aeca85f2279281bd389225a76e23e1c45',1,'nc::NdArray::ravel()']]], - ['ravel_2ehpp_864',['ravel.hpp',['../ravel_8hpp.html',1,'']]], - ['rbegin_865',['rbegin',['../classnc_1_1_nd_array.html#a9f983aabd3568e7bd1be0a0c4e2b881d',1,'nc::NdArray::rbegin(size_type inRow) const'],['../classnc_1_1_nd_array.html#ad779b3d2a2f094370be77e515533f143',1,'nc::NdArray::rbegin() const noexcept'],['../classnc_1_1_nd_array.html#a2aa9a0589da3c0b19b1b413e71f65667',1,'nc::NdArray::rbegin(size_type inRow)'],['../classnc_1_1_nd_array.html#a06b5c7ba13ae9f8750bca6d5f3803c73',1,'nc::NdArray::rbegin() noexcept']]], - ['rcolbegin_866',['rcolbegin',['../classnc_1_1_nd_array.html#a48fb313ad0eb8126c338a319a5a2fd98',1,'nc::NdArray::rcolbegin() noexcept'],['../classnc_1_1_nd_array.html#a5f70273a5bbff4f0b0c5086649939301',1,'nc::NdArray::rcolbegin(size_type inCol) const'],['../classnc_1_1_nd_array.html#a012f1203a072caeba4221aaa3c044186',1,'nc::NdArray::rcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a56704aea2c006973065aaa2848faa7fb',1,'nc::NdArray::rcolbegin(size_type inCol)']]], - ['rcolend_867',['rcolend',['../classnc_1_1_nd_array.html#a51e2cddde9482a27bf73fa308e0268c6',1,'nc::NdArray::rcolend(size_type inCol) const'],['../classnc_1_1_nd_array.html#a2d5976e4cd61862c74dce30c94f8fb87',1,'nc::NdArray::rcolend() const noexcept'],['../classnc_1_1_nd_array.html#ad5f870f49c9601930423258dcc723c8e',1,'nc::NdArray::rcolend() noexcept'],['../classnc_1_1_nd_array.html#a434f10a7956f425882fbbbc90038e4cb',1,'nc::NdArray::rcolend(size_type inCol)']]], - ['readme_2emd_868',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]], - ['real_869',['real',['../namespacenc.html#a74174a26b4b6db41951d9ce4222ea724',1,'nc::real(const std::complex< dtype > &inValue)'],['../namespacenc.html#af7cf60663e018e25b1b59016af7e8967',1,'nc::real(const NdArray< std::complex< dtype >> &inArray)']]], - ['real_2ehpp_870',['real.hpp',['../real_8hpp.html',1,'']]], - ['reciprocal_871',['reciprocal',['../namespacenc.html#af0dd0542b322f7f4f8124d13d25cf50e',1,'nc::reciprocal(const NdArray< dtype > &inArray)'],['../namespacenc.html#ac3d266878661a694e99329ab16fa5d25',1,'nc::reciprocal(const NdArray< std::complex< dtype >> &inArray)']]], - ['reciprocal_2ehpp_872',['reciprocal.hpp',['../reciprocal_8hpp.html',1,'']]], - ['reference_873',['reference',['../classnc_1_1_nd_array.html#adb4a1e1a3c3420c4b2133ba81a44a0e0',1,'nc::NdArray::reference()'],['../classnc_1_1_nd_array_const_iterator.html#aba1912cb4e7cc39898af1ea385847544',1,'nc::NdArrayConstIterator::reference()'],['../classnc_1_1_nd_array_iterator.html#a0782b66e4d3632cd4ce99333fe86d0a3',1,'nc::NdArrayIterator::reference()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6903047bac2424843ca26ed9116abb77',1,'nc::NdArrayConstColumnIterator::reference()'],['../classnc_1_1_nd_array_column_iterator.html#aaccb5a94c10e92de24e5bc465c663305',1,'nc::NdArrayColumnIterator::reference()']]], - ['reflect_874',['REFLECT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae4f6a05f82ed398f984f4bc1a55838df',1,'nc::filter']]], - ['reflect1d_875',['reflect1d',['../namespacenc_1_1filter_1_1boundary.html#ac423cb3e19b12651c02c2c16d0723b3f',1,'nc::filter::boundary']]], - ['reflect1d_2ehpp_876',['reflect1d.hpp',['../reflect1d_8hpp.html',1,'']]], - ['reflect2d_877',['reflect2d',['../namespacenc_1_1filter_1_1boundary.html#add9a7d70820161e370ecd37212b1f397',1,'nc::filter::boundary']]], - ['reflect2d_2ehpp_878',['reflect2d.hpp',['../reflect2d_8hpp.html',1,'']]], - ['release_20notes_879',['Release Notes',['../md__mnt_c__github__num_cpp_docs_markdown__release_notes.html',1,'']]], - ['releasenotes_2emd_880',['ReleaseNotes.md',['../_release_notes_8md.html',1,'']]], - ['remainder_881',['remainder',['../namespacenc.html#a14fb9f7c88fca02b0ef3f5ebd04d9099',1,'nc::remainder(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a12bfc5b4d937aa0366b70fb15270bd41',1,'nc::remainder(dtype inValue1, dtype inValue2) noexcept']]], - ['remainder_2ehpp_882',['remainder.hpp',['../remainder_8hpp.html',1,'']]], - ['rend_883',['rend',['../classnc_1_1_nd_array.html#a93f962a3badfd82da685a2d7fdf006aa',1,'nc::NdArray::rend(size_type inRow) const'],['../classnc_1_1_nd_array.html#a59de727a0db449ca5a28d436c9cec165',1,'nc::NdArray::rend() const noexcept'],['../classnc_1_1_nd_array.html#a9047b67188b652c471db37731659c598',1,'nc::NdArray::rend(size_type inRow)'],['../classnc_1_1_nd_array.html#a92c90b8671a637ec7d7821f6e8bdfa56',1,'nc::NdArray::rend() noexcept']]], - ['repeat_884',['repeat',['../classnc_1_1_nd_array.html#a7d72328d5853baedb1644ae387ed3331',1,'nc::NdArray::repeat(const Shape &inRepeatShape) const'],['../classnc_1_1_nd_array.html#acd2185e49f9cbe68b3d3fe6cef552d34',1,'nc::NdArray::repeat(uint32 inNumRows, uint32 inNumCols) const'],['../namespacenc.html#a29f4287edbe473e6039e4566adfd3ea4',1,'nc::repeat(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a5aaf1657514116d3556183665983e02a',1,'nc::repeat(const NdArray< dtype > &inArray, const Shape &inRepeatShape)']]], - ['repeat_2ehpp_885',['repeat.hpp',['../repeat_8hpp.html',1,'']]], - ['replace_886',['replace',['../namespacenc_1_1stl__algorithms.html#aa8d46043c9c62a348687ef8aa0a3286b',1,'nc::stl_algorithms::replace()'],['../namespacenc.html#a8e35a8cdb9a2a053820c58d2a9eab4e2',1,'nc::replace()'],['../classnc_1_1_nd_array.html#aefaba20fd8cf6710714340ea9733f1d5',1,'nc::NdArray::replace()']]], - ['replace_2ehpp_887',['replace.hpp',['../replace_8hpp.html',1,'']]], - ['resetnumberofiterations_888',['resetNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#a85e79a4794bc3a6ac6bc3564956737a2',1,'nc::roots::Iteration']]], - ['reshape_889',['reshape',['../classnc_1_1_nd_array.html#ace0dfa53f15057e5f505a41b67f000bb',1,'nc::NdArray::reshape()'],['../namespacenc.html#a45d9fc095ecf7a127211c507c03d95db',1,'nc::reshape(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a6858d6bf094cfeaa724b78133668d13d',1,'nc::reshape(NdArray< dtype > &inArray, int32 inNumRows, int32 inNumCols)'],['../namespacenc.html#a5fb8d978dec93ab8a07849b5dc0d2b06',1,'nc::reshape(NdArray< dtype > &inArray, uint32 inSize)'],['../classnc_1_1_nd_array.html#aa646e053a4fcd7ef3356add1edb4240d',1,'nc::NdArray::reshape(int32 inNumRows, int32 inNumCols)'],['../classnc_1_1_nd_array.html#a81992957eaa4cf2da430e12296af79c7',1,'nc::NdArray::reshape(const Shape &inShape)']]], - ['reshape_2ehpp_890',['reshape.hpp',['../reshape_8hpp.html',1,'']]], - ['resizefast_891',['resizeFast',['../namespacenc.html#ac2bcb04348f201141d8f465e461269cc',1,'nc::resizeFast(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a4dcc5b3664678e2510ff1df693641619',1,'nc::resizeFast(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#ac15af1559e8f8dcd8cd5930c5ce54377',1,'nc::NdArray::resizeFast(uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a1f999dc4afd08a9bc9c696af66d3ccb3',1,'nc::NdArray::resizeFast(const Shape &inShape)']]], - ['resizefast_2ehpp_892',['resizeFast.hpp',['../resize_fast_8hpp.html',1,'']]], - ['resizeslow_893',['resizeSlow',['../classnc_1_1_nd_array.html#a9499c04345682f4bf0afd8a5d16df435',1,'nc::NdArray::resizeSlow()'],['../namespacenc.html#acdf2d60461cf6779107dc00118b642f9',1,'nc::resizeSlow(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a845b9344102b55adc482616442765d93',1,'nc::resizeSlow(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a091f587d753e4e4aec1bb6621ccbaa41',1,'nc::NdArray::resizeSlow()']]], - ['resizeslow_2ehpp_894',['resizeSlow.hpp',['../resize_slow_8hpp.html',1,'']]], - ['reverse_895',['reverse',['../namespacenc_1_1stl__algorithms.html#a5334750b4a1bb38d3932bffcc32a71b4',1,'nc::stl_algorithms']]], - ['reverse_5fcolumn_5fiterator_896',['reverse_column_iterator',['../classnc_1_1_nd_array.html#abc1bc6a854968940dac643396b2fb1b5',1,'nc::NdArray']]], - ['reverse_5fiterator_897',['reverse_iterator',['../classnc_1_1_nd_array.html#a9987ced72f8182d4b55807c0177eab11',1,'nc::NdArray']]], - ['riemann_5fzeta_898',['riemann_zeta',['../namespacenc_1_1special.html#a8d31d086f833496ad7eb98c5bd6304a2',1,'nc::special::riemann_zeta(dtype inValue)'],['../namespacenc_1_1special.html#a6a4ac80df3e9946630cf330d03cbbbd2',1,'nc::special::riemann_zeta(const NdArray< dtype > &inArray)']]], - ['riemann_5fzeta_2ehpp_899',['riemann_zeta.hpp',['../riemann__zeta_8hpp.html',1,'']]], - ['right_900',['right',['../classnc_1_1_vec3.html#af8862aed471260a45c7691c7c5c6b016',1,'nc::Vec3::right()'],['../classnc_1_1_vec2.html#ab84fdd231058aa0343e2249e209855bf',1,'nc::Vec2::right()']]], - ['right_5fshift_901',['right_shift',['../namespacenc.html#ad66d86cf7f33128b1d7540ac7cde9f75',1,'nc']]], - ['right_5fshift_2ehpp_902',['right_shift.hpp',['../right__shift_8hpp.html',1,'']]], - ['rint_903',['rint',['../namespacenc.html#a9ba33527dbca7d5482cf88899abd827d',1,'nc::rint(dtype inValue) noexcept'],['../namespacenc.html#ae37c534819fb5756874bf8972df7e2fa',1,'nc::rint(const NdArray< dtype > &inArray)']]], - ['rint_2ehpp_904',['rint.hpp',['../rint_8hpp.html',1,'']]], - ['rms_905',['rms',['../namespacenc.html#a4e858c717929038ef196af3c4b4c53ae',1,'nc::rms(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a0da200d1221a9b1c526de48ccba57258',1,'nc::rms(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], - ['rms_2ehpp_906',['rms.hpp',['../rms_8hpp.html',1,'']]], - ['rodriguesrotation_907',['rodriguesRotation',['../namespacenc_1_1rotations.html#ae7d7397eec3edcfbd8b6b9784ad2fd1c',1,'nc::rotations::rodriguesRotation(const Vec3 &k, double theta, const Vec3 &v) noexcept'],['../namespacenc_1_1rotations.html#ab0fbd9345e707b6efb023ec9b354fbb5',1,'nc::rotations::rodriguesRotation(const NdArray< dtype > &k, double theta, const NdArray< dtype > &v)']]], - ['rodriguesrotation_2ehpp_908',['rodriguesRotation.hpp',['../rodrigues_rotation_8hpp.html',1,'']]], - ['roll_909',['roll',['../classnc_1_1rotations_1_1_quaternion.html#a26f2a9303f0521ee36d92467ab45e3ab',1,'nc::rotations::Quaternion::roll()'],['../namespacenc.html#a57ce5ac638626e5718c13f756af23bf2',1,'nc::roll()'],['../classnc_1_1rotations_1_1_d_c_m.html#ac562518ebdec1ce36cf8897a16f16fca',1,'nc::rotations::DCM::roll()']]], - ['roll_2ehpp_910',['roll.hpp',['../roll_8hpp.html',1,'']]], - ['romberg_911',['romberg',['../namespacenc_1_1integrate.html#a5406412619aa59539dd19f62f0be8caf',1,'nc::integrate']]], - ['romberg_2ehpp_912',['romberg.hpp',['../romberg_8hpp.html',1,'']]], - ['roots_2ehpp_913',['Roots.hpp',['../_roots_8hpp.html',1,'']]], - ['rot90_914',['rot90',['../namespacenc.html#a2f52b32644f8f4da903e9c096d283da6',1,'nc']]], - ['rot90_2ehpp_915',['rot90.hpp',['../rot90_8hpp.html',1,'']]], - ['rotate_916',['rotate',['../namespacenc_1_1stl__algorithms.html#acfc1538e29a04fe5158405c710e5eaa7',1,'nc::stl_algorithms::rotate()'],['../classnc_1_1rotations_1_1_quaternion.html#a382d4e4c045bce131c5cce634ed077c7',1,'nc::rotations::Quaternion::rotate(const Vec3 &inVec3) const'],['../classnc_1_1rotations_1_1_quaternion.html#a2e19c4d0b48d7f73e0aa273d85435370',1,'nc::rotations::Quaternion::rotate(const NdArray< double > &inVector) const']]], - ['rotations_2ehpp_917',['Rotations.hpp',['../_rotations_8hpp.html',1,'']]], - ['round_918',['round',['../namespacenc.html#a2a3a666494e7c95975d40ce80b156f0f',1,'nc::round(const NdArray< dtype > &inArray, uint8 inDecimals=0)'],['../namespacenc.html#af9c0b27b59e8a7be27130c9f470c4ef3',1,'nc::round(dtype inValue, uint8 inDecimals=0)'],['../classnc_1_1_nd_array.html#a13b0f7af99772cfbca83b6734fbef04d',1,'nc::NdArray::round()']]], - ['round_2ehpp_919',['round.hpp',['../round_8hpp.html',1,'']]], - ['row_920',['ROW',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84a54c1ed33c810f895d48c008d89f880b7',1,'nc']]], - ['row_921',['row',['../classnc_1_1image_processing_1_1_centroid.html#aa3546b7b2430b51650f40fb344ab55a8',1,'nc::imageProcessing::Centroid::row()'],['../classnc_1_1_nd_array.html#ab24cce75b03204af139d8d32090cdae8',1,'nc::NdArray::row()'],['../classnc_1_1image_processing_1_1_pixel.html#a6e712ef3b6547f5cafb6e8db1349658e',1,'nc::imageProcessing::Pixel::row()']]], - ['row_5fstack_922',['row_stack',['../namespacenc.html#a0d82f81eba247f95974bd20039bd56fc',1,'nc']]], - ['row_5fstack_2ehpp_923',['row_stack.hpp',['../row__stack_8hpp.html',1,'']]], - ['rowmax_924',['rowMax',['../classnc_1_1image_processing_1_1_cluster.html#a58eea870dca4a5c61cfd4db24ea50267',1,'nc::imageProcessing::Cluster']]], - ['rowmin_925',['rowMin',['../classnc_1_1image_processing_1_1_cluster.html#ac3f0c485f193a71a6caca9f553970383',1,'nc::imageProcessing::Cluster']]], - ['rows_926',['rows',['../classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a',1,'nc::Shape']]], - ['rslice_927',['rSlice',['../classnc_1_1_nd_array.html#af0fb0a32e08456603964206487aebc88',1,'nc::NdArray']]] + ['beta_2ehpp_887',['beta.hpp',['../_random_2beta_8hpp.html',1,'']]], + ['gamma_2ehpp_888',['gamma.hpp',['../_random_2gamma_8hpp.html',1,'']]], + ['laplace_2ehpp_889',['laplace.hpp',['../_random_2laplace_8hpp.html',1,'']]], + ['ra_890',['RA',['../classnc_1_1coordinates_1_1_r_a.html',1,'nc::coordinates::RA'],['../classnc_1_1coordinates_1_1_r_a.html#a632d150cc8009f1ab61053161046f553',1,'nc::coordinates::RA::RA()=default'],['../classnc_1_1coordinates_1_1_r_a.html#ab14fd57fb6ab65c4d8ca668d549a507f',1,'nc::coordinates::RA::RA(double inDegrees)'],['../classnc_1_1coordinates_1_1_r_a.html#a7566e8350b9075ae0f0406fce26b7900',1,'nc::coordinates::RA::RA(uint8 inHours, uint8 inMinutes, double inSeconds) noexcept']]], + ['ra_891',['ra',['../classnc_1_1coordinates_1_1_coordinate.html#abf447494a1d0a769af81aeab79041e5b',1,'nc::coordinates::Coordinate']]], + ['ra_2ehpp_892',['RA.hpp',['../_r_a_8hpp.html',1,'']]], + ['rad2deg_893',['rad2deg',['../namespacenc.html#a8c8fc041b633785104c583a8ce3d9cef',1,'nc::rad2deg(dtype inValue) noexcept'],['../namespacenc.html#a19a21c68cb53309ac33e9c1a7b5d2513',1,'nc::rad2deg(const NdArray< dtype > &inArray)']]], + ['rad2deg_2ehpp_894',['rad2deg.hpp',['../rad2deg_8hpp.html',1,'']]], + ['radians_895',['radians',['../classnc_1_1coordinates_1_1_dec.html#af80282ccfb04054bbccb98735a28ac46',1,'nc::coordinates::Dec::radians()'],['../namespacenc.html#ac0f2714a22ef5029abf0f3fee0028546',1,'nc::radians(dtype inValue) noexcept'],['../namespacenc.html#a746ecf69081dec55ceb2647726ee106b',1,'nc::radians(const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_r_a.html#a8a9f875774dd8375cbc72c7fbfbebc2a',1,'nc::coordinates::RA::radians()']]], + ['radians_2ehpp_896',['radians.hpp',['../radians_8hpp.html',1,'']]], + ['radianseperation_897',['radianSeperation',['../namespacenc_1_1coordinates.html#a712fd847123cfde7948c36ca59c6a435',1,'nc::coordinates::radianSeperation()'],['../classnc_1_1coordinates_1_1_coordinate.html#ae01f4143ae771a0f8bccefc4bba78b86',1,'nc::coordinates::Coordinate::radianSeperation(const NdArray< double > &inVector) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a169974783c87c9bbc89ccb4ea2ea4123',1,'nc::coordinates::Coordinate::radianSeperation(const Coordinate &inOtherCoordinate) const'],['../namespacenc_1_1coordinates.html#aa009e573b47b51d34d3aae0b152566c8',1,'nc::coordinates::radianSeperation()']]], + ['radianseperation_2ehpp_898',['radianSeperation.hpp',['../radian_seperation_8hpp.html',1,'']]], + ['rand_899',['rand',['../namespacenc_1_1random.html#a4552f49c72dc1a4d8426643fce14f214',1,'nc::random::rand(const Shape &inShape)'],['../namespacenc_1_1random.html#a0f5694167e15a8bc566a3fa6f842c3b4',1,'nc::random::rand()']]], + ['rand_2ehpp_900',['rand.hpp',['../rand_8hpp.html',1,'']]], + ['randfloat_901',['randFloat',['../namespacenc_1_1random.html#a531b5487f2f3e54fab878340277f7283',1,'nc::random::randFloat(const Shape &inShape, dtype inLow, dtype inHigh=0.0)'],['../namespacenc_1_1random.html#a4a261ae2a0f7783f2a5262a22b18412f',1,'nc::random::randFloat(dtype inLow, dtype inHigh=0.0)']]], + ['randfloat_2ehpp_902',['randFloat.hpp',['../rand_float_8hpp.html',1,'']]], + ['randint_903',['randInt',['../namespacenc_1_1random.html#a43201ec4ec8e0c99041647ab45ac0133',1,'nc::random::randInt(dtype inLow, dtype inHigh=0)'],['../namespacenc_1_1random.html#a2842db744ad52ca905a48cd281934fd3',1,'nc::random::randInt(const Shape &inShape, dtype inLow, dtype inHigh=0)']]], + ['randint_2ehpp_904',['randInt.hpp',['../rand_int_8hpp.html',1,'']]], + ['randn_905',['randN',['../namespacenc_1_1random.html#aeffa74d48c1fb2603f83eaa358f17501',1,'nc::random::randN()'],['../namespacenc_1_1random.html#a3c6b8fb355a9ec0bd4c9e9bb8062d1f2',1,'nc::random::randN(const Shape &inShape)']]], + ['randn_2ehpp_906',['randN.hpp',['../rand_n_8hpp.html',1,'']]], + ['random_2ehpp_907',['Random.hpp',['../_random_8hpp.html',1,'']]], + ['rankfilter_908',['rankFilter',['../namespacenc_1_1filter.html#a0c2cbe33d4d1ef4f6a1a10320db1c059',1,'nc::filter']]], + ['rankfilter_2ehpp_909',['rankFilter.hpp',['../rank_filter_8hpp.html',1,'']]], + ['rankfilter1d_910',['rankFilter1d',['../namespacenc_1_1filter.html#ac46eab01f172d2fb3818e0d1cfaf1274',1,'nc::filter']]], + ['rankfilter1d_2ehpp_911',['rankFilter1d.hpp',['../rank_filter1d_8hpp.html',1,'']]], + ['ravel_912',['ravel',['../namespacenc.html#a3e7af5d797200117ddc5e5e3e2a46ee9',1,'nc::ravel()'],['../classnc_1_1_nd_array.html#aeca85f2279281bd389225a76e23e1c45',1,'nc::NdArray::ravel()']]], + ['ravel_2ehpp_913',['ravel.hpp',['../ravel_8hpp.html',1,'']]], + ['rbegin_914',['rbegin',['../classnc_1_1_nd_array.html#a06b5c7ba13ae9f8750bca6d5f3803c73',1,'nc::NdArray::rbegin() noexcept'],['../classnc_1_1_nd_array.html#a2aa9a0589da3c0b19b1b413e71f65667',1,'nc::NdArray::rbegin(size_type inRow)'],['../classnc_1_1_nd_array.html#ad779b3d2a2f094370be77e515533f143',1,'nc::NdArray::rbegin() const noexcept'],['../classnc_1_1_nd_array.html#a9f983aabd3568e7bd1be0a0c4e2b881d',1,'nc::NdArray::rbegin(size_type inRow) const']]], + ['rcolbegin_915',['rcolbegin',['../classnc_1_1_nd_array.html#a012f1203a072caeba4221aaa3c044186',1,'nc::NdArray::rcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a5f70273a5bbff4f0b0c5086649939301',1,'nc::NdArray::rcolbegin(size_type inCol) const'],['../classnc_1_1_nd_array.html#a56704aea2c006973065aaa2848faa7fb',1,'nc::NdArray::rcolbegin(size_type inCol)'],['../classnc_1_1_nd_array.html#a48fb313ad0eb8126c338a319a5a2fd98',1,'nc::NdArray::rcolbegin() noexcept']]], + ['rcolend_916',['rcolend',['../classnc_1_1_nd_array.html#ad5f870f49c9601930423258dcc723c8e',1,'nc::NdArray::rcolend() noexcept'],['../classnc_1_1_nd_array.html#a434f10a7956f425882fbbbc90038e4cb',1,'nc::NdArray::rcolend(size_type inCol)'],['../classnc_1_1_nd_array.html#a2d5976e4cd61862c74dce30c94f8fb87',1,'nc::NdArray::rcolend() const noexcept'],['../classnc_1_1_nd_array.html#a51e2cddde9482a27bf73fa308e0268c6',1,'nc::NdArray::rcolend(size_type inCol) const']]], + ['readme_2emd_917',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]], + ['real_918',['real',['../namespacenc.html#a74174a26b4b6db41951d9ce4222ea724',1,'nc::real(const std::complex< dtype > &inValue)'],['../namespacenc.html#af7cf60663e018e25b1b59016af7e8967',1,'nc::real(const NdArray< std::complex< dtype >> &inArray)']]], + ['real_2ehpp_919',['real.hpp',['../real_8hpp.html',1,'']]], + ['reciprocal_920',['reciprocal',['../namespacenc.html#af0dd0542b322f7f4f8124d13d25cf50e',1,'nc::reciprocal(const NdArray< dtype > &inArray)'],['../namespacenc.html#ac3d266878661a694e99329ab16fa5d25',1,'nc::reciprocal(const NdArray< std::complex< dtype >> &inArray)']]], + ['reciprocal_2ehpp_921',['reciprocal.hpp',['../reciprocal_8hpp.html',1,'']]], + ['reference_922',['reference',['../classnc_1_1_nd_array.html#adb4a1e1a3c3420c4b2133ba81a44a0e0',1,'nc::NdArray::reference()'],['../classnc_1_1_nd_array_iterator.html#a0782b66e4d3632cd4ce99333fe86d0a3',1,'nc::NdArrayIterator::reference()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6903047bac2424843ca26ed9116abb77',1,'nc::NdArrayConstColumnIterator::reference()'],['../classnc_1_1_nd_array_column_iterator.html#aaccb5a94c10e92de24e5bc465c663305',1,'nc::NdArrayColumnIterator::reference()'],['../classnc_1_1_nd_array_const_iterator.html#aba1912cb4e7cc39898af1ea385847544',1,'nc::NdArrayConstIterator::reference()']]], + ['reflect_923',['REFLECT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae4f6a05f82ed398f984f4bc1a55838df',1,'nc::filter']]], + ['reflect1d_924',['reflect1d',['../namespacenc_1_1filter_1_1boundary.html#ac423cb3e19b12651c02c2c16d0723b3f',1,'nc::filter::boundary']]], + ['reflect1d_2ehpp_925',['reflect1d.hpp',['../reflect1d_8hpp.html',1,'']]], + ['reflect2d_926',['reflect2d',['../namespacenc_1_1filter_1_1boundary.html#add9a7d70820161e370ecd37212b1f397',1,'nc::filter::boundary']]], + ['reflect2d_2ehpp_927',['reflect2d.hpp',['../reflect2d_8hpp.html',1,'']]], + ['release_20notes_928',['Release Notes',['../md__c___github__num_cpp_docs_markdown__release_notes.html',1,'']]], + ['releasenotes_2emd_929',['ReleaseNotes.md',['../_release_notes_8md.html',1,'']]], + ['remainder_930',['remainder',['../namespacenc.html#a14fb9f7c88fca02b0ef3f5ebd04d9099',1,'nc::remainder(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a12bfc5b4d937aa0366b70fb15270bd41',1,'nc::remainder(dtype inValue1, dtype inValue2) noexcept']]], + ['remainder_2ehpp_931',['remainder.hpp',['../remainder_8hpp.html',1,'']]], + ['rend_932',['rend',['../classnc_1_1_nd_array.html#a93f962a3badfd82da685a2d7fdf006aa',1,'nc::NdArray::rend(size_type inRow) const'],['../classnc_1_1_nd_array.html#a59de727a0db449ca5a28d436c9cec165',1,'nc::NdArray::rend() const noexcept'],['../classnc_1_1_nd_array.html#a9047b67188b652c471db37731659c598',1,'nc::NdArray::rend(size_type inRow)'],['../classnc_1_1_nd_array.html#a92c90b8671a637ec7d7821f6e8bdfa56',1,'nc::NdArray::rend() noexcept']]], + ['repeat_933',['repeat',['../classnc_1_1_nd_array.html#acd2185e49f9cbe68b3d3fe6cef552d34',1,'nc::NdArray::repeat()'],['../namespacenc.html#a5aaf1657514116d3556183665983e02a',1,'nc::repeat(const NdArray< dtype > &inArray, const Shape &inRepeatShape)'],['../namespacenc.html#a29f4287edbe473e6039e4566adfd3ea4',1,'nc::repeat(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a7d72328d5853baedb1644ae387ed3331',1,'nc::NdArray::repeat()']]], + ['repeat_2ehpp_934',['repeat.hpp',['../repeat_8hpp.html',1,'']]], + ['replace_935',['replace',['../namespacenc_1_1stl__algorithms.html#aa8d46043c9c62a348687ef8aa0a3286b',1,'nc::stl_algorithms::replace()'],['../namespacenc.html#a8e35a8cdb9a2a053820c58d2a9eab4e2',1,'nc::replace()'],['../classnc_1_1_nd_array.html#aefaba20fd8cf6710714340ea9733f1d5',1,'nc::NdArray::replace()']]], + ['replace_2ehpp_936',['replace.hpp',['../replace_8hpp.html',1,'']]], + ['resetnumberofiterations_937',['resetNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#a85e79a4794bc3a6ac6bc3564956737a2',1,'nc::roots::Iteration']]], + ['reshape_938',['reshape',['../classnc_1_1_nd_array.html#a81992957eaa4cf2da430e12296af79c7',1,'nc::NdArray::reshape()'],['../namespacenc.html#a45d9fc095ecf7a127211c507c03d95db',1,'nc::reshape(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a6858d6bf094cfeaa724b78133668d13d',1,'nc::reshape(NdArray< dtype > &inArray, int32 inNumRows, int32 inNumCols)'],['../namespacenc.html#a5fb8d978dec93ab8a07849b5dc0d2b06',1,'nc::reshape(NdArray< dtype > &inArray, uint32 inSize)'],['../classnc_1_1_nd_array.html#aa646e053a4fcd7ef3356add1edb4240d',1,'nc::NdArray::reshape(int32 inNumRows, int32 inNumCols)'],['../classnc_1_1_nd_array.html#ace0dfa53f15057e5f505a41b67f000bb',1,'nc::NdArray::reshape(size_type inSize)']]], + ['reshape_2ehpp_939',['reshape.hpp',['../reshape_8hpp.html',1,'']]], + ['resizefast_940',['resizeFast',['../classnc_1_1_nd_array.html#ac15af1559e8f8dcd8cd5930c5ce54377',1,'nc::NdArray::resizeFast(uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a1f999dc4afd08a9bc9c696af66d3ccb3',1,'nc::NdArray::resizeFast(const Shape &inShape)'],['../namespacenc.html#ac2bcb04348f201141d8f465e461269cc',1,'nc::resizeFast(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a4dcc5b3664678e2510ff1df693641619',1,'nc::resizeFast(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], + ['resizefast_2ehpp_941',['resizeFast.hpp',['../resize_fast_8hpp.html',1,'']]], + ['resizeslow_942',['resizeSlow',['../classnc_1_1_nd_array.html#a091f587d753e4e4aec1bb6621ccbaa41',1,'nc::NdArray::resizeSlow(uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a9499c04345682f4bf0afd8a5d16df435',1,'nc::NdArray::resizeSlow(const Shape &inShape)'],['../namespacenc.html#acdf2d60461cf6779107dc00118b642f9',1,'nc::resizeSlow(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a845b9344102b55adc482616442765d93',1,'nc::resizeSlow(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], + ['resizeslow_2ehpp_943',['resizeSlow.hpp',['../resize_slow_8hpp.html',1,'']]], + ['reverse_944',['reverse',['../namespacenc_1_1stl__algorithms.html#a5334750b4a1bb38d3932bffcc32a71b4',1,'nc::stl_algorithms']]], + ['reverse_5fcolumn_5fiterator_945',['reverse_column_iterator',['../classnc_1_1_nd_array.html#abc1bc6a854968940dac643396b2fb1b5',1,'nc::NdArray']]], + ['reverse_5fiterator_946',['reverse_iterator',['../classnc_1_1_nd_array.html#a9987ced72f8182d4b55807c0177eab11',1,'nc::NdArray']]], + ['riemann_5fzeta_947',['riemann_zeta',['../namespacenc_1_1special.html#a6a4ac80df3e9946630cf330d03cbbbd2',1,'nc::special::riemann_zeta(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a8d31d086f833496ad7eb98c5bd6304a2',1,'nc::special::riemann_zeta(dtype inValue)']]], + ['riemann_5fzeta_2ehpp_948',['riemann_zeta.hpp',['../riemann__zeta_8hpp.html',1,'']]], + ['right_949',['right',['../classnc_1_1_vec2.html#ab84fdd231058aa0343e2249e209855bf',1,'nc::Vec2::right()'],['../classnc_1_1_vec3.html#af8862aed471260a45c7691c7c5c6b016',1,'nc::Vec3::right()']]], + ['right_5fshift_950',['right_shift',['../namespacenc.html#ad66d86cf7f33128b1d7540ac7cde9f75',1,'nc']]], + ['right_5fshift_2ehpp_951',['right_shift.hpp',['../right__shift_8hpp.html',1,'']]], + ['rint_952',['rint',['../namespacenc.html#ae37c534819fb5756874bf8972df7e2fa',1,'nc::rint(const NdArray< dtype > &inArray)'],['../namespacenc.html#a9ba33527dbca7d5482cf88899abd827d',1,'nc::rint(dtype inValue) noexcept']]], + ['rint_2ehpp_953',['rint.hpp',['../rint_8hpp.html',1,'']]], + ['rms_954',['rms',['../namespacenc.html#a0da200d1221a9b1c526de48ccba57258',1,'nc::rms(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a4e858c717929038ef196af3c4b4c53ae',1,'nc::rms(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], + ['rms_2ehpp_955',['rms.hpp',['../rms_8hpp.html',1,'']]], + ['rodriguesrotation_956',['rodriguesRotation',['../namespacenc_1_1rotations.html#ae7d7397eec3edcfbd8b6b9784ad2fd1c',1,'nc::rotations::rodriguesRotation(const Vec3 &k, double theta, const Vec3 &v) noexcept'],['../namespacenc_1_1rotations.html#ab0fbd9345e707b6efb023ec9b354fbb5',1,'nc::rotations::rodriguesRotation(const NdArray< dtype > &k, double theta, const NdArray< dtype > &v)']]], + ['rodriguesrotation_2ehpp_957',['rodriguesRotation.hpp',['../rodrigues_rotation_8hpp.html',1,'']]], + ['roll_958',['roll',['../classnc_1_1rotations_1_1_d_c_m.html#ac562518ebdec1ce36cf8897a16f16fca',1,'nc::rotations::DCM::roll()'],['../classnc_1_1rotations_1_1_quaternion.html#a26f2a9303f0521ee36d92467ab45e3ab',1,'nc::rotations::Quaternion::roll()'],['../namespacenc.html#a57ce5ac638626e5718c13f756af23bf2',1,'nc::roll()']]], + ['roll_2ehpp_959',['roll.hpp',['../roll_8hpp.html',1,'']]], + ['romberg_960',['romberg',['../namespacenc_1_1integrate.html#a5406412619aa59539dd19f62f0be8caf',1,'nc::integrate']]], + ['romberg_2ehpp_961',['romberg.hpp',['../romberg_8hpp.html',1,'']]], + ['roots_2ehpp_962',['Roots.hpp',['../_roots_8hpp.html',1,'']]], + ['rot90_963',['rot90',['../namespacenc.html#a2f52b32644f8f4da903e9c096d283da6',1,'nc']]], + ['rot90_2ehpp_964',['rot90.hpp',['../rot90_8hpp.html',1,'']]], + ['rotate_965',['rotate',['../classnc_1_1rotations_1_1_quaternion.html#a382d4e4c045bce131c5cce634ed077c7',1,'nc::rotations::Quaternion::rotate(const Vec3 &inVec3) const'],['../classnc_1_1rotations_1_1_quaternion.html#a2e19c4d0b48d7f73e0aa273d85435370',1,'nc::rotations::Quaternion::rotate(const NdArray< double > &inVector) const'],['../namespacenc_1_1stl__algorithms.html#acfc1538e29a04fe5158405c710e5eaa7',1,'nc::stl_algorithms::rotate()']]], + ['rotations_2ehpp_966',['Rotations.hpp',['../_rotations_8hpp.html',1,'']]], + ['round_967',['round',['../classnc_1_1_nd_array.html#a13b0f7af99772cfbca83b6734fbef04d',1,'nc::NdArray::round()'],['../namespacenc.html#af9c0b27b59e8a7be27130c9f470c4ef3',1,'nc::round(dtype inValue, uint8 inDecimals=0)'],['../namespacenc.html#a2a3a666494e7c95975d40ce80b156f0f',1,'nc::round(const NdArray< dtype > &inArray, uint8 inDecimals=0)']]], + ['round_2ehpp_968',['round.hpp',['../round_8hpp.html',1,'']]], + ['row_969',['row',['../classnc_1_1image_processing_1_1_centroid.html#aa3546b7b2430b51650f40fb344ab55a8',1,'nc::imageProcessing::Centroid::row()'],['../classnc_1_1image_processing_1_1_pixel.html#a6e712ef3b6547f5cafb6e8db1349658e',1,'nc::imageProcessing::Pixel::row()'],['../classnc_1_1_nd_array.html#ab24cce75b03204af139d8d32090cdae8',1,'nc::NdArray::row()']]], + ['row_970',['ROW',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84a54c1ed33c810f895d48c008d89f880b7',1,'nc']]], + ['row_5fstack_971',['row_stack',['../namespacenc.html#a0d82f81eba247f95974bd20039bd56fc',1,'nc']]], + ['row_5fstack_2ehpp_972',['row_stack.hpp',['../row__stack_8hpp.html',1,'']]], + ['rowmax_973',['rowMax',['../classnc_1_1image_processing_1_1_cluster.html#a58eea870dca4a5c61cfd4db24ea50267',1,'nc::imageProcessing::Cluster']]], + ['rowmin_974',['rowMin',['../classnc_1_1image_processing_1_1_cluster.html#ac3f0c485f193a71a6caca9f553970383',1,'nc::imageProcessing::Cluster']]], + ['rows_975',['rows',['../classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a',1,'nc::Shape']]], + ['rslice_976',['rSlice',['../classnc_1_1_nd_array.html#af0fb0a32e08456603964206487aebc88',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/all_12.html b/docs/doxygen/html/search/all_12.html index 62953a199..ab934722c 100644 --- a/docs/doxygen/html/search/all_12.html +++ b/docs/doxygen/html/search/all_12.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_12.js b/docs/doxygen/html/search/all_12.js index bb11ea56d..365bf72e9 100644 --- a/docs/doxygen/html/search/all_12.js +++ b/docs/doxygen/html/search/all_12.js @@ -1,110 +1,112 @@ var searchData= [ - ['beta_2ehpp_928',['beta.hpp',['../_special_2beta_8hpp.html',1,'']]], - ['gamma_2ehpp_929',['gamma.hpp',['../_special_2gamma_8hpp.html',1,'']]], - ['s_930',['s',['../classnc_1_1rotations_1_1_quaternion.html#a075b6f1befef247f5d638c91e1a451fd',1,'nc::rotations::Quaternion::s()'],['../classnc_1_1linalg_1_1_s_v_d.html#a323915fbe7cbaabadef01ffa948d2f1a',1,'nc::linalg::SVD::s()']]], - ['secant_931',['Secant',['../classnc_1_1roots_1_1_secant.html',1,'nc::roots::Secant'],['../classnc_1_1roots_1_1_secant.html#adedf56589f2027e224d6044a071f20e3',1,'nc::roots::Secant::Secant(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_secant.html#af8afc48a7393e85103a9c2acc662c63b',1,'nc::roots::Secant::Secant(const double epsilon, std::function< double(double)> f) noexcept']]], - ['secant_2ehpp_932',['Secant.hpp',['../_secant_8hpp.html',1,'']]], - ['seconds_933',['seconds',['../classnc_1_1coordinates_1_1_r_a.html#af0c9b649f60a70bbf421a6eb5b169cda',1,'nc::coordinates::RA::seconds()'],['../classnc_1_1coordinates_1_1_dec.html#a2927e30c2059f09bd30be622cf9b52ea',1,'nc::coordinates::Dec::seconds()']]], - ['seconds_5fper_5fday_934',['SECONDS_PER_DAY',['../namespacenc_1_1constants.html#a766ec3bf1f6fb57f586f943cea1946c3',1,'nc::constants']]], - ['seconds_5fper_5fhour_935',['SECONDS_PER_HOUR',['../namespacenc_1_1constants.html#ad635a54557e853e1ee098d0ead5f1902',1,'nc::constants']]], - ['seconds_5fper_5fminute_936',['SECONDS_PER_MINUTE',['../namespacenc_1_1constants.html#ad89620cbdf9102f40ec7c0fd52c16a5e',1,'nc::constants']]], - ['seconds_5fper_5fweek_937',['SECONDS_PER_WEEK',['../namespacenc_1_1constants.html#ac36cac5f19ce5f81b2acc562f247f0be',1,'nc::constants']]], - ['seed_938',['seed',['../namespacenc_1_1random.html#a93fe76208181d041adb08a02de0966d8',1,'nc::random']]], - ['set_5fdifference_939',['set_difference',['../namespacenc_1_1stl__algorithms.html#a8a145ff0f4cf32b64e7464347d1ea9b2',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a8cc83e2fb7a3d8302db0f4b19513ddd9',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination)']]], - ['set_5fintersection_940',['set_intersection',['../namespacenc_1_1stl__algorithms.html#ad9a963ad13c86117f01fe2960525e074',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#aa8ff8c5bb6003ff0f02a17deb4ced8e2',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], - ['set_5funion_941',['set_union',['../namespacenc_1_1stl__algorithms.html#a33da2f830ebf2e7c04f1ac94e1ad20b7',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a273ff7212f84bcd8de30e83ab0ae3bd1',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], - ['setdiff1d_942',['setdiff1d',['../namespacenc.html#adb6b7ca658c4d613fe0c4a695ba3542b',1,'nc']]], - ['setdiff1d_2ehpp_943',['setdiff1d.hpp',['../setdiff1d_8hpp.html',1,'']]], - ['setname_944',['setName',['../classnc_1_1_timer.html#a88dd680a63b38ae9989a40878a8fd65b',1,'nc::Timer']]], - ['shape_945',['Shape',['../classnc_1_1_shape.html',1,'nc::Shape'],['../classnc_1_1_shape.html#a6e870e9fda60c8e82996802fcb71490a',1,'nc::Shape::Shape()']]], - ['shape_946',['shape',['../classnc_1_1_data_cube.html#a1e7e4ce08e0c57abb661a8f95192173e',1,'nc::DataCube::shape()'],['../classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4',1,'nc::NdArray::shape()']]], - ['shape_947',['Shape',['../classnc_1_1_shape.html#a0f41587a1b8f1c2b65035adc49705eec',1,'nc::Shape::Shape()=default'],['../classnc_1_1_shape.html#a4b2cd200804257d9c53084f14fb38e31',1,'nc::Shape::Shape(uint32 inRows, uint32 inCols) noexcept']]], - ['shape_948',['shape',['../namespacenc.html#ae2b224742bc8263190d451a44ebe5e34',1,'nc']]], - ['shuffle_949',['shuffle',['../namespacenc_1_1random.html#ad73d56152095ad55887c89f47490c070',1,'nc::random']]], - ['shuffle_2ehpp_950',['shuffle.hpp',['../shuffle_8hpp.html',1,'']]], - ['sign_951',['Sign',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94',1,'nc::coordinates']]], - ['sign_952',['sign',['../namespacenc.html#a22372b41fc480a7284967d2be4b87841',1,'nc::sign(const NdArray< dtype > &inArray)'],['../namespacenc.html#a4a5d98f334e0b50a3cf9c2718485e5e9',1,'nc::sign(dtype inValue) noexcept'],['../classnc_1_1coordinates_1_1_dec.html#ac551f7b1f2728f20fbdbd79dd00919f7',1,'nc::coordinates::Dec::sign()']]], - ['sign_2ehpp_953',['sign.hpp',['../sign_8hpp.html',1,'']]], - ['signbit_954',['signbit',['../namespacenc.html#af6dcbdfea85cdc84b4ddcf6c978b71f1',1,'nc::signbit(dtype inValue) noexcept'],['../namespacenc.html#a09632f5c6c5d569ccfde17351811b3c0',1,'nc::signbit(const NdArray< dtype > &inArray)']]], - ['signbit_2ehpp_955',['signbit.hpp',['../signbit_8hpp.html',1,'']]], - ['simpson_956',['simpson',['../namespacenc_1_1integrate.html#aa7c55b05139ecfce5e5a9d0380df9eb1',1,'nc::integrate']]], - ['simpson_2ehpp_957',['simpson.hpp',['../simpson_8hpp.html',1,'']]], - ['sin_958',['sin',['../namespacenc.html#a3fa4e582cdeef0716309ad51378f2983',1,'nc::sin(dtype inValue) noexcept'],['../namespacenc.html#aff909cb0ae96644487adaedbbb498cea',1,'nc::sin(const NdArray< dtype > &inArray)']]], - ['sin_2ehpp_959',['sin.hpp',['../sin_8hpp.html',1,'']]], - ['sinc_960',['sinc',['../namespacenc.html#a0c8e5bf6fca377445afd941d70bcac10',1,'nc::sinc(const NdArray< dtype > &inArray)'],['../namespacenc.html#aafe29b8d2e32e8e2af4d92074851b777',1,'nc::sinc(dtype inValue) noexcept']]], - ['sinc_2ehpp_961',['sinc.hpp',['../sinc_8hpp.html',1,'']]], - ['sinh_962',['sinh',['../namespacenc.html#a7672779bec72183de09ddc469739b385',1,'nc::sinh(dtype inValue) noexcept'],['../namespacenc.html#a8de43bfef3cdd2e1af1c521dcf3a2dcd',1,'nc::sinh(const NdArray< dtype > &inArray)']]], - ['sinh_2ehpp_963',['sinh.hpp',['../sinh_8hpp.html',1,'']]], - ['size_964',['size',['../namespacenc.html#a25f36ba02112a206936fae22b0724bb9',1,'nc::size()'],['../classnc_1_1_shape.html#ab29f87cc8479a2d0610a918cd9b08bbc',1,'nc::Shape::size()'],['../classnc_1_1image_processing_1_1_cluster.html#ae89900f4557d6273fc49b330417e324e',1,'nc::imageProcessing::Cluster::size()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae437071bfc291a36745d043ddd4cba1d',1,'nc::imageProcessing::ClusterMaker::size()'],['../classnc_1_1_nd_array.html#a055875abbe80163ca91328c0fa8ffbfa',1,'nc::NdArray::size()']]], - ['size_2ehpp_965',['size.hpp',['../size_8hpp.html',1,'']]], - ['size_5ftype_966',['size_type',['../classnc_1_1_nd_array.html#ae2bdede667042f52176de3f3649735f6',1,'nc::NdArray::size_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a99d31459bd356031b795095a38366706',1,'nc::NdArrayConstColumnIterator::size_type()'],['../classnc_1_1_nd_array_column_iterator.html#a845a41edc124e1c38ccf1940c02e272d',1,'nc::NdArrayColumnIterator::size_type()']]], - ['sizez_967',['sizeZ',['../classnc_1_1_data_cube.html#a6518d36db671db4053abffff92505c64',1,'nc::DataCube']]], - ['sleep_968',['sleep',['../classnc_1_1_timer.html#a9fec514ed605a11c6e1c321041960d7e',1,'nc::Timer']]], - ['slerp_969',['slerp',['../classnc_1_1rotations_1_1_quaternion.html#a7a39f199e4d1ad773b93c69e66ae0415',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#a687155cd6469c095941b94a738119da9',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat2, double inPercent) const']]], - ['slice_970',['Slice',['../classnc_1_1_slice.html',1,'nc::Slice'],['../classnc_1_1_slice.html#aeb2a7e0854fa82d97a48a5ef402d6e7c',1,'nc::Slice::Slice()=default'],['../classnc_1_1_slice.html#aa54f0fae63ece8ff87455e2192d8f336',1,'nc::Slice::Slice(int32 inStop) noexcept'],['../classnc_1_1_slice.html#aba1f6c8193f0a61a3f5711edd58aeba1',1,'nc::Slice::Slice(int32 inStart, int32 inStop) noexcept'],['../classnc_1_1_slice.html#a91177c7ea9b87318232b8d916a487d38',1,'nc::Slice::Slice(int32 inStart, int32 inStop, int32 inStep) noexcept']]], - ['slice_2ehpp_971',['Slice.hpp',['../_slice_8hpp.html',1,'']]], - ['slicez_972',['sliceZ',['../classnc_1_1_data_cube.html#aacc3751540c1b3d79e177a6b93a383fb',1,'nc::DataCube::sliceZ(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a3bc1ba8251f5e788155d6a01727d1644',1,'nc::DataCube::sliceZ(Slice inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a8164f497dd44a89d1c5a1aeb7ca92e55',1,'nc::DataCube::sliceZ(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a71d00d236bd135a4a35212fb147ae905',1,'nc::DataCube::sliceZ(int32 inIndex, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6e6629a0891235ea43e77389f93326cd',1,'nc::DataCube::sliceZ(int32 inRow, int32 inCol, Slice inSliceZ) const']]], - ['slicezall_973',['sliceZAll',['../classnc_1_1_data_cube.html#a7297568496398f9d80ceef1b9b955bfa',1,'nc::DataCube::sliceZAll(int32 inIndex) const'],['../classnc_1_1_data_cube.html#a0f149a9a6dfc3644a95c7741bbe60ca6',1,'nc::DataCube::sliceZAll(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#af8c15897cf2ff42ddd86648583aee686',1,'nc::DataCube::sliceZAll(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#a1961f8bf37432ab59bba9a59206537bd',1,'nc::DataCube::sliceZAll(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a64c85bf44f454e917c635167e46301e9',1,'nc::DataCube::sliceZAll(Slice inRow, Slice inCol) const']]], - ['slicezallat_974',['sliceZAllat',['../classnc_1_1_data_cube.html#ae6f6216581c3824f862bad03fea73f45',1,'nc::DataCube::sliceZAllat(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a57aaf216577c8a696dbf1dbe6363297e',1,'nc::DataCube::sliceZAllat(Slice inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#ad404a350af85b9e99be4901c028ed487',1,'nc::DataCube::sliceZAllat(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#aaf2cad6dc76e1342d72c8d0291062357',1,'nc::DataCube::sliceZAllat(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#a7dd2ceb0e7935647c31993c5db1d1d20',1,'nc::DataCube::sliceZAllat(int32 inIndex) const']]], - ['slicezat_975',['sliceZat',['../classnc_1_1_data_cube.html#a435a6f90ee141a790af7c04557396baf',1,'nc::DataCube::sliceZat(int32 inIndex, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6075ed979ff9294f2ff0bd54bb928952',1,'nc::DataCube::sliceZat(int32 inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6f6bfc2ed7ec485877f0266f906342be',1,'nc::DataCube::sliceZat(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a70d350f869a1831a401522667b65639a',1,'nc::DataCube::sliceZat(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a2c4ac09094f98ca9de7e6f02aa8956a3',1,'nc::DataCube::sliceZat(Slice inRow, Slice inCol, Slice inSliceZ) const']]], - ['softmax_976',['softmax',['../namespacenc_1_1special.html#a459176cc2a1b285e93c3ee5671294590',1,'nc::special']]], - ['softmax_2ehpp_977',['softmax.hpp',['../softmax_8hpp.html',1,'']]], - ['solve_978',['solve',['../classnc_1_1roots_1_1_secant.html#a3fefb4412402aa20eeabb85145463d70',1,'nc::roots::Secant::solve()'],['../namespacenc_1_1linalg.html#afe2a5221f8e22e671e9e6eb231516205',1,'nc::linalg::solve()'],['../classnc_1_1linalg_1_1_s_v_d.html#aa170c7ec6894fb30e115840d61bd58a1',1,'nc::linalg::SVD::solve()'],['../classnc_1_1roots_1_1_bisection.html#a1199a68b6f57fee8b24bfc59ffeff486',1,'nc::roots::Bisection::solve()'],['../classnc_1_1roots_1_1_brent.html#a3853981ca1113723006b6627d96d378b',1,'nc::roots::Brent::solve()'],['../classnc_1_1roots_1_1_dekker.html#a5da7506a8f371764d0fae321fe081111',1,'nc::roots::Dekker::solve()'],['../classnc_1_1roots_1_1_newton.html#aaed2535d1abdb0c6790aea60762ed789',1,'nc::roots::Newton::solve()']]], - ['solve_2ehpp_979',['solve.hpp',['../solve_8hpp.html',1,'']]], - ['sort_980',['sort',['../classnc_1_1_nd_array.html#a3c0a24c292c340c58a6da5526654f3bb',1,'nc::NdArray::sort()'],['../namespacenc.html#a8273e1ecb5eafba97b7ed5b8f10a6cdf',1,'nc::sort()'],['../namespacenc_1_1stl__algorithms.html#a519432fa55645fab8162c354e387b1a6',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a1d75d47f198fcc3693e87806d6ea8715',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last) noexcept']]], - ['sort_2ehpp_981',['sort.hpp',['../sort_8hpp.html',1,'']]], - ['special_2ehpp_982',['Special.hpp',['../_special_8hpp.html',1,'']]], - ['spherical_5fbessel_5fjn_983',['spherical_bessel_jn',['../namespacenc_1_1special.html#a979e99d8a1626829183e38f69486e263',1,'nc::special::spherical_bessel_jn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#aa7f12646500dfd811792934164f8f403',1,'nc::special::spherical_bessel_jn(uint32 inV, const NdArray< dtype > &inArrayX)']]], - ['spherical_5fbessel_5fjn_2ehpp_984',['spherical_bessel_jn.hpp',['../spherical__bessel__jn_8hpp.html',1,'']]], - ['spherical_5fbessel_5fyn_985',['spherical_bessel_yn',['../namespacenc_1_1special.html#a1628a418aa8896a4f9711083ac5579d5',1,'nc::special::spherical_bessel_yn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#a11378004d6f60a0ecf65470d071985b0',1,'nc::special::spherical_bessel_yn(uint32 inV, const NdArray< dtype > &inArrayX)']]], - ['spherical_5fbessel_5fyn_2ehpp_986',['spherical_bessel_yn.hpp',['../spherical__bessel__yn_8hpp.html',1,'']]], - ['spherical_5fhankel_5f1_987',['spherical_hankel_1',['../namespacenc_1_1special.html#a5c0f4be297580a6d46f89b851c948227',1,'nc::special::spherical_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a239954539e877214833b9cfe65f742db',1,'nc::special::spherical_hankel_1(dtype1 inV, const NdArray< dtype2 > &inArray)']]], - ['spherical_5fhankel_5f1_2ehpp_988',['spherical_hankel_1.hpp',['../spherical__hankel__1_8hpp.html',1,'']]], - ['spherical_5fhankel_5f2_989',['spherical_hankel_2',['../namespacenc_1_1special.html#aa0181306ece55cbaf50c65da8d215542',1,'nc::special::spherical_hankel_2(dtype1 inV, const NdArray< dtype2 > &inArray)'],['../namespacenc_1_1special.html#a767d00adf7283b45bd3b7ea4aab6c5ff',1,'nc::special::spherical_hankel_2(dtype1 inV, dtype2 inX)']]], - ['spherical_5fhankel_5f2_2ehpp_990',['spherical_hankel_2.hpp',['../spherical__hankel__2_8hpp.html',1,'']]], - ['spherical_5fharmonic_991',['spherical_harmonic',['../namespacenc_1_1polynomial.html#aa5bb22676f3f43eda1e7c0af04da376a',1,'nc::polynomial']]], - ['spherical_5fharmonic_2ehpp_992',['spherical_harmonic.hpp',['../spherical__harmonic_8hpp.html',1,'']]], - ['spherical_5fharmonic_5fi_993',['spherical_harmonic_i',['../namespacenc_1_1polynomial.html#a583c30981b9547a90ad7c33edbe041c1',1,'nc::polynomial']]], - ['spherical_5fharmonic_5fr_994',['spherical_harmonic_r',['../namespacenc_1_1polynomial.html#a5ed971ca59899f372f28a53913796745',1,'nc::polynomial']]], - ['sqr_995',['sqr',['../namespacenc_1_1utils.html#ae792e10a24b7e5b8291a6c31a28a4512',1,'nc::utils']]], - ['sqr_2ehpp_996',['sqr.hpp',['../sqr_8hpp.html',1,'']]], - ['sqrt_997',['sqrt',['../namespacenc.html#abb4086978f52185f25340b0ff57ca8f0',1,'nc::sqrt(const NdArray< dtype > &inArray)'],['../namespacenc.html#a941a5a1ffb61387495a6f23dc4036287',1,'nc::sqrt(dtype inValue) noexcept']]], - ['sqrt_2ehpp_998',['sqrt.hpp',['../sqrt_8hpp.html',1,'']]], - ['square_999',['square',['../namespacenc.html#a282e72a93afe2e6554e0f17f21dd7b9e',1,'nc::square(dtype inValue) noexcept'],['../namespacenc.html#a104a8ffcdf7d3911fb6d4bbb847e2a1d',1,'nc::square(const NdArray< dtype > &inArray)']]], - ['square_2ehpp_1000',['square.hpp',['../square_8hpp.html',1,'']]], - ['stable_5fsort_1001',['stable_sort',['../namespacenc_1_1stl__algorithms.html#a7b2c4b6a3ef5cc55ebdae2aa757d1874',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a3b9f4bb9ba9a3ea8d8f97258eaa732d9',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last) noexcept']]], - ['stack_1002',['stack',['../namespacenc.html#a656bb4b9fecf40f1f4194964be57c78b',1,'nc']]], - ['stack_2ehpp_1003',['stack.hpp',['../stack_8hpp.html',1,'']]], - ['standardnormal_1004',['standardNormal',['../namespacenc_1_1random.html#a026e31e4ef305beb2bbb546817e44eb0',1,'nc::random::standardNormal(const Shape &inShape)'],['../namespacenc_1_1random.html#acc9d03c66c1fa8b35dea3fa0a0f075e7',1,'nc::random::standardNormal()']]], - ['standardnormal_2ehpp_1005',['standardNormal.hpp',['../standard_normal_8hpp.html',1,'']]], - ['start_1006',['start',['../classnc_1_1_slice.html#a36ddb261d9057db4a9794b4fc46e9d3f',1,'nc::Slice']]], - ['static_5fassert_5farithmetic_1007',['STATIC_ASSERT_ARITHMETIC',['../_static_asserts_8hpp.html#a36abb32368b91aed0d3133a4cfd5ae92',1,'StaticAsserts.hpp']]], - ['static_5fassert_5farithmetic_5for_5fcomplex_1008',['STATIC_ASSERT_ARITHMETIC_OR_COMPLEX',['../_static_asserts_8hpp.html#a1589f74d429e30786c65cda69b17ab96',1,'StaticAsserts.hpp']]], - ['static_5fassert_5fcomplex_1009',['STATIC_ASSERT_COMPLEX',['../_static_asserts_8hpp.html#a1cd1b98c2b918cbd369afc12c11a0597',1,'StaticAsserts.hpp']]], - ['static_5fassert_5ffloat_1010',['STATIC_ASSERT_FLOAT',['../_static_asserts_8hpp.html#a0cd8e186da549fbdd918111d0302d973',1,'StaticAsserts.hpp']]], - ['static_5fassert_5finteger_1011',['STATIC_ASSERT_INTEGER',['../_static_asserts_8hpp.html#a187660686583e9047c0cf4424259ad10',1,'StaticAsserts.hpp']]], - ['static_5fassert_5fvalid_5fdtype_1012',['STATIC_ASSERT_VALID_DTYPE',['../_static_asserts_8hpp.html#a00cfe1ea01e56fe28ffe3d6ce5cae468',1,'StaticAsserts.hpp']]], - ['staticasserts_2ehpp_1013',['StaticAsserts.hpp',['../_static_asserts_8hpp.html',1,'']]], - ['stdcomplexoperators_2ehpp_1014',['StdComplexOperators.hpp',['../_std_complex_operators_8hpp.html',1,'']]], - ['stdev_1015',['stdev',['../namespacenc.html#ae197a8efaeeebe00c6e886b779ec1a43',1,'nc::stdev(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a60ac1ab2f35e50531ef0f12be00d89c8',1,'nc::stdev(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], - ['stdev_2ehpp_1016',['stdev.hpp',['../stdev_8hpp.html',1,'']]], - ['step_1017',['step',['../classnc_1_1_slice.html#a112855a11aa1737b7859e3d63feb09c4',1,'nc::Slice']]], - ['stlalgorithms_2ehpp_1018',['StlAlgorithms.hpp',['../_stl_algorithms_8hpp.html',1,'']]], - ['stop_1019',['stop',['../classnc_1_1_slice.html#ac2d72f4ca003ed645bc82efcafee87f5',1,'nc::Slice']]], - ['str_1020',['str',['../classnc_1_1image_processing_1_1_cluster.html#aaa1ee55d0c47196847b8bb1a76258bd3',1,'nc::imageProcessing::Cluster::str()'],['../classnc_1_1image_processing_1_1_centroid.html#aa39ae81638b8f7ed7b81d4476e2a6316',1,'nc::imageProcessing::Centroid::str()'],['../classnc_1_1image_processing_1_1_pixel.html#ae47f279d2f0ba0921027e787e3773ee8',1,'nc::imageProcessing::Pixel::str()'],['../classnc_1_1_nd_array.html#aa44f94cc8d02a56636223686f30d84f1',1,'nc::NdArray::str()'],['../classnc_1_1polynomial_1_1_poly1d.html#aa5c091077a037bab14a1c558ece21435',1,'nc::polynomial::Poly1d::str()'],['../classnc_1_1rotations_1_1_quaternion.html#a0ddeeba7435df3364f262215f24c93c1',1,'nc::rotations::Quaternion::str()'],['../classnc_1_1coordinates_1_1_coordinate.html#a04a60dd7bc2ef5be41c8006e2797997f',1,'nc::coordinates::Coordinate::str()'],['../classnc_1_1coordinates_1_1_dec.html#a91ddbec1fadfdcc049930dc439da4608',1,'nc::coordinates::Dec::str()'],['../classnc_1_1coordinates_1_1_r_a.html#a37824a93eb9e0a02237d4e654040761b',1,'nc::coordinates::RA::str()'],['../classnc_1_1_shape.html#aadb0e0d633d64e5eb5a4f9bef12b26c4',1,'nc::Shape::str()'],['../classnc_1_1_slice.html#af8bc3bb19b48fd09c769fd1fa9860ed5',1,'nc::Slice::str()']]], - ['studentt_1021',['studentT',['../namespacenc_1_1random.html#a5c18c6c123083003f32344baeb0f4ad3',1,'nc::random::studentT(const Shape &inShape, dtype inDof)'],['../namespacenc_1_1random.html#a9e8074cb89e2362b5ae485834f550217',1,'nc::random::studentT(dtype inDof)']]], - ['studentt_2ehpp_1022',['studentT.hpp',['../student_t_8hpp.html',1,'']]], - ['subtract_1023',['subtract',['../namespacenc.html#a29da51134625301935f0e1098111e74b',1,'nc::subtract(dtype value, const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a8668e0f6416572f18cf0d8c2e008784a',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a7f2189bdc8a3718be82a8497cd2ea99d',1,'nc::subtract(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#ae4be1086253a0b121695d9cabfcb86ce',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#afa4586729c62bfae485a6e7664ba7117',1,'nc::subtract(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a7851e0af8b7501f667e2d89738259191',1,'nc::subtract(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a0499ac58fc4cfe52a2bba30f70376d84',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a8aae2ea3fcf6335997c10676fafcd1e5',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#acddd661c047325c1c0c473aa545011d9',1,'nc::subtract(const NdArray< dtype > &inArray, const std::complex< dtype > &value)']]], - ['subtract_2ehpp_1024',['subtract.hpp',['../subtract_8hpp.html',1,'']]], - ['sum_1025',['sum',['../classnc_1_1_nd_array.html#a467700098b002b5631c756ca0fd50cae',1,'nc::NdArray::sum()'],['../namespacenc.html#aa14c0f092bfdc980c656bf6bf58bfc67',1,'nc::sum()']]], - ['sum_2ehpp_1026',['sum.hpp',['../sum_8hpp.html',1,'']]], - ['svd_1027',['SVD',['../classnc_1_1linalg_1_1_s_v_d.html',1,'nc::linalg::SVD'],['../classnc_1_1linalg_1_1_s_v_d.html#ae0561bbc9633e436139258b0c70b98ba',1,'nc::linalg::SVD::SVD()']]], - ['svd_1028',['svd',['../namespacenc_1_1linalg.html#acb38ad2613d50422afc539d005159055',1,'nc::linalg']]], - ['svd_2ehpp_1029',['svd.hpp',['../svd_8hpp.html',1,'']]], - ['svdclass_2ehpp_1030',['SVDClass.hpp',['../_s_v_d_class_8hpp.html',1,'']]], - ['swap_1031',['swap',['../namespacenc.html#a39da0502565b913855379ea1439047e1',1,'nc']]], - ['swap_2ehpp_1032',['swap.hpp',['../swap_8hpp.html',1,'']]], - ['swapaxes_1033',['swapaxes',['../classnc_1_1_nd_array.html#a7995ba04b64061dfd931ac58c05826f2',1,'nc::NdArray::swapaxes()'],['../namespacenc.html#a9371c43ae0a95c53cdaaf97a5bbc1db7',1,'nc::swapaxes()']]], - ['swapaxes_2ehpp_1034',['swapaxes.hpp',['../swapaxes_8hpp.html',1,'']]] + ['beta_2ehpp_977',['beta.hpp',['../_special_2beta_8hpp.html',1,'']]], + ['gamma_2ehpp_978',['gamma.hpp',['../_special_2gamma_8hpp.html',1,'']]], + ['s_979',['s',['../classnc_1_1rotations_1_1_quaternion.html#a075b6f1befef247f5d638c91e1a451fd',1,'nc::rotations::Quaternion::s()'],['../classnc_1_1linalg_1_1_s_v_d.html#a323915fbe7cbaabadef01ffa948d2f1a',1,'nc::linalg::SVD::s()']]], + ['secant_980',['Secant',['../classnc_1_1roots_1_1_secant.html',1,'nc::roots::Secant'],['../classnc_1_1roots_1_1_secant.html#adedf56589f2027e224d6044a071f20e3',1,'nc::roots::Secant::Secant(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_secant.html#af8afc48a7393e85103a9c2acc662c63b',1,'nc::roots::Secant::Secant(const double epsilon, std::function< double(double)> f) noexcept']]], + ['secant_2ehpp_981',['Secant.hpp',['../_secant_8hpp.html',1,'']]], + ['seconds_982',['seconds',['../classnc_1_1coordinates_1_1_r_a.html#af0c9b649f60a70bbf421a6eb5b169cda',1,'nc::coordinates::RA::seconds()'],['../classnc_1_1coordinates_1_1_dec.html#a2927e30c2059f09bd30be622cf9b52ea',1,'nc::coordinates::Dec::seconds()']]], + ['seconds_5fper_5fday_983',['SECONDS_PER_DAY',['../namespacenc_1_1constants.html#a766ec3bf1f6fb57f586f943cea1946c3',1,'nc::constants']]], + ['seconds_5fper_5fhour_984',['SECONDS_PER_HOUR',['../namespacenc_1_1constants.html#ad635a54557e853e1ee098d0ead5f1902',1,'nc::constants']]], + ['seconds_5fper_5fminute_985',['SECONDS_PER_MINUTE',['../namespacenc_1_1constants.html#ad89620cbdf9102f40ec7c0fd52c16a5e',1,'nc::constants']]], + ['seconds_5fper_5fweek_986',['SECONDS_PER_WEEK',['../namespacenc_1_1constants.html#ac36cac5f19ce5f81b2acc562f247f0be',1,'nc::constants']]], + ['seed_987',['seed',['../namespacenc_1_1random.html#a93fe76208181d041adb08a02de0966d8',1,'nc::random']]], + ['select_988',['select',['../namespacenc.html#aab95eb9e265a3daf251b7e1926a42dac',1,'nc::select(const std::vector< const NdArray< bool > * > &condVec, const std::vector< const NdArray< dtype > * > &choiceVec, dtype defaultValue=dtype{0})'],['../namespacenc.html#acbb2b67807944a713b19844d2fe3dcc6',1,'nc::select(const std::vector< NdArray< bool >> &condList, const std::vector< NdArray< dtype >> &choiceList, dtype defaultValue=dtype{0})']]], + ['select_2ehpp_989',['select.hpp',['../select_8hpp.html',1,'']]], + ['set_5fdifference_990',['set_difference',['../namespacenc_1_1stl__algorithms.html#a8a145ff0f4cf32b64e7464347d1ea9b2',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a8cc83e2fb7a3d8302db0f4b19513ddd9',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination)']]], + ['set_5fintersection_991',['set_intersection',['../namespacenc_1_1stl__algorithms.html#ad9a963ad13c86117f01fe2960525e074',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#aa8ff8c5bb6003ff0f02a17deb4ced8e2',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], + ['set_5funion_992',['set_union',['../namespacenc_1_1stl__algorithms.html#a33da2f830ebf2e7c04f1ac94e1ad20b7',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a273ff7212f84bcd8de30e83ab0ae3bd1',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], + ['setdiff1d_993',['setdiff1d',['../namespacenc.html#adb6b7ca658c4d613fe0c4a695ba3542b',1,'nc']]], + ['setdiff1d_2ehpp_994',['setdiff1d.hpp',['../setdiff1d_8hpp.html',1,'']]], + ['setname_995',['setName',['../classnc_1_1_timer.html#a88dd680a63b38ae9989a40878a8fd65b',1,'nc::Timer']]], + ['shape_996',['Shape',['../classnc_1_1_shape.html',1,'nc']]], + ['shape_997',['shape',['../namespacenc.html#ae2b224742bc8263190d451a44ebe5e34',1,'nc::shape()'],['../classnc_1_1_data_cube.html#a1e7e4ce08e0c57abb661a8f95192173e',1,'nc::DataCube::shape()'],['../classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4',1,'nc::NdArray::shape()']]], + ['shape_998',['Shape',['../classnc_1_1_shape.html#a0f41587a1b8f1c2b65035adc49705eec',1,'nc::Shape::Shape()=default'],['../classnc_1_1_shape.html#a6e870e9fda60c8e82996802fcb71490a',1,'nc::Shape::Shape(uint32 inSquareSize) noexcept'],['../classnc_1_1_shape.html#a4b2cd200804257d9c53084f14fb38e31',1,'nc::Shape::Shape(uint32 inRows, uint32 inCols) noexcept']]], + ['shuffle_999',['shuffle',['../namespacenc_1_1random.html#ad73d56152095ad55887c89f47490c070',1,'nc::random']]], + ['shuffle_2ehpp_1000',['shuffle.hpp',['../shuffle_8hpp.html',1,'']]], + ['sign_1001',['sign',['../classnc_1_1coordinates_1_1_dec.html#ac551f7b1f2728f20fbdbd79dd00919f7',1,'nc::coordinates::Dec']]], + ['sign_1002',['Sign',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94',1,'nc::coordinates']]], + ['sign_1003',['sign',['../namespacenc.html#a4a5d98f334e0b50a3cf9c2718485e5e9',1,'nc::sign(dtype inValue) noexcept'],['../namespacenc.html#a22372b41fc480a7284967d2be4b87841',1,'nc::sign(const NdArray< dtype > &inArray)']]], + ['sign_2ehpp_1004',['sign.hpp',['../sign_8hpp.html',1,'']]], + ['signbit_1005',['signbit',['../namespacenc.html#af6dcbdfea85cdc84b4ddcf6c978b71f1',1,'nc::signbit(dtype inValue) noexcept'],['../namespacenc.html#a09632f5c6c5d569ccfde17351811b3c0',1,'nc::signbit(const NdArray< dtype > &inArray)']]], + ['signbit_2ehpp_1006',['signbit.hpp',['../signbit_8hpp.html',1,'']]], + ['simpson_1007',['simpson',['../namespacenc_1_1integrate.html#aa7c55b05139ecfce5e5a9d0380df9eb1',1,'nc::integrate']]], + ['simpson_2ehpp_1008',['simpson.hpp',['../simpson_8hpp.html',1,'']]], + ['sin_1009',['sin',['../namespacenc.html#a3fa4e582cdeef0716309ad51378f2983',1,'nc::sin(dtype inValue) noexcept'],['../namespacenc.html#aff909cb0ae96644487adaedbbb498cea',1,'nc::sin(const NdArray< dtype > &inArray)']]], + ['sin_2ehpp_1010',['sin.hpp',['../sin_8hpp.html',1,'']]], + ['sinc_1011',['sinc',['../namespacenc.html#aafe29b8d2e32e8e2af4d92074851b777',1,'nc::sinc(dtype inValue) noexcept'],['../namespacenc.html#a0c8e5bf6fca377445afd941d70bcac10',1,'nc::sinc(const NdArray< dtype > &inArray)']]], + ['sinc_2ehpp_1012',['sinc.hpp',['../sinc_8hpp.html',1,'']]], + ['sinh_1013',['sinh',['../namespacenc.html#a7672779bec72183de09ddc469739b385',1,'nc::sinh(dtype inValue) noexcept'],['../namespacenc.html#a8de43bfef3cdd2e1af1c521dcf3a2dcd',1,'nc::sinh(const NdArray< dtype > &inArray)']]], + ['sinh_2ehpp_1014',['sinh.hpp',['../sinh_8hpp.html',1,'']]], + ['size_1015',['size',['../namespacenc.html#a25f36ba02112a206936fae22b0724bb9',1,'nc::size()'],['../classnc_1_1_shape.html#ab29f87cc8479a2d0610a918cd9b08bbc',1,'nc::Shape::size()'],['../classnc_1_1image_processing_1_1_cluster.html#ae89900f4557d6273fc49b330417e324e',1,'nc::imageProcessing::Cluster::size()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae437071bfc291a36745d043ddd4cba1d',1,'nc::imageProcessing::ClusterMaker::size()'],['../classnc_1_1_nd_array.html#a055875abbe80163ca91328c0fa8ffbfa',1,'nc::NdArray::size()']]], + ['size_2ehpp_1016',['size.hpp',['../size_8hpp.html',1,'']]], + ['size_5ftype_1017',['size_type',['../classnc_1_1_nd_array_const_column_iterator.html#a99d31459bd356031b795095a38366706',1,'nc::NdArrayConstColumnIterator::size_type()'],['../classnc_1_1_nd_array_column_iterator.html#a845a41edc124e1c38ccf1940c02e272d',1,'nc::NdArrayColumnIterator::size_type()'],['../classnc_1_1_nd_array.html#ae2bdede667042f52176de3f3649735f6',1,'nc::NdArray::size_type()']]], + ['sizez_1018',['sizeZ',['../classnc_1_1_data_cube.html#a6518d36db671db4053abffff92505c64',1,'nc::DataCube']]], + ['sleep_1019',['sleep',['../classnc_1_1_timer.html#a9fec514ed605a11c6e1c321041960d7e',1,'nc::Timer']]], + ['slerp_1020',['slerp',['../classnc_1_1rotations_1_1_quaternion.html#a7a39f199e4d1ad773b93c69e66ae0415',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#a687155cd6469c095941b94a738119da9',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat2, double inPercent) const']]], + ['slice_1021',['Slice',['../classnc_1_1_slice.html',1,'nc::Slice'],['../classnc_1_1_slice.html#aeb2a7e0854fa82d97a48a5ef402d6e7c',1,'nc::Slice::Slice()=default'],['../classnc_1_1_slice.html#aa54f0fae63ece8ff87455e2192d8f336',1,'nc::Slice::Slice(int32 inStop) noexcept'],['../classnc_1_1_slice.html#aba1f6c8193f0a61a3f5711edd58aeba1',1,'nc::Slice::Slice(int32 inStart, int32 inStop) noexcept'],['../classnc_1_1_slice.html#a91177c7ea9b87318232b8d916a487d38',1,'nc::Slice::Slice(int32 inStart, int32 inStop, int32 inStep) noexcept']]], + ['slice_2ehpp_1022',['Slice.hpp',['../_slice_8hpp.html',1,'']]], + ['slicez_1023',['sliceZ',['../classnc_1_1_data_cube.html#a71d00d236bd135a4a35212fb147ae905',1,'nc::DataCube::sliceZ(int32 inIndex, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#aacc3751540c1b3d79e177a6b93a383fb',1,'nc::DataCube::sliceZ(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a8164f497dd44a89d1c5a1aeb7ca92e55',1,'nc::DataCube::sliceZ(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a3bc1ba8251f5e788155d6a01727d1644',1,'nc::DataCube::sliceZ(Slice inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6e6629a0891235ea43e77389f93326cd',1,'nc::DataCube::sliceZ(int32 inRow, int32 inCol, Slice inSliceZ) const']]], + ['slicezall_1024',['sliceZAll',['../classnc_1_1_data_cube.html#a7297568496398f9d80ceef1b9b955bfa',1,'nc::DataCube::sliceZAll(int32 inIndex) const'],['../classnc_1_1_data_cube.html#a0f149a9a6dfc3644a95c7741bbe60ca6',1,'nc::DataCube::sliceZAll(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#af8c15897cf2ff42ddd86648583aee686',1,'nc::DataCube::sliceZAll(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#a1961f8bf37432ab59bba9a59206537bd',1,'nc::DataCube::sliceZAll(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a64c85bf44f454e917c635167e46301e9',1,'nc::DataCube::sliceZAll(Slice inRow, Slice inCol) const']]], + ['slicezallat_1025',['sliceZAllat',['../classnc_1_1_data_cube.html#aaf2cad6dc76e1342d72c8d0291062357',1,'nc::DataCube::sliceZAllat(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#a7dd2ceb0e7935647c31993c5db1d1d20',1,'nc::DataCube::sliceZAllat(int32 inIndex) const'],['../classnc_1_1_data_cube.html#ad404a350af85b9e99be4901c028ed487',1,'nc::DataCube::sliceZAllat(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#ae6f6216581c3824f862bad03fea73f45',1,'nc::DataCube::sliceZAllat(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a57aaf216577c8a696dbf1dbe6363297e',1,'nc::DataCube::sliceZAllat(Slice inRow, Slice inCol) const']]], + ['slicezat_1026',['sliceZat',['../classnc_1_1_data_cube.html#a2c4ac09094f98ca9de7e6f02aa8956a3',1,'nc::DataCube::sliceZat(Slice inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a70d350f869a1831a401522667b65639a',1,'nc::DataCube::sliceZat(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6f6bfc2ed7ec485877f0266f906342be',1,'nc::DataCube::sliceZat(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6075ed979ff9294f2ff0bd54bb928952',1,'nc::DataCube::sliceZat(int32 inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a435a6f90ee141a790af7c04557396baf',1,'nc::DataCube::sliceZat(int32 inIndex, Slice inSliceZ) const']]], + ['softmax_1027',['softmax',['../namespacenc_1_1special.html#a459176cc2a1b285e93c3ee5671294590',1,'nc::special']]], + ['softmax_2ehpp_1028',['softmax.hpp',['../softmax_8hpp.html',1,'']]], + ['solve_1029',['solve',['../classnc_1_1linalg_1_1_s_v_d.html#aa170c7ec6894fb30e115840d61bd58a1',1,'nc::linalg::SVD::solve()'],['../classnc_1_1roots_1_1_bisection.html#a1199a68b6f57fee8b24bfc59ffeff486',1,'nc::roots::Bisection::solve()'],['../classnc_1_1roots_1_1_brent.html#a3853981ca1113723006b6627d96d378b',1,'nc::roots::Brent::solve()'],['../classnc_1_1roots_1_1_dekker.html#a5da7506a8f371764d0fae321fe081111',1,'nc::roots::Dekker::solve()'],['../classnc_1_1roots_1_1_newton.html#aaed2535d1abdb0c6790aea60762ed789',1,'nc::roots::Newton::solve()'],['../classnc_1_1roots_1_1_secant.html#a3fefb4412402aa20eeabb85145463d70',1,'nc::roots::Secant::solve()'],['../namespacenc_1_1linalg.html#afe2a5221f8e22e671e9e6eb231516205',1,'nc::linalg::solve()']]], + ['solve_2ehpp_1030',['solve.hpp',['../solve_8hpp.html',1,'']]], + ['sort_1031',['sort',['../classnc_1_1_nd_array.html#a3c0a24c292c340c58a6da5526654f3bb',1,'nc::NdArray::sort()'],['../namespacenc_1_1stl__algorithms.html#a1d75d47f198fcc3693e87806d6ea8715',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a519432fa55645fab8162c354e387b1a6',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../namespacenc.html#a8273e1ecb5eafba97b7ed5b8f10a6cdf',1,'nc::sort()']]], + ['sort_2ehpp_1032',['sort.hpp',['../sort_8hpp.html',1,'']]], + ['special_2ehpp_1033',['Special.hpp',['../_special_8hpp.html',1,'']]], + ['spherical_5fbessel_5fjn_1034',['spherical_bessel_jn',['../namespacenc_1_1special.html#a979e99d8a1626829183e38f69486e263',1,'nc::special::spherical_bessel_jn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#aa7f12646500dfd811792934164f8f403',1,'nc::special::spherical_bessel_jn(uint32 inV, const NdArray< dtype > &inArrayX)']]], + ['spherical_5fbessel_5fjn_2ehpp_1035',['spherical_bessel_jn.hpp',['../spherical__bessel__jn_8hpp.html',1,'']]], + ['spherical_5fbessel_5fyn_1036',['spherical_bessel_yn',['../namespacenc_1_1special.html#a1628a418aa8896a4f9711083ac5579d5',1,'nc::special::spherical_bessel_yn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#a11378004d6f60a0ecf65470d071985b0',1,'nc::special::spherical_bessel_yn(uint32 inV, const NdArray< dtype > &inArrayX)']]], + ['spherical_5fbessel_5fyn_2ehpp_1037',['spherical_bessel_yn.hpp',['../spherical__bessel__yn_8hpp.html',1,'']]], + ['spherical_5fhankel_5f1_1038',['spherical_hankel_1',['../namespacenc_1_1special.html#a5c0f4be297580a6d46f89b851c948227',1,'nc::special::spherical_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a239954539e877214833b9cfe65f742db',1,'nc::special::spherical_hankel_1(dtype1 inV, const NdArray< dtype2 > &inArray)']]], + ['spherical_5fhankel_5f1_2ehpp_1039',['spherical_hankel_1.hpp',['../spherical__hankel__1_8hpp.html',1,'']]], + ['spherical_5fhankel_5f2_1040',['spherical_hankel_2',['../namespacenc_1_1special.html#aa0181306ece55cbaf50c65da8d215542',1,'nc::special::spherical_hankel_2(dtype1 inV, const NdArray< dtype2 > &inArray)'],['../namespacenc_1_1special.html#a767d00adf7283b45bd3b7ea4aab6c5ff',1,'nc::special::spherical_hankel_2(dtype1 inV, dtype2 inX)']]], + ['spherical_5fhankel_5f2_2ehpp_1041',['spherical_hankel_2.hpp',['../spherical__hankel__2_8hpp.html',1,'']]], + ['spherical_5fharmonic_1042',['spherical_harmonic',['../namespacenc_1_1polynomial.html#aa5bb22676f3f43eda1e7c0af04da376a',1,'nc::polynomial']]], + ['spherical_5fharmonic_2ehpp_1043',['spherical_harmonic.hpp',['../spherical__harmonic_8hpp.html',1,'']]], + ['spherical_5fharmonic_5fi_1044',['spherical_harmonic_i',['../namespacenc_1_1polynomial.html#a583c30981b9547a90ad7c33edbe041c1',1,'nc::polynomial']]], + ['spherical_5fharmonic_5fr_1045',['spherical_harmonic_r',['../namespacenc_1_1polynomial.html#a5ed971ca59899f372f28a53913796745',1,'nc::polynomial']]], + ['sqr_1046',['sqr',['../namespacenc_1_1utils.html#ae792e10a24b7e5b8291a6c31a28a4512',1,'nc::utils']]], + ['sqr_2ehpp_1047',['sqr.hpp',['../sqr_8hpp.html',1,'']]], + ['sqrt_1048',['sqrt',['../namespacenc.html#a941a5a1ffb61387495a6f23dc4036287',1,'nc::sqrt(dtype inValue) noexcept'],['../namespacenc.html#abb4086978f52185f25340b0ff57ca8f0',1,'nc::sqrt(const NdArray< dtype > &inArray)']]], + ['sqrt_2ehpp_1049',['sqrt.hpp',['../sqrt_8hpp.html',1,'']]], + ['square_1050',['square',['../namespacenc.html#a104a8ffcdf7d3911fb6d4bbb847e2a1d',1,'nc::square(const NdArray< dtype > &inArray)'],['../namespacenc.html#a282e72a93afe2e6554e0f17f21dd7b9e',1,'nc::square(dtype inValue) noexcept']]], + ['square_2ehpp_1051',['square.hpp',['../square_8hpp.html',1,'']]], + ['stable_5fsort_1052',['stable_sort',['../namespacenc_1_1stl__algorithms.html#a7b2c4b6a3ef5cc55ebdae2aa757d1874',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a3b9f4bb9ba9a3ea8d8f97258eaa732d9',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last) noexcept']]], + ['stack_1053',['stack',['../namespacenc.html#a59f5a937dedc01a2aee57788d80d2912',1,'nc']]], + ['stack_2ehpp_1054',['stack.hpp',['../stack_8hpp.html',1,'']]], + ['standardnormal_1055',['standardNormal',['../namespacenc_1_1random.html#acc9d03c66c1fa8b35dea3fa0a0f075e7',1,'nc::random::standardNormal()'],['../namespacenc_1_1random.html#a026e31e4ef305beb2bbb546817e44eb0',1,'nc::random::standardNormal(const Shape &inShape)']]], + ['standardnormal_2ehpp_1056',['standardNormal.hpp',['../standard_normal_8hpp.html',1,'']]], + ['start_1057',['start',['../classnc_1_1_slice.html#a36ddb261d9057db4a9794b4fc46e9d3f',1,'nc::Slice']]], + ['static_5fassert_5farithmetic_1058',['STATIC_ASSERT_ARITHMETIC',['../_static_asserts_8hpp.html#a36abb32368b91aed0d3133a4cfd5ae92',1,'StaticAsserts.hpp']]], + ['static_5fassert_5farithmetic_5for_5fcomplex_1059',['STATIC_ASSERT_ARITHMETIC_OR_COMPLEX',['../_static_asserts_8hpp.html#a1589f74d429e30786c65cda69b17ab96',1,'StaticAsserts.hpp']]], + ['static_5fassert_5fcomplex_1060',['STATIC_ASSERT_COMPLEX',['../_static_asserts_8hpp.html#a1cd1b98c2b918cbd369afc12c11a0597',1,'StaticAsserts.hpp']]], + ['static_5fassert_5ffloat_1061',['STATIC_ASSERT_FLOAT',['../_static_asserts_8hpp.html#a0cd8e186da549fbdd918111d0302d973',1,'StaticAsserts.hpp']]], + ['static_5fassert_5finteger_1062',['STATIC_ASSERT_INTEGER',['../_static_asserts_8hpp.html#a187660686583e9047c0cf4424259ad10',1,'StaticAsserts.hpp']]], + ['static_5fassert_5fvalid_5fdtype_1063',['STATIC_ASSERT_VALID_DTYPE',['../_static_asserts_8hpp.html#a00cfe1ea01e56fe28ffe3d6ce5cae468',1,'StaticAsserts.hpp']]], + ['staticasserts_2ehpp_1064',['StaticAsserts.hpp',['../_static_asserts_8hpp.html',1,'']]], + ['stdcomplexoperators_2ehpp_1065',['StdComplexOperators.hpp',['../_std_complex_operators_8hpp.html',1,'']]], + ['stdev_1066',['stdev',['../namespacenc.html#ae197a8efaeeebe00c6e886b779ec1a43',1,'nc::stdev(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a60ac1ab2f35e50531ef0f12be00d89c8',1,'nc::stdev(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['stdev_2ehpp_1067',['stdev.hpp',['../stdev_8hpp.html',1,'']]], + ['step_1068',['step',['../classnc_1_1_slice.html#a112855a11aa1737b7859e3d63feb09c4',1,'nc::Slice']]], + ['stlalgorithms_2ehpp_1069',['StlAlgorithms.hpp',['../_stl_algorithms_8hpp.html',1,'']]], + ['stop_1070',['stop',['../classnc_1_1_slice.html#ac2d72f4ca003ed645bc82efcafee87f5',1,'nc::Slice']]], + ['str_1071',['str',['../classnc_1_1coordinates_1_1_coordinate.html#a04a60dd7bc2ef5be41c8006e2797997f',1,'nc::coordinates::Coordinate::str()'],['../classnc_1_1rotations_1_1_quaternion.html#a0ddeeba7435df3364f262215f24c93c1',1,'nc::rotations::Quaternion::str()'],['../classnc_1_1coordinates_1_1_dec.html#a91ddbec1fadfdcc049930dc439da4608',1,'nc::coordinates::Dec::str()'],['../classnc_1_1coordinates_1_1_r_a.html#a37824a93eb9e0a02237d4e654040761b',1,'nc::coordinates::RA::str()'],['../classnc_1_1_shape.html#aadb0e0d633d64e5eb5a4f9bef12b26c4',1,'nc::Shape::str()'],['../classnc_1_1_slice.html#af8bc3bb19b48fd09c769fd1fa9860ed5',1,'nc::Slice::str()'],['../classnc_1_1image_processing_1_1_centroid.html#aa39ae81638b8f7ed7b81d4476e2a6316',1,'nc::imageProcessing::Centroid::str()'],['../classnc_1_1image_processing_1_1_cluster.html#aaa1ee55d0c47196847b8bb1a76258bd3',1,'nc::imageProcessing::Cluster::str()'],['../classnc_1_1image_processing_1_1_pixel.html#ae47f279d2f0ba0921027e787e3773ee8',1,'nc::imageProcessing::Pixel::str()'],['../classnc_1_1_nd_array.html#aa44f94cc8d02a56636223686f30d84f1',1,'nc::NdArray::str()'],['../classnc_1_1polynomial_1_1_poly1d.html#aa5c091077a037bab14a1c558ece21435',1,'nc::polynomial::Poly1d::str()']]], + ['studentt_1072',['studentT',['../namespacenc_1_1random.html#a9e8074cb89e2362b5ae485834f550217',1,'nc::random::studentT(dtype inDof)'],['../namespacenc_1_1random.html#a5c18c6c123083003f32344baeb0f4ad3',1,'nc::random::studentT(const Shape &inShape, dtype inDof)']]], + ['studentt_2ehpp_1073',['studentT.hpp',['../student_t_8hpp.html',1,'']]], + ['subtract_1074',['subtract',['../namespacenc.html#ae4be1086253a0b121695d9cabfcb86ce',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#afa4586729c62bfae485a6e7664ba7117',1,'nc::subtract(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a7851e0af8b7501f667e2d89738259191',1,'nc::subtract(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a0499ac58fc4cfe52a2bba30f70376d84',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a8aae2ea3fcf6335997c10676fafcd1e5',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#acddd661c047325c1c0c473aa545011d9',1,'nc::subtract(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7f2189bdc8a3718be82a8497cd2ea99d',1,'nc::subtract(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a8668e0f6416572f18cf0d8c2e008784a',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a29da51134625301935f0e1098111e74b',1,'nc::subtract(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], + ['subtract_2ehpp_1075',['subtract.hpp',['../subtract_8hpp.html',1,'']]], + ['sum_1076',['sum',['../classnc_1_1_nd_array.html#a467700098b002b5631c756ca0fd50cae',1,'nc::NdArray::sum()'],['../namespacenc.html#aa14c0f092bfdc980c656bf6bf58bfc67',1,'nc::sum()']]], + ['sum_2ehpp_1077',['sum.hpp',['../sum_8hpp.html',1,'']]], + ['svd_1078',['SVD',['../classnc_1_1linalg_1_1_s_v_d.html',1,'nc::linalg::SVD'],['../classnc_1_1linalg_1_1_s_v_d.html#ae0561bbc9633e436139258b0c70b98ba',1,'nc::linalg::SVD::SVD()']]], + ['svd_1079',['svd',['../namespacenc_1_1linalg.html#acb38ad2613d50422afc539d005159055',1,'nc::linalg']]], + ['svd_2ehpp_1080',['svd.hpp',['../svd_8hpp.html',1,'']]], + ['svdclass_2ehpp_1081',['SVDClass.hpp',['../_s_v_d_class_8hpp.html',1,'']]], + ['swap_1082',['swap',['../namespacenc.html#a39da0502565b913855379ea1439047e1',1,'nc']]], + ['swap_2ehpp_1083',['swap.hpp',['../swap_8hpp.html',1,'']]], + ['swapaxes_1084',['swapaxes',['../classnc_1_1_nd_array.html#a7995ba04b64061dfd931ac58c05826f2',1,'nc::NdArray::swapaxes()'],['../namespacenc.html#a9371c43ae0a95c53cdaaf97a5bbc1db7',1,'nc::swapaxes()']]], + ['swapaxes_2ehpp_1085',['swapaxes.hpp',['../swapaxes_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_13.html b/docs/doxygen/html/search/all_13.html index f79da6b21..51172c2f3 100644 --- a/docs/doxygen/html/search/all_13.html +++ b/docs/doxygen/html/search/all_13.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_13.js b/docs/doxygen/html/search/all_13.js index 442b8ef39..d7a20c42d 100644 --- a/docs/doxygen/html/search/all_13.js +++ b/docs/doxygen/html/search/all_13.js @@ -1,51 +1,51 @@ var searchData= [ - ['tan_1035',['tan',['../namespacenc.html#a50d3734603bda1d991baf0696a4b96ce',1,'nc::tan(dtype inValue) noexcept'],['../namespacenc.html#abf0186d9e6764cd8b2a5e1529046429b',1,'nc::tan(const NdArray< dtype > &inArray)']]], - ['tan_2ehpp_1036',['tan.hpp',['../tan_8hpp.html',1,'']]], - ['tanh_1037',['tanh',['../namespacenc.html#aadd0ed02db4a60f805766e7026c78438',1,'nc::tanh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a3d75639028d96fe20286a82740361c6e',1,'nc::tanh(dtype inValue) noexcept']]], - ['tanh_2ehpp_1038',['tanh.hpp',['../tanh_8hpp.html',1,'']]], - ['throw_5finvalid_5fargument_5ferror_1039',['THROW_INVALID_ARGUMENT_ERROR',['../_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd',1,'Error.hpp']]], - ['throw_5fruntime_5ferror_1040',['THROW_RUNTIME_ERROR',['../_error_8hpp.html#a0f0ce4acf1fd6032112a06ebc50bb05a',1,'Error.hpp']]], - ['throwerror_1041',['throwError',['../namespacenc_1_1error.html#ae23be92f797ad9d90604456bdf27092f',1,'nc::error']]], - ['tic_1042',['tic',['../classnc_1_1_timer.html#a4a08ec3e6ba7a7979cb9e72d0cf3f2f7',1,'nc::Timer']]], - ['tile_1043',['tile',['../namespacenc.html#ae4974bdf6c0bccbde88f70c5732fd361',1,'nc::tile(const NdArray< dtype > &inArray, const Shape &inReps)'],['../namespacenc.html#a01db30b2b68eb0dde0d8ffdc7b72dd53',1,'nc::tile(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], - ['tile_2ehpp_1044',['tile.hpp',['../tile_8hpp.html',1,'']]], - ['timepoint_1045',['TimePoint',['../classnc_1_1_timer.html#a29e54a50e709622942a33e70b1b1e8f6',1,'nc::Timer']]], - ['timer_1046',['Timer',['../classnc_1_1_timer.html',1,'nc::Timer< TimeUnit >'],['../classnc_1_1_timer.html#a4ede5d1d2cdf6b97bec93b0954ddb610',1,'nc::Timer::Timer(const std::string &inName)'],['../classnc_1_1_timer.html#a5dabfba271b3655326e46c633eabd70e',1,'nc::Timer::Timer()']]], - ['timer_2ehpp_1047',['Timer.hpp',['../_timer_8hpp.html',1,'']]], - ['toc_1048',['toc',['../classnc_1_1_timer.html#a317fde3b5e7444328adf6484e0ec832e',1,'nc::Timer']]], - ['todcm_1049',['toDCM',['../classnc_1_1rotations_1_1_quaternion.html#aaa79cb63eab5e2bee5101de41d9074f8',1,'nc::rotations::Quaternion']]], - ['tofile_1050',['tofile',['../namespacenc.html#adf3cdf51801e83c58bc58c606781467d',1,'nc::tofile(const NdArray< dtype > &inArray, const std::string &inFilename)'],['../namespacenc.html#a7dc5b27b93f5a921a39151714fa78d67',1,'nc::tofile(const NdArray< dtype > &inArray, const std::string &inFilename, const char inSep)'],['../classnc_1_1_nd_array.html#a25390a2e453495e50219103d389a62d1',1,'nc::NdArray::tofile(const std::string &inFilename, const char inSep) const'],['../classnc_1_1_nd_array.html#a3533a4192c58304b6be7035098d8e263',1,'nc::NdArray::tofile(const std::string &inFilename) const']]], - ['tofile_2ehpp_1051',['tofile.hpp',['../tofile_8hpp.html',1,'']]], - ['toindices_1052',['toIndices',['../classnc_1_1_nd_array.html#a151940b3a151f2d15354bb4a9cbb0852',1,'nc::NdArray']]], - ['tondarray_1053',['toNdArray',['../classnc_1_1rotations_1_1_quaternion.html#a4a11c1c0daf982f9367e4541e5735e71',1,'nc::rotations::Quaternion::toNdArray()'],['../classnc_1_1_vec2.html#ad5f0e922730d66c57630ae5c7847e15a',1,'nc::Vec2::toNdArray()'],['../classnc_1_1_vec3.html#a45dbcf0b972b41fc3bc78aac17288804',1,'nc::Vec3::toNdArray()']]], - ['tostlvector_1054',['toStlVector',['../namespacenc.html#adc9e0bf1da9c54cc65e95a72e795de6b',1,'nc::toStlVector()'],['../classnc_1_1_nd_array.html#a1fb3a21ab9c10a2684098df919b5b440',1,'nc::NdArray::toStlVector()']]], - ['tostlvector_2ehpp_1055',['toStlVector.hpp',['../to_stl_vector_8hpp.html',1,'']]], - ['tostring_1056',['toString',['../classnc_1_1_vec2.html#acd4277d3a9acded9199afef378e1907c',1,'nc::Vec2::toString()'],['../classnc_1_1_vec3.html#a29fad7279d8da7f78805fee0c6d73408',1,'nc::Vec3::toString()']]], - ['trace_1057',['trace',['../namespacenc.html#a4a75035db8c766b2cececb1f3e4d5b74',1,'nc::trace()'],['../classnc_1_1_nd_array.html#ad58c8cb32887059d77903ff4c224e9f3',1,'nc::NdArray::trace()']]], - ['trace_2ehpp_1058',['trace.hpp',['../trace_8hpp.html',1,'']]], - ['transform_1059',['transform',['../namespacenc_1_1stl__algorithms.html#af358fec5563ae500162b310fe263a36d',1,'nc::stl_algorithms::transform(InputIt1 first1, InputIt1 last1, InputIt2 first2, OutputIt destination, BinaryOperation unaryFunction)'],['../namespacenc_1_1stl__algorithms.html#a616d5dabd547326285946d0014361ab4',1,'nc::stl_algorithms::transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)']]], - ['transpose_1060',['transpose',['../classnc_1_1_nd_array.html#a78c99f8306415d8e0ac0e03bb69c6d29',1,'nc::NdArray::transpose()'],['../namespacenc.html#aa6c78ac10e4c3aa446716f80aa1a72ca',1,'nc::transpose()']]], - ['transpose_2ehpp_1061',['transpose.hpp',['../transpose_8hpp.html',1,'']]], - ['trapazoidal_1062',['trapazoidal',['../namespacenc_1_1integrate.html#acdfbecb87f7780b2961eb4e5d3b3d109',1,'nc::integrate']]], - ['trapazoidal_2ehpp_1063',['trapazoidal.hpp',['../trapazoidal_8hpp.html',1,'']]], - ['trapz_1064',['trapz',['../namespacenc.html#a956571b2c934b75025e9168e2ed408f5',1,'nc::trapz(const NdArray< dtype > &inArrayY, const NdArray< dtype > &inArrayX, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ad9d00f10d75f795a2f4cbdfb99776637',1,'nc::trapz(const NdArray< dtype > &inArray, double dx=1.0, Axis inAxis=Axis::NONE)']]], - ['trapz_2ehpp_1065',['trapz.hpp',['../trapz_8hpp.html',1,'']]], - ['tri_2ehpp_1066',['tri.hpp',['../tri_8hpp.html',1,'']]], - ['triangle_1067',['triangle',['../namespacenc_1_1random.html#abaeed48339244cfb7f214c7238b13e8b',1,'nc::random::triangle(const Shape &inShape, dtype inA=0, dtype inB=0.5, dtype inC=1)'],['../namespacenc_1_1random.html#a3dd603264757ce4334bfc0b989cd4503',1,'nc::random::triangle(dtype inA=0, dtype inB=0.5, dtype inC=1)']]], - ['triangle_2ehpp_1068',['triangle.hpp',['../triangle_8hpp.html',1,'']]], - ['trigamma_1069',['trigamma',['../namespacenc_1_1special.html#a8f98455b0421ab89f4722377d9606091',1,'nc::special::trigamma(dtype inValue)'],['../namespacenc_1_1special.html#a0df9137d28cb3421435b464cbc482d5b',1,'nc::special::trigamma(const NdArray< dtype > &inArray)']]], - ['trigamma_2ehpp_1070',['trigamma.hpp',['../trigamma_8hpp.html',1,'']]], - ['tril_1071',['tril',['../namespacenc.html#a7c46d843ef0c6ea562cb89f9732d89ab',1,'nc::tril(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#aa5530b43e1ccdeeaded7a26fdcb43798',1,'nc::tril(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a0fc9894890a23f64d3a676f595920a9a',1,'nc::tril(const NdArray< dtype > &inArray, int32 inOffset=0)']]], - ['trim_5fzeros_1072',['trim_zeros',['../namespacenc.html#a56a856c99dddd37fe14d5639dd6c5622',1,'nc']]], - ['trim_5fzeros_2ehpp_1073',['trim_zeros.hpp',['../trim__zeros_8hpp.html',1,'']]], - ['trimboundary1d_1074',['trimBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#abe0b187c76c106e821b9ff94ef280d39',1,'nc::filter::boundary']]], - ['trimboundary1d_2ehpp_1075',['trimBoundary1d.hpp',['../trim_boundary1d_8hpp.html',1,'']]], - ['trimboundary2d_1076',['trimBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#aeff17b6fddc47bd2220fb912b2429162',1,'nc::filter::boundary']]], - ['trimboundary2d_2ehpp_1077',['trimBoundary2d.hpp',['../trim_boundary2d_8hpp.html',1,'']]], - ['triu_1078',['triu',['../namespacenc.html#a6719a9ad06f8286f1a18f91df4d9b049',1,'nc::triu(const NdArray< dtype > &inArray, int32 inOffset=0)'],['../namespacenc.html#a05c4de5a2c55f32884dec4b1d5634a36',1,'nc::triu(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#ab8fb31254bc1cdd83667f4f2ac3604c8',1,'nc::triu(uint32 inN, int32 inOffset=0)']]], - ['trunc_1079',['trunc',['../namespacenc.html#adaf8b7ce0ee9ec1b91c27f5e6df30cfc',1,'nc::trunc(const NdArray< dtype > &inArray)'],['../namespacenc.html#ac83a50ef99e61f116a86df98196f4a8b',1,'nc::trunc(dtype inValue) noexcept']]], - ['trunc_2ehpp_1080',['trunc.hpp',['../trunc_8hpp.html',1,'']]], - ['types_2ehpp_1081',['Types.hpp',['../_types_8hpp.html',1,'']]], - ['typetraits_2ehpp_1082',['TypeTraits.hpp',['../_type_traits_8hpp.html',1,'']]] + ['tan_1086',['tan',['../namespacenc.html#abf0186d9e6764cd8b2a5e1529046429b',1,'nc::tan(const NdArray< dtype > &inArray)'],['../namespacenc.html#a50d3734603bda1d991baf0696a4b96ce',1,'nc::tan(dtype inValue) noexcept']]], + ['tan_2ehpp_1087',['tan.hpp',['../tan_8hpp.html',1,'']]], + ['tanh_1088',['tanh',['../namespacenc.html#aadd0ed02db4a60f805766e7026c78438',1,'nc::tanh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a3d75639028d96fe20286a82740361c6e',1,'nc::tanh(dtype inValue) noexcept']]], + ['tanh_2ehpp_1089',['tanh.hpp',['../tanh_8hpp.html',1,'']]], + ['throw_5finvalid_5fargument_5ferror_1090',['THROW_INVALID_ARGUMENT_ERROR',['../_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd',1,'Error.hpp']]], + ['throw_5fruntime_5ferror_1091',['THROW_RUNTIME_ERROR',['../_error_8hpp.html#a0f0ce4acf1fd6032112a06ebc50bb05a',1,'Error.hpp']]], + ['throwerror_1092',['throwError',['../namespacenc_1_1error.html#ae23be92f797ad9d90604456bdf27092f',1,'nc::error']]], + ['tic_1093',['tic',['../classnc_1_1_timer.html#a4a08ec3e6ba7a7979cb9e72d0cf3f2f7',1,'nc::Timer']]], + ['tile_1094',['tile',['../namespacenc.html#ae4974bdf6c0bccbde88f70c5732fd361',1,'nc::tile(const NdArray< dtype > &inArray, const Shape &inReps)'],['../namespacenc.html#a01db30b2b68eb0dde0d8ffdc7b72dd53',1,'nc::tile(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], + ['tile_2ehpp_1095',['tile.hpp',['../tile_8hpp.html',1,'']]], + ['timepoint_1096',['TimePoint',['../classnc_1_1_timer.html#a29e54a50e709622942a33e70b1b1e8f6',1,'nc::Timer']]], + ['timer_1097',['Timer',['../classnc_1_1_timer.html',1,'nc::Timer< TimeUnit >'],['../classnc_1_1_timer.html#a5dabfba271b3655326e46c633eabd70e',1,'nc::Timer::Timer()'],['../classnc_1_1_timer.html#a4ede5d1d2cdf6b97bec93b0954ddb610',1,'nc::Timer::Timer(const std::string &inName)']]], + ['timer_2ehpp_1098',['Timer.hpp',['../_timer_8hpp.html',1,'']]], + ['toc_1099',['toc',['../classnc_1_1_timer.html#a317fde3b5e7444328adf6484e0ec832e',1,'nc::Timer']]], + ['todcm_1100',['toDCM',['../classnc_1_1rotations_1_1_quaternion.html#aaa79cb63eab5e2bee5101de41d9074f8',1,'nc::rotations::Quaternion']]], + ['tofile_1101',['tofile',['../classnc_1_1_nd_array.html#a25390a2e453495e50219103d389a62d1',1,'nc::NdArray::tofile()'],['../namespacenc.html#adf3cdf51801e83c58bc58c606781467d',1,'nc::tofile()'],['../classnc_1_1_nd_array.html#a3533a4192c58304b6be7035098d8e263',1,'nc::NdArray::tofile()'],['../namespacenc.html#a7dc5b27b93f5a921a39151714fa78d67',1,'nc::tofile()']]], + ['tofile_2ehpp_1102',['tofile.hpp',['../tofile_8hpp.html',1,'']]], + ['toindices_1103',['toIndices',['../classnc_1_1_nd_array.html#a151940b3a151f2d15354bb4a9cbb0852',1,'nc::NdArray']]], + ['tondarray_1104',['toNdArray',['../classnc_1_1rotations_1_1_quaternion.html#a4a11c1c0daf982f9367e4541e5735e71',1,'nc::rotations::Quaternion::toNdArray()'],['../classnc_1_1_vec2.html#ad5f0e922730d66c57630ae5c7847e15a',1,'nc::Vec2::toNdArray()'],['../classnc_1_1_vec3.html#a45dbcf0b972b41fc3bc78aac17288804',1,'nc::Vec3::toNdArray()']]], + ['tostlvector_1105',['toStlVector',['../classnc_1_1_nd_array.html#a1fb3a21ab9c10a2684098df919b5b440',1,'nc::NdArray::toStlVector()'],['../namespacenc.html#adc9e0bf1da9c54cc65e95a72e795de6b',1,'nc::toStlVector()']]], + ['tostlvector_2ehpp_1106',['toStlVector.hpp',['../to_stl_vector_8hpp.html',1,'']]], + ['tostring_1107',['toString',['../classnc_1_1_vec2.html#acd4277d3a9acded9199afef378e1907c',1,'nc::Vec2::toString()'],['../classnc_1_1_vec3.html#a29fad7279d8da7f78805fee0c6d73408',1,'nc::Vec3::toString()']]], + ['trace_1108',['trace',['../classnc_1_1_nd_array.html#ad58c8cb32887059d77903ff4c224e9f3',1,'nc::NdArray::trace()'],['../namespacenc.html#a4a75035db8c766b2cececb1f3e4d5b74',1,'nc::trace()']]], + ['trace_2ehpp_1109',['trace.hpp',['../trace_8hpp.html',1,'']]], + ['transform_1110',['transform',['../namespacenc_1_1stl__algorithms.html#a616d5dabd547326285946d0014361ab4',1,'nc::stl_algorithms::transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)'],['../namespacenc_1_1stl__algorithms.html#af358fec5563ae500162b310fe263a36d',1,'nc::stl_algorithms::transform(InputIt1 first1, InputIt1 last1, InputIt2 first2, OutputIt destination, BinaryOperation unaryFunction)']]], + ['transpose_1111',['transpose',['../classnc_1_1_nd_array.html#a78c99f8306415d8e0ac0e03bb69c6d29',1,'nc::NdArray::transpose()'],['../namespacenc.html#aa6c78ac10e4c3aa446716f80aa1a72ca',1,'nc::transpose()']]], + ['transpose_2ehpp_1112',['transpose.hpp',['../transpose_8hpp.html',1,'']]], + ['trapazoidal_1113',['trapazoidal',['../namespacenc_1_1integrate.html#acdfbecb87f7780b2961eb4e5d3b3d109',1,'nc::integrate']]], + ['trapazoidal_2ehpp_1114',['trapazoidal.hpp',['../trapazoidal_8hpp.html',1,'']]], + ['trapz_1115',['trapz',['../namespacenc.html#ad9d00f10d75f795a2f4cbdfb99776637',1,'nc::trapz(const NdArray< dtype > &inArray, double dx=1.0, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a956571b2c934b75025e9168e2ed408f5',1,'nc::trapz(const NdArray< dtype > &inArrayY, const NdArray< dtype > &inArrayX, Axis inAxis=Axis::NONE)']]], + ['trapz_2ehpp_1116',['trapz.hpp',['../trapz_8hpp.html',1,'']]], + ['tri_2ehpp_1117',['tri.hpp',['../tri_8hpp.html',1,'']]], + ['triangle_1118',['triangle',['../namespacenc_1_1random.html#a3dd603264757ce4334bfc0b989cd4503',1,'nc::random::triangle(dtype inA=0, dtype inB=0.5, dtype inC=1)'],['../namespacenc_1_1random.html#abaeed48339244cfb7f214c7238b13e8b',1,'nc::random::triangle(const Shape &inShape, dtype inA=0, dtype inB=0.5, dtype inC=1)']]], + ['triangle_2ehpp_1119',['triangle.hpp',['../triangle_8hpp.html',1,'']]], + ['trigamma_1120',['trigamma',['../namespacenc_1_1special.html#a8f98455b0421ab89f4722377d9606091',1,'nc::special::trigamma(dtype inValue)'],['../namespacenc_1_1special.html#a0df9137d28cb3421435b464cbc482d5b',1,'nc::special::trigamma(const NdArray< dtype > &inArray)']]], + ['trigamma_2ehpp_1121',['trigamma.hpp',['../trigamma_8hpp.html',1,'']]], + ['tril_1122',['tril',['../namespacenc.html#aa5530b43e1ccdeeaded7a26fdcb43798',1,'nc::tril(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a7c46d843ef0c6ea562cb89f9732d89ab',1,'nc::tril(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#a0fc9894890a23f64d3a676f595920a9a',1,'nc::tril(const NdArray< dtype > &inArray, int32 inOffset=0)']]], + ['trim_5fzeros_1123',['trim_zeros',['../namespacenc.html#a56a856c99dddd37fe14d5639dd6c5622',1,'nc']]], + ['trim_5fzeros_2ehpp_1124',['trim_zeros.hpp',['../trim__zeros_8hpp.html',1,'']]], + ['trimboundary1d_1125',['trimBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#abe0b187c76c106e821b9ff94ef280d39',1,'nc::filter::boundary']]], + ['trimboundary1d_2ehpp_1126',['trimBoundary1d.hpp',['../trim_boundary1d_8hpp.html',1,'']]], + ['trimboundary2d_1127',['trimBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#aeff17b6fddc47bd2220fb912b2429162',1,'nc::filter::boundary']]], + ['trimboundary2d_2ehpp_1128',['trimBoundary2d.hpp',['../trim_boundary2d_8hpp.html',1,'']]], + ['triu_1129',['triu',['../namespacenc.html#a05c4de5a2c55f32884dec4b1d5634a36',1,'nc::triu(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#ab8fb31254bc1cdd83667f4f2ac3604c8',1,'nc::triu(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a6719a9ad06f8286f1a18f91df4d9b049',1,'nc::triu(const NdArray< dtype > &inArray, int32 inOffset=0)']]], + ['trunc_1130',['trunc',['../namespacenc.html#ac83a50ef99e61f116a86df98196f4a8b',1,'nc::trunc(dtype inValue) noexcept'],['../namespacenc.html#adaf8b7ce0ee9ec1b91c27f5e6df30cfc',1,'nc::trunc(const NdArray< dtype > &inArray)']]], + ['trunc_2ehpp_1131',['trunc.hpp',['../trunc_8hpp.html',1,'']]], + ['types_2ehpp_1132',['Types.hpp',['../_types_8hpp.html',1,'']]], + ['typetraits_2ehpp_1133',['TypeTraits.hpp',['../_type_traits_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_14.html b/docs/doxygen/html/search/all_14.html index 9be989321..afecf5634 100644 --- a/docs/doxygen/html/search/all_14.html +++ b/docs/doxygen/html/search/all_14.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_14.js b/docs/doxygen/html/search/all_14.js index b69be193d..36411dc66 100644 --- a/docs/doxygen/html/search/all_14.js +++ b/docs/doxygen/html/search/all_14.js @@ -1,29 +1,29 @@ var searchData= [ - ['cube_2ehpp_1083',['cube.hpp',['../_utils_2cube_8hpp.html',1,'']]], - ['interp_2ehpp_1084',['interp.hpp',['../_utils_2interp_8hpp.html',1,'']]], - ['power_2ehpp_1085',['power.hpp',['../_utils_2power_8hpp.html',1,'']]], - ['powerf_2ehpp_1086',['powerf.hpp',['../_utils_2powerf_8hpp.html',1,'']]], - ['u_1087',['u',['../classnc_1_1linalg_1_1_s_v_d.html#a0f7dddedc38be47b051aa16e5dc9d6b2',1,'nc::linalg::SVD']]], - ['uint16_1088',['uint16',['../namespacenc.html#a8146518cf6c6a8029c3d84a376167793',1,'nc']]], - ['uint32_1089',['uint32',['../namespacenc.html#af0f49663fb63332596e2e6327009d581',1,'nc']]], - ['uint64_1090',['uint64',['../namespacenc.html#a773f8535ba713f886e9e1b8378f6d76d',1,'nc']]], - ['uint8_1091',['uint8',['../namespacenc.html#a9ba5a0aa26753a185985b8273fb9062d',1,'nc']]], - ['uniform_1092',['uniform',['../namespacenc_1_1random.html#a1e31096d678b7e4be66f6c59d95e5445',1,'nc::random::uniform(const Shape &inShape, dtype inLow, dtype inHigh)'],['../namespacenc_1_1random.html#adbff3f6b80e512d4153b12bae9c6c732',1,'nc::random::uniform(dtype inLow, dtype inHigh)']]], - ['uniform_2ehpp_1093',['uniform.hpp',['../uniform_8hpp.html',1,'']]], - ['uniformfilter_1094',['uniformFilter',['../namespacenc_1_1filter.html#a9f41f17a6f7c06ebf7b1f3a1ab3915bb',1,'nc::filter']]], - ['uniformfilter_2ehpp_1095',['uniformFilter.hpp',['../uniform_filter_8hpp.html',1,'']]], - ['uniformfilter1d_1096',['uniformFilter1d',['../namespacenc_1_1filter.html#ab7f620c737fa95c983523c0950120cd9',1,'nc::filter']]], - ['uniformfilter1d_2ehpp_1097',['uniformFilter1d.hpp',['../uniform_filter1d_8hpp.html',1,'']]], - ['uniformonsphere_1098',['uniformOnSphere',['../namespacenc_1_1random.html#a2f18a1f7b9311d52bbdc4ae7a7b84be6',1,'nc::random']]], - ['uniformonsphere_2ehpp_1099',['uniformOnSphere.hpp',['../uniform_on_sphere_8hpp.html',1,'']]], - ['union1d_1100',['union1d',['../namespacenc.html#a38b544f6e77741848387a3a427579704',1,'nc']]], - ['union1d_2ehpp_1101',['union1d.hpp',['../union1d_8hpp.html',1,'']]], - ['unique_1102',['unique',['../namespacenc.html#ad4832f2be01449e48737aa0e06792494',1,'nc']]], - ['unique_2ehpp_1103',['unique.hpp',['../unique_8hpp.html',1,'']]], - ['unique_5fcopy_1104',['unique_copy',['../namespacenc_1_1stl__algorithms.html#a7cec030870d1f3b4d1c7caf26c8d907d',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination) noexcept'],['../namespacenc_1_1stl__algorithms.html#aefa150cdbb6a1110c2164a3970a317a8',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination, BinaryPredicate binaryFunction) noexcept']]], - ['unwrap_1105',['unwrap',['../namespacenc.html#aac5e942220c693fb9e65fcc3ff4fc50f',1,'nc::unwrap(dtype inValue) noexcept'],['../namespacenc.html#aff80ace967dcf63c32d235a7511c6018',1,'nc::unwrap(const NdArray< dtype > &inArray)']]], - ['unwrap_2ehpp_1106',['unwrap.hpp',['../unwrap_8hpp.html',1,'']]], - ['up_1107',['up',['../classnc_1_1_vec3.html#aafc14ccae575994733d664eb3f4a6e66',1,'nc::Vec3::up()'],['../classnc_1_1_vec2.html#a82fc65cffdae5c0ebd50fece54b56d4c',1,'nc::Vec2::up()']]], - ['utils_2ehpp_1108',['Utils.hpp',['../_utils_8hpp.html',1,'']]] + ['cube_2ehpp_1134',['cube.hpp',['../_utils_2cube_8hpp.html',1,'']]], + ['interp_2ehpp_1135',['interp.hpp',['../_utils_2interp_8hpp.html',1,'']]], + ['power_2ehpp_1136',['power.hpp',['../_utils_2power_8hpp.html',1,'']]], + ['powerf_2ehpp_1137',['powerf.hpp',['../_utils_2powerf_8hpp.html',1,'']]], + ['u_1138',['u',['../classnc_1_1linalg_1_1_s_v_d.html#a0f7dddedc38be47b051aa16e5dc9d6b2',1,'nc::linalg::SVD']]], + ['uint16_1139',['uint16',['../namespacenc.html#a8146518cf6c6a8029c3d84a376167793',1,'nc']]], + ['uint32_1140',['uint32',['../namespacenc.html#af0f49663fb63332596e2e6327009d581',1,'nc']]], + ['uint64_1141',['uint64',['../namespacenc.html#a773f8535ba713f886e9e1b8378f6d76d',1,'nc']]], + ['uint8_1142',['uint8',['../namespacenc.html#a9ba5a0aa26753a185985b8273fb9062d',1,'nc']]], + ['uniform_1143',['uniform',['../namespacenc_1_1random.html#adbff3f6b80e512d4153b12bae9c6c732',1,'nc::random::uniform(dtype inLow, dtype inHigh)'],['../namespacenc_1_1random.html#a1e31096d678b7e4be66f6c59d95e5445',1,'nc::random::uniform(const Shape &inShape, dtype inLow, dtype inHigh)']]], + ['uniform_2ehpp_1144',['uniform.hpp',['../uniform_8hpp.html',1,'']]], + ['uniformfilter_1145',['uniformFilter',['../namespacenc_1_1filter.html#a9f41f17a6f7c06ebf7b1f3a1ab3915bb',1,'nc::filter']]], + ['uniformfilter_2ehpp_1146',['uniformFilter.hpp',['../uniform_filter_8hpp.html',1,'']]], + ['uniformfilter1d_1147',['uniformFilter1d',['../namespacenc_1_1filter.html#ab7f620c737fa95c983523c0950120cd9',1,'nc::filter']]], + ['uniformfilter1d_2ehpp_1148',['uniformFilter1d.hpp',['../uniform_filter1d_8hpp.html',1,'']]], + ['uniformonsphere_1149',['uniformOnSphere',['../namespacenc_1_1random.html#a2f18a1f7b9311d52bbdc4ae7a7b84be6',1,'nc::random']]], + ['uniformonsphere_2ehpp_1150',['uniformOnSphere.hpp',['../uniform_on_sphere_8hpp.html',1,'']]], + ['union1d_1151',['union1d',['../namespacenc.html#a38b544f6e77741848387a3a427579704',1,'nc']]], + ['union1d_2ehpp_1152',['union1d.hpp',['../union1d_8hpp.html',1,'']]], + ['unique_1153',['unique',['../namespacenc.html#ad4832f2be01449e48737aa0e06792494',1,'nc']]], + ['unique_2ehpp_1154',['unique.hpp',['../unique_8hpp.html',1,'']]], + ['unique_5fcopy_1155',['unique_copy',['../namespacenc_1_1stl__algorithms.html#a7cec030870d1f3b4d1c7caf26c8d907d',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination) noexcept'],['../namespacenc_1_1stl__algorithms.html#aefa150cdbb6a1110c2164a3970a317a8',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination, BinaryPredicate binaryFunction) noexcept']]], + ['unwrap_1156',['unwrap',['../namespacenc.html#aac5e942220c693fb9e65fcc3ff4fc50f',1,'nc::unwrap(dtype inValue) noexcept'],['../namespacenc.html#aff80ace967dcf63c32d235a7511c6018',1,'nc::unwrap(const NdArray< dtype > &inArray)']]], + ['unwrap_2ehpp_1157',['unwrap.hpp',['../unwrap_8hpp.html',1,'']]], + ['up_1158',['up',['../classnc_1_1_vec2.html#a82fc65cffdae5c0ebd50fece54b56d4c',1,'nc::Vec2::up()'],['../classnc_1_1_vec3.html#aafc14ccae575994733d664eb3f4a6e66',1,'nc::Vec3::up()']]], + ['utils_2ehpp_1159',['Utils.hpp',['../_utils_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_15.html b/docs/doxygen/html/search/all_15.html index c31349869..69f382b31 100644 --- a/docs/doxygen/html/search/all_15.html +++ b/docs/doxygen/html/search/all_15.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_15.js b/docs/doxygen/html/search/all_15.js index 3d036f3c7..ffbfe4a86 100644 --- a/docs/doxygen/html/search/all_15.js +++ b/docs/doxygen/html/search/all_15.js @@ -1,19 +1,19 @@ var searchData= [ - ['v_1109',['v',['../classnc_1_1linalg_1_1_s_v_d.html#a6b907070cfa7e89c3107fa628694e274',1,'nc::linalg::SVD']]], - ['value_1110',['value',['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html#add526ed6ceb3045a816385e5c2c6d553',1,'nc::is_complex< std::complex< T > >::value()'],['../structnc_1_1is__complex.html#a273a78ae8b41cf81e633f259204ce5dd',1,'nc::is_complex::value()'],['../structnc_1_1is__valid__dtype.html#af383f42b2b624cc161c1748b98cc541e',1,'nc::is_valid_dtype::value()'],['../structnc_1_1all__same_3_01_t1_00_01_t2_01_4.html#a02b49e4936f586c2407c089400ee891f',1,'nc::all_same< T1, T2 >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_head_00_01_tail_8_8_8_01_4.html#a35efae6bdf247952d31021b7e811a653',1,'nc::all_same< T1, Head, Tail... >::value()'],['../structnc_1_1all__arithmetic_3_01_head_00_01_tail_8_8_8_01_4.html#a6e1a48ad3dc95bb666261cd0e3503f5c',1,'nc::all_arithmetic< Head, Tail... >::value()'],['../structnc_1_1all__arithmetic_3_01_t_01_4.html#aeb8a99e0539f9d4d01b6ac63dfe6c186',1,'nc::all_arithmetic< T >::value()']]], - ['value2str_1111',['value2str',['../namespacenc_1_1utils.html#a83530b13c9cc3b01b9bd8b8d3113290a',1,'nc::utils']]], - ['value2str_2ehpp_1112',['value2str.hpp',['../value2str_8hpp.html',1,'']]], - ['value_5ftype_1113',['value_type',['../classnc_1_1_nd_array_const_iterator.html#af4d3be6b1470162a26b34cdaa5a2addd',1,'nc::NdArrayConstIterator::value_type()'],['../classnc_1_1_nd_array.html#aed76b0d590eff875e09a6f0d7968e7db',1,'nc::NdArray::value_type()'],['../classnc_1_1_nd_array_iterator.html#adeb90525f10a8bf2748dafbb2ea154dc',1,'nc::NdArrayIterator::value_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3b124e1120c2fb329dcb5d81abe39e1d',1,'nc::NdArrayConstColumnIterator::value_type()'],['../classnc_1_1_nd_array_column_iterator.html#a7191b7c13b188f2a0abaf8477f0bd2d4',1,'nc::NdArrayColumnIterator::value_type()']]], - ['var_1114',['var',['../namespacenc.html#aeefabf8c851def135518ddded2bf5886',1,'nc::var(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a130dfd14b561ed4f0889fd2093f99d5f',1,'nc::var(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], - ['var_2ehpp_1115',['var.hpp',['../var_8hpp.html',1,'']]], - ['vec2_1116',['Vec2',['../classnc_1_1_vec2.html',1,'nc::Vec2'],['../classnc_1_1_vec2.html#a93a9f0c675265005a60c77179625ddd2',1,'nc::Vec2::Vec2(const NdArray< double > &ndArray)'],['../classnc_1_1_vec2.html#ae34b427d1b6560cce898bf61f9524a80',1,'nc::Vec2::Vec2()=default'],['../classnc_1_1_vec2.html#aeb48b0300990a5b77919589488ddfe30',1,'nc::Vec2::Vec2(double inX, double inY) noexcept'],['../classnc_1_1_vec2.html#abfb713c893dbd31d7c94b4741e82530b',1,'nc::Vec2::Vec2(const std::initializer_list< double > &inList)']]], - ['vec2_2ehpp_1117',['Vec2.hpp',['../_vec2_8hpp.html',1,'']]], - ['vec3_1118',['Vec3',['../classnc_1_1_vec3.html',1,'nc::Vec3'],['../classnc_1_1_vec3.html#adb18c9ba29affb8b712bb22a83e38e09',1,'nc::Vec3::Vec3()=default'],['../classnc_1_1_vec3.html#a6b0bc18cc9594a7d81361c518d543130',1,'nc::Vec3::Vec3(double inX, double inY, double inZ) noexcept'],['../classnc_1_1_vec3.html#a4056d1e369726710d6f1049b277486dd',1,'nc::Vec3::Vec3(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec3.html#a4668419f4c870900466d4aa198247767',1,'nc::Vec3::Vec3(const NdArray< double > &ndArray)']]], - ['vec3_2ehpp_1119',['Vec3.hpp',['../_vec3_8hpp.html',1,'']]], - ['vector_2ehpp_1120',['Vector.hpp',['../_vector_8hpp.html',1,'']]], - ['version_1121',['VERSION',['../namespacenc.html#a8fa2b5de82ba40f346d1ba1e3ad0397a',1,'nc']]], - ['version_2ehpp_1122',['Version.hpp',['../_version_8hpp.html',1,'']]], - ['vstack_1123',['vstack',['../namespacenc.html#a8dec1ff4db1d89ab4b3a7d32ff4b5cf3',1,'nc']]], - ['vstack_2ehpp_1124',['vstack.hpp',['../vstack_8hpp.html',1,'']]] + ['v_1160',['v',['../classnc_1_1linalg_1_1_s_v_d.html#a6b907070cfa7e89c3107fa628694e274',1,'nc::linalg::SVD']]], + ['value_1161',['value',['../structnc_1_1all__arithmetic_3_01_head_00_01_tail_8_8_8_01_4.html#a6e1a48ad3dc95bb666261cd0e3503f5c',1,'nc::all_arithmetic< Head, Tail... >::value()'],['../structnc_1_1all__arithmetic_3_01_t_01_4.html#aeb8a99e0539f9d4d01b6ac63dfe6c186',1,'nc::all_arithmetic< T >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_head_00_01_tail_8_8_8_01_4.html#a35efae6bdf247952d31021b7e811a653',1,'nc::all_same< T1, Head, Tail... >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_t2_01_4.html#a02b49e4936f586c2407c089400ee891f',1,'nc::all_same< T1, T2 >::value()'],['../structnc_1_1is__valid__dtype.html#af383f42b2b624cc161c1748b98cc541e',1,'nc::is_valid_dtype::value()'],['../structnc_1_1is__complex.html#a273a78ae8b41cf81e633f259204ce5dd',1,'nc::is_complex::value()'],['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html#add526ed6ceb3045a816385e5c2c6d553',1,'nc::is_complex< std::complex< T > >::value()'],['../structnc_1_1greater_than.html#a6664c509bb1b73d1547aeffa4ea2afec',1,'nc::greaterThan::value()']]], + ['value2str_1162',['value2str',['../namespacenc_1_1utils.html#a83530b13c9cc3b01b9bd8b8d3113290a',1,'nc::utils']]], + ['value2str_2ehpp_1163',['value2str.hpp',['../value2str_8hpp.html',1,'']]], + ['value_5ftype_1164',['value_type',['../classnc_1_1_nd_array.html#aed76b0d590eff875e09a6f0d7968e7db',1,'nc::NdArray::value_type()'],['../classnc_1_1_nd_array_column_iterator.html#a7191b7c13b188f2a0abaf8477f0bd2d4',1,'nc::NdArrayColumnIterator::value_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3b124e1120c2fb329dcb5d81abe39e1d',1,'nc::NdArrayConstColumnIterator::value_type()'],['../classnc_1_1_nd_array_iterator.html#adeb90525f10a8bf2748dafbb2ea154dc',1,'nc::NdArrayIterator::value_type()'],['../classnc_1_1_nd_array_const_iterator.html#af4d3be6b1470162a26b34cdaa5a2addd',1,'nc::NdArrayConstIterator::value_type()']]], + ['var_1165',['var',['../namespacenc.html#aeefabf8c851def135518ddded2bf5886',1,'nc::var(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a130dfd14b561ed4f0889fd2093f99d5f',1,'nc::var(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['var_2ehpp_1166',['var.hpp',['../var_8hpp.html',1,'']]], + ['vec2_1167',['Vec2',['../classnc_1_1_vec2.html',1,'nc::Vec2'],['../classnc_1_1_vec2.html#ae34b427d1b6560cce898bf61f9524a80',1,'nc::Vec2::Vec2()=default'],['../classnc_1_1_vec2.html#aeb48b0300990a5b77919589488ddfe30',1,'nc::Vec2::Vec2(double inX, double inY) noexcept'],['../classnc_1_1_vec2.html#abfb713c893dbd31d7c94b4741e82530b',1,'nc::Vec2::Vec2(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec2.html#a93a9f0c675265005a60c77179625ddd2',1,'nc::Vec2::Vec2(const NdArray< double > &ndArray)']]], + ['vec2_2ehpp_1168',['Vec2.hpp',['../_vec2_8hpp.html',1,'']]], + ['vec3_1169',['Vec3',['../classnc_1_1_vec3.html',1,'nc::Vec3'],['../classnc_1_1_vec3.html#adb18c9ba29affb8b712bb22a83e38e09',1,'nc::Vec3::Vec3()=default'],['../classnc_1_1_vec3.html#a6b0bc18cc9594a7d81361c518d543130',1,'nc::Vec3::Vec3(double inX, double inY, double inZ) noexcept'],['../classnc_1_1_vec3.html#a4056d1e369726710d6f1049b277486dd',1,'nc::Vec3::Vec3(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec3.html#a4668419f4c870900466d4aa198247767',1,'nc::Vec3::Vec3(const NdArray< double > &ndArray)']]], + ['vec3_2ehpp_1170',['Vec3.hpp',['../_vec3_8hpp.html',1,'']]], + ['vector_2ehpp_1171',['Vector.hpp',['../_vector_8hpp.html',1,'']]], + ['version_1172',['VERSION',['../namespacenc.html#a8fa2b5de82ba40f346d1ba1e3ad0397a',1,'nc']]], + ['version_2ehpp_1173',['Version.hpp',['../_version_8hpp.html',1,'']]], + ['vstack_1174',['vstack',['../namespacenc.html#a5e1694cef7795a5fc4914b17d5272dd0',1,'nc']]], + ['vstack_2ehpp_1175',['vstack.hpp',['../vstack_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_16.html b/docs/doxygen/html/search/all_16.html index 5c2e4c0dc..b19867ad9 100644 --- a/docs/doxygen/html/search/all_16.html +++ b/docs/doxygen/html/search/all_16.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_16.js b/docs/doxygen/html/search/all_16.js index e8bef1144..de0e57d8d 100644 --- a/docs/doxygen/html/search/all_16.js +++ b/docs/doxygen/html/search/all_16.js @@ -1,18 +1,18 @@ var searchData= [ - ['wahbasproblem_1125',['wahbasProblem',['../namespacenc_1_1rotations.html#a6da89864a9512bbe69c848dad18220b4',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk)'],['../namespacenc_1_1rotations.html#a84a42f4e7f09b7c0e1a9307cb5b6f281',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk, const NdArray< dtype > &ak)']]], - ['wahbasproblem_2ehpp_1126',['wahbasProblem.hpp',['../wahbas_problem_8hpp.html',1,'']]], - ['weibull_1127',['weibull',['../namespacenc_1_1random.html#af3a48c59aaa59d37bb5177b962d02bde',1,'nc::random::weibull(const Shape &inShape, dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#a3cf0bdb15264c1ace4163042756a4765',1,'nc::random::weibull(dtype inA=1, dtype inB=1)']]], - ['weibull_2ehpp_1128',['weibull.hpp',['../weibull_8hpp.html',1,'']]], - ['where_1129',['where',['../namespacenc.html#ac0af750215d0444ad9f0208620ca206b',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a7191d45f29de05f27964f56f36c9be94',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, dtype inB)'],['../namespacenc.html#a446fff289053b687a994f9193941cd3f',1,'nc::where(const NdArray< bool > &inMask, dtype inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a39dbf48fd9094cc969f3d006788f2137',1,'nc::where(const NdArray< bool > &inMask, dtype inA, dtype inB)']]], - ['where_2ehpp_1130',['where.hpp',['../where_8hpp.html',1,'']]], - ['width_1131',['width',['../classnc_1_1image_processing_1_1_cluster.html#accbfd3dbb32016c0f4234614347d74ce',1,'nc::imageProcessing::Cluster']]], - ['windowexceedances_1132',['windowExceedances',['../namespacenc_1_1image_processing.html#a896adf0319f58a2f44cbf3dfaf550fe2',1,'nc::imageProcessing']]], - ['windowexceedances_2ehpp_1133',['windowExceedances.hpp',['../window_exceedances_8hpp.html',1,'']]], - ['withext_1134',['withExt',['../classnc_1_1filesystem_1_1_file.html#adde9dd84b2a023df3bb908e6b1c7030f',1,'nc::filesystem::File']]], - ['wrap_1135',['WRAP',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae1c8555fcf0ea2bb648a6fd527d658c0',1,'nc::filter']]], - ['wrap1d_1136',['wrap1d',['../namespacenc_1_1filter_1_1boundary.html#aa318761ec07aeb7764e2e5f0a7ec9e86',1,'nc::filter::boundary']]], - ['wrap1d_2ehpp_1137',['wrap1d.hpp',['../wrap1d_8hpp.html',1,'']]], - ['wrap2d_1138',['wrap2d',['../namespacenc_1_1filter_1_1boundary.html#aeace2e548cf6ecf3aaadbbf000cbead7',1,'nc::filter::boundary']]], - ['wrap2d_2ehpp_1139',['wrap2d.hpp',['../wrap2d_8hpp.html',1,'']]] + ['wahbasproblem_1176',['wahbasProblem',['../namespacenc_1_1rotations.html#a84a42f4e7f09b7c0e1a9307cb5b6f281',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk, const NdArray< dtype > &ak)'],['../namespacenc_1_1rotations.html#a6da89864a9512bbe69c848dad18220b4',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk)']]], + ['wahbasproblem_2ehpp_1177',['wahbasProblem.hpp',['../wahbas_problem_8hpp.html',1,'']]], + ['weibull_1178',['weibull',['../namespacenc_1_1random.html#a3cf0bdb15264c1ace4163042756a4765',1,'nc::random::weibull(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#af3a48c59aaa59d37bb5177b962d02bde',1,'nc::random::weibull(const Shape &inShape, dtype inA=1, dtype inB=1)']]], + ['weibull_2ehpp_1179',['weibull.hpp',['../weibull_8hpp.html',1,'']]], + ['where_1180',['where',['../namespacenc.html#ac0af750215d0444ad9f0208620ca206b',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a7191d45f29de05f27964f56f36c9be94',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, dtype inB)'],['../namespacenc.html#a446fff289053b687a994f9193941cd3f',1,'nc::where(const NdArray< bool > &inMask, dtype inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a39dbf48fd9094cc969f3d006788f2137',1,'nc::where(const NdArray< bool > &inMask, dtype inA, dtype inB)']]], + ['where_2ehpp_1181',['where.hpp',['../where_8hpp.html',1,'']]], + ['width_1182',['width',['../classnc_1_1image_processing_1_1_cluster.html#accbfd3dbb32016c0f4234614347d74ce',1,'nc::imageProcessing::Cluster']]], + ['windowexceedances_1183',['windowExceedances',['../namespacenc_1_1image_processing.html#a896adf0319f58a2f44cbf3dfaf550fe2',1,'nc::imageProcessing']]], + ['windowexceedances_2ehpp_1184',['windowExceedances.hpp',['../window_exceedances_8hpp.html',1,'']]], + ['withext_1185',['withExt',['../classnc_1_1filesystem_1_1_file.html#adde9dd84b2a023df3bb908e6b1c7030f',1,'nc::filesystem::File']]], + ['wrap_1186',['WRAP',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae1c8555fcf0ea2bb648a6fd527d658c0',1,'nc::filter']]], + ['wrap1d_1187',['wrap1d',['../namespacenc_1_1filter_1_1boundary.html#aa318761ec07aeb7764e2e5f0a7ec9e86',1,'nc::filter::boundary']]], + ['wrap1d_2ehpp_1188',['wrap1d.hpp',['../wrap1d_8hpp.html',1,'']]], + ['wrap2d_1189',['wrap2d',['../namespacenc_1_1filter_1_1boundary.html#aeace2e548cf6ecf3aaadbbf000cbead7',1,'nc::filter::boundary']]], + ['wrap2d_2ehpp_1190',['wrap2d.hpp',['../wrap2d_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_17.html b/docs/doxygen/html/search/all_17.html index 961ea4061..1ad5d34b4 100644 --- a/docs/doxygen/html/search/all_17.html +++ b/docs/doxygen/html/search/all_17.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_17.js b/docs/doxygen/html/search/all_17.js index 8378bccd3..7b2ada22d 100644 --- a/docs/doxygen/html/search/all_17.js +++ b/docs/doxygen/html/search/all_17.js @@ -1,6 +1,6 @@ var searchData= [ - ['x_1140',['x',['../classnc_1_1_vec2.html#a36a67b9395b397e1b8e9364a39a5c458',1,'nc::Vec2::x()'],['../classnc_1_1_vec3.html#a7f71dd08d58a1327739de6041e3362bb',1,'nc::Vec3::x()'],['../classnc_1_1coordinates_1_1_coordinate.html#aded7d56f04931cfbb07488d45d6bfce5',1,'nc::coordinates::Coordinate::x()']]], - ['xrotation_1141',['xRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a7679a0d5443e2abdee0c376ef5f6d1e1',1,'nc::rotations::DCM::xRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#a30fe8031959271e5b0134a0c562713b4',1,'nc::rotations::Quaternion::xRotation()']]], - ['xyz_1142',['xyz',['../classnc_1_1coordinates_1_1_coordinate.html#a01ff982f40caae2429c20d0ba66e4afc',1,'nc::coordinates::Coordinate']]] + ['x_1191',['x',['../classnc_1_1_vec2.html#a36a67b9395b397e1b8e9364a39a5c458',1,'nc::Vec2::x()'],['../classnc_1_1_vec3.html#a7f71dd08d58a1327739de6041e3362bb',1,'nc::Vec3::x()'],['../classnc_1_1coordinates_1_1_coordinate.html#aded7d56f04931cfbb07488d45d6bfce5',1,'nc::coordinates::Coordinate::x()']]], + ['xrotation_1192',['xRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a7679a0d5443e2abdee0c376ef5f6d1e1',1,'nc::rotations::DCM::xRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#a30fe8031959271e5b0134a0c562713b4',1,'nc::rotations::Quaternion::xRotation()']]], + ['xyz_1193',['xyz',['../classnc_1_1coordinates_1_1_coordinate.html#a01ff982f40caae2429c20d0ba66e4afc',1,'nc::coordinates::Coordinate']]] ]; diff --git a/docs/doxygen/html/search/all_18.html b/docs/doxygen/html/search/all_18.html index c81b0f578..507d0f856 100644 --- a/docs/doxygen/html/search/all_18.html +++ b/docs/doxygen/html/search/all_18.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_18.js b/docs/doxygen/html/search/all_18.js index 1cc4861e7..c66c10929 100644 --- a/docs/doxygen/html/search/all_18.js +++ b/docs/doxygen/html/search/all_18.js @@ -1,6 +1,6 @@ var searchData= [ - ['y_1143',['y',['../classnc_1_1_vec2.html#ad7a5bc1612f92f7e49112cf58caeaace',1,'nc::Vec2::y()'],['../classnc_1_1_vec3.html#a969dd1c195f4c78fc3a93292391e29c1',1,'nc::Vec3::y()'],['../classnc_1_1coordinates_1_1_coordinate.html#a624e354f60ca0822c5a60e9ee6432bc6',1,'nc::coordinates::Coordinate::y()']]], - ['yaw_1144',['yaw',['../classnc_1_1rotations_1_1_d_c_m.html#aef0f27b195b93151a94cb86ca9fa21c9',1,'nc::rotations::DCM::yaw()'],['../classnc_1_1rotations_1_1_quaternion.html#a5b5cef534a39badf5d3079ee642e675c',1,'nc::rotations::Quaternion::yaw()']]], - ['yrotation_1145',['yRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a9c495cb1fc84c70042d652d84bcddea4',1,'nc::rotations::DCM::yRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#ab77da90ef63465f79bd79348330ca9a4',1,'nc::rotations::Quaternion::yRotation()']]] + ['y_1194',['y',['../classnc_1_1_vec2.html#ad7a5bc1612f92f7e49112cf58caeaace',1,'nc::Vec2::y()'],['../classnc_1_1_vec3.html#a969dd1c195f4c78fc3a93292391e29c1',1,'nc::Vec3::y()'],['../classnc_1_1coordinates_1_1_coordinate.html#a624e354f60ca0822c5a60e9ee6432bc6',1,'nc::coordinates::Coordinate::y()']]], + ['yaw_1195',['yaw',['../classnc_1_1rotations_1_1_d_c_m.html#aef0f27b195b93151a94cb86ca9fa21c9',1,'nc::rotations::DCM::yaw()'],['../classnc_1_1rotations_1_1_quaternion.html#a5b5cef534a39badf5d3079ee642e675c',1,'nc::rotations::Quaternion::yaw()']]], + ['yrotation_1196',['yRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a9c495cb1fc84c70042d652d84bcddea4',1,'nc::rotations::DCM::yRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#ab77da90ef63465f79bd79348330ca9a4',1,'nc::rotations::Quaternion::yRotation()']]] ]; diff --git a/docs/doxygen/html/search/all_19.html b/docs/doxygen/html/search/all_19.html index 0964e799d..e69289e9b 100644 --- a/docs/doxygen/html/search/all_19.html +++ b/docs/doxygen/html/search/all_19.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_19.js b/docs/doxygen/html/search/all_19.js index b4be66c7a..0c70f3915 100644 --- a/docs/doxygen/html/search/all_19.js +++ b/docs/doxygen/html/search/all_19.js @@ -1,9 +1,9 @@ var searchData= [ - ['z_1146',['z',['../classnc_1_1_vec3.html#a0896ee691f46ce0bd669b869fe6acb41',1,'nc::Vec3::z()'],['../classnc_1_1coordinates_1_1_coordinate.html#a21614cb1e2513d0d8cb553ccb035986e',1,'nc::coordinates::Coordinate::z()']]], - ['zeros_1147',['zeros',['../classnc_1_1_nd_array.html#acac210ad3d3bd973be4bece6e6b625ed',1,'nc::NdArray::zeros()'],['../namespacenc.html#a8fb3ecc9cc7448e4b5d3d422e499b10e',1,'nc::zeros(uint32 inSquareSize)'],['../namespacenc.html#aa78000e997f09d772b82dd4a08783f69',1,'nc::zeros(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a9751f678e096a185122168c1c52edb25',1,'nc::zeros(const Shape &inShape)']]], - ['zeros_2ehpp_1148',['zeros.hpp',['../zeros_8hpp.html',1,'']]], - ['zeros_5flike_1149',['zeros_like',['../namespacenc.html#a497502db462e463196e12005ebf2d395',1,'nc']]], - ['zeros_5flike_2ehpp_1150',['zeros_like.hpp',['../zeros__like_8hpp.html',1,'']]], - ['zrotation_1151',['zRotation',['../classnc_1_1rotations_1_1_d_c_m.html#aa0c71aecc70f9354665b0c81cdf366ce',1,'nc::rotations::DCM::zRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#aaf688fafc4714f1da399e265c8e49a8d',1,'nc::rotations::Quaternion::zRotation()']]] + ['z_1197',['z',['../classnc_1_1_vec3.html#a0896ee691f46ce0bd669b869fe6acb41',1,'nc::Vec3::z()'],['../classnc_1_1coordinates_1_1_coordinate.html#a21614cb1e2513d0d8cb553ccb035986e',1,'nc::coordinates::Coordinate::z()']]], + ['zeros_1198',['zeros',['../classnc_1_1_nd_array.html#acac210ad3d3bd973be4bece6e6b625ed',1,'nc::NdArray::zeros()'],['../namespacenc.html#a8fb3ecc9cc7448e4b5d3d422e499b10e',1,'nc::zeros(uint32 inSquareSize)'],['../namespacenc.html#aa78000e997f09d772b82dd4a08783f69',1,'nc::zeros(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a9751f678e096a185122168c1c52edb25',1,'nc::zeros(const Shape &inShape)']]], + ['zeros_2ehpp_1199',['zeros.hpp',['../zeros_8hpp.html',1,'']]], + ['zeros_5flike_1200',['zeros_like',['../namespacenc.html#a497502db462e463196e12005ebf2d395',1,'nc']]], + ['zeros_5flike_2ehpp_1201',['zeros_like.hpp',['../zeros__like_8hpp.html',1,'']]], + ['zrotation_1202',['zRotation',['../classnc_1_1rotations_1_1_d_c_m.html#aa0c71aecc70f9354665b0c81cdf366ce',1,'nc::rotations::DCM::zRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#aaf688fafc4714f1da399e265c8e49a8d',1,'nc::rotations::Quaternion::zRotation()']]] ]; diff --git a/docs/doxygen/html/search/all_1a.html b/docs/doxygen/html/search/all_1a.html index 65d1029b4..e50f29b1c 100644 --- a/docs/doxygen/html/search/all_1a.html +++ b/docs/doxygen/html/search/all_1a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_1a.js b/docs/doxygen/html/search/all_1a.js index 1d7658d82..d02246294 100644 --- a/docs/doxygen/html/search/all_1a.js +++ b/docs/doxygen/html/search/all_1a.js @@ -1,10 +1,10 @@ var searchData= [ - ['_7ebisection_1152',['~Bisection',['../classnc_1_1roots_1_1_bisection.html#a5e0d0c67681add5f2feec713901539df',1,'nc::roots::Bisection']]], - ['_7ebrent_1153',['~Brent',['../classnc_1_1roots_1_1_brent.html#ade76ad260d82314f284ebacf885f6884',1,'nc::roots::Brent']]], - ['_7edekker_1154',['~Dekker',['../classnc_1_1roots_1_1_dekker.html#a49413387fbe4d12e20569d175fa7f486',1,'nc::roots::Dekker']]], - ['_7eiteration_1155',['~Iteration',['../classnc_1_1roots_1_1_iteration.html#a44492e4a1849938cd7017154213ec002',1,'nc::roots::Iteration']]], - ['_7endarray_1156',['~NdArray',['../classnc_1_1_nd_array.html#a7ef259d6b54cf8373721700b12c14500',1,'nc::NdArray']]], - ['_7enewton_1157',['~Newton',['../classnc_1_1roots_1_1_newton.html#a25702b087e2e9917af0c31fe1dbdf442',1,'nc::roots::Newton']]], - ['_7esecant_1158',['~Secant',['../classnc_1_1roots_1_1_secant.html#aa5eb3c22ecf2ef92a381b6cf54fb1f83',1,'nc::roots::Secant']]] + ['_7ebisection_1203',['~Bisection',['../classnc_1_1roots_1_1_bisection.html#a5e0d0c67681add5f2feec713901539df',1,'nc::roots::Bisection']]], + ['_7ebrent_1204',['~Brent',['../classnc_1_1roots_1_1_brent.html#ade76ad260d82314f284ebacf885f6884',1,'nc::roots::Brent']]], + ['_7edekker_1205',['~Dekker',['../classnc_1_1roots_1_1_dekker.html#a49413387fbe4d12e20569d175fa7f486',1,'nc::roots::Dekker']]], + ['_7eiteration_1206',['~Iteration',['../classnc_1_1roots_1_1_iteration.html#a44492e4a1849938cd7017154213ec002',1,'nc::roots::Iteration']]], + ['_7endarray_1207',['~NdArray',['../classnc_1_1_nd_array.html#a7ef259d6b54cf8373721700b12c14500',1,'nc::NdArray']]], + ['_7enewton_1208',['~Newton',['../classnc_1_1roots_1_1_newton.html#a25702b087e2e9917af0c31fe1dbdf442',1,'nc::roots::Newton']]], + ['_7esecant_1209',['~Secant',['../classnc_1_1roots_1_1_secant.html#aa5eb3c22ecf2ef92a381b6cf54fb1f83',1,'nc::roots::Secant']]] ]; diff --git a/docs/doxygen/html/search/all_2.html b/docs/doxygen/html/search/all_2.html index 0a5f832e0..02cfffc2e 100644 --- a/docs/doxygen/html/search/all_2.html +++ b/docs/doxygen/html/search/all_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_2.js b/docs/doxygen/html/search/all_2.js index 498d2a326..9e8b10859 100644 --- a/docs/doxygen/html/search/all_2.js +++ b/docs/doxygen/html/search/all_2.js @@ -1,128 +1,136 @@ var searchData= [ - ['c_143',['c',['../namespacenc_1_1constants.html#ac3fc62713ed109e451648c67faab7581',1,'nc::constants']]], - ['cauchy_144',['cauchy',['../namespacenc_1_1random.html#aa72b221b82940e126a4c740ee55b269b',1,'nc::random::cauchy(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a61dc9fcfaee6e2a74e3f2e1f0e9c039b',1,'nc::random::cauchy(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], - ['cauchy_2ehpp_145',['cauchy.hpp',['../cauchy_8hpp.html',1,'']]], - ['cbegin_146',['cbegin',['../classnc_1_1_nd_array.html#a4a3d1f968c924a4dc74cd8b617d30df6',1,'nc::NdArray::cbegin(size_type inRow) const'],['../classnc_1_1_nd_array.html#a0bee49339bdc4d7edbeb5efa73133cc3',1,'nc::NdArray::cbegin() const noexcept'],['../classnc_1_1_data_cube.html#adee7aa24a04d84f83f4c76ef8dcec974',1,'nc::DataCube::cbegin()']]], - ['cbrt_147',['cbrt',['../namespacenc.html#ae0f91253a3818ac7a12a9d5120ee9a14',1,'nc::cbrt(const NdArray< dtype > &inArray)'],['../namespacenc.html#a21de0caa1ff8e9e7baed8a8a57f7bcab',1,'nc::cbrt(dtype inValue) noexcept']]], - ['cbrt_2ehpp_148',['cbrt.hpp',['../cbrt_8hpp.html',1,'']]], - ['ccolbegin_149',['ccolbegin',['../classnc_1_1_nd_array.html#a1252a696593c510d506c1bca8bd65c51',1,'nc::NdArray::ccolbegin(size_type inCol) const'],['../classnc_1_1_nd_array.html#a25c7145679e41227023ad6de4ab5cd18',1,'nc::NdArray::ccolbegin() const noexcept']]], - ['ccolend_150',['ccolend',['../classnc_1_1_nd_array.html#a4a493445c10ed3c299632bf8c7077cfb',1,'nc::NdArray::ccolend(size_type inCol) const'],['../classnc_1_1_nd_array.html#ad2833ea5479c37de114bf52afff04a20',1,'nc::NdArray::ccolend() const noexcept']]], - ['ceil_151',['ceil',['../namespacenc.html#a375f83bc366e3b26842a03b9688b8a33',1,'nc::ceil(const NdArray< dtype > &inArray)'],['../namespacenc.html#a291189b2c2bc35a608b393ab1c06e84a',1,'nc::ceil(dtype inValue) noexcept']]], - ['ceil_2ehpp_152',['ceil.hpp',['../ceil_8hpp.html',1,'']]], - ['cend_153',['cend',['../classnc_1_1_data_cube.html#aca3c0041f121ed92d47d1f2873f713e4',1,'nc::DataCube::cend()'],['../classnc_1_1_nd_array.html#aa16bc96e4bbafbc8a06743f3e4a10a6a',1,'nc::NdArray::cend() const noexcept'],['../classnc_1_1_nd_array.html#a4da6aaa43b6074a4353328a8047992f6',1,'nc::NdArray::cend(size_type inRow) const']]], - ['centerofmass_154',['centerOfMass',['../namespacenc.html#a830888da11b33ea36bf4fc580d8c4757',1,'nc']]], - ['centerofmass_2ehpp_155',['centerOfMass.hpp',['../center_of_mass_8hpp.html',1,'']]], - ['centroid_156',['Centroid',['../classnc_1_1image_processing_1_1_centroid.html#a3b97e4ddc31b85eb8c3f84b398429a35',1,'nc::imageProcessing::Centroid::Centroid()=default'],['../classnc_1_1image_processing_1_1_centroid.html#a59d0af7acae8d24d29ccb372440aed22',1,'nc::imageProcessing::Centroid::Centroid(const Cluster< dtype > &inCluster)'],['../classnc_1_1image_processing_1_1_centroid.html',1,'nc::imageProcessing::Centroid< dtype >']]], - ['centroid_2ehpp_157',['Centroid.hpp',['../_centroid_8hpp.html',1,'']]], - ['centroidclusters_158',['centroidClusters',['../namespacenc_1_1image_processing.html#adbb987932dd69ec19029228e065c6603',1,'nc::imageProcessing']]], - ['centroidclusters_2ehpp_159',['centroidClusters.hpp',['../centroid_clusters_8hpp.html',1,'']]], - ['chebyshev_5ft_160',['chebyshev_t',['../namespacenc_1_1polynomial.html#afc70c903be3c216cf6215b76c89fecc0',1,'nc::polynomial::chebyshev_t(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a0ce5634d805736db2082358497bac2f4',1,'nc::polynomial::chebyshev_t(uint32 n, const NdArray< dtype > &inArrayX)']]], - ['chebyshev_5ft_2ehpp_161',['chebyshev_t.hpp',['../chebyshev__t_8hpp.html',1,'']]], - ['chebyshev_5fu_162',['chebyshev_u',['../namespacenc_1_1polynomial.html#a1e0f56b8366b1f83b48e30e7bb04c937',1,'nc::polynomial::chebyshev_u(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#ae03d7859d449ee3fa17f2d09bb2b5638',1,'nc::polynomial::chebyshev_u(uint32 n, const NdArray< dtype > &inArrayX)']]], - ['chebyshev_5fu_2ehpp_163',['chebyshev_u.hpp',['../chebyshev__u_8hpp.html',1,'']]], - ['chisquare_164',['chiSquare',['../namespacenc_1_1random.html#abb480e9a17b71ea09ef0f043c081e9ff',1,'nc::random::chiSquare(dtype inDof)'],['../namespacenc_1_1random.html#a329370aed893f0e10a8050520cf0bbd4',1,'nc::random::chiSquare(const Shape &inShape, dtype inDof)']]], - ['chisquare_2ehpp_165',['chiSquare.hpp',['../chi_square_8hpp.html',1,'']]], - ['choice_166',['choice',['../namespacenc_1_1random.html#a7fcf28e4b1a2b015b1099986c5202877',1,'nc::random::choice(const NdArray< dtype > &inArray, uint32 inNum, bool replace=true)'],['../namespacenc_1_1random.html#ad60ec32743642bd0540fec0076043fed',1,'nc::random::choice(const NdArray< dtype > &inArray)']]], - ['choice_2ehpp_167',['choice.hpp',['../choice_8hpp.html',1,'']]], - ['cholesky_168',['cholesky',['../namespacenc_1_1linalg.html#ac2d27e58dd0f082ef5a422d545699d19',1,'nc::linalg']]], - ['cholesky_2ehpp_169',['cholesky.hpp',['../cholesky_8hpp.html',1,'']]], - ['chronoclock_170',['ChronoClock',['../classnc_1_1_timer.html#a968ad8ca046ae73671e211e644682c8d',1,'nc::Timer']]], - ['clampmagnitude_171',['clampMagnitude',['../classnc_1_1_vec2.html#abb0f6f8cacc680a464425d908e1e55cc',1,'nc::Vec2::clampMagnitude()'],['../classnc_1_1_vec3.html#a4f3cfcbd67a402820cc8e0576dccd2e4',1,'nc::Vec3::clampMagnitude()']]], - ['clip_172',['clip',['../namespacenc.html#a5200696e06dadf4eca2f0d7332ed4af1',1,'nc::clip(dtype inValue, dtype inMinValue, dtype inMaxValue)'],['../namespacenc.html#af82b46f44ea7fad5bbd8ef9acf2499c3',1,'nc::clip(const NdArray< dtype > &inArray, dtype inMinValue, dtype inMaxValue)'],['../classnc_1_1_nd_array.html#a5a7fa82bdf3f34fcd3cc1dd2169c6c6f',1,'nc::NdArray::clip()']]], - ['clip_2ehpp_173',['clip.hpp',['../clip_8hpp.html',1,'']]], - ['cluster_174',['Cluster',['../classnc_1_1image_processing_1_1_cluster.html#a9c84aca9710bec5c721fd6a9f94182c3',1,'nc::imageProcessing::Cluster::Cluster()=default'],['../classnc_1_1image_processing_1_1_cluster.html#a73ce20625b5ca5d9e0d872cc8ad885dc',1,'nc::imageProcessing::Cluster::Cluster(uint32 inClusterId) noexcept'],['../classnc_1_1image_processing_1_1_cluster.html',1,'nc::imageProcessing::Cluster< dtype >']]], - ['cluster_2ehpp_175',['Cluster.hpp',['../_cluster_8hpp.html',1,'']]], - ['clusterid_176',['clusterId',['../classnc_1_1image_processing_1_1_cluster.html#abcc9f76b1d903546a3604ef87795d37e',1,'nc::imageProcessing::Cluster::clusterId()'],['../classnc_1_1image_processing_1_1_pixel.html#ac22936e8b5b80a1c557faaf9722b3183',1,'nc::imageProcessing::Pixel::clusterId()']]], - ['clustermaker_177',['ClusterMaker',['../classnc_1_1image_processing_1_1_cluster_maker.html#a17c7a9f6260f7d6d0aea002b7e5e6ae6',1,'nc::imageProcessing::ClusterMaker::ClusterMaker()'],['../classnc_1_1image_processing_1_1_cluster_maker.html',1,'nc::imageProcessing::ClusterMaker< dtype >']]], - ['clustermaker_2ehpp_178',['ClusterMaker.hpp',['../_cluster_maker_8hpp.html',1,'']]], - ['clusterpixels_179',['clusterPixels',['../namespacenc_1_1image_processing.html#a9b0730e1067dc755ee1fa2ecf280c14f',1,'nc::imageProcessing']]], - ['clusterpixels_2ehpp_180',['clusterPixels.hpp',['../cluster_pixels_8hpp.html',1,'']]], - ['cnr_181',['cnr',['../namespacenc_1_1special.html#a8249c674798e782f98a90942818ab395',1,'nc::special']]], - ['cnr_2ehpp_182',['cnr.hpp',['../cnr_8hpp.html',1,'']]], - ['coefficients_183',['coefficients',['../classnc_1_1polynomial_1_1_poly1d.html#abc31b5e093fd3ce5b2c14eade8d346a9',1,'nc::polynomial::Poly1d']]], - ['col_184',['col',['../classnc_1_1image_processing_1_1_centroid.html#a4ef0e9b2faa4999af5c3597a60140d6c',1,'nc::imageProcessing::Centroid::col()'],['../classnc_1_1image_processing_1_1_pixel.html#a6749c7a5513e2b7ee5c027aef104b269',1,'nc::imageProcessing::Pixel::col()']]], - ['col_185',['COL',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84aa44a065875f5d66d41474bb9bfb0ce05',1,'nc']]], - ['colbegin_186',['colbegin',['../classnc_1_1_nd_array.html#a41f363682d797ed0ed236cf91bd644f1',1,'nc::NdArray::colbegin() noexcept'],['../classnc_1_1_nd_array.html#a3730d4ac599c06e0e25ac7838f53240b',1,'nc::NdArray::colbegin(size_type inCol)'],['../classnc_1_1_nd_array.html#ab6bf02841ec667f5bb4266da569c99fc',1,'nc::NdArray::colbegin() const noexcept'],['../classnc_1_1_nd_array.html#acadf6ded9a6eb2638d975da9dbbfe38c',1,'nc::NdArray::colbegin(size_type inCol) const']]], - ['colend_187',['colend',['../classnc_1_1_nd_array.html#a6501fd771b4dcf1fb49defeee43a47cc',1,'nc::NdArray::colend() noexcept'],['../classnc_1_1_nd_array.html#ae611e2ecc5bae6035d0de4d48f5de239',1,'nc::NdArray::colend(size_type inCol)'],['../classnc_1_1_nd_array.html#ac1297463b545ecfd72d22549ce0db02a',1,'nc::NdArray::colend() const noexcept'],['../classnc_1_1_nd_array.html#a97f4fdf4d1a588662733af2bc7e63aaa',1,'nc::NdArray::colend(size_type inCol) const']]], - ['colmax_188',['colMax',['../classnc_1_1image_processing_1_1_cluster.html#a8c884e5e55d41c09165bca85446edb1f',1,'nc::imageProcessing::Cluster']]], - ['colmin_189',['colMin',['../classnc_1_1image_processing_1_1_cluster.html#a27734d0fa45c7440e3018fa36c6633f9',1,'nc::imageProcessing::Cluster']]], - ['cols_190',['cols',['../classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d',1,'nc::Shape']]], - ['column_191',['column',['../classnc_1_1_nd_array.html#a4dc9d45ee849274808d850deeba451dd',1,'nc::NdArray']]], - ['column_5fiterator_192',['column_iterator',['../classnc_1_1_nd_array.html#a379e1e1ed2a61de6aa44226679620d47',1,'nc::NdArray']]], - ['column_5fstack_193',['column_stack',['../namespacenc.html#a940bbaf9f760ce2d85119beb4a5c23f2',1,'nc']]], - ['column_5fstack_2ehpp_194',['column_stack.hpp',['../column__stack_8hpp.html',1,'']]], - ['comp_5fellint_5f1_195',['comp_ellint_1',['../namespacenc_1_1special.html#a445930bd5caceb59104bc466c55d479a',1,'nc::special::comp_ellint_1(const NdArray< dtype > &inArrayK)'],['../namespacenc_1_1special.html#a3b24e9dde5d68f19d8a29de419e32024',1,'nc::special::comp_ellint_1(dtype inK)']]], - ['comp_5fellint_5f1_2ehpp_196',['comp_ellint_1.hpp',['../comp__ellint__1_8hpp.html',1,'']]], - ['comp_5fellint_5f2_197',['comp_ellint_2',['../namespacenc_1_1special.html#abb6b67ccb2a8ea054c188d82f3a67013',1,'nc::special::comp_ellint_2(const NdArray< dtype > &inArrayK)'],['../namespacenc_1_1special.html#abfcffce97bdc9114b78a4c6d06956fc5',1,'nc::special::comp_ellint_2(dtype inK)']]], - ['comp_5fellint_5f2_2ehpp_198',['comp_ellint_2.hpp',['../comp__ellint__2_8hpp.html',1,'']]], - ['comp_5fellint_5f3_199',['comp_ellint_3',['../namespacenc_1_1special.html#a40e29e793c7c7ee437f242a8cc7e8e26',1,'nc::special::comp_ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV)'],['../namespacenc_1_1special.html#a8c90b0cd0de06a5e789e3b9f8b0a1243',1,'nc::special::comp_ellint_3(dtype1 inK, dtype2 inV)']]], - ['comp_5fellint_5f3_2ehpp_200',['comp_ellint_3.hpp',['../comp__ellint__3_8hpp.html',1,'']]], - ['compiler_20flags_201',['Compiler Flags',['../md__mnt_c__github__num_cpp_docs_markdown__compiler_flags.html',1,'']]], - ['compilerflags_2emd_202',['CompilerFlags.md',['../_compiler_flags_8md.html',1,'']]], - ['complementarymedianfilter_203',['complementaryMedianFilter',['../namespacenc_1_1filter.html#a2343ac38b1ec7c4cbde82a3fe20b4c21',1,'nc::filter']]], - ['complementarymedianfilter_2ehpp_204',['complementaryMedianFilter.hpp',['../complementary_median_filter_8hpp.html',1,'']]], - ['complementarymedianfilter1d_205',['complementaryMedianFilter1d',['../namespacenc_1_1filter.html#aed171f8ad8a79d99c13158c909ac4017',1,'nc::filter']]], - ['complementarymedianfilter1d_2ehpp_206',['complementaryMedianFilter1d.hpp',['../complementary_median_filter1d_8hpp.html',1,'']]], - ['complex_207',['complex',['../namespacenc.html#a56639fcc468435514861ce0e5059d82f',1,'nc::complex(dtype inReal)'],['../namespacenc.html#a2e653b99a0f26149fe399ebed1fc949e',1,'nc::complex(dtype inReal, dtype inImag)'],['../namespacenc.html#ab84a62b7de04ef6f69870e51f5dd8d00',1,'nc::complex(const NdArray< dtype > &inReal)'],['../namespacenc.html#a1d8b87baeef70163d94b40c96759ecc0',1,'nc::complex(const NdArray< dtype > &inReal, const NdArray< dtype > &inImag)']]], - ['complex_2ehpp_208',['complex.hpp',['../complex_8hpp.html',1,'']]], - ['complex_5fcast_209',['complex_cast',['../namespacenc.html#ad639d68db9e1b3ea9acc08efe4bad20e',1,'nc']]], - ['concatenate_210',['concatenate',['../namespacenc.html#a027070169f1750a74315d07c5bbdfb03',1,'nc']]], - ['concatenate_2ehpp_211',['concatenate.hpp',['../concatenate_8hpp.html',1,'']]], - ['conditional_5fno_5fexcept_212',['CONDITIONAL_NO_EXCEPT',['../_stl_algorithms_8hpp.html#a328745b2b79b264770ec2783aa489f26',1,'StlAlgorithms.hpp']]], - ['conj_213',['conj',['../namespacenc.html#a26e9df3c46d4f782d04c8d35881aad80',1,'nc::conj(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a0387ae5584e72894ae9e690eba21e26b',1,'nc::conj(const std::complex< dtype > &inValue)']]], - ['conj_2ehpp_214',['conj.hpp',['../conj_8hpp.html',1,'']]], - ['conjugate_215',['conjugate',['../classnc_1_1rotations_1_1_quaternion.html#ade406544e8360506bb77102d17b14e61',1,'nc::rotations::Quaternion']]], - ['const_5fcolumn_5fiterator_216',['const_column_iterator',['../classnc_1_1_nd_array.html#a1307cf472f722baa8850200dcb7a3a89',1,'nc::NdArray']]], - ['const_5fiterator_217',['const_iterator',['../classnc_1_1_data_cube.html#a1ea7b9bd30731c3325545fbcd2678761',1,'nc::DataCube::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster.html#a3b344c255dfcfcf18e0fc9f1e84979ae',1,'nc::imageProcessing::Cluster::const_iterator()'],['../classnc_1_1_nd_array.html#a49deeee0db98eae1c16ac6bca6fa6f31',1,'nc::NdArray::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a870aeb2f713b4efba22a2f978704c215',1,'nc::imageProcessing::ClusterMaker::const_iterator()']]], - ['const_5fpointer_218',['const_pointer',['../classnc_1_1_nd_array.html#a94982f81d8aa8c8a72abe0327f22b4dd',1,'nc::NdArray']]], - ['const_5freference_219',['const_reference',['../classnc_1_1_nd_array.html#a2e9001eb3a7fb5b44f6400b3cc3b3222',1,'nc::NdArray']]], - ['const_5freverse_5fcolumn_5fiterator_220',['const_reverse_column_iterator',['../classnc_1_1_nd_array.html#aa4f80e21b4b0f30ff98d1b90ae4fd70d',1,'nc::NdArray']]], - ['const_5freverse_5fiterator_221',['const_reverse_iterator',['../classnc_1_1_nd_array.html#a6de6f2ef3b2519edd272623a9681b527',1,'nc::NdArray']]], - ['constant_222',['CONSTANT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a8d6b5cada83510220f59e00ce86d4d92',1,'nc::filter']]], - ['constant1d_223',['constant1d',['../namespacenc_1_1filter_1_1boundary.html#a09c2e0a7f9ff3c1fbbbee0136d80a2e0',1,'nc::filter::boundary']]], - ['constant1d_2ehpp_224',['constant1d.hpp',['../constant1d_8hpp.html',1,'']]], - ['constant2d_225',['constant2d',['../namespacenc_1_1filter_1_1boundary.html#a0e0bd2ad1d6ac1b1d248175b9bc422f6',1,'nc::filter::boundary']]], - ['constant2d_2ehpp_226',['constant2d.hpp',['../constant2d_8hpp.html',1,'']]], - ['constants_2ehpp_227',['Constants.hpp',['../_constants_8hpp.html',1,'']]], - ['contains_228',['contains',['../namespacenc.html#a89349379637971764e6efe28ad8c1848',1,'nc::contains()'],['../classnc_1_1_nd_array.html#ad0c493a734dbca9f622d0f7ca6dffbf4',1,'nc::NdArray::contains()']]], - ['contains_2ehpp_229',['contains.hpp',['../contains_8hpp.html',1,'']]], - ['convolve_230',['convolve',['../namespacenc_1_1filter.html#abc4c77c759de3cd79f3fc02b7461d971',1,'nc::filter']]], - ['convolve_2ehpp_231',['convolve.hpp',['../convolve_8hpp.html',1,'']]], - ['convolve1d_232',['convolve1d',['../namespacenc_1_1filter.html#a21d48fecf984290cb5a4388d50371b13',1,'nc::filter']]], - ['convolve1d_2ehpp_233',['convolve1d.hpp',['../convolve1d_8hpp.html',1,'']]], - ['coordinate_234',['Coordinate',['../classnc_1_1coordinates_1_1_coordinate.html#a0f541169a4c318a5cf4fd0a50a4c2013',1,'nc::coordinates::Coordinate::Coordinate()=default'],['../classnc_1_1coordinates_1_1_coordinate.html#a983a167d97af973947f76474ab299ab8',1,'nc::coordinates::Coordinate::Coordinate(double inRaDegrees, double inDecDegrees)'],['../classnc_1_1coordinates_1_1_coordinate.html#a68eafc66dfeb8551fa7d8960f116be83',1,'nc::coordinates::Coordinate::Coordinate(uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds)'],['../classnc_1_1coordinates_1_1_coordinate.html#a7cf9e8138023ced7cfcb071299018fd5',1,'nc::coordinates::Coordinate::Coordinate(const RA &inRA, const Dec &inDec) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#aa023b8b0e74159909e99aabcf778c57f',1,'nc::coordinates::Coordinate::Coordinate(double inX, double inY, double inZ) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#a35b32fa280c920d0b528472f7726a03d',1,'nc::coordinates::Coordinate::Coordinate(const NdArray< double > &inCartesianVector)'],['../classnc_1_1coordinates_1_1_coordinate.html',1,'nc::coordinates::Coordinate']]], - ['coordinate_2ehpp_235',['Coordinate.hpp',['../_coordinate_8hpp.html',1,'']]], - ['coordinates_2ehpp_236',['Coordinates.hpp',['../_coordinates_8hpp.html',1,'']]], - ['copy_237',['copy',['../classnc_1_1_nd_array.html#a1f2d2aacc254129f36b0557a661e6664',1,'nc::NdArray::copy()'],['../namespacenc.html#a9bbe10d41fdbd74a6254bad44c7c7cf6',1,'nc::copy()'],['../namespacenc_1_1stl__algorithms.html#ae62a4e197ec640aacea520220bd27cef',1,'nc::stl_algorithms::copy()']]], - ['copy_2ehpp_238',['copy.hpp',['../copy_8hpp.html',1,'']]], - ['copysign_239',['copySign',['../namespacenc.html#a9e08e770fd2283734390ab631edc250d',1,'nc']]], - ['copysign_2ehpp_240',['copySign.hpp',['../copy_sign_8hpp.html',1,'']]], - ['copyto_241',['copyto',['../namespacenc.html#af8eca852439098c1fff96384d88d82dd',1,'nc']]], - ['copyto_2ehpp_242',['copyto.hpp',['../copyto_8hpp.html',1,'']]], - ['core_2ehpp_243',['Core.hpp',['../_core_8hpp.html',1,'']]], - ['cos_244',['cos',['../namespacenc.html#af208ae28fe0df17392ca128188cbcd73',1,'nc::cos(const NdArray< dtype > &inArray)'],['../namespacenc.html#a736de91eb8f79bfaf4dc92d7161f1c87',1,'nc::cos(dtype inValue) noexcept']]], - ['cos_2ehpp_245',['cos.hpp',['../cos_8hpp.html',1,'']]], - ['cosh_246',['cosh',['../namespacenc.html#a520e0290bb667b43a9f494b3858b5f17',1,'nc::cosh(const NdArray< dtype > &inArray)'],['../namespacenc.html#abb07133a1f54b24a4a4986eefb5eda85',1,'nc::cosh(dtype inValue) noexcept']]], - ['cosh_2ehpp_247',['cosh.hpp',['../cosh_8hpp.html',1,'']]], - ['count_248',['count',['../namespacenc_1_1stl__algorithms.html#a1fa02155befc0c39a853e66f6df26745',1,'nc::stl_algorithms']]], - ['count_5fnonzero_249',['count_nonzero',['../namespacenc.html#aebb0dfe3637c07f6a9f6e4f08cacf515',1,'nc']]], - ['count_5fnonzero_2ehpp_250',['count_nonzero.hpp',['../count__nonzero_8hpp.html',1,'']]], - ['crbegin_251',['crbegin',['../classnc_1_1_nd_array.html#a95cbc4440ac1e139642a08cbd075dafc',1,'nc::NdArray::crbegin() const noexcept'],['../classnc_1_1_nd_array.html#af6b2581fae90a5c67e87df6a82ea13c5',1,'nc::NdArray::crbegin(size_type inRow) const']]], - ['crcolbegin_252',['crcolbegin',['../classnc_1_1_nd_array.html#a35883ec844477b9bca2597939dd99c2a',1,'nc::NdArray::crcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a8afdb68c11124e1fe0309204f3996435',1,'nc::NdArray::crcolbegin(size_type inCol) const']]], - ['crcolend_253',['crcolend',['../classnc_1_1_nd_array.html#a55e5d41795f14f7f2aa256ba0f4bb676',1,'nc::NdArray::crcolend() const noexcept'],['../classnc_1_1_nd_array.html#a35b66f060b1ed99a6fb5247581fcb8fc',1,'nc::NdArray::crcolend(size_type inCol) const']]], - ['crend_254',['crend',['../classnc_1_1_nd_array.html#ac5d1c900c4db4263d1bf799ac3551ed6',1,'nc::NdArray::crend() const noexcept'],['../classnc_1_1_nd_array.html#af3b4c48e3328a8dd22eedd27c225aeb5',1,'nc::NdArray::crend(size_type inRow) const']]], - ['cross_255',['cross',['../namespacenc.html#a4d1ed581965ed53090824290def38565',1,'nc::cross()'],['../classnc_1_1_vec3.html#af8173f6e61e9a63beae3092fd8dc4378',1,'nc::Vec3::cross()']]], - ['cross_2ehpp_256',['cross.hpp',['../cross_8hpp.html',1,'']]], - ['cslice_257',['cSlice',['../classnc_1_1_nd_array.html#a29eabba849b35a3095cd341fa1c7b123',1,'nc::NdArray']]], - ['cube_258',['cube',['../namespacenc.html#a5899ccef8410243438debea3d8296df6',1,'nc::cube(dtype inValue) noexcept'],['../namespacenc.html#a224d96b41af957c782c02f1cb25e66fd',1,'nc::cube(const NdArray< dtype > &inArray)'],['../namespacenc_1_1utils.html#a46e88717d4d32003bb449fd5cefd401c',1,'nc::utils::cube()']]], - ['cumprod_259',['cumprod',['../classnc_1_1_nd_array.html#a75a231dec87e18370e9731214983858e',1,'nc::NdArray::cumprod()'],['../namespacenc.html#aafc4846f2f7956841d356060c9689cba',1,'nc::cumprod()']]], - ['cumprod_2ehpp_260',['cumprod.hpp',['../cumprod_8hpp.html',1,'']]], - ['cumsum_261',['cumsum',['../classnc_1_1_nd_array.html#a4baa93f2a125d7665f3cdfd8d96d3acc',1,'nc::NdArray::cumsum()'],['../namespacenc.html#a2abc8c4a18823234e3baec64d10c0dcd',1,'nc::cumsum()']]], - ['cumsum_2ehpp_262',['cumsum.hpp',['../cumsum_8hpp.html',1,'']]], - ['cyclic_5fhankel_5f1_263',['cyclic_hankel_1',['../namespacenc_1_1special.html#af5dd42de33ec77dda47dd089561895d5',1,'nc::special::cyclic_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ae7053cd6eafb59a62ba6ede63aac6f90',1,'nc::special::cyclic_hankel_1(dtype1 inV, const NdArray< dtype2 > &inX)']]], - ['cyclic_5fhankel_5f1_2ehpp_264',['cyclic_hankel_1.hpp',['../cyclic__hankel__1_8hpp.html',1,'']]], - ['cyclic_5fhankel_5f2_265',['cyclic_hankel_2',['../namespacenc_1_1special.html#a388472a49e89f21b3eb144368fe55664',1,'nc::special::cyclic_hankel_2(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a8e3b27238d1cae20e4ee071766549c5d',1,'nc::special::cyclic_hankel_2(dtype1 inV, const NdArray< dtype2 > &inX)']]], - ['cyclic_5fhankel_5f2_2ehpp_266',['cyclic_hankel_2.hpp',['../cyclic__hankel__2_8hpp.html',1,'']]], - ['shape_2ehpp_267',['Shape.hpp',['../_core_2_shape_8hpp.html',1,'']]] + ['c_147',['c',['../namespacenc_1_1constants.html#ac3fc62713ed109e451648c67faab7581',1,'nc::constants']]], + ['calculateparity_148',['calculateParity',['../namespacenc_1_1edac_1_1detail.html#ad3215e8486eb3a544a483e5234c856d7',1,'nc::edac::detail::calculateParity(const std::bitset< DataBits > &data) noexcept'],['../namespacenc_1_1edac_1_1detail.html#abde37c852253de171988da5e4b775273',1,'nc::edac::detail::calculateParity(const boost::dynamic_bitset<> &data) noexcept'],['../namespacenc_1_1edac_1_1detail.html#aea349d7b4d28ca91b85bcb3a2823c145',1,'nc::edac::detail::calculateParity(const std::bitset< DataBits > &data, IntType parityBit)']]], + ['cauchy_149',['cauchy',['../namespacenc_1_1random.html#aa72b221b82940e126a4c740ee55b269b',1,'nc::random::cauchy(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a61dc9fcfaee6e2a74e3f2e1f0e9c039b',1,'nc::random::cauchy(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], + ['cauchy_2ehpp_150',['cauchy.hpp',['../cauchy_8hpp.html',1,'']]], + ['cbegin_151',['cbegin',['../classnc_1_1_data_cube.html#adee7aa24a04d84f83f4c76ef8dcec974',1,'nc::DataCube::cbegin()'],['../classnc_1_1_nd_array.html#a4a3d1f968c924a4dc74cd8b617d30df6',1,'nc::NdArray::cbegin(size_type inRow) const'],['../classnc_1_1_nd_array.html#a0bee49339bdc4d7edbeb5efa73133cc3',1,'nc::NdArray::cbegin() const noexcept']]], + ['cbrt_152',['cbrt',['../namespacenc.html#ae0f91253a3818ac7a12a9d5120ee9a14',1,'nc::cbrt(const NdArray< dtype > &inArray)'],['../namespacenc.html#a21de0caa1ff8e9e7baed8a8a57f7bcab',1,'nc::cbrt(dtype inValue) noexcept']]], + ['cbrt_2ehpp_153',['cbrt.hpp',['../cbrt_8hpp.html',1,'']]], + ['ccolbegin_154',['ccolbegin',['../classnc_1_1_nd_array.html#a25c7145679e41227023ad6de4ab5cd18',1,'nc::NdArray::ccolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a1252a696593c510d506c1bca8bd65c51',1,'nc::NdArray::ccolbegin(size_type inCol) const']]], + ['ccolend_155',['ccolend',['../classnc_1_1_nd_array.html#a4a493445c10ed3c299632bf8c7077cfb',1,'nc::NdArray::ccolend(size_type inCol) const'],['../classnc_1_1_nd_array.html#ad2833ea5479c37de114bf52afff04a20',1,'nc::NdArray::ccolend() const noexcept']]], + ['ceil_156',['ceil',['../namespacenc.html#a375f83bc366e3b26842a03b9688b8a33',1,'nc::ceil(const NdArray< dtype > &inArray)'],['../namespacenc.html#a291189b2c2bc35a608b393ab1c06e84a',1,'nc::ceil(dtype inValue) noexcept']]], + ['ceil_2ehpp_157',['ceil.hpp',['../ceil_8hpp.html',1,'']]], + ['cend_158',['cend',['../classnc_1_1_nd_array.html#a4da6aaa43b6074a4353328a8047992f6',1,'nc::NdArray::cend(size_type inRow) const'],['../classnc_1_1_nd_array.html#aa16bc96e4bbafbc8a06743f3e4a10a6a',1,'nc::NdArray::cend() const noexcept'],['../classnc_1_1_data_cube.html#aca3c0041f121ed92d47d1f2873f713e4',1,'nc::DataCube::cend()']]], + ['centerofmass_159',['centerOfMass',['../namespacenc.html#a830888da11b33ea36bf4fc580d8c4757',1,'nc']]], + ['centerofmass_2ehpp_160',['centerOfMass.hpp',['../center_of_mass_8hpp.html',1,'']]], + ['centroid_161',['Centroid',['../classnc_1_1image_processing_1_1_centroid.html#a59d0af7acae8d24d29ccb372440aed22',1,'nc::imageProcessing::Centroid::Centroid(const Cluster< dtype > &inCluster)'],['../classnc_1_1image_processing_1_1_centroid.html#a3b97e4ddc31b85eb8c3f84b398429a35',1,'nc::imageProcessing::Centroid::Centroid()=default'],['../classnc_1_1image_processing_1_1_centroid.html',1,'nc::imageProcessing::Centroid< dtype >']]], + ['centroid_2ehpp_162',['Centroid.hpp',['../_centroid_8hpp.html',1,'']]], + ['centroidclusters_163',['centroidClusters',['../namespacenc_1_1image_processing.html#adbb987932dd69ec19029228e065c6603',1,'nc::imageProcessing']]], + ['centroidclusters_2ehpp_164',['centroidClusters.hpp',['../centroid_clusters_8hpp.html',1,'']]], + ['chebyshev_5ft_165',['chebyshev_t',['../namespacenc_1_1polynomial.html#a0ce5634d805736db2082358497bac2f4',1,'nc::polynomial::chebyshev_t(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#afc70c903be3c216cf6215b76c89fecc0',1,'nc::polynomial::chebyshev_t(uint32 n, dtype x)']]], + ['chebyshev_5ft_2ehpp_166',['chebyshev_t.hpp',['../chebyshev__t_8hpp.html',1,'']]], + ['chebyshev_5fu_167',['chebyshev_u',['../namespacenc_1_1polynomial.html#ae03d7859d449ee3fa17f2d09bb2b5638',1,'nc::polynomial::chebyshev_u(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a1e0f56b8366b1f83b48e30e7bb04c937',1,'nc::polynomial::chebyshev_u(uint32 n, dtype x)']]], + ['chebyshev_5fu_2ehpp_168',['chebyshev_u.hpp',['../chebyshev__u_8hpp.html',1,'']]], + ['checkbitsconsistent_169',['checkBitsConsistent',['../namespacenc_1_1edac_1_1detail.html#af386b23445a4942453c69cff80ee0e20',1,'nc::edac::detail']]], + ['chisquare_170',['chiSquare',['../namespacenc_1_1random.html#abb480e9a17b71ea09ef0f043c081e9ff',1,'nc::random::chiSquare(dtype inDof)'],['../namespacenc_1_1random.html#a329370aed893f0e10a8050520cf0bbd4',1,'nc::random::chiSquare(const Shape &inShape, dtype inDof)']]], + ['chisquare_2ehpp_171',['chiSquare.hpp',['../chi_square_8hpp.html',1,'']]], + ['choice_172',['choice',['../namespacenc_1_1random.html#ad60ec32743642bd0540fec0076043fed',1,'nc::random::choice(const NdArray< dtype > &inArray)'],['../namespacenc_1_1random.html#a7fcf28e4b1a2b015b1099986c5202877',1,'nc::random::choice(const NdArray< dtype > &inArray, uint32 inNum, bool replace=true)']]], + ['choice_2ehpp_173',['choice.hpp',['../choice_8hpp.html',1,'']]], + ['cholesky_174',['cholesky',['../namespacenc_1_1linalg.html#ac2d27e58dd0f082ef5a422d545699d19',1,'nc::linalg']]], + ['cholesky_2ehpp_175',['cholesky.hpp',['../cholesky_8hpp.html',1,'']]], + ['chronoclock_176',['ChronoClock',['../classnc_1_1_timer.html#a968ad8ca046ae73671e211e644682c8d',1,'nc::Timer']]], + ['clampmagnitude_177',['clampMagnitude',['../classnc_1_1_vec3.html#a4f3cfcbd67a402820cc8e0576dccd2e4',1,'nc::Vec3::clampMagnitude()'],['../classnc_1_1_vec2.html#abb0f6f8cacc680a464425d908e1e55cc',1,'nc::Vec2::clampMagnitude()']]], + ['clip_178',['clip',['../namespacenc.html#a5200696e06dadf4eca2f0d7332ed4af1',1,'nc::clip(dtype inValue, dtype inMinValue, dtype inMaxValue)'],['../namespacenc.html#af82b46f44ea7fad5bbd8ef9acf2499c3',1,'nc::clip(const NdArray< dtype > &inArray, dtype inMinValue, dtype inMaxValue)'],['../classnc_1_1_nd_array.html#a5a7fa82bdf3f34fcd3cc1dd2169c6c6f',1,'nc::NdArray::clip()']]], + ['clip_2ehpp_179',['clip.hpp',['../clip_8hpp.html',1,'']]], + ['cluster_180',['Cluster',['../classnc_1_1image_processing_1_1_cluster.html#a73ce20625b5ca5d9e0d872cc8ad885dc',1,'nc::imageProcessing::Cluster::Cluster(uint32 inClusterId) noexcept'],['../classnc_1_1image_processing_1_1_cluster.html#a9c84aca9710bec5c721fd6a9f94182c3',1,'nc::imageProcessing::Cluster::Cluster()=default'],['../classnc_1_1image_processing_1_1_cluster.html',1,'nc::imageProcessing::Cluster< dtype >']]], + ['cluster_2ehpp_181',['Cluster.hpp',['../_cluster_8hpp.html',1,'']]], + ['clusterid_182',['clusterId',['../classnc_1_1image_processing_1_1_cluster.html#abcc9f76b1d903546a3604ef87795d37e',1,'nc::imageProcessing::Cluster::clusterId()'],['../classnc_1_1image_processing_1_1_pixel.html#ac22936e8b5b80a1c557faaf9722b3183',1,'nc::imageProcessing::Pixel::clusterId()']]], + ['clustermaker_183',['ClusterMaker',['../classnc_1_1image_processing_1_1_cluster_maker.html#a17c7a9f6260f7d6d0aea002b7e5e6ae6',1,'nc::imageProcessing::ClusterMaker::ClusterMaker()'],['../classnc_1_1image_processing_1_1_cluster_maker.html',1,'nc::imageProcessing::ClusterMaker< dtype >']]], + ['clustermaker_2ehpp_184',['ClusterMaker.hpp',['../_cluster_maker_8hpp.html',1,'']]], + ['clusterpixels_185',['clusterPixels',['../namespacenc_1_1image_processing.html#a9b0730e1067dc755ee1fa2ecf280c14f',1,'nc::imageProcessing']]], + ['clusterpixels_2ehpp_186',['clusterPixels.hpp',['../cluster_pixels_8hpp.html',1,'']]], + ['cnr_187',['cnr',['../namespacenc_1_1special.html#a8249c674798e782f98a90942818ab395',1,'nc::special']]], + ['cnr_2ehpp_188',['cnr.hpp',['../cnr_8hpp.html',1,'']]], + ['coefficients_189',['coefficients',['../classnc_1_1polynomial_1_1_poly1d.html#abc31b5e093fd3ce5b2c14eade8d346a9',1,'nc::polynomial::Poly1d']]], + ['col_190',['COL',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84aa44a065875f5d66d41474bb9bfb0ce05',1,'nc']]], + ['col_191',['col',['../classnc_1_1image_processing_1_1_pixel.html#a6749c7a5513e2b7ee5c027aef104b269',1,'nc::imageProcessing::Pixel::col()'],['../classnc_1_1image_processing_1_1_centroid.html#a4ef0e9b2faa4999af5c3597a60140d6c',1,'nc::imageProcessing::Centroid::col()']]], + ['colbegin_192',['colbegin',['../classnc_1_1_nd_array.html#a41f363682d797ed0ed236cf91bd644f1',1,'nc::NdArray::colbegin() noexcept'],['../classnc_1_1_nd_array.html#a3730d4ac599c06e0e25ac7838f53240b',1,'nc::NdArray::colbegin(size_type inCol)'],['../classnc_1_1_nd_array.html#ab6bf02841ec667f5bb4266da569c99fc',1,'nc::NdArray::colbegin() const noexcept'],['../classnc_1_1_nd_array.html#acadf6ded9a6eb2638d975da9dbbfe38c',1,'nc::NdArray::colbegin(size_type inCol) const']]], + ['colend_193',['colend',['../classnc_1_1_nd_array.html#ae611e2ecc5bae6035d0de4d48f5de239',1,'nc::NdArray::colend(size_type inCol)'],['../classnc_1_1_nd_array.html#ac1297463b545ecfd72d22549ce0db02a',1,'nc::NdArray::colend() const noexcept'],['../classnc_1_1_nd_array.html#a97f4fdf4d1a588662733af2bc7e63aaa',1,'nc::NdArray::colend(size_type inCol) const'],['../classnc_1_1_nd_array.html#a6501fd771b4dcf1fb49defeee43a47cc',1,'nc::NdArray::colend() noexcept']]], + ['colmax_194',['colMax',['../classnc_1_1image_processing_1_1_cluster.html#a8c884e5e55d41c09165bca85446edb1f',1,'nc::imageProcessing::Cluster']]], + ['colmin_195',['colMin',['../classnc_1_1image_processing_1_1_cluster.html#a27734d0fa45c7440e3018fa36c6633f9',1,'nc::imageProcessing::Cluster']]], + ['cols_196',['cols',['../classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d',1,'nc::Shape']]], + ['column_197',['column',['../classnc_1_1_nd_array.html#a4dc9d45ee849274808d850deeba451dd',1,'nc::NdArray']]], + ['column_5fiterator_198',['column_iterator',['../classnc_1_1_nd_array.html#a379e1e1ed2a61de6aa44226679620d47',1,'nc::NdArray']]], + ['column_5fstack_199',['column_stack',['../namespacenc.html#a940bbaf9f760ce2d85119beb4a5c23f2',1,'nc']]], + ['column_5fstack_2ehpp_200',['column_stack.hpp',['../column__stack_8hpp.html',1,'']]], + ['comp_5fellint_5f1_201',['comp_ellint_1',['../namespacenc_1_1special.html#a445930bd5caceb59104bc466c55d479a',1,'nc::special::comp_ellint_1(const NdArray< dtype > &inArrayK)'],['../namespacenc_1_1special.html#a3b24e9dde5d68f19d8a29de419e32024',1,'nc::special::comp_ellint_1(dtype inK)']]], + ['comp_5fellint_5f1_2ehpp_202',['comp_ellint_1.hpp',['../comp__ellint__1_8hpp.html',1,'']]], + ['comp_5fellint_5f2_203',['comp_ellint_2',['../namespacenc_1_1special.html#abb6b67ccb2a8ea054c188d82f3a67013',1,'nc::special::comp_ellint_2(const NdArray< dtype > &inArrayK)'],['../namespacenc_1_1special.html#abfcffce97bdc9114b78a4c6d06956fc5',1,'nc::special::comp_ellint_2(dtype inK)']]], + ['comp_5fellint_5f2_2ehpp_204',['comp_ellint_2.hpp',['../comp__ellint__2_8hpp.html',1,'']]], + ['comp_5fellint_5f3_205',['comp_ellint_3',['../namespacenc_1_1special.html#a8c90b0cd0de06a5e789e3b9f8b0a1243',1,'nc::special::comp_ellint_3(dtype1 inK, dtype2 inV)'],['../namespacenc_1_1special.html#a40e29e793c7c7ee437f242a8cc7e8e26',1,'nc::special::comp_ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV)']]], + ['comp_5fellint_5f3_2ehpp_206',['comp_ellint_3.hpp',['../comp__ellint__3_8hpp.html',1,'']]], + ['compiler_20flags_207',['Compiler Flags',['../md__c___github__num_cpp_docs_markdown__compiler_flags.html',1,'']]], + ['compilerflags_2emd_208',['CompilerFlags.md',['../_compiler_flags_8md.html',1,'']]], + ['complementarymedianfilter_209',['complementaryMedianFilter',['../namespacenc_1_1filter.html#a2343ac38b1ec7c4cbde82a3fe20b4c21',1,'nc::filter']]], + ['complementarymedianfilter_2ehpp_210',['complementaryMedianFilter.hpp',['../complementary_median_filter_8hpp.html',1,'']]], + ['complementarymedianfilter1d_211',['complementaryMedianFilter1d',['../namespacenc_1_1filter.html#aed171f8ad8a79d99c13158c909ac4017',1,'nc::filter']]], + ['complementarymedianfilter1d_2ehpp_212',['complementaryMedianFilter1d.hpp',['../complementary_median_filter1d_8hpp.html',1,'']]], + ['complex_213',['complex',['../namespacenc.html#a2e653b99a0f26149fe399ebed1fc949e',1,'nc::complex(dtype inReal, dtype inImag)'],['../namespacenc.html#a56639fcc468435514861ce0e5059d82f',1,'nc::complex(dtype inReal)'],['../namespacenc.html#ab84a62b7de04ef6f69870e51f5dd8d00',1,'nc::complex(const NdArray< dtype > &inReal)'],['../namespacenc.html#a1d8b87baeef70163d94b40c96759ecc0',1,'nc::complex(const NdArray< dtype > &inReal, const NdArray< dtype > &inImag)']]], + ['complex_2ehpp_214',['complex.hpp',['../complex_8hpp.html',1,'']]], + ['complex_5fcast_215',['complex_cast',['../namespacenc.html#ad639d68db9e1b3ea9acc08efe4bad20e',1,'nc']]], + ['concatenate_216',['concatenate',['../namespacenc.html#a027070169f1750a74315d07c5bbdfb03',1,'nc']]], + ['concatenate_2ehpp_217',['concatenate.hpp',['../concatenate_8hpp.html',1,'']]], + ['conditional_5fno_5fexcept_218',['CONDITIONAL_NO_EXCEPT',['../_stl_algorithms_8hpp.html#a328745b2b79b264770ec2783aa489f26',1,'StlAlgorithms.hpp']]], + ['conj_219',['conj',['../namespacenc.html#a0387ae5584e72894ae9e690eba21e26b',1,'nc::conj(const std::complex< dtype > &inValue)'],['../namespacenc.html#a26e9df3c46d4f782d04c8d35881aad80',1,'nc::conj(const NdArray< std::complex< dtype >> &inArray)']]], + ['conj_2ehpp_220',['conj.hpp',['../conj_8hpp.html',1,'']]], + ['conjugate_221',['conjugate',['../classnc_1_1rotations_1_1_quaternion.html#ade406544e8360506bb77102d17b14e61',1,'nc::rotations::Quaternion']]], + ['const_5fcolumn_5fiterator_222',['const_column_iterator',['../classnc_1_1_nd_array.html#a1307cf472f722baa8850200dcb7a3a89',1,'nc::NdArray']]], + ['const_5fiterator_223',['const_iterator',['../classnc_1_1_nd_array.html#a49deeee0db98eae1c16ac6bca6fa6f31',1,'nc::NdArray::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a870aeb2f713b4efba22a2f978704c215',1,'nc::imageProcessing::ClusterMaker::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster.html#a3b344c255dfcfcf18e0fc9f1e84979ae',1,'nc::imageProcessing::Cluster::const_iterator()'],['../classnc_1_1_data_cube.html#a1ea7b9bd30731c3325545fbcd2678761',1,'nc::DataCube::const_iterator()']]], + ['const_5fpointer_224',['const_pointer',['../classnc_1_1_nd_array.html#a94982f81d8aa8c8a72abe0327f22b4dd',1,'nc::NdArray']]], + ['const_5freference_225',['const_reference',['../classnc_1_1_nd_array.html#a2e9001eb3a7fb5b44f6400b3cc3b3222',1,'nc::NdArray']]], + ['const_5freverse_5fcolumn_5fiterator_226',['const_reverse_column_iterator',['../classnc_1_1_nd_array.html#aa4f80e21b4b0f30ff98d1b90ae4fd70d',1,'nc::NdArray']]], + ['const_5freverse_5fiterator_227',['const_reverse_iterator',['../classnc_1_1_nd_array.html#a6de6f2ef3b2519edd272623a9681b527',1,'nc::NdArray']]], + ['constant_228',['CONSTANT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a8d6b5cada83510220f59e00ce86d4d92',1,'nc::filter']]], + ['constant1d_229',['constant1d',['../namespacenc_1_1filter_1_1boundary.html#a09c2e0a7f9ff3c1fbbbee0136d80a2e0',1,'nc::filter::boundary']]], + ['constant1d_2ehpp_230',['constant1d.hpp',['../constant1d_8hpp.html',1,'']]], + ['constant2d_231',['constant2d',['../namespacenc_1_1filter_1_1boundary.html#a0e0bd2ad1d6ac1b1d248175b9bc422f6',1,'nc::filter::boundary']]], + ['constant2d_2ehpp_232',['constant2d.hpp',['../constant2d_8hpp.html',1,'']]], + ['constants_2ehpp_233',['Constants.hpp',['../_constants_8hpp.html',1,'']]], + ['contains_234',['contains',['../classnc_1_1_nd_array.html#ad0c493a734dbca9f622d0f7ca6dffbf4',1,'nc::NdArray::contains()'],['../namespacenc.html#a89349379637971764e6efe28ad8c1848',1,'nc::contains()']]], + ['contains_2ehpp_235',['contains.hpp',['../contains_8hpp.html',1,'']]], + ['convolve_236',['convolve',['../namespacenc_1_1filter.html#abc4c77c759de3cd79f3fc02b7461d971',1,'nc::filter']]], + ['convolve_2ehpp_237',['convolve.hpp',['../convolve_8hpp.html',1,'']]], + ['convolve1d_238',['convolve1d',['../namespacenc_1_1filter.html#a21d48fecf984290cb5a4388d50371b13',1,'nc::filter']]], + ['convolve1d_2ehpp_239',['convolve1d.hpp',['../convolve1d_8hpp.html',1,'']]], + ['coordinate_240',['Coordinate',['../classnc_1_1coordinates_1_1_coordinate.html#a0f541169a4c318a5cf4fd0a50a4c2013',1,'nc::coordinates::Coordinate::Coordinate()=default'],['../classnc_1_1coordinates_1_1_coordinate.html#a983a167d97af973947f76474ab299ab8',1,'nc::coordinates::Coordinate::Coordinate(double inRaDegrees, double inDecDegrees)'],['../classnc_1_1coordinates_1_1_coordinate.html#a35b32fa280c920d0b528472f7726a03d',1,'nc::coordinates::Coordinate::Coordinate(const NdArray< double > &inCartesianVector)'],['../classnc_1_1coordinates_1_1_coordinate.html#aa023b8b0e74159909e99aabcf778c57f',1,'nc::coordinates::Coordinate::Coordinate(double inX, double inY, double inZ) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#a7cf9e8138023ced7cfcb071299018fd5',1,'nc::coordinates::Coordinate::Coordinate(const RA &inRA, const Dec &inDec) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#a68eafc66dfeb8551fa7d8960f116be83',1,'nc::coordinates::Coordinate::Coordinate(uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds)'],['../classnc_1_1coordinates_1_1_coordinate.html',1,'nc::coordinates::Coordinate']]], + ['coordinate_2ehpp_241',['Coordinate.hpp',['../_coordinate_8hpp.html',1,'']]], + ['coordinates_2ehpp_242',['Coordinates.hpp',['../_coordinates_8hpp.html',1,'']]], + ['copy_243',['copy',['../classnc_1_1_nd_array.html#a1f2d2aacc254129f36b0557a661e6664',1,'nc::NdArray::copy()'],['../namespacenc.html#a9bbe10d41fdbd74a6254bad44c7c7cf6',1,'nc::copy()'],['../namespacenc_1_1stl__algorithms.html#ae62a4e197ec640aacea520220bd27cef',1,'nc::stl_algorithms::copy()']]], + ['copy_2ehpp_244',['copy.hpp',['../copy_8hpp.html',1,'']]], + ['copysign_245',['copySign',['../namespacenc.html#a9e08e770fd2283734390ab631edc250d',1,'nc']]], + ['copysign_2ehpp_246',['copySign.hpp',['../copy_sign_8hpp.html',1,'']]], + ['copyto_247',['copyto',['../namespacenc.html#af8eca852439098c1fff96384d88d82dd',1,'nc']]], + ['copyto_2ehpp_248',['copyto.hpp',['../copyto_8hpp.html',1,'']]], + ['core_2ehpp_249',['Core.hpp',['../_core_8hpp.html',1,'']]], + ['corrcoef_250',['corrcoef',['../namespacenc.html#a2232014b014afca61e5ebe93c5ba2c0c',1,'nc']]], + ['corrcoef_2ehpp_251',['corrcoef.hpp',['../corrcoef_8hpp.html',1,'']]], + ['cos_252',['cos',['../namespacenc.html#a736de91eb8f79bfaf4dc92d7161f1c87',1,'nc::cos(dtype inValue) noexcept'],['../namespacenc.html#af208ae28fe0df17392ca128188cbcd73',1,'nc::cos(const NdArray< dtype > &inArray)']]], + ['cos_2ehpp_253',['cos.hpp',['../cos_8hpp.html',1,'']]], + ['cosh_254',['cosh',['../namespacenc.html#a520e0290bb667b43a9f494b3858b5f17',1,'nc::cosh(const NdArray< dtype > &inArray)'],['../namespacenc.html#abb07133a1f54b24a4a4986eefb5eda85',1,'nc::cosh(dtype inValue) noexcept']]], + ['cosh_2ehpp_255',['cosh.hpp',['../cosh_8hpp.html',1,'']]], + ['count_256',['count',['../namespacenc_1_1stl__algorithms.html#a1fa02155befc0c39a853e66f6df26745',1,'nc::stl_algorithms']]], + ['count_5fnonzero_257',['count_nonzero',['../namespacenc.html#aebb0dfe3637c07f6a9f6e4f08cacf515',1,'nc']]], + ['count_5fnonzero_2ehpp_258',['count_nonzero.hpp',['../count__nonzero_8hpp.html',1,'']]], + ['cov_259',['cov',['../namespacenc.html#a61dbb6e2f778525a305dc235a9a43c76',1,'nc']]], + ['cov_2ehpp_260',['cov.hpp',['../cov_8hpp.html',1,'']]], + ['cov_5finv_261',['cov_inv',['../namespacenc.html#a2a45ff9db0b44932844a5d9cb13b2d38',1,'nc']]], + ['cov_5finv_2ehpp_262',['cov_inv.hpp',['../cov__inv_8hpp.html',1,'']]], + ['crbegin_263',['crbegin',['../classnc_1_1_nd_array.html#a95cbc4440ac1e139642a08cbd075dafc',1,'nc::NdArray::crbegin() const noexcept'],['../classnc_1_1_nd_array.html#af6b2581fae90a5c67e87df6a82ea13c5',1,'nc::NdArray::crbegin(size_type inRow) const']]], + ['crcolbegin_264',['crcolbegin',['../classnc_1_1_nd_array.html#a35883ec844477b9bca2597939dd99c2a',1,'nc::NdArray::crcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a8afdb68c11124e1fe0309204f3996435',1,'nc::NdArray::crcolbegin(size_type inCol) const']]], + ['crcolend_265',['crcolend',['../classnc_1_1_nd_array.html#a55e5d41795f14f7f2aa256ba0f4bb676',1,'nc::NdArray::crcolend() const noexcept'],['../classnc_1_1_nd_array.html#a35b66f060b1ed99a6fb5247581fcb8fc',1,'nc::NdArray::crcolend(size_type inCol) const']]], + ['crend_266',['crend',['../classnc_1_1_nd_array.html#ac5d1c900c4db4263d1bf799ac3551ed6',1,'nc::NdArray::crend() const noexcept'],['../classnc_1_1_nd_array.html#af3b4c48e3328a8dd22eedd27c225aeb5',1,'nc::NdArray::crend(size_type inRow) const']]], + ['cross_267',['cross',['../classnc_1_1_vec3.html#af8173f6e61e9a63beae3092fd8dc4378',1,'nc::Vec3::cross()'],['../namespacenc.html#a4d1ed581965ed53090824290def38565',1,'nc::cross()']]], + ['cross_2ehpp_268',['cross.hpp',['../cross_8hpp.html',1,'']]], + ['cslice_269',['cSlice',['../classnc_1_1_nd_array.html#a29eabba849b35a3095cd341fa1c7b123',1,'nc::NdArray']]], + ['cube_270',['cube',['../namespacenc.html#a5899ccef8410243438debea3d8296df6',1,'nc::cube(dtype inValue) noexcept'],['../namespacenc.html#a224d96b41af957c782c02f1cb25e66fd',1,'nc::cube(const NdArray< dtype > &inArray)'],['../namespacenc_1_1utils.html#a46e88717d4d32003bb449fd5cefd401c',1,'nc::utils::cube()']]], + ['cumprod_271',['cumprod',['../classnc_1_1_nd_array.html#a75a231dec87e18370e9731214983858e',1,'nc::NdArray::cumprod()'],['../namespacenc.html#aafc4846f2f7956841d356060c9689cba',1,'nc::cumprod()']]], + ['cumprod_2ehpp_272',['cumprod.hpp',['../cumprod_8hpp.html',1,'']]], + ['cumsum_273',['cumsum',['../classnc_1_1_nd_array.html#a4baa93f2a125d7665f3cdfd8d96d3acc',1,'nc::NdArray::cumsum()'],['../namespacenc.html#a2abc8c4a18823234e3baec64d10c0dcd',1,'nc::cumsum()']]], + ['cumsum_2ehpp_274',['cumsum.hpp',['../cumsum_8hpp.html',1,'']]], + ['cyclic_5fhankel_5f1_275',['cyclic_hankel_1',['../namespacenc_1_1special.html#af5dd42de33ec77dda47dd089561895d5',1,'nc::special::cyclic_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ae7053cd6eafb59a62ba6ede63aac6f90',1,'nc::special::cyclic_hankel_1(dtype1 inV, const NdArray< dtype2 > &inX)']]], + ['cyclic_5fhankel_5f1_2ehpp_276',['cyclic_hankel_1.hpp',['../cyclic__hankel__1_8hpp.html',1,'']]], + ['cyclic_5fhankel_5f2_277',['cyclic_hankel_2',['../namespacenc_1_1special.html#a388472a49e89f21b3eb144368fe55664',1,'nc::special::cyclic_hankel_2(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a8e3b27238d1cae20e4ee071766549c5d',1,'nc::special::cyclic_hankel_2(dtype1 inV, const NdArray< dtype2 > &inX)']]], + ['cyclic_5fhankel_5f2_2ehpp_278',['cyclic_hankel_2.hpp',['../cyclic__hankel__2_8hpp.html',1,'']]], + ['shape_2ehpp_279',['Shape.hpp',['../_core_2_shape_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_3.html b/docs/doxygen/html/search/all_3.html index 93567f1e0..39767b85b 100644 --- a/docs/doxygen/html/search/all_3.html +++ b/docs/doxygen/html/search/all_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_3.js b/docs/doxygen/html/search/all_3.js index a3a187238..2a0d800b1 100644 --- a/docs/doxygen/html/search/all_3.js +++ b/docs/doxygen/html/search/all_3.js @@ -1,52 +1,54 @@ var searchData= [ - ['data_268',['data',['../classnc_1_1_nd_array.html#a14e4541ae1e02ee5acdc01e18337d546',1,'nc::NdArray::data() const noexcept'],['../classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49',1,'nc::NdArray::data() noexcept']]], - ['datacube_269',['DataCube',['../classnc_1_1_data_cube.html#a7ae08af82b0553d2b294286bdf06703b',1,'nc::DataCube::DataCube(uint32 inSize)'],['../classnc_1_1_data_cube.html#a8224b613a7c87a16e06ef08d6f90926e',1,'nc::DataCube::DataCube()=default'],['../classnc_1_1_data_cube.html',1,'nc::DataCube< dtype >']]], - ['datacube_2ehpp_270',['DataCube.hpp',['../_data_cube_8hpp.html',1,'']]], - ['datarelease_271',['dataRelease',['../classnc_1_1_nd_array.html#ade07629d4094244f1dfca863af67e7c0',1,'nc::NdArray']]], - ['days_5fper_5fweek_272',['DAYS_PER_WEEK',['../namespacenc_1_1constants.html#a2c11c386e1a07a17f95122fc4630cbe9',1,'nc::constants']]], - ['dcm_273',['DCM',['../classnc_1_1rotations_1_1_d_c_m.html',1,'nc::rotations']]], - ['dcm_2ehpp_274',['DCM.hpp',['../_d_c_m_8hpp.html',1,'']]], - ['dec_275',['Dec',['../classnc_1_1coordinates_1_1_dec.html#af462329adb3a1bdb1f6b724e7a92a442',1,'nc::coordinates::Dec::Dec(Sign inSign, uint8 inDegrees, uint8 inMinutes, double inSeconds) noexcept'],['../classnc_1_1coordinates_1_1_dec.html#a63de0ff17c7f842866893fdfacd0edb7',1,'nc::coordinates::Dec::Dec(double inDegrees)'],['../classnc_1_1coordinates_1_1_dec.html#af821e7394e5de4c396dd2c60aa7c0eca',1,'nc::coordinates::Dec::Dec()=default']]], - ['dec_276',['dec',['../classnc_1_1coordinates_1_1_coordinate.html#ab5502c231ff400b90fc9ede39a524eed',1,'nc::coordinates::Coordinate']]], - ['dec_277',['Dec',['../classnc_1_1coordinates_1_1_dec.html',1,'nc::coordinates']]], - ['dec_2ehpp_278',['Dec.hpp',['../_dec_8hpp.html',1,'']]], - ['deg2rad_279',['deg2rad',['../namespacenc.html#a2cdc1c791ab98eb708ba5662ffb82b39',1,'nc::deg2rad(dtype inValue) noexcept'],['../namespacenc.html#a828388cb973b4e28e0b7060694e2604a',1,'nc::deg2rad(const NdArray< dtype > &inArray)']]], - ['deg2rad_2ehpp_280',['deg2rad.hpp',['../deg2rad_8hpp.html',1,'']]], - ['degrees_281',['degrees',['../namespacenc.html#a75c2b6b4713a5695a4738da25cf9d262',1,'nc::degrees(dtype inValue) noexcept'],['../namespacenc.html#aab0d24a5ffaf73330854bbcfc47d2fee',1,'nc::degrees(const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_r_a.html#aaf73bcb5e2afd0e075c452148f67a3bd',1,'nc::coordinates::RA::degrees()'],['../classnc_1_1coordinates_1_1_dec.html#ad2e47ff7298e1b88bb1b77940c241c8f',1,'nc::coordinates::Dec::degrees()']]], - ['degrees_2ehpp_282',['degrees.hpp',['../degrees_8hpp.html',1,'']]], - ['degreeseperation_283',['degreeSeperation',['../namespacenc_1_1coordinates.html#a06135e21507cfe2aa1cb4154fe1702bf',1,'nc::coordinates::degreeSeperation(const Coordinate &inCoordinate1, const Coordinate &inCoordinate2)'],['../namespacenc_1_1coordinates.html#abc47b2d64d107bcb19ff696ecff89edf',1,'nc::coordinates::degreeSeperation(const NdArray< double > &inVector1, const NdArray< double > &inVector2)'],['../classnc_1_1coordinates_1_1_coordinate.html#a223ae10750fed3706997220e76f25c0d',1,'nc::coordinates::Coordinate::degreeSeperation(const NdArray< double > &inVector) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a9fd37a2cb2c3b45aee933e4e5f95d074',1,'nc::coordinates::Coordinate::degreeSeperation(const Coordinate &inOtherCoordinate) const']]], - ['degreeseperation_2ehpp_284',['degreeSeperation.hpp',['../degree_seperation_8hpp.html',1,'']]], - ['degreeswhole_285',['degreesWhole',['../classnc_1_1coordinates_1_1_dec.html#abe36c8e081efa41452dc10ddd7ffcda7',1,'nc::coordinates::Dec']]], - ['dekker_286',['Dekker',['../classnc_1_1roots_1_1_dekker.html#ab0a5db20e82cfd3ef95810ccb7d8c4e6',1,'nc::roots::Dekker::Dekker(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_dekker.html#a77b88bb369da2d03d34717b7d8e0a2ab',1,'nc::roots::Dekker::Dekker(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_dekker.html',1,'nc::roots::Dekker']]], - ['dekker_2ehpp_287',['Dekker.hpp',['../_dekker_8hpp.html',1,'']]], - ['deleteindices_288',['deleteIndices',['../namespacenc.html#a7c33539e037218ba9b0b11acfae38363',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const Slice &inIndicesSlice, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a53ddac04b49358cb41736640871bcea2',1,'nc::deleteIndices(const NdArray< dtype > &inArray, uint32 inIndex, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ae59479b36cd7991d9dfc2d836b4d838c',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const NdArray< uint32 > &inArrayIdxs, Axis inAxis=Axis::NONE)']]], - ['deleteindices_2ehpp_289',['deleteIndices.hpp',['../delete_indices_8hpp.html',1,'']]], - ['deriv_290',['deriv',['../classnc_1_1polynomial_1_1_poly1d.html#a06b9fb8a31de37a067c9ed54af6295d2',1,'nc::polynomial::Poly1d']]], - ['det_291',['det',['../namespacenc_1_1linalg.html#a55bafcebbc897458164e8dc511b6119c',1,'nc::linalg']]], - ['det_2ehpp_292',['det.hpp',['../det_8hpp.html',1,'']]], - ['diag_293',['diag',['../namespacenc.html#a8c80cee3e4853bc79290c995cf9d69dc',1,'nc']]], - ['diag_2ehpp_294',['diag.hpp',['../diag_8hpp.html',1,'']]], - ['diagflat_295',['diagflat',['../namespacenc.html#af3ab63d17fa40b3c3880a9065a95e47f',1,'nc']]], - ['diagflat_2ehpp_296',['diagflat.hpp',['../diagflat_8hpp.html',1,'']]], - ['diagonal_297',['diagonal',['../namespacenc.html#a8eeb67e5ad2a5b0567570a774b7fb1f3',1,'nc::diagonal()'],['../classnc_1_1_nd_array.html#aae6a8845bf3654a27265ecffee163628',1,'nc::NdArray::diagonal()']]], - ['diagonal_2ehpp_298',['diagonal.hpp',['../diagonal_8hpp.html',1,'']]], - ['diff_299',['diff',['../namespacenc.html#a94701ce8e9c8a4bb6dd162da5d07eadd',1,'nc']]], - ['diff_2ehpp_300',['diff.hpp',['../diff_8hpp.html',1,'']]], - ['difference_5ftype_301',['difference_type',['../classnc_1_1_nd_array_const_iterator.html#a16aa191e5615d641693ff077b56771ad',1,'nc::NdArrayConstIterator::difference_type()'],['../classnc_1_1_nd_array.html#a612cdd532e56b711ebb9c2478971c04f',1,'nc::NdArray::difference_type()'],['../classnc_1_1_nd_array_iterator.html#a871a849294da1c7e7b99250008471138',1,'nc::NdArrayIterator::difference_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad4e9c4a6df66608a4d6ea6e7608337ce',1,'nc::NdArrayConstColumnIterator::difference_type()'],['../classnc_1_1_nd_array_column_iterator.html#addc363984d95db8bed56843682372e44',1,'nc::NdArrayColumnIterator::difference_type()']]], - ['digamma_302',['digamma',['../namespacenc_1_1special.html#a78dead2375df379d1976ff87f62fbade',1,'nc::special::digamma(dtype inValue)'],['../namespacenc_1_1special.html#a6419633142287d898c551f99cd7c589d',1,'nc::special::digamma(const NdArray< dtype > &inArray)']]], - ['digamma_2ehpp_303',['digamma.hpp',['../digamma_8hpp.html',1,'']]], - ['discrete_304',['discrete',['../namespacenc_1_1random.html#ae5367b53538e888028853607e1c522a4',1,'nc::random::discrete(const Shape &inShape, const NdArray< double > &inWeights)'],['../namespacenc_1_1random.html#a2ea5db9ee73d9f7a633e5899e4be2c94',1,'nc::random::discrete(const NdArray< double > &inWeights)']]], - ['discrete_2ehpp_305',['discrete.hpp',['../discrete_8hpp.html',1,'']]], - ['distance_306',['distance',['../classnc_1_1_vec3.html#a301f3edcb8cb17e7e3e5dbdd5255bdd2',1,'nc::Vec3::distance()'],['../classnc_1_1_vec2.html#a63c2b2b7a16828af770d38176b6cb3aa',1,'nc::Vec2::distance()']]], - ['divide_307',['divide',['../namespacenc.html#aad734f111f1fc140c2c3c8fc84f398b5',1,'nc::divide(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#aed2d517035fdd5539971fa0c1dcb61df',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#ade8f0271af8c94c0a0e1166aba83a619',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a2389581759aa0446030642193638ef63',1,'nc::divide(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7d83e88182dd99da3ad09e76bb916a35',1,'nc::divide(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a85d01a50833bff37f13437cdd3e1a1a0',1,'nc::divide(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a48c5c456736ced98b946e89b573c204e',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a130f8bc6ccdb70da4cfb245659bc61af',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a9b10ead8c068b9b473023c993dc25d7c',1,'nc::divide(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], - ['divide_2ehpp_308',['divide.hpp',['../divide_8hpp.html',1,'']]], - ['dot_309',['dot',['../classnc_1_1_vec2.html#a231781cc06b8f005a1dda5003498ec99',1,'nc::Vec2::dot()'],['../namespacenc.html#a2c9414f356ae2025a7cde3a192d6d67d',1,'nc::dot()'],['../classnc_1_1_nd_array.html#acca065e13f826c504493a2eae31f5d0e',1,'nc::NdArray::dot()'],['../namespacenc.html#abfdbde62bdc084a9b8f9a894fa173c40',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a6ab78d4355c57b053b6e44f710d60528',1,'nc::dot(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../classnc_1_1_vec3.html#ac9f2bf549a4b800f140de060a0281a7e',1,'nc::Vec3::dot()']]], - ['dot_2ehpp_310',['dot.hpp',['../dot_8hpp.html',1,'']]], - ['down_311',['down',['../classnc_1_1_vec3.html#a4ea0c82948117391c6c42a99e3093f91',1,'nc::Vec3::down()'],['../classnc_1_1_vec2.html#a265ae124776dd84b657c4ff6d7677352',1,'nc::Vec2::down()']]], - ['dtypeinfo_312',['DtypeInfo',['../classnc_1_1_dtype_info.html',1,'nc']]], - ['dtypeinfo_2ehpp_313',['DtypeInfo.hpp',['../_dtype_info_8hpp.html',1,'']]], - ['dtypeinfo_3c_20std_3a_3acomplex_3c_20dtype_20_3e_20_3e_314',['DtypeInfo< std::complex< dtype > >',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html',1,'nc']]], - ['dump_315',['dump',['../classnc_1_1_nd_array.html#ada776db2a3c9ffef3dd7bf656cf75f08',1,'nc::NdArray::dump()'],['../classnc_1_1_data_cube.html#abbaa9ebba302183cae3563c9eb371ee3',1,'nc::DataCube::dump()'],['../namespacenc.html#af6e71bd96dbc78f9ca018d2da0a7e653',1,'nc::dump()']]], - ['dump_2ehpp_316',['dump.hpp',['../dump_8hpp.html',1,'']]] + ['data_280',['data',['../classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49',1,'nc::NdArray::data() noexcept'],['../classnc_1_1_nd_array.html#a14e4541ae1e02ee5acdc01e18337d546',1,'nc::NdArray::data() const noexcept']]], + ['databitscovered_281',['dataBitsCovered',['../namespacenc_1_1edac_1_1detail.html#aa8a14d5fd872ed0292631e57f5afe618',1,'nc::edac::detail']]], + ['datacube_282',['DataCube',['../classnc_1_1_data_cube.html#a7ae08af82b0553d2b294286bdf06703b',1,'nc::DataCube::DataCube(uint32 inSize)'],['../classnc_1_1_data_cube.html#a8224b613a7c87a16e06ef08d6f90926e',1,'nc::DataCube::DataCube()=default'],['../classnc_1_1_data_cube.html',1,'nc::DataCube< dtype >']]], + ['datacube_2ehpp_283',['DataCube.hpp',['../_data_cube_8hpp.html',1,'']]], + ['datarelease_284',['dataRelease',['../classnc_1_1_nd_array.html#ade07629d4094244f1dfca863af67e7c0',1,'nc::NdArray']]], + ['days_5fper_5fweek_285',['DAYS_PER_WEEK',['../namespacenc_1_1constants.html#a2c11c386e1a07a17f95122fc4630cbe9',1,'nc::constants']]], + ['dcm_286',['DCM',['../classnc_1_1rotations_1_1_d_c_m.html',1,'nc::rotations']]], + ['dcm_2ehpp_287',['DCM.hpp',['../_d_c_m_8hpp.html',1,'']]], + ['dec_288',['Dec',['../classnc_1_1coordinates_1_1_dec.html#af462329adb3a1bdb1f6b724e7a92a442',1,'nc::coordinates::Dec::Dec(Sign inSign, uint8 inDegrees, uint8 inMinutes, double inSeconds) noexcept'],['../classnc_1_1coordinates_1_1_dec.html#af821e7394e5de4c396dd2c60aa7c0eca',1,'nc::coordinates::Dec::Dec()=default'],['../classnc_1_1coordinates_1_1_dec.html#a63de0ff17c7f842866893fdfacd0edb7',1,'nc::coordinates::Dec::Dec(double inDegrees)']]], + ['dec_289',['dec',['../classnc_1_1coordinates_1_1_coordinate.html#ab5502c231ff400b90fc9ede39a524eed',1,'nc::coordinates::Coordinate']]], + ['dec_290',['Dec',['../classnc_1_1coordinates_1_1_dec.html',1,'nc::coordinates']]], + ['dec_2ehpp_291',['Dec.hpp',['../_dec_8hpp.html',1,'']]], + ['decode_292',['decode',['../namespacenc_1_1edac.html#aa24d4f99fd0739df7480845e96668e0f',1,'nc::edac']]], + ['deg2rad_293',['deg2rad',['../namespacenc.html#a2cdc1c791ab98eb708ba5662ffb82b39',1,'nc::deg2rad(dtype inValue) noexcept'],['../namespacenc.html#a828388cb973b4e28e0b7060694e2604a',1,'nc::deg2rad(const NdArray< dtype > &inArray)']]], + ['deg2rad_2ehpp_294',['deg2rad.hpp',['../deg2rad_8hpp.html',1,'']]], + ['degrees_295',['degrees',['../classnc_1_1coordinates_1_1_dec.html#ad2e47ff7298e1b88bb1b77940c241c8f',1,'nc::coordinates::Dec::degrees()'],['../namespacenc.html#aab0d24a5ffaf73330854bbcfc47d2fee',1,'nc::degrees()'],['../classnc_1_1coordinates_1_1_r_a.html#aaf73bcb5e2afd0e075c452148f67a3bd',1,'nc::coordinates::RA::degrees()'],['../namespacenc.html#a75c2b6b4713a5695a4738da25cf9d262',1,'nc::degrees()']]], + ['degrees_2ehpp_296',['degrees.hpp',['../degrees_8hpp.html',1,'']]], + ['degreeseperation_297',['degreeSeperation',['../namespacenc_1_1coordinates.html#a06135e21507cfe2aa1cb4154fe1702bf',1,'nc::coordinates::degreeSeperation()'],['../classnc_1_1coordinates_1_1_coordinate.html#a9fd37a2cb2c3b45aee933e4e5f95d074',1,'nc::coordinates::Coordinate::degreeSeperation(const Coordinate &inOtherCoordinate) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a223ae10750fed3706997220e76f25c0d',1,'nc::coordinates::Coordinate::degreeSeperation(const NdArray< double > &inVector) const'],['../namespacenc_1_1coordinates.html#abc47b2d64d107bcb19ff696ecff89edf',1,'nc::coordinates::degreeSeperation()']]], + ['degreeseperation_2ehpp_298',['degreeSeperation.hpp',['../degree_seperation_8hpp.html',1,'']]], + ['degreeswhole_299',['degreesWhole',['../classnc_1_1coordinates_1_1_dec.html#abe36c8e081efa41452dc10ddd7ffcda7',1,'nc::coordinates::Dec']]], + ['dekker_300',['Dekker',['../classnc_1_1roots_1_1_dekker.html#a77b88bb369da2d03d34717b7d8e0a2ab',1,'nc::roots::Dekker::Dekker(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_dekker.html#ab0a5db20e82cfd3ef95810ccb7d8c4e6',1,'nc::roots::Dekker::Dekker(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_dekker.html',1,'nc::roots::Dekker']]], + ['dekker_2ehpp_301',['Dekker.hpp',['../_dekker_8hpp.html',1,'']]], + ['deleteindices_302',['deleteIndices',['../namespacenc.html#ae59479b36cd7991d9dfc2d836b4d838c',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const NdArray< uint32 > &inArrayIdxs, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a7c33539e037218ba9b0b11acfae38363',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const Slice &inIndicesSlice, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a53ddac04b49358cb41736640871bcea2',1,'nc::deleteIndices(const NdArray< dtype > &inArray, uint32 inIndex, Axis inAxis=Axis::NONE)']]], + ['deleteindices_2ehpp_303',['deleteIndices.hpp',['../delete_indices_8hpp.html',1,'']]], + ['deriv_304',['deriv',['../classnc_1_1polynomial_1_1_poly1d.html#a06b9fb8a31de37a067c9ed54af6295d2',1,'nc::polynomial::Poly1d']]], + ['det_305',['det',['../namespacenc_1_1linalg.html#a55bafcebbc897458164e8dc511b6119c',1,'nc::linalg']]], + ['det_2ehpp_306',['det.hpp',['../det_8hpp.html',1,'']]], + ['diag_307',['diag',['../namespacenc.html#a8c80cee3e4853bc79290c995cf9d69dc',1,'nc']]], + ['diag_2ehpp_308',['diag.hpp',['../diag_8hpp.html',1,'']]], + ['diagflat_309',['diagflat',['../namespacenc.html#af3ab63d17fa40b3c3880a9065a95e47f',1,'nc']]], + ['diagflat_2ehpp_310',['diagflat.hpp',['../diagflat_8hpp.html',1,'']]], + ['diagonal_311',['diagonal',['../classnc_1_1_nd_array.html#aae6a8845bf3654a27265ecffee163628',1,'nc::NdArray::diagonal()'],['../namespacenc.html#a8eeb67e5ad2a5b0567570a774b7fb1f3',1,'nc::diagonal()']]], + ['diagonal_2ehpp_312',['diagonal.hpp',['../diagonal_8hpp.html',1,'']]], + ['diff_313',['diff',['../namespacenc.html#a94701ce8e9c8a4bb6dd162da5d07eadd',1,'nc']]], + ['diff_2ehpp_314',['diff.hpp',['../diff_8hpp.html',1,'']]], + ['difference_5ftype_315',['difference_type',['../classnc_1_1_nd_array_column_iterator.html#addc363984d95db8bed56843682372e44',1,'nc::NdArrayColumnIterator::difference_type()'],['../classnc_1_1_nd_array.html#a612cdd532e56b711ebb9c2478971c04f',1,'nc::NdArray::difference_type()'],['../classnc_1_1_nd_array_const_iterator.html#a16aa191e5615d641693ff077b56771ad',1,'nc::NdArrayConstIterator::difference_type()'],['../classnc_1_1_nd_array_iterator.html#a871a849294da1c7e7b99250008471138',1,'nc::NdArrayIterator::difference_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad4e9c4a6df66608a4d6ea6e7608337ce',1,'nc::NdArrayConstColumnIterator::difference_type()']]], + ['digamma_316',['digamma',['../namespacenc_1_1special.html#a78dead2375df379d1976ff87f62fbade',1,'nc::special::digamma(dtype inValue)'],['../namespacenc_1_1special.html#a6419633142287d898c551f99cd7c589d',1,'nc::special::digamma(const NdArray< dtype > &inArray)']]], + ['digamma_2ehpp_317',['digamma.hpp',['../digamma_8hpp.html',1,'']]], + ['discrete_318',['discrete',['../namespacenc_1_1random.html#a2ea5db9ee73d9f7a633e5899e4be2c94',1,'nc::random::discrete(const NdArray< double > &inWeights)'],['../namespacenc_1_1random.html#ae5367b53538e888028853607e1c522a4',1,'nc::random::discrete(const Shape &inShape, const NdArray< double > &inWeights)']]], + ['discrete_2ehpp_319',['discrete.hpp',['../discrete_8hpp.html',1,'']]], + ['distance_320',['distance',['../classnc_1_1_vec2.html#a63c2b2b7a16828af770d38176b6cb3aa',1,'nc::Vec2::distance()'],['../classnc_1_1_vec3.html#a301f3edcb8cb17e7e3e5dbdd5255bdd2',1,'nc::Vec3::distance()']]], + ['divide_321',['divide',['../namespacenc.html#a48c5c456736ced98b946e89b573c204e',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a85d01a50833bff37f13437cdd3e1a1a0',1,'nc::divide(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#aad734f111f1fc140c2c3c8fc84f398b5',1,'nc::divide(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#aed2d517035fdd5539971fa0c1dcb61df',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#ade8f0271af8c94c0a0e1166aba83a619',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a2389581759aa0446030642193638ef63',1,'nc::divide(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7d83e88182dd99da3ad09e76bb916a35',1,'nc::divide(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a130f8bc6ccdb70da4cfb245659bc61af',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a9b10ead8c068b9b473023c993dc25d7c',1,'nc::divide(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], + ['divide_2ehpp_322',['divide.hpp',['../divide_8hpp.html',1,'']]], + ['dot_323',['dot',['../classnc_1_1_nd_array.html#acca065e13f826c504493a2eae31f5d0e',1,'nc::NdArray::dot()'],['../classnc_1_1_vec2.html#a231781cc06b8f005a1dda5003498ec99',1,'nc::Vec2::dot()'],['../classnc_1_1_vec3.html#ac9f2bf549a4b800f140de060a0281a7e',1,'nc::Vec3::dot()'],['../namespacenc.html#a2c9414f356ae2025a7cde3a192d6d67d',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#abfdbde62bdc084a9b8f9a894fa173c40',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a6ab78d4355c57b053b6e44f710d60528',1,'nc::dot(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)']]], + ['dot_2ehpp_324',['dot.hpp',['../dot_8hpp.html',1,'']]], + ['down_325',['down',['../classnc_1_1_vec2.html#a265ae124776dd84b657c4ff6d7677352',1,'nc::Vec2::down()'],['../classnc_1_1_vec3.html#a4ea0c82948117391c6c42a99e3093f91',1,'nc::Vec3::down()']]], + ['dtypeinfo_326',['DtypeInfo',['../classnc_1_1_dtype_info.html',1,'nc']]], + ['dtypeinfo_2ehpp_327',['DtypeInfo.hpp',['../_dtype_info_8hpp.html',1,'']]], + ['dtypeinfo_3c_20std_3a_3acomplex_3c_20dtype_20_3e_20_3e_328',['DtypeInfo< std::complex< dtype > >',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html',1,'nc']]], + ['dump_329',['dump',['../classnc_1_1_data_cube.html#abbaa9ebba302183cae3563c9eb371ee3',1,'nc::DataCube::dump()'],['../classnc_1_1_nd_array.html#ada776db2a3c9ffef3dd7bf656cf75f08',1,'nc::NdArray::dump()'],['../namespacenc.html#af6e71bd96dbc78f9ca018d2da0a7e653',1,'nc::dump()']]], + ['dump_2ehpp_330',['dump.hpp',['../dump_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_4.html b/docs/doxygen/html/search/all_4.html index 9fab82fad..fc40463c8 100644 --- a/docs/doxygen/html/search/all_4.html +++ b/docs/doxygen/html/search/all_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_4.js b/docs/doxygen/html/search/all_4.js index fb72d99b6..3c3c34d2a 100644 --- a/docs/doxygen/html/search/all_4.js +++ b/docs/doxygen/html/search/all_4.js @@ -1,54 +1,58 @@ var searchData= [ - ['e_317',['e',['../namespacenc_1_1constants.html#aebabe96d6c2be3df3d71922b399e24c7',1,'nc::constants']]], - ['ellint_5f1_318',['ellint_1',['../namespacenc_1_1special.html#a0198bebbecba53e96b36d270be457490',1,'nc::special::ellint_1(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)'],['../namespacenc_1_1special.html#aa7fd769db69bde9583f039306c011816',1,'nc::special::ellint_1(dtype1 inK, dtype2 inP)']]], - ['ellint_5f1_2ehpp_319',['ellint_1.hpp',['../ellint__1_8hpp.html',1,'']]], - ['ellint_5f2_320',['ellint_2',['../namespacenc_1_1special.html#a920986b87a9c40529343491bebdadfe0',1,'nc::special::ellint_2(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)'],['../namespacenc_1_1special.html#ab9c4568493afa63db21d5b88f3c2a82d',1,'nc::special::ellint_2(dtype1 inK, dtype2 inP)']]], - ['ellint_5f2_2ehpp_321',['ellint_2.hpp',['../ellint__2_8hpp.html',1,'']]], - ['ellint_5f3_322',['ellint_3',['../namespacenc_1_1special.html#aaf7e9aa3cce2502f67735c787588a2eb',1,'nc::special::ellint_3(dtype1 inK, dtype2 inV, dtype3 inP)'],['../namespacenc_1_1special.html#ab04eafe87336f4206d63b804dc8653ca',1,'nc::special::ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV, const NdArray< dtype3 > &inArrayP)']]], - ['ellint_5f3_2ehpp_323',['ellint_3.hpp',['../ellint__3_8hpp.html',1,'']]], - ['empty_324',['empty',['../namespacenc.html#a47dcd15b30a7fd2b977377ebb37cbdb6',1,'nc::empty(const Shape &inShape)'],['../namespacenc.html#a3da6e6c01236f9c2af8591a890f7d717',1,'nc::empty(uint32 inNumRows, uint32 inNumCols)']]], - ['empty_2ehpp_325',['empty.hpp',['../empty_8hpp.html',1,'']]], - ['empty_5flike_326',['empty_like',['../namespacenc.html#ad03bf017e6cc91a4169134de885bb9ad',1,'nc']]], - ['empty_5flike_2ehpp_327',['empty_like.hpp',['../empty__like_8hpp.html',1,'']]], - ['enable_5fif_5ft_328',['enable_if_t',['../namespacenc.html#ae6f8d4a50bd2b4254f00085e7f17ce01',1,'nc']]], - ['end_329',['end',['../classnc_1_1_nd_array.html#a546c8b9de00188fab35a6c5075147cc1',1,'nc::NdArray::end(size_type inRow) const'],['../classnc_1_1_nd_array.html#a635448f7b5d598e3a978d2c2e62d7727',1,'nc::NdArray::end() const noexcept'],['../classnc_1_1_nd_array.html#a229701da7e9b386f5a58e5f1dc00bb73',1,'nc::NdArray::end(size_type inRow)'],['../classnc_1_1_nd_array.html#a153d3032d72c24d233407a351d0f8174',1,'nc::NdArray::end() noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a7d5ceccddb2db3b143c772ec9d66460a',1,'nc::imageProcessing::ClusterMaker::end()'],['../classnc_1_1image_processing_1_1_cluster.html#afc8b5d168cf1d611be9f5226ec7efd55',1,'nc::imageProcessing::Cluster::end()'],['../classnc_1_1_data_cube.html#a9aeac78f9aec9b69b9673c1e56778b1b',1,'nc::DataCube::end()']]], - ['endian_330',['Endian',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152',1,'nc']]], - ['endian_2ehpp_331',['Endian.hpp',['../_endian_8hpp.html',1,'']]], - ['endianess_332',['endianess',['../namespacenc.html#a6d1bce5e0cf3f24f84a50b945eec7a26',1,'nc::endianess()'],['../classnc_1_1_nd_array.html#a349b83beffbfb0a631799f921f13f7ad',1,'nc::NdArray::endianess()']]], - ['endianess_2ehpp_333',['endianess.hpp',['../endianess_8hpp.html',1,'']]], - ['eod_334',['eod',['../classnc_1_1image_processing_1_1_centroid.html#a098ee235ea6fcf22df2a7a0d80d53e44',1,'nc::imageProcessing::Centroid::eod()'],['../classnc_1_1image_processing_1_1_cluster.html#a461863af036452bdb1813dfff33c7c42',1,'nc::imageProcessing::Cluster::eod()']]], - ['epsilon_335',['epsilon',['../classnc_1_1_dtype_info.html#a845cc6986a3912805ab68960bc2b2318',1,'nc::DtypeInfo::epsilon()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a01e23e6687e74de38a9799934aa94d69',1,'nc::DtypeInfo< std::complex< dtype > >::epsilon()']]], - ['epsilon_5f_336',['epsilon_',['../classnc_1_1roots_1_1_iteration.html#a5eafe219bb90f82da4ece84f012a411a',1,'nc::roots::Iteration']]], - ['equal_337',['equal',['../namespacenc_1_1stl__algorithms.html#ab200b92040bf3da8ee4325f5a994e73d',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2) noexcept'],['../namespacenc_1_1stl__algorithms.html#a684d1011b375da4078afb4474a36b0e6',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, BinaryPredicate p) noexcept'],['../namespacenc.html#a7440518ae70823ac15ea1711d8df7bfc',1,'nc::equal()']]], - ['equal_2ehpp_338',['equal.hpp',['../equal_8hpp.html',1,'']]], - ['erf_339',['erf',['../namespacenc_1_1special.html#a8b2da132f8a6d86ea0bcce34819d1833',1,'nc::special::erf(dtype inValue)'],['../namespacenc_1_1special.html#a5b7ac05949538787c3fdec373cb05126',1,'nc::special::erf(const NdArray< dtype > &inArray)']]], - ['erf_2ehpp_340',['erf.hpp',['../erf_8hpp.html',1,'']]], - ['erf_5finv_341',['erf_inv',['../namespacenc_1_1special.html#abab69146b99ff384c6de4a24da69a780',1,'nc::special::erf_inv(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a0f66785ec1e2643dd4c932ff7cae61a4',1,'nc::special::erf_inv(dtype inValue)']]], - ['erf_5finv_2ehpp_342',['erf_inv.hpp',['../erf__inv_8hpp.html',1,'']]], - ['erfc_343',['erfc',['../namespacenc_1_1special.html#a1673dca59c73c85eedf077fb62aab5d7',1,'nc::special::erfc(dtype inValue)'],['../namespacenc_1_1special.html#a8671b7ab0e06230889f4a0cf417a248f',1,'nc::special::erfc(const NdArray< dtype > &inArray)']]], - ['erfc_2ehpp_344',['erfc.hpp',['../erfc_8hpp.html',1,'']]], - ['erfc_5finv_345',['erfc_inv',['../namespacenc_1_1special.html#a653404a544d777c6d7d636a207ee7bca',1,'nc::special::erfc_inv(dtype inValue)'],['../namespacenc_1_1special.html#a3c9551b639e79ce3024fef298f4ace8c',1,'nc::special::erfc_inv(const NdArray< dtype > &inArray)']]], - ['erfc_5finv_2ehpp_346',['erfc_inv.hpp',['../erfc__inv_8hpp.html',1,'']]], - ['error_2ehpp_347',['Error.hpp',['../_error_8hpp.html',1,'']]], - ['essentiallyequal_348',['essentiallyEqual',['../namespacenc_1_1utils.html#a963b90e7c9a3b057a924298750ddf74c',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc_1_1utils.html#aedd8afd691cf9f5a8f8e12c9ca33743a',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2, dtype inEpsilon) noexcept'],['../namespacenc_1_1utils.html#a139da62fc9c51ae191e7451bb4edb706',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2) noexcept'],['../namespacenc_1_1utils.html#a7e935ef90aaa774b37e6ab4b5316e01f',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2, const std::complex< dtype > &inEpsilon) noexcept']]], - ['essentiallyequal_2ehpp_349',['essentiallyEqual.hpp',['../essentially_equal_8hpp.html',1,'']]], - ['eulerangles_350',['eulerAngles',['../classnc_1_1rotations_1_1_d_c_m.html#a75a392cc2db9f9fdcfd8e212d152c9ff',1,'nc::rotations::DCM::eulerAngles(double roll, double pitch, double yaw)'],['../classnc_1_1rotations_1_1_d_c_m.html#a7ad5acfeac4205b7ee348332cb7aeadd',1,'nc::rotations::DCM::eulerAngles(const NdArray< double > &angles)']]], - ['euleraxisangle_351',['eulerAxisAngle',['../classnc_1_1rotations_1_1_d_c_m.html#aeb6400855cfc4163e09f03b101fe2d92',1,'nc::rotations::DCM::eulerAxisAngle(const NdArray< double > &inAxis, double inAngle)'],['../classnc_1_1rotations_1_1_d_c_m.html#a4da503d407f8ad563ec41364ff5b3b43',1,'nc::rotations::DCM::eulerAxisAngle(const Vec3 &inAxis, double inAngle)']]], - ['exists_352',['exists',['../classnc_1_1filesystem_1_1_file.html#a9a9b7d3f9505b025038e16a469553515',1,'nc::filesystem::File']]], - ['exp_353',['exp',['../namespacenc.html#a4069791fefff15148813bbbbadf064b1',1,'nc::exp(const NdArray< dtype > &inArray)'],['../namespacenc.html#ad7e555d480465930a7ac44f4ab39eea7',1,'nc::exp(dtype inValue) noexcept']]], - ['exp_2ehpp_354',['exp.hpp',['../exp_8hpp.html',1,'']]], - ['exp2_355',['exp2',['../namespacenc.html#a0595c87603ad5c35ddc78eab15148db7',1,'nc::exp2(const NdArray< dtype > &inArray)'],['../namespacenc.html#aafbab1d2bd67c753fb1656e037bd8b1d',1,'nc::exp2(dtype inValue) noexcept']]], - ['exp2_2ehpp_356',['exp2.hpp',['../exp2_8hpp.html',1,'']]], - ['expint_357',['expint',['../namespacenc_1_1special.html#a23097c9d953be37f1399154274ba2ff1',1,'nc::special::expint(dtype inX)'],['../namespacenc_1_1special.html#a98e6e3ad00faf7aef9f90e1c187f49b0',1,'nc::special::expint(const NdArray< dtype > &inArrayX)']]], - ['expint_2ehpp_358',['expint.hpp',['../expint_8hpp.html',1,'']]], - ['expm1_359',['expm1',['../namespacenc.html#a1f8b7ba3bb64b868fc41508d6912afab',1,'nc::expm1(dtype inValue) noexcept'],['../namespacenc.html#ac1e31d2bff523a5936799445f16d11af',1,'nc::expm1(const NdArray< dtype > &inArray)']]], - ['expm1_2ehpp_360',['expm1.hpp',['../expm1_8hpp.html',1,'']]], - ['exponential_361',['exponential',['../namespacenc_1_1random.html#a5d71db2fa4d818d737554405776d2aea',1,'nc::random::exponential(const Shape &inShape, dtype inScaleValue=1)'],['../namespacenc_1_1random.html#a278212d1b177cb2bba47215d083bb10f',1,'nc::random::exponential(dtype inScaleValue=1)']]], - ['exponential_2ehpp_362',['exponential.hpp',['../exponential_8hpp.html',1,'']]], - ['ext_363',['ext',['../classnc_1_1filesystem_1_1_file.html#ac51df5a278a9b6045d6f241766c10483',1,'nc::filesystem::File']]], - ['extremevalue_364',['extremeValue',['../namespacenc_1_1random.html#a11144426dec05283d6c682e0e532af7e',1,'nc::random::extremeValue(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#a6a5f569b594585794e6b268576d2e587',1,'nc::random::extremeValue(const Shape &inShape, dtype inA=1, dtype inB=1)']]], - ['extremevalue_2ehpp_365',['extremeValue.hpp',['../extreme_value_8hpp.html',1,'']]], - ['eye_366',['eye',['../namespacenc.html#a944a26b6ffe66b39ab9ba6972906bf55',1,'nc::eye(uint32 inN, uint32 inM, int32 inK=0)'],['../namespacenc.html#a1af40ed299fe04e075ca80d0d00dfba0',1,'nc::eye(uint32 inN, int32 inK=0)'],['../namespacenc.html#aa5328556ac755d5aafbe0f0e5d0c7af3',1,'nc::eye(const Shape &inShape, int32 inK=0)']]], - ['eye_2ehpp_367',['eye.hpp',['../eye_8hpp.html',1,'']]] + ['e_331',['e',['../namespacenc_1_1constants.html#aebabe96d6c2be3df3d71922b399e24c7',1,'nc::constants']]], + ['ellint_5f1_332',['ellint_1',['../namespacenc_1_1special.html#a0198bebbecba53e96b36d270be457490',1,'nc::special::ellint_1(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)'],['../namespacenc_1_1special.html#aa7fd769db69bde9583f039306c011816',1,'nc::special::ellint_1(dtype1 inK, dtype2 inP)']]], + ['ellint_5f1_2ehpp_333',['ellint_1.hpp',['../ellint__1_8hpp.html',1,'']]], + ['ellint_5f2_334',['ellint_2',['../namespacenc_1_1special.html#a920986b87a9c40529343491bebdadfe0',1,'nc::special::ellint_2(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)'],['../namespacenc_1_1special.html#ab9c4568493afa63db21d5b88f3c2a82d',1,'nc::special::ellint_2(dtype1 inK, dtype2 inP)']]], + ['ellint_5f2_2ehpp_335',['ellint_2.hpp',['../ellint__2_8hpp.html',1,'']]], + ['ellint_5f3_336',['ellint_3',['../namespacenc_1_1special.html#aaf7e9aa3cce2502f67735c787588a2eb',1,'nc::special::ellint_3(dtype1 inK, dtype2 inV, dtype3 inP)'],['../namespacenc_1_1special.html#ab04eafe87336f4206d63b804dc8653ca',1,'nc::special::ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV, const NdArray< dtype3 > &inArrayP)']]], + ['ellint_5f3_2ehpp_337',['ellint_3.hpp',['../ellint__3_8hpp.html',1,'']]], + ['empty_338',['empty',['../namespacenc.html#a47dcd15b30a7fd2b977377ebb37cbdb6',1,'nc::empty(const Shape &inShape)'],['../namespacenc.html#a3da6e6c01236f9c2af8591a890f7d717',1,'nc::empty(uint32 inNumRows, uint32 inNumCols)']]], + ['empty_2ehpp_339',['empty.hpp',['../empty_8hpp.html',1,'']]], + ['empty_5flike_340',['empty_like',['../namespacenc.html#ad03bf017e6cc91a4169134de885bb9ad',1,'nc']]], + ['empty_5flike_2ehpp_341',['empty_like.hpp',['../empty__like_8hpp.html',1,'']]], + ['enable_5fif_5ft_342',['enable_if_t',['../namespacenc.html#ae6f8d4a50bd2b4254f00085e7f17ce01',1,'nc']]], + ['encode_343',['encode',['../namespacenc_1_1edac.html#af5c36a1f2c74d632192cf9fe29cc5f03',1,'nc::edac']]], + ['end_344',['end',['../classnc_1_1image_processing_1_1_cluster_maker.html#a7d5ceccddb2db3b143c772ec9d66460a',1,'nc::imageProcessing::ClusterMaker::end()'],['../classnc_1_1_nd_array.html#a153d3032d72c24d233407a351d0f8174',1,'nc::NdArray::end() noexcept'],['../classnc_1_1_nd_array.html#a229701da7e9b386f5a58e5f1dc00bb73',1,'nc::NdArray::end(size_type inRow)'],['../classnc_1_1_nd_array.html#a635448f7b5d598e3a978d2c2e62d7727',1,'nc::NdArray::end() const noexcept'],['../classnc_1_1image_processing_1_1_cluster.html#afc8b5d168cf1d611be9f5226ec7efd55',1,'nc::imageProcessing::Cluster::end()'],['../classnc_1_1_data_cube.html#a9aeac78f9aec9b69b9673c1e56778b1b',1,'nc::DataCube::end()'],['../classnc_1_1_nd_array.html#a546c8b9de00188fab35a6c5075147cc1',1,'nc::NdArray::end()']]], + ['endian_345',['Endian',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152',1,'nc']]], + ['endian_2ehpp_346',['Endian.hpp',['../_endian_8hpp.html',1,'']]], + ['endianess_347',['endianess',['../classnc_1_1_nd_array.html#a349b83beffbfb0a631799f921f13f7ad',1,'nc::NdArray::endianess()'],['../namespacenc.html#a6d1bce5e0cf3f24f84a50b945eec7a26',1,'nc::endianess()']]], + ['endianess_2ehpp_348',['endianess.hpp',['../endianess_8hpp.html',1,'']]], + ['eod_349',['eod',['../classnc_1_1image_processing_1_1_centroid.html#a098ee235ea6fcf22df2a7a0d80d53e44',1,'nc::imageProcessing::Centroid::eod()'],['../classnc_1_1image_processing_1_1_cluster.html#a461863af036452bdb1813dfff33c7c42',1,'nc::imageProcessing::Cluster::eod()']]], + ['epsilon_350',['epsilon',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a01e23e6687e74de38a9799934aa94d69',1,'nc::DtypeInfo< std::complex< dtype > >::epsilon()'],['../classnc_1_1_dtype_info.html#a845cc6986a3912805ab68960bc2b2318',1,'nc::DtypeInfo::epsilon()']]], + ['epsilon_5f_351',['epsilon_',['../classnc_1_1roots_1_1_iteration.html#a5eafe219bb90f82da4ece84f012a411a',1,'nc::roots::Iteration']]], + ['equal_352',['equal',['../namespacenc_1_1stl__algorithms.html#ab200b92040bf3da8ee4325f5a994e73d',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2) noexcept'],['../namespacenc_1_1stl__algorithms.html#a684d1011b375da4078afb4474a36b0e6',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, BinaryPredicate p) noexcept'],['../namespacenc.html#a7440518ae70823ac15ea1711d8df7bfc',1,'nc::equal()']]], + ['equal_2ehpp_353',['equal.hpp',['../equal_8hpp.html',1,'']]], + ['erf_354',['erf',['../namespacenc_1_1special.html#a8b2da132f8a6d86ea0bcce34819d1833',1,'nc::special::erf(dtype inValue)'],['../namespacenc_1_1special.html#a5b7ac05949538787c3fdec373cb05126',1,'nc::special::erf(const NdArray< dtype > &inArray)']]], + ['erf_2ehpp_355',['erf.hpp',['../erf_8hpp.html',1,'']]], + ['erf_5finv_356',['erf_inv',['../namespacenc_1_1special.html#a0f66785ec1e2643dd4c932ff7cae61a4',1,'nc::special::erf_inv(dtype inValue)'],['../namespacenc_1_1special.html#abab69146b99ff384c6de4a24da69a780',1,'nc::special::erf_inv(const NdArray< dtype > &inArray)']]], + ['erf_5finv_2ehpp_357',['erf_inv.hpp',['../erf__inv_8hpp.html',1,'']]], + ['erfc_358',['erfc',['../namespacenc_1_1special.html#a1673dca59c73c85eedf077fb62aab5d7',1,'nc::special::erfc(dtype inValue)'],['../namespacenc_1_1special.html#a8671b7ab0e06230889f4a0cf417a248f',1,'nc::special::erfc(const NdArray< dtype > &inArray)']]], + ['erfc_2ehpp_359',['erfc.hpp',['../erfc_8hpp.html',1,'']]], + ['erfc_5finv_360',['erfc_inv',['../namespacenc_1_1special.html#a653404a544d777c6d7d636a207ee7bca',1,'nc::special::erfc_inv(dtype inValue)'],['../namespacenc_1_1special.html#a3c9551b639e79ce3024fef298f4ace8c',1,'nc::special::erfc_inv(const NdArray< dtype > &inArray)']]], + ['erfc_5finv_2ehpp_361',['erfc_inv.hpp',['../erfc__inv_8hpp.html',1,'']]], + ['error_2ehpp_362',['Error.hpp',['../_error_8hpp.html',1,'']]], + ['essentiallyequal_363',['essentiallyEqual',['../namespacenc_1_1utils.html#aedd8afd691cf9f5a8f8e12c9ca33743a',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2, dtype inEpsilon) noexcept'],['../namespacenc_1_1utils.html#a7e935ef90aaa774b37e6ab4b5316e01f',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2, const std::complex< dtype > &inEpsilon) noexcept'],['../namespacenc_1_1utils.html#a139da62fc9c51ae191e7451bb4edb706',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2) noexcept'],['../namespacenc_1_1utils.html#a963b90e7c9a3b057a924298750ddf74c',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2) noexcept']]], + ['essentiallyequal_2ehpp_364',['essentiallyEqual.hpp',['../essentially_equal_8hpp.html',1,'']]], + ['eulerangles_365',['eulerAngles',['../classnc_1_1rotations_1_1_d_c_m.html#a7ad5acfeac4205b7ee348332cb7aeadd',1,'nc::rotations::DCM::eulerAngles(const NdArray< double > &angles)'],['../classnc_1_1rotations_1_1_d_c_m.html#a75a392cc2db9f9fdcfd8e212d152c9ff',1,'nc::rotations::DCM::eulerAngles(double roll, double pitch, double yaw)']]], + ['euleraxisangle_366',['eulerAxisAngle',['../classnc_1_1rotations_1_1_d_c_m.html#a4da503d407f8ad563ec41364ff5b3b43',1,'nc::rotations::DCM::eulerAxisAngle(const Vec3 &inAxis, double inAngle)'],['../classnc_1_1rotations_1_1_d_c_m.html#aeb6400855cfc4163e09f03b101fe2d92',1,'nc::rotations::DCM::eulerAxisAngle(const NdArray< double > &inAxis, double inAngle)']]], + ['exists_367',['exists',['../classnc_1_1filesystem_1_1_file.html#a9a9b7d3f9505b025038e16a469553515',1,'nc::filesystem::File']]], + ['exp_368',['exp',['../namespacenc.html#ad7e555d480465930a7ac44f4ab39eea7',1,'nc::exp(dtype inValue) noexcept'],['../namespacenc.html#a4069791fefff15148813bbbbadf064b1',1,'nc::exp(const NdArray< dtype > &inArray)']]], + ['exp_2ehpp_369',['exp.hpp',['../exp_8hpp.html',1,'']]], + ['exp2_370',['exp2',['../namespacenc.html#aafbab1d2bd67c753fb1656e037bd8b1d',1,'nc::exp2(dtype inValue) noexcept'],['../namespacenc.html#a0595c87603ad5c35ddc78eab15148db7',1,'nc::exp2(const NdArray< dtype > &inArray)']]], + ['exp2_2ehpp_371',['exp2.hpp',['../exp2_8hpp.html',1,'']]], + ['expint_372',['expint',['../namespacenc_1_1special.html#a23097c9d953be37f1399154274ba2ff1',1,'nc::special::expint(dtype inX)'],['../namespacenc_1_1special.html#a98e6e3ad00faf7aef9f90e1c187f49b0',1,'nc::special::expint(const NdArray< dtype > &inArrayX)']]], + ['expint_2ehpp_373',['expint.hpp',['../expint_8hpp.html',1,'']]], + ['expm1_374',['expm1',['../namespacenc.html#a1f8b7ba3bb64b868fc41508d6912afab',1,'nc::expm1(dtype inValue) noexcept'],['../namespacenc.html#ac1e31d2bff523a5936799445f16d11af',1,'nc::expm1(const NdArray< dtype > &inArray)']]], + ['expm1_2ehpp_375',['expm1.hpp',['../expm1_8hpp.html',1,'']]], + ['exponential_376',['exponential',['../namespacenc_1_1random.html#a278212d1b177cb2bba47215d083bb10f',1,'nc::random::exponential(dtype inScaleValue=1)'],['../namespacenc_1_1random.html#a5d71db2fa4d818d737554405776d2aea',1,'nc::random::exponential(const Shape &inShape, dtype inScaleValue=1)']]], + ['exponential_2ehpp_377',['exponential.hpp',['../exponential_8hpp.html',1,'']]], + ['ext_378',['ext',['../classnc_1_1filesystem_1_1_file.html#ac51df5a278a9b6045d6f241766c10483',1,'nc::filesystem::File']]], + ['extract_379',['extract',['../namespacenc.html#af75594a13a627d4b014cf04749324571',1,'nc']]], + ['extract_2ehpp_380',['extract.hpp',['../extract_8hpp.html',1,'']]], + ['extractdata_381',['extractData',['../namespacenc_1_1edac_1_1detail.html#a1c606c3f9302bb406021a50006898ebf',1,'nc::edac::detail']]], + ['extremevalue_382',['extremeValue',['../namespacenc_1_1random.html#a11144426dec05283d6c682e0e532af7e',1,'nc::random::extremeValue(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#a6a5f569b594585794e6b268576d2e587',1,'nc::random::extremeValue(const Shape &inShape, dtype inA=1, dtype inB=1)']]], + ['extremevalue_2ehpp_383',['extremeValue.hpp',['../extreme_value_8hpp.html',1,'']]], + ['eye_384',['eye',['../namespacenc.html#a944a26b6ffe66b39ab9ba6972906bf55',1,'nc::eye(uint32 inN, uint32 inM, int32 inK=0)'],['../namespacenc.html#a1af40ed299fe04e075ca80d0d00dfba0',1,'nc::eye(uint32 inN, int32 inK=0)'],['../namespacenc.html#aa5328556ac755d5aafbe0f0e5d0c7af3',1,'nc::eye(const Shape &inShape, int32 inK=0)']]], + ['eye_2ehpp_385',['eye.hpp',['../eye_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_5.html b/docs/doxygen/html/search/all_5.html index ff4c7034b..9dd9344b0 100644 --- a/docs/doxygen/html/search/all_5.html +++ b/docs/doxygen/html/search/all_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_5.js b/docs/doxygen/html/search/all_5.js index 2c31a9410..2c6afe081 100644 --- a/docs/doxygen/html/search/all_5.js +++ b/docs/doxygen/html/search/all_5.js @@ -1,61 +1,61 @@ var searchData= [ - ['cube_2ehpp_368',['cube.hpp',['../_functions_2cube_8hpp.html',1,'']]], - ['f_369',['f',['../namespacenc_1_1random.html#aabf17da1f94e6da4ec99085feca10799',1,'nc::random::f(const Shape &inShape, dtype inDofN, dtype inDofD)'],['../namespacenc_1_1random.html#a00229c23da25284daf436c0a338ea25c',1,'nc::random::f(dtype inDofN, dtype inDofD)']]], - ['f_2ehpp_370',['f.hpp',['../f_8hpp.html',1,'']]], - ['factorial_371',['factorial',['../namespacenc_1_1special.html#a7ab9b16b9bcb43038db57b7d21a90304',1,'nc::special::factorial(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a429b2caa6cf7fcbdba8ce3184c0367e3',1,'nc::special::factorial(uint32 inValue)']]], - ['factorial_2ehpp_372',['factorial.hpp',['../factorial_8hpp.html',1,'']]], - ['file_373',['File',['../classnc_1_1filesystem_1_1_file.html#aa27dc231895f81412af1d8206b5496dd',1,'nc::filesystem::File::File()'],['../classnc_1_1filesystem_1_1_file.html',1,'nc::filesystem::File']]], - ['filesystem_2ehpp_374',['Filesystem.hpp',['../_filesystem_8hpp.html',1,'']]], - ['fill_375',['fill',['../namespacenc_1_1stl__algorithms.html#af9a01fcb79e7a69b707081c1c17f361c',1,'nc::stl_algorithms::fill()'],['../classnc_1_1_nd_array.html#a646ec787a3b7331b34c0c3f21e0d992d',1,'nc::NdArray::fill()']]], - ['fillcorners_376',['fillCorners',['../namespacenc_1_1filter_1_1boundary.html#ac2c4c5858898760f48e5aba06ad0eb3c',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth, dtype inFillValue)'],['../namespacenc_1_1filter_1_1boundary.html#ac78b1c70b5d7e26d6013674cdb84690a',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth)']]], - ['fillcorners_2ehpp_377',['fillCorners.hpp',['../fill_corners_8hpp.html',1,'']]], - ['filldiagnol_2ehpp_378',['fillDiagnol.hpp',['../fill_diagnol_8hpp.html',1,'']]], - ['filldiagonal_379',['fillDiagonal',['../namespacenc.html#a7c40717fa80c513ecbb943859d9d1ac2',1,'nc']]], - ['filter_2ehpp_380',['Filter.hpp',['../_filter_8hpp.html',1,'']]], - ['find_381',['find',['../namespacenc.html#a8eaa82071f16b2654f11096247ba10e5',1,'nc::find()'],['../namespacenc_1_1stl__algorithms.html#a761aa9f3bd88f019c46fe6cece93ade2',1,'nc::stl_algorithms::find()']]], - ['find_2ehpp_382',['find.hpp',['../find_8hpp.html',1,'']]], - ['fit_383',['fit',['../classnc_1_1polynomial_1_1_poly1d.html#a1526585db421bbf96dfb88d99870c201',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, const NdArray< dtype > &weights, uint8 polyOrder)'],['../classnc_1_1polynomial_1_1_poly1d.html#abd9c3ff549505b8c42b4a4e97ff95b2c',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, uint8 polyOrder)']]], - ['fix_384',['fix',['../namespacenc.html#af259d081804c4be2d33e3a00e937b79c',1,'nc::fix(dtype inValue) noexcept'],['../namespacenc.html#aa2d5bc309911a5c6a79324691cf7ea27',1,'nc::fix(const NdArray< dtype > &inArray)']]], - ['fix_2ehpp_385',['fix.hpp',['../fix_8hpp.html',1,'']]], - ['flatnonzero_386',['flatnonzero',['../classnc_1_1_nd_array.html#a91687e040d05ac06b389d389facff3c9',1,'nc::NdArray::flatnonzero()'],['../namespacenc.html#a1564bf5bf94b5a6d8b55850e2a956407',1,'nc::flatnonzero()']]], - ['flatnonzero_2ehpp_387',['flatnonzero.hpp',['../flatnonzero_8hpp.html',1,'']]], - ['flatten_388',['flatten',['../namespacenc.html#ae968142455e50b994f534186693934dd',1,'nc::flatten()'],['../classnc_1_1_nd_array.html#a22ba05b8e537c008a2143396b5995551',1,'nc::NdArray::flatten()']]], - ['flatten_2ehpp_389',['flatten.hpp',['../flatten_8hpp.html',1,'']]], - ['flip_390',['flip',['../namespacenc.html#ab17a2f12bb2bea50a74c2ed41b30fdb2',1,'nc']]], - ['flip_2ehpp_391',['flip.hpp',['../flip_8hpp.html',1,'']]], - ['fliplr_392',['fliplr',['../namespacenc.html#ae316eb25ff89e7999a24221c91f8d395',1,'nc']]], - ['fliplr_2ehpp_393',['fliplr.hpp',['../fliplr_8hpp.html',1,'']]], - ['flipud_394',['flipud',['../namespacenc.html#a0241fc364ae8002c42cd4d452c897e26',1,'nc']]], - ['flipud_2ehpp_395',['flipud.hpp',['../flipud_8hpp.html',1,'']]], - ['floor_396',['floor',['../namespacenc.html#a85531048cade0ac3a1b4e8d6e01ff6fe',1,'nc::floor(const NdArray< dtype > &inArray)'],['../namespacenc.html#a832da7fc615ea4e1da7bed94a4488ea6',1,'nc::floor(dtype inValue) noexcept']]], - ['floor_2ehpp_397',['floor.hpp',['../floor_8hpp.html',1,'']]], - ['floor_5fdivide_398',['floor_divide',['../namespacenc.html#ab299e0245c7a703a9506ce6f39d9d8e4',1,'nc::floor_divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#ae8e2b2ae79d7a56eefd11986a6de9b21',1,'nc::floor_divide(dtype inValue1, dtype inValue2) noexcept']]], - ['floor_5fdivide_2ehpp_399',['floor_divide.hpp',['../floor__divide_8hpp.html',1,'']]], - ['fmax_400',['fmax',['../namespacenc.html#aebbd1fbc64f00fdeaae6c8cfdf6a7f59',1,'nc::fmax(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a99c7f7c680632be6a42ebd6b923df328',1,'nc::fmax(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['fmax_2ehpp_401',['fmax.hpp',['../fmax_8hpp.html',1,'']]], - ['fmin_402',['fmin',['../namespacenc.html#a7cd8e4c771d0676279f506f9d7e949e0',1,'nc::fmin(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#add4b4f64b2991ac90b24c93ce10a2b80',1,'nc::fmin(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['fmin_2ehpp_403',['fmin.hpp',['../fmin_8hpp.html',1,'']]], - ['fmod_404',['fmod',['../namespacenc.html#a4208e3d02b9bc915767eab689c64b30f',1,'nc::fmod(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a87bf4f8636ec0237d958c2ec1d9f1a89',1,'nc::fmod(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['fmod_2ehpp_405',['fmod.hpp',['../fmod_8hpp.html',1,'']]], - ['for_5feach_406',['for_each',['../namespacenc_1_1stl__algorithms.html#a734698435eabdbc5bdf93b195d7fb6a7',1,'nc::stl_algorithms']]], - ['forward_407',['forward',['../classnc_1_1_vec3.html#ac5a33c96c05a8c856b774c24f4a1965d',1,'nc::Vec3']]], - ['frombuffer_408',['frombuffer',['../namespacenc.html#ac0d91788bdc0924b82e9a38302d71316',1,'nc']]], - ['frombuffer_2ehpp_409',['frombuffer.hpp',['../frombuffer_8hpp.html',1,'']]], - ['fromfile_410',['fromfile',['../namespacenc.html#aa344c64ebbe94231d377f99775606c68',1,'nc::fromfile(const std::string &inFilename, const char inSep)'],['../namespacenc.html#a1f10b3d839d24d71df9c92e3f9794a14',1,'nc::fromfile(const std::string &inFilename)']]], - ['fromfile_2ehpp_411',['fromfile.hpp',['../fromfile_8hpp.html',1,'']]], - ['fromiter_412',['fromiter',['../namespacenc.html#a17c629bae4e06fe95b23d2b5799148f0',1,'nc']]], - ['fromiter_2ehpp_413',['fromiter.hpp',['../fromiter_8hpp.html',1,'']]], - ['front_414',['front',['../classnc_1_1_nd_array.html#a823d56e88aa815d86d41e8b11d348a6a',1,'nc::NdArray::front() noexcept'],['../classnc_1_1_nd_array.html#aacff9537c7c8537583b70115626a420b',1,'nc::NdArray::front(size_type row)'],['../classnc_1_1_nd_array.html#a42b713a59eac4e9df2ea3b2e584a80f1',1,'nc::NdArray::front(size_type row) const'],['../classnc_1_1_nd_array.html#a7c17d60541d81f71107c5dc0a06885ac',1,'nc::NdArray::front() const noexcept'],['../classnc_1_1_data_cube.html#a398373aeb2f3c9dd8df78f9eac1ca3d9',1,'nc::DataCube::front()']]], - ['full_415',['full',['../namespacenc.html#ac09334ce9ac6c4c140bbae68e8ce1a6c',1,'nc::full(const Shape &inShape, dtype inFillValue)'],['../namespacenc.html#a64e56324bce64094973a2da35548178d',1,'nc::full(uint32 inNumRows, uint32 inNumCols, dtype inFillValue)'],['../namespacenc.html#a139698e3756d4cb9b021c9d97e200bda',1,'nc::full(uint32 inSquareSize, dtype inFillValue)']]], - ['full_2ehpp_416',['full.hpp',['../full_8hpp.html',1,'']]], - ['full_5flike_417',['full_like',['../namespacenc.html#ad7e958219ad5b01b015edaf725eb4b7a',1,'nc']]], - ['full_5flike_2ehpp_418',['full_like.hpp',['../full__like_8hpp.html',1,'']]], - ['fullname_419',['fullName',['../classnc_1_1filesystem_1_1_file.html#a0f3f9b0e15d7cd007ae2b8a808f74799',1,'nc::filesystem::File']]], - ['functions_2ehpp_420',['Functions.hpp',['../_functions_8hpp.html',1,'']]], - ['interp_2ehpp_421',['interp.hpp',['../_functions_2interp_8hpp.html',1,'']]], - ['laplace_2ehpp_422',['laplace.hpp',['../_filter_2_filters_2_filters2d_2laplace_8hpp.html',1,'']]], - ['power_2ehpp_423',['power.hpp',['../_functions_2power_8hpp.html',1,'']]], - ['powerf_2ehpp_424',['powerf.hpp',['../_functions_2powerf_8hpp.html',1,'']]], - ['shape_2ehpp_425',['shape.hpp',['../_functions_2_shape_8hpp.html',1,'']]] + ['cube_2ehpp_386',['cube.hpp',['../_functions_2cube_8hpp.html',1,'']]], + ['f_387',['f',['../namespacenc_1_1random.html#a00229c23da25284daf436c0a338ea25c',1,'nc::random::f(dtype inDofN, dtype inDofD)'],['../namespacenc_1_1random.html#aabf17da1f94e6da4ec99085feca10799',1,'nc::random::f(const Shape &inShape, dtype inDofN, dtype inDofD)']]], + ['f_2ehpp_388',['f.hpp',['../f_8hpp.html',1,'']]], + ['factorial_389',['factorial',['../namespacenc_1_1special.html#a7ab9b16b9bcb43038db57b7d21a90304',1,'nc::special::factorial(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a429b2caa6cf7fcbdba8ce3184c0367e3',1,'nc::special::factorial(uint32 inValue)']]], + ['factorial_2ehpp_390',['factorial.hpp',['../factorial_8hpp.html',1,'']]], + ['file_391',['File',['../classnc_1_1filesystem_1_1_file.html#aa27dc231895f81412af1d8206b5496dd',1,'nc::filesystem::File::File()'],['../classnc_1_1filesystem_1_1_file.html',1,'nc::filesystem::File']]], + ['filesystem_2ehpp_392',['Filesystem.hpp',['../_filesystem_8hpp.html',1,'']]], + ['fill_393',['fill',['../namespacenc_1_1stl__algorithms.html#af9a01fcb79e7a69b707081c1c17f361c',1,'nc::stl_algorithms::fill()'],['../classnc_1_1_nd_array.html#a646ec787a3b7331b34c0c3f21e0d992d',1,'nc::NdArray::fill()']]], + ['fillcorners_394',['fillCorners',['../namespacenc_1_1filter_1_1boundary.html#ac2c4c5858898760f48e5aba06ad0eb3c',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth, dtype inFillValue)'],['../namespacenc_1_1filter_1_1boundary.html#ac78b1c70b5d7e26d6013674cdb84690a',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth)']]], + ['fillcorners_2ehpp_395',['fillCorners.hpp',['../fill_corners_8hpp.html',1,'']]], + ['filldiagnol_2ehpp_396',['fillDiagnol.hpp',['../fill_diagnol_8hpp.html',1,'']]], + ['filldiagonal_397',['fillDiagonal',['../namespacenc.html#a7c40717fa80c513ecbb943859d9d1ac2',1,'nc']]], + ['filter_2ehpp_398',['Filter.hpp',['../_filter_8hpp.html',1,'']]], + ['find_399',['find',['../namespacenc.html#a8eaa82071f16b2654f11096247ba10e5',1,'nc::find()'],['../namespacenc_1_1stl__algorithms.html#a761aa9f3bd88f019c46fe6cece93ade2',1,'nc::stl_algorithms::find()']]], + ['find_2ehpp_400',['find.hpp',['../find_8hpp.html',1,'']]], + ['fit_401',['fit',['../classnc_1_1polynomial_1_1_poly1d.html#abd9c3ff549505b8c42b4a4e97ff95b2c',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, uint8 polyOrder)'],['../classnc_1_1polynomial_1_1_poly1d.html#a1526585db421bbf96dfb88d99870c201',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, const NdArray< dtype > &weights, uint8 polyOrder)']]], + ['fix_402',['fix',['../namespacenc.html#af259d081804c4be2d33e3a00e937b79c',1,'nc::fix(dtype inValue) noexcept'],['../namespacenc.html#aa2d5bc309911a5c6a79324691cf7ea27',1,'nc::fix(const NdArray< dtype > &inArray)']]], + ['fix_2ehpp_403',['fix.hpp',['../fix_8hpp.html',1,'']]], + ['flatnonzero_404',['flatnonzero',['../namespacenc.html#a1564bf5bf94b5a6d8b55850e2a956407',1,'nc::flatnonzero()'],['../classnc_1_1_nd_array.html#a91687e040d05ac06b389d389facff3c9',1,'nc::NdArray::flatnonzero()']]], + ['flatnonzero_2ehpp_405',['flatnonzero.hpp',['../flatnonzero_8hpp.html',1,'']]], + ['flatten_406',['flatten',['../namespacenc.html#ae968142455e50b994f534186693934dd',1,'nc::flatten()'],['../classnc_1_1_nd_array.html#a22ba05b8e537c008a2143396b5995551',1,'nc::NdArray::flatten()']]], + ['flatten_2ehpp_407',['flatten.hpp',['../flatten_8hpp.html',1,'']]], + ['flip_408',['flip',['../namespacenc.html#ab17a2f12bb2bea50a74c2ed41b30fdb2',1,'nc']]], + ['flip_2ehpp_409',['flip.hpp',['../flip_8hpp.html',1,'']]], + ['fliplr_410',['fliplr',['../namespacenc.html#ae316eb25ff89e7999a24221c91f8d395',1,'nc']]], + ['fliplr_2ehpp_411',['fliplr.hpp',['../fliplr_8hpp.html',1,'']]], + ['flipud_412',['flipud',['../namespacenc.html#a0241fc364ae8002c42cd4d452c897e26',1,'nc']]], + ['flipud_2ehpp_413',['flipud.hpp',['../flipud_8hpp.html',1,'']]], + ['floor_414',['floor',['../namespacenc.html#a832da7fc615ea4e1da7bed94a4488ea6',1,'nc::floor(dtype inValue) noexcept'],['../namespacenc.html#a85531048cade0ac3a1b4e8d6e01ff6fe',1,'nc::floor(const NdArray< dtype > &inArray)']]], + ['floor_2ehpp_415',['floor.hpp',['../floor_8hpp.html',1,'']]], + ['floor_5fdivide_416',['floor_divide',['../namespacenc.html#ae8e2b2ae79d7a56eefd11986a6de9b21',1,'nc::floor_divide(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ab299e0245c7a703a9506ce6f39d9d8e4',1,'nc::floor_divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['floor_5fdivide_2ehpp_417',['floor_divide.hpp',['../floor__divide_8hpp.html',1,'']]], + ['fmax_418',['fmax',['../namespacenc.html#aebbd1fbc64f00fdeaae6c8cfdf6a7f59',1,'nc::fmax(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a99c7f7c680632be6a42ebd6b923df328',1,'nc::fmax(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['fmax_2ehpp_419',['fmax.hpp',['../fmax_8hpp.html',1,'']]], + ['fmin_420',['fmin',['../namespacenc.html#a7cd8e4c771d0676279f506f9d7e949e0',1,'nc::fmin(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#add4b4f64b2991ac90b24c93ce10a2b80',1,'nc::fmin(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['fmin_2ehpp_421',['fmin.hpp',['../fmin_8hpp.html',1,'']]], + ['fmod_422',['fmod',['../namespacenc.html#a6894e06b913479ce699cba7dbce5bc93',1,'nc::fmod(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a87bf4f8636ec0237d958c2ec1d9f1a89',1,'nc::fmod(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['fmod_2ehpp_423',['fmod.hpp',['../fmod_8hpp.html',1,'']]], + ['for_5feach_424',['for_each',['../namespacenc_1_1stl__algorithms.html#a734698435eabdbc5bdf93b195d7fb6a7',1,'nc::stl_algorithms']]], + ['forward_425',['forward',['../classnc_1_1_vec3.html#ac5a33c96c05a8c856b774c24f4a1965d',1,'nc::Vec3']]], + ['frombuffer_426',['frombuffer',['../namespacenc.html#ac0d91788bdc0924b82e9a38302d71316',1,'nc']]], + ['frombuffer_2ehpp_427',['frombuffer.hpp',['../frombuffer_8hpp.html',1,'']]], + ['fromfile_428',['fromfile',['../namespacenc.html#a1f10b3d839d24d71df9c92e3f9794a14',1,'nc::fromfile(const std::string &inFilename)'],['../namespacenc.html#aa344c64ebbe94231d377f99775606c68',1,'nc::fromfile(const std::string &inFilename, const char inSep)']]], + ['fromfile_2ehpp_429',['fromfile.hpp',['../fromfile_8hpp.html',1,'']]], + ['fromiter_430',['fromiter',['../namespacenc.html#a17c629bae4e06fe95b23d2b5799148f0',1,'nc']]], + ['fromiter_2ehpp_431',['fromiter.hpp',['../fromiter_8hpp.html',1,'']]], + ['front_432',['front',['../classnc_1_1_nd_array.html#a42b713a59eac4e9df2ea3b2e584a80f1',1,'nc::NdArray::front(size_type row) const'],['../classnc_1_1_nd_array.html#aacff9537c7c8537583b70115626a420b',1,'nc::NdArray::front(size_type row)'],['../classnc_1_1_nd_array.html#a7c17d60541d81f71107c5dc0a06885ac',1,'nc::NdArray::front() const noexcept'],['../classnc_1_1_data_cube.html#a398373aeb2f3c9dd8df78f9eac1ca3d9',1,'nc::DataCube::front()'],['../classnc_1_1_nd_array.html#a823d56e88aa815d86d41e8b11d348a6a',1,'nc::NdArray::front()']]], + ['full_433',['full',['../namespacenc.html#a139698e3756d4cb9b021c9d97e200bda',1,'nc::full(uint32 inSquareSize, dtype inFillValue)'],['../namespacenc.html#a64e56324bce64094973a2da35548178d',1,'nc::full(uint32 inNumRows, uint32 inNumCols, dtype inFillValue)'],['../namespacenc.html#ac09334ce9ac6c4c140bbae68e8ce1a6c',1,'nc::full(const Shape &inShape, dtype inFillValue)']]], + ['full_2ehpp_434',['full.hpp',['../full_8hpp.html',1,'']]], + ['full_5flike_435',['full_like',['../namespacenc.html#ad7e958219ad5b01b015edaf725eb4b7a',1,'nc']]], + ['full_5flike_2ehpp_436',['full_like.hpp',['../full__like_8hpp.html',1,'']]], + ['fullname_437',['fullName',['../classnc_1_1filesystem_1_1_file.html#a0f3f9b0e15d7cd007ae2b8a808f74799',1,'nc::filesystem::File']]], + ['functions_2ehpp_438',['Functions.hpp',['../_functions_8hpp.html',1,'']]], + ['interp_2ehpp_439',['interp.hpp',['../_functions_2interp_8hpp.html',1,'']]], + ['laplace_2ehpp_440',['laplace.hpp',['../_filter_2_filters_2_filters2d_2laplace_8hpp.html',1,'']]], + ['power_2ehpp_441',['power.hpp',['../_functions_2power_8hpp.html',1,'']]], + ['powerf_2ehpp_442',['powerf.hpp',['../_functions_2powerf_8hpp.html',1,'']]], + ['shape_2ehpp_443',['shape.hpp',['../_functions_2_shape_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_6.html b/docs/doxygen/html/search/all_6.html index 671f73654..f1e516d75 100644 --- a/docs/doxygen/html/search/all_6.html +++ b/docs/doxygen/html/search/all_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_6.js b/docs/doxygen/html/search/all_6.js index e2ddeff24..b55b9a4ca 100644 --- a/docs/doxygen/html/search/all_6.js +++ b/docs/doxygen/html/search/all_6.js @@ -1,38 +1,42 @@ var searchData= [ - ['gamma_426',['gamma',['../namespacenc_1_1special.html#a07a3d6d5e0610dca66ca975cdf1d34b9',1,'nc::special::gamma(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#aad22d353f040026576c4a28727ecaf35',1,'nc::special::gamma(dtype inValue)'],['../namespacenc_1_1random.html#aa706a2bd65cb664ae9af10f713661d79',1,'nc::random::gamma(const Shape &inShape, dtype inGammaShape, dtype inScaleValue=1)'],['../namespacenc_1_1random.html#a0a969335423de5ad59fed5e952189e2d',1,'nc::random::gamma(dtype inGammaShape, dtype inScaleValue=1)']]], - ['gamma1pm1_427',['gamma1pm1',['../namespacenc_1_1special.html#a7b98a5eedb6e5354adbab8dcfe1ce4e1',1,'nc::special::gamma1pm1(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a9ea9c889891f9f3a071c786d0b947e20',1,'nc::special::gamma1pm1(dtype inValue)']]], - ['gamma1pm1_2ehpp_428',['gamma1pm1.hpp',['../gamma1pm1_8hpp.html',1,'']]], - ['gauss_5flegendre_429',['gauss_legendre',['../namespacenc_1_1integrate.html#af7d17b4e025bf94f903d3c671da3baf7',1,'nc::integrate']]], - ['gauss_5flegendre_2ehpp_430',['gauss_legendre.hpp',['../gauss__legendre_8hpp.html',1,'']]], - ['gaussian_431',['gaussian',['../namespacenc_1_1utils.html#a5016e06ac7ca186ff6c110b314d30209',1,'nc::utils']]], - ['gaussian_2ehpp_432',['gaussian.hpp',['../gaussian_8hpp.html',1,'']]], - ['gaussian1d_433',['gaussian1d',['../namespacenc_1_1utils.html#a263704ee2cc6ab3f77b462522c7150f8',1,'nc::utils']]], - ['gaussian1d_2ehpp_434',['gaussian1d.hpp',['../gaussian1d_8hpp.html',1,'']]], - ['gaussianfilter_435',['gaussianFilter',['../namespacenc_1_1filter.html#a91c9fcd09a78eba8a42c5166ebb7709b',1,'nc::filter']]], - ['gaussianfilter_2ehpp_436',['gaussianFilter.hpp',['../gaussian_filter_8hpp.html',1,'']]], - ['gaussianfilter1d_437',['gaussianFilter1d',['../namespacenc_1_1filter.html#abda833220ea035db0aa485f6ccf66923',1,'nc::filter']]], - ['gaussianfilter1d_2ehpp_438',['gaussianFilter1d.hpp',['../gaussian_filter1d_8hpp.html',1,'']]], - ['gaussnewtonnlls_439',['gaussNewtonNlls',['../namespacenc_1_1linalg.html#aff0f97e94666284100b584e13d27def3',1,'nc::linalg']]], - ['gaussnewtonnlls_2ehpp_440',['gaussNewtonNlls.hpp',['../gauss_newton_nlls_8hpp.html',1,'']]], - ['gcd_441',['gcd',['../namespacenc.html#a4a496eaa0a42e0b9c80724358664d432',1,'nc::gcd(const NdArray< dtype > &inArray)'],['../namespacenc.html#a45b5db91eb9f524459fa3878e23ca0ec',1,'nc::gcd(dtype inValue1, dtype inValue2) noexcept']]], - ['gcd_2ehpp_442',['gcd.hpp',['../gcd_8hpp.html',1,'']]], - ['generatecentroids_443',['generateCentroids',['../namespacenc_1_1image_processing.html#a874d0f4174d10763002fdd70f190595b',1,'nc::imageProcessing']]], - ['generatecentroids_2ehpp_444',['generateCentroids.hpp',['../generate_centroids_8hpp.html',1,'']]], - ['generatethreshold_445',['generateThreshold',['../namespacenc_1_1image_processing.html#a356989d12dda6e1b0748d22d50d4ecaa',1,'nc::imageProcessing']]], - ['generatethreshold_2ehpp_446',['generateThreshold.hpp',['../generate_threshold_8hpp.html',1,'']]], - ['generator_2ehpp_447',['generator.hpp',['../generator_8hpp.html',1,'']]], - ['generator_5f_448',['generator_',['../namespacenc_1_1random.html#aa541047e6b742f1c5251e72f3b7aec95',1,'nc::random']]], - ['geometric_449',['geometric',['../namespacenc_1_1random.html#a7199f5c06c0e05440e9a97e01930b896',1,'nc::random::geometric(double inP=0.5)'],['../namespacenc_1_1random.html#ae761ff6e68fb0708061704bee4a3a7e3',1,'nc::random::geometric(const Shape &inShape, double inP=0.5)']]], - ['geometric_2ehpp_450',['geometric.hpp',['../geometric_8hpp.html',1,'']]], - ['getbyindices_451',['getByIndices',['../classnc_1_1_nd_array.html#a9437732d220581563d44c800ce240e17',1,'nc::NdArray']]], - ['getbymask_452',['getByMask',['../classnc_1_1_nd_array.html#a4da478ab5a1c836be7ad2f9d6bfed91e',1,'nc::NdArray']]], - ['getroot_453',['getRoot',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac2d8f6377f8ae7cf27b4d0599eb7880b',1,'nc::integrate::LegendrePolynomial']]], - ['getweight_454',['getWeight',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac6b804e8a2d582df601cc2b3ff2bf74f',1,'nc::integrate::LegendrePolynomial']]], - ['gradient_455',['gradient',['../namespacenc.html#ae2a11c3f92effc5991a2e0134f6a9188',1,'nc::gradient(const NdArray< dtype > &inArray, Axis inAxis=Axis::ROW)'],['../namespacenc.html#a7ef89fff9eb07946e77a5375dac5e7b6',1,'nc::gradient(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::ROW)']]], - ['gradient_2ehpp_456',['gradient.hpp',['../gradient_8hpp.html',1,'']]], - ['greater_457',['greater',['../namespacenc.html#a105d660675a98132264a13b17410a82d',1,'nc']]], - ['greater_2ehpp_458',['greater.hpp',['../greater_8hpp.html',1,'']]], - ['greater_5fequal_459',['greater_equal',['../namespacenc.html#a9a2bbc9879a2b3a9e657328c9d8ad025',1,'nc']]], - ['greater_5fequal_2ehpp_460',['greater_equal.hpp',['../greater__equal_8hpp.html',1,'']]] + ['gamma_444',['gamma',['../namespacenc_1_1special.html#aad22d353f040026576c4a28727ecaf35',1,'nc::special::gamma(dtype inValue)'],['../namespacenc_1_1special.html#a07a3d6d5e0610dca66ca975cdf1d34b9',1,'nc::special::gamma(const NdArray< dtype > &inArray)'],['../namespacenc_1_1random.html#a0a969335423de5ad59fed5e952189e2d',1,'nc::random::gamma(dtype inGammaShape, dtype inScaleValue=1)'],['../namespacenc_1_1random.html#aa706a2bd65cb664ae9af10f713661d79',1,'nc::random::gamma(const Shape &inShape, dtype inGammaShape, dtype inScaleValue=1)']]], + ['gamma1pm1_445',['gamma1pm1',['../namespacenc_1_1special.html#a7b98a5eedb6e5354adbab8dcfe1ce4e1',1,'nc::special::gamma1pm1(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a9ea9c889891f9f3a071c786d0b947e20',1,'nc::special::gamma1pm1(dtype inValue)']]], + ['gamma1pm1_2ehpp_446',['gamma1pm1.hpp',['../gamma1pm1_8hpp.html',1,'']]], + ['gauss_5flegendre_447',['gauss_legendre',['../namespacenc_1_1integrate.html#af7d17b4e025bf94f903d3c671da3baf7',1,'nc::integrate']]], + ['gauss_5flegendre_2ehpp_448',['gauss_legendre.hpp',['../gauss__legendre_8hpp.html',1,'']]], + ['gaussian_449',['gaussian',['../namespacenc_1_1utils.html#a5016e06ac7ca186ff6c110b314d30209',1,'nc::utils']]], + ['gaussian_2ehpp_450',['gaussian.hpp',['../gaussian_8hpp.html',1,'']]], + ['gaussian1d_451',['gaussian1d',['../namespacenc_1_1utils.html#a263704ee2cc6ab3f77b462522c7150f8',1,'nc::utils']]], + ['gaussian1d_2ehpp_452',['gaussian1d.hpp',['../gaussian1d_8hpp.html',1,'']]], + ['gaussianfilter_453',['gaussianFilter',['../namespacenc_1_1filter.html#a91c9fcd09a78eba8a42c5166ebb7709b',1,'nc::filter']]], + ['gaussianfilter_2ehpp_454',['gaussianFilter.hpp',['../gaussian_filter_8hpp.html',1,'']]], + ['gaussianfilter1d_455',['gaussianFilter1d',['../namespacenc_1_1filter.html#abda833220ea035db0aa485f6ccf66923',1,'nc::filter']]], + ['gaussianfilter1d_2ehpp_456',['gaussianFilter1d.hpp',['../gaussian_filter1d_8hpp.html',1,'']]], + ['gaussnewtonnlls_457',['gaussNewtonNlls',['../namespacenc_1_1linalg.html#aff0f97e94666284100b584e13d27def3',1,'nc::linalg']]], + ['gaussnewtonnlls_2ehpp_458',['gaussNewtonNlls.hpp',['../gauss_newton_nlls_8hpp.html',1,'']]], + ['gcd_459',['gcd',['../namespacenc.html#a4a496eaa0a42e0b9c80724358664d432',1,'nc::gcd(const NdArray< dtype > &inArray)'],['../namespacenc.html#a45b5db91eb9f524459fa3878e23ca0ec',1,'nc::gcd(dtype inValue1, dtype inValue2) noexcept']]], + ['gcd_2ehpp_460',['gcd.hpp',['../gcd_8hpp.html',1,'']]], + ['generatecentroids_461',['generateCentroids',['../namespacenc_1_1image_processing.html#a874d0f4174d10763002fdd70f190595b',1,'nc::imageProcessing']]], + ['generatecentroids_2ehpp_462',['generateCentroids.hpp',['../generate_centroids_8hpp.html',1,'']]], + ['generatethreshold_463',['generateThreshold',['../namespacenc_1_1image_processing.html#a356989d12dda6e1b0748d22d50d4ecaa',1,'nc::imageProcessing']]], + ['generatethreshold_2ehpp_464',['generateThreshold.hpp',['../generate_threshold_8hpp.html',1,'']]], + ['generator_2ehpp_465',['generator.hpp',['../generator_8hpp.html',1,'']]], + ['generator_5f_466',['generator_',['../namespacenc_1_1random.html#aa541047e6b742f1c5251e72f3b7aec95',1,'nc::random']]], + ['geometric_467',['geometric',['../namespacenc_1_1random.html#a7199f5c06c0e05440e9a97e01930b896',1,'nc::random::geometric(double inP=0.5)'],['../namespacenc_1_1random.html#ae761ff6e68fb0708061704bee4a3a7e3',1,'nc::random::geometric(const Shape &inShape, double inP=0.5)']]], + ['geometric_2ehpp_468',['geometric.hpp',['../geometric_8hpp.html',1,'']]], + ['geomspace_469',['geomspace',['../namespacenc.html#aa5cdd68a27ae041c382eabfb07dfa9bc',1,'nc']]], + ['geomspace_2ehpp_470',['geomspace.hpp',['../geomspace_8hpp.html',1,'']]], + ['getbyindices_471',['getByIndices',['../classnc_1_1_nd_array.html#a9437732d220581563d44c800ce240e17',1,'nc::NdArray']]], + ['getbymask_472',['getByMask',['../classnc_1_1_nd_array.html#a4da478ab5a1c836be7ad2f9d6bfed91e',1,'nc::NdArray']]], + ['getroot_473',['getRoot',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac2d8f6377f8ae7cf27b4d0599eb7880b',1,'nc::integrate::LegendrePolynomial']]], + ['getweight_474',['getWeight',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac6b804e8a2d582df601cc2b3ff2bf74f',1,'nc::integrate::LegendrePolynomial']]], + ['gradient_475',['gradient',['../namespacenc.html#ae2a11c3f92effc5991a2e0134f6a9188',1,'nc::gradient(const NdArray< dtype > &inArray, Axis inAxis=Axis::ROW)'],['../namespacenc.html#a7ef89fff9eb07946e77a5375dac5e7b6',1,'nc::gradient(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::ROW)']]], + ['gradient_2ehpp_476',['gradient.hpp',['../gradient_8hpp.html',1,'']]], + ['greater_477',['greater',['../namespacenc.html#a105d660675a98132264a13b17410a82d',1,'nc']]], + ['greater_2ehpp_478',['greater.hpp',['../greater_8hpp.html',1,'']]], + ['greater_5fequal_479',['greater_equal',['../namespacenc.html#a9a2bbc9879a2b3a9e657328c9d8ad025',1,'nc']]], + ['greater_5fequal_2ehpp_480',['greater_equal.hpp',['../greater__equal_8hpp.html',1,'']]], + ['greaterthan_481',['greaterThan',['../structnc_1_1greater_than.html',1,'nc']]], + ['greaterthan_5fv_482',['greaterThan_v',['../namespacenc.html#a4cdb8bc70afcd7483d200f235181471c',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/all_7.html b/docs/doxygen/html/search/all_7.html index 280e9b1c6..8ddbf6c8e 100644 --- a/docs/doxygen/html/search/all_7.html +++ b/docs/doxygen/html/search/all_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_7.js b/docs/doxygen/html/search/all_7.js index 7543c7e2a..760b83588 100644 --- a/docs/doxygen/html/search/all_7.js +++ b/docs/doxygen/html/search/all_7.js @@ -1,17 +1,22 @@ var searchData= [ - ['hasext_461',['hasExt',['../classnc_1_1filesystem_1_1_file.html#a4e8ede3f75b64847964d4d85cd58f123',1,'nc::filesystem::File']]], - ['hat_462',['hat',['../namespacenc_1_1linalg.html#ae9cdb091717a1c74dc659519d77e0048',1,'nc::linalg::hat(const Vec3 &inVec)'],['../namespacenc_1_1linalg.html#ae7ced3680f1ae95af4bc2e6b98a5a517',1,'nc::linalg::hat(const NdArray< dtype > &inVec)'],['../namespacenc_1_1linalg.html#a12e16cb9d1a7b09e85b4abbef14ba2ef',1,'nc::linalg::hat(dtype inX, dtype inY, dtype inZ)']]], - ['hat_2ehpp_463',['hat.hpp',['../hat_8hpp.html',1,'']]], - ['height_464',['height',['../classnc_1_1image_processing_1_1_cluster.html#a71ccd5ee3fea70b4b1b27ba25f4b3fb8',1,'nc::imageProcessing::Cluster']]], - ['hermite_465',['hermite',['../namespacenc_1_1polynomial.html#ad88f67a61dad283461c6121958c5af54',1,'nc::polynomial::hermite(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#aeea1ebbc592a6a8c533f2230fb0f6f10',1,'nc::polynomial::hermite(uint32 n, dtype x)']]], - ['hermite_2ehpp_466',['hermite.hpp',['../hermite_8hpp.html',1,'']]], - ['histogram_467',['histogram',['../namespacenc.html#abff7fb8fdafbdd8db4dad38cc5a2267c',1,'nc::histogram(const NdArray< dtype > &inArray, const NdArray< double > &inBinEdges)'],['../namespacenc.html#a9f8af3a8f7adefd20992fe0686837cf6',1,'nc::histogram(const NdArray< dtype > &inArray, uint32 inNumBins=10)']]], - ['histogram_2ehpp_468',['histogram.hpp',['../histogram_8hpp.html',1,'']]], - ['hours_469',['hours',['../classnc_1_1coordinates_1_1_r_a.html#a52af78880f6c5a5ec8750a7ad20c2e2d',1,'nc::coordinates::RA']]], - ['hours_5fper_5fday_470',['HOURS_PER_DAY',['../namespacenc_1_1constants.html#aef903b1f40001bc712b61f5dec7de716',1,'nc::constants']]], - ['hstack_471',['hstack',['../namespacenc.html#a80a6677582b65c19750b0d82ac182081',1,'nc']]], - ['hstack_2ehpp_472',['hstack.hpp',['../hstack_8hpp.html',1,'']]], - ['hypot_473',['hypot',['../namespacenc.html#a4648674053cd83851d9549bbcc7a8481',1,'nc::hypot(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ad2d90c3dcbe0a1e652b0505b637d973a',1,'nc::hypot(dtype inValue1, dtype inValue2, dtype inValue3) noexcept'],['../namespacenc.html#a66b0aabfaacc7ec12206b4edf6026b12',1,'nc::hypot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['hypot_2ehpp_474',['hypot.hpp',['../hypot_8hpp.html',1,'']]] + ['hamming_483',['hamming',['../namespacenc.html#ad7fcd267d31bec0085f82959e3b5f9d3',1,'nc']]], + ['hamming_2ehpp_484',['hamming.hpp',['../hamming_8hpp.html',1,'']]], + ['hammingencode_2ehpp_485',['hammingEncode.hpp',['../hamming_encode_8hpp.html',1,'']]], + ['hanning_486',['hanning',['../namespacenc.html#ab50f9ea31f882bd8121c1adf820798b3',1,'nc']]], + ['hanning_2ehpp_487',['hanning.hpp',['../hanning_8hpp.html',1,'']]], + ['hasext_488',['hasExt',['../classnc_1_1filesystem_1_1_file.html#a4e8ede3f75b64847964d4d85cd58f123',1,'nc::filesystem::File']]], + ['hat_489',['hat',['../namespacenc_1_1linalg.html#a12e16cb9d1a7b09e85b4abbef14ba2ef',1,'nc::linalg::hat(dtype inX, dtype inY, dtype inZ)'],['../namespacenc_1_1linalg.html#ae7ced3680f1ae95af4bc2e6b98a5a517',1,'nc::linalg::hat(const NdArray< dtype > &inVec)'],['../namespacenc_1_1linalg.html#ae9cdb091717a1c74dc659519d77e0048',1,'nc::linalg::hat(const Vec3 &inVec)']]], + ['hat_2ehpp_490',['hat.hpp',['../hat_8hpp.html',1,'']]], + ['height_491',['height',['../classnc_1_1image_processing_1_1_cluster.html#a71ccd5ee3fea70b4b1b27ba25f4b3fb8',1,'nc::imageProcessing::Cluster']]], + ['hermite_492',['hermite',['../namespacenc_1_1polynomial.html#aeea1ebbc592a6a8c533f2230fb0f6f10',1,'nc::polynomial::hermite(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#ad88f67a61dad283461c6121958c5af54',1,'nc::polynomial::hermite(uint32 n, const NdArray< dtype > &inArrayX)']]], + ['hermite_2ehpp_493',['hermite.hpp',['../hermite_8hpp.html',1,'']]], + ['histogram_494',['histogram',['../namespacenc.html#abff7fb8fdafbdd8db4dad38cc5a2267c',1,'nc::histogram(const NdArray< dtype > &inArray, const NdArray< double > &inBinEdges)'],['../namespacenc.html#a9f8af3a8f7adefd20992fe0686837cf6',1,'nc::histogram(const NdArray< dtype > &inArray, uint32 inNumBins=10)']]], + ['histogram_2ehpp_495',['histogram.hpp',['../histogram_8hpp.html',1,'']]], + ['hours_496',['hours',['../classnc_1_1coordinates_1_1_r_a.html#a52af78880f6c5a5ec8750a7ad20c2e2d',1,'nc::coordinates::RA']]], + ['hours_5fper_5fday_497',['HOURS_PER_DAY',['../namespacenc_1_1constants.html#aef903b1f40001bc712b61f5dec7de716',1,'nc::constants']]], + ['hstack_498',['hstack',['../namespacenc.html#afa8806a41df51bbb4410d4cb6601971f',1,'nc']]], + ['hstack_2ehpp_499',['hstack.hpp',['../hstack_8hpp.html',1,'']]], + ['hypot_500',['hypot',['../namespacenc.html#a4648674053cd83851d9549bbcc7a8481',1,'nc::hypot(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ad2d90c3dcbe0a1e652b0505b637d973a',1,'nc::hypot(dtype inValue1, dtype inValue2, dtype inValue3) noexcept'],['../namespacenc.html#a66b0aabfaacc7ec12206b4edf6026b12',1,'nc::hypot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['hypot_2ehpp_501',['hypot.hpp',['../hypot_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_8.html b/docs/doxygen/html/search/all_8.html index ed820aceb..83c55ae22 100644 --- a/docs/doxygen/html/search/all_8.html +++ b/docs/doxygen/html/search/all_8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_8.js b/docs/doxygen/html/search/all_8.js index 293edac42..edb4fad6b 100644 --- a/docs/doxygen/html/search/all_8.js +++ b/docs/doxygen/html/search/all_8.js @@ -1,58 +1,65 @@ var searchData= [ - ['i_475',['i',['../classnc_1_1rotations_1_1_quaternion.html#a5a661b367dff916e8bdb5e28ac608ecd',1,'nc::rotations::Quaternion']]], - ['identity_476',['identity',['../classnc_1_1rotations_1_1_quaternion.html#ae093d333b66b63eeef5704be4a374af2',1,'nc::rotations::Quaternion::identity()'],['../namespacenc.html#ac344d8b6291a38244e2d99cd77b17334',1,'nc::identity()']]], - ['identity_2ehpp_477',['identity.hpp',['../identity_8hpp.html',1,'']]], - ['imag_478',['imag',['../namespacenc.html#a12cdcae89058ab627b68d32bc9ce0666',1,'nc::imag(const std::complex< dtype > &inValue)'],['../namespacenc.html#ae9eae82003557c0e94890a8f3bb3f5dc',1,'nc::imag(const NdArray< std::complex< dtype >> &inArray)']]], - ['imag_2ehpp_479',['imag.hpp',['../imag_8hpp.html',1,'']]], - ['imageprocessing_2ehpp_480',['ImageProcessing.hpp',['../_image_processing_8hpp.html',1,'']]], - ['incrementnumberofiterations_481',['incrementNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#ad0262a1a694e734ebc154c77f010bcff',1,'nc::roots::Iteration']]], - ['inf_482',['inf',['../namespacenc_1_1constants.html#a4649bfc00f6360ccda3b3f9316e2dc0e',1,'nc::constants']]], - ['installation_483',['Installation',['../md__mnt_c__github__num_cpp_docs_markdown__installation.html',1,'']]], - ['installation_2emd_484',['Installation.md',['../_installation_8md.html',1,'']]], - ['int16_485',['int16',['../namespacenc.html#a8f5045ed0f0a08d87fd76d7a74ac128d',1,'nc']]], - ['int32_486',['int32',['../namespacenc.html#a9386099a0fdc2bc9fb0dbfde5606584d',1,'nc']]], - ['int64_487',['int64',['../namespacenc.html#a6223a7f3b0f7886036f64276f36c921e',1,'nc']]], - ['int8_488',['int8',['../namespacenc.html#a0815baab2bc081f4250ba9cb1cf361b4',1,'nc']]], - ['integ_489',['integ',['../classnc_1_1polynomial_1_1_poly1d.html#a4c2902780c89054a6ca436a72ac77119',1,'nc::polynomial::Poly1d']]], - ['integrate_2ehpp_490',['Integrate.hpp',['../_integrate_8hpp.html',1,'']]], - ['intensity_491',['intensity',['../classnc_1_1image_processing_1_1_pixel.html#a2ffea8fff18945da4971ab4c847a49bd',1,'nc::imageProcessing::Pixel::intensity()'],['../classnc_1_1image_processing_1_1_centroid.html#aa203a8f8138fe9679f307f38ad65a5aa',1,'nc::imageProcessing::Centroid::intensity()'],['../classnc_1_1image_processing_1_1_cluster.html#a1797d804406d51ab2e22d5b9fae9cb53',1,'nc::imageProcessing::Cluster::intensity()']]], - ['interp_492',['interp',['../namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e',1,'nc::utils::interp()'],['../namespacenc.html#a25a0717dab4a33f74927d390b83182ab',1,'nc::interp(const NdArray< dtype > &inX, const NdArray< dtype > &inXp, const NdArray< dtype > &inFp)'],['../namespacenc.html#a5b9584eeac344f9d37beb6be475300ca',1,'nc::interp(dtype inValue1, dtype inValue2, double inPercent) noexcept']]], - ['intersect1d_493',['intersect1d',['../namespacenc.html#a05a1080b20bfa1434ccb96fb08836bc4',1,'nc']]], - ['intersect1d_2ehpp_494',['intersect1d.hpp',['../intersect1d_8hpp.html',1,'']]], - ['inv_495',['inv',['../namespacenc_1_1linalg.html#ae36553eb100d8f2c2167e8ecadf2a9fc',1,'nc::linalg']]], - ['inv_2ehpp_496',['inv.hpp',['../inv_8hpp.html',1,'']]], - ['inverse_497',['inverse',['../classnc_1_1rotations_1_1_quaternion.html#a9b0634474b2ff27f9443ba256ea00ab1',1,'nc::rotations::Quaternion']]], - ['invert_498',['invert',['../namespacenc.html#a4159e9798b5726992f13f27366bea4f5',1,'nc']]], - ['invert_2ehpp_499',['invert.hpp',['../invert_8hpp.html',1,'']]], - ['is_5farithmetic_5fv_500',['is_arithmetic_v',['../namespacenc.html#ad5ef02185c876c1c30e12824c3b9aba5',1,'nc']]], - ['is_5fcomplex_501',['is_complex',['../structnc_1_1is__complex.html',1,'nc']]], - ['is_5fcomplex_3c_20std_3a_3acomplex_3c_20t_20_3e_20_3e_502',['is_complex< std::complex< T > >',['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html',1,'nc']]], - ['is_5fcomplex_5fv_503',['is_complex_v',['../namespacenc.html#af8be3598b0e2894429842d64d3ce4050',1,'nc']]], - ['is_5ffloating_5fpoint_5fv_504',['is_floating_point_v',['../namespacenc.html#a33d8e465a48ee094f340d8a5bab416bd',1,'nc']]], - ['is_5fintegral_5fv_505',['is_integral_v',['../namespacenc.html#a157cdac039a66a88d2aa922781d060f6',1,'nc']]], - ['is_5fsame_5fv_506',['is_same_v',['../namespacenc.html#a04829dab261829c5ee2570febfa287eb',1,'nc']]], - ['is_5fsorted_507',['is_sorted',['../namespacenc_1_1stl__algorithms.html#a1f71dfda5f16d8a53c16260c5fa8fbdc',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#aca7862e3fe066fc65bf00cb7f5108e33',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last) noexcept']]], - ['is_5fvalid_5fdtype_508',['is_valid_dtype',['../structnc_1_1is__valid__dtype.html',1,'nc']]], - ['is_5fvalid_5fdtype_5fv_509',['is_valid_dtype_v',['../namespacenc.html#aae4eab83016ec7dcaa7d78b6d1e78481',1,'nc']]], - ['isclose_510',['isclose',['../namespacenc.html#ae80bdb1c4ce59e2a74cad2d518f50e1e',1,'nc']]], - ['isclose_2ehpp_511',['isclose.hpp',['../isclose_8hpp.html',1,'']]], - ['isempty_512',['isempty',['../classnc_1_1_data_cube.html#ac569e0c62a9e5cbf21228b85128a53a5',1,'nc::DataCube::isempty()'],['../classnc_1_1_nd_array.html#a3e5261e1be6357a2c608f5e1d97b35f9',1,'nc::NdArray::isempty() const noexcept']]], - ['isflat_513',['isflat',['../classnc_1_1_nd_array.html#a344f12e052eeb49cc87e361127386a64',1,'nc::NdArray']]], - ['isinf_514',['isinf',['../namespacenc.html#ac2770d614de64c300c2f10cb39a299c0',1,'nc::isinf(dtype inValue) noexcept'],['../namespacenc.html#a38b400fe936ea86828d4e29d5b0950bb',1,'nc::isinf(const NdArray< dtype > &inArray)']]], - ['isinf_2ehpp_515',['isinf.hpp',['../isinf_8hpp.html',1,'']]], - ['isinteger_516',['isInteger',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac055638657a1459bc6a7c9d94d5c96a4',1,'nc::DtypeInfo< std::complex< dtype > >::isInteger()'],['../classnc_1_1_dtype_info.html#a10b60bd27123b5c724e2a52526fe8cfe',1,'nc::DtypeInfo::isInteger()']]], - ['islittleendian_517',['isLittleEndian',['../namespacenc_1_1endian.html#a11907ef8078650aee8fe900854ba5bb4',1,'nc::endian']]], - ['isnan_518',['isnan',['../namespacenc.html#ac28569da874c0b37a4c50c86b31a98ab',1,'nc::isnan(dtype inValue) noexcept'],['../namespacenc.html#aedce7cd7ff92f9fec0c93cd9c5522ca8',1,'nc::isnan(const NdArray< dtype > &inArray)']]], - ['isnan_2ehpp_519',['isnan.hpp',['../isnan_8hpp.html',1,'']]], - ['isnull_520',['isnull',['../classnc_1_1_shape.html#a3c8d187f677e9a4cdbdf1906d612b596',1,'nc::Shape']]], - ['issigned_521',['isSigned',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac58a829905d11a1a7fca32427eab41d3',1,'nc::DtypeInfo< std::complex< dtype > >::isSigned()'],['../classnc_1_1_dtype_info.html#a039ecfb9a5bd9fe0cb751a59f28055d1',1,'nc::DtypeInfo::isSigned()']]], - ['issorted_522',['issorted',['../classnc_1_1_nd_array.html#a0ba38857fd4f9474e2814bbf1c3a6a0a',1,'nc::NdArray']]], - ['issquare_523',['issquare',['../classnc_1_1_nd_array.html#a302be17d815b1a4e353e6a2aade581a5',1,'nc::NdArray::issquare()'],['../classnc_1_1_shape.html#a939dd0ab6edf83b7abaf8b8c93a99152',1,'nc::Shape::issquare()']]], - ['isvalid_524',['isValid',['../classnc_1_1rotations_1_1_d_c_m.html#ab1947c7618408b063b704ec391e27888',1,'nc::rotations::DCM']]], - ['item_525',['item',['../classnc_1_1_nd_array.html#abec76b8f271e07fa07cc2f88fed676fa',1,'nc::NdArray']]], - ['iteration_526',['Iteration',['../classnc_1_1roots_1_1_iteration.html#a7948f08cfaa01f5685ec35149bf6bba0',1,'nc::roots::Iteration::Iteration(double epsilon, uint32 maxNumIterations) noexcept'],['../classnc_1_1roots_1_1_iteration.html#a2d7285a81c033d56ce8283b6dbfca136',1,'nc::roots::Iteration::Iteration(double epsilon) noexcept'],['../classnc_1_1roots_1_1_iteration.html',1,'nc::roots::Iteration']]], - ['iteration_2ehpp_527',['Iteration.hpp',['../_iteration_8hpp.html',1,'']]], - ['iterator_528',['iterator',['../classnc_1_1_nd_array.html#a33ce0c581a22e809cfc5a79a534bf798',1,'nc::NdArray::iterator()'],['../classnc_1_1_data_cube.html#a623df8fc48ba169d221b1c26249e5853',1,'nc::DataCube::iterator()']]], - ['iterator_5fcategory_529',['iterator_category',['../classnc_1_1_nd_array_const_iterator.html#a17535e5dcb696923adaa626c86cc3c00',1,'nc::NdArrayConstIterator::iterator_category()'],['../classnc_1_1_nd_array_iterator.html#a7b2c0794eac54ab2c3847776a8383283',1,'nc::NdArrayIterator::iterator_category()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3ed61bf2a830e89fd8fbbb6efc2e7171',1,'nc::NdArrayConstColumnIterator::iterator_category()'],['../classnc_1_1_nd_array_column_iterator.html#a3785618b3936e835ccc15b39440f3da5',1,'nc::NdArrayColumnIterator::iterator_category()']]] + ['i_502',['i',['../classnc_1_1rotations_1_1_quaternion.html#a5a661b367dff916e8bdb5e28ac608ecd',1,'nc::rotations::Quaternion']]], + ['identity_503',['identity',['../classnc_1_1rotations_1_1_quaternion.html#ae093d333b66b63eeef5704be4a374af2',1,'nc::rotations::Quaternion::identity()'],['../namespacenc.html#ac344d8b6291a38244e2d99cd77b17334',1,'nc::identity()']]], + ['identity_2ehpp_504',['identity.hpp',['../identity_8hpp.html',1,'']]], + ['imag_505',['imag',['../namespacenc.html#ae9eae82003557c0e94890a8f3bb3f5dc',1,'nc::imag(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a12cdcae89058ab627b68d32bc9ce0666',1,'nc::imag(const std::complex< dtype > &inValue)']]], + ['imag_2ehpp_506',['imag.hpp',['../imag_8hpp.html',1,'']]], + ['imageprocessing_2ehpp_507',['ImageProcessing.hpp',['../_image_processing_8hpp.html',1,'']]], + ['incrementnumberofiterations_508',['incrementNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#ad0262a1a694e734ebc154c77f010bcff',1,'nc::roots::Iteration']]], + ['inf_509',['inf',['../namespacenc_1_1constants.html#a4649bfc00f6360ccda3b3f9316e2dc0e',1,'nc::constants']]], + ['inner_510',['inner',['../namespacenc.html#aa44cb1f69e57caf4a79ff92960ddaebd',1,'nc']]], + ['inner_2ehpp_511',['inner.hpp',['../inner_8hpp.html',1,'']]], + ['installation_512',['Installation',['../md__c___github__num_cpp_docs_markdown__installation.html',1,'']]], + ['installation_2emd_513',['Installation.md',['../_installation_8md.html',1,'']]], + ['int16_514',['int16',['../namespacenc.html#a8f5045ed0f0a08d87fd76d7a74ac128d',1,'nc']]], + ['int32_515',['int32',['../namespacenc.html#a9386099a0fdc2bc9fb0dbfde5606584d',1,'nc']]], + ['int64_516',['int64',['../namespacenc.html#a6223a7f3b0f7886036f64276f36c921e',1,'nc']]], + ['int8_517',['int8',['../namespacenc.html#a0815baab2bc081f4250ba9cb1cf361b4',1,'nc']]], + ['integ_518',['integ',['../classnc_1_1polynomial_1_1_poly1d.html#a4c2902780c89054a6ca436a72ac77119',1,'nc::polynomial::Poly1d']]], + ['integrate_2ehpp_519',['Integrate.hpp',['../_integrate_8hpp.html',1,'']]], + ['intensity_520',['intensity',['../classnc_1_1image_processing_1_1_pixel.html#a2ffea8fff18945da4971ab4c847a49bd',1,'nc::imageProcessing::Pixel::intensity()'],['../classnc_1_1image_processing_1_1_centroid.html#aa203a8f8138fe9679f307f38ad65a5aa',1,'nc::imageProcessing::Centroid::intensity()'],['../classnc_1_1image_processing_1_1_cluster.html#a1797d804406d51ab2e22d5b9fae9cb53',1,'nc::imageProcessing::Cluster::intensity()']]], + ['interp_521',['interp',['../namespacenc.html#a5b9584eeac344f9d37beb6be475300ca',1,'nc::interp()'],['../namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e',1,'nc::utils::interp()'],['../namespacenc.html#a25a0717dab4a33f74927d390b83182ab',1,'nc::interp(const NdArray< dtype > &inX, const NdArray< dtype > &inXp, const NdArray< dtype > &inFp)']]], + ['intersect1d_522',['intersect1d',['../namespacenc.html#a05a1080b20bfa1434ccb96fb08836bc4',1,'nc']]], + ['intersect1d_2ehpp_523',['intersect1d.hpp',['../intersect1d_8hpp.html',1,'']]], + ['inv_524',['inv',['../namespacenc_1_1linalg.html#ae36553eb100d8f2c2167e8ecadf2a9fc',1,'nc::linalg']]], + ['inv_2ehpp_525',['inv.hpp',['../inv_8hpp.html',1,'']]], + ['inverse_526',['inverse',['../classnc_1_1rotations_1_1_quaternion.html#a9b0634474b2ff27f9443ba256ea00ab1',1,'nc::rotations::Quaternion']]], + ['invert_527',['invert',['../namespacenc.html#a4159e9798b5726992f13f27366bea4f5',1,'nc']]], + ['invert_2ehpp_528',['invert.hpp',['../invert_8hpp.html',1,'']]], + ['is_5farithmetic_5fv_529',['is_arithmetic_v',['../namespacenc.html#ad5ef02185c876c1c30e12824c3b9aba5',1,'nc']]], + ['is_5fcomplex_530',['is_complex',['../structnc_1_1is__complex.html',1,'nc']]], + ['is_5fcomplex_3c_20std_3a_3acomplex_3c_20t_20_3e_20_3e_531',['is_complex< std::complex< T > >',['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html',1,'nc']]], + ['is_5fcomplex_5fv_532',['is_complex_v',['../namespacenc.html#af8be3598b0e2894429842d64d3ce4050',1,'nc']]], + ['is_5ffloating_5fpoint_5fv_533',['is_floating_point_v',['../namespacenc.html#a33d8e465a48ee094f340d8a5bab416bd',1,'nc']]], + ['is_5fintegral_5fv_534',['is_integral_v',['../namespacenc.html#a157cdac039a66a88d2aa922781d060f6',1,'nc']]], + ['is_5fsame_5fv_535',['is_same_v',['../namespacenc.html#a04829dab261829c5ee2570febfa287eb',1,'nc']]], + ['is_5fsorted_536',['is_sorted',['../namespacenc_1_1stl__algorithms.html#a1f71dfda5f16d8a53c16260c5fa8fbdc',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#aca7862e3fe066fc65bf00cb7f5108e33',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last) noexcept']]], + ['is_5fvalid_5fdtype_537',['is_valid_dtype',['../structnc_1_1is__valid__dtype.html',1,'nc']]], + ['is_5fvalid_5fdtype_5fv_538',['is_valid_dtype_v',['../namespacenc.html#aae4eab83016ec7dcaa7d78b6d1e78481',1,'nc']]], + ['isclose_539',['isclose',['../namespacenc.html#ae80bdb1c4ce59e2a74cad2d518f50e1e',1,'nc']]], + ['isclose_2ehpp_540',['isclose.hpp',['../isclose_8hpp.html',1,'']]], + ['isempty_541',['isempty',['../classnc_1_1_data_cube.html#ac569e0c62a9e5cbf21228b85128a53a5',1,'nc::DataCube::isempty()'],['../classnc_1_1_nd_array.html#a3e5261e1be6357a2c608f5e1d97b35f9',1,'nc::NdArray::isempty() const noexcept']]], + ['isflat_542',['isflat',['../classnc_1_1_nd_array.html#a344f12e052eeb49cc87e361127386a64',1,'nc::NdArray']]], + ['isinf_543',['isinf',['../namespacenc.html#ac2770d614de64c300c2f10cb39a299c0',1,'nc::isinf(dtype inValue) noexcept'],['../namespacenc.html#a38b400fe936ea86828d4e29d5b0950bb',1,'nc::isinf(const NdArray< dtype > &inArray)']]], + ['isinf_2ehpp_544',['isinf.hpp',['../isinf_8hpp.html',1,'']]], + ['isinteger_545',['isInteger',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac055638657a1459bc6a7c9d94d5c96a4',1,'nc::DtypeInfo< std::complex< dtype > >::isInteger()'],['../classnc_1_1_dtype_info.html#a10b60bd27123b5c724e2a52526fe8cfe',1,'nc::DtypeInfo::isInteger()']]], + ['islittleendian_546',['isLittleEndian',['../namespacenc_1_1endian.html#a11907ef8078650aee8fe900854ba5bb4',1,'nc::endian']]], + ['isnan_547',['isnan',['../namespacenc.html#aedce7cd7ff92f9fec0c93cd9c5522ca8',1,'nc::isnan(const NdArray< dtype > &inArray)'],['../namespacenc.html#ac28569da874c0b37a4c50c86b31a98ab',1,'nc::isnan(dtype inValue) noexcept']]], + ['isnan_2ehpp_548',['isnan.hpp',['../isnan_8hpp.html',1,'']]], + ['isneginf_549',['isneginf',['../namespacenc.html#abb8e6e08f1b4374017ef8e4cd1841ba6',1,'nc::isneginf(dtype inValue) noexcept'],['../namespacenc.html#af02b9a27f4177ad1ccb9ecea6ab79f46',1,'nc::isneginf(const NdArray< dtype > &inArray)']]], + ['isneginf_2ehpp_550',['isneginf.hpp',['../isneginf_8hpp.html',1,'']]], + ['isnull_551',['isnull',['../classnc_1_1_shape.html#a3c8d187f677e9a4cdbdf1906d612b596',1,'nc::Shape']]], + ['isposinf_552',['isposinf',['../namespacenc.html#a7229b43ce1e19fb560d461b6beda24af',1,'nc::isposinf(dtype inValue) noexcept'],['../namespacenc.html#a00f30f48ef39bc0fa8149cb09b286e07',1,'nc::isposinf(const NdArray< dtype > &inArray)']]], + ['isposinf_2ehpp_553',['isposinf.hpp',['../isposinf_8hpp.html',1,'']]], + ['ispoweroftwo_554',['isPowerOfTwo',['../namespacenc_1_1edac_1_1detail.html#a7f066ec8b196c2943ae99382eb63e2fb',1,'nc::edac::detail']]], + ['issigned_555',['isSigned',['../classnc_1_1_dtype_info.html#a039ecfb9a5bd9fe0cb751a59f28055d1',1,'nc::DtypeInfo::isSigned()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac58a829905d11a1a7fca32427eab41d3',1,'nc::DtypeInfo< std::complex< dtype > >::isSigned()']]], + ['issorted_556',['issorted',['../classnc_1_1_nd_array.html#a0ba38857fd4f9474e2814bbf1c3a6a0a',1,'nc::NdArray']]], + ['issquare_557',['issquare',['../classnc_1_1_shape.html#a939dd0ab6edf83b7abaf8b8c93a99152',1,'nc::Shape::issquare()'],['../classnc_1_1_nd_array.html#a302be17d815b1a4e353e6a2aade581a5',1,'nc::NdArray::issquare()']]], + ['isvalid_558',['isValid',['../classnc_1_1rotations_1_1_d_c_m.html#ab1947c7618408b063b704ec391e27888',1,'nc::rotations::DCM']]], + ['item_559',['item',['../classnc_1_1_nd_array.html#abec76b8f271e07fa07cc2f88fed676fa',1,'nc::NdArray']]], + ['iteration_560',['Iteration',['../classnc_1_1roots_1_1_iteration.html#a7948f08cfaa01f5685ec35149bf6bba0',1,'nc::roots::Iteration::Iteration(double epsilon, uint32 maxNumIterations) noexcept'],['../classnc_1_1roots_1_1_iteration.html#a2d7285a81c033d56ce8283b6dbfca136',1,'nc::roots::Iteration::Iteration(double epsilon) noexcept'],['../classnc_1_1roots_1_1_iteration.html',1,'nc::roots::Iteration']]], + ['iteration_2ehpp_561',['Iteration.hpp',['../_iteration_8hpp.html',1,'']]], + ['iterator_562',['iterator',['../classnc_1_1_nd_array.html#a33ce0c581a22e809cfc5a79a534bf798',1,'nc::NdArray::iterator()'],['../classnc_1_1_data_cube.html#a623df8fc48ba169d221b1c26249e5853',1,'nc::DataCube::iterator()']]], + ['iterator_5fcategory_563',['iterator_category',['../classnc_1_1_nd_array_column_iterator.html#a3785618b3936e835ccc15b39440f3da5',1,'nc::NdArrayColumnIterator::iterator_category()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3ed61bf2a830e89fd8fbbb6efc2e7171',1,'nc::NdArrayConstColumnIterator::iterator_category()'],['../classnc_1_1_nd_array_iterator.html#a7b2c0794eac54ab2c3847776a8383283',1,'nc::NdArrayIterator::iterator_category()'],['../classnc_1_1_nd_array_const_iterator.html#a17535e5dcb696923adaa626c86cc3c00',1,'nc::NdArrayConstIterator::iterator_category()']]] ]; diff --git a/docs/doxygen/html/search/all_9.html b/docs/doxygen/html/search/all_9.html index 892a37946..1e263c134 100644 --- a/docs/doxygen/html/search/all_9.html +++ b/docs/doxygen/html/search/all_9.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_9.js b/docs/doxygen/html/search/all_9.js index dab58a401..9661e3bc3 100644 --- a/docs/doxygen/html/search/all_9.js +++ b/docs/doxygen/html/search/all_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['j_530',['j',['../classnc_1_1rotations_1_1_quaternion.html#acb62c703a1f96333bf76ad0735cb8b97',1,'nc::rotations::Quaternion::j()'],['../namespacenc_1_1constants.html#a0e933571f05ee6af915fc327260517e9',1,'nc::constants::j()']]] + ['j_564',['j',['../classnc_1_1rotations_1_1_quaternion.html#acb62c703a1f96333bf76ad0735cb8b97',1,'nc::rotations::Quaternion::j()'],['../namespacenc_1_1constants.html#a0e933571f05ee6af915fc327260517e9',1,'nc::constants::j()']]] ]; diff --git a/docs/doxygen/html/search/all_a.html b/docs/doxygen/html/search/all_a.html index 5aeaf81dd..3a6cac108 100644 --- a/docs/doxygen/html/search/all_a.html +++ b/docs/doxygen/html/search/all_a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_a.js b/docs/doxygen/html/search/all_a.js index 99d4486e8..bdcfeed47 100644 --- a/docs/doxygen/html/search/all_a.js +++ b/docs/doxygen/html/search/all_a.js @@ -1,4 +1,6 @@ var searchData= [ - ['k_531',['k',['../classnc_1_1rotations_1_1_quaternion.html#aa2eee61d3a428a558f28d1bb6cc6a048',1,'nc::rotations::Quaternion']]] + ['k_565',['k',['../classnc_1_1rotations_1_1_quaternion.html#aa2eee61d3a428a558f28d1bb6cc6a048',1,'nc::rotations::Quaternion']]], + ['kaiser_566',['kaiser',['../namespacenc.html#a40ad53a4a4ad1be06ca85bbf9f9e9d25',1,'nc']]], + ['kaiser_2ehpp_567',['kaiser.hpp',['../kaiser_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_b.html b/docs/doxygen/html/search/all_b.html index 9253f5e4b..130deb4ed 100644 --- a/docs/doxygen/html/search/all_b.html +++ b/docs/doxygen/html/search/all_b.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_b.js b/docs/doxygen/html/search/all_b.js index 18dcbcada..88c2ed872 100644 --- a/docs/doxygen/html/search/all_b.js +++ b/docs/doxygen/html/search/all_b.js @@ -1,53 +1,57 @@ var searchData= [ - ['laguerre_532',['laguerre',['../namespacenc_1_1polynomial.html#a9a3c9fb31c548094a1ce7ec927f28bee',1,'nc::polynomial::laguerre(uint32 n, uint32 m, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a55e940d8393b196ebce707ac8b0df5b9',1,'nc::polynomial::laguerre(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#ad7fef1e52b0054b5894995ee1ed94340',1,'nc::polynomial::laguerre(uint32 n, uint32 m, dtype x)'],['../namespacenc_1_1polynomial.html#aa2c08952d8dfd2cccfbcd6da40b49f4f',1,'nc::polynomial::laguerre(uint32 n, dtype x)']]], - ['laguerre_2ehpp_533',['laguerre.hpp',['../laguerre_8hpp.html',1,'']]], - ['laplace_534',['laplace',['../namespacenc_1_1random.html#ab2ecb1401cb11a3c816073fcbc7b05b5',1,'nc::random::laplace(const Shape &inShape, dtype inLoc=0, dtype inScale=1)'],['../namespacenc_1_1random.html#a76e5b2a6feb9bf6a05c5dd9402f9c62f',1,'nc::random::laplace(dtype inLoc=0, dtype inScale=1)'],['../namespacenc_1_1filter.html#aae2d06efe29180faf7363b9322588f46',1,'nc::filter::laplace()']]], - ['lcm_535',['lcm',['../namespacenc.html#a7ffd0c15b8419a5d84458d4009b38b88',1,'nc::lcm(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#aa69cf791720987deb546d71057a668a1',1,'nc::lcm(const NdArray< dtype > &inArray)']]], - ['lcm_2ehpp_536',['lcm.hpp',['../lcm_8hpp.html',1,'']]], - ['ldexp_537',['ldexp',['../namespacenc.html#a52060ff2d69ed791b3f19c1d78cf8551',1,'nc::ldexp(const NdArray< dtype > &inArray1, const NdArray< uint8 > &inArray2)'],['../namespacenc.html#aca805ef0273314ddc6c70b2c913bf485',1,'nc::ldexp(dtype inValue1, uint8 inValue2) noexcept']]], - ['ldexp_2ehpp_538',['ldexp.hpp',['../ldexp_8hpp.html',1,'']]], - ['left_539',['left',['../classnc_1_1_vec3.html#a7e6730d945972ecda1815c1d41f5074c',1,'nc::Vec3::left()'],['../classnc_1_1_vec2.html#ade3f4342726264a1493f91ae80ab24ca',1,'nc::Vec2::left()']]], - ['left_5fshift_540',['left_shift',['../namespacenc.html#a6f10270824079210d4264d50f5a64f4d',1,'nc']]], - ['left_5fshift_2ehpp_541',['left_shift.hpp',['../left__shift_8hpp.html',1,'']]], - ['legendre_5fp_542',['legendre_p',['../namespacenc_1_1polynomial.html#aa3860199d898cdf173f3846cce684d72',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a10a5a1a92ac32725bb3d0496078f122e',1,'nc::polynomial::legendre_p(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a6a68bde646dae6ffb484502d54e5c175',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a567bdffcff63421b77a9dfae9cbdfc8a',1,'nc::polynomial::legendre_p(uint32 n, dtype x)']]], - ['legendre_5fp_2ehpp_543',['legendre_p.hpp',['../legendre__p_8hpp.html',1,'']]], - ['legendre_5fq_544',['legendre_q',['../namespacenc_1_1polynomial.html#aed5c95f5a321ec71c1a34a42414bec52',1,'nc::polynomial::legendre_q(int32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a78897e159974d6732b77759be2f2da13',1,'nc::polynomial::legendre_q(int32 n, dtype x)']]], - ['legendre_5fq_2ehpp_545',['legendre_q.hpp',['../legendre__q_8hpp.html',1,'']]], - ['legendrepolynomial_546',['LegendrePolynomial',['../classnc_1_1integrate_1_1_legendre_polynomial.html#a2e1fefae138e66215cd7586a85fc3642',1,'nc::integrate::LegendrePolynomial::LegendrePolynomial()'],['../classnc_1_1integrate_1_1_legendre_polynomial.html',1,'nc::integrate::LegendrePolynomial']]], - ['lerp_547',['lerp',['../classnc_1_1_vec3.html#ab4878c8a4ebcd94fd0baf93059b50ac6',1,'nc::Vec3::lerp()'],['../classnc_1_1_vec2.html#a91e6417e5b9903ed6bee3ad90c0c38f4',1,'nc::Vec2::lerp()']]], - ['less_548',['less',['../namespacenc.html#a114baa0d21d439b7971dedd4b4042db8',1,'nc']]], - ['less_2ehpp_549',['less.hpp',['../less_8hpp.html',1,'']]], - ['less_5fequal_550',['less_equal',['../namespacenc.html#ac51b96f0ac720a028ebd856abf1b5785',1,'nc']]], - ['less_5fequal_2ehpp_551',['less_equal.hpp',['../less__equal_8hpp.html',1,'']]], - ['linalg_2ehpp_552',['Linalg.hpp',['../_linalg_8hpp.html',1,'']]], - ['linspace_553',['linspace',['../namespacenc.html#a672fbcbd2271d5fc58bd1b94750bbdcc',1,'nc']]], - ['linspace_2ehpp_554',['linspace.hpp',['../linspace_8hpp.html',1,'']]], - ['little_555',['LITTLE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152a1314341b466dcb5e2c880b76414c49fe',1,'nc']]], - ['load_556',['load',['../namespacenc.html#abec5f2e4d2a1598de762e32b839a3067',1,'nc']]], - ['load_2ehpp_557',['load.hpp',['../load_8hpp.html',1,'']]], - ['log_558',['log',['../namespacenc.html#aba925957229bf54bfe854be197cd3d52',1,'nc::log(const NdArray< dtype > &inArray)'],['../namespacenc.html#a3f08d373ae167ac90d3bb6b6c4da0fb9',1,'nc::log(dtype inValue) noexcept']]], - ['log_2ehpp_559',['log.hpp',['../log_8hpp.html',1,'']]], - ['log10_560',['log10',['../namespacenc.html#a3cd82f65b6ee069a7d6443646dfecf67',1,'nc::log10(const NdArray< dtype > &inArray)'],['../namespacenc.html#a0d8a5ffeaed868463a6e55645c625c8f',1,'nc::log10(dtype inValue) noexcept']]], - ['log10_2ehpp_561',['log10.hpp',['../log10_8hpp.html',1,'']]], - ['log1p_562',['log1p',['../namespacenc.html#a1ae30700a2db1cd8e44fa59b84c2b547',1,'nc::log1p(const NdArray< dtype > &inArray)'],['../namespacenc.html#a5abcc8523a49a47fd2224d5588f128b4',1,'nc::log1p(dtype inValue) noexcept']]], - ['log1p_2ehpp_563',['log1p.hpp',['../log1p_8hpp.html',1,'']]], - ['log2_564',['log2',['../namespacenc.html#a536e5046481a32bd6955a222f323393a',1,'nc::log2(const NdArray< dtype > &inArray)'],['../namespacenc.html#a48cbc16dc706678b6f85e655e935cd41',1,'nc::log2(dtype inValue) noexcept']]], - ['log2_2ehpp_565',['log2.hpp',['../log2_8hpp.html',1,'']]], - ['log_5fgamma_566',['log_gamma',['../namespacenc_1_1special.html#a11ec3d4677a53eafd8b0144cd6e42ce3',1,'nc::special::log_gamma(dtype inValue)'],['../namespacenc_1_1special.html#addebe777849a11f027a793975a53b653',1,'nc::special::log_gamma(const NdArray< dtype > &inArray)']]], - ['log_5fgamma_2ehpp_567',['log_gamma.hpp',['../log__gamma_8hpp.html',1,'']]], - ['logical_5fand_568',['logical_and',['../namespacenc.html#a951c3f9acd6147a8e2be1ab2cda4d51c',1,'nc']]], - ['logical_5fand_2ehpp_569',['logical_and.hpp',['../logical__and_8hpp.html',1,'']]], - ['logical_5fnot_570',['logical_not',['../namespacenc.html#ae90620999105f741609c7f279cac2907',1,'nc']]], - ['logical_5fnot_2ehpp_571',['logical_not.hpp',['../logical__not_8hpp.html',1,'']]], - ['logical_5for_572',['logical_or',['../namespacenc.html#a0492e302b114ab15b996b1330604478b',1,'nc']]], - ['logical_5for_2ehpp_573',['logical_or.hpp',['../logical__or_8hpp.html',1,'']]], - ['logical_5fxor_574',['logical_xor',['../namespacenc.html#a7b84e63b2d32e1b59bfef4690c918989',1,'nc']]], - ['logical_5fxor_2ehpp_575',['logical_xor.hpp',['../logical__xor_8hpp.html',1,'']]], - ['lognormal_576',['lognormal',['../namespacenc_1_1random.html#a03d5528a3a97b3731210ba2cc5d1c75d',1,'nc::random::lognormal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a3adc9de1025d27ed485603980657225b',1,'nc::random::lognormal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], - ['lognormal_2ehpp_577',['lognormal.hpp',['../lognormal_8hpp.html',1,'']]], - ['lstsq_578',['lstsq',['../namespacenc_1_1linalg.html#a9c15421c77e6b4b12fca1515596d1414',1,'nc::linalg']]], - ['lstsq_2ehpp_579',['lstsq.hpp',['../lstsq_8hpp.html',1,'']]], - ['lu_5fdecomposition_580',['lu_decomposition',['../namespacenc_1_1linalg.html#a153a90dbcc2ca94c664c429868d15bc4',1,'nc::linalg']]], - ['lu_5fdecomposition_2ehpp_581',['lu_decomposition.hpp',['../lu__decomposition_8hpp.html',1,'']]] + ['laguerre_568',['laguerre',['../namespacenc_1_1polynomial.html#a55e940d8393b196ebce707ac8b0df5b9',1,'nc::polynomial::laguerre(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a9a3c9fb31c548094a1ce7ec927f28bee',1,'nc::polynomial::laguerre(uint32 n, uint32 m, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#aa2c08952d8dfd2cccfbcd6da40b49f4f',1,'nc::polynomial::laguerre(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#ad7fef1e52b0054b5894995ee1ed94340',1,'nc::polynomial::laguerre(uint32 n, uint32 m, dtype x)']]], + ['laguerre_2ehpp_569',['laguerre.hpp',['../laguerre_8hpp.html',1,'']]], + ['laplace_570',['laplace',['../namespacenc_1_1filter.html#aae2d06efe29180faf7363b9322588f46',1,'nc::filter::laplace()'],['../namespacenc_1_1random.html#a76e5b2a6feb9bf6a05c5dd9402f9c62f',1,'nc::random::laplace(dtype inLoc=0, dtype inScale=1)'],['../namespacenc_1_1random.html#ab2ecb1401cb11a3c816073fcbc7b05b5',1,'nc::random::laplace(const Shape &inShape, dtype inLoc=0, dtype inScale=1)']]], + ['lcm_571',['lcm',['../namespacenc.html#aa69cf791720987deb546d71057a668a1',1,'nc::lcm(const NdArray< dtype > &inArray)'],['../namespacenc.html#a7ffd0c15b8419a5d84458d4009b38b88',1,'nc::lcm(dtype inValue1, dtype inValue2) noexcept']]], + ['lcm_2ehpp_572',['lcm.hpp',['../lcm_8hpp.html',1,'']]], + ['ldexp_573',['ldexp',['../namespacenc.html#a52060ff2d69ed791b3f19c1d78cf8551',1,'nc::ldexp(const NdArray< dtype > &inArray1, const NdArray< uint8 > &inArray2)'],['../namespacenc.html#aca805ef0273314ddc6c70b2c913bf485',1,'nc::ldexp(dtype inValue1, uint8 inValue2) noexcept']]], + ['ldexp_2ehpp_574',['ldexp.hpp',['../ldexp_8hpp.html',1,'']]], + ['left_575',['left',['../classnc_1_1_vec2.html#ade3f4342726264a1493f91ae80ab24ca',1,'nc::Vec2::left()'],['../classnc_1_1_vec3.html#a7e6730d945972ecda1815c1d41f5074c',1,'nc::Vec3::left()']]], + ['left_5fshift_576',['left_shift',['../namespacenc.html#a6f10270824079210d4264d50f5a64f4d',1,'nc']]], + ['left_5fshift_2ehpp_577',['left_shift.hpp',['../left__shift_8hpp.html',1,'']]], + ['legendre_5fp_578',['legendre_p',['../namespacenc_1_1polynomial.html#a567bdffcff63421b77a9dfae9cbdfc8a',1,'nc::polynomial::legendre_p(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#aa3860199d898cdf173f3846cce684d72',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a6a68bde646dae6ffb484502d54e5c175',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a10a5a1a92ac32725bb3d0496078f122e',1,'nc::polynomial::legendre_p(uint32 n, const NdArray< dtype > &inArrayX)']]], + ['legendre_5fp_2ehpp_579',['legendre_p.hpp',['../legendre__p_8hpp.html',1,'']]], + ['legendre_5fq_580',['legendre_q',['../namespacenc_1_1polynomial.html#aed5c95f5a321ec71c1a34a42414bec52',1,'nc::polynomial::legendre_q(int32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a78897e159974d6732b77759be2f2da13',1,'nc::polynomial::legendre_q(int32 n, dtype x)']]], + ['legendre_5fq_2ehpp_581',['legendre_q.hpp',['../legendre__q_8hpp.html',1,'']]], + ['legendrepolynomial_582',['LegendrePolynomial',['../classnc_1_1integrate_1_1_legendre_polynomial.html#a2e1fefae138e66215cd7586a85fc3642',1,'nc::integrate::LegendrePolynomial::LegendrePolynomial()'],['../classnc_1_1integrate_1_1_legendre_polynomial.html',1,'nc::integrate::LegendrePolynomial']]], + ['lerp_583',['lerp',['../classnc_1_1_vec2.html#a91e6417e5b9903ed6bee3ad90c0c38f4',1,'nc::Vec2::lerp()'],['../classnc_1_1_vec3.html#ab4878c8a4ebcd94fd0baf93059b50ac6',1,'nc::Vec3::lerp()']]], + ['less_584',['less',['../namespacenc.html#a114baa0d21d439b7971dedd4b4042db8',1,'nc']]], + ['less_2ehpp_585',['less.hpp',['../less_8hpp.html',1,'']]], + ['less_5fequal_586',['less_equal',['../namespacenc.html#ac51b96f0ac720a028ebd856abf1b5785',1,'nc']]], + ['less_5fequal_2ehpp_587',['less_equal.hpp',['../less__equal_8hpp.html',1,'']]], + ['linalg_2ehpp_588',['Linalg.hpp',['../_linalg_8hpp.html',1,'']]], + ['linspace_589',['linspace',['../namespacenc.html#a672fbcbd2271d5fc58bd1b94750bbdcc',1,'nc']]], + ['linspace_2ehpp_590',['linspace.hpp',['../linspace_8hpp.html',1,'']]], + ['little_591',['LITTLE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152a1314341b466dcb5e2c880b76414c49fe',1,'nc']]], + ['load_592',['load',['../namespacenc.html#abec5f2e4d2a1598de762e32b839a3067',1,'nc']]], + ['load_2ehpp_593',['load.hpp',['../load_8hpp.html',1,'']]], + ['log_594',['log',['../namespacenc.html#a3f08d373ae167ac90d3bb6b6c4da0fb9',1,'nc::log(dtype inValue) noexcept'],['../namespacenc.html#aba925957229bf54bfe854be197cd3d52',1,'nc::log(const NdArray< dtype > &inArray)']]], + ['log_2ehpp_595',['log.hpp',['../log_8hpp.html',1,'']]], + ['log10_596',['log10',['../namespacenc.html#a0d8a5ffeaed868463a6e55645c625c8f',1,'nc::log10(dtype inValue) noexcept'],['../namespacenc.html#a3cd82f65b6ee069a7d6443646dfecf67',1,'nc::log10(const NdArray< dtype > &inArray)']]], + ['log10_2ehpp_597',['log10.hpp',['../log10_8hpp.html',1,'']]], + ['log1p_598',['log1p',['../namespacenc.html#a5abcc8523a49a47fd2224d5588f128b4',1,'nc::log1p(dtype inValue) noexcept'],['../namespacenc.html#a1ae30700a2db1cd8e44fa59b84c2b547',1,'nc::log1p(const NdArray< dtype > &inArray)']]], + ['log1p_2ehpp_599',['log1p.hpp',['../log1p_8hpp.html',1,'']]], + ['log2_600',['log2',['../namespacenc.html#a48cbc16dc706678b6f85e655e935cd41',1,'nc::log2(dtype inValue) noexcept'],['../namespacenc.html#a536e5046481a32bd6955a222f323393a',1,'nc::log2(const NdArray< dtype > &inArray)']]], + ['log2_2ehpp_601',['log2.hpp',['../log2_8hpp.html',1,'']]], + ['log_5fgamma_602',['log_gamma',['../namespacenc_1_1special.html#a11ec3d4677a53eafd8b0144cd6e42ce3',1,'nc::special::log_gamma(dtype inValue)'],['../namespacenc_1_1special.html#addebe777849a11f027a793975a53b653',1,'nc::special::log_gamma(const NdArray< dtype > &inArray)']]], + ['log_5fgamma_2ehpp_603',['log_gamma.hpp',['../log__gamma_8hpp.html',1,'']]], + ['logb_604',['logb',['../namespacenc.html#a4925bc774ee8c671be4e15ba4305d230',1,'nc::logb(dtype inValue, dtype inBase) noexcept'],['../namespacenc.html#a512c632dd9629cbc02ad96398f82ab2a',1,'nc::logb(const NdArray< dtype > &inArray, dtype inBase)']]], + ['logb_2ehpp_605',['logb.hpp',['../logb_8hpp.html',1,'']]], + ['logical_5fand_606',['logical_and',['../namespacenc.html#a951c3f9acd6147a8e2be1ab2cda4d51c',1,'nc']]], + ['logical_5fand_2ehpp_607',['logical_and.hpp',['../logical__and_8hpp.html',1,'']]], + ['logical_5fnot_608',['logical_not',['../namespacenc.html#ae90620999105f741609c7f279cac2907',1,'nc']]], + ['logical_5fnot_2ehpp_609',['logical_not.hpp',['../logical__not_8hpp.html',1,'']]], + ['logical_5for_610',['logical_or',['../namespacenc.html#a0492e302b114ab15b996b1330604478b',1,'nc']]], + ['logical_5for_2ehpp_611',['logical_or.hpp',['../logical__or_8hpp.html',1,'']]], + ['logical_5fxor_612',['logical_xor',['../namespacenc.html#a7b84e63b2d32e1b59bfef4690c918989',1,'nc']]], + ['logical_5fxor_2ehpp_613',['logical_xor.hpp',['../logical__xor_8hpp.html',1,'']]], + ['lognormal_614',['lognormal',['../namespacenc_1_1random.html#a03d5528a3a97b3731210ba2cc5d1c75d',1,'nc::random::lognormal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a3adc9de1025d27ed485603980657225b',1,'nc::random::lognormal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], + ['lognormal_2ehpp_615',['lognormal.hpp',['../lognormal_8hpp.html',1,'']]], + ['logspace_616',['logspace',['../namespacenc.html#a4342eee2bea5ed3c8ece78b9119efc31',1,'nc']]], + ['logspace_2ehpp_617',['logspace.hpp',['../logspace_8hpp.html',1,'']]], + ['lstsq_618',['lstsq',['../namespacenc_1_1linalg.html#a9c15421c77e6b4b12fca1515596d1414',1,'nc::linalg']]], + ['lstsq_2ehpp_619',['lstsq.hpp',['../lstsq_8hpp.html',1,'']]], + ['lu_5fdecomposition_620',['lu_decomposition',['../namespacenc_1_1linalg.html#a153a90dbcc2ca94c664c429868d15bc4',1,'nc::linalg']]], + ['lu_5fdecomposition_2ehpp_621',['lu_decomposition.hpp',['../lu__decomposition_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_c.html b/docs/doxygen/html/search/all_c.html index 72d8d3759..3dd5af06d 100644 --- a/docs/doxygen/html/search/all_c.html +++ b/docs/doxygen/html/search/all_c.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_c.js b/docs/doxygen/html/search/all_c.js index 832d1c6da..05a8234e2 100644 --- a/docs/doxygen/html/search/all_c.js +++ b/docs/doxygen/html/search/all_c.js @@ -1,54 +1,54 @@ var searchData= [ - ['makepositiveandvalidate_582',['makePositiveAndValidate',['../classnc_1_1_slice.html#a4d518d51dad679d9a9c6938b065e38f8',1,'nc::Slice']]], - ['matmul_583',['matmul',['../namespacenc.html#a9f795cdfcf86a07f1a7febcb9d024c73',1,'nc::matmul(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a82209f3c03cb63a659d28e7c87f7ee23',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#ab39e4a1bc6bcd0f28dbd5806d5f2d0b9',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['matmul_2ehpp_584',['matmul.hpp',['../matmul_8hpp.html',1,'']]], - ['matrix_5fpower_585',['matrix_power',['../namespacenc_1_1linalg.html#ad27c1996e4e27a6f8ba5d2aed0743bba',1,'nc::linalg']]], - ['matrix_5fpower_2ehpp_586',['matrix_power.hpp',['../matrix__power_8hpp.html',1,'']]], - ['max_587',['max',['../namespacenc.html#a4d5872f22ac07aeba503857cb5948bc1',1,'nc::max()'],['../classnc_1_1_nd_array.html#abbca6c205525a4b706729f9f36acc06d',1,'nc::NdArray::max()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#acdf46b23b24e1421c38e6297c56024d1',1,'nc::DtypeInfo< std::complex< dtype > >::max()'],['../classnc_1_1_dtype_info.html#a2a3dc0ba2812411660219f61189d8aca',1,'nc::DtypeInfo::max()']]], - ['max_2ehpp_588',['max.hpp',['../max_8hpp.html',1,'']]], - ['max_5felement_589',['max_element',['../namespacenc_1_1stl__algorithms.html#a282a4146afe33e4abb012e5c6b332948',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a334cd50f7f10f689f82fa2ba7c5d88b2',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last) noexcept']]], - ['maximum_590',['maximum',['../namespacenc.html#a417e75e173adaf0f6a9905a60a62e135',1,'nc']]], - ['maximum_2ehpp_591',['maximum.hpp',['../maximum_8hpp.html',1,'']]], - ['maximumfilter_592',['maximumFilter',['../namespacenc_1_1filter.html#a237010b21fd77fa3b72c1fda0360f6a9',1,'nc::filter']]], - ['maximumfilter_2ehpp_593',['maximumFilter.hpp',['../maximum_filter_8hpp.html',1,'']]], - ['maximumfilter1d_594',['maximumFilter1d',['../namespacenc_1_1filter.html#a6760bbaeefd6338527665fa2426cf418',1,'nc::filter']]], - ['maximumfilter1d_2ehpp_595',['maximumFilter1d.hpp',['../maximum_filter1d_8hpp.html',1,'']]], - ['maxnumiterations_5f_596',['maxNumIterations_',['../classnc_1_1roots_1_1_iteration.html#a9b1c4ea8cf91c5308020c105293b4a02',1,'nc::roots::Iteration']]], - ['mean_597',['mean',['../namespacenc.html#ac0b868e518c5b489ce25b8a84ebc618b',1,'nc::mean(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ae215351046b49fec834d006fd35a4078',1,'nc::mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], - ['mean_2ehpp_598',['mean.hpp',['../mean_8hpp.html',1,'']]], - ['median_599',['median',['../namespacenc.html#a737b54d3ec786235c90211a3ad4a5cfb',1,'nc::median()'],['../classnc_1_1_nd_array.html#a4d733d7a90d94c3f21e90ab79dc2cc14',1,'nc::NdArray::median()']]], - ['median_2ehpp_600',['median.hpp',['../median_8hpp.html',1,'']]], - ['medianfilter_601',['medianFilter',['../namespacenc_1_1filter.html#a6edb931e0ad73a60625c4854f11ab82a',1,'nc::filter']]], - ['medianfilter_2ehpp_602',['medianFilter.hpp',['../median_filter_8hpp.html',1,'']]], - ['medianfilter1d_603',['medianFilter1d',['../namespacenc_1_1filter.html#a39fc9c2648f0d223b63a5f1b7253bb40',1,'nc::filter']]], - ['medianfilter1d_2ehpp_604',['medianFilter1d.hpp',['../median_filter1d_8hpp.html',1,'']]], - ['meshgrid_605',['meshgrid',['../namespacenc.html#ae392e03f9e01b088a082c6055082df49',1,'nc::meshgrid(const NdArray< dtype > &inICoords, const NdArray< dtype > &inJCoords)'],['../namespacenc.html#a2338e094bb1195888e3f385d01627c4f',1,'nc::meshgrid(const Slice &inSlice1, const Slice &inSlice2)']]], - ['meshgrid_2ehpp_606',['meshgrid.hpp',['../meshgrid_8hpp.html',1,'']]], - ['milliseconds_5fper_5fday_607',['MILLISECONDS_PER_DAY',['../namespacenc_1_1constants.html#a2838aa56f95be8020a326aa6b9ba5c68',1,'nc::constants']]], - ['milliseconds_5fper_5fsecond_608',['MILLISECONDS_PER_SECOND',['../namespacenc_1_1constants.html#a4373df6d6df75334290f4240f174aeb0',1,'nc::constants']]], - ['min_609',['min',['../classnc_1_1_nd_array.html#a7f0c49ac50a79ba24ea8d351ee70fd55',1,'nc::NdArray::min()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a420b21e23e9673bea71980f55bf82d03',1,'nc::DtypeInfo< std::complex< dtype > >::min()'],['../classnc_1_1_dtype_info.html#ab566f68bc6b82c06b5a3df887f87ab74',1,'nc::DtypeInfo::min()'],['../namespacenc.html#a8a61a49362258590b70289fd63fb2d8e',1,'nc::min()']]], - ['min_2ehpp_610',['min.hpp',['../min_8hpp.html',1,'']]], - ['min_5felement_611',['min_element',['../namespacenc_1_1stl__algorithms.html#af6291d1011c61c416134bc28def6f3ac',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#acb252e962fc7cedee9f4257453480d2b',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], - ['minimum_612',['minimum',['../namespacenc.html#a8499c0529d36d402e32b3990d31429e8',1,'nc']]], - ['minimum_2ehpp_613',['minimum.hpp',['../minimum_8hpp.html',1,'']]], - ['minimumfilter_614',['minimumFilter',['../namespacenc_1_1filter.html#ad4b7a2f39d82320559353b151aec3585',1,'nc::filter']]], - ['minimumfilter_2ehpp_615',['minimumFilter.hpp',['../minimum_filter_8hpp.html',1,'']]], - ['minimumfilter1d_2ehpp_616',['minimumFilter1d.hpp',['../minimum_filter1d_8hpp.html',1,'']]], - ['minmax_5felement_617',['minmax_element',['../namespacenc_1_1stl__algorithms.html#a919ee9141ca95be989ad9b872a7ebd27',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#ae1007b77aafe5a99b4952d9a8d8307af',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], - ['minumumfilter1d_618',['minumumFilter1d',['../namespacenc_1_1filter.html#aca02565c2b898228312ef781bf4ed29c',1,'nc::filter']]], - ['minutes_619',['minutes',['../classnc_1_1coordinates_1_1_r_a.html#a7f4f4c06b26cad116e250a0dc7553b02',1,'nc::coordinates::RA::minutes()'],['../classnc_1_1coordinates_1_1_dec.html#aeaa851b538014aae5bf909117e8fcb42',1,'nc::coordinates::Dec::minutes()']]], - ['minutes_5fper_5fday_620',['MINUTES_PER_DAY',['../namespacenc_1_1constants.html#aa018ab3bca299694899f51683d5b3c0f',1,'nc::constants']]], - ['minutes_5fper_5fhour_621',['MINUTES_PER_HOUR',['../namespacenc_1_1constants.html#a84dfb71171d2a19b89afea89be57bc52',1,'nc::constants']]], - ['mirror_622',['MIRROR',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a72a92ae9c1d172cdda196686278fbfc6',1,'nc::filter']]], - ['mirror1d_623',['mirror1d',['../namespacenc_1_1filter_1_1boundary.html#aaeb7c9f1da6f817190da9daa622c9c8d',1,'nc::filter::boundary']]], - ['mirror1d_2ehpp_624',['mirror1d.hpp',['../mirror1d_8hpp.html',1,'']]], - ['mirror2d_625',['mirror2d',['../namespacenc_1_1filter_1_1boundary.html#a2aaf003bb59428d53d1849dd188e10b8',1,'nc::filter::boundary']]], - ['mirror2d_2ehpp_626',['mirror2d.hpp',['../mirror2d_8hpp.html',1,'']]], - ['mod_627',['mod',['../namespacenc.html#ad8b53ff84658514a7007efba44802c5c',1,'nc']]], - ['mod_2ehpp_628',['mod.hpp',['../mod_8hpp.html',1,'']]], - ['multi_5fdot_629',['multi_dot',['../namespacenc_1_1linalg.html#a86ab79e41b748e7ea0ee4f2e0bc462a6',1,'nc::linalg']]], - ['multi_5fdot_2ehpp_630',['multi_dot.hpp',['../multi__dot_8hpp.html',1,'']]], - ['multiply_631',['multiply',['../namespacenc.html#a6d7cd3b57c93a891a00d881832fdba77',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#aa6c517bf71575054de46518d7c0fce92',1,'nc::multiply(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a4965aed453e169ec8cbcd09a76b8afda',1,'nc::multiply(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#ad413820c1e92c7dcf83366f33399d6ef',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a78bbe031000f44fa4cdc0ad6b7825b7e',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#ace4de2d438459be581bd9fbc0c85c8d7',1,'nc::multiply(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a8bf62ccb0b68f25de562a08315dbb58e',1,'nc::multiply(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a786f53f7de209bb989c5965861d5dc27',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#afe5c0aa7fc5442e1453159e1fa78115a',1,'nc::multiply(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], - ['multiply_2ehpp_632',['multiply.hpp',['../multiply_8hpp.html',1,'']]] + ['makepositiveandvalidate_622',['makePositiveAndValidate',['../classnc_1_1_slice.html#a4d518d51dad679d9a9c6938b065e38f8',1,'nc::Slice']]], + ['matmul_623',['matmul',['../namespacenc.html#ab39e4a1bc6bcd0f28dbd5806d5f2d0b9',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a82209f3c03cb63a659d28e7c87f7ee23',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a9f795cdfcf86a07f1a7febcb9d024c73',1,'nc::matmul(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)']]], + ['matmul_2ehpp_624',['matmul.hpp',['../matmul_8hpp.html',1,'']]], + ['matrix_5fpower_625',['matrix_power',['../namespacenc_1_1linalg.html#ad27c1996e4e27a6f8ba5d2aed0743bba',1,'nc::linalg']]], + ['matrix_5fpower_2ehpp_626',['matrix_power.hpp',['../matrix__power_8hpp.html',1,'']]], + ['max_627',['max',['../namespacenc.html#a4d5872f22ac07aeba503857cb5948bc1',1,'nc::max()'],['../classnc_1_1_dtype_info.html#a2a3dc0ba2812411660219f61189d8aca',1,'nc::DtypeInfo::max()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#acdf46b23b24e1421c38e6297c56024d1',1,'nc::DtypeInfo< std::complex< dtype > >::max()'],['../classnc_1_1_nd_array.html#abbca6c205525a4b706729f9f36acc06d',1,'nc::NdArray::max()']]], + ['max_2ehpp_628',['max.hpp',['../max_8hpp.html',1,'']]], + ['max_5felement_629',['max_element',['../namespacenc_1_1stl__algorithms.html#a334cd50f7f10f689f82fa2ba7c5d88b2',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a282a4146afe33e4abb012e5c6b332948',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['maximum_630',['maximum',['../namespacenc.html#a417e75e173adaf0f6a9905a60a62e135',1,'nc']]], + ['maximum_2ehpp_631',['maximum.hpp',['../maximum_8hpp.html',1,'']]], + ['maximumfilter_632',['maximumFilter',['../namespacenc_1_1filter.html#a237010b21fd77fa3b72c1fda0360f6a9',1,'nc::filter']]], + ['maximumfilter_2ehpp_633',['maximumFilter.hpp',['../maximum_filter_8hpp.html',1,'']]], + ['maximumfilter1d_634',['maximumFilter1d',['../namespacenc_1_1filter.html#a6760bbaeefd6338527665fa2426cf418',1,'nc::filter']]], + ['maximumfilter1d_2ehpp_635',['maximumFilter1d.hpp',['../maximum_filter1d_8hpp.html',1,'']]], + ['maxnumiterations_5f_636',['maxNumIterations_',['../classnc_1_1roots_1_1_iteration.html#a9b1c4ea8cf91c5308020c105293b4a02',1,'nc::roots::Iteration']]], + ['mean_637',['mean',['../namespacenc.html#ac0b868e518c5b489ce25b8a84ebc618b',1,'nc::mean(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ae215351046b49fec834d006fd35a4078',1,'nc::mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], + ['mean_2ehpp_638',['mean.hpp',['../mean_8hpp.html',1,'']]], + ['median_639',['median',['../namespacenc.html#a737b54d3ec786235c90211a3ad4a5cfb',1,'nc::median()'],['../classnc_1_1_nd_array.html#a4d733d7a90d94c3f21e90ab79dc2cc14',1,'nc::NdArray::median()']]], + ['median_2ehpp_640',['median.hpp',['../median_8hpp.html',1,'']]], + ['medianfilter_641',['medianFilter',['../namespacenc_1_1filter.html#a6edb931e0ad73a60625c4854f11ab82a',1,'nc::filter']]], + ['medianfilter_2ehpp_642',['medianFilter.hpp',['../median_filter_8hpp.html',1,'']]], + ['medianfilter1d_643',['medianFilter1d',['../namespacenc_1_1filter.html#a39fc9c2648f0d223b63a5f1b7253bb40',1,'nc::filter']]], + ['medianfilter1d_2ehpp_644',['medianFilter1d.hpp',['../median_filter1d_8hpp.html',1,'']]], + ['meshgrid_645',['meshgrid',['../namespacenc.html#ae392e03f9e01b088a082c6055082df49',1,'nc::meshgrid(const NdArray< dtype > &inICoords, const NdArray< dtype > &inJCoords)'],['../namespacenc.html#a2338e094bb1195888e3f385d01627c4f',1,'nc::meshgrid(const Slice &inSlice1, const Slice &inSlice2)']]], + ['meshgrid_2ehpp_646',['meshgrid.hpp',['../meshgrid_8hpp.html',1,'']]], + ['milliseconds_5fper_5fday_647',['MILLISECONDS_PER_DAY',['../namespacenc_1_1constants.html#a2838aa56f95be8020a326aa6b9ba5c68',1,'nc::constants']]], + ['milliseconds_5fper_5fsecond_648',['MILLISECONDS_PER_SECOND',['../namespacenc_1_1constants.html#a4373df6d6df75334290f4240f174aeb0',1,'nc::constants']]], + ['min_649',['min',['../namespacenc.html#a8a61a49362258590b70289fd63fb2d8e',1,'nc::min()'],['../classnc_1_1_nd_array.html#a7f0c49ac50a79ba24ea8d351ee70fd55',1,'nc::NdArray::min()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a420b21e23e9673bea71980f55bf82d03',1,'nc::DtypeInfo< std::complex< dtype > >::min()'],['../classnc_1_1_dtype_info.html#ab566f68bc6b82c06b5a3df887f87ab74',1,'nc::DtypeInfo::min()']]], + ['min_2ehpp_650',['min.hpp',['../min_8hpp.html',1,'']]], + ['min_5felement_651',['min_element',['../namespacenc_1_1stl__algorithms.html#af6291d1011c61c416134bc28def6f3ac',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#acb252e962fc7cedee9f4257453480d2b',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['minimum_652',['minimum',['../namespacenc.html#a8499c0529d36d402e32b3990d31429e8',1,'nc']]], + ['minimum_2ehpp_653',['minimum.hpp',['../minimum_8hpp.html',1,'']]], + ['minimumfilter_654',['minimumFilter',['../namespacenc_1_1filter.html#ad4b7a2f39d82320559353b151aec3585',1,'nc::filter']]], + ['minimumfilter_2ehpp_655',['minimumFilter.hpp',['../minimum_filter_8hpp.html',1,'']]], + ['minimumfilter1d_2ehpp_656',['minimumFilter1d.hpp',['../minimum_filter1d_8hpp.html',1,'']]], + ['minmax_5felement_657',['minmax_element',['../namespacenc_1_1stl__algorithms.html#a919ee9141ca95be989ad9b872a7ebd27',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#ae1007b77aafe5a99b4952d9a8d8307af',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['minumumfilter1d_658',['minumumFilter1d',['../namespacenc_1_1filter.html#aca02565c2b898228312ef781bf4ed29c',1,'nc::filter']]], + ['minutes_659',['minutes',['../classnc_1_1coordinates_1_1_dec.html#aeaa851b538014aae5bf909117e8fcb42',1,'nc::coordinates::Dec::minutes()'],['../classnc_1_1coordinates_1_1_r_a.html#a7f4f4c06b26cad116e250a0dc7553b02',1,'nc::coordinates::RA::minutes()']]], + ['minutes_5fper_5fday_660',['MINUTES_PER_DAY',['../namespacenc_1_1constants.html#aa018ab3bca299694899f51683d5b3c0f',1,'nc::constants']]], + ['minutes_5fper_5fhour_661',['MINUTES_PER_HOUR',['../namespacenc_1_1constants.html#a84dfb71171d2a19b89afea89be57bc52',1,'nc::constants']]], + ['mirror_662',['MIRROR',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a72a92ae9c1d172cdda196686278fbfc6',1,'nc::filter']]], + ['mirror1d_663',['mirror1d',['../namespacenc_1_1filter_1_1boundary.html#aaeb7c9f1da6f817190da9daa622c9c8d',1,'nc::filter::boundary']]], + ['mirror1d_2ehpp_664',['mirror1d.hpp',['../mirror1d_8hpp.html',1,'']]], + ['mirror2d_665',['mirror2d',['../namespacenc_1_1filter_1_1boundary.html#a2aaf003bb59428d53d1849dd188e10b8',1,'nc::filter::boundary']]], + ['mirror2d_2ehpp_666',['mirror2d.hpp',['../mirror2d_8hpp.html',1,'']]], + ['mod_667',['mod',['../namespacenc.html#ad8b53ff84658514a7007efba44802c5c',1,'nc']]], + ['mod_2ehpp_668',['mod.hpp',['../mod_8hpp.html',1,'']]], + ['multi_5fdot_669',['multi_dot',['../namespacenc_1_1linalg.html#a86ab79e41b748e7ea0ee4f2e0bc462a6',1,'nc::linalg']]], + ['multi_5fdot_2ehpp_670',['multi_dot.hpp',['../multi__dot_8hpp.html',1,'']]], + ['multiply_671',['multiply',['../namespacenc.html#a6d7cd3b57c93a891a00d881832fdba77',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#aa6c517bf71575054de46518d7c0fce92',1,'nc::multiply(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a4965aed453e169ec8cbcd09a76b8afda',1,'nc::multiply(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#ad413820c1e92c7dcf83366f33399d6ef',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a78bbe031000f44fa4cdc0ad6b7825b7e',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#ace4de2d438459be581bd9fbc0c85c8d7',1,'nc::multiply(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a8bf62ccb0b68f25de562a08315dbb58e',1,'nc::multiply(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a786f53f7de209bb989c5965861d5dc27',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#afe5c0aa7fc5442e1453159e1fa78115a',1,'nc::multiply(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], + ['multiply_2ehpp_672',['multiply.hpp',['../multiply_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/all_d.html b/docs/doxygen/html/search/all_d.html index 3fb5ce30d..af7f2f0f5 100644 --- a/docs/doxygen/html/search/all_d.html +++ b/docs/doxygen/html/search/all_d.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_d.js b/docs/doxygen/html/search/all_d.js index a211ea207..e9c9264c5 100644 --- a/docs/doxygen/html/search/all_d.js +++ b/docs/doxygen/html/search/all_d.js @@ -1,107 +1,114 @@ var searchData= [ - ['boundary_633',['boundary',['../namespacenc_1_1filter_1_1boundary.html',1,'nc::filter']]], - ['constants_634',['constants',['../namespacenc_1_1constants.html',1,'nc']]], - ['coordinates_635',['coordinates',['../namespacenc_1_1coordinates.html',1,'nc']]], - ['endian_636',['endian',['../namespacenc_1_1endian.html',1,'nc']]], - ['error_637',['error',['../namespacenc_1_1error.html',1,'nc']]], - ['filesystem_638',['filesystem',['../namespacenc_1_1filesystem.html',1,'nc']]], - ['filter_639',['filter',['../namespacenc_1_1filter.html',1,'nc']]], - ['imageprocessing_640',['imageProcessing',['../namespacenc_1_1image_processing.html',1,'nc']]], - ['integrate_641',['integrate',['../namespacenc_1_1integrate.html',1,'nc']]], - ['linalg_642',['linalg',['../namespacenc_1_1linalg.html',1,'nc']]], - ['name_643',['name',['../classnc_1_1filesystem_1_1_file.html#a29fd40eb720c1caad3dcef59e2f215a4',1,'nc::filesystem::File']]], - ['nan_644',['nan',['../namespacenc_1_1constants.html#af94758715a9a5157d7ca95ab89d390ac',1,'nc::constants']]], - ['nan_5fto_5fnum_645',['nan_to_num',['../namespacenc.html#ab5b2173fccfe4b4a8c91edb704c51b12',1,'nc']]], - ['nan_5fto_5fnum_2ehpp_646',['nan_to_num.hpp',['../nan__to__num_8hpp.html',1,'']]], - ['nanargmax_647',['nanargmax',['../namespacenc.html#a5f3d3d15fae35dc9538f6daa792f3e1b',1,'nc']]], - ['nanargmax_2ehpp_648',['nanargmax.hpp',['../nanargmax_8hpp.html',1,'']]], - ['nanargmin_649',['nanargmin',['../namespacenc.html#a0c69df200cbe88324129ae3c6fc05330',1,'nc']]], - ['nanargmin_2ehpp_650',['nanargmin.hpp',['../nanargmin_8hpp.html',1,'']]], - ['nancumprod_651',['nancumprod',['../namespacenc.html#ad22449b2b6c92860eed3670d68ea4ba4',1,'nc']]], - ['nancumprod_2ehpp_652',['nancumprod.hpp',['../nancumprod_8hpp.html',1,'']]], - ['nancumsum_653',['nancumsum',['../namespacenc.html#a626089b225be4978da275ef9a7ecf451',1,'nc']]], - ['nancumsum_2ehpp_654',['nancumsum.hpp',['../nancumsum_8hpp.html',1,'']]], - ['nanmax_655',['nanmax',['../namespacenc.html#a00ab1c4ed4358cba5e87a3d107720474',1,'nc']]], - ['nanmax_2ehpp_656',['nanmax.hpp',['../nanmax_8hpp.html',1,'']]], - ['nanmean_657',['nanmean',['../namespacenc.html#acac66186b7fff8d8cdc1dd3f37b98297',1,'nc']]], - ['nanmean_2ehpp_658',['nanmean.hpp',['../nanmean_8hpp.html',1,'']]], - ['nanmedian_659',['nanmedian',['../namespacenc.html#a60fd6cc6607d10bf8fe4913a5daa7f3a',1,'nc']]], - ['nanmedian_2ehpp_660',['nanmedian.hpp',['../nanmedian_8hpp.html',1,'']]], - ['nanmin_661',['nanmin',['../namespacenc.html#a2f4b9832c72a282a23da1dad186d36d8',1,'nc']]], - ['nanmin_2ehpp_662',['nanmin.hpp',['../nanmin_8hpp.html',1,'']]], - ['nanpercentile_663',['nanpercentile',['../namespacenc.html#ade1f6fe4e6860b046b50e05252a61c0a',1,'nc']]], - ['nanpercentile_2ehpp_664',['nanpercentile.hpp',['../nanpercentile_8hpp.html',1,'']]], - ['nanprod_665',['nanprod',['../namespacenc.html#a8121a0aa2907751c6fd7db34dfc28719',1,'nc']]], - ['nanprod_2ehpp_666',['nanprod.hpp',['../nanprod_8hpp.html',1,'']]], - ['nans_667',['nans',['../classnc_1_1_nd_array.html#aa7592409ea9bc24e4324725e5ff74ee9',1,'nc::NdArray::nans()'],['../namespacenc.html#a1c3fe37572a53d83154138b2de5d5e8b',1,'nc::nans(uint32 inSquareSize)'],['../namespacenc.html#aea74254d1b55e5b9adf1e6610b0da9d6',1,'nc::nans(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a6bec1d7117a467081676bfd8d31fcd87',1,'nc::nans(const Shape &inShape)']]], - ['nans_2ehpp_668',['nans.hpp',['../nans_8hpp.html',1,'']]], - ['nans_5flike_669',['nans_like',['../namespacenc.html#aae8b7e12e53ff6e21d555c1eabadf615',1,'nc']]], - ['nans_5flike_2ehpp_670',['nans_like.hpp',['../nans__like_8hpp.html',1,'']]], - ['nanstdev_671',['nanstdev',['../namespacenc.html#a3ae8768b4362f564849bc2ba0115450a',1,'nc']]], - ['nanstdev_2ehpp_672',['nanstdev.hpp',['../nanstdev_8hpp.html',1,'']]], - ['nansum_673',['nansum',['../namespacenc.html#a69b05488ef7b28eefa3bc733836a4e48',1,'nc']]], - ['nansum_2ehpp_674',['nansum.hpp',['../nansum_8hpp.html',1,'']]], - ['nanvar_675',['nanvar',['../namespacenc.html#a333035c5f246c01da1de4ae7015f5715',1,'nc']]], - ['nanvar_2ehpp_676',['nanvar.hpp',['../nanvar_8hpp.html',1,'']]], - ['native_677',['NATIVE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152af78504d96ba7177dc0c6784905ac8743',1,'nc']]], - ['nbytes_678',['nbytes',['../namespacenc.html#a66464387c8d92793b5355e2afd107cbc',1,'nc::nbytes()'],['../classnc_1_1_nd_array.html#a775e07af6829b5336969c703c4eddba7',1,'nc::NdArray::nbytes()']]], - ['nbytes_2ehpp_679',['nbytes.hpp',['../nbytes_8hpp.html',1,'']]], - ['nc_680',['nc',['../namespacenc.html',1,'']]], - ['ndarray_681',['NdArray',['../classnc_1_1_nd_array.html',1,'nc::NdArray< dtype, Allocator >'],['../classnc_1_1_nd_array.html#a8509cda74ae6f29995dd8a9f27d30d11',1,'nc::NdArray::NdArray(size_type inNumRows, size_type inNumCols)'],['../classnc_1_1_nd_array.html#a7b0f43ea1853dcc471949c0e7eb977f5',1,'nc::NdArray::NdArray(const std::list< dtype > &inList)'],['../classnc_1_1_nd_array.html#a567a45c944672939e89fa507236d1158',1,'nc::NdArray::NdArray(const std::deque< std::deque< dtype >> &in2dDeque)'],['../classnc_1_1_nd_array.html#ad94cfcf69d664d94e81fc98a0a61d193',1,'nc::NdArray::NdArray(const std::deque< dtype > &inDeque)'],['../classnc_1_1_nd_array.html#a00cddf06371547d613388cefeece2cc0',1,'nc::NdArray::NdArray(std::vector< std::array< dtype, Dim1Size >> &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a9d7045ecdff86bac3306a8bfd9a787eb',1,'nc::NdArray::NdArray(const std::vector< std::vector< dtype >> &in2dVector)'],['../classnc_1_1_nd_array.html#a1847487093139deb6a541cfaa43c3d90',1,'nc::NdArray::NdArray(std::vector< dtype > &inVector, bool copy=true)'],['../classnc_1_1_nd_array.html#ad9ccdeb2572f239a33ca5fbb473b513a',1,'nc::NdArray::NdArray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#ad724d08ab913c125a38bc528e68cad8e',1,'nc::NdArray::NdArray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a1877502ba79a59c3a9b144e6111def1a',1,'nc::NdArray::NdArray(const std::initializer_list< std::initializer_list< dtype > > &inList)'],['../classnc_1_1_nd_array.html#a9b5658aaaff185187c964a6bf3f4f5a3',1,'nc::NdArray::NdArray(const std::initializer_list< dtype > &inList)'],['../classnc_1_1_nd_array.html#af8cd2e1b7214c4b8b8b784e1b5265c11',1,'nc::NdArray::NdArray(const Shape &inShape)'],['../classnc_1_1_nd_array.html#ae04a364f503fe72c06d2f7cd78e712d6',1,'nc::NdArray::NdArray(const NdArray< dtype > &inOtherArray)'],['../classnc_1_1_nd_array.html#a91801907e76fd8ecc9ce7ff3b85ea9bd',1,'nc::NdArray::NdArray(size_type inSquareSize)'],['../classnc_1_1_nd_array.html#a7b46bea4f56ab2327fc291dac4e75788',1,'nc::NdArray::NdArray()=default'],['../classnc_1_1_nd_array.html#aa6bf0b18b1ebb54b2a1fd4e4b33253dd',1,'nc::NdArray::NdArray(NdArray< dtype > &&inOtherArray) noexcept'],['../classnc_1_1_nd_array.html#a46c4fbd999ab1d612586191a15ada4b7',1,'nc::NdArray::NdArray(Iterator inFirst, Iterator inLast)'],['../classnc_1_1_nd_array.html#ad8160a6009ce9c0c8bbb384261ce18bb',1,'nc::NdArray::NdArray(const_pointer inPtr, size_type size)'],['../classnc_1_1_nd_array.html#a7473135d0434a04abec09a884b5683cc',1,'nc::NdArray::NdArray(const_pointer inPtr, UIntType1 numRows, UIntType2 numCols)'],['../classnc_1_1_nd_array.html#aee44fee3e2c882d490898c082db39449',1,'nc::NdArray::NdArray(pointer inPtr, size_type size, Bool takeOwnership) noexcept'],['../classnc_1_1_nd_array.html#a7fcb1cf40a8402e8ba6353e58eed8dbd',1,'nc::NdArray::NdArray(pointer inPtr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept']]], - ['ndarray_2ehpp_682',['NdArray.hpp',['../_nd_array_8hpp.html',1,'']]], - ['ndarraycolumniterator_683',['NdArrayColumnIterator',['../classnc_1_1_nd_array_column_iterator.html',1,'nc']]], - ['ndarrayconstcolumniterator_684',['NdArrayConstColumnIterator',['../classnc_1_1_nd_array_const_column_iterator.html',1,'nc::NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType >'],['../classnc_1_1_nd_array_const_column_iterator.html#a3c779a77e6a0920d8fc799931feb3c3d',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator()=default'],['../classnc_1_1_nd_array_const_column_iterator.html#aff03e1020fa6e935fb0fe2a926a4f378',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator(pointer ptr, SizeType numRows, SizeType numCols) noexcept']]], - ['ndarrayconstiterator_685',['NdArrayConstIterator',['../classnc_1_1_nd_array_const_iterator.html',1,'nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >'],['../classnc_1_1_nd_array_const_iterator.html#a518e77992a6b8710c2d43734a84f2006',1,'nc::NdArrayConstIterator::NdArrayConstIterator()=default'],['../classnc_1_1_nd_array_const_iterator.html#a8f0504fbf9ea4d0f89cda5b7e120b6f0',1,'nc::NdArrayConstIterator::NdArrayConstIterator(pointer ptr)']]], - ['ndarraycore_2ehpp_686',['NdArrayCore.hpp',['../_nd_array_core_8hpp.html',1,'']]], - ['ndarrayiterator_687',['NdArrayIterator',['../classnc_1_1_nd_array_iterator.html',1,'nc']]], - ['ndarrayiterators_2ehpp_688',['NdArrayIterators.hpp',['../_nd_array_iterators_8hpp.html',1,'']]], - ['ndarrayoperators_2ehpp_689',['NdArrayOperators.hpp',['../_nd_array_operators_8hpp.html',1,'']]], - ['nearest_690',['NEAREST',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6aad135772d7cf93dd0ccf9d2474b34e6a',1,'nc::filter']]], - ['nearest1d_691',['nearest1d',['../namespacenc_1_1filter_1_1boundary.html#ac5f60c43aa94490993eee9fcc1e105b1',1,'nc::filter::boundary']]], - ['nearest1d_2ehpp_692',['nearest1d.hpp',['../nearest1d_8hpp.html',1,'']]], - ['nearest2d_693',['nearest2d',['../namespacenc_1_1filter_1_1boundary.html#a7f70d66ead018652239bb3334a040850',1,'nc::filter::boundary']]], - ['nearest2d_2ehpp_694',['nearest2d.hpp',['../nearest2d_8hpp.html',1,'']]], - ['negative_695',['NEGATIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94a50546bf973283065b6ccf09faf7a580a',1,'nc::coordinates']]], - ['negative_696',['negative',['../namespacenc.html#a678a4671c949113db1578078d409bb91',1,'nc']]], - ['negative_2ehpp_697',['negative.hpp',['../negative_8hpp.html',1,'']]], - ['negativebinomial_698',['negativeBinomial',['../namespacenc_1_1random.html#a1a15a08fe9134f5dcf5e7b32eb1de5e2',1,'nc::random::negativeBinomial(dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#ac6181e54b9cae303574f9c5fad33cfc2',1,'nc::random::negativeBinomial(const Shape &inShape, dtype inN, double inP=0.5)']]], - ['negativebinomial_2ehpp_699',['negativeBinomial.hpp',['../negative_binomial_8hpp.html',1,'']]], - ['newbyteorder_700',['newbyteorder',['../classnc_1_1_nd_array.html#ae5fe2e501921c3361c0edc66030b772d',1,'nc::NdArray::newbyteorder()'],['../namespacenc.html#a4d2ae51817f2acee83e2df0e04a8bac5',1,'nc::newbyteorder(dtype inValue, Endian inEndianess)'],['../namespacenc.html#adfc5c49151c50d90fce45c676b0fcaa4',1,'nc::newbyteorder(const NdArray< dtype > &inArray, Endian inEndianess)']]], - ['newbyteorder_2ehpp_701',['newbyteorder.hpp',['../newbyteorder_8hpp.html',1,'']]], - ['newton_702',['Newton',['../classnc_1_1roots_1_1_newton.html',1,'nc::roots::Newton'],['../classnc_1_1roots_1_1_newton.html#aecc72e3899f42b277536689439ea24bc',1,'nc::roots::Newton::Newton(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept'],['../classnc_1_1roots_1_1_newton.html#ab5b82361c4ce325e6165e023c0255d3e',1,'nc::roots::Newton::Newton(const double epsilon, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept']]], - ['newton_2ehpp_703',['Newton.hpp',['../_newton_8hpp.html',1,'']]], - ['nlerp_704',['nlerp',['../classnc_1_1rotations_1_1_quaternion.html#a314478702a3da52f2be3f422057d8732',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#ab055510c1338490b957de867cecaf790',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat2, double inPercent) const']]], - ['noncentralchisquared_705',['nonCentralChiSquared',['../namespacenc_1_1random.html#af01395c7355ee4c0f36441c40039e82d',1,'nc::random::nonCentralChiSquared(const Shape &inShape, dtype inK=1, dtype inLambda=1)'],['../namespacenc_1_1random.html#abf3cab0396026700ebf2d2ffa5e13fa6',1,'nc::random::nonCentralChiSquared(dtype inK=1, dtype inLambda=1)']]], - ['noncentralchisquared_2ehpp_706',['nonCentralChiSquared.hpp',['../non_central_chi_squared_8hpp.html',1,'']]], - ['none_707',['NONE',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84ab50339a10e1de285ac99d4c3990b8693',1,'nc']]], - ['none_708',['none',['../classnc_1_1_nd_array.html#a379f8cd88dc84a38d668cb7bf97078ee',1,'nc::NdArray::none()'],['../namespacenc.html#ada2840f1202c44082ee75b5f5705399d',1,'nc::none()']]], - ['none_2ehpp_709',['none.hpp',['../none_8hpp.html',1,'']]], - ['none_5fof_710',['none_of',['../namespacenc_1_1stl__algorithms.html#a2804ccb14980f96c7680838adc3b2762',1,'nc::stl_algorithms']]], - ['nonzero_711',['nonzero',['../namespacenc.html#a46ce9bcc6ba641e0550934b981175683',1,'nc::nonzero()'],['../classnc_1_1_nd_array.html#a6cc8c7b53a707468d6da112849970904',1,'nc::NdArray::nonzero()']]], - ['nonzero_2ehpp_712',['nonzero.hpp',['../nonzero_8hpp.html',1,'']]], - ['norm_713',['norm',['../namespacenc.html#a13467936d679d6d078d585504bc42642',1,'nc::norm(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#aa57b910a1d9a448a15e76bd72563ac5d',1,'nc::norm(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../classnc_1_1_vec3.html#a6c177e1f5c00584279a0527d3053dee8',1,'nc::Vec3::norm()'],['../classnc_1_1_vec2.html#ab6922f6c089b20e9d019301fddc6dc0a',1,'nc::Vec2::norm()']]], - ['norm_2ehpp_714',['norm.hpp',['../norm_8hpp.html',1,'']]], - ['normal_715',['normal',['../namespacenc_1_1random.html#ab655c4af3dac07aeff39efd50c120f4d',1,'nc::random::normal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a0d52ff6ccaa63bc36348ba39e5936056',1,'nc::random::normal(dtype inMean=0, dtype inSigma=1)']]], - ['normal_2ehpp_716',['normal.hpp',['../normal_8hpp.html',1,'']]], - ['normalize_717',['normalize',['../classnc_1_1_vec3.html#a6356b462b11a156b923a7c79b9747c25',1,'nc::Vec3::normalize()'],['../classnc_1_1_vec2.html#a8d8a3ec28ef8336ab02dcd964a3e836c',1,'nc::Vec2::normalize()']]], - ['not_5fequal_718',['not_equal',['../namespacenc.html#ac6c0da616068bc667891c0a460431de3',1,'nc']]], - ['not_5fequal_2ehpp_719',['not_equal.hpp',['../not__equal_8hpp.html',1,'']]], - ['nth_5felement_720',['nth_element',['../namespacenc_1_1stl__algorithms.html#a9928869b550b082898709c5671936079',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#af5ef45ab7814938799020ad24358b734',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last) noexcept']]], - ['num2str_721',['num2str',['../namespacenc_1_1utils.html#a16a6ad93c420ed7a003d9921bee1a7c6',1,'nc::utils']]], - ['num2str_2ehpp_722',['num2str.hpp',['../num2str_8hpp.html',1,'']]], - ['numcols_723',['numCols',['../classnc_1_1_nd_array.html#a0049b5d6d1d99463edc773f01eb7c091',1,'nc::NdArray']]], - ['numcpp_724',['NumCpp',['../index.html',1,'']]], - ['numcpp_2ehpp_725',['NumCpp.hpp',['../_num_cpp_8hpp.html',1,'']]], - ['numelements_726',['numElements',['../classnc_1_1_slice.html#aab35be40c38521a4bd9b3c99b3d33731',1,'nc::Slice']]], - ['numiterations_727',['numIterations',['../classnc_1_1roots_1_1_iteration.html#ab3192d0f9de4b8b27b23013c65489e5a',1,'nc::roots::Iteration']]], - ['numiterations_5f_728',['numIterations_',['../classnc_1_1roots_1_1_iteration.html#a84d7f2f7412d1f54861edeacc7bc0c20',1,'nc::roots::Iteration']]], - ['numrows_729',['numRows',['../classnc_1_1_nd_array.html#a2dbdc72c98c216a133f7e1a8d3c067f7',1,'nc::NdArray']]], - ['polynomial_730',['polynomial',['../namespacenc_1_1polynomial.html',1,'nc']]], - ['random_731',['random',['../namespacenc_1_1random.html',1,'nc']]], - ['roots_732',['roots',['../namespacenc_1_1roots.html',1,'nc']]], - ['rotations_733',['rotations',['../namespacenc_1_1rotations.html',1,'nc']]], - ['special_734',['special',['../namespacenc_1_1special.html',1,'nc']]], - ['stl_5falgorithms_735',['stl_algorithms',['../namespacenc_1_1stl__algorithms.html',1,'nc']]], - ['utils_736',['utils',['../namespacenc_1_1utils.html',1,'nc']]] + ['boundary_673',['boundary',['../namespacenc_1_1filter_1_1boundary.html',1,'nc::filter']]], + ['constants_674',['constants',['../namespacenc_1_1constants.html',1,'nc']]], + ['coordinates_675',['coordinates',['../namespacenc_1_1coordinates.html',1,'nc']]], + ['detail_676',['detail',['../namespacenc_1_1edac_1_1detail.html',1,'nc::edac']]], + ['edac_677',['edac',['../namespacenc_1_1edac.html',1,'nc']]], + ['endian_678',['endian',['../namespacenc_1_1endian.html',1,'nc']]], + ['error_679',['error',['../namespacenc_1_1error.html',1,'nc']]], + ['filesystem_680',['filesystem',['../namespacenc_1_1filesystem.html',1,'nc']]], + ['filter_681',['filter',['../namespacenc_1_1filter.html',1,'nc']]], + ['imageprocessing_682',['imageProcessing',['../namespacenc_1_1image_processing.html',1,'nc']]], + ['integrate_683',['integrate',['../namespacenc_1_1integrate.html',1,'nc']]], + ['linalg_684',['linalg',['../namespacenc_1_1linalg.html',1,'nc']]], + ['name_685',['name',['../classnc_1_1filesystem_1_1_file.html#a29fd40eb720c1caad3dcef59e2f215a4',1,'nc::filesystem::File']]], + ['nan_686',['nan',['../namespacenc_1_1constants.html#af94758715a9a5157d7ca95ab89d390ac',1,'nc::constants']]], + ['nan_5fto_5fnum_687',['nan_to_num',['../namespacenc.html#ab5b2173fccfe4b4a8c91edb704c51b12',1,'nc']]], + ['nan_5fto_5fnum_2ehpp_688',['nan_to_num.hpp',['../nan__to__num_8hpp.html',1,'']]], + ['nanargmax_689',['nanargmax',['../namespacenc.html#a5f3d3d15fae35dc9538f6daa792f3e1b',1,'nc']]], + ['nanargmax_2ehpp_690',['nanargmax.hpp',['../nanargmax_8hpp.html',1,'']]], + ['nanargmin_691',['nanargmin',['../namespacenc.html#a0c69df200cbe88324129ae3c6fc05330',1,'nc']]], + ['nanargmin_2ehpp_692',['nanargmin.hpp',['../nanargmin_8hpp.html',1,'']]], + ['nancumprod_693',['nancumprod',['../namespacenc.html#ad22449b2b6c92860eed3670d68ea4ba4',1,'nc']]], + ['nancumprod_2ehpp_694',['nancumprod.hpp',['../nancumprod_8hpp.html',1,'']]], + ['nancumsum_695',['nancumsum',['../namespacenc.html#a626089b225be4978da275ef9a7ecf451',1,'nc']]], + ['nancumsum_2ehpp_696',['nancumsum.hpp',['../nancumsum_8hpp.html',1,'']]], + ['nanmax_697',['nanmax',['../namespacenc.html#a00ab1c4ed4358cba5e87a3d107720474',1,'nc']]], + ['nanmax_2ehpp_698',['nanmax.hpp',['../nanmax_8hpp.html',1,'']]], + ['nanmean_699',['nanmean',['../namespacenc.html#acac66186b7fff8d8cdc1dd3f37b98297',1,'nc']]], + ['nanmean_2ehpp_700',['nanmean.hpp',['../nanmean_8hpp.html',1,'']]], + ['nanmedian_701',['nanmedian',['../namespacenc.html#a60fd6cc6607d10bf8fe4913a5daa7f3a',1,'nc']]], + ['nanmedian_2ehpp_702',['nanmedian.hpp',['../nanmedian_8hpp.html',1,'']]], + ['nanmin_703',['nanmin',['../namespacenc.html#a2f4b9832c72a282a23da1dad186d36d8',1,'nc']]], + ['nanmin_2ehpp_704',['nanmin.hpp',['../nanmin_8hpp.html',1,'']]], + ['nanpercentile_705',['nanpercentile',['../namespacenc.html#ade1f6fe4e6860b046b50e05252a61c0a',1,'nc']]], + ['nanpercentile_2ehpp_706',['nanpercentile.hpp',['../nanpercentile_8hpp.html',1,'']]], + ['nanprod_707',['nanprod',['../namespacenc.html#a8121a0aa2907751c6fd7db34dfc28719',1,'nc']]], + ['nanprod_2ehpp_708',['nanprod.hpp',['../nanprod_8hpp.html',1,'']]], + ['nans_709',['nans',['../namespacenc.html#a6bec1d7117a467081676bfd8d31fcd87',1,'nc::nans(const Shape &inShape)'],['../namespacenc.html#aea74254d1b55e5b9adf1e6610b0da9d6',1,'nc::nans(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a1c3fe37572a53d83154138b2de5d5e8b',1,'nc::nans(uint32 inSquareSize)'],['../classnc_1_1_nd_array.html#aa7592409ea9bc24e4324725e5ff74ee9',1,'nc::NdArray::nans()']]], + ['nans_2ehpp_710',['nans.hpp',['../nans_8hpp.html',1,'']]], + ['nans_5flike_711',['nans_like',['../namespacenc.html#aae8b7e12e53ff6e21d555c1eabadf615',1,'nc']]], + ['nans_5flike_2ehpp_712',['nans_like.hpp',['../nans__like_8hpp.html',1,'']]], + ['nanstdev_713',['nanstdev',['../namespacenc.html#a3ae8768b4362f564849bc2ba0115450a',1,'nc']]], + ['nanstdev_2ehpp_714',['nanstdev.hpp',['../nanstdev_8hpp.html',1,'']]], + ['nansum_715',['nansum',['../namespacenc.html#a69b05488ef7b28eefa3bc733836a4e48',1,'nc']]], + ['nansum_2ehpp_716',['nansum.hpp',['../nansum_8hpp.html',1,'']]], + ['nanvar_717',['nanvar',['../namespacenc.html#a333035c5f246c01da1de4ae7015f5715',1,'nc']]], + ['nanvar_2ehpp_718',['nanvar.hpp',['../nanvar_8hpp.html',1,'']]], + ['native_719',['NATIVE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152af78504d96ba7177dc0c6784905ac8743',1,'nc']]], + ['nbytes_720',['nbytes',['../classnc_1_1_nd_array.html#a775e07af6829b5336969c703c4eddba7',1,'nc::NdArray::nbytes()'],['../namespacenc.html#a66464387c8d92793b5355e2afd107cbc',1,'nc::nbytes()']]], + ['nbytes_2ehpp_721',['nbytes.hpp',['../nbytes_8hpp.html',1,'']]], + ['nc_722',['nc',['../namespacenc.html',1,'']]], + ['ndarray_723',['NdArray',['../classnc_1_1_nd_array.html',1,'nc::NdArray< dtype, Allocator >'],['../classnc_1_1_nd_array.html#a7473135d0434a04abec09a884b5683cc',1,'nc::NdArray::NdArray(const_pointer inPtr, UIntType1 numRows, UIntType2 numCols)'],['../classnc_1_1_nd_array.html#ad94cfcf69d664d94e81fc98a0a61d193',1,'nc::NdArray::NdArray(const std::deque< dtype > &inDeque)'],['../classnc_1_1_nd_array.html#ad8160a6009ce9c0c8bbb384261ce18bb',1,'nc::NdArray::NdArray(const_pointer inPtr, size_type size)'],['../classnc_1_1_nd_array.html#a46c4fbd999ab1d612586191a15ada4b7',1,'nc::NdArray::NdArray(Iterator inFirst, Iterator inLast)'],['../classnc_1_1_nd_array.html#a567a45c944672939e89fa507236d1158',1,'nc::NdArray::NdArray(const std::deque< std::deque< dtype >> &in2dDeque)'],['../classnc_1_1_nd_array.html#a7b46bea4f56ab2327fc291dac4e75788',1,'nc::NdArray::NdArray()=default'],['../classnc_1_1_nd_array.html#a91801907e76fd8ecc9ce7ff3b85ea9bd',1,'nc::NdArray::NdArray(size_type inSquareSize)'],['../classnc_1_1_nd_array.html#a8509cda74ae6f29995dd8a9f27d30d11',1,'nc::NdArray::NdArray(size_type inNumRows, size_type inNumCols)'],['../classnc_1_1_nd_array.html#af8cd2e1b7214c4b8b8b784e1b5265c11',1,'nc::NdArray::NdArray(const Shape &inShape)'],['../classnc_1_1_nd_array.html#a66ae5664d66e900a48ca1d9a607f655e',1,'nc::NdArray::NdArray(std::initializer_list< dtype > inList)'],['../classnc_1_1_nd_array.html#a1877502ba79a59c3a9b144e6111def1a',1,'nc::NdArray::NdArray(const std::initializer_list< std::initializer_list< dtype > > &inList)'],['../classnc_1_1_nd_array.html#ad724d08ab913c125a38bc528e68cad8e',1,'nc::NdArray::NdArray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../classnc_1_1_nd_array.html#ad9ccdeb2572f239a33ca5fbb473b513a',1,'nc::NdArray::NdArray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a1847487093139deb6a541cfaa43c3d90',1,'nc::NdArray::NdArray(std::vector< dtype > &inVector, bool copy=true)'],['../classnc_1_1_nd_array.html#a00cddf06371547d613388cefeece2cc0',1,'nc::NdArray::NdArray(std::vector< std::array< dtype, Dim1Size >> &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a9d7045ecdff86bac3306a8bfd9a787eb',1,'nc::NdArray::NdArray(const std::vector< std::vector< dtype >> &in2dVector)'],['../classnc_1_1_nd_array.html#a7b0f43ea1853dcc471949c0e7eb977f5',1,'nc::NdArray::NdArray(const std::list< dtype > &inList)'],['../classnc_1_1_nd_array.html#aa6bf0b18b1ebb54b2a1fd4e4b33253dd',1,'nc::NdArray::NdArray(NdArray< dtype > &&inOtherArray) noexcept'],['../classnc_1_1_nd_array.html#ae04a364f503fe72c06d2f7cd78e712d6',1,'nc::NdArray::NdArray(const NdArray< dtype > &inOtherArray)'],['../classnc_1_1_nd_array.html#a7fcb1cf40a8402e8ba6353e58eed8dbd',1,'nc::NdArray::NdArray(pointer inPtr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept'],['../classnc_1_1_nd_array.html#aee44fee3e2c882d490898c082db39449',1,'nc::NdArray::NdArray(pointer inPtr, size_type size, Bool takeOwnership) noexcept']]], + ['ndarray_2ehpp_724',['NdArray.hpp',['../_nd_array_8hpp.html',1,'']]], + ['ndarray_3c_20bool_20_3e_725',['NdArray< bool >',['../classnc_1_1_nd_array.html',1,'nc']]], + ['ndarray_3c_20double_20_3e_726',['NdArray< double >',['../classnc_1_1_nd_array.html',1,'nc']]], + ['ndarraycolumniterator_727',['NdArrayColumnIterator',['../classnc_1_1_nd_array_column_iterator.html',1,'nc']]], + ['ndarrayconstcolumniterator_728',['NdArrayConstColumnIterator',['../classnc_1_1_nd_array_const_column_iterator.html',1,'nc::NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType >'],['../classnc_1_1_nd_array_const_column_iterator.html#aff03e1020fa6e935fb0fe2a926a4f378',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator(pointer ptr, SizeType numRows, SizeType numCols) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a3c779a77e6a0920d8fc799931feb3c3d',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator()=default']]], + ['ndarrayconstiterator_729',['NdArrayConstIterator',['../classnc_1_1_nd_array_const_iterator.html',1,'nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >'],['../classnc_1_1_nd_array_const_iterator.html#a518e77992a6b8710c2d43734a84f2006',1,'nc::NdArrayConstIterator::NdArrayConstIterator()=default'],['../classnc_1_1_nd_array_const_iterator.html#a8f0504fbf9ea4d0f89cda5b7e120b6f0',1,'nc::NdArrayConstIterator::NdArrayConstIterator(pointer ptr)']]], + ['ndarraycore_2ehpp_730',['NdArrayCore.hpp',['../_nd_array_core_8hpp.html',1,'']]], + ['ndarrayiterator_731',['NdArrayIterator',['../classnc_1_1_nd_array_iterator.html',1,'nc']]], + ['ndarrayiterators_2ehpp_732',['NdArrayIterators.hpp',['../_nd_array_iterators_8hpp.html',1,'']]], + ['ndarrayoperators_2ehpp_733',['NdArrayOperators.hpp',['../_nd_array_operators_8hpp.html',1,'']]], + ['nearest_734',['NEAREST',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6aad135772d7cf93dd0ccf9d2474b34e6a',1,'nc::filter']]], + ['nearest1d_735',['nearest1d',['../namespacenc_1_1filter_1_1boundary.html#ac5f60c43aa94490993eee9fcc1e105b1',1,'nc::filter::boundary']]], + ['nearest1d_2ehpp_736',['nearest1d.hpp',['../nearest1d_8hpp.html',1,'']]], + ['nearest2d_737',['nearest2d',['../namespacenc_1_1filter_1_1boundary.html#a7f70d66ead018652239bb3334a040850',1,'nc::filter::boundary']]], + ['nearest2d_2ehpp_738',['nearest2d.hpp',['../nearest2d_8hpp.html',1,'']]], + ['negative_739',['negative',['../namespacenc.html#a678a4671c949113db1578078d409bb91',1,'nc']]], + ['negative_740',['NEGATIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94a50546bf973283065b6ccf09faf7a580a',1,'nc::coordinates']]], + ['negative_2ehpp_741',['negative.hpp',['../negative_8hpp.html',1,'']]], + ['negativebinomial_742',['negativeBinomial',['../namespacenc_1_1random.html#a1a15a08fe9134f5dcf5e7b32eb1de5e2',1,'nc::random::negativeBinomial(dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#ac6181e54b9cae303574f9c5fad33cfc2',1,'nc::random::negativeBinomial(const Shape &inShape, dtype inN, double inP=0.5)']]], + ['negativebinomial_2ehpp_743',['negativeBinomial.hpp',['../negative_binomial_8hpp.html',1,'']]], + ['newbyteorder_744',['newbyteorder',['../classnc_1_1_nd_array.html#ae5fe2e501921c3361c0edc66030b772d',1,'nc::NdArray::newbyteorder()'],['../namespacenc.html#a4d2ae51817f2acee83e2df0e04a8bac5',1,'nc::newbyteorder(dtype inValue, Endian inEndianess)'],['../namespacenc.html#adfc5c49151c50d90fce45c676b0fcaa4',1,'nc::newbyteorder(const NdArray< dtype > &inArray, Endian inEndianess)']]], + ['newbyteorder_2ehpp_745',['newbyteorder.hpp',['../newbyteorder_8hpp.html',1,'']]], + ['newton_746',['Newton',['../classnc_1_1roots_1_1_newton.html',1,'nc::roots::Newton'],['../classnc_1_1roots_1_1_newton.html#ab5b82361c4ce325e6165e023c0255d3e',1,'nc::roots::Newton::Newton(const double epsilon, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept'],['../classnc_1_1roots_1_1_newton.html#aecc72e3899f42b277536689439ea24bc',1,'nc::roots::Newton::Newton(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept']]], + ['newton_2ehpp_747',['Newton.hpp',['../_newton_8hpp.html',1,'']]], + ['nextpoweroftwo_748',['nextPowerOfTwo',['../namespacenc_1_1edac_1_1detail.html#a279241a794bffbea6920299cf8e5c4a1',1,'nc::edac::detail']]], + ['nlerp_749',['nlerp',['../classnc_1_1rotations_1_1_quaternion.html#a314478702a3da52f2be3f422057d8732',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#ab055510c1338490b957de867cecaf790',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat2, double inPercent) const']]], + ['noncentralchisquared_750',['nonCentralChiSquared',['../namespacenc_1_1random.html#af01395c7355ee4c0f36441c40039e82d',1,'nc::random::nonCentralChiSquared(const Shape &inShape, dtype inK=1, dtype inLambda=1)'],['../namespacenc_1_1random.html#abf3cab0396026700ebf2d2ffa5e13fa6',1,'nc::random::nonCentralChiSquared(dtype inK=1, dtype inLambda=1)']]], + ['noncentralchisquared_2ehpp_751',['nonCentralChiSquared.hpp',['../non_central_chi_squared_8hpp.html',1,'']]], + ['none_752',['NONE',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84ab50339a10e1de285ac99d4c3990b8693',1,'nc']]], + ['none_753',['none',['../namespacenc.html#ada2840f1202c44082ee75b5f5705399d',1,'nc::none()'],['../classnc_1_1_nd_array.html#a379f8cd88dc84a38d668cb7bf97078ee',1,'nc::NdArray::none()']]], + ['none_2ehpp_754',['none.hpp',['../none_8hpp.html',1,'']]], + ['none_5fof_755',['none_of',['../namespacenc_1_1stl__algorithms.html#a2804ccb14980f96c7680838adc3b2762',1,'nc::stl_algorithms']]], + ['nonzero_756',['nonzero',['../namespacenc.html#a46ce9bcc6ba641e0550934b981175683',1,'nc::nonzero()'],['../classnc_1_1_nd_array.html#a6cc8c7b53a707468d6da112849970904',1,'nc::NdArray::nonzero()']]], + ['nonzero_2ehpp_757',['nonzero.hpp',['../nonzero_8hpp.html',1,'']]], + ['norm_758',['norm',['../namespacenc.html#aa57b910a1d9a448a15e76bd72563ac5d',1,'nc::norm()'],['../classnc_1_1_vec3.html#a6c177e1f5c00584279a0527d3053dee8',1,'nc::Vec3::norm()'],['../classnc_1_1_vec2.html#ab6922f6c089b20e9d019301fddc6dc0a',1,'nc::Vec2::norm()'],['../namespacenc.html#a13467936d679d6d078d585504bc42642',1,'nc::norm()']]], + ['norm_2ehpp_759',['norm.hpp',['../norm_8hpp.html',1,'']]], + ['normal_760',['normal',['../namespacenc_1_1random.html#a0d52ff6ccaa63bc36348ba39e5936056',1,'nc::random::normal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#ab655c4af3dac07aeff39efd50c120f4d',1,'nc::random::normal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], + ['normal_2ehpp_761',['normal.hpp',['../normal_8hpp.html',1,'']]], + ['normalize_762',['normalize',['../classnc_1_1_vec3.html#a6356b462b11a156b923a7c79b9747c25',1,'nc::Vec3::normalize()'],['../classnc_1_1_vec2.html#a8d8a3ec28ef8336ab02dcd964a3e836c',1,'nc::Vec2::normalize()']]], + ['not_5fequal_763',['not_equal',['../namespacenc.html#ac6c0da616068bc667891c0a460431de3',1,'nc']]], + ['not_5fequal_2ehpp_764',['not_equal.hpp',['../not__equal_8hpp.html',1,'']]], + ['nth_5felement_765',['nth_element',['../namespacenc_1_1stl__algorithms.html#af5ef45ab7814938799020ad24358b734',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a9928869b550b082898709c5671936079',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last, Compare comp) noexcept']]], + ['nth_5froot_766',['nth_root',['../namespacenc.html#aae5eb97b7313026b451ac4d7c01db027',1,'nc::nth_root(dtype1 inValue, dtype2 inRoot) noexcept'],['../namespacenc.html#a6da3daf9d73c1cea2e69c77f62b267b0',1,'nc::nth_root(const NdArray< dtype1 > &inArray, dtype2 inRoot)']]], + ['nth_5froot_2ehpp_767',['nth_root.hpp',['../nth__root_8hpp.html',1,'']]], + ['num2str_768',['num2str',['../namespacenc_1_1utils.html#a16a6ad93c420ed7a003d9921bee1a7c6',1,'nc::utils']]], + ['num2str_2ehpp_769',['num2str.hpp',['../num2str_8hpp.html',1,'']]], + ['numcols_770',['numCols',['../classnc_1_1_nd_array.html#a0049b5d6d1d99463edc773f01eb7c091',1,'nc::NdArray']]], + ['numcpp_2ehpp_771',['NumCpp.hpp',['../_num_cpp_8hpp.html',1,'']]], + ['numelements_772',['numElements',['../classnc_1_1_slice.html#aab35be40c38521a4bd9b3c99b3d33731',1,'nc::Slice']]], + ['numiterations_773',['numIterations',['../classnc_1_1roots_1_1_iteration.html#ab3192d0f9de4b8b27b23013c65489e5a',1,'nc::roots::Iteration']]], + ['numiterations_5f_774',['numIterations_',['../classnc_1_1roots_1_1_iteration.html#a84d7f2f7412d1f54861edeacc7bc0c20',1,'nc::roots::Iteration']]], + ['numrows_775',['numRows',['../classnc_1_1_nd_array.html#a2dbdc72c98c216a133f7e1a8d3c067f7',1,'nc::NdArray']]], + ['numsecdedparitybitsneeded_776',['numSecdedParityBitsNeeded',['../namespacenc_1_1edac_1_1detail.html#a6ee59971c08bfdc3e11a0245f17d5f9a',1,'nc::edac::detail']]], + ['polynomial_777',['polynomial',['../namespacenc_1_1polynomial.html',1,'nc']]], + ['random_778',['random',['../namespacenc_1_1random.html',1,'nc']]], + ['roots_779',['roots',['../namespacenc_1_1roots.html',1,'nc']]], + ['rotations_780',['rotations',['../namespacenc_1_1rotations.html',1,'nc']]], + ['special_781',['special',['../namespacenc_1_1special.html',1,'nc']]], + ['stl_5falgorithms_782',['stl_algorithms',['../namespacenc_1_1stl__algorithms.html',1,'nc']]], + ['utils_783',['utils',['../namespacenc_1_1utils.html',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/all_e.html b/docs/doxygen/html/search/all_e.html index 6de7dfc45..e25df423a 100644 --- a/docs/doxygen/html/search/all_e.html +++ b/docs/doxygen/html/search/all_e.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_e.js b/docs/doxygen/html/search/all_e.js index b1d1eed70..e6cfa0be2 100644 --- a/docs/doxygen/html/search/all_e.js +++ b/docs/doxygen/html/search/all_e.js @@ -1,47 +1,47 @@ var searchData= [ - ['ones_737',['ones',['../classnc_1_1_nd_array.html#ac6e5a0c875c593a6bc1970745af3684b',1,'nc::NdArray::ones()'],['../namespacenc.html#a5a935c0d187c7a0cab3d7ada27ffafc5',1,'nc::ones(const Shape &inShape)'],['../namespacenc.html#a0f6db9a6dcb85c14639b515f53d6b893',1,'nc::ones(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#ac9ffd1a2fa29857f39a38a9dab1079a2',1,'nc::ones(uint32 inSquareSize)']]], - ['ones_2ehpp_738',['ones.hpp',['../ones_8hpp.html',1,'']]], - ['ones_5flike_739',['ones_like',['../namespacenc.html#a90cb0bbdc492b0b10e635a79aa943e51',1,'nc']]], - ['ones_5flike_2ehpp_740',['ones_like.hpp',['../ones__like_8hpp.html',1,'']]], - ['operator_21_741',['operator!',['../namespacenc.html#a5afb0ad958d78f15eb6617618aec0640',1,'nc']]], - ['operator_21_3d_742',['operator!=',['../classnc_1_1_slice.html#afd66bc2d5f975f986e62230b124ae607',1,'nc::Slice::operator!=()'],['../namespacenc.html#a631e6eb2bf338af6af8487fd2d94b0a8',1,'nc::operator!=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a4cb019941743262a028a62001cda4bd0',1,'nc::operator!=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a33e15d535856758fb49567aa71204426',1,'nc::operator!=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1coordinates_1_1_coordinate.html#a8d139bb6b4d2d315d32d6fa818dab93d',1,'nc::coordinates::Coordinate::operator!=()'],['../classnc_1_1coordinates_1_1_dec.html#a60c04d5b65d89ed8204a51247b31c733',1,'nc::coordinates::Dec::operator!=()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9354c5b4942674a815b2315e8b92978',1,'nc::coordinates::RA::operator!=()'],['../classnc_1_1_vec3.html#aad142760da8d2b3493462b4542e42673',1,'nc::Vec3::operator!=()'],['../classnc_1_1_vec2.html#ac83768c682c162ec9dffe1bfb9637338',1,'nc::Vec2::operator!=()'],['../classnc_1_1rotations_1_1_quaternion.html#adcf57fd29d62e19f5c764750262ff7c3',1,'nc::rotations::Quaternion::operator!=()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad7a25b0cb28882ed45417dd3ed01e094',1,'nc::NdArrayConstColumnIterator::operator!=()'],['../classnc_1_1_nd_array_const_iterator.html#a96a196ff02ef70fe942c36afcb402f67',1,'nc::NdArrayConstIterator::operator!=()'],['../classnc_1_1image_processing_1_1_pixel.html#a4b80694a366506909633ff28c74b4042',1,'nc::imageProcessing::Pixel::operator!=()'],['../classnc_1_1image_processing_1_1_cluster.html#aa023fb6ea06515f18cd629b155f96a2c',1,'nc::imageProcessing::Cluster::operator!=()'],['../classnc_1_1image_processing_1_1_centroid.html#a89eb742174a9dd27b730ce4502e119cd',1,'nc::imageProcessing::Centroid::operator!=()'],['../classnc_1_1_shape.html#a56c44db7af73bc585c83e094da8996b5',1,'nc::Shape::operator!=()']]], - ['operator_25_743',['operator%',['../namespacenc.html#a4c7d623473bf78038f36fe75395e685b',1,'nc::operator%(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a6c703ec4985bf1bc6ea5c4a32fd72fcf',1,'nc::operator%(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a54ce1f6f396a09dddabae0f02d9aeeeb',1,'nc::operator%(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_25_3d_744',['operator%=',['../namespacenc.html#a02273630b6ed39b81c3341674a2ce527',1,'nc::operator%=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a112144152ae720509653d881e3a9d4f4',1,'nc::operator%=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_26_745',['operator&',['../namespacenc.html#a0c80b9ed3ff24fb25fb794e22a3467e6',1,'nc::operator&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a12d6f6d2a62496d8fe53f8b2daf0b6a8',1,'nc::operator&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aaa9c45bb88e88461db334c8b933217e3',1,'nc::operator&(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_26_26_746',['operator&&',['../namespacenc.html#aa9c15b56f7dc1eb4ce63b15285c7f8b1',1,'nc::operator&&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7f508d7557317498384741bd76fe39d5',1,'nc::operator&&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aa73c70b154a9045312635eb5a9252875',1,'nc::operator&&(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_26_3d_747',['operator&=',['../namespacenc.html#aedc89e1be7f41979fc870006016b6b46',1,'nc::operator&=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ae104d25f74df02965d9ef6e4a9848659',1,'nc::operator&=(NdArray< dtype > &lhs, dtype rhs)']]], - ['operator_28_29_748',['operator()',['../classnc_1_1_nd_array.html#abf2c4d2e67b692c67e5aed62cd981800',1,'nc::NdArray::operator()()'],['../classnc_1_1polynomial_1_1_poly1d.html#ac82910d648a2a3cfd2301e12907414dd',1,'nc::polynomial::Poly1d::operator()()'],['../classnc_1_1_nd_array.html#ac97b34c8348f6a510820bc3887a088d1',1,'nc::NdArray::operator()(RowIndices rowIndices, ColIndices colIndices) const'],['../classnc_1_1_nd_array.html#adfc2050efba624e48733775ae48da8ff',1,'nc::NdArray::operator()(Slice rowSlice, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#a921862c636c42a394cb25d95b2c6e326',1,'nc::NdArray::operator()(int32 rowIndex, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#a9c33b3d44d196376aa9511f86c9c860c',1,'nc::NdArray::operator()(const Indices &rowIndices, Slice colSlice) const'],['../classnc_1_1_nd_array.html#ab2b2913858d7d8427ef5c58ce2caee01',1,'nc::NdArray::operator()(const Indices &rowIndices, int32 colIndex) const'],['../classnc_1_1_nd_array.html#a6ca54f3e1aca253d55dab87e38d21df1',1,'nc::NdArray::operator()(int32 inRowIndex, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#a1583ae58b94d68e101079c4578fe1716',1,'nc::NdArray::operator()(Slice inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#a694ed71b52be045362ed9c9ed9d0d5a0',1,'nc::NdArray::operator()(Slice inRowSlice, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#aac0b806c621ce85a61f1370cc618fcc8',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) const noexcept']]], - ['operator_2a_749',['operator*',['../classnc_1_1rotations_1_1_quaternion.html#a10fd2d44927d59f19e37c45586072d14',1,'nc::rotations::Quaternion::operator*()'],['../classnc_1_1_nd_array_const_iterator.html#ad4ce15f95730d8c089db4f2a26b91090',1,'nc::NdArrayConstIterator::operator*()'],['../classnc_1_1_nd_array_iterator.html#ae1e918bc6718fe1ffa58f7c6a82fbe30',1,'nc::NdArrayIterator::operator*()'],['../classnc_1_1_nd_array_const_column_iterator.html#ac096213e50279dc023bbf6270c31969a',1,'nc::NdArrayConstColumnIterator::operator*()'],['../classnc_1_1_nd_array_column_iterator.html#af387e330729ecde7c09d388915ae346a',1,'nc::NdArrayColumnIterator::operator*()'],['../classnc_1_1polynomial_1_1_poly1d.html#aab8cce6bf7a9400862d98684de8ef355',1,'nc::polynomial::Poly1d::operator*()'],['../classnc_1_1rotations_1_1_quaternion.html#adad6ca92266f6090930addc585900805',1,'nc::rotations::Quaternion::operator*(const Quaternion &inRhs) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#ad63920fa01f5bd4949c0fbb3ff7c7137',1,'nc::rotations::Quaternion::operator*(double inScalar) const noexcept'],['../namespacenc.html#ace6d6bf5d703e886d8f137cf73be5021',1,'nc::operator*(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#abf6f57d9d17019d8756b86bfa1019bc1',1,'nc::operator*(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#af09d0c6363ef9dc8e661e9254bcf109f',1,'nc::operator*(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#af4f34a2e6e8b9011cb2d2fc5c564e10a',1,'nc::operator*(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a7865c90c232341c387b0105ac4fdbfd9',1,'nc::operator*(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9a0ff185c891d6c5af3d7150bc645dc8',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a199168f4bff489c9ad1d0755e573c6aa',1,'nc::operator*(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a8248dae03ae96d459320f42d60fdf424',1,'nc::operator*(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a1769d68f44f9c98d94dd412bc32a9bb5',1,'nc::operator*(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#af51c9efd8dbadbdc664972bd96583a72',1,'nc::operator*(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#af4ecba4e059c6dcf672644a3c1bff75d',1,'nc::operator*(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a39b128708b2225a00de527c8ec83d72a',1,'nc::operator*(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a34212756103e0c821034e5469f0f0ed7',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a72a4a5ad03afcaf6e9f9b7ee6e145a80',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9188c8ea881ad55ea9dc85ae154cbc22',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#a97a81255a6bb91049b1ad7e7b83e2f7f',1,'nc::rotations::Quaternion::operator*()']]], - ['operator_2a_3d_750',['operator*=',['../namespacenc.html#a25ad051c1d98b01675e9c1a52eb8f8c8',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#af0a3674baebda83b99ba3b18ca4a59d3',1,'nc::operator*=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a36c7c3a0be4e8652e52e1710f2808ddd',1,'nc::operator*=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a9211f93baeed5af8e00cfd30628d65f6',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#aaaa8a1bd7130e7ce6a819284584a84c5',1,'nc::rotations::Quaternion::operator*=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a06293521430112062f975b4854090d24',1,'nc::polynomial::Poly1d::operator*=()'],['../classnc_1_1rotations_1_1_quaternion.html#a17636913a3a1e810a81a558dc986fd54',1,'nc::rotations::Quaternion::operator*=()'],['../classnc_1_1_vec2.html#a72ac39ba88f909cb5552f6b379509f81',1,'nc::Vec2::operator*=()'],['../classnc_1_1_vec3.html#a02ec360e4ebb7b4a6b629eedf8d24a2f',1,'nc::Vec3::operator*=()']]], - ['operator_2b_751',['operator+',['../namespacenc.html#ac6f8a785c25c21f9b4b8328dfd7da6c6',1,'nc::operator+()'],['../classnc_1_1_nd_array_const_iterator.html#a55064001ba08765b1e97962ca82a91cd',1,'nc::NdArrayConstIterator::operator+()'],['../classnc_1_1_nd_array_iterator.html#ab26263e7aa624ed5dd5b0140f2adccb7',1,'nc::NdArrayIterator::operator+()'],['../classnc_1_1_nd_array_const_column_iterator.html#a0375a9e5bb7a8e268d80da41186d58a4',1,'nc::NdArrayConstColumnIterator::operator+()'],['../classnc_1_1_nd_array_column_iterator.html#a6e4c3af43aa00d49305bcd50eaa477e1',1,'nc::NdArrayColumnIterator::operator+()'],['../classnc_1_1polynomial_1_1_poly1d.html#a65afb72ad35683688c7fb71ee77f839e',1,'nc::polynomial::Poly1d::operator+()'],['../classnc_1_1rotations_1_1_quaternion.html#a53c84fdd06a1f980c7c74a185d568156',1,'nc::rotations::Quaternion::operator+()'],['../namespacenc.html#a5a056c387e8726b0612d920bfa55123f',1,'nc::operator+(typename NdArrayConstIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayConstIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a3768e00a52c63b8bbc18d712cb4330c6',1,'nc::operator+(typename NdArrayIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#acb8250110150dfe1c585f48f988d703a',1,'nc::operator+(typename NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a675deb20abd6aec02f63f72e4c4787dd',1,'nc::operator+(typename NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#aae286fee26a3f654159dca70928e4060',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a44bd86bfac8783b176ecb2242d3ae93f',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a050e6920070ccd078fc357b3ef0198e1',1,'nc::operator+(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a2fff3527567d94f0a1a62269549ad20a',1,'nc::operator+(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a98293d4bef0cd036ce30829e7965126e',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a26bec2e52fdab966f0f3714d1e2ea8bb',1,'nc::operator+(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a5ded64221f16b9a774bc35de58204e28',1,'nc::operator+(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#ab769651a09123be0a13a54a82aaa088a',1,'nc::operator+(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a43fad0472de9a72d2680623200138907',1,'nc::operator+(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a9f50afa50b63aea110be8b9b477d1cb4',1,'nc::operator+(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a9c2f64fa5154e84e1b33b518f75b2ee8',1,'nc::operator+(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a2d00329ee55367cc78bb5ec002d177cf',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#ae7a4dd062b1c5d1f495741e11947f3b5',1,'nc::operator+(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#acf7b3bfdc67df0619847cd06cb2f0519',1,'nc::operator+(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)']]], - ['operator_2b_2b_752',['operator++',['../namespacenc.html#ab0ad6a59584ad4f4e277ddedd3c4d476',1,'nc::operator++()'],['../classnc_1_1_nd_array_const_iterator.html#ae955fba21b22639a84b9b030283476a6',1,'nc::NdArrayConstIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a3d40f842cc5345a8f8051ae6bdebe321',1,'nc::NdArrayConstIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#ab832430f99b5ddfed996584e4c354f4a',1,'nc::NdArrayIterator::operator++() noexcept'],['../classnc_1_1_nd_array_iterator.html#a350b5406b062642ed48d6c3d9d2ce4b9',1,'nc::NdArrayIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#ad69593e9f3cbf04dff6941bd52827208',1,'nc::NdArrayConstColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a82ded30f6199ce6c9f3630b28e971650',1,'nc::NdArrayConstColumnIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#abd93d4f21e45188893fcb1c43f907ff0',1,'nc::NdArrayColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a388ac709c8d2b80c0ed5aa7fbb2047a6',1,'nc::NdArrayColumnIterator::operator++(int) noexcept'],['../namespacenc.html#ad1dfa157bab28851bf97d9982df3f2f3',1,'nc::operator++(NdArray< dtype > &lhs, int)']]], - ['operator_2b_3d_753',['operator+=',['../namespacenc.html#ae11d9ca1ca975cd511b91ddb512dd097',1,'nc::operator+=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aad9f67cc0911a32f877365833eec3f95',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array_const_iterator.html#aedc3bbd86f2b1b678abb27109dd50ff6',1,'nc::NdArrayConstIterator::operator+=()'],['../classnc_1_1_nd_array_iterator.html#af691ece9b6335b8191eeeb43a6168b00',1,'nc::NdArrayIterator::operator+=()'],['../classnc_1_1_nd_array_const_column_iterator.html#aa6b2701798827af7b54de723628a20d7',1,'nc::NdArrayConstColumnIterator::operator+=()'],['../classnc_1_1_nd_array_column_iterator.html#acc186137be7b139f7fdcf323e716e5a0',1,'nc::NdArrayColumnIterator::operator+=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a44a0331a1cfc760d7b80bfc20b661366',1,'nc::polynomial::Poly1d::operator+=()'],['../classnc_1_1rotations_1_1_quaternion.html#af2b75597d538e55cfdd1215c35c9c6fe',1,'nc::rotations::Quaternion::operator+=()'],['../classnc_1_1_vec2.html#a21b1c9c0aa0b7e8886f1b4a7c255bb9e',1,'nc::Vec2::operator+=(double scaler) noexcept'],['../classnc_1_1_vec2.html#af441d4bbee40c07f9b86fbd056ff637e',1,'nc::Vec2::operator+=(const Vec2 &rhs) noexcept'],['../classnc_1_1_vec3.html#afef859d21f4332089843c5d337c1ce01',1,'nc::Vec3::operator+=()'],['../namespacenc.html#a7d26cc24b2a68f3ee89c701453e6c9a8',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a4f44f946519987633cf47549e5764298',1,'nc::operator+=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1_vec3.html#a2b1c4e63a7233fb56e2f037807dffb68',1,'nc::Vec3::operator+=()']]], - ['operator_2d_754',['operator-',['../namespacenc.html#a5e63a7dbcbc5bf2e9e5ad41c0169df34',1,'nc::operator-(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#af87da9c66c9e535066221e4f85f3ed90',1,'nc::operator-(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a6935362e6d04b73f04c0e8191ae3098d',1,'nc::operator-(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#a7227073082d530baaf7ebb96ee06995b',1,'nc::operator-(const Vec3 &vec) noexcept'],['../namespacenc.html#a305a3e10402251fc06871a84f8941298',1,'nc::operator-(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7cf1dfd7144b41f4d748af9fb8aa5ffb',1,'nc::operator-(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#ad279cbad60173006f6883e0d18b0147e',1,'nc::operator-(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#af29a28cada8fd30111a2c6d41a110ff8',1,'nc::operator-(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a7c52ae6f5c5daf9d27c292e0451cccc3',1,'nc::operator-(const Vec2 &vec) noexcept'],['../namespacenc.html#a31b3ca85817b7242152028c4fd3f32c3',1,'nc::operator-(const NdArray< dtype > &inArray)'],['../namespacenc.html#a9d459ed977535f74996fe4820343138d',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#aae5b14c2febca550101675a55ee5e436',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aea4fe5d4daa75249a7b7765a219cbdb9',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a88d16d314b7e1427529122d2434223e0',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9b0eb6f1f7c4c55004478a3eb99c5367',1,'nc::operator-(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a419f15a00c80bffbe8446892e2015eae',1,'nc::operator-(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1c852c2418c1b5eac6da53972f82233e',1,'nc::operator-(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../classnc_1_1_nd_array_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayIterator::operator-()'],['../classnc_1_1_nd_array_const_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayConstIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_const_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayConstIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_iterator.html#a8bb1505ab1105805bd3ced24b69d17eb',1,'nc::NdArrayIterator::operator-()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayConstColumnIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayConstColumnIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a6dda98c1eba18dff31c9a66f528cd72b',1,'nc::NdArrayColumnIterator::operator-()'],['../classnc_1_1polynomial_1_1_poly1d.html#ade7b4f432e1056bc66d88a131a2cbf41',1,'nc::polynomial::Poly1d::operator-()'],['../classnc_1_1rotations_1_1_quaternion.html#ad6eb2370d77e01a944c4b32a48966e76',1,'nc::rotations::Quaternion::operator-(const Quaternion &inRhs) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a43fe6603ffbaaadf9348910e17e99519',1,'nc::rotations::Quaternion::operator-() const noexcept'],['../classnc_1_1_nd_array_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayIterator::operator-()'],['../classnc_1_1_nd_array_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayColumnIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayColumnIterator::operator-(const self_type &rhs) const noexcept'],['../namespacenc.html#a7c61e5d343e6439c26abb36db5a0b948',1,'nc::operator-()']]], - ['operator_2d_2d_755',['operator--',['../classnc_1_1_nd_array_column_iterator.html#a8ee7c1ecf2dc107159aec64377f5d6bd',1,'nc::NdArrayColumnIterator::operator--()'],['../classnc_1_1_nd_array_const_iterator.html#a6061cf25f89e41d3a77d0f4fb0ccc7e2',1,'nc::NdArrayConstIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a526a13c16c0ef08b005f67184f80087a',1,'nc::NdArrayConstIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#a3bcc95583b7a85e5d253b6c830d33ec4',1,'nc::NdArrayIterator::operator--() noexcept'],['../classnc_1_1_nd_array_iterator.html#adcd3b9918db13467bcd234e6f3eec61f',1,'nc::NdArrayIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a9813a585d99eb656cbe7e1e12476d30b',1,'nc::NdArrayConstColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a5fea275f4afdd1fca5b59830ce182bff',1,'nc::NdArrayConstColumnIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a145c2fa5cbd327fbba7dd4701ef27baf',1,'nc::NdArrayColumnIterator::operator--()'],['../namespacenc.html#aa7ea8977a2740af99f4c08c88d7a79e8',1,'nc::operator--(NdArray< dtype > &rhs)'],['../namespacenc.html#ab1ac162f983d66eec0f6189325bd1720',1,'nc::operator--(NdArray< dtype > &lhs, int)']]], - ['operator_2d_3d_756',['operator-=',['../namespacenc.html#ac870e3973346560eba3380c11f216540',1,'nc::operator-=()'],['../classnc_1_1_vec2.html#abfb0b00888fa37d52a895d06f2b39133',1,'nc::Vec2::operator-=(double scaler) noexcept'],['../classnc_1_1_vec2.html#a13a2bbc2595248211e0bc97de51e13b5',1,'nc::Vec2::operator-=(const Vec2 &rhs) noexcept'],['../classnc_1_1_vec3.html#a70251860269c7cb5becbe988a0b2c48e',1,'nc::Vec3::operator-=(double scaler) noexcept'],['../classnc_1_1_vec3.html#a208820649ed763a5dcc9405c4aa481f2',1,'nc::Vec3::operator-=(const Vec3 &rhs) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a60f1f33144c887cde1338fd80183638f',1,'nc::rotations::Quaternion::operator-=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a732cca31f4b6180d0ad035a6daeb160a',1,'nc::polynomial::Poly1d::operator-=()'],['../classnc_1_1_nd_array_column_iterator.html#a80924e15c192ee04843add79ad2efece',1,'nc::NdArrayColumnIterator::operator-=()'],['../namespacenc.html#a8ba0ad93a3ec2ca409cdb14785e1f679',1,'nc::operator-=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9093ebf2aaa2dbc811ae45e77ba52960',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aae2f4895eb95921ca77529137e603cd0',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../classnc_1_1_nd_array_const_iterator.html#a9ae2efc38005276adaa744e6bec116c3',1,'nc::NdArrayConstIterator::operator-=()'],['../classnc_1_1_nd_array_iterator.html#a3ae9bd787a73639f2d0334d87f1fb720',1,'nc::NdArrayIterator::operator-=()'],['../classnc_1_1_nd_array_const_column_iterator.html#af68690450642df08758a9e067edeee47',1,'nc::NdArrayConstColumnIterator::operator-=()']]], - ['operator_2d_3e_757',['operator->',['../classnc_1_1_nd_array_const_iterator.html#a36aee44e67ed7bdc2fd3ca660e1748fa',1,'nc::NdArrayConstIterator::operator->()'],['../classnc_1_1_nd_array_iterator.html#aa1627ff7d2b0089222794bfebaa29a32',1,'nc::NdArrayIterator::operator->()'],['../classnc_1_1_nd_array_const_column_iterator.html#a33d2e58d269f938c742ac25f46edf008',1,'nc::NdArrayConstColumnIterator::operator->()'],['../classnc_1_1_nd_array_column_iterator.html#ae66efdfa1252f405042276e3e9a25364',1,'nc::NdArrayColumnIterator::operator->()']]], - ['operator_2f_758',['operator/',['../namespacenc.html#abe2fc114afe7f62aacf55a9288f45c4a',1,'nc::operator/(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a0a070b4ec8a29ee1a357c53857d4778a',1,'nc::operator/(const Vec3 &lhs, double rhs) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#ab054e067fc333a48582e291f95120866',1,'nc::rotations::Quaternion::operator/()'],['../namespacenc.html#a69481119ed4cf9e7fe41b0c9228693e3',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a06365d71ef5c147fee8e571b9fef7313',1,'nc::operator/(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a58862db40468f4be62b860990cf05336',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a8d2ca407e7579acac2ca6496c4196d15',1,'nc::operator/(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1eee81e10b382e6b0474508725831a4f',1,'nc::operator/(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a04bf5ca073685e762d84932ae14b8caa',1,'nc::operator/(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4dda3a7297e38679bf172d870090da1d',1,'nc::operator/(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a4bec4dbe25db0a2ec84e5999458a2c02',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ac8cd599e4b67e78c173894bc3d2bd7f2',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_2f_3d_759',['operator/=',['../namespacenc.html#a05414ec63ae42b4a3e9e81ceef072094',1,'nc::operator/=()'],['../classnc_1_1rotations_1_1_quaternion.html#a859df40774ccff755560604b930c934d',1,'nc::rotations::Quaternion::operator/=()'],['../classnc_1_1_vec2.html#a1a1c875b11ea5571cb2b71778a692472',1,'nc::Vec2::operator/=()'],['../classnc_1_1_vec3.html#a431b2ac6af51bf59d804adbe5c8a7700',1,'nc::Vec3::operator/=()'],['../namespacenc.html#ad554e38d21aec306a8e3e4cd4ca990a2',1,'nc::operator/=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a26c691c1a8a6ddea49796591063e7630',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7bbd0ddf9efe256d0c010e2c481da2d5',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], - ['operator_3c_760',['operator<',['../classnc_1_1image_processing_1_1_centroid.html#a093719e81ed5bd5af0cb80dcfd03289f',1,'nc::imageProcessing::Centroid::operator<()'],['../classnc_1_1_nd_array_const_iterator.html#a6ae3aca3c7cb79a9fd985c1820b74c39',1,'nc::NdArrayConstIterator::operator<()'],['../classnc_1_1_nd_array_const_column_iterator.html#ab0928638c653f5ed37088a3e5098064b',1,'nc::NdArrayConstColumnIterator::operator<()'],['../namespacenc.html#a724cd71c78633aa5a757aa76b514f46a',1,'nc::operator<(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#ac1e7489f428b83ed55b5d44963b4eab6',1,'nc::operator<(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a8b68828e75eb8bd91ccdc63e6c39511f',1,'nc::operator<(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a6500fd0898086f300bb7909249b3e50f',1,'nc::operator<(dtype inValue, const NdArray< dtype > &inArray)'],['../classnc_1_1image_processing_1_1_pixel.html#a592926833195d4f2587efef12e4b1148',1,'nc::imageProcessing::Pixel::operator<()']]], - ['operator_3c_3c_761',['operator<<',['../classnc_1_1polynomial_1_1_poly1d.html#a589d9ff132413fa86a20f2fa7910e5df',1,'nc::polynomial::Poly1d::operator<<()'],['../namespacenc.html#a0cf6f27f323d5bc34b6c56316c480865',1,'nc::operator<<(std::ostream &stream, const Vec3 &vec)'],['../namespacenc.html#a39964568372712a2a5427c44e59ffbe2',1,'nc::operator<<(const NdArray< dtype > &lhs, uint8 inNumBits)'],['../namespacenc.html#a5df285ae528f83294768588fa622d41f',1,'nc::operator<<(std::ostream &inOStream, const NdArray< dtype > &inArray)'],['../namespacenc.html#aecdda46f9eca3e1f802bb5451ca952cb',1,'nc::operator<<(std::ostream &stream, const Vec2 &vec)'],['../classnc_1_1rotations_1_1_quaternion.html#a6d11f3a719f010cdd220642d2bb586e6',1,'nc::rotations::Quaternion::operator<<()'],['../classnc_1_1image_processing_1_1_pixel.html#a157a2e98ace3e2185af571a68e5a5b9c',1,'nc::imageProcessing::Pixel::operator<<()'],['../classnc_1_1image_processing_1_1_cluster.html#a1b1adec296082d83ee2f87484bfe07cb',1,'nc::imageProcessing::Cluster::operator<<()'],['../classnc_1_1image_processing_1_1_centroid.html#a787da1f79223e97a2788a2ad47e1c394',1,'nc::imageProcessing::Centroid::operator<<()'],['../classnc_1_1_slice.html#ad6889d2df295fef3796aebb769b8cac0',1,'nc::Slice::operator<<()'],['../classnc_1_1_shape.html#a520d818f31bbdacdf8cfbe6de9e88a28',1,'nc::Shape::operator<<()'],['../classnc_1_1coordinates_1_1_r_a.html#aa7b5289b9d14da6e7b4393be2fddfc33',1,'nc::coordinates::RA::operator<<()'],['../classnc_1_1coordinates_1_1_dec.html#a83e1fb757cb9153e02dcecd2a37976c1',1,'nc::coordinates::Dec::operator<<()'],['../classnc_1_1coordinates_1_1_coordinate.html#aa9e34ee6b7a8425e6af5a715935a4251',1,'nc::coordinates::Coordinate::operator<<()']]], - ['operator_3c_3c_3d_762',['operator<<=',['../namespacenc.html#a9d82fca424a68c0042594e483b51ced2',1,'nc']]], - ['operator_3c_3d_763',['operator<=',['../namespacenc.html#a496de942a0d74925ed64972dcb2cffe8',1,'nc::operator<=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9f9bb9e7b4ecf581498351e14f074145',1,'nc::operator<=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a8468d6928d88c7f34d1456261331f238',1,'nc::NdArrayConstColumnIterator::operator<=()'],['../classnc_1_1_nd_array_const_iterator.html#a171276f9e90a1336d156c61c2b61bd23',1,'nc::NdArrayConstIterator::operator<=()'],['../namespacenc.html#a4ceffb2e21de23701d431abde8e78592',1,'nc::operator<=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#accb22a9c6f4dc0452020b0a86ef8fdf9',1,'nc::operator<=(dtype inValue, const NdArray< dtype > &inArray)']]], - ['operator_3d_764',['operator=',['../classnc_1_1_nd_array.html#abe4cda5855bc5d6aee488293000d1acb',1,'nc::NdArray::operator=(const NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array.html#ae5150db09cf7f76269b3254ceb0c43a8',1,'nc::NdArray::operator=(value_type inValue) noexcept'],['../classnc_1_1_nd_array.html#a5ff24670b2173fccf1c9a35b688f2683',1,'nc::NdArray::operator=(NdArray< dtype > &&rhs) noexcept']]], - ['operator_3d_3d_765',['operator==',['../classnc_1_1_vec3.html#a2cc63855706091881f765b63dcf52c44',1,'nc::Vec3::operator==()'],['../classnc_1_1rotations_1_1_quaternion.html#a82f40acb2292256faffab2b88aa38208',1,'nc::rotations::Quaternion::operator==()'],['../classnc_1_1_nd_array_const_column_iterator.html#aec9953c2361595fc656a1a5d306e36c0',1,'nc::NdArrayConstColumnIterator::operator==()'],['../classnc_1_1_nd_array_const_iterator.html#ac055ccace7f791cfb94d7df8e7100dc2',1,'nc::NdArrayConstIterator::operator==()'],['../classnc_1_1image_processing_1_1_pixel.html#a008757a06c498b1a31e26d53a54e51dc',1,'nc::imageProcessing::Pixel::operator==()'],['../classnc_1_1image_processing_1_1_cluster.html#a8308c5f0313872c9499de36d69d0ff19',1,'nc::imageProcessing::Cluster::operator==()'],['../classnc_1_1image_processing_1_1_centroid.html#a503a2542b388f65fb80710dd33610abc',1,'nc::imageProcessing::Centroid::operator==()'],['../classnc_1_1_slice.html#a769815d8fbb98ba34101c18a21efbbf5',1,'nc::Slice::operator==()'],['../classnc_1_1_shape.html#a0267d8b7eb226fdc442be5c914f9c870',1,'nc::Shape::operator==()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9e22496d5fdc265ee5a5d77ec97c184',1,'nc::coordinates::RA::operator==()'],['../classnc_1_1coordinates_1_1_dec.html#a5b264a9d7bb9b2c1b537b03a5eac7265',1,'nc::coordinates::Dec::operator==()'],['../classnc_1_1coordinates_1_1_coordinate.html#a96255907cf1af2c416c7dbe34e96b0d5',1,'nc::coordinates::Coordinate::operator==()'],['../namespacenc.html#a283fba259d2cd892a8cbb2782490b92a',1,'nc::operator==(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aa956dff0507eddc1c1d80e423f126383',1,'nc::operator==(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#afdcaaff39ed10311d74302a6e9be2fd4',1,'nc::operator==(dtype inValue, const NdArray< dtype > &inArray)'],['../classnc_1_1_vec2.html#af04a7f20ae8ac7a59ae44f7819668fa0',1,'nc::Vec2::operator==()']]], - ['operator_3e_766',['operator>',['../classnc_1_1_nd_array_const_iterator.html#a8a312e1809eae90df625971d6b4ab62e',1,'nc::NdArrayConstIterator::operator>()'],['../classnc_1_1_nd_array_const_column_iterator.html#a827d0a8431ec616ef0161144b3d24af6',1,'nc::NdArrayConstColumnIterator::operator>()'],['../namespacenc.html#a20910640e1c1dd8bc9298561fedc84a4',1,'nc::operator>(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a5755bb93bff9c0cbd38dbf1296902374',1,'nc::operator>(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7433343db2634ef8f75e290370cfe21e',1,'nc::operator>(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a113de1155a4e2a71dcdad1709c58afe8',1,'nc::operator>(dtype inValue, const NdArray< dtype > &inArray)']]], - ['operator_3e_3d_767',['operator>=',['../namespacenc.html#a0dfd9f5c1ec0c3d61959c4c54e6dc23a',1,'nc::operator>=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a48199b1c11d42106cd09ae57215520fe',1,'nc::operator>=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4a32b6c123eaa3f46c14159b243522de',1,'nc::operator>=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#ac453f615df2e03778835908a70907145',1,'nc::operator>=(dtype inValue, const NdArray< dtype > &inArray)'],['../classnc_1_1_nd_array_const_column_iterator.html#a9935c5d4b3deff76207ccde7cfccbf62',1,'nc::NdArrayConstColumnIterator::operator>=()'],['../classnc_1_1_nd_array_const_iterator.html#a06871d8ba079130e84a892995c07a49a',1,'nc::NdArrayConstIterator::operator>=()']]], - ['operator_3e_3e_768',['operator>>',['../namespacenc.html#a7e6fe3981b55cd4f381339b616a55ec8',1,'nc']]], - ['operator_3e_3e_3d_769',['operator>>=',['../namespacenc.html#a7626eefaf34c6ac138da762c6ae930e7',1,'nc']]], - ['operator_5b_5d_770',['operator[]',['../classnc_1_1_nd_array_iterator.html#a40c132f8a7c1dd9fde17bcd3ddc2a18f',1,'nc::NdArrayIterator::operator[]()'],['../classnc_1_1_data_cube.html#a1a16b98e982d79cc6a172b8e2bfad856',1,'nc::DataCube::operator[](uint32 inIndex) noexcept'],['../classnc_1_1_data_cube.html#a403c0b0df22fc5fa0858109fa7a65f87',1,'nc::DataCube::operator[](uint32 inIndex) const noexcept'],['../classnc_1_1image_processing_1_1_cluster.html#a386b222d5747fc2b77448ea5a56d24e4',1,'nc::imageProcessing::Cluster::operator[]()'],['../classnc_1_1_nd_array_column_iterator.html#a5dc1514332728850b8fbeaa7d1f8bda0',1,'nc::NdArrayColumnIterator::operator[]()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3a37dd5a1496ecf2249950325b0a388c',1,'nc::NdArrayConstColumnIterator::operator[]()'],['../classnc_1_1_nd_array_const_iterator.html#a83ee672f75e74c4421a25a7816be12c6',1,'nc::NdArrayConstIterator::operator[]()'],['../classnc_1_1_nd_array.html#a0f53f1d4f5b259021cf61026f65759e0',1,'nc::NdArray::operator[](const Indices &inIndices) const'],['../classnc_1_1_nd_array.html#ab04b63c2794747b88b0e640f737c6b2c',1,'nc::NdArray::operator[](const NdArray< bool > &inMask) const'],['../classnc_1_1_nd_array.html#a4744ab68830cc2cc16d8804295662b6a',1,'nc::NdArray::operator[](const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#aeabee2aba11a885f3bd874b7a06d62ea',1,'nc::NdArray::operator[](int32 inIndex) const noexcept'],['../classnc_1_1_nd_array.html#aa58a51df41648b4d39f2f972c60e09ae',1,'nc::NdArray::operator[](int32 inIndex) noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae92d75ae626bb18324b0dfe69ee44f25',1,'nc::imageProcessing::ClusterMaker::operator[]()']]], - ['operator_5e_771',['operator^',['../namespacenc.html#ae4befd8a03420464348fdfcc71b106bb',1,'nc::operator^()'],['../classnc_1_1polynomial_1_1_poly1d.html#a548c945121cb39859f649cf39a6d0830',1,'nc::polynomial::Poly1d::operator^()'],['../namespacenc.html#aa6be940ce9eed012ca0fac881d884411',1,'nc::operator^(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#af4f0fce9397ab714d3567d454f143835',1,'nc::operator^(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_5e_3d_772',['operator^=',['../namespacenc.html#a8d3d77fe59d533d1301aea0112e38fa8',1,'nc::operator^=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ad4f2748ac9b7ebe59f1592e118169ea7',1,'nc::operator^=(NdArray< dtype > &lhs, dtype rhs)'],['../classnc_1_1polynomial_1_1_poly1d.html#a930f53185992537e3eb5844ebb70bf38',1,'nc::polynomial::Poly1d::operator^=()']]], - ['operator_7c_773',['operator|',['../namespacenc.html#a2dd868d584e1d65748cf04957eb97d99',1,'nc::operator|(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a129a0c61ca191919674576a76ee7fd93',1,'nc::operator|(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a50e6d418c92ccd6d7a2cf42a899a2203',1,'nc::operator|(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_7c_3d_774',['operator|=',['../namespacenc.html#a958f4fd964269c7affaaff0e30b4dc01',1,'nc::operator|=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#afbb3e9d2eb28cad36a9de996263067d9',1,'nc::operator|=(NdArray< dtype > &lhs, dtype rhs)']]], - ['operator_7c_7c_775',['operator||',['../namespacenc.html#a25c9ac2d82de1fd3c81890ad38ebfb25',1,'nc::operator||(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#affe1935670d985dfe387f429d68874e2',1,'nc::operator||(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a37ef6f1c023837fbe628c3838b14d940',1,'nc::operator||(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_7e_776',['operator~',['../namespacenc.html#ae9d44b86bb2c2968d5c67f11ca789d3e',1,'nc']]], - ['order_777',['order',['../classnc_1_1polynomial_1_1_poly1d.html#ab978ca2f65c7cd640309c1be86aa9141',1,'nc::polynomial::Poly1d']]], - ['outer_778',['outer',['../namespacenc.html#a395197f9b1d3f53a5fdcd234fa6e6baf',1,'nc']]], - ['outer_2ehpp_779',['outer.hpp',['../outer_8hpp.html',1,'']]], - ['ownsinternaldata_780',['ownsInternalData',['../classnc_1_1_nd_array.html#a63a1c0f9fdef078770e4f8cbe2c249ec',1,'nc::NdArray']]] + ['ones_784',['ones',['../namespacenc.html#ac9ffd1a2fa29857f39a38a9dab1079a2',1,'nc::ones()'],['../classnc_1_1_nd_array.html#ac6e5a0c875c593a6bc1970745af3684b',1,'nc::NdArray::ones()'],['../namespacenc.html#a0f6db9a6dcb85c14639b515f53d6b893',1,'nc::ones(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a5a935c0d187c7a0cab3d7ada27ffafc5',1,'nc::ones(const Shape &inShape)']]], + ['ones_2ehpp_785',['ones.hpp',['../ones_8hpp.html',1,'']]], + ['ones_5flike_786',['ones_like',['../namespacenc.html#a90cb0bbdc492b0b10e635a79aa943e51',1,'nc']]], + ['ones_5flike_2ehpp_787',['ones_like.hpp',['../ones__like_8hpp.html',1,'']]], + ['operator_21_788',['operator!',['../namespacenc.html#a5afb0ad958d78f15eb6617618aec0640',1,'nc']]], + ['operator_21_3d_789',['operator!=',['../classnc_1_1coordinates_1_1_coordinate.html#a8d139bb6b4d2d315d32d6fa818dab93d',1,'nc::coordinates::Coordinate::operator!=()'],['../classnc_1_1coordinates_1_1_dec.html#a60c04d5b65d89ed8204a51247b31c733',1,'nc::coordinates::Dec::operator!=()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9354c5b4942674a815b2315e8b92978',1,'nc::coordinates::RA::operator!=()'],['../classnc_1_1_shape.html#a56c44db7af73bc585c83e094da8996b5',1,'nc::Shape::operator!=()'],['../classnc_1_1_slice.html#afd66bc2d5f975f986e62230b124ae607',1,'nc::Slice::operator!=()'],['../classnc_1_1image_processing_1_1_centroid.html#a89eb742174a9dd27b730ce4502e119cd',1,'nc::imageProcessing::Centroid::operator!=()'],['../classnc_1_1image_processing_1_1_cluster.html#aa023fb6ea06515f18cd629b155f96a2c',1,'nc::imageProcessing::Cluster::operator!=()'],['../classnc_1_1image_processing_1_1_pixel.html#a4b80694a366506909633ff28c74b4042',1,'nc::imageProcessing::Pixel::operator!=()'],['../classnc_1_1_nd_array_const_iterator.html#a96a196ff02ef70fe942c36afcb402f67',1,'nc::NdArrayConstIterator::operator!=()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad7a25b0cb28882ed45417dd3ed01e094',1,'nc::NdArrayConstColumnIterator::operator!=()'],['../classnc_1_1rotations_1_1_quaternion.html#adcf57fd29d62e19f5c764750262ff7c3',1,'nc::rotations::Quaternion::operator!=()'],['../classnc_1_1_vec2.html#ac83768c682c162ec9dffe1bfb9637338',1,'nc::Vec2::operator!=()'],['../classnc_1_1_vec3.html#aad142760da8d2b3493462b4542e42673',1,'nc::Vec3::operator!=()'],['../namespacenc.html#a4cb019941743262a028a62001cda4bd0',1,'nc::operator!=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a631e6eb2bf338af6af8487fd2d94b0a8',1,'nc::operator!=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a33e15d535856758fb49567aa71204426',1,'nc::operator!=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_25_790',['operator%',['../namespacenc.html#a54ce1f6f396a09dddabae0f02d9aeeeb',1,'nc::operator%(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a6c703ec4985bf1bc6ea5c4a32fd72fcf',1,'nc::operator%(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#af2360d92e17c3bf8956f1ab391f0022a',1,'nc::operator%(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_25_3d_791',['operator%=',['../namespacenc.html#a0dfaa5d06ddc26868216477f53b56b46',1,'nc::operator%=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9b9a9ad49ab9cdaa1b3434038c6c983a',1,'nc::operator%=(NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_26_792',['operator&',['../namespacenc.html#aaa9c45bb88e88461db334c8b933217e3',1,'nc::operator&(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a0c80b9ed3ff24fb25fb794e22a3467e6',1,'nc::operator&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a12d6f6d2a62496d8fe53f8b2daf0b6a8',1,'nc::operator&(const NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_26_26_793',['operator&&',['../namespacenc.html#aa9c15b56f7dc1eb4ce63b15285c7f8b1',1,'nc::operator&&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7f508d7557317498384741bd76fe39d5',1,'nc::operator&&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aa73c70b154a9045312635eb5a9252875',1,'nc::operator&&(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_26_3d_794',['operator&=',['../namespacenc.html#ae104d25f74df02965d9ef6e4a9848659',1,'nc::operator&=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aedc89e1be7f41979fc870006016b6b46',1,'nc::operator&=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_28_29_795',['operator()',['../classnc_1_1_nd_array.html#abf2c4d2e67b692c67e5aed62cd981800',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) noexcept'],['../classnc_1_1_nd_array.html#aac0b806c621ce85a61f1370cc618fcc8',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) const noexcept'],['../classnc_1_1_nd_array.html#a694ed71b52be045362ed9c9ed9d0d5a0',1,'nc::NdArray::operator()(Slice inRowSlice, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#a1583ae58b94d68e101079c4578fe1716',1,'nc::NdArray::operator()(Slice inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#a6ca54f3e1aca253d55dab87e38d21df1',1,'nc::NdArray::operator()(int32 inRowIndex, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#ab2b2913858d7d8427ef5c58ce2caee01',1,'nc::NdArray::operator()(const Indices &rowIndices, int32 colIndex) const'],['../classnc_1_1_nd_array.html#a9c33b3d44d196376aa9511f86c9c860c',1,'nc::NdArray::operator()(const Indices &rowIndices, Slice colSlice) const'],['../classnc_1_1_nd_array.html#a921862c636c42a394cb25d95b2c6e326',1,'nc::NdArray::operator()(int32 rowIndex, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#adfc2050efba624e48733775ae48da8ff',1,'nc::NdArray::operator()(Slice rowSlice, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#ac97b34c8348f6a510820bc3887a088d1',1,'nc::NdArray::operator()(RowIndices rowIndices, ColIndices colIndices) const'],['../classnc_1_1polynomial_1_1_poly1d.html#ac82910d648a2a3cfd2301e12907414dd',1,'nc::polynomial::Poly1d::operator()()']]], + ['operator_2a_796',['operator*',['../namespacenc.html#a8248dae03ae96d459320f42d60fdf424',1,'nc::operator*(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a39b128708b2225a00de527c8ec83d72a',1,'nc::operator*(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#af4f34a2e6e8b9011cb2d2fc5c564e10a',1,'nc::operator*(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a34212756103e0c821034e5469f0f0ed7',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ace6d6bf5d703e886d8f137cf73be5021',1,'nc::operator*(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#abf6f57d9d17019d8756b86bfa1019bc1',1,'nc::operator*(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a72a4a5ad03afcaf6e9f9b7ee6e145a80',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9188c8ea881ad55ea9dc85ae154cbc22',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#adad6ca92266f6090930addc585900805',1,'nc::rotations::Quaternion::operator*()'],['../namespacenc.html#a7865c90c232341c387b0105ac4fdbfd9',1,'nc::operator*(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9a0ff185c891d6c5af3d7150bc645dc8',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#a97a81255a6bb91049b1ad7e7b83e2f7f',1,'nc::rotations::Quaternion::operator*()'],['../namespacenc.html#a1769d68f44f9c98d94dd412bc32a9bb5',1,'nc::operator*(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#af51c9efd8dbadbdc664972bd96583a72',1,'nc::operator*(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#af4ecba4e059c6dcf672644a3c1bff75d',1,'nc::operator*(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#af09d0c6363ef9dc8e661e9254bcf109f',1,'nc::operator*(dtype lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#a10fd2d44927d59f19e37c45586072d14',1,'nc::rotations::Quaternion::operator*(const NdArray< double > &inVec) const'],['../classnc_1_1rotations_1_1_quaternion.html#ad63920fa01f5bd4949c0fbb3ff7c7137',1,'nc::rotations::Quaternion::operator*(double inScalar) const noexcept'],['../classnc_1_1polynomial_1_1_poly1d.html#aab8cce6bf7a9400862d98684de8ef355',1,'nc::polynomial::Poly1d::operator*()'],['../classnc_1_1_nd_array_column_iterator.html#af387e330729ecde7c09d388915ae346a',1,'nc::NdArrayColumnIterator::operator*()'],['../classnc_1_1_nd_array_const_column_iterator.html#ac096213e50279dc023bbf6270c31969a',1,'nc::NdArrayConstColumnIterator::operator*()'],['../classnc_1_1_nd_array_iterator.html#ae1e918bc6718fe1ffa58f7c6a82fbe30',1,'nc::NdArrayIterator::operator*()'],['../classnc_1_1_nd_array_const_iterator.html#ad4ce15f95730d8c089db4f2a26b91090',1,'nc::NdArrayConstIterator::operator*()'],['../namespacenc.html#a199168f4bff489c9ad1d0755e573c6aa',1,'nc::operator*()']]], + ['operator_2a_3d_797',['operator*=',['../classnc_1_1rotations_1_1_quaternion.html#aaaa8a1bd7130e7ce6a819284584a84c5',1,'nc::rotations::Quaternion::operator*=(const Quaternion &inRhs) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a17636913a3a1e810a81a558dc986fd54',1,'nc::rotations::Quaternion::operator*=(double inScalar) noexcept'],['../classnc_1_1_vec2.html#a72ac39ba88f909cb5552f6b379509f81',1,'nc::Vec2::operator*=()'],['../namespacenc.html#af0a3674baebda83b99ba3b18ca4a59d3',1,'nc::operator*=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9211f93baeed5af8e00cfd30628d65f6',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a36c7c3a0be4e8652e52e1710f2808ddd',1,'nc::operator*=(NdArray< dtype > &lhs, dtype rhs)'],['../classnc_1_1_vec3.html#a02ec360e4ebb7b4a6b629eedf8d24a2f',1,'nc::Vec3::operator*=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a06293521430112062f975b4854090d24',1,'nc::polynomial::Poly1d::operator*=()'],['../namespacenc.html#a25ad051c1d98b01675e9c1a52eb8f8c8',1,'nc::operator*=()']]], + ['operator_2b_798',['operator+',['../classnc_1_1_nd_array_const_column_iterator.html#a0375a9e5bb7a8e268d80da41186d58a4',1,'nc::NdArrayConstColumnIterator::operator+()'],['../classnc_1_1_nd_array_column_iterator.html#a6e4c3af43aa00d49305bcd50eaa477e1',1,'nc::NdArrayColumnIterator::operator+()'],['../classnc_1_1polynomial_1_1_poly1d.html#a65afb72ad35683688c7fb71ee77f839e',1,'nc::polynomial::Poly1d::operator+()'],['../classnc_1_1rotations_1_1_quaternion.html#a53c84fdd06a1f980c7c74a185d568156',1,'nc::rotations::Quaternion::operator+()'],['../namespacenc.html#a2fff3527567d94f0a1a62269549ad20a',1,'nc::operator+(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a5a056c387e8726b0612d920bfa55123f',1,'nc::operator+(typename NdArrayConstIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayConstIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a3768e00a52c63b8bbc18d712cb4330c6',1,'nc::operator+(typename NdArrayIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#acb8250110150dfe1c585f48f988d703a',1,'nc::operator+(typename NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a55064001ba08765b1e97962ca82a91cd',1,'nc::NdArrayConstIterator::operator+()'],['../classnc_1_1_nd_array_iterator.html#ab26263e7aa624ed5dd5b0140f2adccb7',1,'nc::NdArrayIterator::operator+()'],['../namespacenc.html#a675deb20abd6aec02f63f72e4c4787dd',1,'nc::operator+(typename NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a98293d4bef0cd036ce30829e7965126e',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aae286fee26a3f654159dca70928e4060',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a44bd86bfac8783b176ecb2242d3ae93f',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a050e6920070ccd078fc357b3ef0198e1',1,'nc::operator+(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#acf7b3bfdc67df0619847cd06cb2f0519',1,'nc::operator+(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#ae7a4dd062b1c5d1f495741e11947f3b5',1,'nc::operator+(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a2d00329ee55367cc78bb5ec002d177cf',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a9c2f64fa5154e84e1b33b518f75b2ee8',1,'nc::operator+(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9f50afa50b63aea110be8b9b477d1cb4',1,'nc::operator+(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a43fad0472de9a72d2680623200138907',1,'nc::operator+(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#ab769651a09123be0a13a54a82aaa088a',1,'nc::operator+(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a5ded64221f16b9a774bc35de58204e28',1,'nc::operator+(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#a26bec2e52fdab966f0f3714d1e2ea8bb',1,'nc::operator+(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#ac6f8a785c25c21f9b4b8328dfd7da6c6',1,'nc::operator+(const Vec3 &lhs, const Vec3 &rhs) noexcept']]], + ['operator_2b_2b_799',['operator++',['../classnc_1_1_nd_array_column_iterator.html#a388ac709c8d2b80c0ed5aa7fbb2047a6',1,'nc::NdArrayColumnIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#abd93d4f21e45188893fcb1c43f907ff0',1,'nc::NdArrayColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a3d40f842cc5345a8f8051ae6bdebe321',1,'nc::NdArrayConstIterator::operator++()'],['../classnc_1_1_nd_array_const_column_iterator.html#a82ded30f6199ce6c9f3630b28e971650',1,'nc::NdArrayConstColumnIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#ad69593e9f3cbf04dff6941bd52827208',1,'nc::NdArrayConstColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_iterator.html#a350b5406b062642ed48d6c3d9d2ce4b9',1,'nc::NdArrayIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#ab832430f99b5ddfed996584e4c354f4a',1,'nc::NdArrayIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#ae955fba21b22639a84b9b030283476a6',1,'nc::NdArrayConstIterator::operator++()'],['../namespacenc.html#ab0ad6a59584ad4f4e277ddedd3c4d476',1,'nc::operator++(NdArray< dtype > &rhs)'],['../namespacenc.html#ad1dfa157bab28851bf97d9982df3f2f3',1,'nc::operator++(NdArray< dtype > &lhs, int)']]], + ['operator_2b_3d_800',['operator+=',['../classnc_1_1_vec3.html#afef859d21f4332089843c5d337c1ce01',1,'nc::Vec3::operator+=()'],['../classnc_1_1_vec2.html#af441d4bbee40c07f9b86fbd056ff637e',1,'nc::Vec2::operator+=()'],['../classnc_1_1_nd_array_const_column_iterator.html#aa6b2701798827af7b54de723628a20d7',1,'nc::NdArrayConstColumnIterator::operator+=()'],['../classnc_1_1_nd_array_iterator.html#af691ece9b6335b8191eeeb43a6168b00',1,'nc::NdArrayIterator::operator+=()'],['../classnc_1_1_nd_array_const_iterator.html#aedc3bbd86f2b1b678abb27109dd50ff6',1,'nc::NdArrayConstIterator::operator+=()'],['../classnc_1_1_vec3.html#a2b1c4e63a7233fb56e2f037807dffb68',1,'nc::Vec3::operator+=()'],['../classnc_1_1_vec2.html#a21b1c9c0aa0b7e8886f1b4a7c255bb9e',1,'nc::Vec2::operator+=()'],['../classnc_1_1rotations_1_1_quaternion.html#af2b75597d538e55cfdd1215c35c9c6fe',1,'nc::rotations::Quaternion::operator+=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a44a0331a1cfc760d7b80bfc20b661366',1,'nc::polynomial::Poly1d::operator+=()'],['../classnc_1_1_nd_array_column_iterator.html#acc186137be7b139f7fdcf323e716e5a0',1,'nc::NdArrayColumnIterator::operator+=()'],['../namespacenc.html#a4f44f946519987633cf47549e5764298',1,'nc::operator+=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aad9f67cc0911a32f877365833eec3f95',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ae11d9ca1ca975cd511b91ddb512dd097',1,'nc::operator+=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7d26cc24b2a68f3ee89c701453e6c9a8',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], + ['operator_2d_801',['operator-',['../classnc_1_1_nd_array_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayColumnIterator::operator-()'],['../classnc_1_1_nd_array_const_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayConstIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_const_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayConstIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_iterator.html#a8bb1505ab1105805bd3ced24b69d17eb',1,'nc::NdArrayIterator::operator-()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayConstColumnIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayConstColumnIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a6dda98c1eba18dff31c9a66f528cd72b',1,'nc::NdArrayColumnIterator::operator-()'],['../classnc_1_1polynomial_1_1_poly1d.html#ade7b4f432e1056bc66d88a131a2cbf41',1,'nc::polynomial::Poly1d::operator-()'],['../classnc_1_1rotations_1_1_quaternion.html#ad6eb2370d77e01a944c4b32a48966e76',1,'nc::rotations::Quaternion::operator-(const Quaternion &inRhs) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a43fe6603ffbaaadf9348910e17e99519',1,'nc::rotations::Quaternion::operator-() const noexcept'],['../classnc_1_1_nd_array_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayColumnIterator::operator-()'],['../namespacenc.html#aae5b14c2febca550101675a55ee5e436',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aea4fe5d4daa75249a7b7765a219cbdb9',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a88d16d314b7e1427529122d2434223e0',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9b0eb6f1f7c4c55004478a3eb99c5367',1,'nc::operator-(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a419f15a00c80bffbe8446892e2015eae',1,'nc::operator-(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1c852c2418c1b5eac6da53972f82233e',1,'nc::operator-(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a305a3e10402251fc06871a84f8941298',1,'nc::operator-(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9d459ed977535f74996fe4820343138d',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a5e63a7dbcbc5bf2e9e5ad41c0169df34',1,'nc::operator-(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a31b3ca85817b7242152028c4fd3f32c3',1,'nc::operator-(const NdArray< dtype > &inArray)'],['../namespacenc.html#a7c52ae6f5c5daf9d27c292e0451cccc3',1,'nc::operator-(const Vec2 &vec) noexcept'],['../namespacenc.html#af29a28cada8fd30111a2c6d41a110ff8',1,'nc::operator-(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#ad279cbad60173006f6883e0d18b0147e',1,'nc::operator-(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a7cf1dfd7144b41f4d748af9fb8aa5ffb',1,'nc::operator-(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a7227073082d530baaf7ebb96ee06995b',1,'nc::operator-(const Vec3 &vec) noexcept'],['../namespacenc.html#a6935362e6d04b73f04c0e8191ae3098d',1,'nc::operator-(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#af87da9c66c9e535066221e4f85f3ed90',1,'nc::operator-(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a7c61e5d343e6439c26abb36db5a0b948',1,'nc::operator-(const Vec3 &lhs, const Vec3 &rhs) noexcept']]], + ['operator_2d_2d_802',['operator--',['../classnc_1_1_nd_array_const_iterator.html#a6061cf25f89e41d3a77d0f4fb0ccc7e2',1,'nc::NdArrayConstIterator::operator--()'],['../namespacenc.html#ab1ac162f983d66eec0f6189325bd1720',1,'nc::operator--(NdArray< dtype > &lhs, int)'],['../namespacenc.html#aa7ea8977a2740af99f4c08c88d7a79e8',1,'nc::operator--(NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array_column_iterator.html#a8ee7c1ecf2dc107159aec64377f5d6bd',1,'nc::NdArrayColumnIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a145c2fa5cbd327fbba7dd4701ef27baf',1,'nc::NdArrayColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a5fea275f4afdd1fca5b59830ce182bff',1,'nc::NdArrayConstColumnIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a9813a585d99eb656cbe7e1e12476d30b',1,'nc::NdArrayConstColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_iterator.html#adcd3b9918db13467bcd234e6f3eec61f',1,'nc::NdArrayIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#a3bcc95583b7a85e5d253b6c830d33ec4',1,'nc::NdArrayIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a526a13c16c0ef08b005f67184f80087a',1,'nc::NdArrayConstIterator::operator--()']]], + ['operator_2d_3d_803',['operator-=',['../classnc_1_1_vec2.html#a13a2bbc2595248211e0bc97de51e13b5',1,'nc::Vec2::operator-=()'],['../namespacenc.html#a9093ebf2aaa2dbc811ae45e77ba52960',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ac870e3973346560eba3380c11f216540',1,'nc::operator-=(NdArray< dtype > &lhs, dtype rhs)'],['../classnc_1_1_vec3.html#a208820649ed763a5dcc9405c4aa481f2',1,'nc::Vec3::operator-=(const Vec3 &rhs) noexcept'],['../classnc_1_1_vec3.html#a70251860269c7cb5becbe988a0b2c48e',1,'nc::Vec3::operator-=(double scaler) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#af68690450642df08758a9e067edeee47',1,'nc::NdArrayConstColumnIterator::operator-=()'],['../classnc_1_1_vec2.html#abfb0b00888fa37d52a895d06f2b39133',1,'nc::Vec2::operator-=()'],['../classnc_1_1rotations_1_1_quaternion.html#a60f1f33144c887cde1338fd80183638f',1,'nc::rotations::Quaternion::operator-=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a732cca31f4b6180d0ad035a6daeb160a',1,'nc::polynomial::Poly1d::operator-=()'],['../classnc_1_1_nd_array_column_iterator.html#a80924e15c192ee04843add79ad2efece',1,'nc::NdArrayColumnIterator::operator-=()'],['../namespacenc.html#aae2f4895eb95921ca77529137e603cd0',1,'nc::operator-=()'],['../classnc_1_1_nd_array_iterator.html#a3ae9bd787a73639f2d0334d87f1fb720',1,'nc::NdArrayIterator::operator-=()'],['../classnc_1_1_nd_array_const_iterator.html#a9ae2efc38005276adaa744e6bec116c3',1,'nc::NdArrayConstIterator::operator-=()'],['../namespacenc.html#a8ba0ad93a3ec2ca409cdb14785e1f679',1,'nc::operator-=()']]], + ['operator_2d_3e_804',['operator->',['../classnc_1_1_nd_array_iterator.html#aa1627ff7d2b0089222794bfebaa29a32',1,'nc::NdArrayIterator::operator->()'],['../classnc_1_1_nd_array_const_iterator.html#a36aee44e67ed7bdc2fd3ca660e1748fa',1,'nc::NdArrayConstIterator::operator->()'],['../classnc_1_1_nd_array_const_column_iterator.html#a33d2e58d269f938c742ac25f46edf008',1,'nc::NdArrayConstColumnIterator::operator->()'],['../classnc_1_1_nd_array_column_iterator.html#ae66efdfa1252f405042276e3e9a25364',1,'nc::NdArrayColumnIterator::operator->()']]], + ['operator_2f_805',['operator/',['../classnc_1_1rotations_1_1_quaternion.html#ab054e067fc333a48582e291f95120866',1,'nc::rotations::Quaternion::operator/()'],['../namespacenc.html#ac8cd599e4b67e78c173894bc3d2bd7f2',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a69481119ed4cf9e7fe41b0c9228693e3',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a4bec4dbe25db0a2ec84e5999458a2c02',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4dda3a7297e38679bf172d870090da1d',1,'nc::operator/(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a04bf5ca073685e762d84932ae14b8caa',1,'nc::operator/(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1eee81e10b382e6b0474508725831a4f',1,'nc::operator/(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a8d2ca407e7579acac2ca6496c4196d15',1,'nc::operator/(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a58862db40468f4be62b860990cf05336',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a06365d71ef5c147fee8e571b9fef7313',1,'nc::operator/(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#abe2fc114afe7f62aacf55a9288f45c4a',1,'nc::operator/(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a0a070b4ec8a29ee1a357c53857d4778a',1,'nc::operator/(const Vec3 &lhs, double rhs) noexcept']]], + ['operator_2f_3d_806',['operator/=',['../classnc_1_1_vec3.html#a431b2ac6af51bf59d804adbe5c8a7700',1,'nc::Vec3::operator/=()'],['../classnc_1_1rotations_1_1_quaternion.html#a859df40774ccff755560604b930c934d',1,'nc::rotations::Quaternion::operator/=()'],['../classnc_1_1_vec2.html#a1a1c875b11ea5571cb2b71778a692472',1,'nc::Vec2::operator/=()'],['../namespacenc.html#ad554e38d21aec306a8e3e4cd4ca990a2',1,'nc::operator/=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a26c691c1a8a6ddea49796591063e7630',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a05414ec63ae42b4a3e9e81ceef072094',1,'nc::operator/=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7bbd0ddf9efe256d0c010e2c481da2d5',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], + ['operator_3c_807',['operator<',['../classnc_1_1image_processing_1_1_pixel.html#a592926833195d4f2587efef12e4b1148',1,'nc::imageProcessing::Pixel::operator<()'],['../classnc_1_1_nd_array_const_iterator.html#a6ae3aca3c7cb79a9fd985c1820b74c39',1,'nc::NdArrayConstIterator::operator<()'],['../classnc_1_1_nd_array_const_column_iterator.html#ab0928638c653f5ed37088a3e5098064b',1,'nc::NdArrayConstColumnIterator::operator<()'],['../namespacenc.html#a6500fd0898086f300bb7909249b3e50f',1,'nc::operator<()'],['../classnc_1_1image_processing_1_1_centroid.html#a093719e81ed5bd5af0cb80dcfd03289f',1,'nc::imageProcessing::Centroid::operator<()'],['../namespacenc.html#a724cd71c78633aa5a757aa76b514f46a',1,'nc::operator<(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#ac1e7489f428b83ed55b5d44963b4eab6',1,'nc::operator<(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a8b68828e75eb8bd91ccdc63e6c39511f',1,'nc::operator<(const NdArray< dtype > &lhs, dtype inValue)']]], + ['operator_3c_3c_808',['operator<<',['../classnc_1_1coordinates_1_1_dec.html#a83e1fb757cb9153e02dcecd2a37976c1',1,'nc::coordinates::Dec::operator<<()'],['../classnc_1_1coordinates_1_1_r_a.html#aa7b5289b9d14da6e7b4393be2fddfc33',1,'nc::coordinates::RA::operator<<()'],['../classnc_1_1_shape.html#a520d818f31bbdacdf8cfbe6de9e88a28',1,'nc::Shape::operator<<()'],['../classnc_1_1_slice.html#ad6889d2df295fef3796aebb769b8cac0',1,'nc::Slice::operator<<()'],['../classnc_1_1rotations_1_1_quaternion.html#a6d11f3a719f010cdd220642d2bb586e6',1,'nc::rotations::Quaternion::operator<<()'],['../classnc_1_1image_processing_1_1_cluster.html#a1b1adec296082d83ee2f87484bfe07cb',1,'nc::imageProcessing::Cluster::operator<<()'],['../classnc_1_1polynomial_1_1_poly1d.html#a589d9ff132413fa86a20f2fa7910e5df',1,'nc::polynomial::Poly1d::operator<<()'],['../classnc_1_1image_processing_1_1_pixel.html#a157a2e98ace3e2185af571a68e5a5b9c',1,'nc::imageProcessing::Pixel::operator<<()'],['../namespacenc.html#aecdda46f9eca3e1f802bb5451ca952cb',1,'nc::operator<<(std::ostream &stream, const Vec2 &vec)'],['../namespacenc.html#a5df285ae528f83294768588fa622d41f',1,'nc::operator<<(std::ostream &inOStream, const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_coordinate.html#aa9e34ee6b7a8425e6af5a715935a4251',1,'nc::coordinates::Coordinate::operator<<()'],['../namespacenc.html#a0cf6f27f323d5bc34b6c56316c480865',1,'nc::operator<<(std::ostream &stream, const Vec3 &vec)'],['../namespacenc.html#a39964568372712a2a5427c44e59ffbe2',1,'nc::operator<<(const NdArray< dtype > &lhs, uint8 inNumBits)'],['../classnc_1_1image_processing_1_1_centroid.html#a787da1f79223e97a2788a2ad47e1c394',1,'nc::imageProcessing::Centroid::operator<<()']]], + ['operator_3c_3c_3d_809',['operator<<=',['../namespacenc.html#a9d82fca424a68c0042594e483b51ced2',1,'nc']]], + ['operator_3c_3d_810',['operator<=',['../classnc_1_1_nd_array_const_column_iterator.html#a8468d6928d88c7f34d1456261331f238',1,'nc::NdArrayConstColumnIterator::operator<=()'],['../classnc_1_1_nd_array_const_iterator.html#a171276f9e90a1336d156c61c2b61bd23',1,'nc::NdArrayConstIterator::operator<=()'],['../namespacenc.html#a9f9bb9e7b4ecf581498351e14f074145',1,'nc::operator<=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a496de942a0d74925ed64972dcb2cffe8',1,'nc::operator<=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4ceffb2e21de23701d431abde8e78592',1,'nc::operator<=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#accb22a9c6f4dc0452020b0a86ef8fdf9',1,'nc::operator<=(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3d_811',['operator=',['../classnc_1_1_nd_array.html#abe4cda5855bc5d6aee488293000d1acb',1,'nc::NdArray::operator=(const NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array.html#a5ff24670b2173fccf1c9a35b688f2683',1,'nc::NdArray::operator=(NdArray< dtype > &&rhs) noexcept'],['../classnc_1_1_nd_array.html#ae5150db09cf7f76269b3254ceb0c43a8',1,'nc::NdArray::operator=(value_type inValue) noexcept']]], + ['operator_3d_3d_812',['operator==',['../classnc_1_1coordinates_1_1_r_a.html#ab9e22496d5fdc265ee5a5d77ec97c184',1,'nc::coordinates::RA::operator==()'],['../classnc_1_1coordinates_1_1_dec.html#a5b264a9d7bb9b2c1b537b03a5eac7265',1,'nc::coordinates::Dec::operator==()'],['../classnc_1_1coordinates_1_1_coordinate.html#a96255907cf1af2c416c7dbe34e96b0d5',1,'nc::coordinates::Coordinate::operator==()'],['../classnc_1_1_vec2.html#af04a7f20ae8ac7a59ae44f7819668fa0',1,'nc::Vec2::operator==()'],['../classnc_1_1_vec3.html#a2cc63855706091881f765b63dcf52c44',1,'nc::Vec3::operator==()'],['../classnc_1_1rotations_1_1_quaternion.html#a82f40acb2292256faffab2b88aa38208',1,'nc::rotations::Quaternion::operator==()'],['../classnc_1_1_nd_array_const_column_iterator.html#aec9953c2361595fc656a1a5d306e36c0',1,'nc::NdArrayConstColumnIterator::operator==()'],['../classnc_1_1_nd_array_const_iterator.html#ac055ccace7f791cfb94d7df8e7100dc2',1,'nc::NdArrayConstIterator::operator==()'],['../classnc_1_1image_processing_1_1_pixel.html#a008757a06c498b1a31e26d53a54e51dc',1,'nc::imageProcessing::Pixel::operator==()'],['../classnc_1_1image_processing_1_1_cluster.html#a8308c5f0313872c9499de36d69d0ff19',1,'nc::imageProcessing::Cluster::operator==()'],['../classnc_1_1image_processing_1_1_centroid.html#a503a2542b388f65fb80710dd33610abc',1,'nc::imageProcessing::Centroid::operator==()'],['../classnc_1_1_slice.html#a769815d8fbb98ba34101c18a21efbbf5',1,'nc::Slice::operator==()'],['../classnc_1_1_shape.html#a0267d8b7eb226fdc442be5c914f9c870',1,'nc::Shape::operator==()'],['../namespacenc.html#a283fba259d2cd892a8cbb2782490b92a',1,'nc::operator==(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aa956dff0507eddc1c1d80e423f126383',1,'nc::operator==(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#afdcaaff39ed10311d74302a6e9be2fd4',1,'nc::operator==(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3e_813',['operator>',['../classnc_1_1_nd_array_const_iterator.html#a8a312e1809eae90df625971d6b4ab62e',1,'nc::NdArrayConstIterator::operator>()'],['../classnc_1_1_nd_array_const_column_iterator.html#a827d0a8431ec616ef0161144b3d24af6',1,'nc::NdArrayConstColumnIterator::operator>()'],['../namespacenc.html#a20910640e1c1dd8bc9298561fedc84a4',1,'nc::operator>(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a5755bb93bff9c0cbd38dbf1296902374',1,'nc::operator>(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7433343db2634ef8f75e290370cfe21e',1,'nc::operator>(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a113de1155a4e2a71dcdad1709c58afe8',1,'nc::operator>(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3e_3d_814',['operator>=',['../classnc_1_1_nd_array_const_iterator.html#a06871d8ba079130e84a892995c07a49a',1,'nc::NdArrayConstIterator::operator>=()'],['../classnc_1_1_nd_array_const_column_iterator.html#a9935c5d4b3deff76207ccde7cfccbf62',1,'nc::NdArrayConstColumnIterator::operator>=()'],['../namespacenc.html#a0dfd9f5c1ec0c3d61959c4c54e6dc23a',1,'nc::operator>=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a48199b1c11d42106cd09ae57215520fe',1,'nc::operator>=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4a32b6c123eaa3f46c14159b243522de',1,'nc::operator>=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#ac453f615df2e03778835908a70907145',1,'nc::operator>=(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3e_3e_815',['operator>>',['../namespacenc.html#a7e6fe3981b55cd4f381339b616a55ec8',1,'nc']]], + ['operator_3e_3e_3d_816',['operator>>=',['../namespacenc.html#a7626eefaf34c6ac138da762c6ae930e7',1,'nc']]], + ['operator_5b_5d_817',['operator[]',['../classnc_1_1_nd_array.html#a0f53f1d4f5b259021cf61026f65759e0',1,'nc::NdArray::operator[](const Indices &inIndices) const'],['../classnc_1_1_nd_array.html#ab04b63c2794747b88b0e640f737c6b2c',1,'nc::NdArray::operator[](const NdArray< bool > &inMask) const'],['../classnc_1_1_nd_array.html#a4744ab68830cc2cc16d8804295662b6a',1,'nc::NdArray::operator[](const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#aeabee2aba11a885f3bd874b7a06d62ea',1,'nc::NdArray::operator[](int32 inIndex) const noexcept'],['../classnc_1_1_nd_array.html#aa58a51df41648b4d39f2f972c60e09ae',1,'nc::NdArray::operator[](int32 inIndex) noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae92d75ae626bb18324b0dfe69ee44f25',1,'nc::imageProcessing::ClusterMaker::operator[]()'],['../classnc_1_1image_processing_1_1_cluster.html#a386b222d5747fc2b77448ea5a56d24e4',1,'nc::imageProcessing::Cluster::operator[]()'],['../classnc_1_1_data_cube.html#a403c0b0df22fc5fa0858109fa7a65f87',1,'nc::DataCube::operator[](uint32 inIndex) const noexcept'],['../classnc_1_1_data_cube.html#a1a16b98e982d79cc6a172b8e2bfad856',1,'nc::DataCube::operator[](uint32 inIndex) noexcept'],['../classnc_1_1_nd_array_iterator.html#a40c132f8a7c1dd9fde17bcd3ddc2a18f',1,'nc::NdArrayIterator::operator[]()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3a37dd5a1496ecf2249950325b0a388c',1,'nc::NdArrayConstColumnIterator::operator[]()'],['../classnc_1_1_nd_array_column_iterator.html#a5dc1514332728850b8fbeaa7d1f8bda0',1,'nc::NdArrayColumnIterator::operator[]()'],['../classnc_1_1_nd_array_const_iterator.html#a83ee672f75e74c4421a25a7816be12c6',1,'nc::NdArrayConstIterator::operator[]()']]], + ['operator_5e_818',['operator^',['../classnc_1_1polynomial_1_1_poly1d.html#a548c945121cb39859f649cf39a6d0830',1,'nc::polynomial::Poly1d::operator^()'],['../namespacenc.html#ae4befd8a03420464348fdfcc71b106bb',1,'nc::operator^(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aa6be940ce9eed012ca0fac881d884411',1,'nc::operator^(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#af4f0fce9397ab714d3567d454f143835',1,'nc::operator^(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_5e_3d_819',['operator^=',['../classnc_1_1polynomial_1_1_poly1d.html#a930f53185992537e3eb5844ebb70bf38',1,'nc::polynomial::Poly1d::operator^=()'],['../namespacenc.html#a8d3d77fe59d533d1301aea0112e38fa8',1,'nc::operator^=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ad4f2748ac9b7ebe59f1592e118169ea7',1,'nc::operator^=(NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_7c_820',['operator|',['../namespacenc.html#a2dd868d584e1d65748cf04957eb97d99',1,'nc::operator|(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a129a0c61ca191919674576a76ee7fd93',1,'nc::operator|(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a50e6d418c92ccd6d7a2cf42a899a2203',1,'nc::operator|(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_7c_3d_821',['operator|=',['../namespacenc.html#a958f4fd964269c7affaaff0e30b4dc01',1,'nc::operator|=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#afbb3e9d2eb28cad36a9de996263067d9',1,'nc::operator|=(NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_7c_7c_822',['operator||',['../namespacenc.html#a25c9ac2d82de1fd3c81890ad38ebfb25',1,'nc::operator||(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#affe1935670d985dfe387f429d68874e2',1,'nc::operator||(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a37ef6f1c023837fbe628c3838b14d940',1,'nc::operator||(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_7e_823',['operator~',['../namespacenc.html#ae9d44b86bb2c2968d5c67f11ca789d3e',1,'nc']]], + ['order_824',['order',['../classnc_1_1polynomial_1_1_poly1d.html#ab978ca2f65c7cd640309c1be86aa9141',1,'nc::polynomial::Poly1d']]], + ['outer_825',['outer',['../namespacenc.html#a395197f9b1d3f53a5fdcd234fa6e6baf',1,'nc']]], + ['outer_2ehpp_826',['outer.hpp',['../outer_8hpp.html',1,'']]], + ['ownsinternaldata_827',['ownsInternalData',['../classnc_1_1_nd_array.html#a63a1c0f9fdef078770e4f8cbe2c249ec',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/all_f.html b/docs/doxygen/html/search/all_f.html index c22b9404d..b23da6ce4 100644 --- a/docs/doxygen/html/search/all_f.html +++ b/docs/doxygen/html/search/all_f.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/all_f.js b/docs/doxygen/html/search/all_f.js index d3cf9a34a..1e45b3b88 100644 --- a/docs/doxygen/html/search/all_f.js +++ b/docs/doxygen/html/search/all_f.js @@ -1,57 +1,60 @@ var searchData= [ - ['pad_781',['pad',['../namespacenc.html#a54ebb23ac2a5fef9013f82afd8efd143',1,'nc']]], - ['pad_2ehpp_782',['pad.hpp',['../pad_8hpp.html',1,'']]], - ['partition_783',['partition',['../namespacenc.html#a4756e923c974025e793ede125bf0902f',1,'nc::partition()'],['../classnc_1_1_nd_array.html#a2fa17d38624fabcae789cfa3323b66d8',1,'nc::NdArray::partition()']]], - ['partition_2ehpp_784',['partition.hpp',['../partition_8hpp.html',1,'']]], - ['peakpixelintensity_785',['peakPixelIntensity',['../classnc_1_1image_processing_1_1_cluster.html#aab51c1c4539c3824bcdbd20a5db1fd4a',1,'nc::imageProcessing::Cluster']]], - ['percentile_786',['percentile',['../namespacenc.html#aea6e5b5c0255660d4968b657b06b4d58',1,'nc']]], - ['percentile_2ehpp_787',['percentile.hpp',['../percentile_8hpp.html',1,'']]], - ['percentilefilter_788',['percentileFilter',['../namespacenc_1_1filter.html#a357d5be7b2dc0b511d398acc4c8af1fd',1,'nc::filter']]], - ['percentilefilter_2ehpp_789',['percentileFilter.hpp',['../percentile_filter_8hpp.html',1,'']]], - ['percentilefilter1d_790',['percentileFilter1d',['../namespacenc_1_1filter.html#aee202739b753a067c7cb2aa32a9b1519',1,'nc::filter']]], - ['percentilefilter1d_2ehpp_791',['percentileFilter1d.hpp',['../percentile_filter1d_8hpp.html',1,'']]], - ['permutation_792',['permutation',['../namespacenc_1_1random.html#ac2ddd4fda3731e5f66378b191804085f',1,'nc::random::permutation(const NdArray< dtype > &inArray)'],['../namespacenc_1_1random.html#a01eed1c9d55b68fa4c93afef918dd3e0',1,'nc::random::permutation(dtype inValue)']]], - ['permutation_2ehpp_793',['permutation.hpp',['../permutation_8hpp.html',1,'']]], - ['pi_794',['pi',['../namespacenc_1_1constants.html#a2f1219a120c9cc1434486d9de75a8221',1,'nc::constants']]], - ['pitch_795',['pitch',['../classnc_1_1rotations_1_1_d_c_m.html#a726e1d9c5e2a88dbd7e70b8fc9d55fbf',1,'nc::rotations::DCM::pitch()'],['../classnc_1_1rotations_1_1_quaternion.html#a601b444c8c8f820700844d7ab5f743ba',1,'nc::rotations::Quaternion::pitch()']]], - ['pivotlu_5fdecomposition_796',['pivotLU_decomposition',['../namespacenc_1_1linalg.html#a390c3d32ed4b8ed7e718cbe121025ebd',1,'nc::linalg']]], - ['pivotlu_5fdecomposition_2ehpp_797',['pivotLU_decomposition.hpp',['../pivot_l_u__decomposition_8hpp.html',1,'']]], - ['pixel_798',['Pixel',['../classnc_1_1image_processing_1_1_pixel.html',1,'nc::imageProcessing::Pixel< dtype >'],['../classnc_1_1image_processing_1_1_pixel.html#a0d7095db72d4478f37d6e371e77509be',1,'nc::imageProcessing::Pixel::Pixel()=default'],['../classnc_1_1image_processing_1_1_pixel.html#a4d1db82b1617d892266270d2bec28f61',1,'nc::imageProcessing::Pixel::Pixel(uint32 inRow, uint32 inCol, dtype inIntensity) noexcept']]], - ['pixel_2ehpp_799',['Pixel.hpp',['../_pixel_8hpp.html',1,'']]], - ['pnr_800',['pnr',['../namespacenc_1_1special.html#ab52643e0c6a859c47871094023c834b5',1,'nc::special']]], - ['pnr_2ehpp_801',['pnr.hpp',['../pnr_8hpp.html',1,'']]], - ['pointer_802',['pointer',['../classnc_1_1_nd_array_column_iterator.html#aeb402bf56941dc24138dc9f33845be81',1,'nc::NdArrayColumnIterator::pointer()'],['../classnc_1_1_nd_array_const_column_iterator.html#a4070d7ef2c99fec46a8df015769f58b6',1,'nc::NdArrayConstColumnIterator::pointer()'],['../classnc_1_1_nd_array.html#a288e6b26205492751717d3fb8854ca30',1,'nc::NdArray::pointer()'],['../classnc_1_1_nd_array_const_iterator.html#a47936ba0f04dbcad7ab4e239bfb7da03',1,'nc::NdArrayConstIterator::pointer()'],['../classnc_1_1_nd_array_iterator.html#a60d5e768fcd13cedd43febeb28148aea',1,'nc::NdArrayIterator::pointer()']]], - ['poisson_803',['poisson',['../namespacenc_1_1random.html#ae18029c16ca489ea9db6331c609b20e8',1,'nc::random::poisson(double inMean=1)'],['../namespacenc_1_1random.html#ae103ffefefe45e4b64067d52a1763f24',1,'nc::random::poisson(const Shape &inShape, double inMean=1)']]], - ['poisson_2ehpp_804',['poisson.hpp',['../poisson_8hpp.html',1,'']]], - ['polar_805',['polar',['../namespacenc.html#abbf3200fe11e4cb7ae6363b00099c2fe',1,'nc::polar(dtype magnitude, dtype phaseAngle)'],['../namespacenc.html#a4f674e5cab66c911b212a5eae86a641b',1,'nc::polar(const NdArray< dtype > &magnitude, const NdArray< dtype > &phaseAngle)']]], - ['polar_2ehpp_806',['polar.hpp',['../polar_8hpp.html',1,'']]], - ['poly1d_807',['Poly1d',['../classnc_1_1polynomial_1_1_poly1d.html',1,'nc::polynomial::Poly1d< dtype >'],['../classnc_1_1polynomial_1_1_poly1d.html#a33c01905d846d32e7d49dc4e7e884551',1,'nc::polynomial::Poly1d::Poly1d(const NdArray< dtype > &inValues, bool isRoots=false)'],['../classnc_1_1polynomial_1_1_poly1d.html#a30777a0dd9351cf64f96959dad0d9ba5',1,'nc::polynomial::Poly1d::Poly1d()=default']]], - ['poly1d_2ehpp_808',['Poly1d.hpp',['../_poly1d_8hpp.html',1,'']]], - ['polygamma_809',['polygamma',['../namespacenc_1_1special.html#a1aab975128b9cfbd175699a9587b34d0',1,'nc::special::polygamma(uint32 n, const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a132b29cd86870cdd360652baeb54c663',1,'nc::special::polygamma(uint32 n, dtype inValue)']]], - ['polygamma_2ehpp_810',['polygamma.hpp',['../polygamma_8hpp.html',1,'']]], - ['polynomial_2ehpp_811',['Polynomial.hpp',['../_polynomial_8hpp.html',1,'']]], - ['pop_5fback_812',['pop_back',['../classnc_1_1_data_cube.html#a8e261e08fd074073771b98dc96726b0f',1,'nc::DataCube']]], - ['positive_813',['POSITIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94aab6c31432785221bae58327ef5f6ea58',1,'nc::coordinates']]], - ['power_814',['power',['../namespacenc.html#a1f059635ecfc805979db6973dfa29008',1,'nc::power()'],['../namespacenc_1_1utils.html#a716a63ef8627c73f6cc4146481fcabdf',1,'nc::utils::power()'],['../namespacenc.html#ad09cd336cd7c12dd32a84c91654fa5d1',1,'nc::power(const NdArray< dtype > &inArray, const NdArray< uint8 > &inExponents)'],['../namespacenc.html#a545b7daab1de503eed95d64b2d6b6002',1,'nc::power(const NdArray< dtype > &inArray, uint8 inExponent)']]], - ['powerf_815',['powerf',['../namespacenc_1_1utils.html#ac113b30b96f9c707c0cbe2eecbabe85f',1,'nc::utils::powerf()'],['../namespacenc.html#a1284308e19d619e53362f5784256c99f',1,'nc::powerf(const NdArray< dtype1 > &inArray, const NdArray< dtype2 > &inExponents)'],['../namespacenc.html#afa339e99c7bf037352cf0f2a0751f7fd',1,'nc::powerf(const NdArray< dtype1 > &inArray, dtype2 inExponent)'],['../namespacenc.html#acc759e42feb1633b521ed7138cf4bfe3',1,'nc::powerf(dtype1 inValue, dtype2 inExponent) noexcept']]], - ['prime_816',['prime',['../namespacenc_1_1special.html#a9fa95a2e2a03a5eff8ea2f9e0594b206',1,'nc::special::prime(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a2e0b9f447fd033ac62a0dfe3eadb46cd',1,'nc::special::prime(uint32 n)']]], - ['prime_2ehpp_817',['prime.hpp',['../prime_8hpp.html',1,'']]], - ['print_818',['print',['../namespacenc.html#aad1fad7ba0ba94b118bdceb29178488b',1,'nc::print()'],['../classnc_1_1coordinates_1_1_coordinate.html#afb451d6e6c10d1f6cacd98bea67850a2',1,'nc::coordinates::Coordinate::print()'],['../classnc_1_1rotations_1_1_quaternion.html#a815d72f9b492ff821077d5d4652b7985',1,'nc::rotations::Quaternion::print()'],['../classnc_1_1polynomial_1_1_poly1d.html#ab17f5e0983d6c66a3419cb331d158395',1,'nc::polynomial::Poly1d::print()'],['../classnc_1_1_nd_array.html#a8729dc551775ca022cbfbf66b22c999b',1,'nc::NdArray::print()'],['../classnc_1_1image_processing_1_1_pixel.html#a3a8fb91578395ef70a5f6038c4c48062',1,'nc::imageProcessing::Pixel::print()'],['../classnc_1_1image_processing_1_1_cluster.html#afdb1943f70f28747a1e83b74de984972',1,'nc::imageProcessing::Cluster::print()'],['../classnc_1_1image_processing_1_1_centroid.html#a139efcdd994d1bacdf62d65b3c427d8d',1,'nc::imageProcessing::Centroid::print()'],['../classnc_1_1coordinates_1_1_dec.html#aaf14d802f311f155310a8efa1bf18567',1,'nc::coordinates::Dec::print()'],['../classnc_1_1coordinates_1_1_r_a.html#a1f935f2825ee66373e5a5b0635851d8e',1,'nc::coordinates::RA::print()'],['../classnc_1_1_slice.html#a24c1eb77b94d3120bb02868cc965c058',1,'nc::Slice::print()'],['../classnc_1_1_shape.html#a494a3d8467911c47d56aa881e11a69f1',1,'nc::Shape::print()']]], - ['print_2ehpp_819',['print.hpp',['../print_8hpp.html',1,'']]], - ['prod_820',['prod',['../namespacenc.html#afadd339ab80158ebd9f1dc294052e58d',1,'nc::prod()'],['../classnc_1_1_nd_array.html#a1a95a48b1434d2260a265d13509f864d',1,'nc::NdArray::prod()']]], - ['prod_2ehpp_821',['prod.hpp',['../prod_8hpp.html',1,'']]], - ['proj_822',['proj',['../namespacenc.html#a7d1c3835da6ff00937ae62a975240957',1,'nc::proj(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a645f790a7dfb01c78317ff23e000db52',1,'nc::proj(const std::complex< dtype > &inValue)']]], - ['proj_2ehpp_823',['proj.hpp',['../proj_8hpp.html',1,'']]], - ['project_824',['project',['../classnc_1_1_vec3.html#aaba2a76701fbf17582641cefeb513f1c',1,'nc::Vec3::project()'],['../classnc_1_1_vec2.html#aa5cb2f954360d7be97c443da16694383',1,'nc::Vec2::project()']]], - ['ptp_825',['ptp',['../namespacenc.html#ae336fd0ff89427cca931a05fd9a9697a',1,'nc::ptp()'],['../classnc_1_1_nd_array.html#aabfb3d013e77626b7e423da910ab9ffb',1,'nc::NdArray::ptp()']]], - ['ptp_2ehpp_826',['ptp.hpp',['../ptp_8hpp.html',1,'']]], - ['push_5fback_827',['push_back',['../classnc_1_1_data_cube.html#a00f652afe3e8734f7d0707b12afd6a65',1,'nc::DataCube']]], - ['put_828',['put',['../classnc_1_1_nd_array.html#aa8f52298436a941b3e53b8204b0b85df',1,'nc::NdArray::put()'],['../namespacenc.html#aa1ecdda42e74eaa37516ee8032a9a84e',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, dtype inValue)'],['../namespacenc.html#a5047b3f195605e63ef655048a8d07279',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a02a06425d6284dbc370807ed11b1f7b2',1,'nc::NdArray::put(int32 inIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#a57e1fc57f28b17f5ba6b421b82066388',1,'nc::NdArray::put(int32 inRow, int32 inCol, value_type inValue)'],['../classnc_1_1_nd_array.html#a6a0bd2406380b080b0ab7565759bb660',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#ae8213735dca5d0ad895138f01aa70947',1,'nc::NdArray::put(const Slice &inSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#ab67c8f364caab7706d32041b2d01012d',1,'nc::NdArray::put(const Slice &inSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a094424d8f368eaa3730102a5f75f0c2e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a2ebd28ce6f5227d42bd5c990a22d9f29',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#a7ae6272ff9d4dea6c890ef6dcbae6eb4',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a17398abb49993b960a33bd14c0db399e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#af062cf00ee693dbd74d0f440b1cbded7',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#ad74b89f5bac37d089ee940ae8c225703',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, const NdArray< dtype > &inValues)']]], - ['put_2ehpp_829',['put.hpp',['../put_8hpp.html',1,'']]], - ['putmask_830',['putmask',['../namespacenc.html#a0ae15cbd793c43445aca3660fc209a0c',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, const NdArray< dtype > &inValues)'],['../namespacenc.html#af6468198b46c36c8a93068c936617725',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, dtype inValue)']]], - ['putmask_831',['putMask',['../classnc_1_1_nd_array.html#aaf9229244e8984f557a823223ac35a29',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a52e65ffbf29d168d53ac7605acb69b4e',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, value_type inValue)']]], - ['putmask_2ehpp_832',['putmask.hpp',['../putmask_8hpp.html',1,'']]], - ['pybindinterface_2ehpp_833',['PybindInterface.hpp',['../_pybind_interface_8hpp.html',1,'']]], - ['pythoninterface_2ehpp_834',['PythonInterface.hpp',['../_python_interface_8hpp.html',1,'']]] + ['pad_828',['pad',['../namespacenc.html#a54ebb23ac2a5fef9013f82afd8efd143',1,'nc']]], + ['pad_2ehpp_829',['pad.hpp',['../pad_8hpp.html',1,'']]], + ['partition_830',['partition',['../classnc_1_1_nd_array.html#a2fa17d38624fabcae789cfa3323b66d8',1,'nc::NdArray::partition()'],['../namespacenc.html#a4756e923c974025e793ede125bf0902f',1,'nc::partition()']]], + ['partition_2ehpp_831',['partition.hpp',['../partition_8hpp.html',1,'']]], + ['peakpixelintensity_832',['peakPixelIntensity',['../classnc_1_1image_processing_1_1_cluster.html#aab51c1c4539c3824bcdbd20a5db1fd4a',1,'nc::imageProcessing::Cluster']]], + ['percentile_833',['percentile',['../namespacenc.html#aea6e5b5c0255660d4968b657b06b4d58',1,'nc']]], + ['percentile_2ehpp_834',['percentile.hpp',['../percentile_8hpp.html',1,'']]], + ['percentilefilter_835',['percentileFilter',['../namespacenc_1_1filter.html#a357d5be7b2dc0b511d398acc4c8af1fd',1,'nc::filter']]], + ['percentilefilter_2ehpp_836',['percentileFilter.hpp',['../percentile_filter_8hpp.html',1,'']]], + ['percentilefilter1d_837',['percentileFilter1d',['../namespacenc_1_1filter.html#aee202739b753a067c7cb2aa32a9b1519',1,'nc::filter']]], + ['percentilefilter1d_2ehpp_838',['percentileFilter1d.hpp',['../percentile_filter1d_8hpp.html',1,'']]], + ['permutation_839',['permutation',['../namespacenc_1_1random.html#ac2ddd4fda3731e5f66378b191804085f',1,'nc::random::permutation(const NdArray< dtype > &inArray)'],['../namespacenc_1_1random.html#a01eed1c9d55b68fa4c93afef918dd3e0',1,'nc::random::permutation(dtype inValue)']]], + ['permutation_2ehpp_840',['permutation.hpp',['../permutation_8hpp.html',1,'']]], + ['pi_841',['pi',['../namespacenc_1_1constants.html#a2f1219a120c9cc1434486d9de75a8221',1,'nc::constants']]], + ['pitch_842',['pitch',['../classnc_1_1rotations_1_1_d_c_m.html#a726e1d9c5e2a88dbd7e70b8fc9d55fbf',1,'nc::rotations::DCM::pitch()'],['../classnc_1_1rotations_1_1_quaternion.html#a601b444c8c8f820700844d7ab5f743ba',1,'nc::rotations::Quaternion::pitch()']]], + ['pivotlu_5fdecomposition_843',['pivotLU_decomposition',['../namespacenc_1_1linalg.html#a390c3d32ed4b8ed7e718cbe121025ebd',1,'nc::linalg']]], + ['pivotlu_5fdecomposition_2ehpp_844',['pivotLU_decomposition.hpp',['../pivot_l_u__decomposition_8hpp.html',1,'']]], + ['pixel_845',['Pixel',['../classnc_1_1image_processing_1_1_pixel.html',1,'nc::imageProcessing::Pixel< dtype >'],['../classnc_1_1image_processing_1_1_pixel.html#a0d7095db72d4478f37d6e371e77509be',1,'nc::imageProcessing::Pixel::Pixel()=default'],['../classnc_1_1image_processing_1_1_pixel.html#a4d1db82b1617d892266270d2bec28f61',1,'nc::imageProcessing::Pixel::Pixel(uint32 inRow, uint32 inCol, dtype inIntensity) noexcept']]], + ['pixel_2ehpp_846',['Pixel.hpp',['../_pixel_8hpp.html',1,'']]], + ['place_847',['place',['../namespacenc.html#a171da00c79cfbc9500916b6ac4d3de70',1,'nc']]], + ['place_2ehpp_848',['place.hpp',['../place_8hpp.html',1,'']]], + ['pnr_849',['pnr',['../namespacenc_1_1special.html#ab52643e0c6a859c47871094023c834b5',1,'nc::special']]], + ['pnr_2ehpp_850',['pnr.hpp',['../pnr_8hpp.html',1,'']]], + ['pointer_851',['pointer',['../classnc_1_1_nd_array_iterator.html#a60d5e768fcd13cedd43febeb28148aea',1,'nc::NdArrayIterator::pointer()'],['../classnc_1_1_nd_array_column_iterator.html#aeb402bf56941dc24138dc9f33845be81',1,'nc::NdArrayColumnIterator::pointer()'],['../classnc_1_1_nd_array_const_iterator.html#a47936ba0f04dbcad7ab4e239bfb7da03',1,'nc::NdArrayConstIterator::pointer()'],['../classnc_1_1_nd_array_const_column_iterator.html#a4070d7ef2c99fec46a8df015769f58b6',1,'nc::NdArrayConstColumnIterator::pointer()'],['../classnc_1_1_nd_array.html#a288e6b26205492751717d3fb8854ca30',1,'nc::NdArray::pointer()']]], + ['poisson_852',['poisson',['../namespacenc_1_1random.html#ae18029c16ca489ea9db6331c609b20e8',1,'nc::random::poisson(double inMean=1)'],['../namespacenc_1_1random.html#ae103ffefefe45e4b64067d52a1763f24',1,'nc::random::poisson(const Shape &inShape, double inMean=1)']]], + ['poisson_2ehpp_853',['poisson.hpp',['../poisson_8hpp.html',1,'']]], + ['polar_854',['polar',['../namespacenc.html#abbf3200fe11e4cb7ae6363b00099c2fe',1,'nc::polar(dtype magnitude, dtype phaseAngle)'],['../namespacenc.html#a4f674e5cab66c911b212a5eae86a641b',1,'nc::polar(const NdArray< dtype > &magnitude, const NdArray< dtype > &phaseAngle)']]], + ['polar_2ehpp_855',['polar.hpp',['../polar_8hpp.html',1,'']]], + ['poly1d_856',['Poly1d',['../classnc_1_1polynomial_1_1_poly1d.html',1,'nc::polynomial::Poly1d< dtype >'],['../classnc_1_1polynomial_1_1_poly1d.html#a33c01905d846d32e7d49dc4e7e884551',1,'nc::polynomial::Poly1d::Poly1d(const NdArray< dtype > &inValues, bool isRoots=false)'],['../classnc_1_1polynomial_1_1_poly1d.html#a30777a0dd9351cf64f96959dad0d9ba5',1,'nc::polynomial::Poly1d::Poly1d()=default']]], + ['poly1d_2ehpp_857',['Poly1d.hpp',['../_poly1d_8hpp.html',1,'']]], + ['polygamma_858',['polygamma',['../namespacenc_1_1special.html#a132b29cd86870cdd360652baeb54c663',1,'nc::special::polygamma(uint32 n, dtype inValue)'],['../namespacenc_1_1special.html#a1aab975128b9cfbd175699a9587b34d0',1,'nc::special::polygamma(uint32 n, const NdArray< dtype > &inArray)']]], + ['polygamma_2ehpp_859',['polygamma.hpp',['../polygamma_8hpp.html',1,'']]], + ['polynomial_2ehpp_860',['Polynomial.hpp',['../_polynomial_8hpp.html',1,'']]], + ['pop_5fback_861',['pop_back',['../classnc_1_1_data_cube.html#a8e261e08fd074073771b98dc96726b0f',1,'nc::DataCube']]], + ['positive_862',['POSITIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94aab6c31432785221bae58327ef5f6ea58',1,'nc::coordinates']]], + ['power_863',['power',['../namespacenc.html#a545b7daab1de503eed95d64b2d6b6002',1,'nc::power()'],['../namespacenc_1_1utils.html#a716a63ef8627c73f6cc4146481fcabdf',1,'nc::utils::power()'],['../namespacenc.html#a1f059635ecfc805979db6973dfa29008',1,'nc::power(dtype inValue, uint8 inExponent) noexcept'],['../namespacenc.html#ad09cd336cd7c12dd32a84c91654fa5d1',1,'nc::power(const NdArray< dtype > &inArray, const NdArray< uint8 > &inExponents)']]], + ['powerf_864',['powerf',['../namespacenc_1_1utils.html#ac113b30b96f9c707c0cbe2eecbabe85f',1,'nc::utils::powerf()'],['../namespacenc.html#a1284308e19d619e53362f5784256c99f',1,'nc::powerf(const NdArray< dtype1 > &inArray, const NdArray< dtype2 > &inExponents)'],['../namespacenc.html#acc759e42feb1633b521ed7138cf4bfe3',1,'nc::powerf(dtype1 inValue, dtype2 inExponent) noexcept'],['../namespacenc.html#afa339e99c7bf037352cf0f2a0751f7fd',1,'nc::powerf(const NdArray< dtype1 > &inArray, dtype2 inExponent)']]], + ['powersoftwo_865',['powersOfTwo',['../namespacenc_1_1edac_1_1detail.html#ad4328ffa9ba9949a9c4b494592496055',1,'nc::edac::detail']]], + ['prime_866',['prime',['../namespacenc_1_1special.html#a2e0b9f447fd033ac62a0dfe3eadb46cd',1,'nc::special::prime(uint32 n)'],['../namespacenc_1_1special.html#a9fa95a2e2a03a5eff8ea2f9e0594b206',1,'nc::special::prime(const NdArray< uint32 > &inArray)']]], + ['prime_2ehpp_867',['prime.hpp',['../prime_8hpp.html',1,'']]], + ['print_868',['print',['../classnc_1_1rotations_1_1_quaternion.html#a815d72f9b492ff821077d5d4652b7985',1,'nc::rotations::Quaternion::print()'],['../classnc_1_1polynomial_1_1_poly1d.html#ab17f5e0983d6c66a3419cb331d158395',1,'nc::polynomial::Poly1d::print()'],['../classnc_1_1_nd_array.html#a8729dc551775ca022cbfbf66b22c999b',1,'nc::NdArray::print()'],['../classnc_1_1image_processing_1_1_pixel.html#a3a8fb91578395ef70a5f6038c4c48062',1,'nc::imageProcessing::Pixel::print()'],['../classnc_1_1image_processing_1_1_cluster.html#afdb1943f70f28747a1e83b74de984972',1,'nc::imageProcessing::Cluster::print()'],['../classnc_1_1coordinates_1_1_dec.html#aaf14d802f311f155310a8efa1bf18567',1,'nc::coordinates::Dec::print()'],['../classnc_1_1image_processing_1_1_centroid.html#a139efcdd994d1bacdf62d65b3c427d8d',1,'nc::imageProcessing::Centroid::print()'],['../classnc_1_1_slice.html#a24c1eb77b94d3120bb02868cc965c058',1,'nc::Slice::print()'],['../classnc_1_1_shape.html#a494a3d8467911c47d56aa881e11a69f1',1,'nc::Shape::print()'],['../classnc_1_1coordinates_1_1_r_a.html#a1f935f2825ee66373e5a5b0635851d8e',1,'nc::coordinates::RA::print()'],['../classnc_1_1coordinates_1_1_coordinate.html#afb451d6e6c10d1f6cacd98bea67850a2',1,'nc::coordinates::Coordinate::print()'],['../namespacenc.html#aad1fad7ba0ba94b118bdceb29178488b',1,'nc::print()']]], + ['print_2ehpp_869',['print.hpp',['../print_8hpp.html',1,'']]], + ['prod_870',['prod',['../classnc_1_1_nd_array.html#a1a95a48b1434d2260a265d13509f864d',1,'nc::NdArray::prod()'],['../namespacenc.html#afadd339ab80158ebd9f1dc294052e58d',1,'nc::prod()']]], + ['prod_2ehpp_871',['prod.hpp',['../prod_8hpp.html',1,'']]], + ['proj_872',['proj',['../namespacenc.html#a645f790a7dfb01c78317ff23e000db52',1,'nc::proj(const std::complex< dtype > &inValue)'],['../namespacenc.html#a7d1c3835da6ff00937ae62a975240957',1,'nc::proj(const NdArray< std::complex< dtype >> &inArray)']]], + ['proj_2ehpp_873',['proj.hpp',['../proj_8hpp.html',1,'']]], + ['project_874',['project',['../classnc_1_1_vec3.html#aaba2a76701fbf17582641cefeb513f1c',1,'nc::Vec3::project()'],['../classnc_1_1_vec2.html#aa5cb2f954360d7be97c443da16694383',1,'nc::Vec2::project()']]], + ['ptp_875',['ptp',['../classnc_1_1_nd_array.html#aabfb3d013e77626b7e423da910ab9ffb',1,'nc::NdArray::ptp()'],['../namespacenc.html#ae336fd0ff89427cca931a05fd9a9697a',1,'nc::ptp()']]], + ['ptp_2ehpp_876',['ptp.hpp',['../ptp_8hpp.html',1,'']]], + ['push_5fback_877',['push_back',['../classnc_1_1_data_cube.html#a00f652afe3e8734f7d0707b12afd6a65',1,'nc::DataCube']]], + ['put_878',['put',['../classnc_1_1_nd_array.html#ab67c8f364caab7706d32041b2d01012d',1,'nc::NdArray::put(const Slice &inSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a02a06425d6284dbc370807ed11b1f7b2',1,'nc::NdArray::put(int32 inIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#a094424d8f368eaa3730102a5f75f0c2e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a7ae6272ff9d4dea6c890ef6dcbae6eb4',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a17398abb49993b960a33bd14c0db399e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#af062cf00ee693dbd74d0f440b1cbded7',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#ad74b89f5bac37d089ee940ae8c225703',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a2ebd28ce6f5227d42bd5c990a22d9f29',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#aa8f52298436a941b3e53b8204b0b85df',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, value_type inValue)'],['../classnc_1_1_nd_array.html#a57e1fc57f28b17f5ba6b421b82066388',1,'nc::NdArray::put(int32 inRow, int32 inCol, value_type inValue)'],['../classnc_1_1_nd_array.html#a6a0bd2406380b080b0ab7565759bb660',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#ae8213735dca5d0ad895138f01aa70947',1,'nc::NdArray::put(const Slice &inSlice, value_type inValue)'],['../namespacenc.html#aa1ecdda42e74eaa37516ee8032a9a84e',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, dtype inValue)'],['../namespacenc.html#a5047b3f195605e63ef655048a8d07279',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)']]], + ['put_2ehpp_879',['put.hpp',['../put_8hpp.html',1,'']]], + ['putmask_880',['putMask',['../classnc_1_1_nd_array.html#a52e65ffbf29d168d53ac7605acb69b4e',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, value_type inValue)'],['../classnc_1_1_nd_array.html#aaf9229244e8984f557a823223ac35a29',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, const NdArray< dtype > &inValues)']]], + ['putmask_881',['putmask',['../namespacenc.html#af6468198b46c36c8a93068c936617725',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, dtype inValue)'],['../namespacenc.html#a0ae15cbd793c43445aca3660fc209a0c',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, const NdArray< dtype > &inValues)']]], + ['putmask_2ehpp_882',['putmask.hpp',['../putmask_8hpp.html',1,'']]], + ['pybindinterface_2ehpp_883',['PybindInterface.hpp',['../_pybind_interface_8hpp.html',1,'']]], + ['pythoninterface_2ehpp_884',['PythonInterface.hpp',['../_python_interface_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/classes_0.html b/docs/doxygen/html/search/classes_0.html index 63d78fe69..af8159ee6 100644 --- a/docs/doxygen/html/search/classes_0.html +++ b/docs/doxygen/html/search/classes_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_0.js b/docs/doxygen/html/search/classes_0.js index 7eddb8a2d..abcf88197 100644 --- a/docs/doxygen/html/search/classes_0.js +++ b/docs/doxygen/html/search/classes_0.js @@ -1,9 +1,9 @@ var searchData= [ - ['all_5farithmetic_1159',['all_arithmetic',['../structnc_1_1all__arithmetic.html',1,'nc']]], - ['all_5farithmetic_3c_20head_2c_20tail_2e_2e_2e_20_3e_1160',['all_arithmetic< Head, Tail... >',['../structnc_1_1all__arithmetic_3_01_head_00_01_tail_8_8_8_01_4.html',1,'nc']]], - ['all_5farithmetic_3c_20t_20_3e_1161',['all_arithmetic< T >',['../structnc_1_1all__arithmetic_3_01_t_01_4.html',1,'nc']]], - ['all_5fsame_1162',['all_same',['../structnc_1_1all__same.html',1,'nc']]], - ['all_5fsame_3c_20t1_2c_20head_2c_20tail_2e_2e_2e_20_3e_1163',['all_same< T1, Head, Tail... >',['../structnc_1_1all__same_3_01_t1_00_01_head_00_01_tail_8_8_8_01_4.html',1,'nc']]], - ['all_5fsame_3c_20t1_2c_20t2_20_3e_1164',['all_same< T1, T2 >',['../structnc_1_1all__same_3_01_t1_00_01_t2_01_4.html',1,'nc']]] + ['all_5farithmetic_1210',['all_arithmetic',['../structnc_1_1all__arithmetic.html',1,'nc']]], + ['all_5farithmetic_3c_20head_2c_20tail_2e_2e_2e_20_3e_1211',['all_arithmetic< Head, Tail... >',['../structnc_1_1all__arithmetic_3_01_head_00_01_tail_8_8_8_01_4.html',1,'nc']]], + ['all_5farithmetic_3c_20t_20_3e_1212',['all_arithmetic< T >',['../structnc_1_1all__arithmetic_3_01_t_01_4.html',1,'nc']]], + ['all_5fsame_1213',['all_same',['../structnc_1_1all__same.html',1,'nc']]], + ['all_5fsame_3c_20t1_2c_20head_2c_20tail_2e_2e_2e_20_3e_1214',['all_same< T1, Head, Tail... >',['../structnc_1_1all__same_3_01_t1_00_01_head_00_01_tail_8_8_8_01_4.html',1,'nc']]], + ['all_5fsame_3c_20t1_2c_20t2_20_3e_1215',['all_same< T1, T2 >',['../structnc_1_1all__same_3_01_t1_00_01_t2_01_4.html',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/classes_1.html b/docs/doxygen/html/search/classes_1.html index 1a5618cfc..576e91689 100644 --- a/docs/doxygen/html/search/classes_1.html +++ b/docs/doxygen/html/search/classes_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_1.js b/docs/doxygen/html/search/classes_1.js index 658d6bb25..bb158b7f3 100644 --- a/docs/doxygen/html/search/classes_1.js +++ b/docs/doxygen/html/search/classes_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['bisection_1165',['Bisection',['../classnc_1_1roots_1_1_bisection.html',1,'nc::roots']]], - ['brent_1166',['Brent',['../classnc_1_1roots_1_1_brent.html',1,'nc::roots']]] + ['bisection_1216',['Bisection',['../classnc_1_1roots_1_1_bisection.html',1,'nc::roots']]], + ['brent_1217',['Brent',['../classnc_1_1roots_1_1_brent.html',1,'nc::roots']]] ]; diff --git a/docs/doxygen/html/search/classes_2.html b/docs/doxygen/html/search/classes_2.html index 455fc5fed..956405e5a 100644 --- a/docs/doxygen/html/search/classes_2.html +++ b/docs/doxygen/html/search/classes_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_2.js b/docs/doxygen/html/search/classes_2.js index ece7f4296..c33b6e099 100644 --- a/docs/doxygen/html/search/classes_2.js +++ b/docs/doxygen/html/search/classes_2.js @@ -1,7 +1,7 @@ var searchData= [ - ['centroid_1167',['Centroid',['../classnc_1_1image_processing_1_1_centroid.html',1,'nc::imageProcessing']]], - ['cluster_1168',['Cluster',['../classnc_1_1image_processing_1_1_cluster.html',1,'nc::imageProcessing']]], - ['clustermaker_1169',['ClusterMaker',['../classnc_1_1image_processing_1_1_cluster_maker.html',1,'nc::imageProcessing']]], - ['coordinate_1170',['Coordinate',['../classnc_1_1coordinates_1_1_coordinate.html',1,'nc::coordinates']]] + ['centroid_1218',['Centroid',['../classnc_1_1image_processing_1_1_centroid.html',1,'nc::imageProcessing']]], + ['cluster_1219',['Cluster',['../classnc_1_1image_processing_1_1_cluster.html',1,'nc::imageProcessing']]], + ['clustermaker_1220',['ClusterMaker',['../classnc_1_1image_processing_1_1_cluster_maker.html',1,'nc::imageProcessing']]], + ['coordinate_1221',['Coordinate',['../classnc_1_1coordinates_1_1_coordinate.html',1,'nc::coordinates']]] ]; diff --git a/docs/doxygen/html/search/classes_3.html b/docs/doxygen/html/search/classes_3.html index a7139980b..d33343bc1 100644 --- a/docs/doxygen/html/search/classes_3.html +++ b/docs/doxygen/html/search/classes_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_3.js b/docs/doxygen/html/search/classes_3.js index 300d431d3..719220c06 100644 --- a/docs/doxygen/html/search/classes_3.js +++ b/docs/doxygen/html/search/classes_3.js @@ -1,9 +1,9 @@ var searchData= [ - ['datacube_1171',['DataCube',['../classnc_1_1_data_cube.html',1,'nc']]], - ['dcm_1172',['DCM',['../classnc_1_1rotations_1_1_d_c_m.html',1,'nc::rotations']]], - ['dec_1173',['Dec',['../classnc_1_1coordinates_1_1_dec.html',1,'nc::coordinates']]], - ['dekker_1174',['Dekker',['../classnc_1_1roots_1_1_dekker.html',1,'nc::roots']]], - ['dtypeinfo_1175',['DtypeInfo',['../classnc_1_1_dtype_info.html',1,'nc']]], - ['dtypeinfo_3c_20std_3a_3acomplex_3c_20dtype_20_3e_20_3e_1176',['DtypeInfo< std::complex< dtype > >',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html',1,'nc']]] + ['datacube_1222',['DataCube',['../classnc_1_1_data_cube.html',1,'nc']]], + ['dcm_1223',['DCM',['../classnc_1_1rotations_1_1_d_c_m.html',1,'nc::rotations']]], + ['dec_1224',['Dec',['../classnc_1_1coordinates_1_1_dec.html',1,'nc::coordinates']]], + ['dekker_1225',['Dekker',['../classnc_1_1roots_1_1_dekker.html',1,'nc::roots']]], + ['dtypeinfo_1226',['DtypeInfo',['../classnc_1_1_dtype_info.html',1,'nc']]], + ['dtypeinfo_3c_20std_3a_3acomplex_3c_20dtype_20_3e_20_3e_1227',['DtypeInfo< std::complex< dtype > >',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/classes_4.html b/docs/doxygen/html/search/classes_4.html index cb0026fdf..8430b07fe 100644 --- a/docs/doxygen/html/search/classes_4.html +++ b/docs/doxygen/html/search/classes_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_4.js b/docs/doxygen/html/search/classes_4.js index 1fa4ff4af..ec38c6a68 100644 --- a/docs/doxygen/html/search/classes_4.js +++ b/docs/doxygen/html/search/classes_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['file_1177',['File',['../classnc_1_1filesystem_1_1_file.html',1,'nc::filesystem']]] + ['file_1228',['File',['../classnc_1_1filesystem_1_1_file.html',1,'nc::filesystem']]] ]; diff --git a/docs/doxygen/html/search/classes_5.html b/docs/doxygen/html/search/classes_5.html index b77826f89..c2f1b767b 100644 --- a/docs/doxygen/html/search/classes_5.html +++ b/docs/doxygen/html/search/classes_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_5.js b/docs/doxygen/html/search/classes_5.js index 20bb24bd1..1b04c1b49 100644 --- a/docs/doxygen/html/search/classes_5.js +++ b/docs/doxygen/html/search/classes_5.js @@ -1,7 +1,4 @@ var searchData= [ - ['is_5fcomplex_1178',['is_complex',['../structnc_1_1is__complex.html',1,'nc']]], - ['is_5fcomplex_3c_20std_3a_3acomplex_3c_20t_20_3e_20_3e_1179',['is_complex< std::complex< T > >',['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html',1,'nc']]], - ['is_5fvalid_5fdtype_1180',['is_valid_dtype',['../structnc_1_1is__valid__dtype.html',1,'nc']]], - ['iteration_1181',['Iteration',['../classnc_1_1roots_1_1_iteration.html',1,'nc::roots']]] + ['greaterthan_1229',['greaterThan',['../structnc_1_1greater_than.html',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/classes_6.html b/docs/doxygen/html/search/classes_6.html index 99e860317..e39847ce8 100644 --- a/docs/doxygen/html/search/classes_6.html +++ b/docs/doxygen/html/search/classes_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_6.js b/docs/doxygen/html/search/classes_6.js index 6009393bb..2ce1a1372 100644 --- a/docs/doxygen/html/search/classes_6.js +++ b/docs/doxygen/html/search/classes_6.js @@ -1,4 +1,7 @@ var searchData= [ - ['legendrepolynomial_1182',['LegendrePolynomial',['../classnc_1_1integrate_1_1_legendre_polynomial.html',1,'nc::integrate']]] + ['is_5fcomplex_1230',['is_complex',['../structnc_1_1is__complex.html',1,'nc']]], + ['is_5fcomplex_3c_20std_3a_3acomplex_3c_20t_20_3e_20_3e_1231',['is_complex< std::complex< T > >',['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html',1,'nc']]], + ['is_5fvalid_5fdtype_1232',['is_valid_dtype',['../structnc_1_1is__valid__dtype.html',1,'nc']]], + ['iteration_1233',['Iteration',['../classnc_1_1roots_1_1_iteration.html',1,'nc::roots']]] ]; diff --git a/docs/doxygen/html/search/classes_7.html b/docs/doxygen/html/search/classes_7.html index 7d1ae6d84..a2c4d1a39 100644 --- a/docs/doxygen/html/search/classes_7.html +++ b/docs/doxygen/html/search/classes_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_7.js b/docs/doxygen/html/search/classes_7.js index 2d1c45d43..4bd20487c 100644 --- a/docs/doxygen/html/search/classes_7.js +++ b/docs/doxygen/html/search/classes_7.js @@ -1,9 +1,4 @@ var searchData= [ - ['ndarray_1183',['NdArray',['../classnc_1_1_nd_array.html',1,'nc']]], - ['ndarraycolumniterator_1184',['NdArrayColumnIterator',['../classnc_1_1_nd_array_column_iterator.html',1,'nc']]], - ['ndarrayconstcolumniterator_1185',['NdArrayConstColumnIterator',['../classnc_1_1_nd_array_const_column_iterator.html',1,'nc']]], - ['ndarrayconstiterator_1186',['NdArrayConstIterator',['../classnc_1_1_nd_array_const_iterator.html',1,'nc']]], - ['ndarrayiterator_1187',['NdArrayIterator',['../classnc_1_1_nd_array_iterator.html',1,'nc']]], - ['newton_1188',['Newton',['../classnc_1_1roots_1_1_newton.html',1,'nc::roots']]] + ['legendrepolynomial_1234',['LegendrePolynomial',['../classnc_1_1integrate_1_1_legendre_polynomial.html',1,'nc::integrate']]] ]; diff --git a/docs/doxygen/html/search/classes_8.html b/docs/doxygen/html/search/classes_8.html index 13aea8536..17003e480 100644 --- a/docs/doxygen/html/search/classes_8.html +++ b/docs/doxygen/html/search/classes_8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_8.js b/docs/doxygen/html/search/classes_8.js index b3e0e784a..a39d700de 100644 --- a/docs/doxygen/html/search/classes_8.js +++ b/docs/doxygen/html/search/classes_8.js @@ -1,5 +1,11 @@ var searchData= [ - ['pixel_1189',['Pixel',['../classnc_1_1image_processing_1_1_pixel.html',1,'nc::imageProcessing']]], - ['poly1d_1190',['Poly1d',['../classnc_1_1polynomial_1_1_poly1d.html',1,'nc::polynomial']]] + ['ndarray_1235',['NdArray',['../classnc_1_1_nd_array.html',1,'nc']]], + ['ndarray_3c_20bool_20_3e_1236',['NdArray< bool >',['../classnc_1_1_nd_array.html',1,'nc']]], + ['ndarray_3c_20double_20_3e_1237',['NdArray< double >',['../classnc_1_1_nd_array.html',1,'nc']]], + ['ndarraycolumniterator_1238',['NdArrayColumnIterator',['../classnc_1_1_nd_array_column_iterator.html',1,'nc']]], + ['ndarrayconstcolumniterator_1239',['NdArrayConstColumnIterator',['../classnc_1_1_nd_array_const_column_iterator.html',1,'nc']]], + ['ndarrayconstiterator_1240',['NdArrayConstIterator',['../classnc_1_1_nd_array_const_iterator.html',1,'nc']]], + ['ndarrayiterator_1241',['NdArrayIterator',['../classnc_1_1_nd_array_iterator.html',1,'nc']]], + ['newton_1242',['Newton',['../classnc_1_1roots_1_1_newton.html',1,'nc::roots']]] ]; diff --git a/docs/doxygen/html/search/classes_9.html b/docs/doxygen/html/search/classes_9.html index da92743b2..b8afa8cba 100644 --- a/docs/doxygen/html/search/classes_9.html +++ b/docs/doxygen/html/search/classes_9.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_9.js b/docs/doxygen/html/search/classes_9.js index 8aefb0531..df70c3d2e 100644 --- a/docs/doxygen/html/search/classes_9.js +++ b/docs/doxygen/html/search/classes_9.js @@ -1,4 +1,5 @@ var searchData= [ - ['quaternion_1191',['Quaternion',['../classnc_1_1rotations_1_1_quaternion.html',1,'nc::rotations']]] + ['pixel_1243',['Pixel',['../classnc_1_1image_processing_1_1_pixel.html',1,'nc::imageProcessing']]], + ['poly1d_1244',['Poly1d',['../classnc_1_1polynomial_1_1_poly1d.html',1,'nc::polynomial']]] ]; diff --git a/docs/doxygen/html/search/classes_a.html b/docs/doxygen/html/search/classes_a.html index 44f1dcea5..6788af270 100644 --- a/docs/doxygen/html/search/classes_a.html +++ b/docs/doxygen/html/search/classes_a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_a.js b/docs/doxygen/html/search/classes_a.js index 775c24b48..48135d7bb 100644 --- a/docs/doxygen/html/search/classes_a.js +++ b/docs/doxygen/html/search/classes_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['ra_1192',['RA',['../classnc_1_1coordinates_1_1_r_a.html',1,'nc::coordinates']]] + ['quaternion_1245',['Quaternion',['../classnc_1_1rotations_1_1_quaternion.html',1,'nc::rotations']]] ]; diff --git a/docs/doxygen/html/search/classes_b.html b/docs/doxygen/html/search/classes_b.html index 6de43930e..3fcb49858 100644 --- a/docs/doxygen/html/search/classes_b.html +++ b/docs/doxygen/html/search/classes_b.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_b.js b/docs/doxygen/html/search/classes_b.js index fd319d60e..4ea6b556e 100644 --- a/docs/doxygen/html/search/classes_b.js +++ b/docs/doxygen/html/search/classes_b.js @@ -1,7 +1,4 @@ var searchData= [ - ['secant_1193',['Secant',['../classnc_1_1roots_1_1_secant.html',1,'nc::roots']]], - ['shape_1194',['Shape',['../classnc_1_1_shape.html',1,'nc']]], - ['slice_1195',['Slice',['../classnc_1_1_slice.html',1,'nc']]], - ['svd_1196',['SVD',['../classnc_1_1linalg_1_1_s_v_d.html',1,'nc::linalg']]] + ['ra_1246',['RA',['../classnc_1_1coordinates_1_1_r_a.html',1,'nc::coordinates']]] ]; diff --git a/docs/doxygen/html/search/classes_c.html b/docs/doxygen/html/search/classes_c.html index e7443ec68..2f7b1f3da 100644 --- a/docs/doxygen/html/search/classes_c.html +++ b/docs/doxygen/html/search/classes_c.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_c.js b/docs/doxygen/html/search/classes_c.js index bd9809683..bb42aa9ca 100644 --- a/docs/doxygen/html/search/classes_c.js +++ b/docs/doxygen/html/search/classes_c.js @@ -1,4 +1,7 @@ var searchData= [ - ['timer_1197',['Timer',['../classnc_1_1_timer.html',1,'nc']]] + ['secant_1247',['Secant',['../classnc_1_1roots_1_1_secant.html',1,'nc::roots']]], + ['shape_1248',['Shape',['../classnc_1_1_shape.html',1,'nc']]], + ['slice_1249',['Slice',['../classnc_1_1_slice.html',1,'nc']]], + ['svd_1250',['SVD',['../classnc_1_1linalg_1_1_s_v_d.html',1,'nc::linalg']]] ]; diff --git a/docs/doxygen/html/search/classes_d.html b/docs/doxygen/html/search/classes_d.html index ab4e1181e..f9011e70f 100644 --- a/docs/doxygen/html/search/classes_d.html +++ b/docs/doxygen/html/search/classes_d.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/classes_d.js b/docs/doxygen/html/search/classes_d.js index eb914d910..04b3f3bc9 100644 --- a/docs/doxygen/html/search/classes_d.js +++ b/docs/doxygen/html/search/classes_d.js @@ -1,5 +1,4 @@ var searchData= [ - ['vec2_1198',['Vec2',['../classnc_1_1_vec2.html',1,'nc']]], - ['vec3_1199',['Vec3',['../classnc_1_1_vec3.html',1,'nc']]] + ['timer_1251',['Timer',['../classnc_1_1_timer.html',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/classes_e.html b/docs/doxygen/html/search/classes_e.html new file mode 100644 index 000000000..bb33dcfa5 --- /dev/null +++ b/docs/doxygen/html/search/classes_e.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/doxygen/html/search/classes_e.js b/docs/doxygen/html/search/classes_e.js new file mode 100644 index 000000000..a828cea42 --- /dev/null +++ b/docs/doxygen/html/search/classes_e.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['vec2_1252',['Vec2',['../classnc_1_1_vec2.html',1,'nc']]], + ['vec3_1253',['Vec3',['../classnc_1_1_vec3.html',1,'nc']]] +]; diff --git a/docs/doxygen/html/search/defines_0.html b/docs/doxygen/html/search/defines_0.html index 75e810d41..15cc3de38 100644 --- a/docs/doxygen/html/search/defines_0.html +++ b/docs/doxygen/html/search/defines_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/defines_0.js b/docs/doxygen/html/search/defines_0.js index b4503fe82..c95330282 100644 --- a/docs/doxygen/html/search/defines_0.js +++ b/docs/doxygen/html/search/defines_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['conditional_5fno_5fexcept_2338',['CONDITIONAL_NO_EXCEPT',['../_stl_algorithms_8hpp.html#a328745b2b79b264770ec2783aa489f26',1,'StlAlgorithms.hpp']]] + ['conditional_5fno_5fexcept_2440',['CONDITIONAL_NO_EXCEPT',['../_stl_algorithms_8hpp.html#a328745b2b79b264770ec2783aa489f26',1,'StlAlgorithms.hpp']]] ]; diff --git a/docs/doxygen/html/search/defines_1.html b/docs/doxygen/html/search/defines_1.html index ef85498af..c49009c71 100644 --- a/docs/doxygen/html/search/defines_1.html +++ b/docs/doxygen/html/search/defines_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/defines_1.js b/docs/doxygen/html/search/defines_1.js index 3f43821f9..664093358 100644 --- a/docs/doxygen/html/search/defines_1.js +++ b/docs/doxygen/html/search/defines_1.js @@ -1,9 +1,9 @@ var searchData= [ - ['static_5fassert_5farithmetic_2339',['STATIC_ASSERT_ARITHMETIC',['../_static_asserts_8hpp.html#a36abb32368b91aed0d3133a4cfd5ae92',1,'StaticAsserts.hpp']]], - ['static_5fassert_5farithmetic_5for_5fcomplex_2340',['STATIC_ASSERT_ARITHMETIC_OR_COMPLEX',['../_static_asserts_8hpp.html#a1589f74d429e30786c65cda69b17ab96',1,'StaticAsserts.hpp']]], - ['static_5fassert_5fcomplex_2341',['STATIC_ASSERT_COMPLEX',['../_static_asserts_8hpp.html#a1cd1b98c2b918cbd369afc12c11a0597',1,'StaticAsserts.hpp']]], - ['static_5fassert_5ffloat_2342',['STATIC_ASSERT_FLOAT',['../_static_asserts_8hpp.html#a0cd8e186da549fbdd918111d0302d973',1,'StaticAsserts.hpp']]], - ['static_5fassert_5finteger_2343',['STATIC_ASSERT_INTEGER',['../_static_asserts_8hpp.html#a187660686583e9047c0cf4424259ad10',1,'StaticAsserts.hpp']]], - ['static_5fassert_5fvalid_5fdtype_2344',['STATIC_ASSERT_VALID_DTYPE',['../_static_asserts_8hpp.html#a00cfe1ea01e56fe28ffe3d6ce5cae468',1,'StaticAsserts.hpp']]] + ['static_5fassert_5farithmetic_2441',['STATIC_ASSERT_ARITHMETIC',['../_static_asserts_8hpp.html#a36abb32368b91aed0d3133a4cfd5ae92',1,'StaticAsserts.hpp']]], + ['static_5fassert_5farithmetic_5for_5fcomplex_2442',['STATIC_ASSERT_ARITHMETIC_OR_COMPLEX',['../_static_asserts_8hpp.html#a1589f74d429e30786c65cda69b17ab96',1,'StaticAsserts.hpp']]], + ['static_5fassert_5fcomplex_2443',['STATIC_ASSERT_COMPLEX',['../_static_asserts_8hpp.html#a1cd1b98c2b918cbd369afc12c11a0597',1,'StaticAsserts.hpp']]], + ['static_5fassert_5ffloat_2444',['STATIC_ASSERT_FLOAT',['../_static_asserts_8hpp.html#a0cd8e186da549fbdd918111d0302d973',1,'StaticAsserts.hpp']]], + ['static_5fassert_5finteger_2445',['STATIC_ASSERT_INTEGER',['../_static_asserts_8hpp.html#a187660686583e9047c0cf4424259ad10',1,'StaticAsserts.hpp']]], + ['static_5fassert_5fvalid_5fdtype_2446',['STATIC_ASSERT_VALID_DTYPE',['../_static_asserts_8hpp.html#a00cfe1ea01e56fe28ffe3d6ce5cae468',1,'StaticAsserts.hpp']]] ]; diff --git a/docs/doxygen/html/search/defines_2.html b/docs/doxygen/html/search/defines_2.html index 63da7d9fd..c55101115 100644 --- a/docs/doxygen/html/search/defines_2.html +++ b/docs/doxygen/html/search/defines_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/defines_2.js b/docs/doxygen/html/search/defines_2.js index 01740c4f8..a64192a7a 100644 --- a/docs/doxygen/html/search/defines_2.js +++ b/docs/doxygen/html/search/defines_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['throw_5finvalid_5fargument_5ferror_2345',['THROW_INVALID_ARGUMENT_ERROR',['../_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd',1,'Error.hpp']]], - ['throw_5fruntime_5ferror_2346',['THROW_RUNTIME_ERROR',['../_error_8hpp.html#a0f0ce4acf1fd6032112a06ebc50bb05a',1,'Error.hpp']]] + ['throw_5finvalid_5fargument_5ferror_2447',['THROW_INVALID_ARGUMENT_ERROR',['../_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd',1,'Error.hpp']]], + ['throw_5fruntime_5ferror_2448',['THROW_RUNTIME_ERROR',['../_error_8hpp.html#a0f0ce4acf1fd6032112a06ebc50bb05a',1,'Error.hpp']]] ]; diff --git a/docs/doxygen/html/search/enums_0.html b/docs/doxygen/html/search/enums_0.html index f2b0f7532..141fff57b 100644 --- a/docs/doxygen/html/search/enums_0.html +++ b/docs/doxygen/html/search/enums_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enums_0.js b/docs/doxygen/html/search/enums_0.js index 509bcd346..c3c2da68a 100644 --- a/docs/doxygen/html/search/enums_0.js +++ b/docs/doxygen/html/search/enums_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['axis_2320',['Axis',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84',1,'nc']]] + ['axis_2422',['Axis',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/enums_1.html b/docs/doxygen/html/search/enums_1.html index 1b1fea39b..d29f3b16d 100644 --- a/docs/doxygen/html/search/enums_1.html +++ b/docs/doxygen/html/search/enums_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enums_1.js b/docs/doxygen/html/search/enums_1.js index a085b75e7..382e3a369 100644 --- a/docs/doxygen/html/search/enums_1.js +++ b/docs/doxygen/html/search/enums_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['boundary_2321',['Boundary',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6',1,'nc::filter']]] + ['boundary_2423',['Boundary',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6',1,'nc::filter']]] ]; diff --git a/docs/doxygen/html/search/enums_2.html b/docs/doxygen/html/search/enums_2.html index 790ad6612..59aadf2cb 100644 --- a/docs/doxygen/html/search/enums_2.html +++ b/docs/doxygen/html/search/enums_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enums_2.js b/docs/doxygen/html/search/enums_2.js index 6a7f916c3..8596cd793 100644 --- a/docs/doxygen/html/search/enums_2.js +++ b/docs/doxygen/html/search/enums_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['endian_2322',['Endian',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152',1,'nc']]] + ['endian_2424',['Endian',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/enums_3.html b/docs/doxygen/html/search/enums_3.html index 7eee6e6b7..87c174430 100644 --- a/docs/doxygen/html/search/enums_3.html +++ b/docs/doxygen/html/search/enums_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enums_3.js b/docs/doxygen/html/search/enums_3.js index 8670fa85d..afa98c7eb 100644 --- a/docs/doxygen/html/search/enums_3.js +++ b/docs/doxygen/html/search/enums_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['sign_2323',['Sign',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94',1,'nc::coordinates']]] + ['sign_2425',['Sign',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94',1,'nc::coordinates']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_0.html b/docs/doxygen/html/search/enumvalues_0.html index 01f10803f..0d131d95b 100644 --- a/docs/doxygen/html/search/enumvalues_0.html +++ b/docs/doxygen/html/search/enumvalues_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_0.js b/docs/doxygen/html/search/enumvalues_0.js index 36888f214..816a60d59 100644 --- a/docs/doxygen/html/search/enumvalues_0.js +++ b/docs/doxygen/html/search/enumvalues_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['big_2324',['BIG',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152aa60c6c694491d75b439073b8cb05b139',1,'nc']]] + ['big_2426',['BIG',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152aa60c6c694491d75b439073b8cb05b139',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_1.html b/docs/doxygen/html/search/enumvalues_1.html index 5a0ca7a55..cd9187ab3 100644 --- a/docs/doxygen/html/search/enumvalues_1.html +++ b/docs/doxygen/html/search/enumvalues_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_1.js b/docs/doxygen/html/search/enumvalues_1.js index a52c69f89..be6b30490 100644 --- a/docs/doxygen/html/search/enumvalues_1.js +++ b/docs/doxygen/html/search/enumvalues_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['col_2325',['COL',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84aa44a065875f5d66d41474bb9bfb0ce05',1,'nc']]], - ['constant_2326',['CONSTANT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a8d6b5cada83510220f59e00ce86d4d92',1,'nc::filter']]] + ['col_2427',['COL',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84aa44a065875f5d66d41474bb9bfb0ce05',1,'nc']]], + ['constant_2428',['CONSTANT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a8d6b5cada83510220f59e00ce86d4d92',1,'nc::filter']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_2.html b/docs/doxygen/html/search/enumvalues_2.html index 324a403fc..2b95d9204 100644 --- a/docs/doxygen/html/search/enumvalues_2.html +++ b/docs/doxygen/html/search/enumvalues_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_2.js b/docs/doxygen/html/search/enumvalues_2.js index c05db0f3b..1f2c269b6 100644 --- a/docs/doxygen/html/search/enumvalues_2.js +++ b/docs/doxygen/html/search/enumvalues_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['little_2327',['LITTLE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152a1314341b466dcb5e2c880b76414c49fe',1,'nc']]] + ['little_2429',['LITTLE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152a1314341b466dcb5e2c880b76414c49fe',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_3.html b/docs/doxygen/html/search/enumvalues_3.html index 64f035144..bc0ac8a97 100644 --- a/docs/doxygen/html/search/enumvalues_3.html +++ b/docs/doxygen/html/search/enumvalues_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_3.js b/docs/doxygen/html/search/enumvalues_3.js index 65beebd6f..5f180fd08 100644 --- a/docs/doxygen/html/search/enumvalues_3.js +++ b/docs/doxygen/html/search/enumvalues_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['mirror_2328',['MIRROR',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a72a92ae9c1d172cdda196686278fbfc6',1,'nc::filter']]] + ['mirror_2430',['MIRROR',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6a72a92ae9c1d172cdda196686278fbfc6',1,'nc::filter']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_4.html b/docs/doxygen/html/search/enumvalues_4.html index e6a2f7933..ef94dd8d7 100644 --- a/docs/doxygen/html/search/enumvalues_4.html +++ b/docs/doxygen/html/search/enumvalues_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_4.js b/docs/doxygen/html/search/enumvalues_4.js index e6d808703..2904606f5 100644 --- a/docs/doxygen/html/search/enumvalues_4.js +++ b/docs/doxygen/html/search/enumvalues_4.js @@ -1,7 +1,7 @@ var searchData= [ - ['native_2329',['NATIVE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152af78504d96ba7177dc0c6784905ac8743',1,'nc']]], - ['nearest_2330',['NEAREST',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6aad135772d7cf93dd0ccf9d2474b34e6a',1,'nc::filter']]], - ['negative_2331',['NEGATIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94a50546bf973283065b6ccf09faf7a580a',1,'nc::coordinates']]], - ['none_2332',['NONE',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84ab50339a10e1de285ac99d4c3990b8693',1,'nc']]] + ['native_2431',['NATIVE',['../namespacenc.html#a8dcbcb343147d09e74689ad8a2586152af78504d96ba7177dc0c6784905ac8743',1,'nc']]], + ['nearest_2432',['NEAREST',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6aad135772d7cf93dd0ccf9d2474b34e6a',1,'nc::filter']]], + ['negative_2433',['NEGATIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94a50546bf973283065b6ccf09faf7a580a',1,'nc::coordinates']]], + ['none_2434',['NONE',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84ab50339a10e1de285ac99d4c3990b8693',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_5.html b/docs/doxygen/html/search/enumvalues_5.html index 00d0a05a7..1c2e2f33d 100644 --- a/docs/doxygen/html/search/enumvalues_5.html +++ b/docs/doxygen/html/search/enumvalues_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_5.js b/docs/doxygen/html/search/enumvalues_5.js index f6641ce60..63e476043 100644 --- a/docs/doxygen/html/search/enumvalues_5.js +++ b/docs/doxygen/html/search/enumvalues_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['positive_2333',['POSITIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94aab6c31432785221bae58327ef5f6ea58',1,'nc::coordinates']]] + ['positive_2435',['POSITIVE',['../namespacenc_1_1coordinates.html#a07a05f0462e5f74f05cbd04664c4ca94aab6c31432785221bae58327ef5f6ea58',1,'nc::coordinates']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_6.html b/docs/doxygen/html/search/enumvalues_6.html index fe6bf8e5b..f985df91d 100644 --- a/docs/doxygen/html/search/enumvalues_6.html +++ b/docs/doxygen/html/search/enumvalues_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_6.js b/docs/doxygen/html/search/enumvalues_6.js index 541387c36..ecbd01737 100644 --- a/docs/doxygen/html/search/enumvalues_6.js +++ b/docs/doxygen/html/search/enumvalues_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['reflect_2334',['REFLECT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae4f6a05f82ed398f984f4bc1a55838df',1,'nc::filter']]], - ['row_2335',['ROW',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84a54c1ed33c810f895d48c008d89f880b7',1,'nc']]] + ['reflect_2436',['REFLECT',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae4f6a05f82ed398f984f4bc1a55838df',1,'nc::filter']]], + ['row_2437',['ROW',['../namespacenc.html#a5edb9ac6f596ae1256faa3f5d797dc84a54c1ed33c810f895d48c008d89f880b7',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/enumvalues_7.html b/docs/doxygen/html/search/enumvalues_7.html index 6b045ef3e..7fdf663dd 100644 --- a/docs/doxygen/html/search/enumvalues_7.html +++ b/docs/doxygen/html/search/enumvalues_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/enumvalues_7.js b/docs/doxygen/html/search/enumvalues_7.js index bc493da49..cf8510219 100644 --- a/docs/doxygen/html/search/enumvalues_7.js +++ b/docs/doxygen/html/search/enumvalues_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['wrap_2336',['WRAP',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae1c8555fcf0ea2bb648a6fd527d658c0',1,'nc::filter']]] + ['wrap_2438',['WRAP',['../namespacenc_1_1filter.html#ada517a46ea965fa51ed51101135c6ac6ae1c8555fcf0ea2bb648a6fd527d658c0',1,'nc::filter']]] ]; diff --git a/docs/doxygen/html/search/files_0.html b/docs/doxygen/html/search/files_0.html index 844f0d648..9498842a6 100644 --- a/docs/doxygen/html/search/files_0.html +++ b/docs/doxygen/html/search/files_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_0.js b/docs/doxygen/html/search/files_0.js index 42e56468d..9337d8710 100644 --- a/docs/doxygen/html/search/files_0.js +++ b/docs/doxygen/html/search/files_0.js @@ -1,40 +1,40 @@ var searchData= [ - ['abs_2ehpp_1218',['abs.hpp',['../abs_8hpp.html',1,'']]], - ['add_2ehpp_1219',['add.hpp',['../add_8hpp.html',1,'']]], - ['addboundary1d_2ehpp_1220',['addBoundary1d.hpp',['../add_boundary1d_8hpp.html',1,'']]], - ['addboundary2d_2ehpp_1221',['addBoundary2d.hpp',['../add_boundary2d_8hpp.html',1,'']]], - ['airy_5fai_2ehpp_1222',['airy_ai.hpp',['../airy__ai_8hpp.html',1,'']]], - ['airy_5fai_5fprime_2ehpp_1223',['airy_ai_prime.hpp',['../airy__ai__prime_8hpp.html',1,'']]], - ['airy_5fbi_2ehpp_1224',['airy_bi.hpp',['../airy__bi_8hpp.html',1,'']]], - ['airy_5fbi_5fprime_2ehpp_1225',['airy_bi_prime.hpp',['../airy__bi__prime_8hpp.html',1,'']]], - ['alen_2ehpp_1226',['alen.hpp',['../alen_8hpp.html',1,'']]], - ['all_2ehpp_1227',['all.hpp',['../all_8hpp.html',1,'']]], - ['allclose_2ehpp_1228',['allclose.hpp',['../allclose_8hpp.html',1,'']]], - ['amax_2ehpp_1229',['amax.hpp',['../amax_8hpp.html',1,'']]], - ['amin_2ehpp_1230',['amin.hpp',['../amin_8hpp.html',1,'']]], - ['angle_2ehpp_1231',['angle.hpp',['../angle_8hpp.html',1,'']]], - ['any_2ehpp_1232',['any.hpp',['../any_8hpp.html',1,'']]], - ['append_2ehpp_1233',['append.hpp',['../append_8hpp.html',1,'']]], - ['applyfunction_2ehpp_1234',['applyFunction.hpp',['../apply_function_8hpp.html',1,'']]], - ['applypoly1d_2ehpp_1235',['applyPoly1d.hpp',['../apply_poly1d_8hpp.html',1,'']]], - ['applythreshold_2ehpp_1236',['applyThreshold.hpp',['../apply_threshold_8hpp.html',1,'']]], - ['arange_2ehpp_1237',['arange.hpp',['../arange_8hpp.html',1,'']]], - ['arccos_2ehpp_1238',['arccos.hpp',['../arccos_8hpp.html',1,'']]], - ['arccosh_2ehpp_1239',['arccosh.hpp',['../arccosh_8hpp.html',1,'']]], - ['arcsin_2ehpp_1240',['arcsin.hpp',['../arcsin_8hpp.html',1,'']]], - ['arcsinh_2ehpp_1241',['arcsinh.hpp',['../arcsinh_8hpp.html',1,'']]], - ['arctan_2ehpp_1242',['arctan.hpp',['../arctan_8hpp.html',1,'']]], - ['arctan2_2ehpp_1243',['arctan2.hpp',['../arctan2_8hpp.html',1,'']]], - ['arctanh_2ehpp_1244',['arctanh.hpp',['../arctanh_8hpp.html',1,'']]], - ['argmax_2ehpp_1245',['argmax.hpp',['../argmax_8hpp.html',1,'']]], - ['argmin_2ehpp_1246',['argmin.hpp',['../argmin_8hpp.html',1,'']]], - ['argsort_2ehpp_1247',['argsort.hpp',['../argsort_8hpp.html',1,'']]], - ['argwhere_2ehpp_1248',['argwhere.hpp',['../argwhere_8hpp.html',1,'']]], - ['around_2ehpp_1249',['around.hpp',['../around_8hpp.html',1,'']]], - ['array_5fequal_2ehpp_1250',['array_equal.hpp',['../array__equal_8hpp.html',1,'']]], - ['array_5fequiv_2ehpp_1251',['array_equiv.hpp',['../array__equiv_8hpp.html',1,'']]], - ['asarray_2ehpp_1252',['asarray.hpp',['../asarray_8hpp.html',1,'']]], - ['astype_2ehpp_1253',['astype.hpp',['../astype_8hpp.html',1,'']]], - ['average_2ehpp_1254',['average.hpp',['../average_8hpp.html',1,'']]] + ['abs_2ehpp_1274',['abs.hpp',['../abs_8hpp.html',1,'']]], + ['add_2ehpp_1275',['add.hpp',['../add_8hpp.html',1,'']]], + ['addboundary1d_2ehpp_1276',['addBoundary1d.hpp',['../add_boundary1d_8hpp.html',1,'']]], + ['addboundary2d_2ehpp_1277',['addBoundary2d.hpp',['../add_boundary2d_8hpp.html',1,'']]], + ['airy_5fai_2ehpp_1278',['airy_ai.hpp',['../airy__ai_8hpp.html',1,'']]], + ['airy_5fai_5fprime_2ehpp_1279',['airy_ai_prime.hpp',['../airy__ai__prime_8hpp.html',1,'']]], + ['airy_5fbi_2ehpp_1280',['airy_bi.hpp',['../airy__bi_8hpp.html',1,'']]], + ['airy_5fbi_5fprime_2ehpp_1281',['airy_bi_prime.hpp',['../airy__bi__prime_8hpp.html',1,'']]], + ['alen_2ehpp_1282',['alen.hpp',['../alen_8hpp.html',1,'']]], + ['all_2ehpp_1283',['all.hpp',['../all_8hpp.html',1,'']]], + ['allclose_2ehpp_1284',['allclose.hpp',['../allclose_8hpp.html',1,'']]], + ['amax_2ehpp_1285',['amax.hpp',['../amax_8hpp.html',1,'']]], + ['amin_2ehpp_1286',['amin.hpp',['../amin_8hpp.html',1,'']]], + ['angle_2ehpp_1287',['angle.hpp',['../angle_8hpp.html',1,'']]], + ['any_2ehpp_1288',['any.hpp',['../any_8hpp.html',1,'']]], + ['append_2ehpp_1289',['append.hpp',['../append_8hpp.html',1,'']]], + ['applyfunction_2ehpp_1290',['applyFunction.hpp',['../apply_function_8hpp.html',1,'']]], + ['applypoly1d_2ehpp_1291',['applyPoly1d.hpp',['../apply_poly1d_8hpp.html',1,'']]], + ['applythreshold_2ehpp_1292',['applyThreshold.hpp',['../apply_threshold_8hpp.html',1,'']]], + ['arange_2ehpp_1293',['arange.hpp',['../arange_8hpp.html',1,'']]], + ['arccos_2ehpp_1294',['arccos.hpp',['../arccos_8hpp.html',1,'']]], + ['arccosh_2ehpp_1295',['arccosh.hpp',['../arccosh_8hpp.html',1,'']]], + ['arcsin_2ehpp_1296',['arcsin.hpp',['../arcsin_8hpp.html',1,'']]], + ['arcsinh_2ehpp_1297',['arcsinh.hpp',['../arcsinh_8hpp.html',1,'']]], + ['arctan_2ehpp_1298',['arctan.hpp',['../arctan_8hpp.html',1,'']]], + ['arctan2_2ehpp_1299',['arctan2.hpp',['../arctan2_8hpp.html',1,'']]], + ['arctanh_2ehpp_1300',['arctanh.hpp',['../arctanh_8hpp.html',1,'']]], + ['argmax_2ehpp_1301',['argmax.hpp',['../argmax_8hpp.html',1,'']]], + ['argmin_2ehpp_1302',['argmin.hpp',['../argmin_8hpp.html',1,'']]], + ['argsort_2ehpp_1303',['argsort.hpp',['../argsort_8hpp.html',1,'']]], + ['argwhere_2ehpp_1304',['argwhere.hpp',['../argwhere_8hpp.html',1,'']]], + ['around_2ehpp_1305',['around.hpp',['../around_8hpp.html',1,'']]], + ['array_5fequal_2ehpp_1306',['array_equal.hpp',['../array__equal_8hpp.html',1,'']]], + ['array_5fequiv_2ehpp_1307',['array_equiv.hpp',['../array__equiv_8hpp.html',1,'']]], + ['asarray_2ehpp_1308',['asarray.hpp',['../asarray_8hpp.html',1,'']]], + ['astype_2ehpp_1309',['astype.hpp',['../astype_8hpp.html',1,'']]], + ['average_2ehpp_1310',['average.hpp',['../average_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_1.html b/docs/doxygen/html/search/files_1.html index 92739573b..7050ef48a 100644 --- a/docs/doxygen/html/search/files_1.html +++ b/docs/doxygen/html/search/files_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_1.js b/docs/doxygen/html/search/files_1.js index 14387623d..39be6ed9e 100644 --- a/docs/doxygen/html/search/files_1.js +++ b/docs/doxygen/html/search/files_1.js @@ -1,27 +1,29 @@ var searchData= [ - ['bernoilli_2ehpp_1255',['bernoilli.hpp',['../bernoilli_8hpp.html',1,'']]], - ['bernoulli_2ehpp_1256',['bernoulli.hpp',['../bernoulli_8hpp.html',1,'']]], - ['bessel_5fin_2ehpp_1257',['bessel_in.hpp',['../bessel__in_8hpp.html',1,'']]], - ['bessel_5fin_5fprime_2ehpp_1258',['bessel_in_prime.hpp',['../bessel__in__prime_8hpp.html',1,'']]], - ['bessel_5fjn_2ehpp_1259',['bessel_jn.hpp',['../bessel__jn_8hpp.html',1,'']]], - ['bessel_5fjn_5fprime_2ehpp_1260',['bessel_jn_prime.hpp',['../bessel__jn__prime_8hpp.html',1,'']]], - ['bessel_5fkn_2ehpp_1261',['bessel_kn.hpp',['../bessel__kn_8hpp.html',1,'']]], - ['bessel_5fkn_5fprime_2ehpp_1262',['bessel_kn_prime.hpp',['../bessel__kn__prime_8hpp.html',1,'']]], - ['bessel_5fyn_2ehpp_1263',['bessel_yn.hpp',['../bessel__yn_8hpp.html',1,'']]], - ['bessel_5fyn_5fprime_2ehpp_1264',['bessel_yn_prime.hpp',['../bessel__yn__prime_8hpp.html',1,'']]], - ['binaryrepr_2ehpp_1265',['binaryRepr.hpp',['../binary_repr_8hpp.html',1,'']]], - ['bincount_2ehpp_1266',['bincount.hpp',['../bincount_8hpp.html',1,'']]], - ['binomial_2ehpp_1267',['binomial.hpp',['../binomial_8hpp.html',1,'']]], - ['bisection_2ehpp_1268',['Bisection.hpp',['../_bisection_8hpp.html',1,'']]], - ['bitwise_5fand_2ehpp_1269',['bitwise_and.hpp',['../bitwise__and_8hpp.html',1,'']]], - ['bitwise_5fnot_2ehpp_1270',['bitwise_not.hpp',['../bitwise__not_8hpp.html',1,'']]], - ['bitwise_5for_2ehpp_1271',['bitwise_or.hpp',['../bitwise__or_8hpp.html',1,'']]], - ['bitwise_5fxor_2ehpp_1272',['bitwise_xor.hpp',['../bitwise__xor_8hpp.html',1,'']]], - ['boostinterface_2ehpp_1273',['BoostInterface.hpp',['../_boost_interface_8hpp.html',1,'']]], - ['boostnumpyndarrayhelper_2ehpp_1274',['BoostNumpyNdarrayHelper.hpp',['../_boost_numpy_ndarray_helper_8hpp.html',1,'']]], - ['boundary_2ehpp_1275',['Boundary.hpp',['../_boundary_8hpp.html',1,'']]], - ['brent_2ehpp_1276',['Brent.hpp',['../_brent_8hpp.html',1,'']]], - ['building_2emd_1277',['Building.md',['../_building_8md.html',1,'']]], - ['byteswap_2ehpp_1278',['byteswap.hpp',['../byteswap_8hpp.html',1,'']]] + ['bartlett_2ehpp_1311',['bartlett.hpp',['../bartlett_8hpp.html',1,'']]], + ['bernoilli_2ehpp_1312',['bernoilli.hpp',['../bernoilli_8hpp.html',1,'']]], + ['bernoulli_2ehpp_1313',['bernoulli.hpp',['../bernoulli_8hpp.html',1,'']]], + ['bessel_5fin_2ehpp_1314',['bessel_in.hpp',['../bessel__in_8hpp.html',1,'']]], + ['bessel_5fin_5fprime_2ehpp_1315',['bessel_in_prime.hpp',['../bessel__in__prime_8hpp.html',1,'']]], + ['bessel_5fjn_2ehpp_1316',['bessel_jn.hpp',['../bessel__jn_8hpp.html',1,'']]], + ['bessel_5fjn_5fprime_2ehpp_1317',['bessel_jn_prime.hpp',['../bessel__jn__prime_8hpp.html',1,'']]], + ['bessel_5fkn_2ehpp_1318',['bessel_kn.hpp',['../bessel__kn_8hpp.html',1,'']]], + ['bessel_5fkn_5fprime_2ehpp_1319',['bessel_kn_prime.hpp',['../bessel__kn__prime_8hpp.html',1,'']]], + ['bessel_5fyn_2ehpp_1320',['bessel_yn.hpp',['../bessel__yn_8hpp.html',1,'']]], + ['bessel_5fyn_5fprime_2ehpp_1321',['bessel_yn_prime.hpp',['../bessel__yn__prime_8hpp.html',1,'']]], + ['binaryrepr_2ehpp_1322',['binaryRepr.hpp',['../binary_repr_8hpp.html',1,'']]], + ['bincount_2ehpp_1323',['bincount.hpp',['../bincount_8hpp.html',1,'']]], + ['binomial_2ehpp_1324',['binomial.hpp',['../binomial_8hpp.html',1,'']]], + ['bisection_2ehpp_1325',['Bisection.hpp',['../_bisection_8hpp.html',1,'']]], + ['bitwise_5fand_2ehpp_1326',['bitwise_and.hpp',['../bitwise__and_8hpp.html',1,'']]], + ['bitwise_5fnot_2ehpp_1327',['bitwise_not.hpp',['../bitwise__not_8hpp.html',1,'']]], + ['bitwise_5for_2ehpp_1328',['bitwise_or.hpp',['../bitwise__or_8hpp.html',1,'']]], + ['bitwise_5fxor_2ehpp_1329',['bitwise_xor.hpp',['../bitwise__xor_8hpp.html',1,'']]], + ['blackman_2ehpp_1330',['blackman.hpp',['../blackman_8hpp.html',1,'']]], + ['boostinterface_2ehpp_1331',['BoostInterface.hpp',['../_boost_interface_8hpp.html',1,'']]], + ['boostnumpyndarrayhelper_2ehpp_1332',['BoostNumpyNdarrayHelper.hpp',['../_boost_numpy_ndarray_helper_8hpp.html',1,'']]], + ['boundary_2ehpp_1333',['Boundary.hpp',['../_boundary_8hpp.html',1,'']]], + ['brent_2ehpp_1334',['Brent.hpp',['../_brent_8hpp.html',1,'']]], + ['building_2emd_1335',['Building.md',['../_building_8md.html',1,'']]], + ['byteswap_2ehpp_1336',['byteswap.hpp',['../byteswap_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_10.html b/docs/doxygen/html/search/files_10.html index 809de9c1d..e52318ed3 100644 --- a/docs/doxygen/html/search/files_10.html +++ b/docs/doxygen/html/search/files_10.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_10.js b/docs/doxygen/html/search/files_10.js index 13aae4ea8..81b9e428a 100644 --- a/docs/doxygen/html/search/files_10.js +++ b/docs/doxygen/html/search/files_10.js @@ -1,41 +1,42 @@ var searchData= [ - ['beta_2ehpp_1572',['beta.hpp',['../_special_2beta_8hpp.html',1,'']]], - ['gamma_2ehpp_1573',['gamma.hpp',['../_special_2gamma_8hpp.html',1,'']]], - ['secant_2ehpp_1574',['Secant.hpp',['../_secant_8hpp.html',1,'']]], - ['setdiff1d_2ehpp_1575',['setdiff1d.hpp',['../setdiff1d_8hpp.html',1,'']]], - ['shuffle_2ehpp_1576',['shuffle.hpp',['../shuffle_8hpp.html',1,'']]], - ['sign_2ehpp_1577',['sign.hpp',['../sign_8hpp.html',1,'']]], - ['signbit_2ehpp_1578',['signbit.hpp',['../signbit_8hpp.html',1,'']]], - ['simpson_2ehpp_1579',['simpson.hpp',['../simpson_8hpp.html',1,'']]], - ['sin_2ehpp_1580',['sin.hpp',['../sin_8hpp.html',1,'']]], - ['sinc_2ehpp_1581',['sinc.hpp',['../sinc_8hpp.html',1,'']]], - ['sinh_2ehpp_1582',['sinh.hpp',['../sinh_8hpp.html',1,'']]], - ['size_2ehpp_1583',['size.hpp',['../size_8hpp.html',1,'']]], - ['slice_2ehpp_1584',['Slice.hpp',['../_slice_8hpp.html',1,'']]], - ['softmax_2ehpp_1585',['softmax.hpp',['../softmax_8hpp.html',1,'']]], - ['solve_2ehpp_1586',['solve.hpp',['../solve_8hpp.html',1,'']]], - ['sort_2ehpp_1587',['sort.hpp',['../sort_8hpp.html',1,'']]], - ['special_2ehpp_1588',['Special.hpp',['../_special_8hpp.html',1,'']]], - ['spherical_5fbessel_5fjn_2ehpp_1589',['spherical_bessel_jn.hpp',['../spherical__bessel__jn_8hpp.html',1,'']]], - ['spherical_5fbessel_5fyn_2ehpp_1590',['spherical_bessel_yn.hpp',['../spherical__bessel__yn_8hpp.html',1,'']]], - ['spherical_5fhankel_5f1_2ehpp_1591',['spherical_hankel_1.hpp',['../spherical__hankel__1_8hpp.html',1,'']]], - ['spherical_5fhankel_5f2_2ehpp_1592',['spherical_hankel_2.hpp',['../spherical__hankel__2_8hpp.html',1,'']]], - ['spherical_5fharmonic_2ehpp_1593',['spherical_harmonic.hpp',['../spherical__harmonic_8hpp.html',1,'']]], - ['sqr_2ehpp_1594',['sqr.hpp',['../sqr_8hpp.html',1,'']]], - ['sqrt_2ehpp_1595',['sqrt.hpp',['../sqrt_8hpp.html',1,'']]], - ['square_2ehpp_1596',['square.hpp',['../square_8hpp.html',1,'']]], - ['stack_2ehpp_1597',['stack.hpp',['../stack_8hpp.html',1,'']]], - ['standardnormal_2ehpp_1598',['standardNormal.hpp',['../standard_normal_8hpp.html',1,'']]], - ['staticasserts_2ehpp_1599',['StaticAsserts.hpp',['../_static_asserts_8hpp.html',1,'']]], - ['stdcomplexoperators_2ehpp_1600',['StdComplexOperators.hpp',['../_std_complex_operators_8hpp.html',1,'']]], - ['stdev_2ehpp_1601',['stdev.hpp',['../stdev_8hpp.html',1,'']]], - ['stlalgorithms_2ehpp_1602',['StlAlgorithms.hpp',['../_stl_algorithms_8hpp.html',1,'']]], - ['studentt_2ehpp_1603',['studentT.hpp',['../student_t_8hpp.html',1,'']]], - ['subtract_2ehpp_1604',['subtract.hpp',['../subtract_8hpp.html',1,'']]], - ['sum_2ehpp_1605',['sum.hpp',['../sum_8hpp.html',1,'']]], - ['svd_2ehpp_1606',['svd.hpp',['../svd_8hpp.html',1,'']]], - ['svdclass_2ehpp_1607',['SVDClass.hpp',['../_s_v_d_class_8hpp.html',1,'']]], - ['swap_2ehpp_1608',['swap.hpp',['../swap_8hpp.html',1,'']]], - ['swapaxes_2ehpp_1609',['swapaxes.hpp',['../swapaxes_8hpp.html',1,'']]] + ['beta_2ehpp_1607',['beta.hpp',['../_random_2beta_8hpp.html',1,'']]], + ['gamma_2ehpp_1608',['gamma.hpp',['../_random_2gamma_8hpp.html',1,'']]], + ['laplace_2ehpp_1609',['laplace.hpp',['../_random_2laplace_8hpp.html',1,'']]], + ['ra_2ehpp_1610',['RA.hpp',['../_r_a_8hpp.html',1,'']]], + ['rad2deg_2ehpp_1611',['rad2deg.hpp',['../rad2deg_8hpp.html',1,'']]], + ['radians_2ehpp_1612',['radians.hpp',['../radians_8hpp.html',1,'']]], + ['radianseperation_2ehpp_1613',['radianSeperation.hpp',['../radian_seperation_8hpp.html',1,'']]], + ['rand_2ehpp_1614',['rand.hpp',['../rand_8hpp.html',1,'']]], + ['randfloat_2ehpp_1615',['randFloat.hpp',['../rand_float_8hpp.html',1,'']]], + ['randint_2ehpp_1616',['randInt.hpp',['../rand_int_8hpp.html',1,'']]], + ['randn_2ehpp_1617',['randN.hpp',['../rand_n_8hpp.html',1,'']]], + ['random_2ehpp_1618',['Random.hpp',['../_random_8hpp.html',1,'']]], + ['rankfilter_2ehpp_1619',['rankFilter.hpp',['../rank_filter_8hpp.html',1,'']]], + ['rankfilter1d_2ehpp_1620',['rankFilter1d.hpp',['../rank_filter1d_8hpp.html',1,'']]], + ['ravel_2ehpp_1621',['ravel.hpp',['../ravel_8hpp.html',1,'']]], + ['readme_2emd_1622',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]], + ['real_2ehpp_1623',['real.hpp',['../real_8hpp.html',1,'']]], + ['reciprocal_2ehpp_1624',['reciprocal.hpp',['../reciprocal_8hpp.html',1,'']]], + ['reflect1d_2ehpp_1625',['reflect1d.hpp',['../reflect1d_8hpp.html',1,'']]], + ['reflect2d_2ehpp_1626',['reflect2d.hpp',['../reflect2d_8hpp.html',1,'']]], + ['releasenotes_2emd_1627',['ReleaseNotes.md',['../_release_notes_8md.html',1,'']]], + ['remainder_2ehpp_1628',['remainder.hpp',['../remainder_8hpp.html',1,'']]], + ['repeat_2ehpp_1629',['repeat.hpp',['../repeat_8hpp.html',1,'']]], + ['replace_2ehpp_1630',['replace.hpp',['../replace_8hpp.html',1,'']]], + ['reshape_2ehpp_1631',['reshape.hpp',['../reshape_8hpp.html',1,'']]], + ['resizefast_2ehpp_1632',['resizeFast.hpp',['../resize_fast_8hpp.html',1,'']]], + ['resizeslow_2ehpp_1633',['resizeSlow.hpp',['../resize_slow_8hpp.html',1,'']]], + ['riemann_5fzeta_2ehpp_1634',['riemann_zeta.hpp',['../riemann__zeta_8hpp.html',1,'']]], + ['right_5fshift_2ehpp_1635',['right_shift.hpp',['../right__shift_8hpp.html',1,'']]], + ['rint_2ehpp_1636',['rint.hpp',['../rint_8hpp.html',1,'']]], + ['rms_2ehpp_1637',['rms.hpp',['../rms_8hpp.html',1,'']]], + ['rodriguesrotation_2ehpp_1638',['rodriguesRotation.hpp',['../rodrigues_rotation_8hpp.html',1,'']]], + ['roll_2ehpp_1639',['roll.hpp',['../roll_8hpp.html',1,'']]], + ['romberg_2ehpp_1640',['romberg.hpp',['../romberg_8hpp.html',1,'']]], + ['roots_2ehpp_1641',['Roots.hpp',['../_roots_8hpp.html',1,'']]], + ['rot90_2ehpp_1642',['rot90.hpp',['../rot90_8hpp.html',1,'']]], + ['rotations_2ehpp_1643',['Rotations.hpp',['../_rotations_8hpp.html',1,'']]], + ['round_2ehpp_1644',['round.hpp',['../round_8hpp.html',1,'']]], + ['row_5fstack_2ehpp_1645',['row_stack.hpp',['../row__stack_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_11.html b/docs/doxygen/html/search/files_11.html index 7e7888f9a..02edc0913 100644 --- a/docs/doxygen/html/search/files_11.html +++ b/docs/doxygen/html/search/files_11.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_11.js b/docs/doxygen/html/search/files_11.js index e99d4ecb4..3d7d17ae2 100644 --- a/docs/doxygen/html/search/files_11.js +++ b/docs/doxygen/html/search/files_11.js @@ -1,22 +1,42 @@ var searchData= [ - ['tan_2ehpp_1610',['tan.hpp',['../tan_8hpp.html',1,'']]], - ['tanh_2ehpp_1611',['tanh.hpp',['../tanh_8hpp.html',1,'']]], - ['tile_2ehpp_1612',['tile.hpp',['../tile_8hpp.html',1,'']]], - ['timer_2ehpp_1613',['Timer.hpp',['../_timer_8hpp.html',1,'']]], - ['tofile_2ehpp_1614',['tofile.hpp',['../tofile_8hpp.html',1,'']]], - ['tostlvector_2ehpp_1615',['toStlVector.hpp',['../to_stl_vector_8hpp.html',1,'']]], - ['trace_2ehpp_1616',['trace.hpp',['../trace_8hpp.html',1,'']]], - ['transpose_2ehpp_1617',['transpose.hpp',['../transpose_8hpp.html',1,'']]], - ['trapazoidal_2ehpp_1618',['trapazoidal.hpp',['../trapazoidal_8hpp.html',1,'']]], - ['trapz_2ehpp_1619',['trapz.hpp',['../trapz_8hpp.html',1,'']]], - ['tri_2ehpp_1620',['tri.hpp',['../tri_8hpp.html',1,'']]], - ['triangle_2ehpp_1621',['triangle.hpp',['../triangle_8hpp.html',1,'']]], - ['trigamma_2ehpp_1622',['trigamma.hpp',['../trigamma_8hpp.html',1,'']]], - ['trim_5fzeros_2ehpp_1623',['trim_zeros.hpp',['../trim__zeros_8hpp.html',1,'']]], - ['trimboundary1d_2ehpp_1624',['trimBoundary1d.hpp',['../trim_boundary1d_8hpp.html',1,'']]], - ['trimboundary2d_2ehpp_1625',['trimBoundary2d.hpp',['../trim_boundary2d_8hpp.html',1,'']]], - ['trunc_2ehpp_1626',['trunc.hpp',['../trunc_8hpp.html',1,'']]], - ['types_2ehpp_1627',['Types.hpp',['../_types_8hpp.html',1,'']]], - ['typetraits_2ehpp_1628',['TypeTraits.hpp',['../_type_traits_8hpp.html',1,'']]] + ['beta_2ehpp_1646',['beta.hpp',['../_special_2beta_8hpp.html',1,'']]], + ['gamma_2ehpp_1647',['gamma.hpp',['../_special_2gamma_8hpp.html',1,'']]], + ['secant_2ehpp_1648',['Secant.hpp',['../_secant_8hpp.html',1,'']]], + ['select_2ehpp_1649',['select.hpp',['../select_8hpp.html',1,'']]], + ['setdiff1d_2ehpp_1650',['setdiff1d.hpp',['../setdiff1d_8hpp.html',1,'']]], + ['shuffle_2ehpp_1651',['shuffle.hpp',['../shuffle_8hpp.html',1,'']]], + ['sign_2ehpp_1652',['sign.hpp',['../sign_8hpp.html',1,'']]], + ['signbit_2ehpp_1653',['signbit.hpp',['../signbit_8hpp.html',1,'']]], + ['simpson_2ehpp_1654',['simpson.hpp',['../simpson_8hpp.html',1,'']]], + ['sin_2ehpp_1655',['sin.hpp',['../sin_8hpp.html',1,'']]], + ['sinc_2ehpp_1656',['sinc.hpp',['../sinc_8hpp.html',1,'']]], + ['sinh_2ehpp_1657',['sinh.hpp',['../sinh_8hpp.html',1,'']]], + ['size_2ehpp_1658',['size.hpp',['../size_8hpp.html',1,'']]], + ['slice_2ehpp_1659',['Slice.hpp',['../_slice_8hpp.html',1,'']]], + ['softmax_2ehpp_1660',['softmax.hpp',['../softmax_8hpp.html',1,'']]], + ['solve_2ehpp_1661',['solve.hpp',['../solve_8hpp.html',1,'']]], + ['sort_2ehpp_1662',['sort.hpp',['../sort_8hpp.html',1,'']]], + ['special_2ehpp_1663',['Special.hpp',['../_special_8hpp.html',1,'']]], + ['spherical_5fbessel_5fjn_2ehpp_1664',['spherical_bessel_jn.hpp',['../spherical__bessel__jn_8hpp.html',1,'']]], + ['spherical_5fbessel_5fyn_2ehpp_1665',['spherical_bessel_yn.hpp',['../spherical__bessel__yn_8hpp.html',1,'']]], + ['spherical_5fhankel_5f1_2ehpp_1666',['spherical_hankel_1.hpp',['../spherical__hankel__1_8hpp.html',1,'']]], + ['spherical_5fhankel_5f2_2ehpp_1667',['spherical_hankel_2.hpp',['../spherical__hankel__2_8hpp.html',1,'']]], + ['spherical_5fharmonic_2ehpp_1668',['spherical_harmonic.hpp',['../spherical__harmonic_8hpp.html',1,'']]], + ['sqr_2ehpp_1669',['sqr.hpp',['../sqr_8hpp.html',1,'']]], + ['sqrt_2ehpp_1670',['sqrt.hpp',['../sqrt_8hpp.html',1,'']]], + ['square_2ehpp_1671',['square.hpp',['../square_8hpp.html',1,'']]], + ['stack_2ehpp_1672',['stack.hpp',['../stack_8hpp.html',1,'']]], + ['standardnormal_2ehpp_1673',['standardNormal.hpp',['../standard_normal_8hpp.html',1,'']]], + ['staticasserts_2ehpp_1674',['StaticAsserts.hpp',['../_static_asserts_8hpp.html',1,'']]], + ['stdcomplexoperators_2ehpp_1675',['StdComplexOperators.hpp',['../_std_complex_operators_8hpp.html',1,'']]], + ['stdev_2ehpp_1676',['stdev.hpp',['../stdev_8hpp.html',1,'']]], + ['stlalgorithms_2ehpp_1677',['StlAlgorithms.hpp',['../_stl_algorithms_8hpp.html',1,'']]], + ['studentt_2ehpp_1678',['studentT.hpp',['../student_t_8hpp.html',1,'']]], + ['subtract_2ehpp_1679',['subtract.hpp',['../subtract_8hpp.html',1,'']]], + ['sum_2ehpp_1680',['sum.hpp',['../sum_8hpp.html',1,'']]], + ['svd_2ehpp_1681',['svd.hpp',['../svd_8hpp.html',1,'']]], + ['svdclass_2ehpp_1682',['SVDClass.hpp',['../_s_v_d_class_8hpp.html',1,'']]], + ['swap_2ehpp_1683',['swap.hpp',['../swap_8hpp.html',1,'']]], + ['swapaxes_2ehpp_1684',['swapaxes.hpp',['../swapaxes_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_12.html b/docs/doxygen/html/search/files_12.html index 82cd0f33b..bd79f3c5f 100644 --- a/docs/doxygen/html/search/files_12.html +++ b/docs/doxygen/html/search/files_12.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_12.js b/docs/doxygen/html/search/files_12.js index 23557b69f..67bac1ed3 100644 --- a/docs/doxygen/html/search/files_12.js +++ b/docs/doxygen/html/search/files_12.js @@ -1,15 +1,22 @@ var searchData= [ - ['cube_2ehpp_1629',['cube.hpp',['../_utils_2cube_8hpp.html',1,'']]], - ['interp_2ehpp_1630',['interp.hpp',['../_utils_2interp_8hpp.html',1,'']]], - ['power_2ehpp_1631',['power.hpp',['../_utils_2power_8hpp.html',1,'']]], - ['powerf_2ehpp_1632',['powerf.hpp',['../_utils_2powerf_8hpp.html',1,'']]], - ['uniform_2ehpp_1633',['uniform.hpp',['../uniform_8hpp.html',1,'']]], - ['uniformfilter_2ehpp_1634',['uniformFilter.hpp',['../uniform_filter_8hpp.html',1,'']]], - ['uniformfilter1d_2ehpp_1635',['uniformFilter1d.hpp',['../uniform_filter1d_8hpp.html',1,'']]], - ['uniformonsphere_2ehpp_1636',['uniformOnSphere.hpp',['../uniform_on_sphere_8hpp.html',1,'']]], - ['union1d_2ehpp_1637',['union1d.hpp',['../union1d_8hpp.html',1,'']]], - ['unique_2ehpp_1638',['unique.hpp',['../unique_8hpp.html',1,'']]], - ['unwrap_2ehpp_1639',['unwrap.hpp',['../unwrap_8hpp.html',1,'']]], - ['utils_2ehpp_1640',['Utils.hpp',['../_utils_8hpp.html',1,'']]] + ['tan_2ehpp_1685',['tan.hpp',['../tan_8hpp.html',1,'']]], + ['tanh_2ehpp_1686',['tanh.hpp',['../tanh_8hpp.html',1,'']]], + ['tile_2ehpp_1687',['tile.hpp',['../tile_8hpp.html',1,'']]], + ['timer_2ehpp_1688',['Timer.hpp',['../_timer_8hpp.html',1,'']]], + ['tofile_2ehpp_1689',['tofile.hpp',['../tofile_8hpp.html',1,'']]], + ['tostlvector_2ehpp_1690',['toStlVector.hpp',['../to_stl_vector_8hpp.html',1,'']]], + ['trace_2ehpp_1691',['trace.hpp',['../trace_8hpp.html',1,'']]], + ['transpose_2ehpp_1692',['transpose.hpp',['../transpose_8hpp.html',1,'']]], + ['trapazoidal_2ehpp_1693',['trapazoidal.hpp',['../trapazoidal_8hpp.html',1,'']]], + ['trapz_2ehpp_1694',['trapz.hpp',['../trapz_8hpp.html',1,'']]], + ['tri_2ehpp_1695',['tri.hpp',['../tri_8hpp.html',1,'']]], + ['triangle_2ehpp_1696',['triangle.hpp',['../triangle_8hpp.html',1,'']]], + ['trigamma_2ehpp_1697',['trigamma.hpp',['../trigamma_8hpp.html',1,'']]], + ['trim_5fzeros_2ehpp_1698',['trim_zeros.hpp',['../trim__zeros_8hpp.html',1,'']]], + ['trimboundary1d_2ehpp_1699',['trimBoundary1d.hpp',['../trim_boundary1d_8hpp.html',1,'']]], + ['trimboundary2d_2ehpp_1700',['trimBoundary2d.hpp',['../trim_boundary2d_8hpp.html',1,'']]], + ['trunc_2ehpp_1701',['trunc.hpp',['../trunc_8hpp.html',1,'']]], + ['types_2ehpp_1702',['Types.hpp',['../_types_8hpp.html',1,'']]], + ['typetraits_2ehpp_1703',['TypeTraits.hpp',['../_type_traits_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_13.html b/docs/doxygen/html/search/files_13.html index 7e9e11917..7cbb5b01e 100644 --- a/docs/doxygen/html/search/files_13.html +++ b/docs/doxygen/html/search/files_13.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_13.js b/docs/doxygen/html/search/files_13.js index 027bf06bf..beb369532 100644 --- a/docs/doxygen/html/search/files_13.js +++ b/docs/doxygen/html/search/files_13.js @@ -1,10 +1,15 @@ var searchData= [ - ['value2str_2ehpp_1641',['value2str.hpp',['../value2str_8hpp.html',1,'']]], - ['var_2ehpp_1642',['var.hpp',['../var_8hpp.html',1,'']]], - ['vec2_2ehpp_1643',['Vec2.hpp',['../_vec2_8hpp.html',1,'']]], - ['vec3_2ehpp_1644',['Vec3.hpp',['../_vec3_8hpp.html',1,'']]], - ['vector_2ehpp_1645',['Vector.hpp',['../_vector_8hpp.html',1,'']]], - ['version_2ehpp_1646',['Version.hpp',['../_version_8hpp.html',1,'']]], - ['vstack_2ehpp_1647',['vstack.hpp',['../vstack_8hpp.html',1,'']]] + ['cube_2ehpp_1704',['cube.hpp',['../_utils_2cube_8hpp.html',1,'']]], + ['interp_2ehpp_1705',['interp.hpp',['../_utils_2interp_8hpp.html',1,'']]], + ['power_2ehpp_1706',['power.hpp',['../_utils_2power_8hpp.html',1,'']]], + ['powerf_2ehpp_1707',['powerf.hpp',['../_utils_2powerf_8hpp.html',1,'']]], + ['uniform_2ehpp_1708',['uniform.hpp',['../uniform_8hpp.html',1,'']]], + ['uniformfilter_2ehpp_1709',['uniformFilter.hpp',['../uniform_filter_8hpp.html',1,'']]], + ['uniformfilter1d_2ehpp_1710',['uniformFilter1d.hpp',['../uniform_filter1d_8hpp.html',1,'']]], + ['uniformonsphere_2ehpp_1711',['uniformOnSphere.hpp',['../uniform_on_sphere_8hpp.html',1,'']]], + ['union1d_2ehpp_1712',['union1d.hpp',['../union1d_8hpp.html',1,'']]], + ['unique_2ehpp_1713',['unique.hpp',['../unique_8hpp.html',1,'']]], + ['unwrap_2ehpp_1714',['unwrap.hpp',['../unwrap_8hpp.html',1,'']]], + ['utils_2ehpp_1715',['Utils.hpp',['../_utils_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_14.html b/docs/doxygen/html/search/files_14.html index 1a700d1ad..c8da77bcc 100644 --- a/docs/doxygen/html/search/files_14.html +++ b/docs/doxygen/html/search/files_14.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_14.js b/docs/doxygen/html/search/files_14.js index 6824cc68c..57318d5f3 100644 --- a/docs/doxygen/html/search/files_14.js +++ b/docs/doxygen/html/search/files_14.js @@ -1,9 +1,10 @@ var searchData= [ - ['wahbasproblem_2ehpp_1648',['wahbasProblem.hpp',['../wahbas_problem_8hpp.html',1,'']]], - ['weibull_2ehpp_1649',['weibull.hpp',['../weibull_8hpp.html',1,'']]], - ['where_2ehpp_1650',['where.hpp',['../where_8hpp.html',1,'']]], - ['windowexceedances_2ehpp_1651',['windowExceedances.hpp',['../window_exceedances_8hpp.html',1,'']]], - ['wrap1d_2ehpp_1652',['wrap1d.hpp',['../wrap1d_8hpp.html',1,'']]], - ['wrap2d_2ehpp_1653',['wrap2d.hpp',['../wrap2d_8hpp.html',1,'']]] + ['value2str_2ehpp_1716',['value2str.hpp',['../value2str_8hpp.html',1,'']]], + ['var_2ehpp_1717',['var.hpp',['../var_8hpp.html',1,'']]], + ['vec2_2ehpp_1718',['Vec2.hpp',['../_vec2_8hpp.html',1,'']]], + ['vec3_2ehpp_1719',['Vec3.hpp',['../_vec3_8hpp.html',1,'']]], + ['vector_2ehpp_1720',['Vector.hpp',['../_vector_8hpp.html',1,'']]], + ['version_2ehpp_1721',['Version.hpp',['../_version_8hpp.html',1,'']]], + ['vstack_2ehpp_1722',['vstack.hpp',['../vstack_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_15.html b/docs/doxygen/html/search/files_15.html index 09d19ca3a..2672868ce 100644 --- a/docs/doxygen/html/search/files_15.html +++ b/docs/doxygen/html/search/files_15.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_15.js b/docs/doxygen/html/search/files_15.js index 7fe8d0afb..7d46c6179 100644 --- a/docs/doxygen/html/search/files_15.js +++ b/docs/doxygen/html/search/files_15.js @@ -1,5 +1,9 @@ var searchData= [ - ['zeros_2ehpp_1654',['zeros.hpp',['../zeros_8hpp.html',1,'']]], - ['zeros_5flike_2ehpp_1655',['zeros_like.hpp',['../zeros__like_8hpp.html',1,'']]] + ['wahbasproblem_2ehpp_1723',['wahbasProblem.hpp',['../wahbas_problem_8hpp.html',1,'']]], + ['weibull_2ehpp_1724',['weibull.hpp',['../weibull_8hpp.html',1,'']]], + ['where_2ehpp_1725',['where.hpp',['../where_8hpp.html',1,'']]], + ['windowexceedances_2ehpp_1726',['windowExceedances.hpp',['../window_exceedances_8hpp.html',1,'']]], + ['wrap1d_2ehpp_1727',['wrap1d.hpp',['../wrap1d_8hpp.html',1,'']]], + ['wrap2d_2ehpp_1728',['wrap2d.hpp',['../wrap2d_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_16.html b/docs/doxygen/html/search/files_16.html new file mode 100644 index 000000000..b48235e24 --- /dev/null +++ b/docs/doxygen/html/search/files_16.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/doxygen/html/search/files_16.js b/docs/doxygen/html/search/files_16.js new file mode 100644 index 000000000..bae1f944f --- /dev/null +++ b/docs/doxygen/html/search/files_16.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['zeros_2ehpp_1729',['zeros.hpp',['../zeros_8hpp.html',1,'']]], + ['zeros_5flike_2ehpp_1730',['zeros_like.hpp',['../zeros__like_8hpp.html',1,'']]] +]; diff --git a/docs/doxygen/html/search/files_2.html b/docs/doxygen/html/search/files_2.html index 185170ad0..497cdf5c7 100644 --- a/docs/doxygen/html/search/files_2.html +++ b/docs/doxygen/html/search/files_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_2.js b/docs/doxygen/html/search/files_2.js index 62ac89df4..121dbb938 100644 --- a/docs/doxygen/html/search/files_2.js +++ b/docs/doxygen/html/search/files_2.js @@ -1,50 +1,53 @@ var searchData= [ - ['cauchy_2ehpp_1279',['cauchy.hpp',['../cauchy_8hpp.html',1,'']]], - ['cbrt_2ehpp_1280',['cbrt.hpp',['../cbrt_8hpp.html',1,'']]], - ['ceil_2ehpp_1281',['ceil.hpp',['../ceil_8hpp.html',1,'']]], - ['centerofmass_2ehpp_1282',['centerOfMass.hpp',['../center_of_mass_8hpp.html',1,'']]], - ['centroid_2ehpp_1283',['Centroid.hpp',['../_centroid_8hpp.html',1,'']]], - ['centroidclusters_2ehpp_1284',['centroidClusters.hpp',['../centroid_clusters_8hpp.html',1,'']]], - ['chebyshev_5ft_2ehpp_1285',['chebyshev_t.hpp',['../chebyshev__t_8hpp.html',1,'']]], - ['chebyshev_5fu_2ehpp_1286',['chebyshev_u.hpp',['../chebyshev__u_8hpp.html',1,'']]], - ['chisquare_2ehpp_1287',['chiSquare.hpp',['../chi_square_8hpp.html',1,'']]], - ['choice_2ehpp_1288',['choice.hpp',['../choice_8hpp.html',1,'']]], - ['cholesky_2ehpp_1289',['cholesky.hpp',['../cholesky_8hpp.html',1,'']]], - ['clip_2ehpp_1290',['clip.hpp',['../clip_8hpp.html',1,'']]], - ['cluster_2ehpp_1291',['Cluster.hpp',['../_cluster_8hpp.html',1,'']]], - ['clustermaker_2ehpp_1292',['ClusterMaker.hpp',['../_cluster_maker_8hpp.html',1,'']]], - ['clusterpixels_2ehpp_1293',['clusterPixels.hpp',['../cluster_pixels_8hpp.html',1,'']]], - ['cnr_2ehpp_1294',['cnr.hpp',['../cnr_8hpp.html',1,'']]], - ['column_5fstack_2ehpp_1295',['column_stack.hpp',['../column__stack_8hpp.html',1,'']]], - ['comp_5fellint_5f1_2ehpp_1296',['comp_ellint_1.hpp',['../comp__ellint__1_8hpp.html',1,'']]], - ['comp_5fellint_5f2_2ehpp_1297',['comp_ellint_2.hpp',['../comp__ellint__2_8hpp.html',1,'']]], - ['comp_5fellint_5f3_2ehpp_1298',['comp_ellint_3.hpp',['../comp__ellint__3_8hpp.html',1,'']]], - ['compilerflags_2emd_1299',['CompilerFlags.md',['../_compiler_flags_8md.html',1,'']]], - ['complementarymedianfilter_2ehpp_1300',['complementaryMedianFilter.hpp',['../complementary_median_filter_8hpp.html',1,'']]], - ['complementarymedianfilter1d_2ehpp_1301',['complementaryMedianFilter1d.hpp',['../complementary_median_filter1d_8hpp.html',1,'']]], - ['complex_2ehpp_1302',['complex.hpp',['../complex_8hpp.html',1,'']]], - ['concatenate_2ehpp_1303',['concatenate.hpp',['../concatenate_8hpp.html',1,'']]], - ['conj_2ehpp_1304',['conj.hpp',['../conj_8hpp.html',1,'']]], - ['constant1d_2ehpp_1305',['constant1d.hpp',['../constant1d_8hpp.html',1,'']]], - ['constant2d_2ehpp_1306',['constant2d.hpp',['../constant2d_8hpp.html',1,'']]], - ['constants_2ehpp_1307',['Constants.hpp',['../_constants_8hpp.html',1,'']]], - ['contains_2ehpp_1308',['contains.hpp',['../contains_8hpp.html',1,'']]], - ['convolve_2ehpp_1309',['convolve.hpp',['../convolve_8hpp.html',1,'']]], - ['convolve1d_2ehpp_1310',['convolve1d.hpp',['../convolve1d_8hpp.html',1,'']]], - ['coordinate_2ehpp_1311',['Coordinate.hpp',['../_coordinate_8hpp.html',1,'']]], - ['coordinates_2ehpp_1312',['Coordinates.hpp',['../_coordinates_8hpp.html',1,'']]], - ['copy_2ehpp_1313',['copy.hpp',['../copy_8hpp.html',1,'']]], - ['copysign_2ehpp_1314',['copySign.hpp',['../copy_sign_8hpp.html',1,'']]], - ['copyto_2ehpp_1315',['copyto.hpp',['../copyto_8hpp.html',1,'']]], - ['core_2ehpp_1316',['Core.hpp',['../_core_8hpp.html',1,'']]], - ['cos_2ehpp_1317',['cos.hpp',['../cos_8hpp.html',1,'']]], - ['cosh_2ehpp_1318',['cosh.hpp',['../cosh_8hpp.html',1,'']]], - ['count_5fnonzero_2ehpp_1319',['count_nonzero.hpp',['../count__nonzero_8hpp.html',1,'']]], - ['cross_2ehpp_1320',['cross.hpp',['../cross_8hpp.html',1,'']]], - ['cumprod_2ehpp_1321',['cumprod.hpp',['../cumprod_8hpp.html',1,'']]], - ['cumsum_2ehpp_1322',['cumsum.hpp',['../cumsum_8hpp.html',1,'']]], - ['cyclic_5fhankel_5f1_2ehpp_1323',['cyclic_hankel_1.hpp',['../cyclic__hankel__1_8hpp.html',1,'']]], - ['cyclic_5fhankel_5f2_2ehpp_1324',['cyclic_hankel_2.hpp',['../cyclic__hankel__2_8hpp.html',1,'']]], - ['shape_2ehpp_1325',['Shape.hpp',['../_core_2_shape_8hpp.html',1,'']]] + ['cauchy_2ehpp_1337',['cauchy.hpp',['../cauchy_8hpp.html',1,'']]], + ['cbrt_2ehpp_1338',['cbrt.hpp',['../cbrt_8hpp.html',1,'']]], + ['ceil_2ehpp_1339',['ceil.hpp',['../ceil_8hpp.html',1,'']]], + ['centerofmass_2ehpp_1340',['centerOfMass.hpp',['../center_of_mass_8hpp.html',1,'']]], + ['centroid_2ehpp_1341',['Centroid.hpp',['../_centroid_8hpp.html',1,'']]], + ['centroidclusters_2ehpp_1342',['centroidClusters.hpp',['../centroid_clusters_8hpp.html',1,'']]], + ['chebyshev_5ft_2ehpp_1343',['chebyshev_t.hpp',['../chebyshev__t_8hpp.html',1,'']]], + ['chebyshev_5fu_2ehpp_1344',['chebyshev_u.hpp',['../chebyshev__u_8hpp.html',1,'']]], + ['chisquare_2ehpp_1345',['chiSquare.hpp',['../chi_square_8hpp.html',1,'']]], + ['choice_2ehpp_1346',['choice.hpp',['../choice_8hpp.html',1,'']]], + ['cholesky_2ehpp_1347',['cholesky.hpp',['../cholesky_8hpp.html',1,'']]], + ['clip_2ehpp_1348',['clip.hpp',['../clip_8hpp.html',1,'']]], + ['cluster_2ehpp_1349',['Cluster.hpp',['../_cluster_8hpp.html',1,'']]], + ['clustermaker_2ehpp_1350',['ClusterMaker.hpp',['../_cluster_maker_8hpp.html',1,'']]], + ['clusterpixels_2ehpp_1351',['clusterPixels.hpp',['../cluster_pixels_8hpp.html',1,'']]], + ['cnr_2ehpp_1352',['cnr.hpp',['../cnr_8hpp.html',1,'']]], + ['column_5fstack_2ehpp_1353',['column_stack.hpp',['../column__stack_8hpp.html',1,'']]], + ['comp_5fellint_5f1_2ehpp_1354',['comp_ellint_1.hpp',['../comp__ellint__1_8hpp.html',1,'']]], + ['comp_5fellint_5f2_2ehpp_1355',['comp_ellint_2.hpp',['../comp__ellint__2_8hpp.html',1,'']]], + ['comp_5fellint_5f3_2ehpp_1356',['comp_ellint_3.hpp',['../comp__ellint__3_8hpp.html',1,'']]], + ['compilerflags_2emd_1357',['CompilerFlags.md',['../_compiler_flags_8md.html',1,'']]], + ['complementarymedianfilter_2ehpp_1358',['complementaryMedianFilter.hpp',['../complementary_median_filter_8hpp.html',1,'']]], + ['complementarymedianfilter1d_2ehpp_1359',['complementaryMedianFilter1d.hpp',['../complementary_median_filter1d_8hpp.html',1,'']]], + ['complex_2ehpp_1360',['complex.hpp',['../complex_8hpp.html',1,'']]], + ['concatenate_2ehpp_1361',['concatenate.hpp',['../concatenate_8hpp.html',1,'']]], + ['conj_2ehpp_1362',['conj.hpp',['../conj_8hpp.html',1,'']]], + ['constant1d_2ehpp_1363',['constant1d.hpp',['../constant1d_8hpp.html',1,'']]], + ['constant2d_2ehpp_1364',['constant2d.hpp',['../constant2d_8hpp.html',1,'']]], + ['constants_2ehpp_1365',['Constants.hpp',['../_constants_8hpp.html',1,'']]], + ['contains_2ehpp_1366',['contains.hpp',['../contains_8hpp.html',1,'']]], + ['convolve_2ehpp_1367',['convolve.hpp',['../convolve_8hpp.html',1,'']]], + ['convolve1d_2ehpp_1368',['convolve1d.hpp',['../convolve1d_8hpp.html',1,'']]], + ['coordinate_2ehpp_1369',['Coordinate.hpp',['../_coordinate_8hpp.html',1,'']]], + ['coordinates_2ehpp_1370',['Coordinates.hpp',['../_coordinates_8hpp.html',1,'']]], + ['copy_2ehpp_1371',['copy.hpp',['../copy_8hpp.html',1,'']]], + ['copysign_2ehpp_1372',['copySign.hpp',['../copy_sign_8hpp.html',1,'']]], + ['copyto_2ehpp_1373',['copyto.hpp',['../copyto_8hpp.html',1,'']]], + ['core_2ehpp_1374',['Core.hpp',['../_core_8hpp.html',1,'']]], + ['corrcoef_2ehpp_1375',['corrcoef.hpp',['../corrcoef_8hpp.html',1,'']]], + ['cos_2ehpp_1376',['cos.hpp',['../cos_8hpp.html',1,'']]], + ['cosh_2ehpp_1377',['cosh.hpp',['../cosh_8hpp.html',1,'']]], + ['count_5fnonzero_2ehpp_1378',['count_nonzero.hpp',['../count__nonzero_8hpp.html',1,'']]], + ['cov_2ehpp_1379',['cov.hpp',['../cov_8hpp.html',1,'']]], + ['cov_5finv_2ehpp_1380',['cov_inv.hpp',['../cov__inv_8hpp.html',1,'']]], + ['cross_2ehpp_1381',['cross.hpp',['../cross_8hpp.html',1,'']]], + ['cumprod_2ehpp_1382',['cumprod.hpp',['../cumprod_8hpp.html',1,'']]], + ['cumsum_2ehpp_1383',['cumsum.hpp',['../cumsum_8hpp.html',1,'']]], + ['cyclic_5fhankel_5f1_2ehpp_1384',['cyclic_hankel_1.hpp',['../cyclic__hankel__1_8hpp.html',1,'']]], + ['cyclic_5fhankel_5f2_2ehpp_1385',['cyclic_hankel_2.hpp',['../cyclic__hankel__2_8hpp.html',1,'']]], + ['shape_2ehpp_1386',['Shape.hpp',['../_core_2_shape_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_3.html b/docs/doxygen/html/search/files_3.html index 982b95229..1ba106b2d 100644 --- a/docs/doxygen/html/search/files_3.html +++ b/docs/doxygen/html/search/files_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_3.js b/docs/doxygen/html/search/files_3.js index 0e1340ee9..a619217cb 100644 --- a/docs/doxygen/html/search/files_3.js +++ b/docs/doxygen/html/search/files_3.js @@ -1,22 +1,22 @@ var searchData= [ - ['datacube_2ehpp_1326',['DataCube.hpp',['../_data_cube_8hpp.html',1,'']]], - ['dcm_2ehpp_1327',['DCM.hpp',['../_d_c_m_8hpp.html',1,'']]], - ['dec_2ehpp_1328',['Dec.hpp',['../_dec_8hpp.html',1,'']]], - ['deg2rad_2ehpp_1329',['deg2rad.hpp',['../deg2rad_8hpp.html',1,'']]], - ['degrees_2ehpp_1330',['degrees.hpp',['../degrees_8hpp.html',1,'']]], - ['degreeseperation_2ehpp_1331',['degreeSeperation.hpp',['../degree_seperation_8hpp.html',1,'']]], - ['dekker_2ehpp_1332',['Dekker.hpp',['../_dekker_8hpp.html',1,'']]], - ['deleteindices_2ehpp_1333',['deleteIndices.hpp',['../delete_indices_8hpp.html',1,'']]], - ['det_2ehpp_1334',['det.hpp',['../det_8hpp.html',1,'']]], - ['diag_2ehpp_1335',['diag.hpp',['../diag_8hpp.html',1,'']]], - ['diagflat_2ehpp_1336',['diagflat.hpp',['../diagflat_8hpp.html',1,'']]], - ['diagonal_2ehpp_1337',['diagonal.hpp',['../diagonal_8hpp.html',1,'']]], - ['diff_2ehpp_1338',['diff.hpp',['../diff_8hpp.html',1,'']]], - ['digamma_2ehpp_1339',['digamma.hpp',['../digamma_8hpp.html',1,'']]], - ['discrete_2ehpp_1340',['discrete.hpp',['../discrete_8hpp.html',1,'']]], - ['divide_2ehpp_1341',['divide.hpp',['../divide_8hpp.html',1,'']]], - ['dot_2ehpp_1342',['dot.hpp',['../dot_8hpp.html',1,'']]], - ['dtypeinfo_2ehpp_1343',['DtypeInfo.hpp',['../_dtype_info_8hpp.html',1,'']]], - ['dump_2ehpp_1344',['dump.hpp',['../dump_8hpp.html',1,'']]] + ['datacube_2ehpp_1387',['DataCube.hpp',['../_data_cube_8hpp.html',1,'']]], + ['dcm_2ehpp_1388',['DCM.hpp',['../_d_c_m_8hpp.html',1,'']]], + ['dec_2ehpp_1389',['Dec.hpp',['../_dec_8hpp.html',1,'']]], + ['deg2rad_2ehpp_1390',['deg2rad.hpp',['../deg2rad_8hpp.html',1,'']]], + ['degrees_2ehpp_1391',['degrees.hpp',['../degrees_8hpp.html',1,'']]], + ['degreeseperation_2ehpp_1392',['degreeSeperation.hpp',['../degree_seperation_8hpp.html',1,'']]], + ['dekker_2ehpp_1393',['Dekker.hpp',['../_dekker_8hpp.html',1,'']]], + ['deleteindices_2ehpp_1394',['deleteIndices.hpp',['../delete_indices_8hpp.html',1,'']]], + ['det_2ehpp_1395',['det.hpp',['../det_8hpp.html',1,'']]], + ['diag_2ehpp_1396',['diag.hpp',['../diag_8hpp.html',1,'']]], + ['diagflat_2ehpp_1397',['diagflat.hpp',['../diagflat_8hpp.html',1,'']]], + ['diagonal_2ehpp_1398',['diagonal.hpp',['../diagonal_8hpp.html',1,'']]], + ['diff_2ehpp_1399',['diff.hpp',['../diff_8hpp.html',1,'']]], + ['digamma_2ehpp_1400',['digamma.hpp',['../digamma_8hpp.html',1,'']]], + ['discrete_2ehpp_1401',['discrete.hpp',['../discrete_8hpp.html',1,'']]], + ['divide_2ehpp_1402',['divide.hpp',['../divide_8hpp.html',1,'']]], + ['dot_2ehpp_1403',['dot.hpp',['../dot_8hpp.html',1,'']]], + ['dtypeinfo_2ehpp_1404',['DtypeInfo.hpp',['../_dtype_info_8hpp.html',1,'']]], + ['dump_2ehpp_1405',['dump.hpp',['../dump_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_4.html b/docs/doxygen/html/search/files_4.html index bcac70223..753b7b109 100644 --- a/docs/doxygen/html/search/files_4.html +++ b/docs/doxygen/html/search/files_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_4.js b/docs/doxygen/html/search/files_4.js index d5a699e87..5ee16f72a 100644 --- a/docs/doxygen/html/search/files_4.js +++ b/docs/doxygen/html/search/files_4.js @@ -1,24 +1,25 @@ var searchData= [ - ['ellint_5f1_2ehpp_1345',['ellint_1.hpp',['../ellint__1_8hpp.html',1,'']]], - ['ellint_5f2_2ehpp_1346',['ellint_2.hpp',['../ellint__2_8hpp.html',1,'']]], - ['ellint_5f3_2ehpp_1347',['ellint_3.hpp',['../ellint__3_8hpp.html',1,'']]], - ['empty_2ehpp_1348',['empty.hpp',['../empty_8hpp.html',1,'']]], - ['empty_5flike_2ehpp_1349',['empty_like.hpp',['../empty__like_8hpp.html',1,'']]], - ['endian_2ehpp_1350',['Endian.hpp',['../_endian_8hpp.html',1,'']]], - ['endianess_2ehpp_1351',['endianess.hpp',['../endianess_8hpp.html',1,'']]], - ['equal_2ehpp_1352',['equal.hpp',['../equal_8hpp.html',1,'']]], - ['erf_2ehpp_1353',['erf.hpp',['../erf_8hpp.html',1,'']]], - ['erf_5finv_2ehpp_1354',['erf_inv.hpp',['../erf__inv_8hpp.html',1,'']]], - ['erfc_2ehpp_1355',['erfc.hpp',['../erfc_8hpp.html',1,'']]], - ['erfc_5finv_2ehpp_1356',['erfc_inv.hpp',['../erfc__inv_8hpp.html',1,'']]], - ['error_2ehpp_1357',['Error.hpp',['../_error_8hpp.html',1,'']]], - ['essentiallyequal_2ehpp_1358',['essentiallyEqual.hpp',['../essentially_equal_8hpp.html',1,'']]], - ['exp_2ehpp_1359',['exp.hpp',['../exp_8hpp.html',1,'']]], - ['exp2_2ehpp_1360',['exp2.hpp',['../exp2_8hpp.html',1,'']]], - ['expint_2ehpp_1361',['expint.hpp',['../expint_8hpp.html',1,'']]], - ['expm1_2ehpp_1362',['expm1.hpp',['../expm1_8hpp.html',1,'']]], - ['exponential_2ehpp_1363',['exponential.hpp',['../exponential_8hpp.html',1,'']]], - ['extremevalue_2ehpp_1364',['extremeValue.hpp',['../extreme_value_8hpp.html',1,'']]], - ['eye_2ehpp_1365',['eye.hpp',['../eye_8hpp.html',1,'']]] + ['ellint_5f1_2ehpp_1406',['ellint_1.hpp',['../ellint__1_8hpp.html',1,'']]], + ['ellint_5f2_2ehpp_1407',['ellint_2.hpp',['../ellint__2_8hpp.html',1,'']]], + ['ellint_5f3_2ehpp_1408',['ellint_3.hpp',['../ellint__3_8hpp.html',1,'']]], + ['empty_2ehpp_1409',['empty.hpp',['../empty_8hpp.html',1,'']]], + ['empty_5flike_2ehpp_1410',['empty_like.hpp',['../empty__like_8hpp.html',1,'']]], + ['endian_2ehpp_1411',['Endian.hpp',['../_endian_8hpp.html',1,'']]], + ['endianess_2ehpp_1412',['endianess.hpp',['../endianess_8hpp.html',1,'']]], + ['equal_2ehpp_1413',['equal.hpp',['../equal_8hpp.html',1,'']]], + ['erf_2ehpp_1414',['erf.hpp',['../erf_8hpp.html',1,'']]], + ['erf_5finv_2ehpp_1415',['erf_inv.hpp',['../erf__inv_8hpp.html',1,'']]], + ['erfc_2ehpp_1416',['erfc.hpp',['../erfc_8hpp.html',1,'']]], + ['erfc_5finv_2ehpp_1417',['erfc_inv.hpp',['../erfc__inv_8hpp.html',1,'']]], + ['error_2ehpp_1418',['Error.hpp',['../_error_8hpp.html',1,'']]], + ['essentiallyequal_2ehpp_1419',['essentiallyEqual.hpp',['../essentially_equal_8hpp.html',1,'']]], + ['exp_2ehpp_1420',['exp.hpp',['../exp_8hpp.html',1,'']]], + ['exp2_2ehpp_1421',['exp2.hpp',['../exp2_8hpp.html',1,'']]], + ['expint_2ehpp_1422',['expint.hpp',['../expint_8hpp.html',1,'']]], + ['expm1_2ehpp_1423',['expm1.hpp',['../expm1_8hpp.html',1,'']]], + ['exponential_2ehpp_1424',['exponential.hpp',['../exponential_8hpp.html',1,'']]], + ['extract_2ehpp_1425',['extract.hpp',['../extract_8hpp.html',1,'']]], + ['extremevalue_2ehpp_1426',['extremeValue.hpp',['../extreme_value_8hpp.html',1,'']]], + ['eye_2ehpp_1427',['eye.hpp',['../eye_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_5.html b/docs/doxygen/html/search/files_5.html index 9b2d69718..7b6affd7f 100644 --- a/docs/doxygen/html/search/files_5.html +++ b/docs/doxygen/html/search/files_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_5.js b/docs/doxygen/html/search/files_5.js index 52cf2a27c..d8eaccae9 100644 --- a/docs/doxygen/html/search/files_5.js +++ b/docs/doxygen/html/search/files_5.js @@ -1,33 +1,33 @@ var searchData= [ - ['cube_2ehpp_1366',['cube.hpp',['../_functions_2cube_8hpp.html',1,'']]], - ['f_2ehpp_1367',['f.hpp',['../f_8hpp.html',1,'']]], - ['factorial_2ehpp_1368',['factorial.hpp',['../factorial_8hpp.html',1,'']]], - ['filesystem_2ehpp_1369',['Filesystem.hpp',['../_filesystem_8hpp.html',1,'']]], - ['fillcorners_2ehpp_1370',['fillCorners.hpp',['../fill_corners_8hpp.html',1,'']]], - ['filldiagnol_2ehpp_1371',['fillDiagnol.hpp',['../fill_diagnol_8hpp.html',1,'']]], - ['filter_2ehpp_1372',['Filter.hpp',['../_filter_8hpp.html',1,'']]], - ['find_2ehpp_1373',['find.hpp',['../find_8hpp.html',1,'']]], - ['fix_2ehpp_1374',['fix.hpp',['../fix_8hpp.html',1,'']]], - ['flatnonzero_2ehpp_1375',['flatnonzero.hpp',['../flatnonzero_8hpp.html',1,'']]], - ['flatten_2ehpp_1376',['flatten.hpp',['../flatten_8hpp.html',1,'']]], - ['flip_2ehpp_1377',['flip.hpp',['../flip_8hpp.html',1,'']]], - ['fliplr_2ehpp_1378',['fliplr.hpp',['../fliplr_8hpp.html',1,'']]], - ['flipud_2ehpp_1379',['flipud.hpp',['../flipud_8hpp.html',1,'']]], - ['floor_2ehpp_1380',['floor.hpp',['../floor_8hpp.html',1,'']]], - ['floor_5fdivide_2ehpp_1381',['floor_divide.hpp',['../floor__divide_8hpp.html',1,'']]], - ['fmax_2ehpp_1382',['fmax.hpp',['../fmax_8hpp.html',1,'']]], - ['fmin_2ehpp_1383',['fmin.hpp',['../fmin_8hpp.html',1,'']]], - ['fmod_2ehpp_1384',['fmod.hpp',['../fmod_8hpp.html',1,'']]], - ['frombuffer_2ehpp_1385',['frombuffer.hpp',['../frombuffer_8hpp.html',1,'']]], - ['fromfile_2ehpp_1386',['fromfile.hpp',['../fromfile_8hpp.html',1,'']]], - ['fromiter_2ehpp_1387',['fromiter.hpp',['../fromiter_8hpp.html',1,'']]], - ['full_2ehpp_1388',['full.hpp',['../full_8hpp.html',1,'']]], - ['full_5flike_2ehpp_1389',['full_like.hpp',['../full__like_8hpp.html',1,'']]], - ['functions_2ehpp_1390',['Functions.hpp',['../_functions_8hpp.html',1,'']]], - ['interp_2ehpp_1391',['interp.hpp',['../_functions_2interp_8hpp.html',1,'']]], - ['laplace_2ehpp_1392',['laplace.hpp',['../_filter_2_filters_2_filters2d_2laplace_8hpp.html',1,'']]], - ['power_2ehpp_1393',['power.hpp',['../_functions_2power_8hpp.html',1,'']]], - ['powerf_2ehpp_1394',['powerf.hpp',['../_functions_2powerf_8hpp.html',1,'']]], - ['shape_2ehpp_1395',['shape.hpp',['../_functions_2_shape_8hpp.html',1,'']]] + ['cube_2ehpp_1428',['cube.hpp',['../_functions_2cube_8hpp.html',1,'']]], + ['f_2ehpp_1429',['f.hpp',['../f_8hpp.html',1,'']]], + ['factorial_2ehpp_1430',['factorial.hpp',['../factorial_8hpp.html',1,'']]], + ['filesystem_2ehpp_1431',['Filesystem.hpp',['../_filesystem_8hpp.html',1,'']]], + ['fillcorners_2ehpp_1432',['fillCorners.hpp',['../fill_corners_8hpp.html',1,'']]], + ['filldiagnol_2ehpp_1433',['fillDiagnol.hpp',['../fill_diagnol_8hpp.html',1,'']]], + ['filter_2ehpp_1434',['Filter.hpp',['../_filter_8hpp.html',1,'']]], + ['find_2ehpp_1435',['find.hpp',['../find_8hpp.html',1,'']]], + ['fix_2ehpp_1436',['fix.hpp',['../fix_8hpp.html',1,'']]], + ['flatnonzero_2ehpp_1437',['flatnonzero.hpp',['../flatnonzero_8hpp.html',1,'']]], + ['flatten_2ehpp_1438',['flatten.hpp',['../flatten_8hpp.html',1,'']]], + ['flip_2ehpp_1439',['flip.hpp',['../flip_8hpp.html',1,'']]], + ['fliplr_2ehpp_1440',['fliplr.hpp',['../fliplr_8hpp.html',1,'']]], + ['flipud_2ehpp_1441',['flipud.hpp',['../flipud_8hpp.html',1,'']]], + ['floor_2ehpp_1442',['floor.hpp',['../floor_8hpp.html',1,'']]], + ['floor_5fdivide_2ehpp_1443',['floor_divide.hpp',['../floor__divide_8hpp.html',1,'']]], + ['fmax_2ehpp_1444',['fmax.hpp',['../fmax_8hpp.html',1,'']]], + ['fmin_2ehpp_1445',['fmin.hpp',['../fmin_8hpp.html',1,'']]], + ['fmod_2ehpp_1446',['fmod.hpp',['../fmod_8hpp.html',1,'']]], + ['frombuffer_2ehpp_1447',['frombuffer.hpp',['../frombuffer_8hpp.html',1,'']]], + ['fromfile_2ehpp_1448',['fromfile.hpp',['../fromfile_8hpp.html',1,'']]], + ['fromiter_2ehpp_1449',['fromiter.hpp',['../fromiter_8hpp.html',1,'']]], + ['full_2ehpp_1450',['full.hpp',['../full_8hpp.html',1,'']]], + ['full_5flike_2ehpp_1451',['full_like.hpp',['../full__like_8hpp.html',1,'']]], + ['functions_2ehpp_1452',['Functions.hpp',['../_functions_8hpp.html',1,'']]], + ['interp_2ehpp_1453',['interp.hpp',['../_functions_2interp_8hpp.html',1,'']]], + ['laplace_2ehpp_1454',['laplace.hpp',['../_filter_2_filters_2_filters2d_2laplace_8hpp.html',1,'']]], + ['power_2ehpp_1455',['power.hpp',['../_functions_2power_8hpp.html',1,'']]], + ['powerf_2ehpp_1456',['powerf.hpp',['../_functions_2powerf_8hpp.html',1,'']]], + ['shape_2ehpp_1457',['shape.hpp',['../_functions_2_shape_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_6.html b/docs/doxygen/html/search/files_6.html index 087793155..802ebf715 100644 --- a/docs/doxygen/html/search/files_6.html +++ b/docs/doxygen/html/search/files_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_6.js b/docs/doxygen/html/search/files_6.js index bd48f2d76..6406d7db9 100644 --- a/docs/doxygen/html/search/files_6.js +++ b/docs/doxygen/html/search/files_6.js @@ -1,18 +1,19 @@ var searchData= [ - ['gamma1pm1_2ehpp_1396',['gamma1pm1.hpp',['../gamma1pm1_8hpp.html',1,'']]], - ['gauss_5flegendre_2ehpp_1397',['gauss_legendre.hpp',['../gauss__legendre_8hpp.html',1,'']]], - ['gaussian_2ehpp_1398',['gaussian.hpp',['../gaussian_8hpp.html',1,'']]], - ['gaussian1d_2ehpp_1399',['gaussian1d.hpp',['../gaussian1d_8hpp.html',1,'']]], - ['gaussianfilter_2ehpp_1400',['gaussianFilter.hpp',['../gaussian_filter_8hpp.html',1,'']]], - ['gaussianfilter1d_2ehpp_1401',['gaussianFilter1d.hpp',['../gaussian_filter1d_8hpp.html',1,'']]], - ['gaussnewtonnlls_2ehpp_1402',['gaussNewtonNlls.hpp',['../gauss_newton_nlls_8hpp.html',1,'']]], - ['gcd_2ehpp_1403',['gcd.hpp',['../gcd_8hpp.html',1,'']]], - ['generatecentroids_2ehpp_1404',['generateCentroids.hpp',['../generate_centroids_8hpp.html',1,'']]], - ['generatethreshold_2ehpp_1405',['generateThreshold.hpp',['../generate_threshold_8hpp.html',1,'']]], - ['generator_2ehpp_1406',['generator.hpp',['../generator_8hpp.html',1,'']]], - ['geometric_2ehpp_1407',['geometric.hpp',['../geometric_8hpp.html',1,'']]], - ['gradient_2ehpp_1408',['gradient.hpp',['../gradient_8hpp.html',1,'']]], - ['greater_2ehpp_1409',['greater.hpp',['../greater_8hpp.html',1,'']]], - ['greater_5fequal_2ehpp_1410',['greater_equal.hpp',['../greater__equal_8hpp.html',1,'']]] + ['gamma1pm1_2ehpp_1458',['gamma1pm1.hpp',['../gamma1pm1_8hpp.html',1,'']]], + ['gauss_5flegendre_2ehpp_1459',['gauss_legendre.hpp',['../gauss__legendre_8hpp.html',1,'']]], + ['gaussian_2ehpp_1460',['gaussian.hpp',['../gaussian_8hpp.html',1,'']]], + ['gaussian1d_2ehpp_1461',['gaussian1d.hpp',['../gaussian1d_8hpp.html',1,'']]], + ['gaussianfilter_2ehpp_1462',['gaussianFilter.hpp',['../gaussian_filter_8hpp.html',1,'']]], + ['gaussianfilter1d_2ehpp_1463',['gaussianFilter1d.hpp',['../gaussian_filter1d_8hpp.html',1,'']]], + ['gaussnewtonnlls_2ehpp_1464',['gaussNewtonNlls.hpp',['../gauss_newton_nlls_8hpp.html',1,'']]], + ['gcd_2ehpp_1465',['gcd.hpp',['../gcd_8hpp.html',1,'']]], + ['generatecentroids_2ehpp_1466',['generateCentroids.hpp',['../generate_centroids_8hpp.html',1,'']]], + ['generatethreshold_2ehpp_1467',['generateThreshold.hpp',['../generate_threshold_8hpp.html',1,'']]], + ['generator_2ehpp_1468',['generator.hpp',['../generator_8hpp.html',1,'']]], + ['geometric_2ehpp_1469',['geometric.hpp',['../geometric_8hpp.html',1,'']]], + ['geomspace_2ehpp_1470',['geomspace.hpp',['../geomspace_8hpp.html',1,'']]], + ['gradient_2ehpp_1471',['gradient.hpp',['../gradient_8hpp.html',1,'']]], + ['greater_2ehpp_1472',['greater.hpp',['../greater_8hpp.html',1,'']]], + ['greater_5fequal_2ehpp_1473',['greater_equal.hpp',['../greater__equal_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_7.html b/docs/doxygen/html/search/files_7.html index c02d5f4d2..365e6484f 100644 --- a/docs/doxygen/html/search/files_7.html +++ b/docs/doxygen/html/search/files_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_7.js b/docs/doxygen/html/search/files_7.js index e054fcb13..b7a0088b0 100644 --- a/docs/doxygen/html/search/files_7.js +++ b/docs/doxygen/html/search/files_7.js @@ -1,8 +1,11 @@ var searchData= [ - ['hat_2ehpp_1411',['hat.hpp',['../hat_8hpp.html',1,'']]], - ['hermite_2ehpp_1412',['hermite.hpp',['../hermite_8hpp.html',1,'']]], - ['histogram_2ehpp_1413',['histogram.hpp',['../histogram_8hpp.html',1,'']]], - ['hstack_2ehpp_1414',['hstack.hpp',['../hstack_8hpp.html',1,'']]], - ['hypot_2ehpp_1415',['hypot.hpp',['../hypot_8hpp.html',1,'']]] + ['hamming_2ehpp_1474',['hamming.hpp',['../hamming_8hpp.html',1,'']]], + ['hammingencode_2ehpp_1475',['hammingEncode.hpp',['../hamming_encode_8hpp.html',1,'']]], + ['hanning_2ehpp_1476',['hanning.hpp',['../hanning_8hpp.html',1,'']]], + ['hat_2ehpp_1477',['hat.hpp',['../hat_8hpp.html',1,'']]], + ['hermite_2ehpp_1478',['hermite.hpp',['../hermite_8hpp.html',1,'']]], + ['histogram_2ehpp_1479',['histogram.hpp',['../histogram_8hpp.html',1,'']]], + ['hstack_2ehpp_1480',['hstack.hpp',['../hstack_8hpp.html',1,'']]], + ['hypot_2ehpp_1481',['hypot.hpp',['../hypot_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_8.html b/docs/doxygen/html/search/files_8.html index 03ad9ee60..3df0f2fae 100644 --- a/docs/doxygen/html/search/files_8.html +++ b/docs/doxygen/html/search/files_8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_8.js b/docs/doxygen/html/search/files_8.js index 4b59d6663..799bbd0d3 100644 --- a/docs/doxygen/html/search/files_8.js +++ b/docs/doxygen/html/search/files_8.js @@ -1,15 +1,18 @@ var searchData= [ - ['identity_2ehpp_1416',['identity.hpp',['../identity_8hpp.html',1,'']]], - ['imag_2ehpp_1417',['imag.hpp',['../imag_8hpp.html',1,'']]], - ['imageprocessing_2ehpp_1418',['ImageProcessing.hpp',['../_image_processing_8hpp.html',1,'']]], - ['installation_2emd_1419',['Installation.md',['../_installation_8md.html',1,'']]], - ['integrate_2ehpp_1420',['Integrate.hpp',['../_integrate_8hpp.html',1,'']]], - ['intersect1d_2ehpp_1421',['intersect1d.hpp',['../intersect1d_8hpp.html',1,'']]], - ['inv_2ehpp_1422',['inv.hpp',['../inv_8hpp.html',1,'']]], - ['invert_2ehpp_1423',['invert.hpp',['../invert_8hpp.html',1,'']]], - ['isclose_2ehpp_1424',['isclose.hpp',['../isclose_8hpp.html',1,'']]], - ['isinf_2ehpp_1425',['isinf.hpp',['../isinf_8hpp.html',1,'']]], - ['isnan_2ehpp_1426',['isnan.hpp',['../isnan_8hpp.html',1,'']]], - ['iteration_2ehpp_1427',['Iteration.hpp',['../_iteration_8hpp.html',1,'']]] + ['identity_2ehpp_1482',['identity.hpp',['../identity_8hpp.html',1,'']]], + ['imag_2ehpp_1483',['imag.hpp',['../imag_8hpp.html',1,'']]], + ['imageprocessing_2ehpp_1484',['ImageProcessing.hpp',['../_image_processing_8hpp.html',1,'']]], + ['inner_2ehpp_1485',['inner.hpp',['../inner_8hpp.html',1,'']]], + ['installation_2emd_1486',['Installation.md',['../_installation_8md.html',1,'']]], + ['integrate_2ehpp_1487',['Integrate.hpp',['../_integrate_8hpp.html',1,'']]], + ['intersect1d_2ehpp_1488',['intersect1d.hpp',['../intersect1d_8hpp.html',1,'']]], + ['inv_2ehpp_1489',['inv.hpp',['../inv_8hpp.html',1,'']]], + ['invert_2ehpp_1490',['invert.hpp',['../invert_8hpp.html',1,'']]], + ['isclose_2ehpp_1491',['isclose.hpp',['../isclose_8hpp.html',1,'']]], + ['isinf_2ehpp_1492',['isinf.hpp',['../isinf_8hpp.html',1,'']]], + ['isnan_2ehpp_1493',['isnan.hpp',['../isnan_8hpp.html',1,'']]], + ['isneginf_2ehpp_1494',['isneginf.hpp',['../isneginf_8hpp.html',1,'']]], + ['isposinf_2ehpp_1495',['isposinf.hpp',['../isposinf_8hpp.html',1,'']]], + ['iteration_2ehpp_1496',['Iteration.hpp',['../_iteration_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_9.html b/docs/doxygen/html/search/files_9.html index 0e459a2cd..52f8b6c07 100644 --- a/docs/doxygen/html/search/files_9.html +++ b/docs/doxygen/html/search/files_9.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_9.js b/docs/doxygen/html/search/files_9.js index 4aa28c796..75de83199 100644 --- a/docs/doxygen/html/search/files_9.js +++ b/docs/doxygen/html/search/files_9.js @@ -1,26 +1,4 @@ var searchData= [ - ['laguerre_2ehpp_1428',['laguerre.hpp',['../laguerre_8hpp.html',1,'']]], - ['lcm_2ehpp_1429',['lcm.hpp',['../lcm_8hpp.html',1,'']]], - ['ldexp_2ehpp_1430',['ldexp.hpp',['../ldexp_8hpp.html',1,'']]], - ['left_5fshift_2ehpp_1431',['left_shift.hpp',['../left__shift_8hpp.html',1,'']]], - ['legendre_5fp_2ehpp_1432',['legendre_p.hpp',['../legendre__p_8hpp.html',1,'']]], - ['legendre_5fq_2ehpp_1433',['legendre_q.hpp',['../legendre__q_8hpp.html',1,'']]], - ['less_2ehpp_1434',['less.hpp',['../less_8hpp.html',1,'']]], - ['less_5fequal_2ehpp_1435',['less_equal.hpp',['../less__equal_8hpp.html',1,'']]], - ['linalg_2ehpp_1436',['Linalg.hpp',['../_linalg_8hpp.html',1,'']]], - ['linspace_2ehpp_1437',['linspace.hpp',['../linspace_8hpp.html',1,'']]], - ['load_2ehpp_1438',['load.hpp',['../load_8hpp.html',1,'']]], - ['log_2ehpp_1439',['log.hpp',['../log_8hpp.html',1,'']]], - ['log10_2ehpp_1440',['log10.hpp',['../log10_8hpp.html',1,'']]], - ['log1p_2ehpp_1441',['log1p.hpp',['../log1p_8hpp.html',1,'']]], - ['log2_2ehpp_1442',['log2.hpp',['../log2_8hpp.html',1,'']]], - ['log_5fgamma_2ehpp_1443',['log_gamma.hpp',['../log__gamma_8hpp.html',1,'']]], - ['logical_5fand_2ehpp_1444',['logical_and.hpp',['../logical__and_8hpp.html',1,'']]], - ['logical_5fnot_2ehpp_1445',['logical_not.hpp',['../logical__not_8hpp.html',1,'']]], - ['logical_5for_2ehpp_1446',['logical_or.hpp',['../logical__or_8hpp.html',1,'']]], - ['logical_5fxor_2ehpp_1447',['logical_xor.hpp',['../logical__xor_8hpp.html',1,'']]], - ['lognormal_2ehpp_1448',['lognormal.hpp',['../lognormal_8hpp.html',1,'']]], - ['lstsq_2ehpp_1449',['lstsq.hpp',['../lstsq_8hpp.html',1,'']]], - ['lu_5fdecomposition_2ehpp_1450',['lu_decomposition.hpp',['../lu__decomposition_8hpp.html',1,'']]] + ['kaiser_2ehpp_1497',['kaiser.hpp',['../kaiser_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_a.html b/docs/doxygen/html/search/files_a.html index 53adebcf8..11d4c117b 100644 --- a/docs/doxygen/html/search/files_a.html +++ b/docs/doxygen/html/search/files_a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_a.js b/docs/doxygen/html/search/files_a.js index 64546ddd1..1c541cf49 100644 --- a/docs/doxygen/html/search/files_a.js +++ b/docs/doxygen/html/search/files_a.js @@ -1,23 +1,28 @@ var searchData= [ - ['matmul_2ehpp_1451',['matmul.hpp',['../matmul_8hpp.html',1,'']]], - ['matrix_5fpower_2ehpp_1452',['matrix_power.hpp',['../matrix__power_8hpp.html',1,'']]], - ['max_2ehpp_1453',['max.hpp',['../max_8hpp.html',1,'']]], - ['maximum_2ehpp_1454',['maximum.hpp',['../maximum_8hpp.html',1,'']]], - ['maximumfilter_2ehpp_1455',['maximumFilter.hpp',['../maximum_filter_8hpp.html',1,'']]], - ['maximumfilter1d_2ehpp_1456',['maximumFilter1d.hpp',['../maximum_filter1d_8hpp.html',1,'']]], - ['mean_2ehpp_1457',['mean.hpp',['../mean_8hpp.html',1,'']]], - ['median_2ehpp_1458',['median.hpp',['../median_8hpp.html',1,'']]], - ['medianfilter_2ehpp_1459',['medianFilter.hpp',['../median_filter_8hpp.html',1,'']]], - ['medianfilter1d_2ehpp_1460',['medianFilter1d.hpp',['../median_filter1d_8hpp.html',1,'']]], - ['meshgrid_2ehpp_1461',['meshgrid.hpp',['../meshgrid_8hpp.html',1,'']]], - ['min_2ehpp_1462',['min.hpp',['../min_8hpp.html',1,'']]], - ['minimum_2ehpp_1463',['minimum.hpp',['../minimum_8hpp.html',1,'']]], - ['minimumfilter_2ehpp_1464',['minimumFilter.hpp',['../minimum_filter_8hpp.html',1,'']]], - ['minimumfilter1d_2ehpp_1465',['minimumFilter1d.hpp',['../minimum_filter1d_8hpp.html',1,'']]], - ['mirror1d_2ehpp_1466',['mirror1d.hpp',['../mirror1d_8hpp.html',1,'']]], - ['mirror2d_2ehpp_1467',['mirror2d.hpp',['../mirror2d_8hpp.html',1,'']]], - ['mod_2ehpp_1468',['mod.hpp',['../mod_8hpp.html',1,'']]], - ['multi_5fdot_2ehpp_1469',['multi_dot.hpp',['../multi__dot_8hpp.html',1,'']]], - ['multiply_2ehpp_1470',['multiply.hpp',['../multiply_8hpp.html',1,'']]] + ['laguerre_2ehpp_1498',['laguerre.hpp',['../laguerre_8hpp.html',1,'']]], + ['lcm_2ehpp_1499',['lcm.hpp',['../lcm_8hpp.html',1,'']]], + ['ldexp_2ehpp_1500',['ldexp.hpp',['../ldexp_8hpp.html',1,'']]], + ['left_5fshift_2ehpp_1501',['left_shift.hpp',['../left__shift_8hpp.html',1,'']]], + ['legendre_5fp_2ehpp_1502',['legendre_p.hpp',['../legendre__p_8hpp.html',1,'']]], + ['legendre_5fq_2ehpp_1503',['legendre_q.hpp',['../legendre__q_8hpp.html',1,'']]], + ['less_2ehpp_1504',['less.hpp',['../less_8hpp.html',1,'']]], + ['less_5fequal_2ehpp_1505',['less_equal.hpp',['../less__equal_8hpp.html',1,'']]], + ['linalg_2ehpp_1506',['Linalg.hpp',['../_linalg_8hpp.html',1,'']]], + ['linspace_2ehpp_1507',['linspace.hpp',['../linspace_8hpp.html',1,'']]], + ['load_2ehpp_1508',['load.hpp',['../load_8hpp.html',1,'']]], + ['log_2ehpp_1509',['log.hpp',['../log_8hpp.html',1,'']]], + ['log10_2ehpp_1510',['log10.hpp',['../log10_8hpp.html',1,'']]], + ['log1p_2ehpp_1511',['log1p.hpp',['../log1p_8hpp.html',1,'']]], + ['log2_2ehpp_1512',['log2.hpp',['../log2_8hpp.html',1,'']]], + ['log_5fgamma_2ehpp_1513',['log_gamma.hpp',['../log__gamma_8hpp.html',1,'']]], + ['logb_2ehpp_1514',['logb.hpp',['../logb_8hpp.html',1,'']]], + ['logical_5fand_2ehpp_1515',['logical_and.hpp',['../logical__and_8hpp.html',1,'']]], + ['logical_5fnot_2ehpp_1516',['logical_not.hpp',['../logical__not_8hpp.html',1,'']]], + ['logical_5for_2ehpp_1517',['logical_or.hpp',['../logical__or_8hpp.html',1,'']]], + ['logical_5fxor_2ehpp_1518',['logical_xor.hpp',['../logical__xor_8hpp.html',1,'']]], + ['lognormal_2ehpp_1519',['lognormal.hpp',['../lognormal_8hpp.html',1,'']]], + ['logspace_2ehpp_1520',['logspace.hpp',['../logspace_8hpp.html',1,'']]], + ['lstsq_2ehpp_1521',['lstsq.hpp',['../lstsq_8hpp.html',1,'']]], + ['lu_5fdecomposition_2ehpp_1522',['lu_decomposition.hpp',['../lu__decomposition_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_b.html b/docs/doxygen/html/search/files_b.html index d676c8396..9fc83436a 100644 --- a/docs/doxygen/html/search/files_b.html +++ b/docs/doxygen/html/search/files_b.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_b.js b/docs/doxygen/html/search/files_b.js index 985e28120..428077d00 100644 --- a/docs/doxygen/html/search/files_b.js +++ b/docs/doxygen/html/search/files_b.js @@ -1,38 +1,23 @@ var searchData= [ - ['nan_5fto_5fnum_2ehpp_1471',['nan_to_num.hpp',['../nan__to__num_8hpp.html',1,'']]], - ['nanargmax_2ehpp_1472',['nanargmax.hpp',['../nanargmax_8hpp.html',1,'']]], - ['nanargmin_2ehpp_1473',['nanargmin.hpp',['../nanargmin_8hpp.html',1,'']]], - ['nancumprod_2ehpp_1474',['nancumprod.hpp',['../nancumprod_8hpp.html',1,'']]], - ['nancumsum_2ehpp_1475',['nancumsum.hpp',['../nancumsum_8hpp.html',1,'']]], - ['nanmax_2ehpp_1476',['nanmax.hpp',['../nanmax_8hpp.html',1,'']]], - ['nanmean_2ehpp_1477',['nanmean.hpp',['../nanmean_8hpp.html',1,'']]], - ['nanmedian_2ehpp_1478',['nanmedian.hpp',['../nanmedian_8hpp.html',1,'']]], - ['nanmin_2ehpp_1479',['nanmin.hpp',['../nanmin_8hpp.html',1,'']]], - ['nanpercentile_2ehpp_1480',['nanpercentile.hpp',['../nanpercentile_8hpp.html',1,'']]], - ['nanprod_2ehpp_1481',['nanprod.hpp',['../nanprod_8hpp.html',1,'']]], - ['nans_2ehpp_1482',['nans.hpp',['../nans_8hpp.html',1,'']]], - ['nans_5flike_2ehpp_1483',['nans_like.hpp',['../nans__like_8hpp.html',1,'']]], - ['nanstdev_2ehpp_1484',['nanstdev.hpp',['../nanstdev_8hpp.html',1,'']]], - ['nansum_2ehpp_1485',['nansum.hpp',['../nansum_8hpp.html',1,'']]], - ['nanvar_2ehpp_1486',['nanvar.hpp',['../nanvar_8hpp.html',1,'']]], - ['nbytes_2ehpp_1487',['nbytes.hpp',['../nbytes_8hpp.html',1,'']]], - ['ndarray_2ehpp_1488',['NdArray.hpp',['../_nd_array_8hpp.html',1,'']]], - ['ndarraycore_2ehpp_1489',['NdArrayCore.hpp',['../_nd_array_core_8hpp.html',1,'']]], - ['ndarrayiterators_2ehpp_1490',['NdArrayIterators.hpp',['../_nd_array_iterators_8hpp.html',1,'']]], - ['ndarrayoperators_2ehpp_1491',['NdArrayOperators.hpp',['../_nd_array_operators_8hpp.html',1,'']]], - ['nearest1d_2ehpp_1492',['nearest1d.hpp',['../nearest1d_8hpp.html',1,'']]], - ['nearest2d_2ehpp_1493',['nearest2d.hpp',['../nearest2d_8hpp.html',1,'']]], - ['negative_2ehpp_1494',['negative.hpp',['../negative_8hpp.html',1,'']]], - ['negativebinomial_2ehpp_1495',['negativeBinomial.hpp',['../negative_binomial_8hpp.html',1,'']]], - ['newbyteorder_2ehpp_1496',['newbyteorder.hpp',['../newbyteorder_8hpp.html',1,'']]], - ['newton_2ehpp_1497',['Newton.hpp',['../_newton_8hpp.html',1,'']]], - ['noncentralchisquared_2ehpp_1498',['nonCentralChiSquared.hpp',['../non_central_chi_squared_8hpp.html',1,'']]], - ['none_2ehpp_1499',['none.hpp',['../none_8hpp.html',1,'']]], - ['nonzero_2ehpp_1500',['nonzero.hpp',['../nonzero_8hpp.html',1,'']]], - ['norm_2ehpp_1501',['norm.hpp',['../norm_8hpp.html',1,'']]], - ['normal_2ehpp_1502',['normal.hpp',['../normal_8hpp.html',1,'']]], - ['not_5fequal_2ehpp_1503',['not_equal.hpp',['../not__equal_8hpp.html',1,'']]], - ['num2str_2ehpp_1504',['num2str.hpp',['../num2str_8hpp.html',1,'']]], - ['numcpp_2ehpp_1505',['NumCpp.hpp',['../_num_cpp_8hpp.html',1,'']]] + ['matmul_2ehpp_1523',['matmul.hpp',['../matmul_8hpp.html',1,'']]], + ['matrix_5fpower_2ehpp_1524',['matrix_power.hpp',['../matrix__power_8hpp.html',1,'']]], + ['max_2ehpp_1525',['max.hpp',['../max_8hpp.html',1,'']]], + ['maximum_2ehpp_1526',['maximum.hpp',['../maximum_8hpp.html',1,'']]], + ['maximumfilter_2ehpp_1527',['maximumFilter.hpp',['../maximum_filter_8hpp.html',1,'']]], + ['maximumfilter1d_2ehpp_1528',['maximumFilter1d.hpp',['../maximum_filter1d_8hpp.html',1,'']]], + ['mean_2ehpp_1529',['mean.hpp',['../mean_8hpp.html',1,'']]], + ['median_2ehpp_1530',['median.hpp',['../median_8hpp.html',1,'']]], + ['medianfilter_2ehpp_1531',['medianFilter.hpp',['../median_filter_8hpp.html',1,'']]], + ['medianfilter1d_2ehpp_1532',['medianFilter1d.hpp',['../median_filter1d_8hpp.html',1,'']]], + ['meshgrid_2ehpp_1533',['meshgrid.hpp',['../meshgrid_8hpp.html',1,'']]], + ['min_2ehpp_1534',['min.hpp',['../min_8hpp.html',1,'']]], + ['minimum_2ehpp_1535',['minimum.hpp',['../minimum_8hpp.html',1,'']]], + ['minimumfilter_2ehpp_1536',['minimumFilter.hpp',['../minimum_filter_8hpp.html',1,'']]], + ['minimumfilter1d_2ehpp_1537',['minimumFilter1d.hpp',['../minimum_filter1d_8hpp.html',1,'']]], + ['mirror1d_2ehpp_1538',['mirror1d.hpp',['../mirror1d_8hpp.html',1,'']]], + ['mirror2d_2ehpp_1539',['mirror2d.hpp',['../mirror2d_8hpp.html',1,'']]], + ['mod_2ehpp_1540',['mod.hpp',['../mod_8hpp.html',1,'']]], + ['multi_5fdot_2ehpp_1541',['multi_dot.hpp',['../multi__dot_8hpp.html',1,'']]], + ['multiply_2ehpp_1542',['multiply.hpp',['../multiply_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_c.html b/docs/doxygen/html/search/files_c.html index 875db0f6a..c266b4c25 100644 --- a/docs/doxygen/html/search/files_c.html +++ b/docs/doxygen/html/search/files_c.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_c.js b/docs/doxygen/html/search/files_c.js index 982406ff3..a352756f6 100644 --- a/docs/doxygen/html/search/files_c.js +++ b/docs/doxygen/html/search/files_c.js @@ -1,6 +1,39 @@ var searchData= [ - ['ones_2ehpp_1506',['ones.hpp',['../ones_8hpp.html',1,'']]], - ['ones_5flike_2ehpp_1507',['ones_like.hpp',['../ones__like_8hpp.html',1,'']]], - ['outer_2ehpp_1508',['outer.hpp',['../outer_8hpp.html',1,'']]] + ['nan_5fto_5fnum_2ehpp_1543',['nan_to_num.hpp',['../nan__to__num_8hpp.html',1,'']]], + ['nanargmax_2ehpp_1544',['nanargmax.hpp',['../nanargmax_8hpp.html',1,'']]], + ['nanargmin_2ehpp_1545',['nanargmin.hpp',['../nanargmin_8hpp.html',1,'']]], + ['nancumprod_2ehpp_1546',['nancumprod.hpp',['../nancumprod_8hpp.html',1,'']]], + ['nancumsum_2ehpp_1547',['nancumsum.hpp',['../nancumsum_8hpp.html',1,'']]], + ['nanmax_2ehpp_1548',['nanmax.hpp',['../nanmax_8hpp.html',1,'']]], + ['nanmean_2ehpp_1549',['nanmean.hpp',['../nanmean_8hpp.html',1,'']]], + ['nanmedian_2ehpp_1550',['nanmedian.hpp',['../nanmedian_8hpp.html',1,'']]], + ['nanmin_2ehpp_1551',['nanmin.hpp',['../nanmin_8hpp.html',1,'']]], + ['nanpercentile_2ehpp_1552',['nanpercentile.hpp',['../nanpercentile_8hpp.html',1,'']]], + ['nanprod_2ehpp_1553',['nanprod.hpp',['../nanprod_8hpp.html',1,'']]], + ['nans_2ehpp_1554',['nans.hpp',['../nans_8hpp.html',1,'']]], + ['nans_5flike_2ehpp_1555',['nans_like.hpp',['../nans__like_8hpp.html',1,'']]], + ['nanstdev_2ehpp_1556',['nanstdev.hpp',['../nanstdev_8hpp.html',1,'']]], + ['nansum_2ehpp_1557',['nansum.hpp',['../nansum_8hpp.html',1,'']]], + ['nanvar_2ehpp_1558',['nanvar.hpp',['../nanvar_8hpp.html',1,'']]], + ['nbytes_2ehpp_1559',['nbytes.hpp',['../nbytes_8hpp.html',1,'']]], + ['ndarray_2ehpp_1560',['NdArray.hpp',['../_nd_array_8hpp.html',1,'']]], + ['ndarraycore_2ehpp_1561',['NdArrayCore.hpp',['../_nd_array_core_8hpp.html',1,'']]], + ['ndarrayiterators_2ehpp_1562',['NdArrayIterators.hpp',['../_nd_array_iterators_8hpp.html',1,'']]], + ['ndarrayoperators_2ehpp_1563',['NdArrayOperators.hpp',['../_nd_array_operators_8hpp.html',1,'']]], + ['nearest1d_2ehpp_1564',['nearest1d.hpp',['../nearest1d_8hpp.html',1,'']]], + ['nearest2d_2ehpp_1565',['nearest2d.hpp',['../nearest2d_8hpp.html',1,'']]], + ['negative_2ehpp_1566',['negative.hpp',['../negative_8hpp.html',1,'']]], + ['negativebinomial_2ehpp_1567',['negativeBinomial.hpp',['../negative_binomial_8hpp.html',1,'']]], + ['newbyteorder_2ehpp_1568',['newbyteorder.hpp',['../newbyteorder_8hpp.html',1,'']]], + ['newton_2ehpp_1569',['Newton.hpp',['../_newton_8hpp.html',1,'']]], + ['noncentralchisquared_2ehpp_1570',['nonCentralChiSquared.hpp',['../non_central_chi_squared_8hpp.html',1,'']]], + ['none_2ehpp_1571',['none.hpp',['../none_8hpp.html',1,'']]], + ['nonzero_2ehpp_1572',['nonzero.hpp',['../nonzero_8hpp.html',1,'']]], + ['norm_2ehpp_1573',['norm.hpp',['../norm_8hpp.html',1,'']]], + ['normal_2ehpp_1574',['normal.hpp',['../normal_8hpp.html',1,'']]], + ['not_5fequal_2ehpp_1575',['not_equal.hpp',['../not__equal_8hpp.html',1,'']]], + ['nth_5froot_2ehpp_1576',['nth_root.hpp',['../nth__root_8hpp.html',1,'']]], + ['num2str_2ehpp_1577',['num2str.hpp',['../num2str_8hpp.html',1,'']]], + ['numcpp_2ehpp_1578',['NumCpp.hpp',['../_num_cpp_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_d.html b/docs/doxygen/html/search/files_d.html index 484e7063c..d2ca3c1ca 100644 --- a/docs/doxygen/html/search/files_d.html +++ b/docs/doxygen/html/search/files_d.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_d.js b/docs/doxygen/html/search/files_d.js index b7cabd026..1a6badde8 100644 --- a/docs/doxygen/html/search/files_d.js +++ b/docs/doxygen/html/search/files_d.js @@ -1,26 +1,6 @@ var searchData= [ - ['pad_2ehpp_1509',['pad.hpp',['../pad_8hpp.html',1,'']]], - ['partition_2ehpp_1510',['partition.hpp',['../partition_8hpp.html',1,'']]], - ['percentile_2ehpp_1511',['percentile.hpp',['../percentile_8hpp.html',1,'']]], - ['percentilefilter_2ehpp_1512',['percentileFilter.hpp',['../percentile_filter_8hpp.html',1,'']]], - ['percentilefilter1d_2ehpp_1513',['percentileFilter1d.hpp',['../percentile_filter1d_8hpp.html',1,'']]], - ['permutation_2ehpp_1514',['permutation.hpp',['../permutation_8hpp.html',1,'']]], - ['pivotlu_5fdecomposition_2ehpp_1515',['pivotLU_decomposition.hpp',['../pivot_l_u__decomposition_8hpp.html',1,'']]], - ['pixel_2ehpp_1516',['Pixel.hpp',['../_pixel_8hpp.html',1,'']]], - ['pnr_2ehpp_1517',['pnr.hpp',['../pnr_8hpp.html',1,'']]], - ['poisson_2ehpp_1518',['poisson.hpp',['../poisson_8hpp.html',1,'']]], - ['polar_2ehpp_1519',['polar.hpp',['../polar_8hpp.html',1,'']]], - ['poly1d_2ehpp_1520',['Poly1d.hpp',['../_poly1d_8hpp.html',1,'']]], - ['polygamma_2ehpp_1521',['polygamma.hpp',['../polygamma_8hpp.html',1,'']]], - ['polynomial_2ehpp_1522',['Polynomial.hpp',['../_polynomial_8hpp.html',1,'']]], - ['prime_2ehpp_1523',['prime.hpp',['../prime_8hpp.html',1,'']]], - ['print_2ehpp_1524',['print.hpp',['../print_8hpp.html',1,'']]], - ['prod_2ehpp_1525',['prod.hpp',['../prod_8hpp.html',1,'']]], - ['proj_2ehpp_1526',['proj.hpp',['../proj_8hpp.html',1,'']]], - ['ptp_2ehpp_1527',['ptp.hpp',['../ptp_8hpp.html',1,'']]], - ['put_2ehpp_1528',['put.hpp',['../put_8hpp.html',1,'']]], - ['putmask_2ehpp_1529',['putmask.hpp',['../putmask_8hpp.html',1,'']]], - ['pybindinterface_2ehpp_1530',['PybindInterface.hpp',['../_pybind_interface_8hpp.html',1,'']]], - ['pythoninterface_2ehpp_1531',['PythonInterface.hpp',['../_python_interface_8hpp.html',1,'']]] + ['ones_2ehpp_1579',['ones.hpp',['../ones_8hpp.html',1,'']]], + ['ones_5flike_2ehpp_1580',['ones_like.hpp',['../ones__like_8hpp.html',1,'']]], + ['outer_2ehpp_1581',['outer.hpp',['../outer_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_e.html b/docs/doxygen/html/search/files_e.html index 640472b3d..9df411672 100644 --- a/docs/doxygen/html/search/files_e.html +++ b/docs/doxygen/html/search/files_e.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_e.js b/docs/doxygen/html/search/files_e.js index 11dac45e7..7bb36156a 100644 --- a/docs/doxygen/html/search/files_e.js +++ b/docs/doxygen/html/search/files_e.js @@ -1,4 +1,27 @@ var searchData= [ - ['quaternion_2ehpp_1532',['Quaternion.hpp',['../_quaternion_8hpp.html',1,'']]] + ['pad_2ehpp_1582',['pad.hpp',['../pad_8hpp.html',1,'']]], + ['partition_2ehpp_1583',['partition.hpp',['../partition_8hpp.html',1,'']]], + ['percentile_2ehpp_1584',['percentile.hpp',['../percentile_8hpp.html',1,'']]], + ['percentilefilter_2ehpp_1585',['percentileFilter.hpp',['../percentile_filter_8hpp.html',1,'']]], + ['percentilefilter1d_2ehpp_1586',['percentileFilter1d.hpp',['../percentile_filter1d_8hpp.html',1,'']]], + ['permutation_2ehpp_1587',['permutation.hpp',['../permutation_8hpp.html',1,'']]], + ['pivotlu_5fdecomposition_2ehpp_1588',['pivotLU_decomposition.hpp',['../pivot_l_u__decomposition_8hpp.html',1,'']]], + ['pixel_2ehpp_1589',['Pixel.hpp',['../_pixel_8hpp.html',1,'']]], + ['place_2ehpp_1590',['place.hpp',['../place_8hpp.html',1,'']]], + ['pnr_2ehpp_1591',['pnr.hpp',['../pnr_8hpp.html',1,'']]], + ['poisson_2ehpp_1592',['poisson.hpp',['../poisson_8hpp.html',1,'']]], + ['polar_2ehpp_1593',['polar.hpp',['../polar_8hpp.html',1,'']]], + ['poly1d_2ehpp_1594',['Poly1d.hpp',['../_poly1d_8hpp.html',1,'']]], + ['polygamma_2ehpp_1595',['polygamma.hpp',['../polygamma_8hpp.html',1,'']]], + ['polynomial_2ehpp_1596',['Polynomial.hpp',['../_polynomial_8hpp.html',1,'']]], + ['prime_2ehpp_1597',['prime.hpp',['../prime_8hpp.html',1,'']]], + ['print_2ehpp_1598',['print.hpp',['../print_8hpp.html',1,'']]], + ['prod_2ehpp_1599',['prod.hpp',['../prod_8hpp.html',1,'']]], + ['proj_2ehpp_1600',['proj.hpp',['../proj_8hpp.html',1,'']]], + ['ptp_2ehpp_1601',['ptp.hpp',['../ptp_8hpp.html',1,'']]], + ['put_2ehpp_1602',['put.hpp',['../put_8hpp.html',1,'']]], + ['putmask_2ehpp_1603',['putmask.hpp',['../putmask_8hpp.html',1,'']]], + ['pybindinterface_2ehpp_1604',['PybindInterface.hpp',['../_pybind_interface_8hpp.html',1,'']]], + ['pythoninterface_2ehpp_1605',['PythonInterface.hpp',['../_python_interface_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/files_f.html b/docs/doxygen/html/search/files_f.html index 6489d6a70..f75258bb5 100644 --- a/docs/doxygen/html/search/files_f.html +++ b/docs/doxygen/html/search/files_f.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/files_f.js b/docs/doxygen/html/search/files_f.js index 8923f008c..51e2c18fb 100644 --- a/docs/doxygen/html/search/files_f.js +++ b/docs/doxygen/html/search/files_f.js @@ -1,42 +1,4 @@ var searchData= [ - ['beta_2ehpp_1533',['beta.hpp',['../_random_2beta_8hpp.html',1,'']]], - ['gamma_2ehpp_1534',['gamma.hpp',['../_random_2gamma_8hpp.html',1,'']]], - ['laplace_2ehpp_1535',['laplace.hpp',['../_random_2laplace_8hpp.html',1,'']]], - ['ra_2ehpp_1536',['RA.hpp',['../_r_a_8hpp.html',1,'']]], - ['rad2deg_2ehpp_1537',['rad2deg.hpp',['../rad2deg_8hpp.html',1,'']]], - ['radians_2ehpp_1538',['radians.hpp',['../radians_8hpp.html',1,'']]], - ['radianseperation_2ehpp_1539',['radianSeperation.hpp',['../radian_seperation_8hpp.html',1,'']]], - ['rand_2ehpp_1540',['rand.hpp',['../rand_8hpp.html',1,'']]], - ['randfloat_2ehpp_1541',['randFloat.hpp',['../rand_float_8hpp.html',1,'']]], - ['randint_2ehpp_1542',['randInt.hpp',['../rand_int_8hpp.html',1,'']]], - ['randn_2ehpp_1543',['randN.hpp',['../rand_n_8hpp.html',1,'']]], - ['random_2ehpp_1544',['Random.hpp',['../_random_8hpp.html',1,'']]], - ['rankfilter_2ehpp_1545',['rankFilter.hpp',['../rank_filter_8hpp.html',1,'']]], - ['rankfilter1d_2ehpp_1546',['rankFilter1d.hpp',['../rank_filter1d_8hpp.html',1,'']]], - ['ravel_2ehpp_1547',['ravel.hpp',['../ravel_8hpp.html',1,'']]], - ['readme_2emd_1548',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]], - ['real_2ehpp_1549',['real.hpp',['../real_8hpp.html',1,'']]], - ['reciprocal_2ehpp_1550',['reciprocal.hpp',['../reciprocal_8hpp.html',1,'']]], - ['reflect1d_2ehpp_1551',['reflect1d.hpp',['../reflect1d_8hpp.html',1,'']]], - ['reflect2d_2ehpp_1552',['reflect2d.hpp',['../reflect2d_8hpp.html',1,'']]], - ['releasenotes_2emd_1553',['ReleaseNotes.md',['../_release_notes_8md.html',1,'']]], - ['remainder_2ehpp_1554',['remainder.hpp',['../remainder_8hpp.html',1,'']]], - ['repeat_2ehpp_1555',['repeat.hpp',['../repeat_8hpp.html',1,'']]], - ['replace_2ehpp_1556',['replace.hpp',['../replace_8hpp.html',1,'']]], - ['reshape_2ehpp_1557',['reshape.hpp',['../reshape_8hpp.html',1,'']]], - ['resizefast_2ehpp_1558',['resizeFast.hpp',['../resize_fast_8hpp.html',1,'']]], - ['resizeslow_2ehpp_1559',['resizeSlow.hpp',['../resize_slow_8hpp.html',1,'']]], - ['riemann_5fzeta_2ehpp_1560',['riemann_zeta.hpp',['../riemann__zeta_8hpp.html',1,'']]], - ['right_5fshift_2ehpp_1561',['right_shift.hpp',['../right__shift_8hpp.html',1,'']]], - ['rint_2ehpp_1562',['rint.hpp',['../rint_8hpp.html',1,'']]], - ['rms_2ehpp_1563',['rms.hpp',['../rms_8hpp.html',1,'']]], - ['rodriguesrotation_2ehpp_1564',['rodriguesRotation.hpp',['../rodrigues_rotation_8hpp.html',1,'']]], - ['roll_2ehpp_1565',['roll.hpp',['../roll_8hpp.html',1,'']]], - ['romberg_2ehpp_1566',['romberg.hpp',['../romberg_8hpp.html',1,'']]], - ['roots_2ehpp_1567',['Roots.hpp',['../_roots_8hpp.html',1,'']]], - ['rot90_2ehpp_1568',['rot90.hpp',['../rot90_8hpp.html',1,'']]], - ['rotations_2ehpp_1569',['Rotations.hpp',['../_rotations_8hpp.html',1,'']]], - ['round_2ehpp_1570',['round.hpp',['../round_8hpp.html',1,'']]], - ['row_5fstack_2ehpp_1571',['row_stack.hpp',['../row__stack_8hpp.html',1,'']]] + ['quaternion_2ehpp_1606',['Quaternion.hpp',['../_quaternion_8hpp.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/functions_0.html b/docs/doxygen/html/search/functions_0.html index 04d772fad..eb4c5014c 100644 --- a/docs/doxygen/html/search/functions_0.html +++ b/docs/doxygen/html/search/functions_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_0.js b/docs/doxygen/html/search/functions_0.js index bd5c5dc8d..f2caf0b0e 100644 --- a/docs/doxygen/html/search/functions_0.js +++ b/docs/doxygen/html/search/functions_0.js @@ -1,46 +1,46 @@ var searchData= [ - ['abs_1656',['abs',['../namespacenc.html#a6c2c40c4efcd5018f84f9aca0c03c29d',1,'nc::abs(dtype inValue) noexcept'],['../namespacenc.html#ad701f25dc97cf57005869ccb83357689',1,'nc::abs(const NdArray< dtype > &inArray)']]], - ['add_1657',['add',['../namespacenc.html#af5a087b8c1a96061e09f940143eda94a',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#abf179f45ed80c33c4093bab65e87f9d5',1,'nc::add(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a9e0ebe00c9b81a6acdd1bfb328ca1e15',1,'nc::add(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a179128257dbcede363ccf942fb32e42f',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a8d76aea45bc47a83ec108b24f82b75ab',1,'nc::add(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a315d6d9acfc7fb154ebac4bea533857a',1,'nc::add(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#afe0e003d201511287b8954aa5b1b0d05',1,'nc::add(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a37845dd28b36310f6dba5aa6ebba9cff',1,'nc::add(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a3f02320424da5d350eba50dc83cbb4cf',1,'nc::add(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], - ['addboundary1d_1658',['addBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#a794f239834d31e60ad7c9d5a552e3f7c',1,'nc::filter::boundary']]], - ['addboundary2d_1659',['addBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#a43e1dba909451a24518231243181d79d',1,'nc::filter::boundary']]], - ['addpixel_1660',['addPixel',['../classnc_1_1image_processing_1_1_cluster.html#a9cab13be79b63d9151e60a798ca39cb5',1,'nc::imageProcessing::Cluster']]], - ['airy_5fai_1661',['airy_ai',['../namespacenc_1_1special.html#a90c6b73247014e03767ad66cefccc4d6',1,'nc::special::airy_ai(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#ae5fa8cc4efa56e60d061600b3f6903b2',1,'nc::special::airy_ai(dtype inValue)']]], - ['airy_5fai_5fprime_1662',['airy_ai_prime',['../namespacenc_1_1special.html#a10516c44f9bd0fb906dd12122401187a',1,'nc::special::airy_ai_prime(dtype inValue)'],['../namespacenc_1_1special.html#abd997d345e8fdf5440c0c16548113d4c',1,'nc::special::airy_ai_prime(const NdArray< dtype > &inArray)']]], - ['airy_5fbi_1663',['airy_bi',['../namespacenc_1_1special.html#a6e23c4a5cc7f4a44b384b0c2a9f3c56f',1,'nc::special::airy_bi(dtype inValue)'],['../namespacenc_1_1special.html#a9ea0f9f510fa0c67639ebf17690271d3',1,'nc::special::airy_bi(const NdArray< dtype > &inArray)']]], - ['airy_5fbi_5fprime_1664',['airy_bi_prime',['../namespacenc_1_1special.html#ab85b0e2d663c5ff84f92e321b9146ae1',1,'nc::special::airy_bi_prime(dtype inValue)'],['../namespacenc_1_1special.html#a9646b2d48062cebaeb627ab0ed8c68c6',1,'nc::special::airy_bi_prime(const NdArray< dtype > &inArray)']]], - ['alen_1665',['alen',['../namespacenc.html#a3c13463ad0ab59dcbd9d8efc99b83ca8',1,'nc']]], - ['all_1666',['all',['../namespacenc.html#ad5df164a8079cf9b22d25b6c62f1d10a',1,'nc::all()'],['../classnc_1_1_nd_array.html#afaba38e055338400eb8a404dfda573d5',1,'nc::NdArray::all()']]], - ['all_5fof_1667',['all_of',['../namespacenc_1_1stl__algorithms.html#a6c632e800fd350eb36ea01eb522eeb1f',1,'nc::stl_algorithms']]], - ['allclose_1668',['allclose',['../namespacenc.html#ac2a107bb7ecfcf649c408069166ed1ea',1,'nc']]], - ['amax_1669',['amax',['../namespacenc.html#a813ac533b98f739214f7ee23d1bc448c',1,'nc']]], - ['amin_1670',['amin',['../namespacenc.html#a4ea471f5a3dc23f638a8499151351435',1,'nc']]], - ['angle_1671',['angle',['../classnc_1_1_vec3.html#a523ca42cbdd088851cc5a299da988cee',1,'nc::Vec3::angle()'],['../classnc_1_1_vec2.html#a271ca2cae96a1df44486fbcc2c0f890f',1,'nc::Vec2::angle()'],['../namespacenc.html#a600c02680b7f5963cc305a4b5450f6f6',1,'nc::angle(const std::complex< dtype > &inValue)'],['../namespacenc.html#aa2ad52b9ebde8a5404642b190adb1bad',1,'nc::angle(const NdArray< std::complex< dtype >> &inArray)']]], - ['angularvelocity_1672',['angularVelocity',['../classnc_1_1rotations_1_1_quaternion.html#a7cbe975bfed4cd7e5b4606047a9ee7f9',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat1, const Quaternion &inQuat2, double inTime)'],['../classnc_1_1rotations_1_1_quaternion.html#a13ac87f70271d1771301011887d9d51a',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat2, double inTime) const']]], - ['any_1673',['any',['../classnc_1_1_nd_array.html#a1463c8f1cb95cb8546d02502d86bd91e',1,'nc::NdArray::any()'],['../namespacenc.html#a2101c957472f0cefeda9d6b2b7bc6935',1,'nc::any()']]], - ['any_5fof_1674',['any_of',['../namespacenc_1_1stl__algorithms.html#a0ae9c71c7298f83822ab49d270c867ba',1,'nc::stl_algorithms']]], - ['append_1675',['append',['../namespacenc.html#a95328595c782582b1e75e1c12e92bd81',1,'nc']]], - ['applyfunction_1676',['applyFunction',['../namespacenc.html#a9514d926dd13e0c80ae8b4f263752725',1,'nc']]], - ['applypoly1d_1677',['applyPoly1d',['../namespacenc.html#a52f3be5bbad0243643027a1477662356',1,'nc']]], - ['applythreshold_1678',['applyThreshold',['../namespacenc_1_1image_processing.html#afabcede2d9e7e67cc80fc822b30d70e6',1,'nc::imageProcessing']]], - ['arange_1679',['arange',['../namespacenc.html#a465e2385ac78ca4cc23928a4a0cd9f53',1,'nc::arange(dtype inStart, dtype inStop, dtype inStep=1)'],['../namespacenc.html#a2edad3e052b232bd9075c78aad3c9287',1,'nc::arange(dtype inStop)'],['../namespacenc.html#a724165d620d8bff96f8f004c18257ad6',1,'nc::arange(const Slice &inSlice)']]], - ['arccos_1680',['arccos',['../namespacenc.html#a0a87e0681917bdd812e139e6d6ea4bf1',1,'nc::arccos(dtype inValue) noexcept'],['../namespacenc.html#aa57707902e14b3f16aec516e183d5830',1,'nc::arccos(const NdArray< dtype > &inArray)']]], - ['arccosh_1681',['arccosh',['../namespacenc.html#a725eab730b946eca5d197933b9f955fa',1,'nc::arccosh(dtype inValue) noexcept'],['../namespacenc.html#a9063e7275b83f3201f74a0014a9b54d5',1,'nc::arccosh(const NdArray< dtype > &inArray)']]], - ['arcsin_1682',['arcsin',['../namespacenc.html#a6d18d24b8a33ec7df0e845d6a430d5f2',1,'nc::arcsin(dtype inValue) noexcept'],['../namespacenc.html#a4b1b8fc9752c90328e3cadce151d6370',1,'nc::arcsin(const NdArray< dtype > &inArray)']]], - ['arcsinh_1683',['arcsinh',['../namespacenc.html#a74ebb0003f6cf0d0dc0fd8af1e983969',1,'nc::arcsinh(dtype inValue) noexcept'],['../namespacenc.html#abbf91db9344e5d1a53325990ef5535a0',1,'nc::arcsinh(const NdArray< dtype > &inArray)']]], - ['arctan_1684',['arctan',['../namespacenc.html#ac7080b26d0d4d849197ae10ce6d94a53',1,'nc::arctan(const NdArray< dtype > &inArray)'],['../namespacenc.html#a0f63f816e660b0a4b3da191c8584a21a',1,'nc::arctan(dtype inValue) noexcept']]], - ['arctan2_1685',['arctan2',['../namespacenc.html#abdec674ddb32540775e97e0fca6016aa',1,'nc::arctan2(dtype inY, dtype inX) noexcept'],['../namespacenc.html#a3d3c4c6b273e6eee45cf6359cf621980',1,'nc::arctan2(const NdArray< dtype > &inY, const NdArray< dtype > &inX)']]], - ['arctanh_1686',['arctanh',['../namespacenc.html#a01f43fad4032a2823fc3ed56137b93de',1,'nc::arctanh(dtype inValue) noexcept'],['../namespacenc.html#a1b71f03b842e44890312fa09ed1aa594',1,'nc::arctanh(const NdArray< dtype > &inArray)']]], - ['area_1687',['area',['../classnc_1_1polynomial_1_1_poly1d.html#adcbfe7e5fe2ed3b73bc5c81a73ece1cb',1,'nc::polynomial::Poly1d']]], - ['argmax_1688',['argmax',['../classnc_1_1_nd_array.html#ad4a41193c4f364a817f51ac7f6932b1f',1,'nc::NdArray::argmax()'],['../namespacenc.html#a33dac7f03588175031847327655f0b5d',1,'nc::argmax()']]], - ['argmin_1689',['argmin',['../classnc_1_1_nd_array.html#a62a38761f6f8fd005e225a5d3328e073',1,'nc::NdArray::argmin()'],['../namespacenc.html#ae26281f75850e9b94272228b56544bd5',1,'nc::argmin()']]], - ['argsort_1690',['argsort',['../classnc_1_1_nd_array.html#ae0ec4abb78faecc68f8d7e2198894196',1,'nc::NdArray::argsort()'],['../namespacenc.html#a88c217359f5e295649dd0cabe648ce6a',1,'nc::argsort(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], - ['argwhere_1691',['argwhere',['../namespacenc.html#aeddef72feba83e0c7d053093c74ed686',1,'nc']]], - ['around_1692',['around',['../namespacenc.html#a32e869df2216c793407d6addea9bf890',1,'nc::around(dtype inValue, uint8 inNumDecimals=0)'],['../namespacenc.html#a332fc87fa0bae7583b6a6ca3ceb8a8d4',1,'nc::around(const NdArray< dtype > &inArray, uint8 inNumDecimals=0)']]], - ['array_5fequal_1693',['array_equal',['../namespacenc.html#a0e8c1396cc01ccd9ec8ba549b6347e21',1,'nc']]], - ['array_5fequiv_1694',['array_equiv',['../namespacenc.html#ac7cfdea4ac1caa81eabdb5dfe33b90b8',1,'nc']]], - ['asarray_1695',['asarray',['../namespacenc.html#a937b7ded9b21c92955e8ab137ad0b449',1,'nc::asarray(std::initializer_list< dtype > inList)'],['../namespacenc.html#a6a6f1083d41b9d345d6dae5093d7632b',1,'nc::asarray(std::initializer_list< std::initializer_list< dtype > > inList)'],['../namespacenc.html#ae2e0f4084163e9be08e324a6f3c10579',1,'nc::asarray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../namespacenc.html#a35116b2646ecd25b63586fa987991f21',1,'nc::asarray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &inArray, bool copy=true)'],['../namespacenc.html#a37aab9b1478f5d5abea3d02029fb2f2d',1,'nc::asarray(std::vector< dtype > &inVector, bool copy=true)'],['../namespacenc.html#a5ac399ecf8e26717e118be6d04164d31',1,'nc::asarray(const std::vector< std::vector< dtype >> &inVector)'],['../namespacenc.html#a39a0d39388c73f10ab8b462108675e98',1,'nc::asarray(dtype *ptr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept'],['../namespacenc.html#ae2b23e323b2d5e16933587ede8c5d115',1,'nc::asarray(dtype *ptr, uint32 size, Bool takeOwnership) noexcept'],['../namespacenc.html#a49d751314929b591b3e1a9d79f81d6ff',1,'nc::asarray(const dtype *ptr, uint32 numRows, uint32 numCols)'],['../namespacenc.html#aab50ba883dd36c374c2b0d34c22f7bc1',1,'nc::asarray(std::vector< std::array< dtype, Dim1Size >> &inVector, bool copy=true)'],['../namespacenc.html#a430dab2027f102a689a812134e1f9655',1,'nc::asarray(const std::deque< dtype > &inDeque)'],['../namespacenc.html#ac7a31dc08b1ea7cbdc71c22cad70e328',1,'nc::asarray(const std::deque< std::deque< dtype >> &inDeque)'],['../namespacenc.html#aaef8615d9fb222814f2849fb0915dd81',1,'nc::asarray(const std::set< dtype, dtypeComp > &inSet)'],['../namespacenc.html#a6280fea16d0710fe5e257c3d4cb3a85d',1,'nc::asarray(const std::list< dtype > &inList)'],['../namespacenc.html#aa0127b6d17a87db3f9deed78e90f54bd',1,'nc::asarray(Iterator iterBegin, Iterator iterEnd)'],['../namespacenc.html#a35bad04da98984458f265fc1dcd66b00',1,'nc::asarray(const dtype *iterBegin, const dtype *iterEnd)'],['../namespacenc.html#ac2c02eb2fd3b28ab815ab5d678649a13',1,'nc::asarray(const dtype *ptr, uint32 size)']]], - ['astype_1696',['astype',['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype()'],['../namespacenc.html#a07250b272d24387fab405d29c14082e4',1,'nc::astype()'],['../classnc_1_1polynomial_1_1_poly1d.html#a0cf03b40603f490af100cdc65140ab9f',1,'nc::polynomial::Poly1d::astype()'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const']]], - ['at_1697',['at',['../classnc_1_1_nd_array.html#a7b5c383337c887ddf537708b29b64afd',1,'nc::NdArray::at()'],['../classnc_1_1_data_cube.html#a8925f65b525c2b4fe04c711851b66828',1,'nc::DataCube::at(uint32 inIndex)'],['../classnc_1_1_data_cube.html#ab78c6fc396ea087819cdef43f316da4e',1,'nc::DataCube::at(uint32 inIndex) const'],['../classnc_1_1image_processing_1_1_cluster.html#a5a8d82d40cea566786e8f80ad72a6d10',1,'nc::imageProcessing::Cluster::at()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a679db8e4b1f175af3db67c756c54d6b1',1,'nc::imageProcessing::ClusterMaker::at()'],['../classnc_1_1_nd_array.html#a3ae4c372620db7cf0211867dcb886b48',1,'nc::NdArray::at(int32 inIndex)'],['../classnc_1_1_nd_array.html#a10ef25d07c5761028091cda2c7f20d1f',1,'nc::NdArray::at(int32 inIndex) const'],['../classnc_1_1_nd_array.html#ade8b486f8c2ffce283abea6126cb3a63',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex)'],['../classnc_1_1_nd_array.html#a77807cb1488da10f8654dc6331426ca6',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#a39dc0db6c17edef6642b55b4ce68df48',1,'nc::NdArray::at(const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#adf7b073b906cd66e1c8a78df865b5679',1,'nc::NdArray::at(const Slice &inRowSlice, const Slice &inColSlice) const'],['../classnc_1_1_nd_array.html#a1537e603e458ad93bdde061e476305d6',1,'nc::NdArray::at(const Slice &inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#a023bd56ee5fd8b58a4d0eb2acd71f67a',1,'nc::NdArray::at(const NdArray< int32 > &rowIndices, const NdArray< int32 > &colIndices) const']]], - ['average_1698',['average',['../namespacenc.html#a9025fe780f7cb82e65c21738672f1d41',1,'nc::average(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a08d310c2089324a7106ff509b862f5c7',1,'nc::average(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a4d65d31c652a1ab639089ab948d0d557',1,'nc::average(const NdArray< std::complex< dtype >> &inArray, const NdArray< dtype > &inWeights, Axis inAxis=Axis::NONE)']]] + ['abs_1731',['abs',['../namespacenc.html#ad701f25dc97cf57005869ccb83357689',1,'nc::abs(const NdArray< dtype > &inArray)'],['../namespacenc.html#a6c2c40c4efcd5018f84f9aca0c03c29d',1,'nc::abs(dtype inValue) noexcept']]], + ['add_1732',['add',['../namespacenc.html#a9e0ebe00c9b81a6acdd1bfb328ca1e15',1,'nc::add(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a37845dd28b36310f6dba5aa6ebba9cff',1,'nc::add(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#afe0e003d201511287b8954aa5b1b0d05',1,'nc::add(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a315d6d9acfc7fb154ebac4bea533857a',1,'nc::add(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a8d76aea45bc47a83ec108b24f82b75ab',1,'nc::add(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a179128257dbcede363ccf942fb32e42f',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#abf179f45ed80c33c4093bab65e87f9d5',1,'nc::add(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#af5a087b8c1a96061e09f940143eda94a',1,'nc::add(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a3f02320424da5d350eba50dc83cbb4cf',1,'nc::add(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], + ['addboundary1d_1733',['addBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#a794f239834d31e60ad7c9d5a552e3f7c',1,'nc::filter::boundary']]], + ['addboundary2d_1734',['addBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#a43e1dba909451a24518231243181d79d',1,'nc::filter::boundary']]], + ['addpixel_1735',['addPixel',['../classnc_1_1image_processing_1_1_cluster.html#a9cab13be79b63d9151e60a798ca39cb5',1,'nc::imageProcessing::Cluster']]], + ['airy_5fai_1736',['airy_ai',['../namespacenc_1_1special.html#a90c6b73247014e03767ad66cefccc4d6',1,'nc::special::airy_ai(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#ae5fa8cc4efa56e60d061600b3f6903b2',1,'nc::special::airy_ai(dtype inValue)']]], + ['airy_5fai_5fprime_1737',['airy_ai_prime',['../namespacenc_1_1special.html#a10516c44f9bd0fb906dd12122401187a',1,'nc::special::airy_ai_prime(dtype inValue)'],['../namespacenc_1_1special.html#abd997d345e8fdf5440c0c16548113d4c',1,'nc::special::airy_ai_prime(const NdArray< dtype > &inArray)']]], + ['airy_5fbi_1738',['airy_bi',['../namespacenc_1_1special.html#a6e23c4a5cc7f4a44b384b0c2a9f3c56f',1,'nc::special::airy_bi(dtype inValue)'],['../namespacenc_1_1special.html#a9ea0f9f510fa0c67639ebf17690271d3',1,'nc::special::airy_bi(const NdArray< dtype > &inArray)']]], + ['airy_5fbi_5fprime_1739',['airy_bi_prime',['../namespacenc_1_1special.html#ab85b0e2d663c5ff84f92e321b9146ae1',1,'nc::special::airy_bi_prime(dtype inValue)'],['../namespacenc_1_1special.html#a9646b2d48062cebaeb627ab0ed8c68c6',1,'nc::special::airy_bi_prime(const NdArray< dtype > &inArray)']]], + ['alen_1740',['alen',['../namespacenc.html#a3c13463ad0ab59dcbd9d8efc99b83ca8',1,'nc']]], + ['all_1741',['all',['../classnc_1_1_nd_array.html#afaba38e055338400eb8a404dfda573d5',1,'nc::NdArray::all()'],['../namespacenc.html#ad5df164a8079cf9b22d25b6c62f1d10a',1,'nc::all()']]], + ['all_5fof_1742',['all_of',['../namespacenc_1_1stl__algorithms.html#a6c632e800fd350eb36ea01eb522eeb1f',1,'nc::stl_algorithms']]], + ['allclose_1743',['allclose',['../namespacenc.html#ac2a107bb7ecfcf649c408069166ed1ea',1,'nc']]], + ['amax_1744',['amax',['../namespacenc.html#a813ac533b98f739214f7ee23d1bc448c',1,'nc']]], + ['amin_1745',['amin',['../namespacenc.html#a4ea471f5a3dc23f638a8499151351435',1,'nc']]], + ['angle_1746',['angle',['../classnc_1_1_vec2.html#a271ca2cae96a1df44486fbcc2c0f890f',1,'nc::Vec2::angle()'],['../classnc_1_1_vec3.html#a523ca42cbdd088851cc5a299da988cee',1,'nc::Vec3::angle()'],['../namespacenc.html#aa2ad52b9ebde8a5404642b190adb1bad',1,'nc::angle(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a600c02680b7f5963cc305a4b5450f6f6',1,'nc::angle(const std::complex< dtype > &inValue)']]], + ['angularvelocity_1747',['angularVelocity',['../classnc_1_1rotations_1_1_quaternion.html#a7cbe975bfed4cd7e5b4606047a9ee7f9',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat1, const Quaternion &inQuat2, double inTime)'],['../classnc_1_1rotations_1_1_quaternion.html#a13ac87f70271d1771301011887d9d51a',1,'nc::rotations::Quaternion::angularVelocity(const Quaternion &inQuat2, double inTime) const']]], + ['any_1748',['any',['../classnc_1_1_nd_array.html#a1463c8f1cb95cb8546d02502d86bd91e',1,'nc::NdArray::any()'],['../namespacenc.html#a2101c957472f0cefeda9d6b2b7bc6935',1,'nc::any()']]], + ['any_5fof_1749',['any_of',['../namespacenc_1_1stl__algorithms.html#a0ae9c71c7298f83822ab49d270c867ba',1,'nc::stl_algorithms']]], + ['append_1750',['append',['../namespacenc.html#a95328595c782582b1e75e1c12e92bd81',1,'nc']]], + ['applyfunction_1751',['applyFunction',['../namespacenc.html#a9514d926dd13e0c80ae8b4f263752725',1,'nc']]], + ['applypoly1d_1752',['applyPoly1d',['../namespacenc.html#a52f3be5bbad0243643027a1477662356',1,'nc']]], + ['applythreshold_1753',['applyThreshold',['../namespacenc_1_1image_processing.html#afabcede2d9e7e67cc80fc822b30d70e6',1,'nc::imageProcessing']]], + ['arange_1754',['arange',['../namespacenc.html#a465e2385ac78ca4cc23928a4a0cd9f53',1,'nc::arange(dtype inStart, dtype inStop, dtype inStep=1)'],['../namespacenc.html#a2edad3e052b232bd9075c78aad3c9287',1,'nc::arange(dtype inStop)'],['../namespacenc.html#a724165d620d8bff96f8f004c18257ad6',1,'nc::arange(const Slice &inSlice)']]], + ['arccos_1755',['arccos',['../namespacenc.html#aa57707902e14b3f16aec516e183d5830',1,'nc::arccos(const NdArray< dtype > &inArray)'],['../namespacenc.html#a0a87e0681917bdd812e139e6d6ea4bf1',1,'nc::arccos(dtype inValue) noexcept']]], + ['arccosh_1756',['arccosh',['../namespacenc.html#a725eab730b946eca5d197933b9f955fa',1,'nc::arccosh(dtype inValue) noexcept'],['../namespacenc.html#a9063e7275b83f3201f74a0014a9b54d5',1,'nc::arccosh(const NdArray< dtype > &inArray)']]], + ['arcsin_1757',['arcsin',['../namespacenc.html#a6d18d24b8a33ec7df0e845d6a430d5f2',1,'nc::arcsin(dtype inValue) noexcept'],['../namespacenc.html#a4b1b8fc9752c90328e3cadce151d6370',1,'nc::arcsin(const NdArray< dtype > &inArray)']]], + ['arcsinh_1758',['arcsinh',['../namespacenc.html#a74ebb0003f6cf0d0dc0fd8af1e983969',1,'nc::arcsinh(dtype inValue) noexcept'],['../namespacenc.html#abbf91db9344e5d1a53325990ef5535a0',1,'nc::arcsinh(const NdArray< dtype > &inArray)']]], + ['arctan_1759',['arctan',['../namespacenc.html#a0f63f816e660b0a4b3da191c8584a21a',1,'nc::arctan(dtype inValue) noexcept'],['../namespacenc.html#ac7080b26d0d4d849197ae10ce6d94a53',1,'nc::arctan(const NdArray< dtype > &inArray)']]], + ['arctan2_1760',['arctan2',['../namespacenc.html#abdec674ddb32540775e97e0fca6016aa',1,'nc::arctan2(dtype inY, dtype inX) noexcept'],['../namespacenc.html#a3d3c4c6b273e6eee45cf6359cf621980',1,'nc::arctan2(const NdArray< dtype > &inY, const NdArray< dtype > &inX)']]], + ['arctanh_1761',['arctanh',['../namespacenc.html#a01f43fad4032a2823fc3ed56137b93de',1,'nc::arctanh(dtype inValue) noexcept'],['../namespacenc.html#a1b71f03b842e44890312fa09ed1aa594',1,'nc::arctanh(const NdArray< dtype > &inArray)']]], + ['area_1762',['area',['../classnc_1_1polynomial_1_1_poly1d.html#adcbfe7e5fe2ed3b73bc5c81a73ece1cb',1,'nc::polynomial::Poly1d']]], + ['argmax_1763',['argmax',['../classnc_1_1_nd_array.html#ad4a41193c4f364a817f51ac7f6932b1f',1,'nc::NdArray::argmax()'],['../namespacenc.html#a33dac7f03588175031847327655f0b5d',1,'nc::argmax()']]], + ['argmin_1764',['argmin',['../classnc_1_1_nd_array.html#a62a38761f6f8fd005e225a5d3328e073',1,'nc::NdArray::argmin()'],['../namespacenc.html#ae26281f75850e9b94272228b56544bd5',1,'nc::argmin()']]], + ['argsort_1765',['argsort',['../classnc_1_1_nd_array.html#ae0ec4abb78faecc68f8d7e2198894196',1,'nc::NdArray::argsort()'],['../namespacenc.html#a88c217359f5e295649dd0cabe648ce6a',1,'nc::argsort(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], + ['argwhere_1766',['argwhere',['../namespacenc.html#aeddef72feba83e0c7d053093c74ed686',1,'nc']]], + ['around_1767',['around',['../namespacenc.html#a32e869df2216c793407d6addea9bf890',1,'nc::around(dtype inValue, uint8 inNumDecimals=0)'],['../namespacenc.html#a332fc87fa0bae7583b6a6ca3ceb8a8d4',1,'nc::around(const NdArray< dtype > &inArray, uint8 inNumDecimals=0)']]], + ['array_5fequal_1768',['array_equal',['../namespacenc.html#a0e8c1396cc01ccd9ec8ba549b6347e21',1,'nc']]], + ['array_5fequiv_1769',['array_equiv',['../namespacenc.html#ac7cfdea4ac1caa81eabdb5dfe33b90b8',1,'nc']]], + ['asarray_1770',['asarray',['../namespacenc.html#a430dab2027f102a689a812134e1f9655',1,'nc::asarray(const std::deque< dtype > &inDeque)'],['../namespacenc.html#a937b7ded9b21c92955e8ab137ad0b449',1,'nc::asarray(std::initializer_list< dtype > inList)'],['../namespacenc.html#a6a6f1083d41b9d345d6dae5093d7632b',1,'nc::asarray(std::initializer_list< std::initializer_list< dtype > > inList)'],['../namespacenc.html#ae2e0f4084163e9be08e324a6f3c10579',1,'nc::asarray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../namespacenc.html#a35116b2646ecd25b63586fa987991f21',1,'nc::asarray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &inArray, bool copy=true)'],['../namespacenc.html#a37aab9b1478f5d5abea3d02029fb2f2d',1,'nc::asarray(std::vector< dtype > &inVector, bool copy=true)'],['../namespacenc.html#a5ac399ecf8e26717e118be6d04164d31',1,'nc::asarray(const std::vector< std::vector< dtype >> &inVector)'],['../namespacenc.html#aab50ba883dd36c374c2b0d34c22f7bc1',1,'nc::asarray(std::vector< std::array< dtype, Dim1Size >> &inVector, bool copy=true)'],['../namespacenc.html#ac7a31dc08b1ea7cbdc71c22cad70e328',1,'nc::asarray(const std::deque< std::deque< dtype >> &inDeque)'],['../namespacenc.html#aaef8615d9fb222814f2849fb0915dd81',1,'nc::asarray(const std::set< dtype, dtypeComp > &inSet)'],['../namespacenc.html#a6280fea16d0710fe5e257c3d4cb3a85d',1,'nc::asarray(const std::list< dtype > &inList)'],['../namespacenc.html#aa0127b6d17a87db3f9deed78e90f54bd',1,'nc::asarray(Iterator iterBegin, Iterator iterEnd)'],['../namespacenc.html#a35bad04da98984458f265fc1dcd66b00',1,'nc::asarray(const dtype *iterBegin, const dtype *iterEnd)'],['../namespacenc.html#ac2c02eb2fd3b28ab815ab5d678649a13',1,'nc::asarray(const dtype *ptr, uint32 size)'],['../namespacenc.html#a49d751314929b591b3e1a9d79f81d6ff',1,'nc::asarray(const dtype *ptr, uint32 numRows, uint32 numCols)'],['../namespacenc.html#ae2b23e323b2d5e16933587ede8c5d115',1,'nc::asarray(dtype *ptr, uint32 size, Bool takeOwnership) noexcept'],['../namespacenc.html#a39a0d39388c73f10ab8b462108675e98',1,'nc::asarray(dtype *ptr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept']]], + ['astype_1771',['astype',['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype() const'],['../classnc_1_1polynomial_1_1_poly1d.html#a0cf03b40603f490af100cdc65140ab9f',1,'nc::polynomial::Poly1d::astype()'],['../classnc_1_1_nd_array.html#a028372744b6c41150c339088b1d1a0dc',1,'nc::NdArray::astype()'],['../namespacenc.html#a07250b272d24387fab405d29c14082e4',1,'nc::astype()']]], + ['at_1772',['at',['../classnc_1_1_nd_array.html#a023bd56ee5fd8b58a4d0eb2acd71f67a',1,'nc::NdArray::at(const NdArray< int32 > &rowIndices, const NdArray< int32 > &colIndices) const'],['../classnc_1_1_nd_array.html#a7b5c383337c887ddf537708b29b64afd',1,'nc::NdArray::at(int32 inRowIndex, const Slice &inColSlice) const'],['../classnc_1_1_nd_array.html#a1537e603e458ad93bdde061e476305d6',1,'nc::NdArray::at(const Slice &inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#adf7b073b906cd66e1c8a78df865b5679',1,'nc::NdArray::at(const Slice &inRowSlice, const Slice &inColSlice) const'],['../classnc_1_1_nd_array.html#a39dc0db6c17edef6642b55b4ce68df48',1,'nc::NdArray::at(const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#a77807cb1488da10f8654dc6331426ca6',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#ade8b486f8c2ffce283abea6126cb3a63',1,'nc::NdArray::at(int32 inRowIndex, int32 inColIndex)'],['../classnc_1_1_nd_array.html#a10ef25d07c5761028091cda2c7f20d1f',1,'nc::NdArray::at(int32 inIndex) const'],['../classnc_1_1_nd_array.html#a3ae4c372620db7cf0211867dcb886b48',1,'nc::NdArray::at(int32 inIndex)'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a679db8e4b1f175af3db67c756c54d6b1',1,'nc::imageProcessing::ClusterMaker::at()'],['../classnc_1_1image_processing_1_1_cluster.html#a5a8d82d40cea566786e8f80ad72a6d10',1,'nc::imageProcessing::Cluster::at()'],['../classnc_1_1_data_cube.html#ab78c6fc396ea087819cdef43f316da4e',1,'nc::DataCube::at(uint32 inIndex) const'],['../classnc_1_1_data_cube.html#a8925f65b525c2b4fe04c711851b66828',1,'nc::DataCube::at(uint32 inIndex)']]], + ['average_1773',['average',['../namespacenc.html#a9025fe780f7cb82e65c21738672f1d41',1,'nc::average(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a08d310c2089324a7106ff509b862f5c7',1,'nc::average(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a4d65d31c652a1ab639089ab948d0d557',1,'nc::average(const NdArray< std::complex< dtype >> &inArray, const NdArray< dtype > &inWeights, Axis inAxis=Axis::NONE)']]] ]; diff --git a/docs/doxygen/html/search/functions_1.html b/docs/doxygen/html/search/functions_1.html index ca6e64fd3..ef4088b89 100644 --- a/docs/doxygen/html/search/functions_1.html +++ b/docs/doxygen/html/search/functions_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_1.js b/docs/doxygen/html/search/functions_1.js index bca6b9a9b..60416a0a5 100644 --- a/docs/doxygen/html/search/functions_1.js +++ b/docs/doxygen/html/search/functions_1.js @@ -1,29 +1,31 @@ var searchData= [ - ['back_1699',['back',['../classnc_1_1_nd_array.html#a6bb650c9e28ff25c9b58c9f4f08d78bb',1,'nc::NdArray::back() const noexcept'],['../classnc_1_1_nd_array.html#a555efdc758b47b107c9c94593b6c2470',1,'nc::NdArray::back() noexcept'],['../classnc_1_1_nd_array.html#a563cf4dcecda39a0599cc13c87363677',1,'nc::NdArray::back(size_type row) const'],['../classnc_1_1_nd_array.html#a20fb268d9bd6c25dd70b6772f5ff5b89',1,'nc::NdArray::back(size_type row)'],['../classnc_1_1_vec3.html#a44e50b4b49011ec94548558600c0b17c',1,'nc::Vec3::back()'],['../classnc_1_1_data_cube.html#abc8860c7c767170d003da447e7618bee',1,'nc::DataCube::back()']]], - ['begin_1700',['begin',['../classnc_1_1_nd_array.html#a57fa866d30c298337bfc906ae73b6a40',1,'nc::NdArray::begin(size_type inRow)'],['../classnc_1_1_nd_array.html#ab3cdc446e55744b31d42dfb53fcdc7cf',1,'nc::NdArray::begin(size_type inRow) const'],['../classnc_1_1_nd_array.html#ae47b79d2054d83dc0c7deb617ab7d1c2',1,'nc::NdArray::begin() const noexcept'],['../classnc_1_1_nd_array.html#ab57282e02905eeb2a932eeb73983221f',1,'nc::NdArray::begin() noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a37c172d7253190e76b065ed2547c3020',1,'nc::imageProcessing::ClusterMaker::begin()'],['../classnc_1_1image_processing_1_1_cluster.html#a6e761b470453d5506015b9332b12e4a4',1,'nc::imageProcessing::Cluster::begin()'],['../classnc_1_1_data_cube.html#a430de05758db67815f957784b298b011',1,'nc::DataCube::begin()']]], - ['bernoilli_1701',['bernoilli',['../namespacenc_1_1special.html#a59caf35b816a219aa2782dd45df207ca',1,'nc::special::bernoilli(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a1af26e52a24fca2b572605ec4b2c1f1b',1,'nc::special::bernoilli(uint32 n)']]], - ['bernoulli_1702',['bernoulli',['../namespacenc_1_1random.html#a8d4a1a62fc03a44cccfa4012413bd70f',1,'nc::random::bernoulli(const Shape &inShape, double inP=0.5)'],['../namespacenc_1_1random.html#a1a5af4283601fd8663dcdc34599aede3',1,'nc::random::bernoulli(double inP=0.5)']]], - ['bessel_5fin_1703',['bessel_in',['../namespacenc_1_1special.html#a92141b6d9ffda6c68c7cb13dee3eae60',1,'nc::special::bessel_in(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a6e9dbda70e7c0732d0b63ea389e5af49',1,'nc::special::bessel_in(dtype1 inV, dtype2 inX)']]], - ['bessel_5fin_5fprime_1704',['bessel_in_prime',['../namespacenc_1_1special.html#a85979b28c3403361a3e818c9cf8cdf16',1,'nc::special::bessel_in_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a416353fb98d37ed2e1a8ab587a16f6f8',1,'nc::special::bessel_in_prime(dtype1 inV, dtype2 inX)']]], - ['bessel_5fjn_1705',['bessel_jn',['../namespacenc_1_1special.html#a3986d3b42ddcd747d40fb6772b49536e',1,'nc::special::bessel_jn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ab310a9680ad09bc52377898876a27620',1,'nc::special::bessel_jn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fjn_5fprime_1706',['bessel_jn_prime',['../namespacenc_1_1special.html#a3eef0d1e8d31602e816578f778feefb5',1,'nc::special::bessel_jn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a6e4139a3ecc85275c4690d01453366dc',1,'nc::special::bessel_jn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fkn_1707',['bessel_kn',['../namespacenc_1_1special.html#a614d69a09535948c87124fe5662452dc',1,'nc::special::bessel_kn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a5727fa899a61975ffcb79d84fd2d231b',1,'nc::special::bessel_kn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], - ['bessel_5fkn_5fprime_1708',['bessel_kn_prime',['../namespacenc_1_1special.html#a98aad61d58f7d046091f6f569d2c97fb',1,'nc::special::bessel_kn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#aa3159d6cbb77b6bc1b913c25d969fa3c',1,'nc::special::bessel_kn_prime(dtype1 inV, dtype2 inX)']]], - ['bessel_5fyn_1709',['bessel_yn',['../namespacenc_1_1special.html#a2a215c5881fc0d98e444942d3a67ed5b',1,'nc::special::bessel_yn(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a55bbc44ffde64dfb7af7a803250cd2a6',1,'nc::special::bessel_yn(dtype1 inV, dtype2 inX)']]], - ['bessel_5fyn_5fprime_1710',['bessel_yn_prime',['../namespacenc_1_1special.html#a129b71949a9659519aea36dc64d47020',1,'nc::special::bessel_yn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a742272fb70f0b85164b61409ad3f464f',1,'nc::special::bessel_yn_prime(dtype1 inV, dtype2 inX)']]], - ['beta_1711',['beta',['../namespacenc_1_1random.html#a9cf5ddddc350278c76e077c67b5254ab',1,'nc::random::beta(dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1random.html#ab7de94b949521786b7bde650b1e813fa',1,'nc::random::beta(const Shape &inShape, dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1special.html#a9b74f451f99338c909b7f73df6e5bff6',1,'nc::special::beta(dtype1 a, dtype2 b)'],['../namespacenc_1_1special.html#ad2ac5c7add77e243dc39899c15ad93e6',1,'nc::special::beta(const NdArray< dtype1 > &inArrayA, const NdArray< dtype2 > &inArrayB)']]], - ['binaryrepr_1712',['binaryRepr',['../namespacenc.html#a8c8a7dbf208bb2d31983140598e7cebe',1,'nc']]], - ['bincount_1713',['bincount',['../namespacenc.html#a60bb0f9e8bed0fd6f5c0973cf3b918ca',1,'nc::bincount(const NdArray< dtype > &inArray, uint16 inMinLength=1)'],['../namespacenc.html#aa31a10ae8201c637ab3d203844b81904',1,'nc::bincount(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, uint16 inMinLength=1)']]], - ['binomial_1714',['binomial',['../namespacenc_1_1random.html#a13657004ec565f15648a520e3d060002',1,'nc::random::binomial(dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#a83099ec22905c3ad69984a94d823a3d8',1,'nc::random::binomial(const Shape &inShape, dtype inN, double inP=0.5)']]], - ['bisection_1715',['Bisection',['../classnc_1_1roots_1_1_bisection.html#ae9ccce420ccf01a829b0138f264956cb',1,'nc::roots::Bisection::Bisection(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_bisection.html#a05985162d3dac7a0919319c6cde74895',1,'nc::roots::Bisection::Bisection(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept']]], - ['bits_1716',['bits',['../classnc_1_1_dtype_info.html#a3f6aa0cc80e59dc331bc0e8dfe2f20bb',1,'nc::DtypeInfo::bits()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ae35570f524474adaa2315bead3f9be9e',1,'nc::DtypeInfo< std::complex< dtype > >::bits()']]], - ['bitwise_5fand_1717',['bitwise_and',['../namespacenc.html#a4a7fa01dbe15029314c6204f930c09af',1,'nc']]], - ['bitwise_5fnot_1718',['bitwise_not',['../namespacenc.html#a172096cafc950983ccbbb05eb5426722',1,'nc']]], - ['bitwise_5for_1719',['bitwise_or',['../namespacenc.html#a6203fb3929a9c533eba79b64342eaa3a',1,'nc']]], - ['bitwise_5fxor_1720',['bitwise_xor',['../namespacenc.html#a07c69919a1dc382fd2ae3ebf1b358319',1,'nc']]], - ['brent_1721',['Brent',['../classnc_1_1roots_1_1_brent.html#a1e9cf8f7be13c7bbb42a073ec9eb5369',1,'nc::roots::Brent::Brent(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_brent.html#aecf6662d1b7128d38796cf4ab99143f4',1,'nc::roots::Brent::Brent(const double epsilon, std::function< double(double)> f) noexcept']]], - ['byteswap_1722',['byteswap',['../classnc_1_1_nd_array.html#a2d3f796540ca2966cd2964a358627630',1,'nc::NdArray']]], - ['byteswap_1723',['byteSwap',['../namespacenc_1_1endian.html#a28d96487f9ac66755e2dd4925a459e0d',1,'nc::endian']]], - ['byteswap_1724',['byteswap',['../namespacenc.html#a244a5b96158e15e74e2cc1e54c17edff',1,'nc']]] + ['back_1774',['back',['../classnc_1_1_data_cube.html#abc8860c7c767170d003da447e7618bee',1,'nc::DataCube::back()'],['../classnc_1_1_nd_array.html#a6bb650c9e28ff25c9b58c9f4f08d78bb',1,'nc::NdArray::back() const noexcept'],['../classnc_1_1_nd_array.html#a555efdc758b47b107c9c94593b6c2470',1,'nc::NdArray::back() noexcept'],['../classnc_1_1_nd_array.html#a563cf4dcecda39a0599cc13c87363677',1,'nc::NdArray::back(size_type row) const'],['../classnc_1_1_nd_array.html#a20fb268d9bd6c25dd70b6772f5ff5b89',1,'nc::NdArray::back(size_type row)'],['../classnc_1_1_vec3.html#a44e50b4b49011ec94548558600c0b17c',1,'nc::Vec3::back()']]], + ['bartlett_1775',['bartlett',['../namespacenc.html#a594225660881a1cd0caabba4946c07d4',1,'nc']]], + ['begin_1776',['begin',['../classnc_1_1_data_cube.html#a430de05758db67815f957784b298b011',1,'nc::DataCube::begin()'],['../classnc_1_1image_processing_1_1_cluster.html#a6e761b470453d5506015b9332b12e4a4',1,'nc::imageProcessing::Cluster::begin()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a37c172d7253190e76b065ed2547c3020',1,'nc::imageProcessing::ClusterMaker::begin()'],['../classnc_1_1_nd_array.html#ab57282e02905eeb2a932eeb73983221f',1,'nc::NdArray::begin() noexcept'],['../classnc_1_1_nd_array.html#a57fa866d30c298337bfc906ae73b6a40',1,'nc::NdArray::begin(size_type inRow)'],['../classnc_1_1_nd_array.html#ae47b79d2054d83dc0c7deb617ab7d1c2',1,'nc::NdArray::begin() const noexcept'],['../classnc_1_1_nd_array.html#ab3cdc446e55744b31d42dfb53fcdc7cf',1,'nc::NdArray::begin(size_type inRow) const']]], + ['bernoilli_1777',['bernoilli',['../namespacenc_1_1special.html#a1af26e52a24fca2b572605ec4b2c1f1b',1,'nc::special::bernoilli(uint32 n)'],['../namespacenc_1_1special.html#a59caf35b816a219aa2782dd45df207ca',1,'nc::special::bernoilli(const NdArray< uint32 > &inArray)']]], + ['bernoulli_1778',['bernoulli',['../namespacenc_1_1random.html#a1a5af4283601fd8663dcdc34599aede3',1,'nc::random::bernoulli(double inP=0.5)'],['../namespacenc_1_1random.html#a8d4a1a62fc03a44cccfa4012413bd70f',1,'nc::random::bernoulli(const Shape &inShape, double inP=0.5)']]], + ['bessel_5fin_1779',['bessel_in',['../namespacenc_1_1special.html#a6e9dbda70e7c0732d0b63ea389e5af49',1,'nc::special::bessel_in(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a92141b6d9ffda6c68c7cb13dee3eae60',1,'nc::special::bessel_in(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fin_5fprime_1780',['bessel_in_prime',['../namespacenc_1_1special.html#a85979b28c3403361a3e818c9cf8cdf16',1,'nc::special::bessel_in_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a416353fb98d37ed2e1a8ab587a16f6f8',1,'nc::special::bessel_in_prime(dtype1 inV, dtype2 inX)']]], + ['bessel_5fjn_1781',['bessel_jn',['../namespacenc_1_1special.html#a3986d3b42ddcd747d40fb6772b49536e',1,'nc::special::bessel_jn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ab310a9680ad09bc52377898876a27620',1,'nc::special::bessel_jn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fjn_5fprime_1782',['bessel_jn_prime',['../namespacenc_1_1special.html#a3eef0d1e8d31602e816578f778feefb5',1,'nc::special::bessel_jn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a6e4139a3ecc85275c4690d01453366dc',1,'nc::special::bessel_jn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fkn_1783',['bessel_kn',['../namespacenc_1_1special.html#a614d69a09535948c87124fe5662452dc',1,'nc::special::bessel_kn(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a5727fa899a61975ffcb79d84fd2d231b',1,'nc::special::bessel_kn(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fkn_5fprime_1784',['bessel_kn_prime',['../namespacenc_1_1special.html#aa3159d6cbb77b6bc1b913c25d969fa3c',1,'nc::special::bessel_kn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a98aad61d58f7d046091f6f569d2c97fb',1,'nc::special::bessel_kn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['bessel_5fyn_1785',['bessel_yn',['../namespacenc_1_1special.html#a2a215c5881fc0d98e444942d3a67ed5b',1,'nc::special::bessel_yn(dtype1 inV, const NdArray< dtype2 > &inArrayX)'],['../namespacenc_1_1special.html#a55bbc44ffde64dfb7af7a803250cd2a6',1,'nc::special::bessel_yn(dtype1 inV, dtype2 inX)']]], + ['bessel_5fyn_5fprime_1786',['bessel_yn_prime',['../namespacenc_1_1special.html#a742272fb70f0b85164b61409ad3f464f',1,'nc::special::bessel_yn_prime(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a129b71949a9659519aea36dc64d47020',1,'nc::special::bessel_yn_prime(dtype1 inV, const NdArray< dtype2 > &inArrayX)']]], + ['beta_1787',['beta',['../namespacenc_1_1special.html#ad2ac5c7add77e243dc39899c15ad93e6',1,'nc::special::beta(const NdArray< dtype1 > &inArrayA, const NdArray< dtype2 > &inArrayB)'],['../namespacenc_1_1special.html#a9b74f451f99338c909b7f73df6e5bff6',1,'nc::special::beta(dtype1 a, dtype2 b)'],['../namespacenc_1_1random.html#ab7de94b949521786b7bde650b1e813fa',1,'nc::random::beta(const Shape &inShape, dtype inAlpha, dtype inBeta)'],['../namespacenc_1_1random.html#a9cf5ddddc350278c76e077c67b5254ab',1,'nc::random::beta(dtype inAlpha, dtype inBeta)']]], + ['binaryrepr_1788',['binaryRepr',['../namespacenc.html#a8c8a7dbf208bb2d31983140598e7cebe',1,'nc']]], + ['bincount_1789',['bincount',['../namespacenc.html#a60bb0f9e8bed0fd6f5c0973cf3b918ca',1,'nc::bincount(const NdArray< dtype > &inArray, uint16 inMinLength=1)'],['../namespacenc.html#aa31a10ae8201c637ab3d203844b81904',1,'nc::bincount(const NdArray< dtype > &inArray, const NdArray< dtype > &inWeights, uint16 inMinLength=1)']]], + ['binomial_1790',['binomial',['../namespacenc_1_1random.html#a13657004ec565f15648a520e3d060002',1,'nc::random::binomial(dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#a83099ec22905c3ad69984a94d823a3d8',1,'nc::random::binomial(const Shape &inShape, dtype inN, double inP=0.5)']]], + ['bisection_1791',['Bisection',['../classnc_1_1roots_1_1_bisection.html#ae9ccce420ccf01a829b0138f264956cb',1,'nc::roots::Bisection::Bisection(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_bisection.html#a05985162d3dac7a0919319c6cde74895',1,'nc::roots::Bisection::Bisection(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept']]], + ['bits_1792',['bits',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ae35570f524474adaa2315bead3f9be9e',1,'nc::DtypeInfo< std::complex< dtype > >::bits()'],['../classnc_1_1_dtype_info.html#a3f6aa0cc80e59dc331bc0e8dfe2f20bb',1,'nc::DtypeInfo::bits()']]], + ['bitwise_5fand_1793',['bitwise_and',['../namespacenc.html#a4a7fa01dbe15029314c6204f930c09af',1,'nc']]], + ['bitwise_5fnot_1794',['bitwise_not',['../namespacenc.html#a172096cafc950983ccbbb05eb5426722',1,'nc']]], + ['bitwise_5for_1795',['bitwise_or',['../namespacenc.html#a6203fb3929a9c533eba79b64342eaa3a',1,'nc']]], + ['bitwise_5fxor_1796',['bitwise_xor',['../namespacenc.html#a07c69919a1dc382fd2ae3ebf1b358319',1,'nc']]], + ['blackman_1797',['blackman',['../namespacenc.html#aab31b376c91a94e877f236177dbab4d0',1,'nc']]], + ['brent_1798',['Brent',['../classnc_1_1roots_1_1_brent.html#a1e9cf8f7be13c7bbb42a073ec9eb5369',1,'nc::roots::Brent::Brent(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_brent.html#aecf6662d1b7128d38796cf4ab99143f4',1,'nc::roots::Brent::Brent(const double epsilon, std::function< double(double)> f) noexcept']]], + ['byteswap_1799',['byteswap',['../classnc_1_1_nd_array.html#a2d3f796540ca2966cd2964a358627630',1,'nc::NdArray']]], + ['byteswap_1800',['byteSwap',['../namespacenc_1_1endian.html#a28d96487f9ac66755e2dd4925a459e0d',1,'nc::endian']]], + ['byteswap_1801',['byteswap',['../namespacenc.html#a244a5b96158e15e74e2cc1e54c17edff',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/functions_10.html b/docs/doxygen/html/search/functions_10.html index 3cf61c9dc..1bdc12572 100644 --- a/docs/doxygen/html/search/functions_10.html +++ b/docs/doxygen/html/search/functions_10.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_10.js b/docs/doxygen/html/search/functions_10.js index 509090ece..0abcf6653 100644 --- a/docs/doxygen/html/search/functions_10.js +++ b/docs/doxygen/html/search/functions_10.js @@ -1,4 +1,4 @@ var searchData= [ - ['quaternion_2084',['Quaternion',['../classnc_1_1rotations_1_1_quaternion.html#a3b6901fb3a079eb9249bd1bf3098c36c',1,'nc::rotations::Quaternion::Quaternion()=default'],['../classnc_1_1rotations_1_1_quaternion.html#a8c498c295071b8b787902044bf87d34d',1,'nc::rotations::Quaternion::Quaternion(double roll, double pitch, double yaw) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a3ba2fb2c68554ec78a0957dc1fd7752d',1,'nc::rotations::Quaternion::Quaternion(double inI, double inJ, double inK, double inS) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#addcc7fb7b4acd4201e7f5b90ef207f4d',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inArray)'],['../classnc_1_1rotations_1_1_quaternion.html#abbacae2cb36d4f7e93e1cf130f8ca6b4',1,'nc::rotations::Quaternion::Quaternion(const Vec3 &inAxis, double inAngle) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a81b7db9d5e593a61272e09ce7dcc1325',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inAxis, double inAngle)']]] + ['quaternion_2186',['Quaternion',['../classnc_1_1rotations_1_1_quaternion.html#a3b6901fb3a079eb9249bd1bf3098c36c',1,'nc::rotations::Quaternion::Quaternion()=default'],['../classnc_1_1rotations_1_1_quaternion.html#a8c498c295071b8b787902044bf87d34d',1,'nc::rotations::Quaternion::Quaternion(double roll, double pitch, double yaw) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a3ba2fb2c68554ec78a0957dc1fd7752d',1,'nc::rotations::Quaternion::Quaternion(double inI, double inJ, double inK, double inS) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#addcc7fb7b4acd4201e7f5b90ef207f4d',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inArray)'],['../classnc_1_1rotations_1_1_quaternion.html#abbacae2cb36d4f7e93e1cf130f8ca6b4',1,'nc::rotations::Quaternion::Quaternion(const Vec3 &inAxis, double inAngle) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a81b7db9d5e593a61272e09ce7dcc1325',1,'nc::rotations::Quaternion::Quaternion(const NdArray< double > &inAxis, double inAngle)']]] ]; diff --git a/docs/doxygen/html/search/functions_11.html b/docs/doxygen/html/search/functions_11.html index 22dd78b23..188076ef2 100644 --- a/docs/doxygen/html/search/functions_11.html +++ b/docs/doxygen/html/search/functions_11.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_11.js b/docs/doxygen/html/search/functions_11.js index 0f4a0e286..d6381908e 100644 --- a/docs/doxygen/html/search/functions_11.js +++ b/docs/doxygen/html/search/functions_11.js @@ -1,48 +1,47 @@ var searchData= [ - ['ra_2085',['RA',['../classnc_1_1coordinates_1_1_r_a.html#ab14fd57fb6ab65c4d8ca668d549a507f',1,'nc::coordinates::RA::RA(double inDegrees)'],['../classnc_1_1coordinates_1_1_r_a.html#a7566e8350b9075ae0f0406fce26b7900',1,'nc::coordinates::RA::RA(uint8 inHours, uint8 inMinutes, double inSeconds) noexcept']]], - ['ra_2086',['ra',['../classnc_1_1coordinates_1_1_coordinate.html#abf447494a1d0a769af81aeab79041e5b',1,'nc::coordinates::Coordinate']]], - ['ra_2087',['RA',['../classnc_1_1coordinates_1_1_r_a.html#a632d150cc8009f1ab61053161046f553',1,'nc::coordinates::RA']]], - ['rad2deg_2088',['rad2deg',['../namespacenc.html#a19a21c68cb53309ac33e9c1a7b5d2513',1,'nc::rad2deg(const NdArray< dtype > &inArray)'],['../namespacenc.html#a8c8fc041b633785104c583a8ce3d9cef',1,'nc::rad2deg(dtype inValue) noexcept']]], - ['radians_2089',['radians',['../namespacenc.html#ac0f2714a22ef5029abf0f3fee0028546',1,'nc::radians(dtype inValue) noexcept'],['../namespacenc.html#a746ecf69081dec55ceb2647726ee106b',1,'nc::radians(const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_r_a.html#a8a9f875774dd8375cbc72c7fbfbebc2a',1,'nc::coordinates::RA::radians()'],['../classnc_1_1coordinates_1_1_dec.html#af80282ccfb04054bbccb98735a28ac46',1,'nc::coordinates::Dec::radians()']]], - ['radianseperation_2090',['radianSeperation',['../classnc_1_1coordinates_1_1_coordinate.html#ae01f4143ae771a0f8bccefc4bba78b86',1,'nc::coordinates::Coordinate::radianSeperation(const NdArray< double > &inVector) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a169974783c87c9bbc89ccb4ea2ea4123',1,'nc::coordinates::Coordinate::radianSeperation(const Coordinate &inOtherCoordinate) const'],['../namespacenc_1_1coordinates.html#aa009e573b47b51d34d3aae0b152566c8',1,'nc::coordinates::radianSeperation(const Coordinate &inCoordinate1, const Coordinate &inCoordinate2)'],['../namespacenc_1_1coordinates.html#a712fd847123cfde7948c36ca59c6a435',1,'nc::coordinates::radianSeperation(const NdArray< double > &inVector1, const NdArray< double > &inVector2)']]], - ['rand_2091',['rand',['../namespacenc_1_1random.html#a0f5694167e15a8bc566a3fa6f842c3b4',1,'nc::random::rand()'],['../namespacenc_1_1random.html#a4552f49c72dc1a4d8426643fce14f214',1,'nc::random::rand(const Shape &inShape)']]], - ['randfloat_2092',['randFloat',['../namespacenc_1_1random.html#a531b5487f2f3e54fab878340277f7283',1,'nc::random::randFloat(const Shape &inShape, dtype inLow, dtype inHigh=0.0)'],['../namespacenc_1_1random.html#a4a261ae2a0f7783f2a5262a22b18412f',1,'nc::random::randFloat(dtype inLow, dtype inHigh=0.0)']]], - ['randint_2093',['randInt',['../namespacenc_1_1random.html#a43201ec4ec8e0c99041647ab45ac0133',1,'nc::random::randInt(dtype inLow, dtype inHigh=0)'],['../namespacenc_1_1random.html#a2842db744ad52ca905a48cd281934fd3',1,'nc::random::randInt(const Shape &inShape, dtype inLow, dtype inHigh=0)']]], - ['randn_2094',['randN',['../namespacenc_1_1random.html#aeffa74d48c1fb2603f83eaa358f17501',1,'nc::random::randN()'],['../namespacenc_1_1random.html#a3c6b8fb355a9ec0bd4c9e9bb8062d1f2',1,'nc::random::randN(const Shape &inShape)']]], - ['rankfilter_2095',['rankFilter',['../namespacenc_1_1filter.html#a0c2cbe33d4d1ef4f6a1a10320db1c059',1,'nc::filter']]], - ['rankfilter1d_2096',['rankFilter1d',['../namespacenc_1_1filter.html#ac46eab01f172d2fb3818e0d1cfaf1274',1,'nc::filter']]], - ['ravel_2097',['ravel',['../namespacenc.html#a3e7af5d797200117ddc5e5e3e2a46ee9',1,'nc::ravel()'],['../classnc_1_1_nd_array.html#aeca85f2279281bd389225a76e23e1c45',1,'nc::NdArray::ravel() noexcept']]], - ['rbegin_2098',['rbegin',['../classnc_1_1_nd_array.html#a06b5c7ba13ae9f8750bca6d5f3803c73',1,'nc::NdArray::rbegin() noexcept'],['../classnc_1_1_nd_array.html#a9f983aabd3568e7bd1be0a0c4e2b881d',1,'nc::NdArray::rbegin(size_type inRow) const'],['../classnc_1_1_nd_array.html#ad779b3d2a2f094370be77e515533f143',1,'nc::NdArray::rbegin() const noexcept'],['../classnc_1_1_nd_array.html#a2aa9a0589da3c0b19b1b413e71f65667',1,'nc::NdArray::rbegin(size_type inRow)']]], - ['rcolbegin_2099',['rcolbegin',['../classnc_1_1_nd_array.html#a5f70273a5bbff4f0b0c5086649939301',1,'nc::NdArray::rcolbegin(size_type inCol) const'],['../classnc_1_1_nd_array.html#a012f1203a072caeba4221aaa3c044186',1,'nc::NdArray::rcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a56704aea2c006973065aaa2848faa7fb',1,'nc::NdArray::rcolbegin(size_type inCol)'],['../classnc_1_1_nd_array.html#a48fb313ad0eb8126c338a319a5a2fd98',1,'nc::NdArray::rcolbegin() noexcept']]], - ['rcolend_2100',['rcolend',['../classnc_1_1_nd_array.html#ad5f870f49c9601930423258dcc723c8e',1,'nc::NdArray::rcolend() noexcept'],['../classnc_1_1_nd_array.html#a434f10a7956f425882fbbbc90038e4cb',1,'nc::NdArray::rcolend(size_type inCol)'],['../classnc_1_1_nd_array.html#a2d5976e4cd61862c74dce30c94f8fb87',1,'nc::NdArray::rcolend() const noexcept'],['../classnc_1_1_nd_array.html#a51e2cddde9482a27bf73fa308e0268c6',1,'nc::NdArray::rcolend(size_type inCol) const']]], - ['real_2101',['real',['../namespacenc.html#af7cf60663e018e25b1b59016af7e8967',1,'nc::real(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a74174a26b4b6db41951d9ce4222ea724',1,'nc::real(const std::complex< dtype > &inValue)']]], - ['reciprocal_2102',['reciprocal',['../namespacenc.html#ac3d266878661a694e99329ab16fa5d25',1,'nc::reciprocal(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#af0dd0542b322f7f4f8124d13d25cf50e',1,'nc::reciprocal(const NdArray< dtype > &inArray)']]], - ['reflect1d_2103',['reflect1d',['../namespacenc_1_1filter_1_1boundary.html#ac423cb3e19b12651c02c2c16d0723b3f',1,'nc::filter::boundary']]], - ['reflect2d_2104',['reflect2d',['../namespacenc_1_1filter_1_1boundary.html#add9a7d70820161e370ecd37212b1f397',1,'nc::filter::boundary']]], - ['remainder_2105',['remainder',['../namespacenc.html#a12bfc5b4d937aa0366b70fb15270bd41',1,'nc::remainder(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a14fb9f7c88fca02b0ef3f5ebd04d9099',1,'nc::remainder(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['rend_2106',['rend',['../classnc_1_1_nd_array.html#a92c90b8671a637ec7d7821f6e8bdfa56',1,'nc::NdArray::rend() noexcept'],['../classnc_1_1_nd_array.html#a9047b67188b652c471db37731659c598',1,'nc::NdArray::rend(size_type inRow)'],['../classnc_1_1_nd_array.html#a59de727a0db449ca5a28d436c9cec165',1,'nc::NdArray::rend() const noexcept'],['../classnc_1_1_nd_array.html#a93f962a3badfd82da685a2d7fdf006aa',1,'nc::NdArray::rend(size_type inRow) const']]], - ['repeat_2107',['repeat',['../classnc_1_1_nd_array.html#a7d72328d5853baedb1644ae387ed3331',1,'nc::NdArray::repeat(const Shape &inRepeatShape) const'],['../classnc_1_1_nd_array.html#acd2185e49f9cbe68b3d3fe6cef552d34',1,'nc::NdArray::repeat(uint32 inNumRows, uint32 inNumCols) const'],['../namespacenc.html#a5aaf1657514116d3556183665983e02a',1,'nc::repeat(const NdArray< dtype > &inArray, const Shape &inRepeatShape)'],['../namespacenc.html#a29f4287edbe473e6039e4566adfd3ea4',1,'nc::repeat(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], - ['replace_2108',['replace',['../namespacenc_1_1stl__algorithms.html#aa8d46043c9c62a348687ef8aa0a3286b',1,'nc::stl_algorithms::replace()'],['../namespacenc.html#a8e35a8cdb9a2a053820c58d2a9eab4e2',1,'nc::replace()'],['../classnc_1_1_nd_array.html#aefaba20fd8cf6710714340ea9733f1d5',1,'nc::NdArray::replace()']]], - ['resetnumberofiterations_2109',['resetNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#a85e79a4794bc3a6ac6bc3564956737a2',1,'nc::roots::Iteration']]], - ['reshape_2110',['reshape',['../namespacenc.html#a45d9fc095ecf7a127211c507c03d95db',1,'nc::reshape()'],['../classnc_1_1_nd_array.html#aa646e053a4fcd7ef3356add1edb4240d',1,'nc::NdArray::reshape(int32 inNumRows, int32 inNumCols)'],['../classnc_1_1_nd_array.html#a81992957eaa4cf2da430e12296af79c7',1,'nc::NdArray::reshape(const Shape &inShape)'],['../classnc_1_1_nd_array.html#ace0dfa53f15057e5f505a41b67f000bb',1,'nc::NdArray::reshape(size_type inSize)'],['../namespacenc.html#a5fb8d978dec93ab8a07849b5dc0d2b06',1,'nc::reshape(NdArray< dtype > &inArray, uint32 inSize)'],['../namespacenc.html#a6858d6bf094cfeaa724b78133668d13d',1,'nc::reshape(NdArray< dtype > &inArray, int32 inNumRows, int32 inNumCols)']]], - ['resizefast_2111',['resizeFast',['../namespacenc.html#ac2bcb04348f201141d8f465e461269cc',1,'nc::resizeFast(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a4dcc5b3664678e2510ff1df693641619',1,'nc::resizeFast(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a1f999dc4afd08a9bc9c696af66d3ccb3',1,'nc::NdArray::resizeFast(const Shape &inShape)'],['../classnc_1_1_nd_array.html#ac15af1559e8f8dcd8cd5930c5ce54377',1,'nc::NdArray::resizeFast(uint32 inNumRows, uint32 inNumCols)']]], - ['resizeslow_2112',['resizeSlow',['../namespacenc.html#acdf2d60461cf6779107dc00118b642f9',1,'nc::resizeSlow(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a845b9344102b55adc482616442765d93',1,'nc::resizeSlow(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a9499c04345682f4bf0afd8a5d16df435',1,'nc::NdArray::resizeSlow(const Shape &inShape)'],['../classnc_1_1_nd_array.html#a091f587d753e4e4aec1bb6621ccbaa41',1,'nc::NdArray::resizeSlow(uint32 inNumRows, uint32 inNumCols)']]], - ['reverse_2113',['reverse',['../namespacenc_1_1stl__algorithms.html#a5334750b4a1bb38d3932bffcc32a71b4',1,'nc::stl_algorithms']]], - ['riemann_5fzeta_2114',['riemann_zeta',['../namespacenc_1_1special.html#a8d31d086f833496ad7eb98c5bd6304a2',1,'nc::special::riemann_zeta(dtype inValue)'],['../namespacenc_1_1special.html#a6a4ac80df3e9946630cf330d03cbbbd2',1,'nc::special::riemann_zeta(const NdArray< dtype > &inArray)']]], - ['right_2115',['right',['../classnc_1_1_vec2.html#ab84fdd231058aa0343e2249e209855bf',1,'nc::Vec2::right()'],['../classnc_1_1_vec3.html#af8862aed471260a45c7691c7c5c6b016',1,'nc::Vec3::right()']]], - ['right_5fshift_2116',['right_shift',['../namespacenc.html#ad66d86cf7f33128b1d7540ac7cde9f75',1,'nc']]], - ['rint_2117',['rint',['../namespacenc.html#ae37c534819fb5756874bf8972df7e2fa',1,'nc::rint(const NdArray< dtype > &inArray)'],['../namespacenc.html#a9ba33527dbca7d5482cf88899abd827d',1,'nc::rint(dtype inValue) noexcept']]], - ['rms_2118',['rms',['../namespacenc.html#a4e858c717929038ef196af3c4b4c53ae',1,'nc::rms(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a0da200d1221a9b1c526de48ccba57258',1,'nc::rms(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], - ['rodriguesrotation_2119',['rodriguesRotation',['../namespacenc_1_1rotations.html#ae7d7397eec3edcfbd8b6b9784ad2fd1c',1,'nc::rotations::rodriguesRotation(const Vec3 &k, double theta, const Vec3 &v) noexcept'],['../namespacenc_1_1rotations.html#ab0fbd9345e707b6efb023ec9b354fbb5',1,'nc::rotations::rodriguesRotation(const NdArray< dtype > &k, double theta, const NdArray< dtype > &v)']]], - ['roll_2120',['roll',['../classnc_1_1rotations_1_1_d_c_m.html#ac562518ebdec1ce36cf8897a16f16fca',1,'nc::rotations::DCM::roll()'],['../classnc_1_1rotations_1_1_quaternion.html#a26f2a9303f0521ee36d92467ab45e3ab',1,'nc::rotations::Quaternion::roll()'],['../namespacenc.html#a57ce5ac638626e5718c13f756af23bf2',1,'nc::roll()']]], - ['romberg_2121',['romberg',['../namespacenc_1_1integrate.html#a5406412619aa59539dd19f62f0be8caf',1,'nc::integrate']]], - ['rot90_2122',['rot90',['../namespacenc.html#a2f52b32644f8f4da903e9c096d283da6',1,'nc']]], - ['rotate_2123',['rotate',['../namespacenc_1_1stl__algorithms.html#acfc1538e29a04fe5158405c710e5eaa7',1,'nc::stl_algorithms::rotate()'],['../classnc_1_1rotations_1_1_quaternion.html#a2e19c4d0b48d7f73e0aa273d85435370',1,'nc::rotations::Quaternion::rotate(const NdArray< double > &inVector) const'],['../classnc_1_1rotations_1_1_quaternion.html#a382d4e4c045bce131c5cce634ed077c7',1,'nc::rotations::Quaternion::rotate(const Vec3 &inVec3) const']]], - ['round_2124',['round',['../classnc_1_1_nd_array.html#a13b0f7af99772cfbca83b6734fbef04d',1,'nc::NdArray::round()'],['../namespacenc.html#af9c0b27b59e8a7be27130c9f470c4ef3',1,'nc::round(dtype inValue, uint8 inDecimals=0)'],['../namespacenc.html#a2a3a666494e7c95975d40ce80b156f0f',1,'nc::round(const NdArray< dtype > &inArray, uint8 inDecimals=0)']]], - ['row_2125',['row',['../classnc_1_1image_processing_1_1_centroid.html#aa3546b7b2430b51650f40fb344ab55a8',1,'nc::imageProcessing::Centroid::row()'],['../classnc_1_1_nd_array.html#ab24cce75b03204af139d8d32090cdae8',1,'nc::NdArray::row()']]], - ['row_5fstack_2126',['row_stack',['../namespacenc.html#a0d82f81eba247f95974bd20039bd56fc',1,'nc']]], - ['rowmax_2127',['rowMax',['../classnc_1_1image_processing_1_1_cluster.html#a58eea870dca4a5c61cfd4db24ea50267',1,'nc::imageProcessing::Cluster']]], - ['rowmin_2128',['rowMin',['../classnc_1_1image_processing_1_1_cluster.html#ac3f0c485f193a71a6caca9f553970383',1,'nc::imageProcessing::Cluster']]], - ['rslice_2129',['rSlice',['../classnc_1_1_nd_array.html#af0fb0a32e08456603964206487aebc88',1,'nc::NdArray']]] + ['ra_2187',['RA',['../classnc_1_1coordinates_1_1_r_a.html#a632d150cc8009f1ab61053161046f553',1,'nc::coordinates::RA::RA()=default'],['../classnc_1_1coordinates_1_1_r_a.html#ab14fd57fb6ab65c4d8ca668d549a507f',1,'nc::coordinates::RA::RA(double inDegrees)'],['../classnc_1_1coordinates_1_1_r_a.html#a7566e8350b9075ae0f0406fce26b7900',1,'nc::coordinates::RA::RA(uint8 inHours, uint8 inMinutes, double inSeconds) noexcept']]], + ['ra_2188',['ra',['../classnc_1_1coordinates_1_1_coordinate.html#abf447494a1d0a769af81aeab79041e5b',1,'nc::coordinates::Coordinate']]], + ['rad2deg_2189',['rad2deg',['../namespacenc.html#a8c8fc041b633785104c583a8ce3d9cef',1,'nc::rad2deg(dtype inValue) noexcept'],['../namespacenc.html#a19a21c68cb53309ac33e9c1a7b5d2513',1,'nc::rad2deg(const NdArray< dtype > &inArray)']]], + ['radians_2190',['radians',['../classnc_1_1coordinates_1_1_dec.html#af80282ccfb04054bbccb98735a28ac46',1,'nc::coordinates::Dec::radians()'],['../classnc_1_1coordinates_1_1_r_a.html#a8a9f875774dd8375cbc72c7fbfbebc2a',1,'nc::coordinates::RA::radians()'],['../namespacenc.html#a746ecf69081dec55ceb2647726ee106b',1,'nc::radians(const NdArray< dtype > &inArray)'],['../namespacenc.html#ac0f2714a22ef5029abf0f3fee0028546',1,'nc::radians(dtype inValue) noexcept']]], + ['radianseperation_2191',['radianSeperation',['../classnc_1_1coordinates_1_1_coordinate.html#a169974783c87c9bbc89ccb4ea2ea4123',1,'nc::coordinates::Coordinate::radianSeperation(const Coordinate &inOtherCoordinate) const'],['../classnc_1_1coordinates_1_1_coordinate.html#ae01f4143ae771a0f8bccefc4bba78b86',1,'nc::coordinates::Coordinate::radianSeperation(const NdArray< double > &inVector) const'],['../namespacenc_1_1coordinates.html#a712fd847123cfde7948c36ca59c6a435',1,'nc::coordinates::radianSeperation(const NdArray< double > &inVector1, const NdArray< double > &inVector2)'],['../namespacenc_1_1coordinates.html#aa009e573b47b51d34d3aae0b152566c8',1,'nc::coordinates::radianSeperation(const Coordinate &inCoordinate1, const Coordinate &inCoordinate2)']]], + ['rand_2192',['rand',['../namespacenc_1_1random.html#a4552f49c72dc1a4d8426643fce14f214',1,'nc::random::rand(const Shape &inShape)'],['../namespacenc_1_1random.html#a0f5694167e15a8bc566a3fa6f842c3b4',1,'nc::random::rand()']]], + ['randfloat_2193',['randFloat',['../namespacenc_1_1random.html#a4a261ae2a0f7783f2a5262a22b18412f',1,'nc::random::randFloat(dtype inLow, dtype inHigh=0.0)'],['../namespacenc_1_1random.html#a531b5487f2f3e54fab878340277f7283',1,'nc::random::randFloat(const Shape &inShape, dtype inLow, dtype inHigh=0.0)']]], + ['randint_2194',['randInt',['../namespacenc_1_1random.html#a2842db744ad52ca905a48cd281934fd3',1,'nc::random::randInt(const Shape &inShape, dtype inLow, dtype inHigh=0)'],['../namespacenc_1_1random.html#a43201ec4ec8e0c99041647ab45ac0133',1,'nc::random::randInt(dtype inLow, dtype inHigh=0)']]], + ['randn_2195',['randN',['../namespacenc_1_1random.html#a3c6b8fb355a9ec0bd4c9e9bb8062d1f2',1,'nc::random::randN(const Shape &inShape)'],['../namespacenc_1_1random.html#aeffa74d48c1fb2603f83eaa358f17501',1,'nc::random::randN()']]], + ['rankfilter_2196',['rankFilter',['../namespacenc_1_1filter.html#a0c2cbe33d4d1ef4f6a1a10320db1c059',1,'nc::filter']]], + ['rankfilter1d_2197',['rankFilter1d',['../namespacenc_1_1filter.html#ac46eab01f172d2fb3818e0d1cfaf1274',1,'nc::filter']]], + ['ravel_2198',['ravel',['../classnc_1_1_nd_array.html#aeca85f2279281bd389225a76e23e1c45',1,'nc::NdArray::ravel()'],['../namespacenc.html#a3e7af5d797200117ddc5e5e3e2a46ee9',1,'nc::ravel()']]], + ['rbegin_2199',['rbegin',['../classnc_1_1_nd_array.html#a06b5c7ba13ae9f8750bca6d5f3803c73',1,'nc::NdArray::rbegin() noexcept'],['../classnc_1_1_nd_array.html#a2aa9a0589da3c0b19b1b413e71f65667',1,'nc::NdArray::rbegin(size_type inRow)'],['../classnc_1_1_nd_array.html#ad779b3d2a2f094370be77e515533f143',1,'nc::NdArray::rbegin() const noexcept'],['../classnc_1_1_nd_array.html#a9f983aabd3568e7bd1be0a0c4e2b881d',1,'nc::NdArray::rbegin(size_type inRow) const']]], + ['rcolbegin_2200',['rcolbegin',['../classnc_1_1_nd_array.html#a48fb313ad0eb8126c338a319a5a2fd98',1,'nc::NdArray::rcolbegin() noexcept'],['../classnc_1_1_nd_array.html#a56704aea2c006973065aaa2848faa7fb',1,'nc::NdArray::rcolbegin(size_type inCol)'],['../classnc_1_1_nd_array.html#a012f1203a072caeba4221aaa3c044186',1,'nc::NdArray::rcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a5f70273a5bbff4f0b0c5086649939301',1,'nc::NdArray::rcolbegin(size_type inCol) const']]], + ['rcolend_2201',['rcolend',['../classnc_1_1_nd_array.html#ad5f870f49c9601930423258dcc723c8e',1,'nc::NdArray::rcolend() noexcept'],['../classnc_1_1_nd_array.html#a434f10a7956f425882fbbbc90038e4cb',1,'nc::NdArray::rcolend(size_type inCol)'],['../classnc_1_1_nd_array.html#a2d5976e4cd61862c74dce30c94f8fb87',1,'nc::NdArray::rcolend() const noexcept'],['../classnc_1_1_nd_array.html#a51e2cddde9482a27bf73fa308e0268c6',1,'nc::NdArray::rcolend(size_type inCol) const']]], + ['real_2202',['real',['../namespacenc.html#af7cf60663e018e25b1b59016af7e8967',1,'nc::real(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a74174a26b4b6db41951d9ce4222ea724',1,'nc::real(const std::complex< dtype > &inValue)']]], + ['reciprocal_2203',['reciprocal',['../namespacenc.html#ac3d266878661a694e99329ab16fa5d25',1,'nc::reciprocal(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#af0dd0542b322f7f4f8124d13d25cf50e',1,'nc::reciprocal(const NdArray< dtype > &inArray)']]], + ['reflect1d_2204',['reflect1d',['../namespacenc_1_1filter_1_1boundary.html#ac423cb3e19b12651c02c2c16d0723b3f',1,'nc::filter::boundary']]], + ['reflect2d_2205',['reflect2d',['../namespacenc_1_1filter_1_1boundary.html#add9a7d70820161e370ecd37212b1f397',1,'nc::filter::boundary']]], + ['remainder_2206',['remainder',['../namespacenc.html#a14fb9f7c88fca02b0ef3f5ebd04d9099',1,'nc::remainder(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a12bfc5b4d937aa0366b70fb15270bd41',1,'nc::remainder(dtype inValue1, dtype inValue2) noexcept']]], + ['rend_2207',['rend',['../classnc_1_1_nd_array.html#a92c90b8671a637ec7d7821f6e8bdfa56',1,'nc::NdArray::rend() noexcept'],['../classnc_1_1_nd_array.html#a9047b67188b652c471db37731659c598',1,'nc::NdArray::rend(size_type inRow)'],['../classnc_1_1_nd_array.html#a59de727a0db449ca5a28d436c9cec165',1,'nc::NdArray::rend() const noexcept'],['../classnc_1_1_nd_array.html#a93f962a3badfd82da685a2d7fdf006aa',1,'nc::NdArray::rend(size_type inRow) const']]], + ['repeat_2208',['repeat',['../classnc_1_1_nd_array.html#acd2185e49f9cbe68b3d3fe6cef552d34',1,'nc::NdArray::repeat(uint32 inNumRows, uint32 inNumCols) const'],['../classnc_1_1_nd_array.html#a7d72328d5853baedb1644ae387ed3331',1,'nc::NdArray::repeat(const Shape &inRepeatShape) const'],['../namespacenc.html#a5aaf1657514116d3556183665983e02a',1,'nc::repeat(const NdArray< dtype > &inArray, const Shape &inRepeatShape)'],['../namespacenc.html#a29f4287edbe473e6039e4566adfd3ea4',1,'nc::repeat(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], + ['replace_2209',['replace',['../classnc_1_1_nd_array.html#aefaba20fd8cf6710714340ea9733f1d5',1,'nc::NdArray::replace()'],['../namespacenc_1_1stl__algorithms.html#aa8d46043c9c62a348687ef8aa0a3286b',1,'nc::stl_algorithms::replace()'],['../namespacenc.html#a8e35a8cdb9a2a053820c58d2a9eab4e2',1,'nc::replace()']]], + ['resetnumberofiterations_2210',['resetNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#a85e79a4794bc3a6ac6bc3564956737a2',1,'nc::roots::Iteration']]], + ['reshape_2211',['reshape',['../classnc_1_1_nd_array.html#ace0dfa53f15057e5f505a41b67f000bb',1,'nc::NdArray::reshape(size_type inSize)'],['../classnc_1_1_nd_array.html#aa646e053a4fcd7ef3356add1edb4240d',1,'nc::NdArray::reshape(int32 inNumRows, int32 inNumCols)'],['../classnc_1_1_nd_array.html#a81992957eaa4cf2da430e12296af79c7',1,'nc::NdArray::reshape(const Shape &inShape)'],['../namespacenc.html#a45d9fc095ecf7a127211c507c03d95db',1,'nc::reshape(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a5fb8d978dec93ab8a07849b5dc0d2b06',1,'nc::reshape(NdArray< dtype > &inArray, uint32 inSize)'],['../namespacenc.html#a6858d6bf094cfeaa724b78133668d13d',1,'nc::reshape(NdArray< dtype > &inArray, int32 inNumRows, int32 inNumCols)']]], + ['resizefast_2212',['resizeFast',['../classnc_1_1_nd_array.html#ac15af1559e8f8dcd8cd5930c5ce54377',1,'nc::NdArray::resizeFast(uint32 inNumRows, uint32 inNumCols)'],['../classnc_1_1_nd_array.html#a1f999dc4afd08a9bc9c696af66d3ccb3',1,'nc::NdArray::resizeFast(const Shape &inShape)'],['../namespacenc.html#ac2bcb04348f201141d8f465e461269cc',1,'nc::resizeFast(NdArray< dtype > &inArray, const Shape &inNewShape)'],['../namespacenc.html#a4dcc5b3664678e2510ff1df693641619',1,'nc::resizeFast(NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], + ['resizeslow_2213',['resizeSlow',['../classnc_1_1_nd_array.html#a091f587d753e4e4aec1bb6621ccbaa41',1,'nc::NdArray::resizeSlow()'],['../namespacenc.html#a845b9344102b55adc482616442765d93',1,'nc::resizeSlow()'],['../classnc_1_1_nd_array.html#a9499c04345682f4bf0afd8a5d16df435',1,'nc::NdArray::resizeSlow()'],['../namespacenc.html#acdf2d60461cf6779107dc00118b642f9',1,'nc::resizeSlow()']]], + ['reverse_2214',['reverse',['../namespacenc_1_1stl__algorithms.html#a5334750b4a1bb38d3932bffcc32a71b4',1,'nc::stl_algorithms']]], + ['riemann_5fzeta_2215',['riemann_zeta',['../namespacenc_1_1special.html#a8d31d086f833496ad7eb98c5bd6304a2',1,'nc::special::riemann_zeta(dtype inValue)'],['../namespacenc_1_1special.html#a6a4ac80df3e9946630cf330d03cbbbd2',1,'nc::special::riemann_zeta(const NdArray< dtype > &inArray)']]], + ['right_2216',['right',['../classnc_1_1_vec3.html#af8862aed471260a45c7691c7c5c6b016',1,'nc::Vec3::right()'],['../classnc_1_1_vec2.html#ab84fdd231058aa0343e2249e209855bf',1,'nc::Vec2::right()']]], + ['right_5fshift_2217',['right_shift',['../namespacenc.html#ad66d86cf7f33128b1d7540ac7cde9f75',1,'nc']]], + ['rint_2218',['rint',['../namespacenc.html#a9ba33527dbca7d5482cf88899abd827d',1,'nc::rint(dtype inValue) noexcept'],['../namespacenc.html#ae37c534819fb5756874bf8972df7e2fa',1,'nc::rint(const NdArray< dtype > &inArray)']]], + ['rms_2219',['rms',['../namespacenc.html#a4e858c717929038ef196af3c4b4c53ae',1,'nc::rms(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a0da200d1221a9b1c526de48ccba57258',1,'nc::rms(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['rodriguesrotation_2220',['rodriguesRotation',['../namespacenc_1_1rotations.html#ae7d7397eec3edcfbd8b6b9784ad2fd1c',1,'nc::rotations::rodriguesRotation(const Vec3 &k, double theta, const Vec3 &v) noexcept'],['../namespacenc_1_1rotations.html#ab0fbd9345e707b6efb023ec9b354fbb5',1,'nc::rotations::rodriguesRotation(const NdArray< dtype > &k, double theta, const NdArray< dtype > &v)']]], + ['roll_2221',['roll',['../classnc_1_1rotations_1_1_d_c_m.html#ac562518ebdec1ce36cf8897a16f16fca',1,'nc::rotations::DCM::roll()'],['../classnc_1_1rotations_1_1_quaternion.html#a26f2a9303f0521ee36d92467ab45e3ab',1,'nc::rotations::Quaternion::roll()'],['../namespacenc.html#a57ce5ac638626e5718c13f756af23bf2',1,'nc::roll()']]], + ['romberg_2222',['romberg',['../namespacenc_1_1integrate.html#a5406412619aa59539dd19f62f0be8caf',1,'nc::integrate']]], + ['rot90_2223',['rot90',['../namespacenc.html#a2f52b32644f8f4da903e9c096d283da6',1,'nc']]], + ['rotate_2224',['rotate',['../classnc_1_1rotations_1_1_quaternion.html#a2e19c4d0b48d7f73e0aa273d85435370',1,'nc::rotations::Quaternion::rotate(const NdArray< double > &inVector) const'],['../classnc_1_1rotations_1_1_quaternion.html#a382d4e4c045bce131c5cce634ed077c7',1,'nc::rotations::Quaternion::rotate(const Vec3 &inVec3) const'],['../namespacenc_1_1stl__algorithms.html#acfc1538e29a04fe5158405c710e5eaa7',1,'nc::stl_algorithms::rotate()']]], + ['round_2225',['round',['../classnc_1_1_nd_array.html#a13b0f7af99772cfbca83b6734fbef04d',1,'nc::NdArray::round()'],['../namespacenc.html#af9c0b27b59e8a7be27130c9f470c4ef3',1,'nc::round(dtype inValue, uint8 inDecimals=0)'],['../namespacenc.html#a2a3a666494e7c95975d40ce80b156f0f',1,'nc::round(const NdArray< dtype > &inArray, uint8 inDecimals=0)']]], + ['row_2226',['row',['../classnc_1_1_nd_array.html#ab24cce75b03204af139d8d32090cdae8',1,'nc::NdArray::row()'],['../classnc_1_1image_processing_1_1_centroid.html#aa3546b7b2430b51650f40fb344ab55a8',1,'nc::imageProcessing::Centroid::row()']]], + ['row_5fstack_2227',['row_stack',['../namespacenc.html#a0d82f81eba247f95974bd20039bd56fc',1,'nc']]], + ['rowmax_2228',['rowMax',['../classnc_1_1image_processing_1_1_cluster.html#a58eea870dca4a5c61cfd4db24ea50267',1,'nc::imageProcessing::Cluster']]], + ['rowmin_2229',['rowMin',['../classnc_1_1image_processing_1_1_cluster.html#ac3f0c485f193a71a6caca9f553970383',1,'nc::imageProcessing::Cluster']]], + ['rslice_2230',['rSlice',['../classnc_1_1_nd_array.html#af0fb0a32e08456603964206487aebc88',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/functions_12.html b/docs/doxygen/html/search/functions_12.html index cb20ca7b7..eb29d8f9a 100644 --- a/docs/doxygen/html/search/functions_12.html +++ b/docs/doxygen/html/search/functions_12.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_12.js b/docs/doxygen/html/search/functions_12.js index 914307a92..44869ea83 100644 --- a/docs/doxygen/html/search/functions_12.js +++ b/docs/doxygen/html/search/functions_12.js @@ -1,56 +1,56 @@ var searchData= [ - ['s_2130',['s',['../classnc_1_1rotations_1_1_quaternion.html#a075b6f1befef247f5d638c91e1a451fd',1,'nc::rotations::Quaternion::s()'],['../classnc_1_1linalg_1_1_s_v_d.html#a323915fbe7cbaabadef01ffa948d2f1a',1,'nc::linalg::SVD::s()']]], - ['secant_2131',['Secant',['../classnc_1_1roots_1_1_secant.html#adedf56589f2027e224d6044a071f20e3',1,'nc::roots::Secant::Secant(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_secant.html#af8afc48a7393e85103a9c2acc662c63b',1,'nc::roots::Secant::Secant(const double epsilon, std::function< double(double)> f) noexcept']]], - ['seconds_2132',['seconds',['../classnc_1_1coordinates_1_1_dec.html#a2927e30c2059f09bd30be622cf9b52ea',1,'nc::coordinates::Dec::seconds()'],['../classnc_1_1coordinates_1_1_r_a.html#af0c9b649f60a70bbf421a6eb5b169cda',1,'nc::coordinates::RA::seconds()']]], - ['seed_2133',['seed',['../namespacenc_1_1random.html#a93fe76208181d041adb08a02de0966d8',1,'nc::random']]], - ['set_5fdifference_2134',['set_difference',['../namespacenc_1_1stl__algorithms.html#a8a145ff0f4cf32b64e7464347d1ea9b2',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a8cc83e2fb7a3d8302db0f4b19513ddd9',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination)']]], - ['set_5fintersection_2135',['set_intersection',['../namespacenc_1_1stl__algorithms.html#ad9a963ad13c86117f01fe2960525e074',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#aa8ff8c5bb6003ff0f02a17deb4ced8e2',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], - ['set_5funion_2136',['set_union',['../namespacenc_1_1stl__algorithms.html#a33da2f830ebf2e7c04f1ac94e1ad20b7',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a273ff7212f84bcd8de30e83ab0ae3bd1',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], - ['setdiff1d_2137',['setdiff1d',['../namespacenc.html#adb6b7ca658c4d613fe0c4a695ba3542b',1,'nc']]], - ['setname_2138',['setName',['../classnc_1_1_timer.html#a88dd680a63b38ae9989a40878a8fd65b',1,'nc::Timer']]], - ['shape_2139',['shape',['../classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4',1,'nc::NdArray::shape()'],['../namespacenc.html#ae2b224742bc8263190d451a44ebe5e34',1,'nc::shape()']]], - ['shape_2140',['Shape',['../classnc_1_1_shape.html#a4b2cd200804257d9c53084f14fb38e31',1,'nc::Shape::Shape(uint32 inRows, uint32 inCols) noexcept'],['../classnc_1_1_shape.html#a6e870e9fda60c8e82996802fcb71490a',1,'nc::Shape::Shape(uint32 inSquareSize) noexcept'],['../classnc_1_1_shape.html#a0f41587a1b8f1c2b65035adc49705eec',1,'nc::Shape::Shape()=default']]], - ['shape_2141',['shape',['../classnc_1_1_data_cube.html#a1e7e4ce08e0c57abb661a8f95192173e',1,'nc::DataCube']]], - ['shuffle_2142',['shuffle',['../namespacenc_1_1random.html#ad73d56152095ad55887c89f47490c070',1,'nc::random']]], - ['sign_2143',['sign',['../classnc_1_1coordinates_1_1_dec.html#ac551f7b1f2728f20fbdbd79dd00919f7',1,'nc::coordinates::Dec::sign()'],['../namespacenc.html#a4a5d98f334e0b50a3cf9c2718485e5e9',1,'nc::sign(dtype inValue) noexcept'],['../namespacenc.html#a22372b41fc480a7284967d2be4b87841',1,'nc::sign(const NdArray< dtype > &inArray)']]], - ['signbit_2144',['signbit',['../namespacenc.html#a09632f5c6c5d569ccfde17351811b3c0',1,'nc::signbit(const NdArray< dtype > &inArray)'],['../namespacenc.html#af6dcbdfea85cdc84b4ddcf6c978b71f1',1,'nc::signbit(dtype inValue) noexcept']]], - ['simpson_2145',['simpson',['../namespacenc_1_1integrate.html#aa7c55b05139ecfce5e5a9d0380df9eb1',1,'nc::integrate']]], - ['sin_2146',['sin',['../namespacenc.html#a3fa4e582cdeef0716309ad51378f2983',1,'nc::sin(dtype inValue) noexcept'],['../namespacenc.html#aff909cb0ae96644487adaedbbb498cea',1,'nc::sin(const NdArray< dtype > &inArray)']]], - ['sinc_2147',['sinc',['../namespacenc.html#aafe29b8d2e32e8e2af4d92074851b777',1,'nc::sinc(dtype inValue) noexcept'],['../namespacenc.html#a0c8e5bf6fca377445afd941d70bcac10',1,'nc::sinc(const NdArray< dtype > &inArray)']]], - ['sinh_2148',['sinh',['../namespacenc.html#a7672779bec72183de09ddc469739b385',1,'nc::sinh(dtype inValue) noexcept'],['../namespacenc.html#a8de43bfef3cdd2e1af1c521dcf3a2dcd',1,'nc::sinh(const NdArray< dtype > &inArray)']]], - ['size_2149',['size',['../classnc_1_1_nd_array.html#a055875abbe80163ca91328c0fa8ffbfa',1,'nc::NdArray::size()'],['../classnc_1_1image_processing_1_1_cluster.html#ae89900f4557d6273fc49b330417e324e',1,'nc::imageProcessing::Cluster::size()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae437071bfc291a36745d043ddd4cba1d',1,'nc::imageProcessing::ClusterMaker::size()'],['../classnc_1_1_shape.html#ab29f87cc8479a2d0610a918cd9b08bbc',1,'nc::Shape::size()'],['../namespacenc.html#a25f36ba02112a206936fae22b0724bb9',1,'nc::size()']]], - ['sizez_2150',['sizeZ',['../classnc_1_1_data_cube.html#a6518d36db671db4053abffff92505c64',1,'nc::DataCube']]], - ['sleep_2151',['sleep',['../classnc_1_1_timer.html#a9fec514ed605a11c6e1c321041960d7e',1,'nc::Timer']]], - ['slerp_2152',['slerp',['../classnc_1_1rotations_1_1_quaternion.html#a7a39f199e4d1ad773b93c69e66ae0415',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#a687155cd6469c095941b94a738119da9',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat2, double inPercent) const']]], - ['slice_2153',['Slice',['../classnc_1_1_slice.html#aeb2a7e0854fa82d97a48a5ef402d6e7c',1,'nc::Slice::Slice()=default'],['../classnc_1_1_slice.html#aa54f0fae63ece8ff87455e2192d8f336',1,'nc::Slice::Slice(int32 inStop) noexcept'],['../classnc_1_1_slice.html#aba1f6c8193f0a61a3f5711edd58aeba1',1,'nc::Slice::Slice(int32 inStart, int32 inStop) noexcept'],['../classnc_1_1_slice.html#a91177c7ea9b87318232b8d916a487d38',1,'nc::Slice::Slice(int32 inStart, int32 inStop, int32 inStep) noexcept']]], - ['slicez_2154',['sliceZ',['../classnc_1_1_data_cube.html#a3bc1ba8251f5e788155d6a01727d1644',1,'nc::DataCube::sliceZ(Slice inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a8164f497dd44a89d1c5a1aeb7ca92e55',1,'nc::DataCube::sliceZ(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#aacc3751540c1b3d79e177a6b93a383fb',1,'nc::DataCube::sliceZ(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6e6629a0891235ea43e77389f93326cd',1,'nc::DataCube::sliceZ(int32 inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a71d00d236bd135a4a35212fb147ae905',1,'nc::DataCube::sliceZ(int32 inIndex, Slice inSliceZ) const']]], - ['slicezall_2155',['sliceZAll',['../classnc_1_1_data_cube.html#a7297568496398f9d80ceef1b9b955bfa',1,'nc::DataCube::sliceZAll(int32 inIndex) const'],['../classnc_1_1_data_cube.html#a0f149a9a6dfc3644a95c7741bbe60ca6',1,'nc::DataCube::sliceZAll(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#af8c15897cf2ff42ddd86648583aee686',1,'nc::DataCube::sliceZAll(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#a1961f8bf37432ab59bba9a59206537bd',1,'nc::DataCube::sliceZAll(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a64c85bf44f454e917c635167e46301e9',1,'nc::DataCube::sliceZAll(Slice inRow, Slice inCol) const']]], - ['slicezallat_2156',['sliceZAllat',['../classnc_1_1_data_cube.html#a7dd2ceb0e7935647c31993c5db1d1d20',1,'nc::DataCube::sliceZAllat(int32 inIndex) const'],['../classnc_1_1_data_cube.html#aaf2cad6dc76e1342d72c8d0291062357',1,'nc::DataCube::sliceZAllat(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#ad404a350af85b9e99be4901c028ed487',1,'nc::DataCube::sliceZAllat(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#ae6f6216581c3824f862bad03fea73f45',1,'nc::DataCube::sliceZAllat(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a57aaf216577c8a696dbf1dbe6363297e',1,'nc::DataCube::sliceZAllat(Slice inRow, Slice inCol) const']]], - ['slicezat_2157',['sliceZat',['../classnc_1_1_data_cube.html#a6f6bfc2ed7ec485877f0266f906342be',1,'nc::DataCube::sliceZat(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a435a6f90ee141a790af7c04557396baf',1,'nc::DataCube::sliceZat(int32 inIndex, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a70d350f869a1831a401522667b65639a',1,'nc::DataCube::sliceZat(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a2c4ac09094f98ca9de7e6f02aa8956a3',1,'nc::DataCube::sliceZat(Slice inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6075ed979ff9294f2ff0bd54bb928952',1,'nc::DataCube::sliceZat(int32 inRow, int32 inCol, Slice inSliceZ) const']]], - ['softmax_2158',['softmax',['../namespacenc_1_1special.html#a459176cc2a1b285e93c3ee5671294590',1,'nc::special']]], - ['solve_2159',['solve',['../namespacenc_1_1linalg.html#afe2a5221f8e22e671e9e6eb231516205',1,'nc::linalg::solve()'],['../classnc_1_1linalg_1_1_s_v_d.html#aa170c7ec6894fb30e115840d61bd58a1',1,'nc::linalg::SVD::solve()'],['../classnc_1_1roots_1_1_bisection.html#a1199a68b6f57fee8b24bfc59ffeff486',1,'nc::roots::Bisection::solve()'],['../classnc_1_1roots_1_1_brent.html#a3853981ca1113723006b6627d96d378b',1,'nc::roots::Brent::solve()'],['../classnc_1_1roots_1_1_dekker.html#a5da7506a8f371764d0fae321fe081111',1,'nc::roots::Dekker::solve()'],['../classnc_1_1roots_1_1_newton.html#aaed2535d1abdb0c6790aea60762ed789',1,'nc::roots::Newton::solve()'],['../classnc_1_1roots_1_1_secant.html#a3fefb4412402aa20eeabb85145463d70',1,'nc::roots::Secant::solve()']]], - ['sort_2160',['sort',['../namespacenc_1_1stl__algorithms.html#a1d75d47f198fcc3693e87806d6ea8715',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a519432fa55645fab8162c354e387b1a6',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../classnc_1_1_nd_array.html#a3c0a24c292c340c58a6da5526654f3bb',1,'nc::NdArray::sort()'],['../namespacenc.html#a8273e1ecb5eafba97b7ed5b8f10a6cdf',1,'nc::sort()']]], - ['spherical_5fbessel_5fjn_2161',['spherical_bessel_jn',['../namespacenc_1_1special.html#a979e99d8a1626829183e38f69486e263',1,'nc::special::spherical_bessel_jn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#aa7f12646500dfd811792934164f8f403',1,'nc::special::spherical_bessel_jn(uint32 inV, const NdArray< dtype > &inArrayX)']]], - ['spherical_5fbessel_5fyn_2162',['spherical_bessel_yn',['../namespacenc_1_1special.html#a1628a418aa8896a4f9711083ac5579d5',1,'nc::special::spherical_bessel_yn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#a11378004d6f60a0ecf65470d071985b0',1,'nc::special::spherical_bessel_yn(uint32 inV, const NdArray< dtype > &inArrayX)']]], - ['spherical_5fhankel_5f1_2163',['spherical_hankel_1',['../namespacenc_1_1special.html#a5c0f4be297580a6d46f89b851c948227',1,'nc::special::spherical_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a239954539e877214833b9cfe65f742db',1,'nc::special::spherical_hankel_1(dtype1 inV, const NdArray< dtype2 > &inArray)']]], - ['spherical_5fhankel_5f2_2164',['spherical_hankel_2',['../namespacenc_1_1special.html#aa0181306ece55cbaf50c65da8d215542',1,'nc::special::spherical_hankel_2(dtype1 inV, const NdArray< dtype2 > &inArray)'],['../namespacenc_1_1special.html#a767d00adf7283b45bd3b7ea4aab6c5ff',1,'nc::special::spherical_hankel_2(dtype1 inV, dtype2 inX)']]], - ['spherical_5fharmonic_2165',['spherical_harmonic',['../namespacenc_1_1polynomial.html#aa5bb22676f3f43eda1e7c0af04da376a',1,'nc::polynomial']]], - ['spherical_5fharmonic_5fi_2166',['spherical_harmonic_i',['../namespacenc_1_1polynomial.html#a583c30981b9547a90ad7c33edbe041c1',1,'nc::polynomial']]], - ['spherical_5fharmonic_5fr_2167',['spherical_harmonic_r',['../namespacenc_1_1polynomial.html#a5ed971ca59899f372f28a53913796745',1,'nc::polynomial']]], - ['sqr_2168',['sqr',['../namespacenc_1_1utils.html#ae792e10a24b7e5b8291a6c31a28a4512',1,'nc::utils']]], - ['sqrt_2169',['sqrt',['../namespacenc.html#a941a5a1ffb61387495a6f23dc4036287',1,'nc::sqrt(dtype inValue) noexcept'],['../namespacenc.html#abb4086978f52185f25340b0ff57ca8f0',1,'nc::sqrt(const NdArray< dtype > &inArray)']]], - ['square_2170',['square',['../namespacenc.html#a282e72a93afe2e6554e0f17f21dd7b9e',1,'nc::square(dtype inValue) noexcept'],['../namespacenc.html#a104a8ffcdf7d3911fb6d4bbb847e2a1d',1,'nc::square(const NdArray< dtype > &inArray)']]], - ['stable_5fsort_2171',['stable_sort',['../namespacenc_1_1stl__algorithms.html#a3b9f4bb9ba9a3ea8d8f97258eaa732d9',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a7b2c4b6a3ef5cc55ebdae2aa757d1874',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last, Compare comp) noexcept']]], - ['stack_2172',['stack',['../namespacenc.html#a656bb4b9fecf40f1f4194964be57c78b',1,'nc']]], - ['standardnormal_2173',['standardNormal',['../namespacenc_1_1random.html#acc9d03c66c1fa8b35dea3fa0a0f075e7',1,'nc::random::standardNormal()'],['../namespacenc_1_1random.html#a026e31e4ef305beb2bbb546817e44eb0',1,'nc::random::standardNormal(const Shape &inShape)']]], - ['stdev_2174',['stdev',['../namespacenc.html#ae197a8efaeeebe00c6e886b779ec1a43',1,'nc::stdev(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a60ac1ab2f35e50531ef0f12be00d89c8',1,'nc::stdev(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], - ['str_2175',['str',['../classnc_1_1coordinates_1_1_coordinate.html#a04a60dd7bc2ef5be41c8006e2797997f',1,'nc::coordinates::Coordinate::str()'],['../classnc_1_1coordinates_1_1_dec.html#a91ddbec1fadfdcc049930dc439da4608',1,'nc::coordinates::Dec::str()'],['../classnc_1_1coordinates_1_1_r_a.html#a37824a93eb9e0a02237d4e654040761b',1,'nc::coordinates::RA::str()'],['../classnc_1_1_shape.html#aadb0e0d633d64e5eb5a4f9bef12b26c4',1,'nc::Shape::str()'],['../classnc_1_1_slice.html#af8bc3bb19b48fd09c769fd1fa9860ed5',1,'nc::Slice::str()'],['../classnc_1_1image_processing_1_1_centroid.html#aa39ae81638b8f7ed7b81d4476e2a6316',1,'nc::imageProcessing::Centroid::str()'],['../classnc_1_1image_processing_1_1_cluster.html#aaa1ee55d0c47196847b8bb1a76258bd3',1,'nc::imageProcessing::Cluster::str()'],['../classnc_1_1image_processing_1_1_pixel.html#ae47f279d2f0ba0921027e787e3773ee8',1,'nc::imageProcessing::Pixel::str()'],['../classnc_1_1_nd_array.html#aa44f94cc8d02a56636223686f30d84f1',1,'nc::NdArray::str()'],['../classnc_1_1polynomial_1_1_poly1d.html#aa5c091077a037bab14a1c558ece21435',1,'nc::polynomial::Poly1d::str()'],['../classnc_1_1rotations_1_1_quaternion.html#a0ddeeba7435df3364f262215f24c93c1',1,'nc::rotations::Quaternion::str()']]], - ['studentt_2176',['studentT',['../namespacenc_1_1random.html#a9e8074cb89e2362b5ae485834f550217',1,'nc::random::studentT(dtype inDof)'],['../namespacenc_1_1random.html#a5c18c6c123083003f32344baeb0f4ad3',1,'nc::random::studentT(const Shape &inShape, dtype inDof)']]], - ['subtract_2177',['subtract',['../namespacenc.html#a8aae2ea3fcf6335997c10676fafcd1e5',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a29da51134625301935f0e1098111e74b',1,'nc::subtract(dtype value, const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a0499ac58fc4cfe52a2bba30f70376d84',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#acddd661c047325c1c0c473aa545011d9',1,'nc::subtract(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7f2189bdc8a3718be82a8497cd2ea99d',1,'nc::subtract(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a8668e0f6416572f18cf0d8c2e008784a',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a7851e0af8b7501f667e2d89738259191',1,'nc::subtract(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#afa4586729c62bfae485a6e7664ba7117',1,'nc::subtract(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#ae4be1086253a0b121695d9cabfcb86ce',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['sum_2178',['sum',['../classnc_1_1_nd_array.html#a467700098b002b5631c756ca0fd50cae',1,'nc::NdArray::sum()'],['../namespacenc.html#aa14c0f092bfdc980c656bf6bf58bfc67',1,'nc::sum()']]], - ['svd_2179',['svd',['../namespacenc_1_1linalg.html#acb38ad2613d50422afc539d005159055',1,'nc::linalg']]], - ['svd_2180',['SVD',['../classnc_1_1linalg_1_1_s_v_d.html#ae0561bbc9633e436139258b0c70b98ba',1,'nc::linalg::SVD']]], - ['swap_2181',['swap',['../namespacenc.html#a39da0502565b913855379ea1439047e1',1,'nc']]], - ['swapaxes_2182',['swapaxes',['../namespacenc.html#a9371c43ae0a95c53cdaaf97a5bbc1db7',1,'nc::swapaxes()'],['../classnc_1_1_nd_array.html#a7995ba04b64061dfd931ac58c05826f2',1,'nc::NdArray::swapaxes()']]] + ['s_2231',['s',['../classnc_1_1linalg_1_1_s_v_d.html#a323915fbe7cbaabadef01ffa948d2f1a',1,'nc::linalg::SVD::s()'],['../classnc_1_1rotations_1_1_quaternion.html#a075b6f1befef247f5d638c91e1a451fd',1,'nc::rotations::Quaternion::s()']]], + ['secant_2232',['Secant',['../classnc_1_1roots_1_1_secant.html#af8afc48a7393e85103a9c2acc662c63b',1,'nc::roots::Secant::Secant(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_secant.html#adedf56589f2027e224d6044a071f20e3',1,'nc::roots::Secant::Secant(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept']]], + ['seconds_2233',['seconds',['../classnc_1_1coordinates_1_1_dec.html#a2927e30c2059f09bd30be622cf9b52ea',1,'nc::coordinates::Dec::seconds()'],['../classnc_1_1coordinates_1_1_r_a.html#af0c9b649f60a70bbf421a6eb5b169cda',1,'nc::coordinates::RA::seconds()']]], + ['seed_2234',['seed',['../namespacenc_1_1random.html#a93fe76208181d041adb08a02de0966d8',1,'nc::random']]], + ['select_2235',['select',['../namespacenc.html#aab95eb9e265a3daf251b7e1926a42dac',1,'nc::select(const std::vector< const NdArray< bool > * > &condVec, const std::vector< const NdArray< dtype > * > &choiceVec, dtype defaultValue=dtype{0})'],['../namespacenc.html#acbb2b67807944a713b19844d2fe3dcc6',1,'nc::select(const std::vector< NdArray< bool >> &condList, const std::vector< NdArray< dtype >> &choiceList, dtype defaultValue=dtype{0})']]], + ['set_5fdifference_2236',['set_difference',['../namespacenc_1_1stl__algorithms.html#a8cc83e2fb7a3d8302db0f4b19513ddd9',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination)'],['../namespacenc_1_1stl__algorithms.html#a8a145ff0f4cf32b64e7464347d1ea9b2',1,'nc::stl_algorithms::set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept']]], + ['set_5fintersection_2237',['set_intersection',['../namespacenc_1_1stl__algorithms.html#aa8ff8c5bb6003ff0f02a17deb4ced8e2',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept'],['../namespacenc_1_1stl__algorithms.html#ad9a963ad13c86117f01fe2960525e074',1,'nc::stl_algorithms::set_intersection(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept']]], + ['set_5funion_2238',['set_union',['../namespacenc_1_1stl__algorithms.html#a33da2f830ebf2e7c04f1ac94e1ad20b7',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a273ff7212f84bcd8de30e83ab0ae3bd1',1,'nc::stl_algorithms::set_union(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt destination) noexcept']]], + ['setdiff1d_2239',['setdiff1d',['../namespacenc.html#adb6b7ca658c4d613fe0c4a695ba3542b',1,'nc']]], + ['setname_2240',['setName',['../classnc_1_1_timer.html#a88dd680a63b38ae9989a40878a8fd65b',1,'nc::Timer']]], + ['shape_2241',['Shape',['../classnc_1_1_shape.html#a0f41587a1b8f1c2b65035adc49705eec',1,'nc::Shape::Shape()=default'],['../classnc_1_1_shape.html#a6e870e9fda60c8e82996802fcb71490a',1,'nc::Shape::Shape(uint32 inSquareSize) noexcept'],['../classnc_1_1_shape.html#a4b2cd200804257d9c53084f14fb38e31',1,'nc::Shape::Shape(uint32 inRows, uint32 inCols) noexcept']]], + ['shape_2242',['shape',['../classnc_1_1_data_cube.html#a1e7e4ce08e0c57abb661a8f95192173e',1,'nc::DataCube::shape()'],['../classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4',1,'nc::NdArray::shape()'],['../namespacenc.html#ae2b224742bc8263190d451a44ebe5e34',1,'nc::shape()']]], + ['shuffle_2243',['shuffle',['../namespacenc_1_1random.html#ad73d56152095ad55887c89f47490c070',1,'nc::random']]], + ['sign_2244',['sign',['../classnc_1_1coordinates_1_1_dec.html#ac551f7b1f2728f20fbdbd79dd00919f7',1,'nc::coordinates::Dec::sign()'],['../namespacenc.html#a22372b41fc480a7284967d2be4b87841',1,'nc::sign(const NdArray< dtype > &inArray)'],['../namespacenc.html#a4a5d98f334e0b50a3cf9c2718485e5e9',1,'nc::sign(dtype inValue) noexcept']]], + ['signbit_2245',['signbit',['../namespacenc.html#a09632f5c6c5d569ccfde17351811b3c0',1,'nc::signbit(const NdArray< dtype > &inArray)'],['../namespacenc.html#af6dcbdfea85cdc84b4ddcf6c978b71f1',1,'nc::signbit(dtype inValue) noexcept']]], + ['simpson_2246',['simpson',['../namespacenc_1_1integrate.html#aa7c55b05139ecfce5e5a9d0380df9eb1',1,'nc::integrate']]], + ['sin_2247',['sin',['../namespacenc.html#aff909cb0ae96644487adaedbbb498cea',1,'nc::sin(const NdArray< dtype > &inArray)'],['../namespacenc.html#a3fa4e582cdeef0716309ad51378f2983',1,'nc::sin(dtype inValue) noexcept']]], + ['sinc_2248',['sinc',['../namespacenc.html#a0c8e5bf6fca377445afd941d70bcac10',1,'nc::sinc(const NdArray< dtype > &inArray)'],['../namespacenc.html#aafe29b8d2e32e8e2af4d92074851b777',1,'nc::sinc(dtype inValue) noexcept']]], + ['sinh_2249',['sinh',['../namespacenc.html#a8de43bfef3cdd2e1af1c521dcf3a2dcd',1,'nc::sinh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a7672779bec72183de09ddc469739b385',1,'nc::sinh(dtype inValue) noexcept']]], + ['size_2250',['size',['../classnc_1_1_shape.html#ab29f87cc8479a2d0610a918cd9b08bbc',1,'nc::Shape::size()'],['../classnc_1_1image_processing_1_1_cluster.html#ae89900f4557d6273fc49b330417e324e',1,'nc::imageProcessing::Cluster::size()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae437071bfc291a36745d043ddd4cba1d',1,'nc::imageProcessing::ClusterMaker::size()'],['../namespacenc.html#a25f36ba02112a206936fae22b0724bb9',1,'nc::size()'],['../classnc_1_1_nd_array.html#a055875abbe80163ca91328c0fa8ffbfa',1,'nc::NdArray::size()']]], + ['sizez_2251',['sizeZ',['../classnc_1_1_data_cube.html#a6518d36db671db4053abffff92505c64',1,'nc::DataCube']]], + ['sleep_2252',['sleep',['../classnc_1_1_timer.html#a9fec514ed605a11c6e1c321041960d7e',1,'nc::Timer']]], + ['slerp_2253',['slerp',['../classnc_1_1rotations_1_1_quaternion.html#a7a39f199e4d1ad773b93c69e66ae0415',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#a687155cd6469c095941b94a738119da9',1,'nc::rotations::Quaternion::slerp(const Quaternion &inQuat2, double inPercent) const']]], + ['slice_2254',['Slice',['../classnc_1_1_slice.html#aeb2a7e0854fa82d97a48a5ef402d6e7c',1,'nc::Slice::Slice()=default'],['../classnc_1_1_slice.html#aa54f0fae63ece8ff87455e2192d8f336',1,'nc::Slice::Slice(int32 inStop) noexcept'],['../classnc_1_1_slice.html#aba1f6c8193f0a61a3f5711edd58aeba1',1,'nc::Slice::Slice(int32 inStart, int32 inStop) noexcept'],['../classnc_1_1_slice.html#a91177c7ea9b87318232b8d916a487d38',1,'nc::Slice::Slice(int32 inStart, int32 inStop, int32 inStep) noexcept']]], + ['slicez_2255',['sliceZ',['../classnc_1_1_data_cube.html#a71d00d236bd135a4a35212fb147ae905',1,'nc::DataCube::sliceZ(int32 inIndex, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6e6629a0891235ea43e77389f93326cd',1,'nc::DataCube::sliceZ(int32 inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#aacc3751540c1b3d79e177a6b93a383fb',1,'nc::DataCube::sliceZ(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a8164f497dd44a89d1c5a1aeb7ca92e55',1,'nc::DataCube::sliceZ(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a3bc1ba8251f5e788155d6a01727d1644',1,'nc::DataCube::sliceZ(Slice inRow, Slice inCol, Slice inSliceZ) const']]], + ['slicezall_2256',['sliceZAll',['../classnc_1_1_data_cube.html#a7297568496398f9d80ceef1b9b955bfa',1,'nc::DataCube::sliceZAll(int32 inIndex) const'],['../classnc_1_1_data_cube.html#a0f149a9a6dfc3644a95c7741bbe60ca6',1,'nc::DataCube::sliceZAll(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#af8c15897cf2ff42ddd86648583aee686',1,'nc::DataCube::sliceZAll(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#a1961f8bf37432ab59bba9a59206537bd',1,'nc::DataCube::sliceZAll(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a64c85bf44f454e917c635167e46301e9',1,'nc::DataCube::sliceZAll(Slice inRow, Slice inCol) const']]], + ['slicezallat_2257',['sliceZAllat',['../classnc_1_1_data_cube.html#a7dd2ceb0e7935647c31993c5db1d1d20',1,'nc::DataCube::sliceZAllat(int32 inIndex) const'],['../classnc_1_1_data_cube.html#aaf2cad6dc76e1342d72c8d0291062357',1,'nc::DataCube::sliceZAllat(int32 inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#ad404a350af85b9e99be4901c028ed487',1,'nc::DataCube::sliceZAllat(Slice inRow, int32 inCol) const'],['../classnc_1_1_data_cube.html#ae6f6216581c3824f862bad03fea73f45',1,'nc::DataCube::sliceZAllat(int32 inRow, Slice inCol) const'],['../classnc_1_1_data_cube.html#a57aaf216577c8a696dbf1dbe6363297e',1,'nc::DataCube::sliceZAllat(Slice inRow, Slice inCol) const']]], + ['slicezat_2258',['sliceZat',['../classnc_1_1_data_cube.html#a435a6f90ee141a790af7c04557396baf',1,'nc::DataCube::sliceZat(int32 inIndex, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6075ed979ff9294f2ff0bd54bb928952',1,'nc::DataCube::sliceZat(int32 inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a6f6bfc2ed7ec485877f0266f906342be',1,'nc::DataCube::sliceZat(Slice inRow, int32 inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a70d350f869a1831a401522667b65639a',1,'nc::DataCube::sliceZat(int32 inRow, Slice inCol, Slice inSliceZ) const'],['../classnc_1_1_data_cube.html#a2c4ac09094f98ca9de7e6f02aa8956a3',1,'nc::DataCube::sliceZat(Slice inRow, Slice inCol, Slice inSliceZ) const']]], + ['softmax_2259',['softmax',['../namespacenc_1_1special.html#a459176cc2a1b285e93c3ee5671294590',1,'nc::special']]], + ['solve_2260',['solve',['../classnc_1_1roots_1_1_newton.html#aaed2535d1abdb0c6790aea60762ed789',1,'nc::roots::Newton::solve()'],['../classnc_1_1roots_1_1_dekker.html#a5da7506a8f371764d0fae321fe081111',1,'nc::roots::Dekker::solve()'],['../classnc_1_1roots_1_1_brent.html#a3853981ca1113723006b6627d96d378b',1,'nc::roots::Brent::solve()'],['../classnc_1_1roots_1_1_bisection.html#a1199a68b6f57fee8b24bfc59ffeff486',1,'nc::roots::Bisection::solve()'],['../classnc_1_1roots_1_1_secant.html#a3fefb4412402aa20eeabb85145463d70',1,'nc::roots::Secant::solve()'],['../classnc_1_1linalg_1_1_s_v_d.html#aa170c7ec6894fb30e115840d61bd58a1',1,'nc::linalg::SVD::solve()'],['../namespacenc_1_1linalg.html#afe2a5221f8e22e671e9e6eb231516205',1,'nc::linalg::solve()']]], + ['sort_2261',['sort',['../namespacenc.html#a8273e1ecb5eafba97b7ed5b8f10a6cdf',1,'nc::sort()'],['../namespacenc_1_1stl__algorithms.html#a519432fa55645fab8162c354e387b1a6',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a1d75d47f198fcc3693e87806d6ea8715',1,'nc::stl_algorithms::sort(RandomIt first, RandomIt last) noexcept'],['../classnc_1_1_nd_array.html#a3c0a24c292c340c58a6da5526654f3bb',1,'nc::NdArray::sort()']]], + ['spherical_5fbessel_5fjn_2262',['spherical_bessel_jn',['../namespacenc_1_1special.html#a979e99d8a1626829183e38f69486e263',1,'nc::special::spherical_bessel_jn(uint32 inV, dtype inX)'],['../namespacenc_1_1special.html#aa7f12646500dfd811792934164f8f403',1,'nc::special::spherical_bessel_jn(uint32 inV, const NdArray< dtype > &inArrayX)']]], + ['spherical_5fbessel_5fyn_2263',['spherical_bessel_yn',['../namespacenc_1_1special.html#a11378004d6f60a0ecf65470d071985b0',1,'nc::special::spherical_bessel_yn(uint32 inV, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1special.html#a1628a418aa8896a4f9711083ac5579d5',1,'nc::special::spherical_bessel_yn(uint32 inV, dtype inX)']]], + ['spherical_5fhankel_5f1_2264',['spherical_hankel_1',['../namespacenc_1_1special.html#a5c0f4be297580a6d46f89b851c948227',1,'nc::special::spherical_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a239954539e877214833b9cfe65f742db',1,'nc::special::spherical_hankel_1(dtype1 inV, const NdArray< dtype2 > &inArray)']]], + ['spherical_5fhankel_5f2_2265',['spherical_hankel_2',['../namespacenc_1_1special.html#a767d00adf7283b45bd3b7ea4aab6c5ff',1,'nc::special::spherical_hankel_2(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#aa0181306ece55cbaf50c65da8d215542',1,'nc::special::spherical_hankel_2(dtype1 inV, const NdArray< dtype2 > &inArray)']]], + ['spherical_5fharmonic_2266',['spherical_harmonic',['../namespacenc_1_1polynomial.html#aa5bb22676f3f43eda1e7c0af04da376a',1,'nc::polynomial']]], + ['spherical_5fharmonic_5fi_2267',['spherical_harmonic_i',['../namespacenc_1_1polynomial.html#a583c30981b9547a90ad7c33edbe041c1',1,'nc::polynomial']]], + ['spherical_5fharmonic_5fr_2268',['spherical_harmonic_r',['../namespacenc_1_1polynomial.html#a5ed971ca59899f372f28a53913796745',1,'nc::polynomial']]], + ['sqr_2269',['sqr',['../namespacenc_1_1utils.html#ae792e10a24b7e5b8291a6c31a28a4512',1,'nc::utils']]], + ['sqrt_2270',['sqrt',['../namespacenc.html#a941a5a1ffb61387495a6f23dc4036287',1,'nc::sqrt(dtype inValue) noexcept'],['../namespacenc.html#abb4086978f52185f25340b0ff57ca8f0',1,'nc::sqrt(const NdArray< dtype > &inArray)']]], + ['square_2271',['square',['../namespacenc.html#a282e72a93afe2e6554e0f17f21dd7b9e',1,'nc::square(dtype inValue) noexcept'],['../namespacenc.html#a104a8ffcdf7d3911fb6d4bbb847e2a1d',1,'nc::square(const NdArray< dtype > &inArray)']]], + ['stable_5fsort_2272',['stable_sort',['../namespacenc_1_1stl__algorithms.html#a7b2c4b6a3ef5cc55ebdae2aa757d1874',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#a3b9f4bb9ba9a3ea8d8f97258eaa732d9',1,'nc::stl_algorithms::stable_sort(RandomIt first, RandomIt last) noexcept']]], + ['stack_2273',['stack',['../namespacenc.html#a59f5a937dedc01a2aee57788d80d2912',1,'nc']]], + ['standardnormal_2274',['standardNormal',['../namespacenc_1_1random.html#acc9d03c66c1fa8b35dea3fa0a0f075e7',1,'nc::random::standardNormal()'],['../namespacenc_1_1random.html#a026e31e4ef305beb2bbb546817e44eb0',1,'nc::random::standardNormal(const Shape &inShape)']]], + ['stdev_2275',['stdev',['../namespacenc.html#ae197a8efaeeebe00c6e886b779ec1a43',1,'nc::stdev(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a60ac1ab2f35e50531ef0f12be00d89c8',1,'nc::stdev(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['str_2276',['str',['../classnc_1_1image_processing_1_1_centroid.html#aa39ae81638b8f7ed7b81d4476e2a6316',1,'nc::imageProcessing::Centroid::str()'],['../classnc_1_1image_processing_1_1_cluster.html#aaa1ee55d0c47196847b8bb1a76258bd3',1,'nc::imageProcessing::Cluster::str()'],['../classnc_1_1image_processing_1_1_pixel.html#ae47f279d2f0ba0921027e787e3773ee8',1,'nc::imageProcessing::Pixel::str()'],['../classnc_1_1_nd_array.html#aa44f94cc8d02a56636223686f30d84f1',1,'nc::NdArray::str()'],['../classnc_1_1_slice.html#af8bc3bb19b48fd09c769fd1fa9860ed5',1,'nc::Slice::str()'],['../classnc_1_1coordinates_1_1_coordinate.html#a04a60dd7bc2ef5be41c8006e2797997f',1,'nc::coordinates::Coordinate::str()'],['../classnc_1_1coordinates_1_1_r_a.html#a37824a93eb9e0a02237d4e654040761b',1,'nc::coordinates::RA::str()'],['../classnc_1_1rotations_1_1_quaternion.html#a0ddeeba7435df3364f262215f24c93c1',1,'nc::rotations::Quaternion::str()'],['../classnc_1_1polynomial_1_1_poly1d.html#aa5c091077a037bab14a1c558ece21435',1,'nc::polynomial::Poly1d::str()'],['../classnc_1_1coordinates_1_1_dec.html#a91ddbec1fadfdcc049930dc439da4608',1,'nc::coordinates::Dec::str()'],['../classnc_1_1_shape.html#aadb0e0d633d64e5eb5a4f9bef12b26c4',1,'nc::Shape::str()']]], + ['studentt_2277',['studentT',['../namespacenc_1_1random.html#a9e8074cb89e2362b5ae485834f550217',1,'nc::random::studentT(dtype inDof)'],['../namespacenc_1_1random.html#a5c18c6c123083003f32344baeb0f4ad3',1,'nc::random::studentT(const Shape &inShape, dtype inDof)']]], + ['subtract_2278',['subtract',['../namespacenc.html#ae4be1086253a0b121695d9cabfcb86ce',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#afa4586729c62bfae485a6e7664ba7117',1,'nc::subtract(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a7851e0af8b7501f667e2d89738259191',1,'nc::subtract(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a0499ac58fc4cfe52a2bba30f70376d84',1,'nc::subtract(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a8aae2ea3fcf6335997c10676fafcd1e5',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#acddd661c047325c1c0c473aa545011d9',1,'nc::subtract(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7f2189bdc8a3718be82a8497cd2ea99d',1,'nc::subtract(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a8668e0f6416572f18cf0d8c2e008784a',1,'nc::subtract(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a29da51134625301935f0e1098111e74b',1,'nc::subtract(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], + ['sum_2279',['sum',['../classnc_1_1_nd_array.html#a467700098b002b5631c756ca0fd50cae',1,'nc::NdArray::sum()'],['../namespacenc.html#aa14c0f092bfdc980c656bf6bf58bfc67',1,'nc::sum()']]], + ['svd_2280',['SVD',['../classnc_1_1linalg_1_1_s_v_d.html#ae0561bbc9633e436139258b0c70b98ba',1,'nc::linalg::SVD']]], + ['svd_2281',['svd',['../namespacenc_1_1linalg.html#acb38ad2613d50422afc539d005159055',1,'nc::linalg']]], + ['swap_2282',['swap',['../namespacenc.html#a39da0502565b913855379ea1439047e1',1,'nc']]], + ['swapaxes_2283',['swapaxes',['../classnc_1_1_nd_array.html#a7995ba04b64061dfd931ac58c05826f2',1,'nc::NdArray::swapaxes()'],['../namespacenc.html#a9371c43ae0a95c53cdaaf97a5bbc1db7',1,'nc::swapaxes()']]] ]; diff --git a/docs/doxygen/html/search/functions_13.html b/docs/doxygen/html/search/functions_13.html index 123660c15..3da2ea69c 100644 --- a/docs/doxygen/html/search/functions_13.html +++ b/docs/doxygen/html/search/functions_13.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_13.js b/docs/doxygen/html/search/functions_13.js index 2efa162c1..404f2bc4e 100644 --- a/docs/doxygen/html/search/functions_13.js +++ b/docs/doxygen/html/search/functions_13.js @@ -1,29 +1,29 @@ var searchData= [ - ['tan_2183',['tan',['../namespacenc.html#abf0186d9e6764cd8b2a5e1529046429b',1,'nc::tan(const NdArray< dtype > &inArray)'],['../namespacenc.html#a50d3734603bda1d991baf0696a4b96ce',1,'nc::tan(dtype inValue) noexcept']]], - ['tanh_2184',['tanh',['../namespacenc.html#aadd0ed02db4a60f805766e7026c78438',1,'nc::tanh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a3d75639028d96fe20286a82740361c6e',1,'nc::tanh(dtype inValue) noexcept']]], - ['throwerror_2185',['throwError',['../namespacenc_1_1error.html#ae23be92f797ad9d90604456bdf27092f',1,'nc::error']]], - ['tic_2186',['tic',['../classnc_1_1_timer.html#a4a08ec3e6ba7a7979cb9e72d0cf3f2f7',1,'nc::Timer']]], - ['tile_2187',['tile',['../namespacenc.html#ae4974bdf6c0bccbde88f70c5732fd361',1,'nc::tile(const NdArray< dtype > &inArray, const Shape &inReps)'],['../namespacenc.html#a01db30b2b68eb0dde0d8ffdc7b72dd53',1,'nc::tile(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)']]], - ['timer_2188',['Timer',['../classnc_1_1_timer.html#a5dabfba271b3655326e46c633eabd70e',1,'nc::Timer::Timer()'],['../classnc_1_1_timer.html#a4ede5d1d2cdf6b97bec93b0954ddb610',1,'nc::Timer::Timer(const std::string &inName)']]], - ['toc_2189',['toc',['../classnc_1_1_timer.html#a317fde3b5e7444328adf6484e0ec832e',1,'nc::Timer']]], - ['todcm_2190',['toDCM',['../classnc_1_1rotations_1_1_quaternion.html#aaa79cb63eab5e2bee5101de41d9074f8',1,'nc::rotations::Quaternion']]], - ['tofile_2191',['tofile',['../namespacenc.html#a7dc5b27b93f5a921a39151714fa78d67',1,'nc::tofile(const NdArray< dtype > &inArray, const std::string &inFilename, const char inSep)'],['../namespacenc.html#adf3cdf51801e83c58bc58c606781467d',1,'nc::tofile(const NdArray< dtype > &inArray, const std::string &inFilename)'],['../classnc_1_1_nd_array.html#a25390a2e453495e50219103d389a62d1',1,'nc::NdArray::tofile(const std::string &inFilename, const char inSep) const'],['../classnc_1_1_nd_array.html#a3533a4192c58304b6be7035098d8e263',1,'nc::NdArray::tofile(const std::string &inFilename) const']]], - ['toindices_2192',['toIndices',['../classnc_1_1_nd_array.html#a151940b3a151f2d15354bb4a9cbb0852',1,'nc::NdArray']]], - ['tondarray_2193',['toNdArray',['../classnc_1_1_vec3.html#a45dbcf0b972b41fc3bc78aac17288804',1,'nc::Vec3::toNdArray()'],['../classnc_1_1_vec2.html#ad5f0e922730d66c57630ae5c7847e15a',1,'nc::Vec2::toNdArray()'],['../classnc_1_1rotations_1_1_quaternion.html#a4a11c1c0daf982f9367e4541e5735e71',1,'nc::rotations::Quaternion::toNdArray()']]], - ['tostlvector_2194',['toStlVector',['../classnc_1_1_nd_array.html#a1fb3a21ab9c10a2684098df919b5b440',1,'nc::NdArray::toStlVector()'],['../namespacenc.html#adc9e0bf1da9c54cc65e95a72e795de6b',1,'nc::toStlVector()']]], - ['tostring_2195',['toString',['../classnc_1_1_vec3.html#a29fad7279d8da7f78805fee0c6d73408',1,'nc::Vec3::toString()'],['../classnc_1_1_vec2.html#acd4277d3a9acded9199afef378e1907c',1,'nc::Vec2::toString()']]], - ['trace_2196',['trace',['../classnc_1_1_nd_array.html#ad58c8cb32887059d77903ff4c224e9f3',1,'nc::NdArray::trace()'],['../namespacenc.html#a4a75035db8c766b2cececb1f3e4d5b74',1,'nc::trace()']]], - ['transform_2197',['transform',['../namespacenc_1_1stl__algorithms.html#a616d5dabd547326285946d0014361ab4',1,'nc::stl_algorithms::transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)'],['../namespacenc_1_1stl__algorithms.html#af358fec5563ae500162b310fe263a36d',1,'nc::stl_algorithms::transform(InputIt1 first1, InputIt1 last1, InputIt2 first2, OutputIt destination, BinaryOperation unaryFunction)']]], - ['transpose_2198',['transpose',['../classnc_1_1_nd_array.html#a78c99f8306415d8e0ac0e03bb69c6d29',1,'nc::NdArray::transpose()'],['../namespacenc.html#aa6c78ac10e4c3aa446716f80aa1a72ca',1,'nc::transpose()']]], - ['trapazoidal_2199',['trapazoidal',['../namespacenc_1_1integrate.html#acdfbecb87f7780b2961eb4e5d3b3d109',1,'nc::integrate']]], - ['trapz_2200',['trapz',['../namespacenc.html#ad9d00f10d75f795a2f4cbdfb99776637',1,'nc::trapz(const NdArray< dtype > &inArray, double dx=1.0, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a956571b2c934b75025e9168e2ed408f5',1,'nc::trapz(const NdArray< dtype > &inArrayY, const NdArray< dtype > &inArrayX, Axis inAxis=Axis::NONE)']]], - ['triangle_2201',['triangle',['../namespacenc_1_1random.html#a3dd603264757ce4334bfc0b989cd4503',1,'nc::random::triangle(dtype inA=0, dtype inB=0.5, dtype inC=1)'],['../namespacenc_1_1random.html#abaeed48339244cfb7f214c7238b13e8b',1,'nc::random::triangle(const Shape &inShape, dtype inA=0, dtype inB=0.5, dtype inC=1)']]], - ['trigamma_2202',['trigamma',['../namespacenc_1_1special.html#a8f98455b0421ab89f4722377d9606091',1,'nc::special::trigamma(dtype inValue)'],['../namespacenc_1_1special.html#a0df9137d28cb3421435b464cbc482d5b',1,'nc::special::trigamma(const NdArray< dtype > &inArray)']]], - ['tril_2203',['tril',['../namespacenc.html#aa5530b43e1ccdeeaded7a26fdcb43798',1,'nc::tril(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a7c46d843ef0c6ea562cb89f9732d89ab',1,'nc::tril(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#a0fc9894890a23f64d3a676f595920a9a',1,'nc::tril(const NdArray< dtype > &inArray, int32 inOffset=0)']]], - ['trim_5fzeros_2204',['trim_zeros',['../namespacenc.html#a56a856c99dddd37fe14d5639dd6c5622',1,'nc']]], - ['trimboundary1d_2205',['trimBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#abe0b187c76c106e821b9ff94ef280d39',1,'nc::filter::boundary']]], - ['trimboundary2d_2206',['trimBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#aeff17b6fddc47bd2220fb912b2429162',1,'nc::filter::boundary']]], - ['triu_2207',['triu',['../namespacenc.html#a05c4de5a2c55f32884dec4b1d5634a36',1,'nc::triu(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#ab8fb31254bc1cdd83667f4f2ac3604c8',1,'nc::triu(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a6719a9ad06f8286f1a18f91df4d9b049',1,'nc::triu(const NdArray< dtype > &inArray, int32 inOffset=0)']]], - ['trunc_2208',['trunc',['../namespacenc.html#ac83a50ef99e61f116a86df98196f4a8b',1,'nc::trunc(dtype inValue) noexcept'],['../namespacenc.html#adaf8b7ce0ee9ec1b91c27f5e6df30cfc',1,'nc::trunc(const NdArray< dtype > &inArray)']]] + ['tan_2284',['tan',['../namespacenc.html#a50d3734603bda1d991baf0696a4b96ce',1,'nc::tan(dtype inValue) noexcept'],['../namespacenc.html#abf0186d9e6764cd8b2a5e1529046429b',1,'nc::tan(const NdArray< dtype > &inArray)']]], + ['tanh_2285',['tanh',['../namespacenc.html#aadd0ed02db4a60f805766e7026c78438',1,'nc::tanh(const NdArray< dtype > &inArray)'],['../namespacenc.html#a3d75639028d96fe20286a82740361c6e',1,'nc::tanh(dtype inValue) noexcept']]], + ['throwerror_2286',['throwError',['../namespacenc_1_1error.html#ae23be92f797ad9d90604456bdf27092f',1,'nc::error']]], + ['tic_2287',['tic',['../classnc_1_1_timer.html#a4a08ec3e6ba7a7979cb9e72d0cf3f2f7',1,'nc::Timer']]], + ['tile_2288',['tile',['../namespacenc.html#a01db30b2b68eb0dde0d8ffdc7b72dd53',1,'nc::tile(const NdArray< dtype > &inArray, uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#ae4974bdf6c0bccbde88f70c5732fd361',1,'nc::tile(const NdArray< dtype > &inArray, const Shape &inReps)']]], + ['timer_2289',['Timer',['../classnc_1_1_timer.html#a5dabfba271b3655326e46c633eabd70e',1,'nc::Timer::Timer()'],['../classnc_1_1_timer.html#a4ede5d1d2cdf6b97bec93b0954ddb610',1,'nc::Timer::Timer(const std::string &inName)']]], + ['toc_2290',['toc',['../classnc_1_1_timer.html#a317fde3b5e7444328adf6484e0ec832e',1,'nc::Timer']]], + ['todcm_2291',['toDCM',['../classnc_1_1rotations_1_1_quaternion.html#aaa79cb63eab5e2bee5101de41d9074f8',1,'nc::rotations::Quaternion']]], + ['tofile_2292',['tofile',['../classnc_1_1_nd_array.html#a3533a4192c58304b6be7035098d8e263',1,'nc::NdArray::tofile(const std::string &inFilename) const'],['../classnc_1_1_nd_array.html#a25390a2e453495e50219103d389a62d1',1,'nc::NdArray::tofile(const std::string &inFilename, const char inSep) const'],['../namespacenc.html#a7dc5b27b93f5a921a39151714fa78d67',1,'nc::tofile(const NdArray< dtype > &inArray, const std::string &inFilename, const char inSep)'],['../namespacenc.html#adf3cdf51801e83c58bc58c606781467d',1,'nc::tofile(const NdArray< dtype > &inArray, const std::string &inFilename)']]], + ['toindices_2293',['toIndices',['../classnc_1_1_nd_array.html#a151940b3a151f2d15354bb4a9cbb0852',1,'nc::NdArray']]], + ['tondarray_2294',['toNdArray',['../classnc_1_1rotations_1_1_quaternion.html#a4a11c1c0daf982f9367e4541e5735e71',1,'nc::rotations::Quaternion::toNdArray()'],['../classnc_1_1_vec2.html#ad5f0e922730d66c57630ae5c7847e15a',1,'nc::Vec2::toNdArray()'],['../classnc_1_1_vec3.html#a45dbcf0b972b41fc3bc78aac17288804',1,'nc::Vec3::toNdArray()']]], + ['tostlvector_2295',['toStlVector',['../classnc_1_1_nd_array.html#a1fb3a21ab9c10a2684098df919b5b440',1,'nc::NdArray::toStlVector()'],['../namespacenc.html#adc9e0bf1da9c54cc65e95a72e795de6b',1,'nc::toStlVector()']]], + ['tostring_2296',['toString',['../classnc_1_1_vec2.html#acd4277d3a9acded9199afef378e1907c',1,'nc::Vec2::toString()'],['../classnc_1_1_vec3.html#a29fad7279d8da7f78805fee0c6d73408',1,'nc::Vec3::toString()']]], + ['trace_2297',['trace',['../classnc_1_1_nd_array.html#ad58c8cb32887059d77903ff4c224e9f3',1,'nc::NdArray::trace()'],['../namespacenc.html#a4a75035db8c766b2cececb1f3e4d5b74',1,'nc::trace()']]], + ['transform_2298',['transform',['../namespacenc_1_1stl__algorithms.html#a616d5dabd547326285946d0014361ab4',1,'nc::stl_algorithms::transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)'],['../namespacenc_1_1stl__algorithms.html#af358fec5563ae500162b310fe263a36d',1,'nc::stl_algorithms::transform(InputIt1 first1, InputIt1 last1, InputIt2 first2, OutputIt destination, BinaryOperation unaryFunction)']]], + ['transpose_2299',['transpose',['../classnc_1_1_nd_array.html#a78c99f8306415d8e0ac0e03bb69c6d29',1,'nc::NdArray::transpose()'],['../namespacenc.html#aa6c78ac10e4c3aa446716f80aa1a72ca',1,'nc::transpose()']]], + ['trapazoidal_2300',['trapazoidal',['../namespacenc_1_1integrate.html#acdfbecb87f7780b2961eb4e5d3b3d109',1,'nc::integrate']]], + ['trapz_2301',['trapz',['../namespacenc.html#ad9d00f10d75f795a2f4cbdfb99776637',1,'nc::trapz(const NdArray< dtype > &inArray, double dx=1.0, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a956571b2c934b75025e9168e2ed408f5',1,'nc::trapz(const NdArray< dtype > &inArrayY, const NdArray< dtype > &inArrayX, Axis inAxis=Axis::NONE)']]], + ['triangle_2302',['triangle',['../namespacenc_1_1random.html#a3dd603264757ce4334bfc0b989cd4503',1,'nc::random::triangle(dtype inA=0, dtype inB=0.5, dtype inC=1)'],['../namespacenc_1_1random.html#abaeed48339244cfb7f214c7238b13e8b',1,'nc::random::triangle(const Shape &inShape, dtype inA=0, dtype inB=0.5, dtype inC=1)']]], + ['trigamma_2303',['trigamma',['../namespacenc_1_1special.html#a8f98455b0421ab89f4722377d9606091',1,'nc::special::trigamma(dtype inValue)'],['../namespacenc_1_1special.html#a0df9137d28cb3421435b464cbc482d5b',1,'nc::special::trigamma(const NdArray< dtype > &inArray)']]], + ['tril_2304',['tril',['../namespacenc.html#aa5530b43e1ccdeeaded7a26fdcb43798',1,'nc::tril(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a7c46d843ef0c6ea562cb89f9732d89ab',1,'nc::tril(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#a0fc9894890a23f64d3a676f595920a9a',1,'nc::tril(const NdArray< dtype > &inArray, int32 inOffset=0)']]], + ['trim_5fzeros_2305',['trim_zeros',['../namespacenc.html#a56a856c99dddd37fe14d5639dd6c5622',1,'nc']]], + ['trimboundary1d_2306',['trimBoundary1d',['../namespacenc_1_1filter_1_1boundary.html#abe0b187c76c106e821b9ff94ef280d39',1,'nc::filter::boundary']]], + ['trimboundary2d_2307',['trimBoundary2d',['../namespacenc_1_1filter_1_1boundary.html#aeff17b6fddc47bd2220fb912b2429162',1,'nc::filter::boundary']]], + ['triu_2308',['triu',['../namespacenc.html#a05c4de5a2c55f32884dec4b1d5634a36',1,'nc::triu(uint32 inN, uint32 inM, int32 inOffset=0)'],['../namespacenc.html#ab8fb31254bc1cdd83667f4f2ac3604c8',1,'nc::triu(uint32 inN, int32 inOffset=0)'],['../namespacenc.html#a6719a9ad06f8286f1a18f91df4d9b049',1,'nc::triu(const NdArray< dtype > &inArray, int32 inOffset=0)']]], + ['trunc_2309',['trunc',['../namespacenc.html#ac83a50ef99e61f116a86df98196f4a8b',1,'nc::trunc(dtype inValue) noexcept'],['../namespacenc.html#adaf8b7ce0ee9ec1b91c27f5e6df30cfc',1,'nc::trunc(const NdArray< dtype > &inArray)']]] ]; diff --git a/docs/doxygen/html/search/functions_14.html b/docs/doxygen/html/search/functions_14.html index c569b5209..29237b44c 100644 --- a/docs/doxygen/html/search/functions_14.html +++ b/docs/doxygen/html/search/functions_14.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_14.js b/docs/doxygen/html/search/functions_14.js index 169fdaa86..1ea7f6273 100644 --- a/docs/doxygen/html/search/functions_14.js +++ b/docs/doxygen/html/search/functions_14.js @@ -1,13 +1,13 @@ var searchData= [ - ['u_2209',['u',['../classnc_1_1linalg_1_1_s_v_d.html#a0f7dddedc38be47b051aa16e5dc9d6b2',1,'nc::linalg::SVD']]], - ['uniform_2210',['uniform',['../namespacenc_1_1random.html#adbff3f6b80e512d4153b12bae9c6c732',1,'nc::random::uniform(dtype inLow, dtype inHigh)'],['../namespacenc_1_1random.html#a1e31096d678b7e4be66f6c59d95e5445',1,'nc::random::uniform(const Shape &inShape, dtype inLow, dtype inHigh)']]], - ['uniformfilter_2211',['uniformFilter',['../namespacenc_1_1filter.html#a9f41f17a6f7c06ebf7b1f3a1ab3915bb',1,'nc::filter']]], - ['uniformfilter1d_2212',['uniformFilter1d',['../namespacenc_1_1filter.html#ab7f620c737fa95c983523c0950120cd9',1,'nc::filter']]], - ['uniformonsphere_2213',['uniformOnSphere',['../namespacenc_1_1random.html#a2f18a1f7b9311d52bbdc4ae7a7b84be6',1,'nc::random']]], - ['union1d_2214',['union1d',['../namespacenc.html#a38b544f6e77741848387a3a427579704',1,'nc']]], - ['unique_2215',['unique',['../namespacenc.html#ad4832f2be01449e48737aa0e06792494',1,'nc']]], - ['unique_5fcopy_2216',['unique_copy',['../namespacenc_1_1stl__algorithms.html#a7cec030870d1f3b4d1c7caf26c8d907d',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination) noexcept'],['../namespacenc_1_1stl__algorithms.html#aefa150cdbb6a1110c2164a3970a317a8',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination, BinaryPredicate binaryFunction) noexcept']]], - ['unwrap_2217',['unwrap',['../namespacenc.html#aac5e942220c693fb9e65fcc3ff4fc50f',1,'nc::unwrap(dtype inValue) noexcept'],['../namespacenc.html#aff80ace967dcf63c32d235a7511c6018',1,'nc::unwrap(const NdArray< dtype > &inArray)']]], - ['up_2218',['up',['../classnc_1_1_vec2.html#a82fc65cffdae5c0ebd50fece54b56d4c',1,'nc::Vec2::up()'],['../classnc_1_1_vec3.html#aafc14ccae575994733d664eb3f4a6e66',1,'nc::Vec3::up()']]] + ['u_2310',['u',['../classnc_1_1linalg_1_1_s_v_d.html#a0f7dddedc38be47b051aa16e5dc9d6b2',1,'nc::linalg::SVD']]], + ['uniform_2311',['uniform',['../namespacenc_1_1random.html#adbff3f6b80e512d4153b12bae9c6c732',1,'nc::random::uniform(dtype inLow, dtype inHigh)'],['../namespacenc_1_1random.html#a1e31096d678b7e4be66f6c59d95e5445',1,'nc::random::uniform(const Shape &inShape, dtype inLow, dtype inHigh)']]], + ['uniformfilter_2312',['uniformFilter',['../namespacenc_1_1filter.html#a9f41f17a6f7c06ebf7b1f3a1ab3915bb',1,'nc::filter']]], + ['uniformfilter1d_2313',['uniformFilter1d',['../namespacenc_1_1filter.html#ab7f620c737fa95c983523c0950120cd9',1,'nc::filter']]], + ['uniformonsphere_2314',['uniformOnSphere',['../namespacenc_1_1random.html#a2f18a1f7b9311d52bbdc4ae7a7b84be6',1,'nc::random']]], + ['union1d_2315',['union1d',['../namespacenc.html#a38b544f6e77741848387a3a427579704',1,'nc']]], + ['unique_2316',['unique',['../namespacenc.html#ad4832f2be01449e48737aa0e06792494',1,'nc']]], + ['unique_5fcopy_2317',['unique_copy',['../namespacenc_1_1stl__algorithms.html#a7cec030870d1f3b4d1c7caf26c8d907d',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination) noexcept'],['../namespacenc_1_1stl__algorithms.html#aefa150cdbb6a1110c2164a3970a317a8',1,'nc::stl_algorithms::unique_copy(InputIt first, InputIt last, OutputIt destination, BinaryPredicate binaryFunction) noexcept']]], + ['unwrap_2318',['unwrap',['../namespacenc.html#aac5e942220c693fb9e65fcc3ff4fc50f',1,'nc::unwrap(dtype inValue) noexcept'],['../namespacenc.html#aff80ace967dcf63c32d235a7511c6018',1,'nc::unwrap(const NdArray< dtype > &inArray)']]], + ['up_2319',['up',['../classnc_1_1_vec2.html#a82fc65cffdae5c0ebd50fece54b56d4c',1,'nc::Vec2::up()'],['../classnc_1_1_vec3.html#aafc14ccae575994733d664eb3f4a6e66',1,'nc::Vec3::up()']]] ]; diff --git a/docs/doxygen/html/search/functions_15.html b/docs/doxygen/html/search/functions_15.html index 26656c07f..6d5decd70 100644 --- a/docs/doxygen/html/search/functions_15.html +++ b/docs/doxygen/html/search/functions_15.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_15.js b/docs/doxygen/html/search/functions_15.js index 188dfa79d..0ceeba500 100644 --- a/docs/doxygen/html/search/functions_15.js +++ b/docs/doxygen/html/search/functions_15.js @@ -1,9 +1,9 @@ var searchData= [ - ['v_2219',['v',['../classnc_1_1linalg_1_1_s_v_d.html#a6b907070cfa7e89c3107fa628694e274',1,'nc::linalg::SVD']]], - ['value2str_2220',['value2str',['../namespacenc_1_1utils.html#a83530b13c9cc3b01b9bd8b8d3113290a',1,'nc::utils']]], - ['var_2221',['var',['../namespacenc.html#aeefabf8c851def135518ddded2bf5886',1,'nc::var(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a130dfd14b561ed4f0889fd2093f99d5f',1,'nc::var(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], - ['vec2_2222',['Vec2',['../classnc_1_1_vec2.html#ae34b427d1b6560cce898bf61f9524a80',1,'nc::Vec2::Vec2()=default'],['../classnc_1_1_vec2.html#aeb48b0300990a5b77919589488ddfe30',1,'nc::Vec2::Vec2(double inX, double inY) noexcept'],['../classnc_1_1_vec2.html#abfb713c893dbd31d7c94b4741e82530b',1,'nc::Vec2::Vec2(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec2.html#a93a9f0c675265005a60c77179625ddd2',1,'nc::Vec2::Vec2(const NdArray< double > &ndArray)']]], - ['vec3_2223',['Vec3',['../classnc_1_1_vec3.html#adb18c9ba29affb8b712bb22a83e38e09',1,'nc::Vec3::Vec3()=default'],['../classnc_1_1_vec3.html#a6b0bc18cc9594a7d81361c518d543130',1,'nc::Vec3::Vec3(double inX, double inY, double inZ) noexcept'],['../classnc_1_1_vec3.html#a4056d1e369726710d6f1049b277486dd',1,'nc::Vec3::Vec3(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec3.html#a4668419f4c870900466d4aa198247767',1,'nc::Vec3::Vec3(const NdArray< double > &ndArray)']]], - ['vstack_2224',['vstack',['../namespacenc.html#a8dec1ff4db1d89ab4b3a7d32ff4b5cf3',1,'nc']]] + ['v_2320',['v',['../classnc_1_1linalg_1_1_s_v_d.html#a6b907070cfa7e89c3107fa628694e274',1,'nc::linalg::SVD']]], + ['value2str_2321',['value2str',['../namespacenc_1_1utils.html#a83530b13c9cc3b01b9bd8b8d3113290a',1,'nc::utils']]], + ['var_2322',['var',['../namespacenc.html#aeefabf8c851def135518ddded2bf5886',1,'nc::var(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a130dfd14b561ed4f0889fd2093f99d5f',1,'nc::var(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['vec2_2323',['Vec2',['../classnc_1_1_vec2.html#ae34b427d1b6560cce898bf61f9524a80',1,'nc::Vec2::Vec2()=default'],['../classnc_1_1_vec2.html#aeb48b0300990a5b77919589488ddfe30',1,'nc::Vec2::Vec2(double inX, double inY) noexcept'],['../classnc_1_1_vec2.html#abfb713c893dbd31d7c94b4741e82530b',1,'nc::Vec2::Vec2(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec2.html#a93a9f0c675265005a60c77179625ddd2',1,'nc::Vec2::Vec2(const NdArray< double > &ndArray)']]], + ['vec3_2324',['Vec3',['../classnc_1_1_vec3.html#adb18c9ba29affb8b712bb22a83e38e09',1,'nc::Vec3::Vec3()=default'],['../classnc_1_1_vec3.html#a6b0bc18cc9594a7d81361c518d543130',1,'nc::Vec3::Vec3(double inX, double inY, double inZ) noexcept'],['../classnc_1_1_vec3.html#a4056d1e369726710d6f1049b277486dd',1,'nc::Vec3::Vec3(const std::initializer_list< double > &inList)'],['../classnc_1_1_vec3.html#a4668419f4c870900466d4aa198247767',1,'nc::Vec3::Vec3(const NdArray< double > &ndArray)']]], + ['vstack_2325',['vstack',['../namespacenc.html#a5e1694cef7795a5fc4914b17d5272dd0',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/functions_16.html b/docs/doxygen/html/search/functions_16.html index 9260b21f7..5aed7d093 100644 --- a/docs/doxygen/html/search/functions_16.html +++ b/docs/doxygen/html/search/functions_16.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_16.js b/docs/doxygen/html/search/functions_16.js index e1f92c80d..2e9abb0a2 100644 --- a/docs/doxygen/html/search/functions_16.js +++ b/docs/doxygen/html/search/functions_16.js @@ -1,11 +1,11 @@ var searchData= [ - ['wahbasproblem_2225',['wahbasProblem',['../namespacenc_1_1rotations.html#a84a42f4e7f09b7c0e1a9307cb5b6f281',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk, const NdArray< dtype > &ak)'],['../namespacenc_1_1rotations.html#a6da89864a9512bbe69c848dad18220b4',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk)']]], - ['weibull_2226',['weibull',['../namespacenc_1_1random.html#a3cf0bdb15264c1ace4163042756a4765',1,'nc::random::weibull(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#af3a48c59aaa59d37bb5177b962d02bde',1,'nc::random::weibull(const Shape &inShape, dtype inA=1, dtype inB=1)']]], - ['where_2227',['where',['../namespacenc.html#ac0af750215d0444ad9f0208620ca206b',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a7191d45f29de05f27964f56f36c9be94',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, dtype inB)'],['../namespacenc.html#a446fff289053b687a994f9193941cd3f',1,'nc::where(const NdArray< bool > &inMask, dtype inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a39dbf48fd9094cc969f3d006788f2137',1,'nc::where(const NdArray< bool > &inMask, dtype inA, dtype inB)']]], - ['width_2228',['width',['../classnc_1_1image_processing_1_1_cluster.html#accbfd3dbb32016c0f4234614347d74ce',1,'nc::imageProcessing::Cluster']]], - ['windowexceedances_2229',['windowExceedances',['../namespacenc_1_1image_processing.html#a896adf0319f58a2f44cbf3dfaf550fe2',1,'nc::imageProcessing']]], - ['withext_2230',['withExt',['../classnc_1_1filesystem_1_1_file.html#adde9dd84b2a023df3bb908e6b1c7030f',1,'nc::filesystem::File']]], - ['wrap1d_2231',['wrap1d',['../namespacenc_1_1filter_1_1boundary.html#aa318761ec07aeb7764e2e5f0a7ec9e86',1,'nc::filter::boundary']]], - ['wrap2d_2232',['wrap2d',['../namespacenc_1_1filter_1_1boundary.html#aeace2e548cf6ecf3aaadbbf000cbead7',1,'nc::filter::boundary']]] + ['wahbasproblem_2326',['wahbasProblem',['../namespacenc_1_1rotations.html#a84a42f4e7f09b7c0e1a9307cb5b6f281',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk, const NdArray< dtype > &ak)'],['../namespacenc_1_1rotations.html#a6da89864a9512bbe69c848dad18220b4',1,'nc::rotations::wahbasProblem(const NdArray< dtype > &wk, const NdArray< dtype > &vk)']]], + ['weibull_2327',['weibull',['../namespacenc_1_1random.html#a3cf0bdb15264c1ace4163042756a4765',1,'nc::random::weibull(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#af3a48c59aaa59d37bb5177b962d02bde',1,'nc::random::weibull(const Shape &inShape, dtype inA=1, dtype inB=1)']]], + ['where_2328',['where',['../namespacenc.html#ac0af750215d0444ad9f0208620ca206b',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a7191d45f29de05f27964f56f36c9be94',1,'nc::where(const NdArray< bool > &inMask, const NdArray< dtype > &inA, dtype inB)'],['../namespacenc.html#a446fff289053b687a994f9193941cd3f',1,'nc::where(const NdArray< bool > &inMask, dtype inA, const NdArray< dtype > &inB)'],['../namespacenc.html#a39dbf48fd9094cc969f3d006788f2137',1,'nc::where(const NdArray< bool > &inMask, dtype inA, dtype inB)']]], + ['width_2329',['width',['../classnc_1_1image_processing_1_1_cluster.html#accbfd3dbb32016c0f4234614347d74ce',1,'nc::imageProcessing::Cluster']]], + ['windowexceedances_2330',['windowExceedances',['../namespacenc_1_1image_processing.html#a896adf0319f58a2f44cbf3dfaf550fe2',1,'nc::imageProcessing']]], + ['withext_2331',['withExt',['../classnc_1_1filesystem_1_1_file.html#adde9dd84b2a023df3bb908e6b1c7030f',1,'nc::filesystem::File']]], + ['wrap1d_2332',['wrap1d',['../namespacenc_1_1filter_1_1boundary.html#aa318761ec07aeb7764e2e5f0a7ec9e86',1,'nc::filter::boundary']]], + ['wrap2d_2333',['wrap2d',['../namespacenc_1_1filter_1_1boundary.html#aeace2e548cf6ecf3aaadbbf000cbead7',1,'nc::filter::boundary']]] ]; diff --git a/docs/doxygen/html/search/functions_17.html b/docs/doxygen/html/search/functions_17.html index 5f5cfd6f2..ad6d5a7af 100644 --- a/docs/doxygen/html/search/functions_17.html +++ b/docs/doxygen/html/search/functions_17.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_17.js b/docs/doxygen/html/search/functions_17.js index 066afb6c2..6cca85abe 100644 --- a/docs/doxygen/html/search/functions_17.js +++ b/docs/doxygen/html/search/functions_17.js @@ -1,6 +1,6 @@ var searchData= [ - ['x_2233',['x',['../classnc_1_1coordinates_1_1_coordinate.html#aded7d56f04931cfbb07488d45d6bfce5',1,'nc::coordinates::Coordinate']]], - ['xrotation_2234',['xRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a7679a0d5443e2abdee0c376ef5f6d1e1',1,'nc::rotations::DCM::xRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#a30fe8031959271e5b0134a0c562713b4',1,'nc::rotations::Quaternion::xRotation()']]], - ['xyz_2235',['xyz',['../classnc_1_1coordinates_1_1_coordinate.html#a01ff982f40caae2429c20d0ba66e4afc',1,'nc::coordinates::Coordinate']]] + ['x_2334',['x',['../classnc_1_1coordinates_1_1_coordinate.html#aded7d56f04931cfbb07488d45d6bfce5',1,'nc::coordinates::Coordinate']]], + ['xrotation_2335',['xRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a7679a0d5443e2abdee0c376ef5f6d1e1',1,'nc::rotations::DCM::xRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#a30fe8031959271e5b0134a0c562713b4',1,'nc::rotations::Quaternion::xRotation()']]], + ['xyz_2336',['xyz',['../classnc_1_1coordinates_1_1_coordinate.html#a01ff982f40caae2429c20d0ba66e4afc',1,'nc::coordinates::Coordinate']]] ]; diff --git a/docs/doxygen/html/search/functions_18.html b/docs/doxygen/html/search/functions_18.html index d5a7aaf81..b5c5c060f 100644 --- a/docs/doxygen/html/search/functions_18.html +++ b/docs/doxygen/html/search/functions_18.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_18.js b/docs/doxygen/html/search/functions_18.js index bf9c46ecd..ee041e40f 100644 --- a/docs/doxygen/html/search/functions_18.js +++ b/docs/doxygen/html/search/functions_18.js @@ -1,6 +1,6 @@ var searchData= [ - ['y_2236',['y',['../classnc_1_1coordinates_1_1_coordinate.html#a624e354f60ca0822c5a60e9ee6432bc6',1,'nc::coordinates::Coordinate']]], - ['yaw_2237',['yaw',['../classnc_1_1rotations_1_1_d_c_m.html#aef0f27b195b93151a94cb86ca9fa21c9',1,'nc::rotations::DCM::yaw()'],['../classnc_1_1rotations_1_1_quaternion.html#a5b5cef534a39badf5d3079ee642e675c',1,'nc::rotations::Quaternion::yaw()']]], - ['yrotation_2238',['yRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a9c495cb1fc84c70042d652d84bcddea4',1,'nc::rotations::DCM::yRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#ab77da90ef63465f79bd79348330ca9a4',1,'nc::rotations::Quaternion::yRotation()']]] + ['y_2337',['y',['../classnc_1_1coordinates_1_1_coordinate.html#a624e354f60ca0822c5a60e9ee6432bc6',1,'nc::coordinates::Coordinate']]], + ['yaw_2338',['yaw',['../classnc_1_1rotations_1_1_d_c_m.html#aef0f27b195b93151a94cb86ca9fa21c9',1,'nc::rotations::DCM::yaw()'],['../classnc_1_1rotations_1_1_quaternion.html#a5b5cef534a39badf5d3079ee642e675c',1,'nc::rotations::Quaternion::yaw()']]], + ['yrotation_2339',['yRotation',['../classnc_1_1rotations_1_1_d_c_m.html#a9c495cb1fc84c70042d652d84bcddea4',1,'nc::rotations::DCM::yRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#ab77da90ef63465f79bd79348330ca9a4',1,'nc::rotations::Quaternion::yRotation()']]] ]; diff --git a/docs/doxygen/html/search/functions_19.html b/docs/doxygen/html/search/functions_19.html index 698074cdf..bcae6da1c 100644 --- a/docs/doxygen/html/search/functions_19.html +++ b/docs/doxygen/html/search/functions_19.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_19.js b/docs/doxygen/html/search/functions_19.js index dde7e548b..f94ba1caf 100644 --- a/docs/doxygen/html/search/functions_19.js +++ b/docs/doxygen/html/search/functions_19.js @@ -1,7 +1,7 @@ var searchData= [ - ['z_2239',['z',['../classnc_1_1coordinates_1_1_coordinate.html#a21614cb1e2513d0d8cb553ccb035986e',1,'nc::coordinates::Coordinate']]], - ['zeros_2240',['zeros',['../classnc_1_1_nd_array.html#acac210ad3d3bd973be4bece6e6b625ed',1,'nc::NdArray::zeros()'],['../namespacenc.html#a8fb3ecc9cc7448e4b5d3d422e499b10e',1,'nc::zeros(uint32 inSquareSize)'],['../namespacenc.html#aa78000e997f09d772b82dd4a08783f69',1,'nc::zeros(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a9751f678e096a185122168c1c52edb25',1,'nc::zeros(const Shape &inShape)']]], - ['zeros_5flike_2241',['zeros_like',['../namespacenc.html#a497502db462e463196e12005ebf2d395',1,'nc']]], - ['zrotation_2242',['zRotation',['../classnc_1_1rotations_1_1_d_c_m.html#aa0c71aecc70f9354665b0c81cdf366ce',1,'nc::rotations::DCM::zRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#aaf688fafc4714f1da399e265c8e49a8d',1,'nc::rotations::Quaternion::zRotation()']]] + ['z_2340',['z',['../classnc_1_1coordinates_1_1_coordinate.html#a21614cb1e2513d0d8cb553ccb035986e',1,'nc::coordinates::Coordinate']]], + ['zeros_2341',['zeros',['../classnc_1_1_nd_array.html#acac210ad3d3bd973be4bece6e6b625ed',1,'nc::NdArray::zeros()'],['../namespacenc.html#a8fb3ecc9cc7448e4b5d3d422e499b10e',1,'nc::zeros(uint32 inSquareSize)'],['../namespacenc.html#aa78000e997f09d772b82dd4a08783f69',1,'nc::zeros(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a9751f678e096a185122168c1c52edb25',1,'nc::zeros(const Shape &inShape)']]], + ['zeros_5flike_2342',['zeros_like',['../namespacenc.html#a497502db462e463196e12005ebf2d395',1,'nc']]], + ['zrotation_2343',['zRotation',['../classnc_1_1rotations_1_1_d_c_m.html#aa0c71aecc70f9354665b0c81cdf366ce',1,'nc::rotations::DCM::zRotation()'],['../classnc_1_1rotations_1_1_quaternion.html#aaf688fafc4714f1da399e265c8e49a8d',1,'nc::rotations::Quaternion::zRotation()']]] ]; diff --git a/docs/doxygen/html/search/functions_1a.html b/docs/doxygen/html/search/functions_1a.html index 8b50562c8..932335d49 100644 --- a/docs/doxygen/html/search/functions_1a.html +++ b/docs/doxygen/html/search/functions_1a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_1a.js b/docs/doxygen/html/search/functions_1a.js index a0aea2970..6f922f206 100644 --- a/docs/doxygen/html/search/functions_1a.js +++ b/docs/doxygen/html/search/functions_1a.js @@ -1,10 +1,10 @@ var searchData= [ - ['_7ebisection_2243',['~Bisection',['../classnc_1_1roots_1_1_bisection.html#a5e0d0c67681add5f2feec713901539df',1,'nc::roots::Bisection']]], - ['_7ebrent_2244',['~Brent',['../classnc_1_1roots_1_1_brent.html#ade76ad260d82314f284ebacf885f6884',1,'nc::roots::Brent']]], - ['_7edekker_2245',['~Dekker',['../classnc_1_1roots_1_1_dekker.html#a49413387fbe4d12e20569d175fa7f486',1,'nc::roots::Dekker']]], - ['_7eiteration_2246',['~Iteration',['../classnc_1_1roots_1_1_iteration.html#a44492e4a1849938cd7017154213ec002',1,'nc::roots::Iteration']]], - ['_7endarray_2247',['~NdArray',['../classnc_1_1_nd_array.html#a7ef259d6b54cf8373721700b12c14500',1,'nc::NdArray']]], - ['_7enewton_2248',['~Newton',['../classnc_1_1roots_1_1_newton.html#a25702b087e2e9917af0c31fe1dbdf442',1,'nc::roots::Newton']]], - ['_7esecant_2249',['~Secant',['../classnc_1_1roots_1_1_secant.html#aa5eb3c22ecf2ef92a381b6cf54fb1f83',1,'nc::roots::Secant']]] + ['_7ebisection_2344',['~Bisection',['../classnc_1_1roots_1_1_bisection.html#a5e0d0c67681add5f2feec713901539df',1,'nc::roots::Bisection']]], + ['_7ebrent_2345',['~Brent',['../classnc_1_1roots_1_1_brent.html#ade76ad260d82314f284ebacf885f6884',1,'nc::roots::Brent']]], + ['_7edekker_2346',['~Dekker',['../classnc_1_1roots_1_1_dekker.html#a49413387fbe4d12e20569d175fa7f486',1,'nc::roots::Dekker']]], + ['_7eiteration_2347',['~Iteration',['../classnc_1_1roots_1_1_iteration.html#a44492e4a1849938cd7017154213ec002',1,'nc::roots::Iteration']]], + ['_7endarray_2348',['~NdArray',['../classnc_1_1_nd_array.html#a7ef259d6b54cf8373721700b12c14500',1,'nc::NdArray']]], + ['_7enewton_2349',['~Newton',['../classnc_1_1roots_1_1_newton.html#a25702b087e2e9917af0c31fe1dbdf442',1,'nc::roots::Newton']]], + ['_7esecant_2350',['~Secant',['../classnc_1_1roots_1_1_secant.html#aa5eb3c22ecf2ef92a381b6cf54fb1f83',1,'nc::roots::Secant']]] ]; diff --git a/docs/doxygen/html/search/functions_2.html b/docs/doxygen/html/search/functions_2.html index 6587a061f..ca5aa10e6 100644 --- a/docs/doxygen/html/search/functions_2.html +++ b/docs/doxygen/html/search/functions_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_2.js b/docs/doxygen/html/search/functions_2.js index 5a5f79dd9..3a11daaed 100644 --- a/docs/doxygen/html/search/functions_2.js +++ b/docs/doxygen/html/search/functions_2.js @@ -1,67 +1,72 @@ var searchData= [ - ['cauchy_1725',['cauchy',['../namespacenc_1_1random.html#a61dc9fcfaee6e2a74e3f2e1f0e9c039b',1,'nc::random::cauchy(const Shape &inShape, dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#aa72b221b82940e126a4c740ee55b269b',1,'nc::random::cauchy(dtype inMean=0, dtype inSigma=1)']]], - ['cbegin_1726',['cbegin',['../classnc_1_1_nd_array.html#a0bee49339bdc4d7edbeb5efa73133cc3',1,'nc::NdArray::cbegin() const noexcept'],['../classnc_1_1_nd_array.html#a4a3d1f968c924a4dc74cd8b617d30df6',1,'nc::NdArray::cbegin(size_type inRow) const'],['../classnc_1_1_data_cube.html#adee7aa24a04d84f83f4c76ef8dcec974',1,'nc::DataCube::cbegin()']]], - ['cbrt_1727',['cbrt',['../namespacenc.html#ae0f91253a3818ac7a12a9d5120ee9a14',1,'nc::cbrt(const NdArray< dtype > &inArray)'],['../namespacenc.html#a21de0caa1ff8e9e7baed8a8a57f7bcab',1,'nc::cbrt(dtype inValue) noexcept']]], - ['ccolbegin_1728',['ccolbegin',['../classnc_1_1_nd_array.html#a25c7145679e41227023ad6de4ab5cd18',1,'nc::NdArray::ccolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a1252a696593c510d506c1bca8bd65c51',1,'nc::NdArray::ccolbegin(size_type inCol) const']]], - ['ccolend_1729',['ccolend',['../classnc_1_1_nd_array.html#ad2833ea5479c37de114bf52afff04a20',1,'nc::NdArray::ccolend() const noexcept'],['../classnc_1_1_nd_array.html#a4a493445c10ed3c299632bf8c7077cfb',1,'nc::NdArray::ccolend(size_type inCol) const']]], - ['ceil_1730',['ceil',['../namespacenc.html#a375f83bc366e3b26842a03b9688b8a33',1,'nc::ceil(const NdArray< dtype > &inArray)'],['../namespacenc.html#a291189b2c2bc35a608b393ab1c06e84a',1,'nc::ceil(dtype inValue) noexcept']]], - ['cend_1731',['cend',['../classnc_1_1_nd_array.html#aa16bc96e4bbafbc8a06743f3e4a10a6a',1,'nc::NdArray::cend()'],['../classnc_1_1_data_cube.html#aca3c0041f121ed92d47d1f2873f713e4',1,'nc::DataCube::cend()'],['../classnc_1_1_nd_array.html#a4da6aaa43b6074a4353328a8047992f6',1,'nc::NdArray::cend()']]], - ['centerofmass_1732',['centerOfMass',['../namespacenc.html#a830888da11b33ea36bf4fc580d8c4757',1,'nc']]], - ['centroid_1733',['Centroid',['../classnc_1_1image_processing_1_1_centroid.html#a59d0af7acae8d24d29ccb372440aed22',1,'nc::imageProcessing::Centroid::Centroid(const Cluster< dtype > &inCluster)'],['../classnc_1_1image_processing_1_1_centroid.html#a3b97e4ddc31b85eb8c3f84b398429a35',1,'nc::imageProcessing::Centroid::Centroid()=default']]], - ['centroidclusters_1734',['centroidClusters',['../namespacenc_1_1image_processing.html#adbb987932dd69ec19029228e065c6603',1,'nc::imageProcessing']]], - ['chebyshev_5ft_1735',['chebyshev_t',['../namespacenc_1_1polynomial.html#a0ce5634d805736db2082358497bac2f4',1,'nc::polynomial::chebyshev_t(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#afc70c903be3c216cf6215b76c89fecc0',1,'nc::polynomial::chebyshev_t(uint32 n, dtype x)']]], - ['chebyshev_5fu_1736',['chebyshev_u',['../namespacenc_1_1polynomial.html#ae03d7859d449ee3fa17f2d09bb2b5638',1,'nc::polynomial::chebyshev_u(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a1e0f56b8366b1f83b48e30e7bb04c937',1,'nc::polynomial::chebyshev_u(uint32 n, dtype x)']]], - ['chisquare_1737',['chiSquare',['../namespacenc_1_1random.html#a329370aed893f0e10a8050520cf0bbd4',1,'nc::random::chiSquare(const Shape &inShape, dtype inDof)'],['../namespacenc_1_1random.html#abb480e9a17b71ea09ef0f043c081e9ff',1,'nc::random::chiSquare(dtype inDof)']]], - ['choice_1738',['choice',['../namespacenc_1_1random.html#a7fcf28e4b1a2b015b1099986c5202877',1,'nc::random::choice(const NdArray< dtype > &inArray, uint32 inNum, bool replace=true)'],['../namespacenc_1_1random.html#ad60ec32743642bd0540fec0076043fed',1,'nc::random::choice(const NdArray< dtype > &inArray)']]], - ['cholesky_1739',['cholesky',['../namespacenc_1_1linalg.html#ac2d27e58dd0f082ef5a422d545699d19',1,'nc::linalg']]], - ['clampmagnitude_1740',['clampMagnitude',['../classnc_1_1_vec2.html#abb0f6f8cacc680a464425d908e1e55cc',1,'nc::Vec2::clampMagnitude()'],['../classnc_1_1_vec3.html#a4f3cfcbd67a402820cc8e0576dccd2e4',1,'nc::Vec3::clampMagnitude()']]], - ['clip_1741',['clip',['../namespacenc.html#a5200696e06dadf4eca2f0d7332ed4af1',1,'nc::clip(dtype inValue, dtype inMinValue, dtype inMaxValue)'],['../namespacenc.html#af82b46f44ea7fad5bbd8ef9acf2499c3',1,'nc::clip(const NdArray< dtype > &inArray, dtype inMinValue, dtype inMaxValue)'],['../classnc_1_1_nd_array.html#a5a7fa82bdf3f34fcd3cc1dd2169c6c6f',1,'nc::NdArray::clip()']]], - ['cluster_1742',['Cluster',['../classnc_1_1image_processing_1_1_cluster.html#a9c84aca9710bec5c721fd6a9f94182c3',1,'nc::imageProcessing::Cluster::Cluster()=default'],['../classnc_1_1image_processing_1_1_cluster.html#a73ce20625b5ca5d9e0d872cc8ad885dc',1,'nc::imageProcessing::Cluster::Cluster(uint32 inClusterId) noexcept']]], - ['clusterid_1743',['clusterId',['../classnc_1_1image_processing_1_1_cluster.html#abcc9f76b1d903546a3604ef87795d37e',1,'nc::imageProcessing::Cluster']]], - ['clustermaker_1744',['ClusterMaker',['../classnc_1_1image_processing_1_1_cluster_maker.html#a17c7a9f6260f7d6d0aea002b7e5e6ae6',1,'nc::imageProcessing::ClusterMaker']]], - ['clusterpixels_1745',['clusterPixels',['../namespacenc_1_1image_processing.html#a9b0730e1067dc755ee1fa2ecf280c14f',1,'nc::imageProcessing']]], - ['cnr_1746',['cnr',['../namespacenc_1_1special.html#a8249c674798e782f98a90942818ab395',1,'nc::special']]], - ['coefficients_1747',['coefficients',['../classnc_1_1polynomial_1_1_poly1d.html#abc31b5e093fd3ce5b2c14eade8d346a9',1,'nc::polynomial::Poly1d']]], - ['col_1748',['col',['../classnc_1_1image_processing_1_1_centroid.html#a4ef0e9b2faa4999af5c3597a60140d6c',1,'nc::imageProcessing::Centroid']]], - ['colbegin_1749',['colbegin',['../classnc_1_1_nd_array.html#acadf6ded9a6eb2638d975da9dbbfe38c',1,'nc::NdArray::colbegin(size_type inCol) const'],['../classnc_1_1_nd_array.html#ab6bf02841ec667f5bb4266da569c99fc',1,'nc::NdArray::colbegin() const noexcept'],['../classnc_1_1_nd_array.html#a41f363682d797ed0ed236cf91bd644f1',1,'nc::NdArray::colbegin() noexcept'],['../classnc_1_1_nd_array.html#a3730d4ac599c06e0e25ac7838f53240b',1,'nc::NdArray::colbegin(size_type inCol)']]], - ['colend_1750',['colend',['../classnc_1_1_nd_array.html#ae611e2ecc5bae6035d0de4d48f5de239',1,'nc::NdArray::colend(size_type inCol)'],['../classnc_1_1_nd_array.html#a6501fd771b4dcf1fb49defeee43a47cc',1,'nc::NdArray::colend() noexcept'],['../classnc_1_1_nd_array.html#ac1297463b545ecfd72d22549ce0db02a',1,'nc::NdArray::colend() const noexcept'],['../classnc_1_1_nd_array.html#a97f4fdf4d1a588662733af2bc7e63aaa',1,'nc::NdArray::colend(size_type inCol) const']]], - ['colmax_1751',['colMax',['../classnc_1_1image_processing_1_1_cluster.html#a8c884e5e55d41c09165bca85446edb1f',1,'nc::imageProcessing::Cluster']]], - ['colmin_1752',['colMin',['../classnc_1_1image_processing_1_1_cluster.html#a27734d0fa45c7440e3018fa36c6633f9',1,'nc::imageProcessing::Cluster']]], - ['column_1753',['column',['../classnc_1_1_nd_array.html#a4dc9d45ee849274808d850deeba451dd',1,'nc::NdArray']]], - ['column_5fstack_1754',['column_stack',['../namespacenc.html#a940bbaf9f760ce2d85119beb4a5c23f2',1,'nc']]], - ['comp_5fellint_5f1_1755',['comp_ellint_1',['../namespacenc_1_1special.html#a3b24e9dde5d68f19d8a29de419e32024',1,'nc::special::comp_ellint_1(dtype inK)'],['../namespacenc_1_1special.html#a445930bd5caceb59104bc466c55d479a',1,'nc::special::comp_ellint_1(const NdArray< dtype > &inArrayK)']]], - ['comp_5fellint_5f2_1756',['comp_ellint_2',['../namespacenc_1_1special.html#abfcffce97bdc9114b78a4c6d06956fc5',1,'nc::special::comp_ellint_2(dtype inK)'],['../namespacenc_1_1special.html#abb6b67ccb2a8ea054c188d82f3a67013',1,'nc::special::comp_ellint_2(const NdArray< dtype > &inArrayK)']]], - ['comp_5fellint_5f3_1757',['comp_ellint_3',['../namespacenc_1_1special.html#a8c90b0cd0de06a5e789e3b9f8b0a1243',1,'nc::special::comp_ellint_3(dtype1 inK, dtype2 inV)'],['../namespacenc_1_1special.html#a40e29e793c7c7ee437f242a8cc7e8e26',1,'nc::special::comp_ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV)']]], - ['complementarymedianfilter_1758',['complementaryMedianFilter',['../namespacenc_1_1filter.html#a2343ac38b1ec7c4cbde82a3fe20b4c21',1,'nc::filter']]], - ['complementarymedianfilter1d_1759',['complementaryMedianFilter1d',['../namespacenc_1_1filter.html#aed171f8ad8a79d99c13158c909ac4017',1,'nc::filter']]], - ['complex_1760',['complex',['../namespacenc.html#a56639fcc468435514861ce0e5059d82f',1,'nc::complex(dtype inReal)'],['../namespacenc.html#a2e653b99a0f26149fe399ebed1fc949e',1,'nc::complex(dtype inReal, dtype inImag)'],['../namespacenc.html#ab84a62b7de04ef6f69870e51f5dd8d00',1,'nc::complex(const NdArray< dtype > &inReal)'],['../namespacenc.html#a1d8b87baeef70163d94b40c96759ecc0',1,'nc::complex(const NdArray< dtype > &inReal, const NdArray< dtype > &inImag)']]], - ['complex_5fcast_1761',['complex_cast',['../namespacenc.html#ad639d68db9e1b3ea9acc08efe4bad20e',1,'nc']]], - ['concatenate_1762',['concatenate',['../namespacenc.html#a027070169f1750a74315d07c5bbdfb03',1,'nc']]], - ['conj_1763',['conj',['../namespacenc.html#a26e9df3c46d4f782d04c8d35881aad80',1,'nc::conj(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a0387ae5584e72894ae9e690eba21e26b',1,'nc::conj(const std::complex< dtype > &inValue)']]], - ['conjugate_1764',['conjugate',['../classnc_1_1rotations_1_1_quaternion.html#ade406544e8360506bb77102d17b14e61',1,'nc::rotations::Quaternion']]], - ['constant1d_1765',['constant1d',['../namespacenc_1_1filter_1_1boundary.html#a09c2e0a7f9ff3c1fbbbee0136d80a2e0',1,'nc::filter::boundary']]], - ['constant2d_1766',['constant2d',['../namespacenc_1_1filter_1_1boundary.html#a0e0bd2ad1d6ac1b1d248175b9bc422f6',1,'nc::filter::boundary']]], - ['contains_1767',['contains',['../classnc_1_1_nd_array.html#ad0c493a734dbca9f622d0f7ca6dffbf4',1,'nc::NdArray::contains()'],['../namespacenc.html#a89349379637971764e6efe28ad8c1848',1,'nc::contains()']]], - ['convolve_1768',['convolve',['../namespacenc_1_1filter.html#abc4c77c759de3cd79f3fc02b7461d971',1,'nc::filter']]], - ['convolve1d_1769',['convolve1d',['../namespacenc_1_1filter.html#a21d48fecf984290cb5a4388d50371b13',1,'nc::filter']]], - ['coordinate_1770',['Coordinate',['../classnc_1_1coordinates_1_1_coordinate.html#a983a167d97af973947f76474ab299ab8',1,'nc::coordinates::Coordinate::Coordinate(double inRaDegrees, double inDecDegrees)'],['../classnc_1_1coordinates_1_1_coordinate.html#a0f541169a4c318a5cf4fd0a50a4c2013',1,'nc::coordinates::Coordinate::Coordinate()=default'],['../classnc_1_1coordinates_1_1_coordinate.html#a68eafc66dfeb8551fa7d8960f116be83',1,'nc::coordinates::Coordinate::Coordinate(uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds)'],['../classnc_1_1coordinates_1_1_coordinate.html#a7cf9e8138023ced7cfcb071299018fd5',1,'nc::coordinates::Coordinate::Coordinate(const RA &inRA, const Dec &inDec) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#aa023b8b0e74159909e99aabcf778c57f',1,'nc::coordinates::Coordinate::Coordinate(double inX, double inY, double inZ) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#a35b32fa280c920d0b528472f7726a03d',1,'nc::coordinates::Coordinate::Coordinate(const NdArray< double > &inCartesianVector)']]], - ['copy_1771',['copy',['../namespacenc.html#a9bbe10d41fdbd74a6254bad44c7c7cf6',1,'nc::copy()'],['../namespacenc_1_1stl__algorithms.html#ae62a4e197ec640aacea520220bd27cef',1,'nc::stl_algorithms::copy()'],['../classnc_1_1_nd_array.html#a1f2d2aacc254129f36b0557a661e6664',1,'nc::NdArray::copy()']]], - ['copysign_1772',['copySign',['../namespacenc.html#a9e08e770fd2283734390ab631edc250d',1,'nc']]], - ['copyto_1773',['copyto',['../namespacenc.html#af8eca852439098c1fff96384d88d82dd',1,'nc']]], - ['cos_1774',['cos',['../namespacenc.html#af208ae28fe0df17392ca128188cbcd73',1,'nc::cos(const NdArray< dtype > &inArray)'],['../namespacenc.html#a736de91eb8f79bfaf4dc92d7161f1c87',1,'nc::cos(dtype inValue) noexcept']]], - ['cosh_1775',['cosh',['../namespacenc.html#abb07133a1f54b24a4a4986eefb5eda85',1,'nc::cosh(dtype inValue) noexcept'],['../namespacenc.html#a520e0290bb667b43a9f494b3858b5f17',1,'nc::cosh(const NdArray< dtype > &inArray)']]], - ['count_1776',['count',['../namespacenc_1_1stl__algorithms.html#a1fa02155befc0c39a853e66f6df26745',1,'nc::stl_algorithms']]], - ['count_5fnonzero_1777',['count_nonzero',['../namespacenc.html#aebb0dfe3637c07f6a9f6e4f08cacf515',1,'nc']]], - ['crbegin_1778',['crbegin',['../classnc_1_1_nd_array.html#a95cbc4440ac1e139642a08cbd075dafc',1,'nc::NdArray::crbegin() const noexcept'],['../classnc_1_1_nd_array.html#af6b2581fae90a5c67e87df6a82ea13c5',1,'nc::NdArray::crbegin(size_type inRow) const']]], - ['crcolbegin_1779',['crcolbegin',['../classnc_1_1_nd_array.html#a35883ec844477b9bca2597939dd99c2a',1,'nc::NdArray::crcolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a8afdb68c11124e1fe0309204f3996435',1,'nc::NdArray::crcolbegin(size_type inCol) const']]], - ['crcolend_1780',['crcolend',['../classnc_1_1_nd_array.html#a55e5d41795f14f7f2aa256ba0f4bb676',1,'nc::NdArray::crcolend() const noexcept'],['../classnc_1_1_nd_array.html#a35b66f060b1ed99a6fb5247581fcb8fc',1,'nc::NdArray::crcolend(size_type inCol) const']]], - ['crend_1781',['crend',['../classnc_1_1_nd_array.html#ac5d1c900c4db4263d1bf799ac3551ed6',1,'nc::NdArray::crend() const noexcept'],['../classnc_1_1_nd_array.html#af3b4c48e3328a8dd22eedd27c225aeb5',1,'nc::NdArray::crend(size_type inRow) const']]], - ['cross_1782',['cross',['../namespacenc.html#a4d1ed581965ed53090824290def38565',1,'nc::cross()'],['../classnc_1_1_vec3.html#af8173f6e61e9a63beae3092fd8dc4378',1,'nc::Vec3::cross()']]], - ['cslice_1783',['cSlice',['../classnc_1_1_nd_array.html#a29eabba849b35a3095cd341fa1c7b123',1,'nc::NdArray']]], - ['cube_1784',['cube',['../namespacenc.html#a224d96b41af957c782c02f1cb25e66fd',1,'nc::cube()'],['../namespacenc_1_1utils.html#a46e88717d4d32003bb449fd5cefd401c',1,'nc::utils::cube()'],['../namespacenc.html#a5899ccef8410243438debea3d8296df6',1,'nc::cube(dtype inValue) noexcept']]], - ['cumprod_1785',['cumprod',['../namespacenc.html#aafc4846f2f7956841d356060c9689cba',1,'nc::cumprod()'],['../classnc_1_1_nd_array.html#a75a231dec87e18370e9731214983858e',1,'nc::NdArray::cumprod(Axis inAxis=Axis::NONE) const']]], - ['cumsum_1786',['cumsum',['../classnc_1_1_nd_array.html#a4baa93f2a125d7665f3cdfd8d96d3acc',1,'nc::NdArray::cumsum()'],['../namespacenc.html#a2abc8c4a18823234e3baec64d10c0dcd',1,'nc::cumsum()']]], - ['cyclic_5fhankel_5f1_1787',['cyclic_hankel_1',['../namespacenc_1_1special.html#af5dd42de33ec77dda47dd089561895d5',1,'nc::special::cyclic_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ae7053cd6eafb59a62ba6ede63aac6f90',1,'nc::special::cyclic_hankel_1(dtype1 inV, const NdArray< dtype2 > &inX)']]], - ['cyclic_5fhankel_5f2_1788',['cyclic_hankel_2',['../namespacenc_1_1special.html#a388472a49e89f21b3eb144368fe55664',1,'nc::special::cyclic_hankel_2(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a8e3b27238d1cae20e4ee071766549c5d',1,'nc::special::cyclic_hankel_2(dtype1 inV, const NdArray< dtype2 > &inX)']]] + ['calculateparity_1802',['calculateParity',['../namespacenc_1_1edac_1_1detail.html#aea349d7b4d28ca91b85bcb3a2823c145',1,'nc::edac::detail::calculateParity(const std::bitset< DataBits > &data, IntType parityBit)'],['../namespacenc_1_1edac_1_1detail.html#abde37c852253de171988da5e4b775273',1,'nc::edac::detail::calculateParity(const boost::dynamic_bitset<> &data) noexcept'],['../namespacenc_1_1edac_1_1detail.html#ad3215e8486eb3a544a483e5234c856d7',1,'nc::edac::detail::calculateParity(const std::bitset< DataBits > &data) noexcept']]], + ['cauchy_1803',['cauchy',['../namespacenc_1_1random.html#a61dc9fcfaee6e2a74e3f2e1f0e9c039b',1,'nc::random::cauchy(const Shape &inShape, dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#aa72b221b82940e126a4c740ee55b269b',1,'nc::random::cauchy(dtype inMean=0, dtype inSigma=1)']]], + ['cbegin_1804',['cbegin',['../classnc_1_1_data_cube.html#adee7aa24a04d84f83f4c76ef8dcec974',1,'nc::DataCube::cbegin()'],['../classnc_1_1_nd_array.html#a0bee49339bdc4d7edbeb5efa73133cc3',1,'nc::NdArray::cbegin() const noexcept'],['../classnc_1_1_nd_array.html#a4a3d1f968c924a4dc74cd8b617d30df6',1,'nc::NdArray::cbegin(size_type inRow) const']]], + ['cbrt_1805',['cbrt',['../namespacenc.html#ae0f91253a3818ac7a12a9d5120ee9a14',1,'nc::cbrt(const NdArray< dtype > &inArray)'],['../namespacenc.html#a21de0caa1ff8e9e7baed8a8a57f7bcab',1,'nc::cbrt(dtype inValue) noexcept']]], + ['ccolbegin_1806',['ccolbegin',['../classnc_1_1_nd_array.html#a25c7145679e41227023ad6de4ab5cd18',1,'nc::NdArray::ccolbegin() const noexcept'],['../classnc_1_1_nd_array.html#a1252a696593c510d506c1bca8bd65c51',1,'nc::NdArray::ccolbegin(size_type inCol) const']]], + ['ccolend_1807',['ccolend',['../classnc_1_1_nd_array.html#a4a493445c10ed3c299632bf8c7077cfb',1,'nc::NdArray::ccolend(size_type inCol) const'],['../classnc_1_1_nd_array.html#ad2833ea5479c37de114bf52afff04a20',1,'nc::NdArray::ccolend() const noexcept']]], + ['ceil_1808',['ceil',['../namespacenc.html#a375f83bc366e3b26842a03b9688b8a33',1,'nc::ceil(const NdArray< dtype > &inArray)'],['../namespacenc.html#a291189b2c2bc35a608b393ab1c06e84a',1,'nc::ceil(dtype inValue) noexcept']]], + ['cend_1809',['cend',['../classnc_1_1_data_cube.html#aca3c0041f121ed92d47d1f2873f713e4',1,'nc::DataCube::cend()'],['../classnc_1_1_nd_array.html#aa16bc96e4bbafbc8a06743f3e4a10a6a',1,'nc::NdArray::cend() const noexcept'],['../classnc_1_1_nd_array.html#a4da6aaa43b6074a4353328a8047992f6',1,'nc::NdArray::cend(size_type inRow) const']]], + ['centerofmass_1810',['centerOfMass',['../namespacenc.html#a830888da11b33ea36bf4fc580d8c4757',1,'nc']]], + ['centroid_1811',['Centroid',['../classnc_1_1image_processing_1_1_centroid.html#a3b97e4ddc31b85eb8c3f84b398429a35',1,'nc::imageProcessing::Centroid::Centroid()=default'],['../classnc_1_1image_processing_1_1_centroid.html#a59d0af7acae8d24d29ccb372440aed22',1,'nc::imageProcessing::Centroid::Centroid(const Cluster< dtype > &inCluster)']]], + ['centroidclusters_1812',['centroidClusters',['../namespacenc_1_1image_processing.html#adbb987932dd69ec19029228e065c6603',1,'nc::imageProcessing']]], + ['chebyshev_5ft_1813',['chebyshev_t',['../namespacenc_1_1polynomial.html#afc70c903be3c216cf6215b76c89fecc0',1,'nc::polynomial::chebyshev_t(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a0ce5634d805736db2082358497bac2f4',1,'nc::polynomial::chebyshev_t(uint32 n, const NdArray< dtype > &inArrayX)']]], + ['chebyshev_5fu_1814',['chebyshev_u',['../namespacenc_1_1polynomial.html#ae03d7859d449ee3fa17f2d09bb2b5638',1,'nc::polynomial::chebyshev_u(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a1e0f56b8366b1f83b48e30e7bb04c937',1,'nc::polynomial::chebyshev_u(uint32 n, dtype x)']]], + ['checkbitsconsistent_1815',['checkBitsConsistent',['../namespacenc_1_1edac_1_1detail.html#af386b23445a4942453c69cff80ee0e20',1,'nc::edac::detail']]], + ['chisquare_1816',['chiSquare',['../namespacenc_1_1random.html#a329370aed893f0e10a8050520cf0bbd4',1,'nc::random::chiSquare(const Shape &inShape, dtype inDof)'],['../namespacenc_1_1random.html#abb480e9a17b71ea09ef0f043c081e9ff',1,'nc::random::chiSquare(dtype inDof)']]], + ['choice_1817',['choice',['../namespacenc_1_1random.html#ad60ec32743642bd0540fec0076043fed',1,'nc::random::choice(const NdArray< dtype > &inArray)'],['../namespacenc_1_1random.html#a7fcf28e4b1a2b015b1099986c5202877',1,'nc::random::choice(const NdArray< dtype > &inArray, uint32 inNum, bool replace=true)']]], + ['cholesky_1818',['cholesky',['../namespacenc_1_1linalg.html#ac2d27e58dd0f082ef5a422d545699d19',1,'nc::linalg']]], + ['clampmagnitude_1819',['clampMagnitude',['../classnc_1_1_vec2.html#abb0f6f8cacc680a464425d908e1e55cc',1,'nc::Vec2::clampMagnitude()'],['../classnc_1_1_vec3.html#a4f3cfcbd67a402820cc8e0576dccd2e4',1,'nc::Vec3::clampMagnitude()']]], + ['clip_1820',['clip',['../classnc_1_1_nd_array.html#a5a7fa82bdf3f34fcd3cc1dd2169c6c6f',1,'nc::NdArray::clip()'],['../namespacenc.html#af82b46f44ea7fad5bbd8ef9acf2499c3',1,'nc::clip(const NdArray< dtype > &inArray, dtype inMinValue, dtype inMaxValue)'],['../namespacenc.html#a5200696e06dadf4eca2f0d7332ed4af1',1,'nc::clip(dtype inValue, dtype inMinValue, dtype inMaxValue)']]], + ['cluster_1821',['Cluster',['../classnc_1_1image_processing_1_1_cluster.html#a73ce20625b5ca5d9e0d872cc8ad885dc',1,'nc::imageProcessing::Cluster::Cluster(uint32 inClusterId) noexcept'],['../classnc_1_1image_processing_1_1_cluster.html#a9c84aca9710bec5c721fd6a9f94182c3',1,'nc::imageProcessing::Cluster::Cluster()=default']]], + ['clusterid_1822',['clusterId',['../classnc_1_1image_processing_1_1_cluster.html#abcc9f76b1d903546a3604ef87795d37e',1,'nc::imageProcessing::Cluster']]], + ['clustermaker_1823',['ClusterMaker',['../classnc_1_1image_processing_1_1_cluster_maker.html#a17c7a9f6260f7d6d0aea002b7e5e6ae6',1,'nc::imageProcessing::ClusterMaker']]], + ['clusterpixels_1824',['clusterPixels',['../namespacenc_1_1image_processing.html#a9b0730e1067dc755ee1fa2ecf280c14f',1,'nc::imageProcessing']]], + ['cnr_1825',['cnr',['../namespacenc_1_1special.html#a8249c674798e782f98a90942818ab395',1,'nc::special']]], + ['coefficients_1826',['coefficients',['../classnc_1_1polynomial_1_1_poly1d.html#abc31b5e093fd3ce5b2c14eade8d346a9',1,'nc::polynomial::Poly1d']]], + ['col_1827',['col',['../classnc_1_1image_processing_1_1_centroid.html#a4ef0e9b2faa4999af5c3597a60140d6c',1,'nc::imageProcessing::Centroid']]], + ['colbegin_1828',['colbegin',['../classnc_1_1_nd_array.html#a41f363682d797ed0ed236cf91bd644f1',1,'nc::NdArray::colbegin() noexcept'],['../classnc_1_1_nd_array.html#a3730d4ac599c06e0e25ac7838f53240b',1,'nc::NdArray::colbegin(size_type inCol)'],['../classnc_1_1_nd_array.html#ab6bf02841ec667f5bb4266da569c99fc',1,'nc::NdArray::colbegin() const noexcept'],['../classnc_1_1_nd_array.html#acadf6ded9a6eb2638d975da9dbbfe38c',1,'nc::NdArray::colbegin(size_type inCol) const']]], + ['colend_1829',['colend',['../classnc_1_1_nd_array.html#a6501fd771b4dcf1fb49defeee43a47cc',1,'nc::NdArray::colend() noexcept'],['../classnc_1_1_nd_array.html#ae611e2ecc5bae6035d0de4d48f5de239',1,'nc::NdArray::colend(size_type inCol)'],['../classnc_1_1_nd_array.html#ac1297463b545ecfd72d22549ce0db02a',1,'nc::NdArray::colend() const noexcept'],['../classnc_1_1_nd_array.html#a97f4fdf4d1a588662733af2bc7e63aaa',1,'nc::NdArray::colend(size_type inCol) const']]], + ['colmax_1830',['colMax',['../classnc_1_1image_processing_1_1_cluster.html#a8c884e5e55d41c09165bca85446edb1f',1,'nc::imageProcessing::Cluster']]], + ['colmin_1831',['colMin',['../classnc_1_1image_processing_1_1_cluster.html#a27734d0fa45c7440e3018fa36c6633f9',1,'nc::imageProcessing::Cluster']]], + ['column_1832',['column',['../classnc_1_1_nd_array.html#a4dc9d45ee849274808d850deeba451dd',1,'nc::NdArray']]], + ['column_5fstack_1833',['column_stack',['../namespacenc.html#a940bbaf9f760ce2d85119beb4a5c23f2',1,'nc']]], + ['comp_5fellint_5f1_1834',['comp_ellint_1',['../namespacenc_1_1special.html#a3b24e9dde5d68f19d8a29de419e32024',1,'nc::special::comp_ellint_1(dtype inK)'],['../namespacenc_1_1special.html#a445930bd5caceb59104bc466c55d479a',1,'nc::special::comp_ellint_1(const NdArray< dtype > &inArrayK)']]], + ['comp_5fellint_5f2_1835',['comp_ellint_2',['../namespacenc_1_1special.html#abfcffce97bdc9114b78a4c6d06956fc5',1,'nc::special::comp_ellint_2(dtype inK)'],['../namespacenc_1_1special.html#abb6b67ccb2a8ea054c188d82f3a67013',1,'nc::special::comp_ellint_2(const NdArray< dtype > &inArrayK)']]], + ['comp_5fellint_5f3_1836',['comp_ellint_3',['../namespacenc_1_1special.html#a8c90b0cd0de06a5e789e3b9f8b0a1243',1,'nc::special::comp_ellint_3(dtype1 inK, dtype2 inV)'],['../namespacenc_1_1special.html#a40e29e793c7c7ee437f242a8cc7e8e26',1,'nc::special::comp_ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV)']]], + ['complementarymedianfilter_1837',['complementaryMedianFilter',['../namespacenc_1_1filter.html#a2343ac38b1ec7c4cbde82a3fe20b4c21',1,'nc::filter']]], + ['complementarymedianfilter1d_1838',['complementaryMedianFilter1d',['../namespacenc_1_1filter.html#aed171f8ad8a79d99c13158c909ac4017',1,'nc::filter']]], + ['complex_1839',['complex',['../namespacenc.html#a56639fcc468435514861ce0e5059d82f',1,'nc::complex(dtype inReal)'],['../namespacenc.html#a1d8b87baeef70163d94b40c96759ecc0',1,'nc::complex(const NdArray< dtype > &inReal, const NdArray< dtype > &inImag)'],['../namespacenc.html#ab84a62b7de04ef6f69870e51f5dd8d00',1,'nc::complex(const NdArray< dtype > &inReal)'],['../namespacenc.html#a2e653b99a0f26149fe399ebed1fc949e',1,'nc::complex(dtype inReal, dtype inImag)']]], + ['complex_5fcast_1840',['complex_cast',['../namespacenc.html#ad639d68db9e1b3ea9acc08efe4bad20e',1,'nc']]], + ['concatenate_1841',['concatenate',['../namespacenc.html#a027070169f1750a74315d07c5bbdfb03',1,'nc']]], + ['conj_1842',['conj',['../namespacenc.html#a26e9df3c46d4f782d04c8d35881aad80',1,'nc::conj(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a0387ae5584e72894ae9e690eba21e26b',1,'nc::conj(const std::complex< dtype > &inValue)']]], + ['conjugate_1843',['conjugate',['../classnc_1_1rotations_1_1_quaternion.html#ade406544e8360506bb77102d17b14e61',1,'nc::rotations::Quaternion']]], + ['constant1d_1844',['constant1d',['../namespacenc_1_1filter_1_1boundary.html#a09c2e0a7f9ff3c1fbbbee0136d80a2e0',1,'nc::filter::boundary']]], + ['constant2d_1845',['constant2d',['../namespacenc_1_1filter_1_1boundary.html#a0e0bd2ad1d6ac1b1d248175b9bc422f6',1,'nc::filter::boundary']]], + ['contains_1846',['contains',['../classnc_1_1_nd_array.html#ad0c493a734dbca9f622d0f7ca6dffbf4',1,'nc::NdArray::contains()'],['../namespacenc.html#a89349379637971764e6efe28ad8c1848',1,'nc::contains()']]], + ['convolve_1847',['convolve',['../namespacenc_1_1filter.html#abc4c77c759de3cd79f3fc02b7461d971',1,'nc::filter']]], + ['convolve1d_1848',['convolve1d',['../namespacenc_1_1filter.html#a21d48fecf984290cb5a4388d50371b13',1,'nc::filter']]], + ['coordinate_1849',['Coordinate',['../classnc_1_1coordinates_1_1_coordinate.html#a0f541169a4c318a5cf4fd0a50a4c2013',1,'nc::coordinates::Coordinate::Coordinate()=default'],['../classnc_1_1coordinates_1_1_coordinate.html#a983a167d97af973947f76474ab299ab8',1,'nc::coordinates::Coordinate::Coordinate(double inRaDegrees, double inDecDegrees)'],['../classnc_1_1coordinates_1_1_coordinate.html#a68eafc66dfeb8551fa7d8960f116be83',1,'nc::coordinates::Coordinate::Coordinate(uint8 inRaHours, uint8 inRaMinutes, double inRaSeconds, Sign inSign, uint8 inDecDegreesWhole, uint8 inDecMinutes, double inDecSeconds)'],['../classnc_1_1coordinates_1_1_coordinate.html#a7cf9e8138023ced7cfcb071299018fd5',1,'nc::coordinates::Coordinate::Coordinate(const RA &inRA, const Dec &inDec) noexcept'],['../classnc_1_1coordinates_1_1_coordinate.html#a35b32fa280c920d0b528472f7726a03d',1,'nc::coordinates::Coordinate::Coordinate(const NdArray< double > &inCartesianVector)'],['../classnc_1_1coordinates_1_1_coordinate.html#aa023b8b0e74159909e99aabcf778c57f',1,'nc::coordinates::Coordinate::Coordinate(double inX, double inY, double inZ) noexcept']]], + ['copy_1850',['copy',['../classnc_1_1_nd_array.html#a1f2d2aacc254129f36b0557a661e6664',1,'nc::NdArray::copy()'],['../namespacenc.html#a9bbe10d41fdbd74a6254bad44c7c7cf6',1,'nc::copy()'],['../namespacenc_1_1stl__algorithms.html#ae62a4e197ec640aacea520220bd27cef',1,'nc::stl_algorithms::copy()']]], + ['copysign_1851',['copySign',['../namespacenc.html#a9e08e770fd2283734390ab631edc250d',1,'nc']]], + ['copyto_1852',['copyto',['../namespacenc.html#af8eca852439098c1fff96384d88d82dd',1,'nc']]], + ['corrcoef_1853',['corrcoef',['../namespacenc.html#a2232014b014afca61e5ebe93c5ba2c0c',1,'nc']]], + ['cos_1854',['cos',['../namespacenc.html#a736de91eb8f79bfaf4dc92d7161f1c87',1,'nc::cos(dtype inValue) noexcept'],['../namespacenc.html#af208ae28fe0df17392ca128188cbcd73',1,'nc::cos(const NdArray< dtype > &inArray)']]], + ['cosh_1855',['cosh',['../namespacenc.html#abb07133a1f54b24a4a4986eefb5eda85',1,'nc::cosh(dtype inValue) noexcept'],['../namespacenc.html#a520e0290bb667b43a9f494b3858b5f17',1,'nc::cosh(const NdArray< dtype > &inArray)']]], + ['count_1856',['count',['../namespacenc_1_1stl__algorithms.html#a1fa02155befc0c39a853e66f6df26745',1,'nc::stl_algorithms']]], + ['count_5fnonzero_1857',['count_nonzero',['../namespacenc.html#aebb0dfe3637c07f6a9f6e4f08cacf515',1,'nc']]], + ['cov_1858',['cov',['../namespacenc.html#a61dbb6e2f778525a305dc235a9a43c76',1,'nc']]], + ['cov_5finv_1859',['cov_inv',['../namespacenc.html#a2a45ff9db0b44932844a5d9cb13b2d38',1,'nc']]], + ['crbegin_1860',['crbegin',['../classnc_1_1_nd_array.html#a95cbc4440ac1e139642a08cbd075dafc',1,'nc::NdArray::crbegin() const noexcept'],['../classnc_1_1_nd_array.html#af6b2581fae90a5c67e87df6a82ea13c5',1,'nc::NdArray::crbegin(size_type inRow) const']]], + ['crcolbegin_1861',['crcolbegin',['../classnc_1_1_nd_array.html#a8afdb68c11124e1fe0309204f3996435',1,'nc::NdArray::crcolbegin(size_type inCol) const'],['../classnc_1_1_nd_array.html#a35883ec844477b9bca2597939dd99c2a',1,'nc::NdArray::crcolbegin() const noexcept']]], + ['crcolend_1862',['crcolend',['../classnc_1_1_nd_array.html#a35b66f060b1ed99a6fb5247581fcb8fc',1,'nc::NdArray::crcolend(size_type inCol) const'],['../classnc_1_1_nd_array.html#a55e5d41795f14f7f2aa256ba0f4bb676',1,'nc::NdArray::crcolend() const noexcept']]], + ['crend_1863',['crend',['../classnc_1_1_nd_array.html#af3b4c48e3328a8dd22eedd27c225aeb5',1,'nc::NdArray::crend(size_type inRow) const'],['../classnc_1_1_nd_array.html#ac5d1c900c4db4263d1bf799ac3551ed6',1,'nc::NdArray::crend() const noexcept']]], + ['cross_1864',['cross',['../classnc_1_1_vec3.html#af8173f6e61e9a63beae3092fd8dc4378',1,'nc::Vec3::cross()'],['../namespacenc.html#a4d1ed581965ed53090824290def38565',1,'nc::cross()']]], + ['cslice_1865',['cSlice',['../classnc_1_1_nd_array.html#a29eabba849b35a3095cd341fa1c7b123',1,'nc::NdArray']]], + ['cube_1866',['cube',['../namespacenc.html#a5899ccef8410243438debea3d8296df6',1,'nc::cube(dtype inValue) noexcept'],['../namespacenc.html#a224d96b41af957c782c02f1cb25e66fd',1,'nc::cube(const NdArray< dtype > &inArray)'],['../namespacenc_1_1utils.html#a46e88717d4d32003bb449fd5cefd401c',1,'nc::utils::cube()']]], + ['cumprod_1867',['cumprod',['../classnc_1_1_nd_array.html#a75a231dec87e18370e9731214983858e',1,'nc::NdArray::cumprod()'],['../namespacenc.html#aafc4846f2f7956841d356060c9689cba',1,'nc::cumprod()']]], + ['cumsum_1868',['cumsum',['../classnc_1_1_nd_array.html#a4baa93f2a125d7665f3cdfd8d96d3acc',1,'nc::NdArray::cumsum()'],['../namespacenc.html#a2abc8c4a18823234e3baec64d10c0dcd',1,'nc::cumsum()']]], + ['cyclic_5fhankel_5f1_1869',['cyclic_hankel_1',['../namespacenc_1_1special.html#af5dd42de33ec77dda47dd089561895d5',1,'nc::special::cyclic_hankel_1(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#ae7053cd6eafb59a62ba6ede63aac6f90',1,'nc::special::cyclic_hankel_1(dtype1 inV, const NdArray< dtype2 > &inX)']]], + ['cyclic_5fhankel_5f2_1870',['cyclic_hankel_2',['../namespacenc_1_1special.html#a388472a49e89f21b3eb144368fe55664',1,'nc::special::cyclic_hankel_2(dtype1 inV, dtype2 inX)'],['../namespacenc_1_1special.html#a8e3b27238d1cae20e4ee071766549c5d',1,'nc::special::cyclic_hankel_2(dtype1 inV, const NdArray< dtype2 > &inX)']]] ]; diff --git a/docs/doxygen/html/search/functions_3.html b/docs/doxygen/html/search/functions_3.html index 756ecfee2..d79f55b8e 100644 --- a/docs/doxygen/html/search/functions_3.html +++ b/docs/doxygen/html/search/functions_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_3.js b/docs/doxygen/html/search/functions_3.js index 2ee1539b6..d6da54374 100644 --- a/docs/doxygen/html/search/functions_3.js +++ b/docs/doxygen/html/search/functions_3.js @@ -1,27 +1,29 @@ var searchData= [ - ['data_1789',['data',['../classnc_1_1_nd_array.html#a14e4541ae1e02ee5acdc01e18337d546',1,'nc::NdArray::data() const noexcept'],['../classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49',1,'nc::NdArray::data() noexcept']]], - ['datacube_1790',['DataCube',['../classnc_1_1_data_cube.html#a8224b613a7c87a16e06ef08d6f90926e',1,'nc::DataCube::DataCube()=default'],['../classnc_1_1_data_cube.html#a7ae08af82b0553d2b294286bdf06703b',1,'nc::DataCube::DataCube(uint32 inSize)']]], - ['datarelease_1791',['dataRelease',['../classnc_1_1_nd_array.html#ade07629d4094244f1dfca863af67e7c0',1,'nc::NdArray']]], - ['dec_1792',['dec',['../classnc_1_1coordinates_1_1_coordinate.html#ab5502c231ff400b90fc9ede39a524eed',1,'nc::coordinates::Coordinate']]], - ['dec_1793',['Dec',['../classnc_1_1coordinates_1_1_dec.html#af821e7394e5de4c396dd2c60aa7c0eca',1,'nc::coordinates::Dec::Dec()=default'],['../classnc_1_1coordinates_1_1_dec.html#a63de0ff17c7f842866893fdfacd0edb7',1,'nc::coordinates::Dec::Dec(double inDegrees)'],['../classnc_1_1coordinates_1_1_dec.html#af462329adb3a1bdb1f6b724e7a92a442',1,'nc::coordinates::Dec::Dec(Sign inSign, uint8 inDegrees, uint8 inMinutes, double inSeconds) noexcept']]], - ['deg2rad_1794',['deg2rad',['../namespacenc.html#a828388cb973b4e28e0b7060694e2604a',1,'nc::deg2rad(const NdArray< dtype > &inArray)'],['../namespacenc.html#a2cdc1c791ab98eb708ba5662ffb82b39',1,'nc::deg2rad(dtype inValue) noexcept']]], - ['degrees_1795',['degrees',['../namespacenc.html#a75c2b6b4713a5695a4738da25cf9d262',1,'nc::degrees(dtype inValue) noexcept'],['../namespacenc.html#aab0d24a5ffaf73330854bbcfc47d2fee',1,'nc::degrees(const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_dec.html#ad2e47ff7298e1b88bb1b77940c241c8f',1,'nc::coordinates::Dec::degrees()'],['../classnc_1_1coordinates_1_1_r_a.html#aaf73bcb5e2afd0e075c452148f67a3bd',1,'nc::coordinates::RA::degrees()']]], - ['degreeseperation_1796',['degreeSeperation',['../namespacenc_1_1coordinates.html#abc47b2d64d107bcb19ff696ecff89edf',1,'nc::coordinates::degreeSeperation(const NdArray< double > &inVector1, const NdArray< double > &inVector2)'],['../namespacenc_1_1coordinates.html#a06135e21507cfe2aa1cb4154fe1702bf',1,'nc::coordinates::degreeSeperation(const Coordinate &inCoordinate1, const Coordinate &inCoordinate2)'],['../classnc_1_1coordinates_1_1_coordinate.html#a9fd37a2cb2c3b45aee933e4e5f95d074',1,'nc::coordinates::Coordinate::degreeSeperation(const Coordinate &inOtherCoordinate) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a223ae10750fed3706997220e76f25c0d',1,'nc::coordinates::Coordinate::degreeSeperation(const NdArray< double > &inVector) const']]], - ['degreeswhole_1797',['degreesWhole',['../classnc_1_1coordinates_1_1_dec.html#abe36c8e081efa41452dc10ddd7ffcda7',1,'nc::coordinates::Dec']]], - ['dekker_1798',['Dekker',['../classnc_1_1roots_1_1_dekker.html#a77b88bb369da2d03d34717b7d8e0a2ab',1,'nc::roots::Dekker::Dekker(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_dekker.html#ab0a5db20e82cfd3ef95810ccb7d8c4e6',1,'nc::roots::Dekker::Dekker(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept']]], - ['deleteindices_1799',['deleteIndices',['../namespacenc.html#a53ddac04b49358cb41736640871bcea2',1,'nc::deleteIndices(const NdArray< dtype > &inArray, uint32 inIndex, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a7c33539e037218ba9b0b11acfae38363',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const Slice &inIndicesSlice, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ae59479b36cd7991d9dfc2d836b4d838c',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const NdArray< uint32 > &inArrayIdxs, Axis inAxis=Axis::NONE)']]], - ['deriv_1800',['deriv',['../classnc_1_1polynomial_1_1_poly1d.html#a06b9fb8a31de37a067c9ed54af6295d2',1,'nc::polynomial::Poly1d']]], - ['det_1801',['det',['../namespacenc_1_1linalg.html#a55bafcebbc897458164e8dc511b6119c',1,'nc::linalg']]], - ['diag_1802',['diag',['../namespacenc.html#a8c80cee3e4853bc79290c995cf9d69dc',1,'nc']]], - ['diagflat_1803',['diagflat',['../namespacenc.html#af3ab63d17fa40b3c3880a9065a95e47f',1,'nc']]], - ['diagonal_1804',['diagonal',['../namespacenc.html#a8eeb67e5ad2a5b0567570a774b7fb1f3',1,'nc::diagonal()'],['../classnc_1_1_nd_array.html#aae6a8845bf3654a27265ecffee163628',1,'nc::NdArray::diagonal()']]], - ['diff_1805',['diff',['../namespacenc.html#a94701ce8e9c8a4bb6dd162da5d07eadd',1,'nc']]], - ['digamma_1806',['digamma',['../namespacenc_1_1special.html#a6419633142287d898c551f99cd7c589d',1,'nc::special::digamma(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a78dead2375df379d1976ff87f62fbade',1,'nc::special::digamma(dtype inValue)']]], - ['discrete_1807',['discrete',['../namespacenc_1_1random.html#a2ea5db9ee73d9f7a633e5899e4be2c94',1,'nc::random::discrete(const NdArray< double > &inWeights)'],['../namespacenc_1_1random.html#ae5367b53538e888028853607e1c522a4',1,'nc::random::discrete(const Shape &inShape, const NdArray< double > &inWeights)']]], - ['distance_1808',['distance',['../classnc_1_1_vec2.html#a63c2b2b7a16828af770d38176b6cb3aa',1,'nc::Vec2::distance()'],['../classnc_1_1_vec3.html#a301f3edcb8cb17e7e3e5dbdd5255bdd2',1,'nc::Vec3::distance()']]], - ['divide_1809',['divide',['../namespacenc.html#a48c5c456736ced98b946e89b573c204e',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a85d01a50833bff37f13437cdd3e1a1a0',1,'nc::divide(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#aad734f111f1fc140c2c3c8fc84f398b5',1,'nc::divide(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#aed2d517035fdd5539971fa0c1dcb61df',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#ade8f0271af8c94c0a0e1166aba83a619',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a2389581759aa0446030642193638ef63',1,'nc::divide(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7d83e88182dd99da3ad09e76bb916a35',1,'nc::divide(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a130f8bc6ccdb70da4cfb245659bc61af',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a9b10ead8c068b9b473023c993dc25d7c',1,'nc::divide(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], - ['dot_1810',['dot',['../namespacenc.html#a2c9414f356ae2025a7cde3a192d6d67d',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#abfdbde62bdc084a9b8f9a894fa173c40',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a6ab78d4355c57b053b6e44f710d60528',1,'nc::dot(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../classnc_1_1_nd_array.html#acca065e13f826c504493a2eae31f5d0e',1,'nc::NdArray::dot()'],['../classnc_1_1_vec2.html#a231781cc06b8f005a1dda5003498ec99',1,'nc::Vec2::dot()'],['../classnc_1_1_vec3.html#ac9f2bf549a4b800f140de060a0281a7e',1,'nc::Vec3::dot()']]], - ['down_1811',['down',['../classnc_1_1_vec2.html#a265ae124776dd84b657c4ff6d7677352',1,'nc::Vec2::down()'],['../classnc_1_1_vec3.html#a4ea0c82948117391c6c42a99e3093f91',1,'nc::Vec3::down()']]], - ['dump_1812',['dump',['../classnc_1_1_data_cube.html#abbaa9ebba302183cae3563c9eb371ee3',1,'nc::DataCube::dump()'],['../namespacenc.html#af6e71bd96dbc78f9ca018d2da0a7e653',1,'nc::dump()'],['../classnc_1_1_nd_array.html#ada776db2a3c9ffef3dd7bf656cf75f08',1,'nc::NdArray::dump()']]] + ['data_1871',['data',['../classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49',1,'nc::NdArray::data() noexcept'],['../classnc_1_1_nd_array.html#a14e4541ae1e02ee5acdc01e18337d546',1,'nc::NdArray::data() const noexcept']]], + ['databitscovered_1872',['dataBitsCovered',['../namespacenc_1_1edac_1_1detail.html#aa8a14d5fd872ed0292631e57f5afe618',1,'nc::edac::detail']]], + ['datacube_1873',['DataCube',['../classnc_1_1_data_cube.html#a8224b613a7c87a16e06ef08d6f90926e',1,'nc::DataCube::DataCube()=default'],['../classnc_1_1_data_cube.html#a7ae08af82b0553d2b294286bdf06703b',1,'nc::DataCube::DataCube(uint32 inSize)']]], + ['datarelease_1874',['dataRelease',['../classnc_1_1_nd_array.html#ade07629d4094244f1dfca863af67e7c0',1,'nc::NdArray']]], + ['dec_1875',['dec',['../classnc_1_1coordinates_1_1_coordinate.html#ab5502c231ff400b90fc9ede39a524eed',1,'nc::coordinates::Coordinate']]], + ['dec_1876',['Dec',['../classnc_1_1coordinates_1_1_dec.html#af821e7394e5de4c396dd2c60aa7c0eca',1,'nc::coordinates::Dec::Dec()=default'],['../classnc_1_1coordinates_1_1_dec.html#a63de0ff17c7f842866893fdfacd0edb7',1,'nc::coordinates::Dec::Dec(double inDegrees)'],['../classnc_1_1coordinates_1_1_dec.html#af462329adb3a1bdb1f6b724e7a92a442',1,'nc::coordinates::Dec::Dec(Sign inSign, uint8 inDegrees, uint8 inMinutes, double inSeconds) noexcept']]], + ['decode_1877',['decode',['../namespacenc_1_1edac.html#aa24d4f99fd0739df7480845e96668e0f',1,'nc::edac']]], + ['deg2rad_1878',['deg2rad',['../namespacenc.html#a2cdc1c791ab98eb708ba5662ffb82b39',1,'nc::deg2rad(dtype inValue) noexcept'],['../namespacenc.html#a828388cb973b4e28e0b7060694e2604a',1,'nc::deg2rad(const NdArray< dtype > &inArray)']]], + ['degrees_1879',['degrees',['../classnc_1_1coordinates_1_1_dec.html#ad2e47ff7298e1b88bb1b77940c241c8f',1,'nc::coordinates::Dec::degrees()'],['../classnc_1_1coordinates_1_1_r_a.html#aaf73bcb5e2afd0e075c452148f67a3bd',1,'nc::coordinates::RA::degrees()'],['../namespacenc.html#aab0d24a5ffaf73330854bbcfc47d2fee',1,'nc::degrees(const NdArray< dtype > &inArray)'],['../namespacenc.html#a75c2b6b4713a5695a4738da25cf9d262',1,'nc::degrees(dtype inValue) noexcept']]], + ['degreeseperation_1880',['degreeSeperation',['../classnc_1_1coordinates_1_1_coordinate.html#a9fd37a2cb2c3b45aee933e4e5f95d074',1,'nc::coordinates::Coordinate::degreeSeperation(const Coordinate &inOtherCoordinate) const'],['../classnc_1_1coordinates_1_1_coordinate.html#a223ae10750fed3706997220e76f25c0d',1,'nc::coordinates::Coordinate::degreeSeperation(const NdArray< double > &inVector) const'],['../namespacenc_1_1coordinates.html#a06135e21507cfe2aa1cb4154fe1702bf',1,'nc::coordinates::degreeSeperation(const Coordinate &inCoordinate1, const Coordinate &inCoordinate2)'],['../namespacenc_1_1coordinates.html#abc47b2d64d107bcb19ff696ecff89edf',1,'nc::coordinates::degreeSeperation(const NdArray< double > &inVector1, const NdArray< double > &inVector2)']]], + ['degreeswhole_1881',['degreesWhole',['../classnc_1_1coordinates_1_1_dec.html#abe36c8e081efa41452dc10ddd7ffcda7',1,'nc::coordinates::Dec']]], + ['dekker_1882',['Dekker',['../classnc_1_1roots_1_1_dekker.html#a77b88bb369da2d03d34717b7d8e0a2ab',1,'nc::roots::Dekker::Dekker(const double epsilon, std::function< double(double)> f) noexcept'],['../classnc_1_1roots_1_1_dekker.html#ab0a5db20e82cfd3ef95810ccb7d8c4e6',1,'nc::roots::Dekker::Dekker(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f) noexcept']]], + ['deleteindices_1883',['deleteIndices',['../namespacenc.html#a53ddac04b49358cb41736640871bcea2',1,'nc::deleteIndices(const NdArray< dtype > &inArray, uint32 inIndex, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ae59479b36cd7991d9dfc2d836b4d838c',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const NdArray< uint32 > &inArrayIdxs, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a7c33539e037218ba9b0b11acfae38363',1,'nc::deleteIndices(const NdArray< dtype > &inArray, const Slice &inIndicesSlice, Axis inAxis=Axis::NONE)']]], + ['deriv_1884',['deriv',['../classnc_1_1polynomial_1_1_poly1d.html#a06b9fb8a31de37a067c9ed54af6295d2',1,'nc::polynomial::Poly1d']]], + ['det_1885',['det',['../namespacenc_1_1linalg.html#a55bafcebbc897458164e8dc511b6119c',1,'nc::linalg']]], + ['diag_1886',['diag',['../namespacenc.html#a8c80cee3e4853bc79290c995cf9d69dc',1,'nc']]], + ['diagflat_1887',['diagflat',['../namespacenc.html#af3ab63d17fa40b3c3880a9065a95e47f',1,'nc']]], + ['diagonal_1888',['diagonal',['../classnc_1_1_nd_array.html#aae6a8845bf3654a27265ecffee163628',1,'nc::NdArray::diagonal()'],['../namespacenc.html#a8eeb67e5ad2a5b0567570a774b7fb1f3',1,'nc::diagonal(const NdArray< dtype > &inArray, int32 inOffset=0, Axis inAxis=Axis::ROW)']]], + ['diff_1889',['diff',['../namespacenc.html#a94701ce8e9c8a4bb6dd162da5d07eadd',1,'nc']]], + ['digamma_1890',['digamma',['../namespacenc_1_1special.html#a6419633142287d898c551f99cd7c589d',1,'nc::special::digamma(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a78dead2375df379d1976ff87f62fbade',1,'nc::special::digamma(dtype inValue)']]], + ['discrete_1891',['discrete',['../namespacenc_1_1random.html#a2ea5db9ee73d9f7a633e5899e4be2c94',1,'nc::random::discrete(const NdArray< double > &inWeights)'],['../namespacenc_1_1random.html#ae5367b53538e888028853607e1c522a4',1,'nc::random::discrete(const Shape &inShape, const NdArray< double > &inWeights)']]], + ['distance_1892',['distance',['../classnc_1_1_vec2.html#a63c2b2b7a16828af770d38176b6cb3aa',1,'nc::Vec2::distance()'],['../classnc_1_1_vec3.html#a301f3edcb8cb17e7e3e5dbdd5255bdd2',1,'nc::Vec3::distance()']]], + ['divide_1893',['divide',['../namespacenc.html#a48c5c456736ced98b946e89b573c204e',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a85d01a50833bff37f13437cdd3e1a1a0',1,'nc::divide(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#aad734f111f1fc140c2c3c8fc84f398b5',1,'nc::divide(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#aed2d517035fdd5539971fa0c1dcb61df',1,'nc::divide(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#ade8f0271af8c94c0a0e1166aba83a619',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a2389581759aa0446030642193638ef63',1,'nc::divide(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a7d83e88182dd99da3ad09e76bb916a35',1,'nc::divide(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a130f8bc6ccdb70da4cfb245659bc61af',1,'nc::divide(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#a9b10ead8c068b9b473023c993dc25d7c',1,'nc::divide(dtype value, const NdArray< std::complex< dtype >> &inArray)']]], + ['dot_1894',['dot',['../classnc_1_1_nd_array.html#acca065e13f826c504493a2eae31f5d0e',1,'nc::NdArray::dot()'],['../classnc_1_1_vec2.html#a231781cc06b8f005a1dda5003498ec99',1,'nc::Vec2::dot()'],['../classnc_1_1_vec3.html#ac9f2bf549a4b800f140de060a0281a7e',1,'nc::Vec3::dot()'],['../namespacenc.html#a2c9414f356ae2025a7cde3a192d6d67d',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#abfdbde62bdc084a9b8f9a894fa173c40',1,'nc::dot(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a6ab78d4355c57b053b6e44f710d60528',1,'nc::dot(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)']]], + ['down_1895',['down',['../classnc_1_1_vec3.html#a4ea0c82948117391c6c42a99e3093f91',1,'nc::Vec3::down()'],['../classnc_1_1_vec2.html#a265ae124776dd84b657c4ff6d7677352',1,'nc::Vec2::down()']]], + ['dump_1896',['dump',['../classnc_1_1_nd_array.html#ada776db2a3c9ffef3dd7bf656cf75f08',1,'nc::NdArray::dump()'],['../classnc_1_1_data_cube.html#abbaa9ebba302183cae3563c9eb371ee3',1,'nc::DataCube::dump()'],['../namespacenc.html#af6e71bd96dbc78f9ca018d2da0a7e653',1,'nc::dump()']]] ]; diff --git a/docs/doxygen/html/search/functions_4.html b/docs/doxygen/html/search/functions_4.html index 52627379d..1657cad0d 100644 --- a/docs/doxygen/html/search/functions_4.html +++ b/docs/doxygen/html/search/functions_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_4.js b/docs/doxygen/html/search/functions_4.js index 55e4bbfb6..d2da440f2 100644 --- a/docs/doxygen/html/search/functions_4.js +++ b/docs/doxygen/html/search/functions_4.js @@ -1,29 +1,32 @@ var searchData= [ - ['ellint_5f1_1813',['ellint_1',['../namespacenc_1_1special.html#a0198bebbecba53e96b36d270be457490',1,'nc::special::ellint_1(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)'],['../namespacenc_1_1special.html#aa7fd769db69bde9583f039306c011816',1,'nc::special::ellint_1(dtype1 inK, dtype2 inP)']]], - ['ellint_5f2_1814',['ellint_2',['../namespacenc_1_1special.html#a920986b87a9c40529343491bebdadfe0',1,'nc::special::ellint_2(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)'],['../namespacenc_1_1special.html#ab9c4568493afa63db21d5b88f3c2a82d',1,'nc::special::ellint_2(dtype1 inK, dtype2 inP)']]], - ['ellint_5f3_1815',['ellint_3',['../namespacenc_1_1special.html#ab04eafe87336f4206d63b804dc8653ca',1,'nc::special::ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV, const NdArray< dtype3 > &inArrayP)'],['../namespacenc_1_1special.html#aaf7e9aa3cce2502f67735c787588a2eb',1,'nc::special::ellint_3(dtype1 inK, dtype2 inV, dtype3 inP)']]], - ['empty_1816',['empty',['../namespacenc.html#a3da6e6c01236f9c2af8591a890f7d717',1,'nc::empty(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a47dcd15b30a7fd2b977377ebb37cbdb6',1,'nc::empty(const Shape &inShape)']]], - ['empty_5flike_1817',['empty_like',['../namespacenc.html#ad03bf017e6cc91a4169134de885bb9ad',1,'nc']]], - ['end_1818',['end',['../classnc_1_1image_processing_1_1_cluster.html#afc8b5d168cf1d611be9f5226ec7efd55',1,'nc::imageProcessing::Cluster::end()'],['../classnc_1_1_data_cube.html#a9aeac78f9aec9b69b9673c1e56778b1b',1,'nc::DataCube::end()'],['../classnc_1_1_nd_array.html#a546c8b9de00188fab35a6c5075147cc1',1,'nc::NdArray::end(size_type inRow) const'],['../classnc_1_1_nd_array.html#a635448f7b5d598e3a978d2c2e62d7727',1,'nc::NdArray::end() const noexcept'],['../classnc_1_1_nd_array.html#a229701da7e9b386f5a58e5f1dc00bb73',1,'nc::NdArray::end(size_type inRow)'],['../classnc_1_1_nd_array.html#a153d3032d72c24d233407a351d0f8174',1,'nc::NdArray::end() noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a7d5ceccddb2db3b143c772ec9d66460a',1,'nc::imageProcessing::ClusterMaker::end()']]], - ['endianess_1819',['endianess',['../namespacenc.html#a6d1bce5e0cf3f24f84a50b945eec7a26',1,'nc::endianess()'],['../classnc_1_1_nd_array.html#a349b83beffbfb0a631799f921f13f7ad',1,'nc::NdArray::endianess()']]], - ['eod_1820',['eod',['../classnc_1_1image_processing_1_1_cluster.html#a461863af036452bdb1813dfff33c7c42',1,'nc::imageProcessing::Cluster::eod()'],['../classnc_1_1image_processing_1_1_centroid.html#a098ee235ea6fcf22df2a7a0d80d53e44',1,'nc::imageProcessing::Centroid::eod()']]], - ['epsilon_1821',['epsilon',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a01e23e6687e74de38a9799934aa94d69',1,'nc::DtypeInfo< std::complex< dtype > >::epsilon()'],['../classnc_1_1_dtype_info.html#a845cc6986a3912805ab68960bc2b2318',1,'nc::DtypeInfo::epsilon()']]], - ['equal_1822',['equal',['../namespacenc.html#a7440518ae70823ac15ea1711d8df7bfc',1,'nc::equal()'],['../namespacenc_1_1stl__algorithms.html#ab200b92040bf3da8ee4325f5a994e73d',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2) noexcept'],['../namespacenc_1_1stl__algorithms.html#a684d1011b375da4078afb4474a36b0e6',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, BinaryPredicate p) noexcept']]], - ['erf_1823',['erf',['../namespacenc_1_1special.html#a8b2da132f8a6d86ea0bcce34819d1833',1,'nc::special::erf(dtype inValue)'],['../namespacenc_1_1special.html#a5b7ac05949538787c3fdec373cb05126',1,'nc::special::erf(const NdArray< dtype > &inArray)']]], - ['erf_5finv_1824',['erf_inv',['../namespacenc_1_1special.html#a0f66785ec1e2643dd4c932ff7cae61a4',1,'nc::special::erf_inv(dtype inValue)'],['../namespacenc_1_1special.html#abab69146b99ff384c6de4a24da69a780',1,'nc::special::erf_inv(const NdArray< dtype > &inArray)']]], - ['erfc_1825',['erfc',['../namespacenc_1_1special.html#a8671b7ab0e06230889f4a0cf417a248f',1,'nc::special::erfc(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a1673dca59c73c85eedf077fb62aab5d7',1,'nc::special::erfc(dtype inValue)']]], - ['erfc_5finv_1826',['erfc_inv',['../namespacenc_1_1special.html#a3c9551b639e79ce3024fef298f4ace8c',1,'nc::special::erfc_inv(const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a653404a544d777c6d7d636a207ee7bca',1,'nc::special::erfc_inv(dtype inValue)']]], - ['essentiallyequal_1827',['essentiallyEqual',['../namespacenc_1_1utils.html#a139da62fc9c51ae191e7451bb4edb706',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2) noexcept'],['../namespacenc_1_1utils.html#aedd8afd691cf9f5a8f8e12c9ca33743a',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2, dtype inEpsilon) noexcept'],['../namespacenc_1_1utils.html#a963b90e7c9a3b057a924298750ddf74c',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc_1_1utils.html#a7e935ef90aaa774b37e6ab4b5316e01f',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2, const std::complex< dtype > &inEpsilon) noexcept']]], - ['eulerangles_1828',['eulerAngles',['../classnc_1_1rotations_1_1_d_c_m.html#a75a392cc2db9f9fdcfd8e212d152c9ff',1,'nc::rotations::DCM::eulerAngles(double roll, double pitch, double yaw)'],['../classnc_1_1rotations_1_1_d_c_m.html#a7ad5acfeac4205b7ee348332cb7aeadd',1,'nc::rotations::DCM::eulerAngles(const NdArray< double > &angles)']]], - ['euleraxisangle_1829',['eulerAxisAngle',['../classnc_1_1rotations_1_1_d_c_m.html#aeb6400855cfc4163e09f03b101fe2d92',1,'nc::rotations::DCM::eulerAxisAngle(const NdArray< double > &inAxis, double inAngle)'],['../classnc_1_1rotations_1_1_d_c_m.html#a4da503d407f8ad563ec41364ff5b3b43',1,'nc::rotations::DCM::eulerAxisAngle(const Vec3 &inAxis, double inAngle)']]], - ['exists_1830',['exists',['../classnc_1_1filesystem_1_1_file.html#a9a9b7d3f9505b025038e16a469553515',1,'nc::filesystem::File']]], - ['exp_1831',['exp',['../namespacenc.html#ad7e555d480465930a7ac44f4ab39eea7',1,'nc::exp(dtype inValue) noexcept'],['../namespacenc.html#a4069791fefff15148813bbbbadf064b1',1,'nc::exp(const NdArray< dtype > &inArray)']]], - ['exp2_1832',['exp2',['../namespacenc.html#aafbab1d2bd67c753fb1656e037bd8b1d',1,'nc::exp2(dtype inValue) noexcept'],['../namespacenc.html#a0595c87603ad5c35ddc78eab15148db7',1,'nc::exp2(const NdArray< dtype > &inArray)']]], - ['expint_1833',['expint',['../namespacenc_1_1special.html#a23097c9d953be37f1399154274ba2ff1',1,'nc::special::expint(dtype inX)'],['../namespacenc_1_1special.html#a98e6e3ad00faf7aef9f90e1c187f49b0',1,'nc::special::expint(const NdArray< dtype > &inArrayX)']]], - ['expm1_1834',['expm1',['../namespacenc.html#a1f8b7ba3bb64b868fc41508d6912afab',1,'nc::expm1(dtype inValue) noexcept'],['../namespacenc.html#ac1e31d2bff523a5936799445f16d11af',1,'nc::expm1(const NdArray< dtype > &inArray)']]], - ['exponential_1835',['exponential',['../namespacenc_1_1random.html#a278212d1b177cb2bba47215d083bb10f',1,'nc::random::exponential(dtype inScaleValue=1)'],['../namespacenc_1_1random.html#a5d71db2fa4d818d737554405776d2aea',1,'nc::random::exponential(const Shape &inShape, dtype inScaleValue=1)']]], - ['ext_1836',['ext',['../classnc_1_1filesystem_1_1_file.html#ac51df5a278a9b6045d6f241766c10483',1,'nc::filesystem::File']]], - ['extremevalue_1837',['extremeValue',['../namespacenc_1_1random.html#a11144426dec05283d6c682e0e532af7e',1,'nc::random::extremeValue(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#a6a5f569b594585794e6b268576d2e587',1,'nc::random::extremeValue(const Shape &inShape, dtype inA=1, dtype inB=1)']]], - ['eye_1838',['eye',['../namespacenc.html#a944a26b6ffe66b39ab9ba6972906bf55',1,'nc::eye(uint32 inN, uint32 inM, int32 inK=0)'],['../namespacenc.html#a1af40ed299fe04e075ca80d0d00dfba0',1,'nc::eye(uint32 inN, int32 inK=0)'],['../namespacenc.html#aa5328556ac755d5aafbe0f0e5d0c7af3',1,'nc::eye(const Shape &inShape, int32 inK=0)']]] + ['ellint_5f1_1897',['ellint_1',['../namespacenc_1_1special.html#aa7fd769db69bde9583f039306c011816',1,'nc::special::ellint_1(dtype1 inK, dtype2 inP)'],['../namespacenc_1_1special.html#a0198bebbecba53e96b36d270be457490',1,'nc::special::ellint_1(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)']]], + ['ellint_5f2_1898',['ellint_2',['../namespacenc_1_1special.html#ab9c4568493afa63db21d5b88f3c2a82d',1,'nc::special::ellint_2(dtype1 inK, dtype2 inP)'],['../namespacenc_1_1special.html#a920986b87a9c40529343491bebdadfe0',1,'nc::special::ellint_2(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayP)']]], + ['ellint_5f3_1899',['ellint_3',['../namespacenc_1_1special.html#ab04eafe87336f4206d63b804dc8653ca',1,'nc::special::ellint_3(const NdArray< dtype1 > &inArrayK, const NdArray< dtype2 > &inArrayV, const NdArray< dtype3 > &inArrayP)'],['../namespacenc_1_1special.html#aaf7e9aa3cce2502f67735c787588a2eb',1,'nc::special::ellint_3(dtype1 inK, dtype2 inV, dtype3 inP)']]], + ['empty_1900',['empty',['../namespacenc.html#a3da6e6c01236f9c2af8591a890f7d717',1,'nc::empty(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a47dcd15b30a7fd2b977377ebb37cbdb6',1,'nc::empty(const Shape &inShape)']]], + ['empty_5flike_1901',['empty_like',['../namespacenc.html#ad03bf017e6cc91a4169134de885bb9ad',1,'nc']]], + ['encode_1902',['encode',['../namespacenc_1_1edac.html#af5c36a1f2c74d632192cf9fe29cc5f03',1,'nc::edac']]], + ['end_1903',['end',['../classnc_1_1_data_cube.html#a9aeac78f9aec9b69b9673c1e56778b1b',1,'nc::DataCube::end()'],['../classnc_1_1image_processing_1_1_cluster.html#afc8b5d168cf1d611be9f5226ec7efd55',1,'nc::imageProcessing::Cluster::end()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a7d5ceccddb2db3b143c772ec9d66460a',1,'nc::imageProcessing::ClusterMaker::end()'],['../classnc_1_1_nd_array.html#a153d3032d72c24d233407a351d0f8174',1,'nc::NdArray::end() noexcept'],['../classnc_1_1_nd_array.html#a229701da7e9b386f5a58e5f1dc00bb73',1,'nc::NdArray::end(size_type inRow)'],['../classnc_1_1_nd_array.html#a635448f7b5d598e3a978d2c2e62d7727',1,'nc::NdArray::end() const noexcept'],['../classnc_1_1_nd_array.html#a546c8b9de00188fab35a6c5075147cc1',1,'nc::NdArray::end(size_type inRow) const']]], + ['endianess_1904',['endianess',['../classnc_1_1_nd_array.html#a349b83beffbfb0a631799f921f13f7ad',1,'nc::NdArray::endianess()'],['../namespacenc.html#a6d1bce5e0cf3f24f84a50b945eec7a26',1,'nc::endianess()']]], + ['eod_1905',['eod',['../classnc_1_1image_processing_1_1_centroid.html#a098ee235ea6fcf22df2a7a0d80d53e44',1,'nc::imageProcessing::Centroid::eod()'],['../classnc_1_1image_processing_1_1_cluster.html#a461863af036452bdb1813dfff33c7c42',1,'nc::imageProcessing::Cluster::eod()']]], + ['epsilon_1906',['epsilon',['../classnc_1_1_dtype_info.html#a845cc6986a3912805ab68960bc2b2318',1,'nc::DtypeInfo::epsilon()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a01e23e6687e74de38a9799934aa94d69',1,'nc::DtypeInfo< std::complex< dtype > >::epsilon()']]], + ['equal_1907',['equal',['../namespacenc_1_1stl__algorithms.html#ab200b92040bf3da8ee4325f5a994e73d',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2) noexcept'],['../namespacenc_1_1stl__algorithms.html#a684d1011b375da4078afb4474a36b0e6',1,'nc::stl_algorithms::equal(InputIt1 first1, InputIt1 last1, InputIt2 first2, BinaryPredicate p) noexcept'],['../namespacenc.html#a7440518ae70823ac15ea1711d8df7bfc',1,'nc::equal()']]], + ['erf_1908',['erf',['../namespacenc_1_1special.html#a8b2da132f8a6d86ea0bcce34819d1833',1,'nc::special::erf(dtype inValue)'],['../namespacenc_1_1special.html#a5b7ac05949538787c3fdec373cb05126',1,'nc::special::erf(const NdArray< dtype > &inArray)']]], + ['erf_5finv_1909',['erf_inv',['../namespacenc_1_1special.html#a0f66785ec1e2643dd4c932ff7cae61a4',1,'nc::special::erf_inv(dtype inValue)'],['../namespacenc_1_1special.html#abab69146b99ff384c6de4a24da69a780',1,'nc::special::erf_inv(const NdArray< dtype > &inArray)']]], + ['erfc_1910',['erfc',['../namespacenc_1_1special.html#a1673dca59c73c85eedf077fb62aab5d7',1,'nc::special::erfc(dtype inValue)'],['../namespacenc_1_1special.html#a8671b7ab0e06230889f4a0cf417a248f',1,'nc::special::erfc(const NdArray< dtype > &inArray)']]], + ['erfc_5finv_1911',['erfc_inv',['../namespacenc_1_1special.html#a653404a544d777c6d7d636a207ee7bca',1,'nc::special::erfc_inv(dtype inValue)'],['../namespacenc_1_1special.html#a3c9551b639e79ce3024fef298f4ace8c',1,'nc::special::erfc_inv(const NdArray< dtype > &inArray)']]], + ['essentiallyequal_1912',['essentiallyEqual',['../namespacenc_1_1utils.html#a7e935ef90aaa774b37e6ab4b5316e01f',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2, const std::complex< dtype > &inEpsilon) noexcept'],['../namespacenc_1_1utils.html#a963b90e7c9a3b057a924298750ddf74c',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc_1_1utils.html#aedd8afd691cf9f5a8f8e12c9ca33743a',1,'nc::utils::essentiallyEqual(dtype inValue1, dtype inValue2, dtype inEpsilon) noexcept'],['../namespacenc_1_1utils.html#a139da62fc9c51ae191e7451bb4edb706',1,'nc::utils::essentiallyEqual(const std::complex< dtype > &inValue1, const std::complex< dtype > &inValue2) noexcept']]], + ['eulerangles_1913',['eulerAngles',['../classnc_1_1rotations_1_1_d_c_m.html#a7ad5acfeac4205b7ee348332cb7aeadd',1,'nc::rotations::DCM::eulerAngles(const NdArray< double > &angles)'],['../classnc_1_1rotations_1_1_d_c_m.html#a75a392cc2db9f9fdcfd8e212d152c9ff',1,'nc::rotations::DCM::eulerAngles(double roll, double pitch, double yaw)']]], + ['euleraxisangle_1914',['eulerAxisAngle',['../classnc_1_1rotations_1_1_d_c_m.html#aeb6400855cfc4163e09f03b101fe2d92',1,'nc::rotations::DCM::eulerAxisAngle(const NdArray< double > &inAxis, double inAngle)'],['../classnc_1_1rotations_1_1_d_c_m.html#a4da503d407f8ad563ec41364ff5b3b43',1,'nc::rotations::DCM::eulerAxisAngle(const Vec3 &inAxis, double inAngle)']]], + ['exists_1915',['exists',['../classnc_1_1filesystem_1_1_file.html#a9a9b7d3f9505b025038e16a469553515',1,'nc::filesystem::File']]], + ['exp_1916',['exp',['../namespacenc.html#ad7e555d480465930a7ac44f4ab39eea7',1,'nc::exp(dtype inValue) noexcept'],['../namespacenc.html#a4069791fefff15148813bbbbadf064b1',1,'nc::exp(const NdArray< dtype > &inArray)']]], + ['exp2_1917',['exp2',['../namespacenc.html#aafbab1d2bd67c753fb1656e037bd8b1d',1,'nc::exp2(dtype inValue) noexcept'],['../namespacenc.html#a0595c87603ad5c35ddc78eab15148db7',1,'nc::exp2(const NdArray< dtype > &inArray)']]], + ['expint_1918',['expint',['../namespacenc_1_1special.html#a23097c9d953be37f1399154274ba2ff1',1,'nc::special::expint(dtype inX)'],['../namespacenc_1_1special.html#a98e6e3ad00faf7aef9f90e1c187f49b0',1,'nc::special::expint(const NdArray< dtype > &inArrayX)']]], + ['expm1_1919',['expm1',['../namespacenc.html#a1f8b7ba3bb64b868fc41508d6912afab',1,'nc::expm1(dtype inValue) noexcept'],['../namespacenc.html#ac1e31d2bff523a5936799445f16d11af',1,'nc::expm1(const NdArray< dtype > &inArray)']]], + ['exponential_1920',['exponential',['../namespacenc_1_1random.html#a278212d1b177cb2bba47215d083bb10f',1,'nc::random::exponential(dtype inScaleValue=1)'],['../namespacenc_1_1random.html#a5d71db2fa4d818d737554405776d2aea',1,'nc::random::exponential(const Shape &inShape, dtype inScaleValue=1)']]], + ['ext_1921',['ext',['../classnc_1_1filesystem_1_1_file.html#ac51df5a278a9b6045d6f241766c10483',1,'nc::filesystem::File']]], + ['extract_1922',['extract',['../namespacenc.html#af75594a13a627d4b014cf04749324571',1,'nc']]], + ['extractdata_1923',['extractData',['../namespacenc_1_1edac_1_1detail.html#a1c606c3f9302bb406021a50006898ebf',1,'nc::edac::detail']]], + ['extremevalue_1924',['extremeValue',['../namespacenc_1_1random.html#a11144426dec05283d6c682e0e532af7e',1,'nc::random::extremeValue(dtype inA=1, dtype inB=1)'],['../namespacenc_1_1random.html#a6a5f569b594585794e6b268576d2e587',1,'nc::random::extremeValue(const Shape &inShape, dtype inA=1, dtype inB=1)']]], + ['eye_1925',['eye',['../namespacenc.html#a944a26b6ffe66b39ab9ba6972906bf55',1,'nc::eye(uint32 inN, uint32 inM, int32 inK=0)'],['../namespacenc.html#a1af40ed299fe04e075ca80d0d00dfba0',1,'nc::eye(uint32 inN, int32 inK=0)'],['../namespacenc.html#aa5328556ac755d5aafbe0f0e5d0c7af3',1,'nc::eye(const Shape &inShape, int32 inK=0)']]] ]; diff --git a/docs/doxygen/html/search/functions_5.html b/docs/doxygen/html/search/functions_5.html index 85004f8b3..9301d6b9c 100644 --- a/docs/doxygen/html/search/functions_5.html +++ b/docs/doxygen/html/search/functions_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_5.js b/docs/doxygen/html/search/functions_5.js index 5d4717972..dca0cbc16 100644 --- a/docs/doxygen/html/search/functions_5.js +++ b/docs/doxygen/html/search/functions_5.js @@ -1,31 +1,31 @@ var searchData= [ - ['f_1839',['f',['../namespacenc_1_1random.html#a00229c23da25284daf436c0a338ea25c',1,'nc::random::f(dtype inDofN, dtype inDofD)'],['../namespacenc_1_1random.html#aabf17da1f94e6da4ec99085feca10799',1,'nc::random::f(const Shape &inShape, dtype inDofN, dtype inDofD)']]], - ['factorial_1840',['factorial',['../namespacenc_1_1special.html#a7ab9b16b9bcb43038db57b7d21a90304',1,'nc::special::factorial(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a429b2caa6cf7fcbdba8ce3184c0367e3',1,'nc::special::factorial(uint32 inValue)']]], - ['file_1841',['File',['../classnc_1_1filesystem_1_1_file.html#aa27dc231895f81412af1d8206b5496dd',1,'nc::filesystem::File']]], - ['fill_1842',['fill',['../classnc_1_1_nd_array.html#a646ec787a3b7331b34c0c3f21e0d992d',1,'nc::NdArray::fill()'],['../namespacenc_1_1stl__algorithms.html#af9a01fcb79e7a69b707081c1c17f361c',1,'nc::stl_algorithms::fill()']]], - ['fillcorners_1843',['fillCorners',['../namespacenc_1_1filter_1_1boundary.html#ac2c4c5858898760f48e5aba06ad0eb3c',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth, dtype inFillValue)'],['../namespacenc_1_1filter_1_1boundary.html#ac78b1c70b5d7e26d6013674cdb84690a',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth)']]], - ['filldiagonal_1844',['fillDiagonal',['../namespacenc.html#a7c40717fa80c513ecbb943859d9d1ac2',1,'nc']]], - ['find_1845',['find',['../namespacenc.html#a8eaa82071f16b2654f11096247ba10e5',1,'nc::find()'],['../namespacenc_1_1stl__algorithms.html#a761aa9f3bd88f019c46fe6cece93ade2',1,'nc::stl_algorithms::find()']]], - ['fit_1846',['fit',['../classnc_1_1polynomial_1_1_poly1d.html#abd9c3ff549505b8c42b4a4e97ff95b2c',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, uint8 polyOrder)'],['../classnc_1_1polynomial_1_1_poly1d.html#a1526585db421bbf96dfb88d99870c201',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, const NdArray< dtype > &weights, uint8 polyOrder)']]], - ['fix_1847',['fix',['../namespacenc.html#aa2d5bc309911a5c6a79324691cf7ea27',1,'nc::fix(const NdArray< dtype > &inArray)'],['../namespacenc.html#af259d081804c4be2d33e3a00e937b79c',1,'nc::fix(dtype inValue) noexcept']]], - ['flatnonzero_1848',['flatnonzero',['../classnc_1_1_nd_array.html#a91687e040d05ac06b389d389facff3c9',1,'nc::NdArray::flatnonzero()'],['../namespacenc.html#a1564bf5bf94b5a6d8b55850e2a956407',1,'nc::flatnonzero(const NdArray< dtype > &inArray)']]], - ['flatten_1849',['flatten',['../namespacenc.html#ae968142455e50b994f534186693934dd',1,'nc::flatten()'],['../classnc_1_1_nd_array.html#a22ba05b8e537c008a2143396b5995551',1,'nc::NdArray::flatten()']]], - ['flip_1850',['flip',['../namespacenc.html#ab17a2f12bb2bea50a74c2ed41b30fdb2',1,'nc']]], - ['fliplr_1851',['fliplr',['../namespacenc.html#ae316eb25ff89e7999a24221c91f8d395',1,'nc']]], - ['flipud_1852',['flipud',['../namespacenc.html#a0241fc364ae8002c42cd4d452c897e26',1,'nc']]], - ['floor_1853',['floor',['../namespacenc.html#a85531048cade0ac3a1b4e8d6e01ff6fe',1,'nc::floor(const NdArray< dtype > &inArray)'],['../namespacenc.html#a832da7fc615ea4e1da7bed94a4488ea6',1,'nc::floor(dtype inValue) noexcept']]], - ['floor_5fdivide_1854',['floor_divide',['../namespacenc.html#ae8e2b2ae79d7a56eefd11986a6de9b21',1,'nc::floor_divide(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ab299e0245c7a703a9506ce6f39d9d8e4',1,'nc::floor_divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['fmax_1855',['fmax',['../namespacenc.html#aebbd1fbc64f00fdeaae6c8cfdf6a7f59',1,'nc::fmax(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a99c7f7c680632be6a42ebd6b923df328',1,'nc::fmax(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['fmin_1856',['fmin',['../namespacenc.html#a7cd8e4c771d0676279f506f9d7e949e0',1,'nc::fmin(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#add4b4f64b2991ac90b24c93ce10a2b80',1,'nc::fmin(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['fmod_1857',['fmod',['../namespacenc.html#a4208e3d02b9bc915767eab689c64b30f',1,'nc::fmod(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a87bf4f8636ec0237d958c2ec1d9f1a89',1,'nc::fmod(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['for_5feach_1858',['for_each',['../namespacenc_1_1stl__algorithms.html#a734698435eabdbc5bdf93b195d7fb6a7',1,'nc::stl_algorithms']]], - ['forward_1859',['forward',['../classnc_1_1_vec3.html#ac5a33c96c05a8c856b774c24f4a1965d',1,'nc::Vec3']]], - ['frombuffer_1860',['frombuffer',['../namespacenc.html#ac0d91788bdc0924b82e9a38302d71316',1,'nc']]], - ['fromfile_1861',['fromfile',['../namespacenc.html#a1f10b3d839d24d71df9c92e3f9794a14',1,'nc::fromfile(const std::string &inFilename)'],['../namespacenc.html#aa344c64ebbe94231d377f99775606c68',1,'nc::fromfile(const std::string &inFilename, const char inSep)']]], - ['fromiter_1862',['fromiter',['../namespacenc.html#a17c629bae4e06fe95b23d2b5799148f0',1,'nc']]], - ['front_1863',['front',['../classnc_1_1_nd_array.html#aacff9537c7c8537583b70115626a420b',1,'nc::NdArray::front()'],['../classnc_1_1_data_cube.html#a398373aeb2f3c9dd8df78f9eac1ca3d9',1,'nc::DataCube::front()'],['../classnc_1_1_nd_array.html#a7c17d60541d81f71107c5dc0a06885ac',1,'nc::NdArray::front() const noexcept'],['../classnc_1_1_nd_array.html#a823d56e88aa815d86d41e8b11d348a6a',1,'nc::NdArray::front() noexcept'],['../classnc_1_1_nd_array.html#a42b713a59eac4e9df2ea3b2e584a80f1',1,'nc::NdArray::front(size_type row) const']]], - ['full_1864',['full',['../namespacenc.html#a139698e3756d4cb9b021c9d97e200bda',1,'nc::full(uint32 inSquareSize, dtype inFillValue)'],['../namespacenc.html#a64e56324bce64094973a2da35548178d',1,'nc::full(uint32 inNumRows, uint32 inNumCols, dtype inFillValue)'],['../namespacenc.html#ac09334ce9ac6c4c140bbae68e8ce1a6c',1,'nc::full(const Shape &inShape, dtype inFillValue)']]], - ['full_5flike_1865',['full_like',['../namespacenc.html#ad7e958219ad5b01b015edaf725eb4b7a',1,'nc']]], - ['fullname_1866',['fullName',['../classnc_1_1filesystem_1_1_file.html#a0f3f9b0e15d7cd007ae2b8a808f74799',1,'nc::filesystem::File']]] + ['f_1926',['f',['../namespacenc_1_1random.html#a00229c23da25284daf436c0a338ea25c',1,'nc::random::f(dtype inDofN, dtype inDofD)'],['../namespacenc_1_1random.html#aabf17da1f94e6da4ec99085feca10799',1,'nc::random::f(const Shape &inShape, dtype inDofN, dtype inDofD)']]], + ['factorial_1927',['factorial',['../namespacenc_1_1special.html#a429b2caa6cf7fcbdba8ce3184c0367e3',1,'nc::special::factorial(uint32 inValue)'],['../namespacenc_1_1special.html#a7ab9b16b9bcb43038db57b7d21a90304',1,'nc::special::factorial(const NdArray< uint32 > &inArray)']]], + ['file_1928',['File',['../classnc_1_1filesystem_1_1_file.html#aa27dc231895f81412af1d8206b5496dd',1,'nc::filesystem::File']]], + ['fill_1929',['fill',['../classnc_1_1_nd_array.html#a646ec787a3b7331b34c0c3f21e0d992d',1,'nc::NdArray::fill()'],['../namespacenc_1_1stl__algorithms.html#af9a01fcb79e7a69b707081c1c17f361c',1,'nc::stl_algorithms::fill()']]], + ['fillcorners_1930',['fillCorners',['../namespacenc_1_1filter_1_1boundary.html#ac78b1c70b5d7e26d6013674cdb84690a',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth)'],['../namespacenc_1_1filter_1_1boundary.html#ac2c4c5858898760f48e5aba06ad0eb3c',1,'nc::filter::boundary::fillCorners(NdArray< dtype > &inArray, uint32 inBorderWidth, dtype inFillValue)']]], + ['filldiagonal_1931',['fillDiagonal',['../namespacenc.html#a7c40717fa80c513ecbb943859d9d1ac2',1,'nc']]], + ['find_1932',['find',['../namespacenc_1_1stl__algorithms.html#a761aa9f3bd88f019c46fe6cece93ade2',1,'nc::stl_algorithms::find()'],['../namespacenc.html#a8eaa82071f16b2654f11096247ba10e5',1,'nc::find()']]], + ['fit_1933',['fit',['../classnc_1_1polynomial_1_1_poly1d.html#abd9c3ff549505b8c42b4a4e97ff95b2c',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, uint8 polyOrder)'],['../classnc_1_1polynomial_1_1_poly1d.html#a1526585db421bbf96dfb88d99870c201',1,'nc::polynomial::Poly1d::fit(const NdArray< dtype > &xValues, const NdArray< dtype > &yValues, const NdArray< dtype > &weights, uint8 polyOrder)']]], + ['fix_1934',['fix',['../namespacenc.html#aa2d5bc309911a5c6a79324691cf7ea27',1,'nc::fix(const NdArray< dtype > &inArray)'],['../namespacenc.html#af259d081804c4be2d33e3a00e937b79c',1,'nc::fix(dtype inValue) noexcept']]], + ['flatnonzero_1935',['flatnonzero',['../classnc_1_1_nd_array.html#a91687e040d05ac06b389d389facff3c9',1,'nc::NdArray::flatnonzero()'],['../namespacenc.html#a1564bf5bf94b5a6d8b55850e2a956407',1,'nc::flatnonzero()']]], + ['flatten_1936',['flatten',['../classnc_1_1_nd_array.html#a22ba05b8e537c008a2143396b5995551',1,'nc::NdArray::flatten()'],['../namespacenc.html#ae968142455e50b994f534186693934dd',1,'nc::flatten(const NdArray< dtype > &inArray)']]], + ['flip_1937',['flip',['../namespacenc.html#ab17a2f12bb2bea50a74c2ed41b30fdb2',1,'nc']]], + ['fliplr_1938',['fliplr',['../namespacenc.html#ae316eb25ff89e7999a24221c91f8d395',1,'nc']]], + ['flipud_1939',['flipud',['../namespacenc.html#a0241fc364ae8002c42cd4d452c897e26',1,'nc']]], + ['floor_1940',['floor',['../namespacenc.html#a832da7fc615ea4e1da7bed94a4488ea6',1,'nc::floor(dtype inValue) noexcept'],['../namespacenc.html#a85531048cade0ac3a1b4e8d6e01ff6fe',1,'nc::floor(const NdArray< dtype > &inArray)']]], + ['floor_5fdivide_1941',['floor_divide',['../namespacenc.html#ae8e2b2ae79d7a56eefd11986a6de9b21',1,'nc::floor_divide(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ab299e0245c7a703a9506ce6f39d9d8e4',1,'nc::floor_divide(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['fmax_1942',['fmax',['../namespacenc.html#aebbd1fbc64f00fdeaae6c8cfdf6a7f59',1,'nc::fmax(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a99c7f7c680632be6a42ebd6b923df328',1,'nc::fmax(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['fmin_1943',['fmin',['../namespacenc.html#a7cd8e4c771d0676279f506f9d7e949e0',1,'nc::fmin(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#add4b4f64b2991ac90b24c93ce10a2b80',1,'nc::fmin(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['fmod_1944',['fmod',['../namespacenc.html#a6894e06b913479ce699cba7dbce5bc93',1,'nc::fmod(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a87bf4f8636ec0237d958c2ec1d9f1a89',1,'nc::fmod(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], + ['for_5feach_1945',['for_each',['../namespacenc_1_1stl__algorithms.html#a734698435eabdbc5bdf93b195d7fb6a7',1,'nc::stl_algorithms']]], + ['forward_1946',['forward',['../classnc_1_1_vec3.html#ac5a33c96c05a8c856b774c24f4a1965d',1,'nc::Vec3']]], + ['frombuffer_1947',['frombuffer',['../namespacenc.html#ac0d91788bdc0924b82e9a38302d71316',1,'nc']]], + ['fromfile_1948',['fromfile',['../namespacenc.html#a1f10b3d839d24d71df9c92e3f9794a14',1,'nc::fromfile(const std::string &inFilename)'],['../namespacenc.html#aa344c64ebbe94231d377f99775606c68',1,'nc::fromfile(const std::string &inFilename, const char inSep)']]], + ['fromiter_1949',['fromiter',['../namespacenc.html#a17c629bae4e06fe95b23d2b5799148f0',1,'nc']]], + ['front_1950',['front',['../classnc_1_1_nd_array.html#a7c17d60541d81f71107c5dc0a06885ac',1,'nc::NdArray::front()'],['../classnc_1_1_data_cube.html#a398373aeb2f3c9dd8df78f9eac1ca3d9',1,'nc::DataCube::front()'],['../classnc_1_1_nd_array.html#aacff9537c7c8537583b70115626a420b',1,'nc::NdArray::front(size_type row)'],['../classnc_1_1_nd_array.html#a42b713a59eac4e9df2ea3b2e584a80f1',1,'nc::NdArray::front(size_type row) const'],['../classnc_1_1_nd_array.html#a823d56e88aa815d86d41e8b11d348a6a',1,'nc::NdArray::front() noexcept']]], + ['full_1951',['full',['../namespacenc.html#a139698e3756d4cb9b021c9d97e200bda',1,'nc::full(uint32 inSquareSize, dtype inFillValue)'],['../namespacenc.html#a64e56324bce64094973a2da35548178d',1,'nc::full(uint32 inNumRows, uint32 inNumCols, dtype inFillValue)'],['../namespacenc.html#ac09334ce9ac6c4c140bbae68e8ce1a6c',1,'nc::full(const Shape &inShape, dtype inFillValue)']]], + ['full_5flike_1952',['full_like',['../namespacenc.html#ad7e958219ad5b01b015edaf725eb4b7a',1,'nc']]], + ['fullname_1953',['fullName',['../classnc_1_1filesystem_1_1_file.html#a0f3f9b0e15d7cd007ae2b8a808f74799',1,'nc::filesystem::File']]] ]; diff --git a/docs/doxygen/html/search/functions_6.html b/docs/doxygen/html/search/functions_6.html index 0c2200fe0..9c4f5fc65 100644 --- a/docs/doxygen/html/search/functions_6.html +++ b/docs/doxygen/html/search/functions_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_6.js b/docs/doxygen/html/search/functions_6.js index 1ba066f6a..1190383f8 100644 --- a/docs/doxygen/html/search/functions_6.js +++ b/docs/doxygen/html/search/functions_6.js @@ -1,22 +1,23 @@ var searchData= [ - ['gamma_1867',['gamma',['../namespacenc_1_1random.html#a0a969335423de5ad59fed5e952189e2d',1,'nc::random::gamma(dtype inGammaShape, dtype inScaleValue=1)'],['../namespacenc_1_1random.html#aa706a2bd65cb664ae9af10f713661d79',1,'nc::random::gamma(const Shape &inShape, dtype inGammaShape, dtype inScaleValue=1)'],['../namespacenc_1_1special.html#aad22d353f040026576c4a28727ecaf35',1,'nc::special::gamma(dtype inValue)'],['../namespacenc_1_1special.html#a07a3d6d5e0610dca66ca975cdf1d34b9',1,'nc::special::gamma(const NdArray< dtype > &inArray)']]], - ['gamma1pm1_1868',['gamma1pm1',['../namespacenc_1_1special.html#a9ea9c889891f9f3a071c786d0b947e20',1,'nc::special::gamma1pm1(dtype inValue)'],['../namespacenc_1_1special.html#a7b98a5eedb6e5354adbab8dcfe1ce4e1',1,'nc::special::gamma1pm1(const NdArray< dtype > &inArray)']]], - ['gauss_5flegendre_1869',['gauss_legendre',['../namespacenc_1_1integrate.html#af7d17b4e025bf94f903d3c671da3baf7',1,'nc::integrate']]], - ['gaussian_1870',['gaussian',['../namespacenc_1_1utils.html#a5016e06ac7ca186ff6c110b314d30209',1,'nc::utils']]], - ['gaussian1d_1871',['gaussian1d',['../namespacenc_1_1utils.html#a263704ee2cc6ab3f77b462522c7150f8',1,'nc::utils']]], - ['gaussianfilter_1872',['gaussianFilter',['../namespacenc_1_1filter.html#a91c9fcd09a78eba8a42c5166ebb7709b',1,'nc::filter']]], - ['gaussianfilter1d_1873',['gaussianFilter1d',['../namespacenc_1_1filter.html#abda833220ea035db0aa485f6ccf66923',1,'nc::filter']]], - ['gaussnewtonnlls_1874',['gaussNewtonNlls',['../namespacenc_1_1linalg.html#aff0f97e94666284100b584e13d27def3',1,'nc::linalg']]], - ['gcd_1875',['gcd',['../namespacenc.html#a4a496eaa0a42e0b9c80724358664d432',1,'nc::gcd(const NdArray< dtype > &inArray)'],['../namespacenc.html#a45b5db91eb9f524459fa3878e23ca0ec',1,'nc::gcd(dtype inValue1, dtype inValue2) noexcept']]], - ['generatecentroids_1876',['generateCentroids',['../namespacenc_1_1image_processing.html#a874d0f4174d10763002fdd70f190595b',1,'nc::imageProcessing']]], - ['generatethreshold_1877',['generateThreshold',['../namespacenc_1_1image_processing.html#a356989d12dda6e1b0748d22d50d4ecaa',1,'nc::imageProcessing']]], - ['geometric_1878',['geometric',['../namespacenc_1_1random.html#a7199f5c06c0e05440e9a97e01930b896',1,'nc::random::geometric(double inP=0.5)'],['../namespacenc_1_1random.html#ae761ff6e68fb0708061704bee4a3a7e3',1,'nc::random::geometric(const Shape &inShape, double inP=0.5)']]], - ['getbyindices_1879',['getByIndices',['../classnc_1_1_nd_array.html#a9437732d220581563d44c800ce240e17',1,'nc::NdArray']]], - ['getbymask_1880',['getByMask',['../classnc_1_1_nd_array.html#a4da478ab5a1c836be7ad2f9d6bfed91e',1,'nc::NdArray']]], - ['getroot_1881',['getRoot',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac2d8f6377f8ae7cf27b4d0599eb7880b',1,'nc::integrate::LegendrePolynomial']]], - ['getweight_1882',['getWeight',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac6b804e8a2d582df601cc2b3ff2bf74f',1,'nc::integrate::LegendrePolynomial']]], - ['gradient_1883',['gradient',['../namespacenc.html#ae2a11c3f92effc5991a2e0134f6a9188',1,'nc::gradient(const NdArray< dtype > &inArray, Axis inAxis=Axis::ROW)'],['../namespacenc.html#a7ef89fff9eb07946e77a5375dac5e7b6',1,'nc::gradient(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::ROW)']]], - ['greater_1884',['greater',['../namespacenc.html#a105d660675a98132264a13b17410a82d',1,'nc']]], - ['greater_5fequal_1885',['greater_equal',['../namespacenc.html#a9a2bbc9879a2b3a9e657328c9d8ad025',1,'nc']]] + ['gamma_1954',['gamma',['../namespacenc_1_1random.html#a0a969335423de5ad59fed5e952189e2d',1,'nc::random::gamma(dtype inGammaShape, dtype inScaleValue=1)'],['../namespacenc_1_1random.html#aa706a2bd65cb664ae9af10f713661d79',1,'nc::random::gamma(const Shape &inShape, dtype inGammaShape, dtype inScaleValue=1)'],['../namespacenc_1_1special.html#aad22d353f040026576c4a28727ecaf35',1,'nc::special::gamma(dtype inValue)'],['../namespacenc_1_1special.html#a07a3d6d5e0610dca66ca975cdf1d34b9',1,'nc::special::gamma(const NdArray< dtype > &inArray)']]], + ['gamma1pm1_1955',['gamma1pm1',['../namespacenc_1_1special.html#a9ea9c889891f9f3a071c786d0b947e20',1,'nc::special::gamma1pm1(dtype inValue)'],['../namespacenc_1_1special.html#a7b98a5eedb6e5354adbab8dcfe1ce4e1',1,'nc::special::gamma1pm1(const NdArray< dtype > &inArray)']]], + ['gauss_5flegendre_1956',['gauss_legendre',['../namespacenc_1_1integrate.html#af7d17b4e025bf94f903d3c671da3baf7',1,'nc::integrate']]], + ['gaussian_1957',['gaussian',['../namespacenc_1_1utils.html#a5016e06ac7ca186ff6c110b314d30209',1,'nc::utils']]], + ['gaussian1d_1958',['gaussian1d',['../namespacenc_1_1utils.html#a263704ee2cc6ab3f77b462522c7150f8',1,'nc::utils']]], + ['gaussianfilter_1959',['gaussianFilter',['../namespacenc_1_1filter.html#a91c9fcd09a78eba8a42c5166ebb7709b',1,'nc::filter']]], + ['gaussianfilter1d_1960',['gaussianFilter1d',['../namespacenc_1_1filter.html#abda833220ea035db0aa485f6ccf66923',1,'nc::filter']]], + ['gaussnewtonnlls_1961',['gaussNewtonNlls',['../namespacenc_1_1linalg.html#aff0f97e94666284100b584e13d27def3',1,'nc::linalg']]], + ['gcd_1962',['gcd',['../namespacenc.html#a45b5db91eb9f524459fa3878e23ca0ec',1,'nc::gcd(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#a4a496eaa0a42e0b9c80724358664d432',1,'nc::gcd(const NdArray< dtype > &inArray)']]], + ['generatecentroids_1963',['generateCentroids',['../namespacenc_1_1image_processing.html#a874d0f4174d10763002fdd70f190595b',1,'nc::imageProcessing']]], + ['generatethreshold_1964',['generateThreshold',['../namespacenc_1_1image_processing.html#a356989d12dda6e1b0748d22d50d4ecaa',1,'nc::imageProcessing']]], + ['geometric_1965',['geometric',['../namespacenc_1_1random.html#a7199f5c06c0e05440e9a97e01930b896',1,'nc::random::geometric(double inP=0.5)'],['../namespacenc_1_1random.html#ae761ff6e68fb0708061704bee4a3a7e3',1,'nc::random::geometric(const Shape &inShape, double inP=0.5)']]], + ['geomspace_1966',['geomspace',['../namespacenc.html#aa5cdd68a27ae041c382eabfb07dfa9bc',1,'nc']]], + ['getbyindices_1967',['getByIndices',['../classnc_1_1_nd_array.html#a9437732d220581563d44c800ce240e17',1,'nc::NdArray']]], + ['getbymask_1968',['getByMask',['../classnc_1_1_nd_array.html#a4da478ab5a1c836be7ad2f9d6bfed91e',1,'nc::NdArray']]], + ['getroot_1969',['getRoot',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac2d8f6377f8ae7cf27b4d0599eb7880b',1,'nc::integrate::LegendrePolynomial']]], + ['getweight_1970',['getWeight',['../classnc_1_1integrate_1_1_legendre_polynomial.html#ac6b804e8a2d582df601cc2b3ff2bf74f',1,'nc::integrate::LegendrePolynomial']]], + ['gradient_1971',['gradient',['../namespacenc.html#ae2a11c3f92effc5991a2e0134f6a9188',1,'nc::gradient(const NdArray< dtype > &inArray, Axis inAxis=Axis::ROW)'],['../namespacenc.html#a7ef89fff9eb07946e77a5375dac5e7b6',1,'nc::gradient(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::ROW)']]], + ['greater_1972',['greater',['../namespacenc.html#a105d660675a98132264a13b17410a82d',1,'nc']]], + ['greater_5fequal_1973',['greater_equal',['../namespacenc.html#a9a2bbc9879a2b3a9e657328c9d8ad025',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/functions_7.html b/docs/doxygen/html/search/functions_7.html index c85b18996..46b5c0f61 100644 --- a/docs/doxygen/html/search/functions_7.html +++ b/docs/doxygen/html/search/functions_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_7.js b/docs/doxygen/html/search/functions_7.js index 32e7f8a32..49710c1b5 100644 --- a/docs/doxygen/html/search/functions_7.js +++ b/docs/doxygen/html/search/functions_7.js @@ -1,11 +1,13 @@ var searchData= [ - ['hasext_1886',['hasExt',['../classnc_1_1filesystem_1_1_file.html#a4e8ede3f75b64847964d4d85cd58f123',1,'nc::filesystem::File']]], - ['hat_1887',['hat',['../namespacenc_1_1linalg.html#a12e16cb9d1a7b09e85b4abbef14ba2ef',1,'nc::linalg::hat(dtype inX, dtype inY, dtype inZ)'],['../namespacenc_1_1linalg.html#ae7ced3680f1ae95af4bc2e6b98a5a517',1,'nc::linalg::hat(const NdArray< dtype > &inVec)'],['../namespacenc_1_1linalg.html#ae9cdb091717a1c74dc659519d77e0048',1,'nc::linalg::hat(const Vec3 &inVec)']]], - ['height_1888',['height',['../classnc_1_1image_processing_1_1_cluster.html#a71ccd5ee3fea70b4b1b27ba25f4b3fb8',1,'nc::imageProcessing::Cluster']]], - ['hermite_1889',['hermite',['../namespacenc_1_1polynomial.html#aeea1ebbc592a6a8c533f2230fb0f6f10',1,'nc::polynomial::hermite(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#ad88f67a61dad283461c6121958c5af54',1,'nc::polynomial::hermite(uint32 n, const NdArray< dtype > &inArrayX)']]], - ['histogram_1890',['histogram',['../namespacenc.html#abff7fb8fdafbdd8db4dad38cc5a2267c',1,'nc::histogram(const NdArray< dtype > &inArray, const NdArray< double > &inBinEdges)'],['../namespacenc.html#a9f8af3a8f7adefd20992fe0686837cf6',1,'nc::histogram(const NdArray< dtype > &inArray, uint32 inNumBins=10)']]], - ['hours_1891',['hours',['../classnc_1_1coordinates_1_1_r_a.html#a52af78880f6c5a5ec8750a7ad20c2e2d',1,'nc::coordinates::RA']]], - ['hstack_1892',['hstack',['../namespacenc.html#a80a6677582b65c19750b0d82ac182081',1,'nc']]], - ['hypot_1893',['hypot',['../namespacenc.html#a4648674053cd83851d9549bbcc7a8481',1,'nc::hypot(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ad2d90c3dcbe0a1e652b0505b637d973a',1,'nc::hypot(dtype inValue1, dtype inValue2, dtype inValue3) noexcept'],['../namespacenc.html#a66b0aabfaacc7ec12206b4edf6026b12',1,'nc::hypot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]] + ['hamming_1974',['hamming',['../namespacenc.html#ad7fcd267d31bec0085f82959e3b5f9d3',1,'nc']]], + ['hanning_1975',['hanning',['../namespacenc.html#ab50f9ea31f882bd8121c1adf820798b3',1,'nc']]], + ['hasext_1976',['hasExt',['../classnc_1_1filesystem_1_1_file.html#a4e8ede3f75b64847964d4d85cd58f123',1,'nc::filesystem::File']]], + ['hat_1977',['hat',['../namespacenc_1_1linalg.html#a12e16cb9d1a7b09e85b4abbef14ba2ef',1,'nc::linalg::hat(dtype inX, dtype inY, dtype inZ)'],['../namespacenc_1_1linalg.html#ae7ced3680f1ae95af4bc2e6b98a5a517',1,'nc::linalg::hat(const NdArray< dtype > &inVec)'],['../namespacenc_1_1linalg.html#ae9cdb091717a1c74dc659519d77e0048',1,'nc::linalg::hat(const Vec3 &inVec)']]], + ['height_1978',['height',['../classnc_1_1image_processing_1_1_cluster.html#a71ccd5ee3fea70b4b1b27ba25f4b3fb8',1,'nc::imageProcessing::Cluster']]], + ['hermite_1979',['hermite',['../namespacenc_1_1polynomial.html#aeea1ebbc592a6a8c533f2230fb0f6f10',1,'nc::polynomial::hermite(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#ad88f67a61dad283461c6121958c5af54',1,'nc::polynomial::hermite(uint32 n, const NdArray< dtype > &inArrayX)']]], + ['histogram_1980',['histogram',['../namespacenc.html#abff7fb8fdafbdd8db4dad38cc5a2267c',1,'nc::histogram(const NdArray< dtype > &inArray, const NdArray< double > &inBinEdges)'],['../namespacenc.html#a9f8af3a8f7adefd20992fe0686837cf6',1,'nc::histogram(const NdArray< dtype > &inArray, uint32 inNumBins=10)']]], + ['hours_1981',['hours',['../classnc_1_1coordinates_1_1_r_a.html#a52af78880f6c5a5ec8750a7ad20c2e2d',1,'nc::coordinates::RA']]], + ['hstack_1982',['hstack',['../namespacenc.html#afa8806a41df51bbb4410d4cb6601971f',1,'nc']]], + ['hypot_1983',['hypot',['../namespacenc.html#a4648674053cd83851d9549bbcc7a8481',1,'nc::hypot(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#ad2d90c3dcbe0a1e652b0505b637d973a',1,'nc::hypot(dtype inValue1, dtype inValue2, dtype inValue3) noexcept'],['../namespacenc.html#a66b0aabfaacc7ec12206b4edf6026b12',1,'nc::hypot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]] ]; diff --git a/docs/doxygen/html/search/functions_8.html b/docs/doxygen/html/search/functions_8.html index aa875b665..31a1d9503 100644 --- a/docs/doxygen/html/search/functions_8.html +++ b/docs/doxygen/html/search/functions_8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_8.js b/docs/doxygen/html/search/functions_8.js index e49e841fa..ca5e3875a 100644 --- a/docs/doxygen/html/search/functions_8.js +++ b/docs/doxygen/html/search/functions_8.js @@ -1,29 +1,33 @@ var searchData= [ - ['i_1894',['i',['../classnc_1_1rotations_1_1_quaternion.html#a5a661b367dff916e8bdb5e28ac608ecd',1,'nc::rotations::Quaternion']]], - ['identity_1895',['identity',['../classnc_1_1rotations_1_1_quaternion.html#ae093d333b66b63eeef5704be4a374af2',1,'nc::rotations::Quaternion::identity()'],['../namespacenc.html#ac344d8b6291a38244e2d99cd77b17334',1,'nc::identity(uint32 inSquareSize)']]], - ['imag_1896',['imag',['../namespacenc.html#ae9eae82003557c0e94890a8f3bb3f5dc',1,'nc::imag(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a12cdcae89058ab627b68d32bc9ce0666',1,'nc::imag(const std::complex< dtype > &inValue)']]], - ['incrementnumberofiterations_1897',['incrementNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#ad0262a1a694e734ebc154c77f010bcff',1,'nc::roots::Iteration']]], - ['integ_1898',['integ',['../classnc_1_1polynomial_1_1_poly1d.html#a4c2902780c89054a6ca436a72ac77119',1,'nc::polynomial::Poly1d']]], - ['intensity_1899',['intensity',['../classnc_1_1image_processing_1_1_centroid.html#aa203a8f8138fe9679f307f38ad65a5aa',1,'nc::imageProcessing::Centroid::intensity()'],['../classnc_1_1image_processing_1_1_cluster.html#a1797d804406d51ab2e22d5b9fae9cb53',1,'nc::imageProcessing::Cluster::intensity()']]], - ['interp_1900',['interp',['../namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e',1,'nc::utils::interp()'],['../namespacenc.html#a25a0717dab4a33f74927d390b83182ab',1,'nc::interp(const NdArray< dtype > &inX, const NdArray< dtype > &inXp, const NdArray< dtype > &inFp)'],['../namespacenc.html#a5b9584eeac344f9d37beb6be475300ca',1,'nc::interp(dtype inValue1, dtype inValue2, double inPercent) noexcept']]], - ['intersect1d_1901',['intersect1d',['../namespacenc.html#a05a1080b20bfa1434ccb96fb08836bc4',1,'nc']]], - ['inv_1902',['inv',['../namespacenc_1_1linalg.html#ae36553eb100d8f2c2167e8ecadf2a9fc',1,'nc::linalg']]], - ['inverse_1903',['inverse',['../classnc_1_1rotations_1_1_quaternion.html#a9b0634474b2ff27f9443ba256ea00ab1',1,'nc::rotations::Quaternion']]], - ['invert_1904',['invert',['../namespacenc.html#a4159e9798b5726992f13f27366bea4f5',1,'nc']]], - ['is_5fsorted_1905',['is_sorted',['../namespacenc_1_1stl__algorithms.html#a1f71dfda5f16d8a53c16260c5fa8fbdc',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last, Compare comp) noexcept'],['../namespacenc_1_1stl__algorithms.html#aca7862e3fe066fc65bf00cb7f5108e33',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last) noexcept']]], - ['isclose_1906',['isclose',['../namespacenc.html#ae80bdb1c4ce59e2a74cad2d518f50e1e',1,'nc']]], - ['isempty_1907',['isempty',['../classnc_1_1_nd_array.html#a3e5261e1be6357a2c608f5e1d97b35f9',1,'nc::NdArray::isempty()'],['../classnc_1_1_data_cube.html#ac569e0c62a9e5cbf21228b85128a53a5',1,'nc::DataCube::isempty()']]], - ['isflat_1908',['isflat',['../classnc_1_1_nd_array.html#a344f12e052eeb49cc87e361127386a64',1,'nc::NdArray']]], - ['isinf_1909',['isinf',['../namespacenc.html#a38b400fe936ea86828d4e29d5b0950bb',1,'nc::isinf(const NdArray< dtype > &inArray)'],['../namespacenc.html#ac2770d614de64c300c2f10cb39a299c0',1,'nc::isinf(dtype inValue) noexcept']]], - ['isinteger_1910',['isInteger',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac055638657a1459bc6a7c9d94d5c96a4',1,'nc::DtypeInfo< std::complex< dtype > >::isInteger()'],['../classnc_1_1_dtype_info.html#a10b60bd27123b5c724e2a52526fe8cfe',1,'nc::DtypeInfo::isInteger()']]], - ['islittleendian_1911',['isLittleEndian',['../namespacenc_1_1endian.html#a11907ef8078650aee8fe900854ba5bb4',1,'nc::endian']]], - ['isnan_1912',['isnan',['../namespacenc.html#ac28569da874c0b37a4c50c86b31a98ab',1,'nc::isnan(dtype inValue) noexcept'],['../namespacenc.html#aedce7cd7ff92f9fec0c93cd9c5522ca8',1,'nc::isnan(const NdArray< dtype > &inArray)']]], - ['isnull_1913',['isnull',['../classnc_1_1_shape.html#a3c8d187f677e9a4cdbdf1906d612b596',1,'nc::Shape']]], - ['issigned_1914',['isSigned',['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac58a829905d11a1a7fca32427eab41d3',1,'nc::DtypeInfo< std::complex< dtype > >::isSigned()'],['../classnc_1_1_dtype_info.html#a039ecfb9a5bd9fe0cb751a59f28055d1',1,'nc::DtypeInfo::isSigned()']]], - ['issorted_1915',['issorted',['../classnc_1_1_nd_array.html#a0ba38857fd4f9474e2814bbf1c3a6a0a',1,'nc::NdArray']]], - ['issquare_1916',['issquare',['../classnc_1_1_nd_array.html#a302be17d815b1a4e353e6a2aade581a5',1,'nc::NdArray::issquare()'],['../classnc_1_1_shape.html#a939dd0ab6edf83b7abaf8b8c93a99152',1,'nc::Shape::issquare()']]], - ['isvalid_1917',['isValid',['../classnc_1_1rotations_1_1_d_c_m.html#ab1947c7618408b063b704ec391e27888',1,'nc::rotations::DCM']]], - ['item_1918',['item',['../classnc_1_1_nd_array.html#abec76b8f271e07fa07cc2f88fed676fa',1,'nc::NdArray']]], - ['iteration_1919',['Iteration',['../classnc_1_1roots_1_1_iteration.html#a7948f08cfaa01f5685ec35149bf6bba0',1,'nc::roots::Iteration::Iteration(double epsilon, uint32 maxNumIterations) noexcept'],['../classnc_1_1roots_1_1_iteration.html#a2d7285a81c033d56ce8283b6dbfca136',1,'nc::roots::Iteration::Iteration(double epsilon) noexcept']]] + ['i_1984',['i',['../classnc_1_1rotations_1_1_quaternion.html#a5a661b367dff916e8bdb5e28ac608ecd',1,'nc::rotations::Quaternion']]], + ['identity_1985',['identity',['../classnc_1_1rotations_1_1_quaternion.html#ae093d333b66b63eeef5704be4a374af2',1,'nc::rotations::Quaternion::identity()'],['../namespacenc.html#ac344d8b6291a38244e2d99cd77b17334',1,'nc::identity(uint32 inSquareSize)']]], + ['imag_1986',['imag',['../namespacenc.html#a12cdcae89058ab627b68d32bc9ce0666',1,'nc::imag(const std::complex< dtype > &inValue)'],['../namespacenc.html#ae9eae82003557c0e94890a8f3bb3f5dc',1,'nc::imag(const NdArray< std::complex< dtype >> &inArray)']]], + ['incrementnumberofiterations_1987',['incrementNumberOfIterations',['../classnc_1_1roots_1_1_iteration.html#ad0262a1a694e734ebc154c77f010bcff',1,'nc::roots::Iteration']]], + ['inner_1988',['inner',['../namespacenc.html#aa44cb1f69e57caf4a79ff92960ddaebd',1,'nc']]], + ['integ_1989',['integ',['../classnc_1_1polynomial_1_1_poly1d.html#a4c2902780c89054a6ca436a72ac77119',1,'nc::polynomial::Poly1d']]], + ['intensity_1990',['intensity',['../classnc_1_1image_processing_1_1_centroid.html#aa203a8f8138fe9679f307f38ad65a5aa',1,'nc::imageProcessing::Centroid::intensity()'],['../classnc_1_1image_processing_1_1_cluster.html#a1797d804406d51ab2e22d5b9fae9cb53',1,'nc::imageProcessing::Cluster::intensity()']]], + ['interp_1991',['interp',['../namespacenc.html#a25a0717dab4a33f74927d390b83182ab',1,'nc::interp(const NdArray< dtype > &inX, const NdArray< dtype > &inXp, const NdArray< dtype > &inFp)'],['../namespacenc.html#a5b9584eeac344f9d37beb6be475300ca',1,'nc::interp(dtype inValue1, dtype inValue2, double inPercent) noexcept'],['../namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e',1,'nc::utils::interp()']]], + ['intersect1d_1992',['intersect1d',['../namespacenc.html#a05a1080b20bfa1434ccb96fb08836bc4',1,'nc']]], + ['inv_1993',['inv',['../namespacenc_1_1linalg.html#ae36553eb100d8f2c2167e8ecadf2a9fc',1,'nc::linalg']]], + ['inverse_1994',['inverse',['../classnc_1_1rotations_1_1_quaternion.html#a9b0634474b2ff27f9443ba256ea00ab1',1,'nc::rotations::Quaternion']]], + ['invert_1995',['invert',['../namespacenc.html#a4159e9798b5726992f13f27366bea4f5',1,'nc']]], + ['is_5fsorted_1996',['is_sorted',['../namespacenc_1_1stl__algorithms.html#aca7862e3fe066fc65bf00cb7f5108e33',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a1f71dfda5f16d8a53c16260c5fa8fbdc',1,'nc::stl_algorithms::is_sorted(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['isclose_1997',['isclose',['../namespacenc.html#ae80bdb1c4ce59e2a74cad2d518f50e1e',1,'nc']]], + ['isempty_1998',['isempty',['../classnc_1_1_data_cube.html#ac569e0c62a9e5cbf21228b85128a53a5',1,'nc::DataCube::isempty()'],['../classnc_1_1_nd_array.html#a3e5261e1be6357a2c608f5e1d97b35f9',1,'nc::NdArray::isempty() const noexcept']]], + ['isflat_1999',['isflat',['../classnc_1_1_nd_array.html#a344f12e052eeb49cc87e361127386a64',1,'nc::NdArray']]], + ['isinf_2000',['isinf',['../namespacenc.html#ac2770d614de64c300c2f10cb39a299c0',1,'nc::isinf(dtype inValue) noexcept'],['../namespacenc.html#a38b400fe936ea86828d4e29d5b0950bb',1,'nc::isinf(const NdArray< dtype > &inArray)']]], + ['isinteger_2001',['isInteger',['../classnc_1_1_dtype_info.html#a10b60bd27123b5c724e2a52526fe8cfe',1,'nc::DtypeInfo::isInteger()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac055638657a1459bc6a7c9d94d5c96a4',1,'nc::DtypeInfo< std::complex< dtype > >::isInteger()']]], + ['islittleendian_2002',['isLittleEndian',['../namespacenc_1_1endian.html#a11907ef8078650aee8fe900854ba5bb4',1,'nc::endian']]], + ['isnan_2003',['isnan',['../namespacenc.html#ac28569da874c0b37a4c50c86b31a98ab',1,'nc::isnan(dtype inValue) noexcept'],['../namespacenc.html#aedce7cd7ff92f9fec0c93cd9c5522ca8',1,'nc::isnan(const NdArray< dtype > &inArray)']]], + ['isneginf_2004',['isneginf',['../namespacenc.html#abb8e6e08f1b4374017ef8e4cd1841ba6',1,'nc::isneginf(dtype inValue) noexcept'],['../namespacenc.html#af02b9a27f4177ad1ccb9ecea6ab79f46',1,'nc::isneginf(const NdArray< dtype > &inArray)']]], + ['isnull_2005',['isnull',['../classnc_1_1_shape.html#a3c8d187f677e9a4cdbdf1906d612b596',1,'nc::Shape']]], + ['isposinf_2006',['isposinf',['../namespacenc.html#a7229b43ce1e19fb560d461b6beda24af',1,'nc::isposinf(dtype inValue) noexcept'],['../namespacenc.html#a00f30f48ef39bc0fa8149cb09b286e07',1,'nc::isposinf(const NdArray< dtype > &inArray)']]], + ['ispoweroftwo_2007',['isPowerOfTwo',['../namespacenc_1_1edac_1_1detail.html#a7f066ec8b196c2943ae99382eb63e2fb',1,'nc::edac::detail']]], + ['issigned_2008',['isSigned',['../classnc_1_1_dtype_info.html#a039ecfb9a5bd9fe0cb751a59f28055d1',1,'nc::DtypeInfo::isSigned()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#ac58a829905d11a1a7fca32427eab41d3',1,'nc::DtypeInfo< std::complex< dtype > >::isSigned()']]], + ['issorted_2009',['issorted',['../classnc_1_1_nd_array.html#a0ba38857fd4f9474e2814bbf1c3a6a0a',1,'nc::NdArray']]], + ['issquare_2010',['issquare',['../classnc_1_1_shape.html#a939dd0ab6edf83b7abaf8b8c93a99152',1,'nc::Shape::issquare()'],['../classnc_1_1_nd_array.html#a302be17d815b1a4e353e6a2aade581a5',1,'nc::NdArray::issquare()']]], + ['isvalid_2011',['isValid',['../classnc_1_1rotations_1_1_d_c_m.html#ab1947c7618408b063b704ec391e27888',1,'nc::rotations::DCM']]], + ['item_2012',['item',['../classnc_1_1_nd_array.html#abec76b8f271e07fa07cc2f88fed676fa',1,'nc::NdArray']]], + ['iteration_2013',['Iteration',['../classnc_1_1roots_1_1_iteration.html#a7948f08cfaa01f5685ec35149bf6bba0',1,'nc::roots::Iteration::Iteration(double epsilon, uint32 maxNumIterations) noexcept'],['../classnc_1_1roots_1_1_iteration.html#a2d7285a81c033d56ce8283b6dbfca136',1,'nc::roots::Iteration::Iteration(double epsilon) noexcept']]] ]; diff --git a/docs/doxygen/html/search/functions_9.html b/docs/doxygen/html/search/functions_9.html index ccfeeecc6..9a8e4290c 100644 --- a/docs/doxygen/html/search/functions_9.html +++ b/docs/doxygen/html/search/functions_9.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_9.js b/docs/doxygen/html/search/functions_9.js index b2955c20b..ac9cb20e1 100644 --- a/docs/doxygen/html/search/functions_9.js +++ b/docs/doxygen/html/search/functions_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['j_1920',['j',['../classnc_1_1rotations_1_1_quaternion.html#acb62c703a1f96333bf76ad0735cb8b97',1,'nc::rotations::Quaternion']]] + ['j_2014',['j',['../classnc_1_1rotations_1_1_quaternion.html#acb62c703a1f96333bf76ad0735cb8b97',1,'nc::rotations::Quaternion']]] ]; diff --git a/docs/doxygen/html/search/functions_a.html b/docs/doxygen/html/search/functions_a.html index 20591df34..5ecc152ca 100644 --- a/docs/doxygen/html/search/functions_a.html +++ b/docs/doxygen/html/search/functions_a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_a.js b/docs/doxygen/html/search/functions_a.js index e58353936..b26f0500c 100644 --- a/docs/doxygen/html/search/functions_a.js +++ b/docs/doxygen/html/search/functions_a.js @@ -1,4 +1,5 @@ var searchData= [ - ['k_1921',['k',['../classnc_1_1rotations_1_1_quaternion.html#aa2eee61d3a428a558f28d1bb6cc6a048',1,'nc::rotations::Quaternion']]] + ['k_2015',['k',['../classnc_1_1rotations_1_1_quaternion.html#aa2eee61d3a428a558f28d1bb6cc6a048',1,'nc::rotations::Quaternion']]], + ['kaiser_2016',['kaiser',['../namespacenc.html#a40ad53a4a4ad1be06ca85bbf9f9e9d25',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/functions_b.html b/docs/doxygen/html/search/functions_b.html index e9d40f14a..e301fedd7 100644 --- a/docs/doxygen/html/search/functions_b.html +++ b/docs/doxygen/html/search/functions_b.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_b.js b/docs/doxygen/html/search/functions_b.js index 927db9f36..cfae0a397 100644 --- a/docs/doxygen/html/search/functions_b.js +++ b/docs/doxygen/html/search/functions_b.js @@ -1,29 +1,31 @@ var searchData= [ - ['laguerre_1922',['laguerre',['../namespacenc_1_1polynomial.html#aa2c08952d8dfd2cccfbcd6da40b49f4f',1,'nc::polynomial::laguerre(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#ad7fef1e52b0054b5894995ee1ed94340',1,'nc::polynomial::laguerre(uint32 n, uint32 m, dtype x)'],['../namespacenc_1_1polynomial.html#a55e940d8393b196ebce707ac8b0df5b9',1,'nc::polynomial::laguerre(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a9a3c9fb31c548094a1ce7ec927f28bee',1,'nc::polynomial::laguerre(uint32 n, uint32 m, const NdArray< dtype > &inArrayX)']]], - ['laplace_1923',['laplace',['../namespacenc_1_1filter.html#aae2d06efe29180faf7363b9322588f46',1,'nc::filter::laplace()'],['../namespacenc_1_1random.html#a76e5b2a6feb9bf6a05c5dd9402f9c62f',1,'nc::random::laplace(dtype inLoc=0, dtype inScale=1)'],['../namespacenc_1_1random.html#ab2ecb1401cb11a3c816073fcbc7b05b5',1,'nc::random::laplace(const Shape &inShape, dtype inLoc=0, dtype inScale=1)']]], - ['lcm_1924',['lcm',['../namespacenc.html#aa69cf791720987deb546d71057a668a1',1,'nc::lcm(const NdArray< dtype > &inArray)'],['../namespacenc.html#a7ffd0c15b8419a5d84458d4009b38b88',1,'nc::lcm(dtype inValue1, dtype inValue2) noexcept']]], - ['ldexp_1925',['ldexp',['../namespacenc.html#a52060ff2d69ed791b3f19c1d78cf8551',1,'nc::ldexp(const NdArray< dtype > &inArray1, const NdArray< uint8 > &inArray2)'],['../namespacenc.html#aca805ef0273314ddc6c70b2c913bf485',1,'nc::ldexp(dtype inValue1, uint8 inValue2) noexcept']]], - ['left_1926',['left',['../classnc_1_1_vec3.html#a7e6730d945972ecda1815c1d41f5074c',1,'nc::Vec3::left()'],['../classnc_1_1_vec2.html#ade3f4342726264a1493f91ae80ab24ca',1,'nc::Vec2::left()']]], - ['left_5fshift_1927',['left_shift',['../namespacenc.html#a6f10270824079210d4264d50f5a64f4d',1,'nc']]], - ['legendre_5fp_1928',['legendre_p',['../namespacenc_1_1polynomial.html#aa3860199d898cdf173f3846cce684d72',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a567bdffcff63421b77a9dfae9cbdfc8a',1,'nc::polynomial::legendre_p(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a6a68bde646dae6ffb484502d54e5c175',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a10a5a1a92ac32725bb3d0496078f122e',1,'nc::polynomial::legendre_p(uint32 n, const NdArray< dtype > &inArrayX)']]], - ['legendre_5fq_1929',['legendre_q',['../namespacenc_1_1polynomial.html#a78897e159974d6732b77759be2f2da13',1,'nc::polynomial::legendre_q(int32 n, dtype x)'],['../namespacenc_1_1polynomial.html#aed5c95f5a321ec71c1a34a42414bec52',1,'nc::polynomial::legendre_q(int32 n, const NdArray< dtype > &inArrayX)']]], - ['legendrepolynomial_1930',['LegendrePolynomial',['../classnc_1_1integrate_1_1_legendre_polynomial.html#a2e1fefae138e66215cd7586a85fc3642',1,'nc::integrate::LegendrePolynomial']]], - ['lerp_1931',['lerp',['../classnc_1_1_vec2.html#a91e6417e5b9903ed6bee3ad90c0c38f4',1,'nc::Vec2::lerp()'],['../classnc_1_1_vec3.html#ab4878c8a4ebcd94fd0baf93059b50ac6',1,'nc::Vec3::lerp()']]], - ['less_1932',['less',['../namespacenc.html#a114baa0d21d439b7971dedd4b4042db8',1,'nc']]], - ['less_5fequal_1933',['less_equal',['../namespacenc.html#ac51b96f0ac720a028ebd856abf1b5785',1,'nc']]], - ['linspace_1934',['linspace',['../namespacenc.html#a672fbcbd2271d5fc58bd1b94750bbdcc',1,'nc']]], - ['load_1935',['load',['../namespacenc.html#abec5f2e4d2a1598de762e32b839a3067',1,'nc']]], - ['log_1936',['log',['../namespacenc.html#a3f08d373ae167ac90d3bb6b6c4da0fb9',1,'nc::log(dtype inValue) noexcept'],['../namespacenc.html#aba925957229bf54bfe854be197cd3d52',1,'nc::log(const NdArray< dtype > &inArray)']]], - ['log10_1937',['log10',['../namespacenc.html#a0d8a5ffeaed868463a6e55645c625c8f',1,'nc::log10(dtype inValue) noexcept'],['../namespacenc.html#a3cd82f65b6ee069a7d6443646dfecf67',1,'nc::log10(const NdArray< dtype > &inArray)']]], - ['log1p_1938',['log1p',['../namespacenc.html#a1ae30700a2db1cd8e44fa59b84c2b547',1,'nc::log1p(const NdArray< dtype > &inArray)'],['../namespacenc.html#a5abcc8523a49a47fd2224d5588f128b4',1,'nc::log1p(dtype inValue) noexcept']]], - ['log2_1939',['log2',['../namespacenc.html#a48cbc16dc706678b6f85e655e935cd41',1,'nc::log2(dtype inValue) noexcept'],['../namespacenc.html#a536e5046481a32bd6955a222f323393a',1,'nc::log2(const NdArray< dtype > &inArray)']]], - ['log_5fgamma_1940',['log_gamma',['../namespacenc_1_1special.html#a11ec3d4677a53eafd8b0144cd6e42ce3',1,'nc::special::log_gamma(dtype inValue)'],['../namespacenc_1_1special.html#addebe777849a11f027a793975a53b653',1,'nc::special::log_gamma(const NdArray< dtype > &inArray)']]], - ['logical_5fand_1941',['logical_and',['../namespacenc.html#a951c3f9acd6147a8e2be1ab2cda4d51c',1,'nc']]], - ['logical_5fnot_1942',['logical_not',['../namespacenc.html#ae90620999105f741609c7f279cac2907',1,'nc']]], - ['logical_5for_1943',['logical_or',['../namespacenc.html#a0492e302b114ab15b996b1330604478b',1,'nc']]], - ['logical_5fxor_1944',['logical_xor',['../namespacenc.html#a7b84e63b2d32e1b59bfef4690c918989',1,'nc']]], - ['lognormal_1945',['lognormal',['../namespacenc_1_1random.html#a03d5528a3a97b3731210ba2cc5d1c75d',1,'nc::random::lognormal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a3adc9de1025d27ed485603980657225b',1,'nc::random::lognormal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], - ['lstsq_1946',['lstsq',['../namespacenc_1_1linalg.html#a9c15421c77e6b4b12fca1515596d1414',1,'nc::linalg']]], - ['lu_5fdecomposition_1947',['lu_decomposition',['../namespacenc_1_1linalg.html#a153a90dbcc2ca94c664c429868d15bc4',1,'nc::linalg']]] + ['laguerre_2017',['laguerre',['../namespacenc_1_1polynomial.html#ad7fef1e52b0054b5894995ee1ed94340',1,'nc::polynomial::laguerre(uint32 n, uint32 m, dtype x)'],['../namespacenc_1_1polynomial.html#aa2c08952d8dfd2cccfbcd6da40b49f4f',1,'nc::polynomial::laguerre(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a55e940d8393b196ebce707ac8b0df5b9',1,'nc::polynomial::laguerre(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#a9a3c9fb31c548094a1ce7ec927f28bee',1,'nc::polynomial::laguerre(uint32 n, uint32 m, const NdArray< dtype > &inArrayX)']]], + ['laplace_2018',['laplace',['../namespacenc_1_1filter.html#aae2d06efe29180faf7363b9322588f46',1,'nc::filter::laplace()'],['../namespacenc_1_1random.html#a76e5b2a6feb9bf6a05c5dd9402f9c62f',1,'nc::random::laplace(dtype inLoc=0, dtype inScale=1)'],['../namespacenc_1_1random.html#ab2ecb1401cb11a3c816073fcbc7b05b5',1,'nc::random::laplace(const Shape &inShape, dtype inLoc=0, dtype inScale=1)']]], + ['lcm_2019',['lcm',['../namespacenc.html#a7ffd0c15b8419a5d84458d4009b38b88',1,'nc::lcm(dtype inValue1, dtype inValue2) noexcept'],['../namespacenc.html#aa69cf791720987deb546d71057a668a1',1,'nc::lcm(const NdArray< dtype > &inArray)']]], + ['ldexp_2020',['ldexp',['../namespacenc.html#aca805ef0273314ddc6c70b2c913bf485',1,'nc::ldexp(dtype inValue1, uint8 inValue2) noexcept'],['../namespacenc.html#a52060ff2d69ed791b3f19c1d78cf8551',1,'nc::ldexp(const NdArray< dtype > &inArray1, const NdArray< uint8 > &inArray2)']]], + ['left_2021',['left',['../classnc_1_1_vec3.html#a7e6730d945972ecda1815c1d41f5074c',1,'nc::Vec3::left()'],['../classnc_1_1_vec2.html#ade3f4342726264a1493f91ae80ab24ca',1,'nc::Vec2::left()']]], + ['left_5fshift_2022',['left_shift',['../namespacenc.html#a6f10270824079210d4264d50f5a64f4d',1,'nc']]], + ['legendre_5fp_2023',['legendre_p',['../namespacenc_1_1polynomial.html#a567bdffcff63421b77a9dfae9cbdfc8a',1,'nc::polynomial::legendre_p(uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a6a68bde646dae6ffb484502d54e5c175',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, dtype x)'],['../namespacenc_1_1polynomial.html#a10a5a1a92ac32725bb3d0496078f122e',1,'nc::polynomial::legendre_p(uint32 n, const NdArray< dtype > &inArrayX)'],['../namespacenc_1_1polynomial.html#aa3860199d898cdf173f3846cce684d72',1,'nc::polynomial::legendre_p(uint32 m, uint32 n, const NdArray< dtype > &inArrayX)']]], + ['legendre_5fq_2024',['legendre_q',['../namespacenc_1_1polynomial.html#a78897e159974d6732b77759be2f2da13',1,'nc::polynomial::legendre_q(int32 n, dtype x)'],['../namespacenc_1_1polynomial.html#aed5c95f5a321ec71c1a34a42414bec52',1,'nc::polynomial::legendre_q(int32 n, const NdArray< dtype > &inArrayX)']]], + ['legendrepolynomial_2025',['LegendrePolynomial',['../classnc_1_1integrate_1_1_legendre_polynomial.html#a2e1fefae138e66215cd7586a85fc3642',1,'nc::integrate::LegendrePolynomial']]], + ['lerp_2026',['lerp',['../classnc_1_1_vec2.html#a91e6417e5b9903ed6bee3ad90c0c38f4',1,'nc::Vec2::lerp()'],['../classnc_1_1_vec3.html#ab4878c8a4ebcd94fd0baf93059b50ac6',1,'nc::Vec3::lerp()']]], + ['less_2027',['less',['../namespacenc.html#a114baa0d21d439b7971dedd4b4042db8',1,'nc']]], + ['less_5fequal_2028',['less_equal',['../namespacenc.html#ac51b96f0ac720a028ebd856abf1b5785',1,'nc']]], + ['linspace_2029',['linspace',['../namespacenc.html#a672fbcbd2271d5fc58bd1b94750bbdcc',1,'nc']]], + ['load_2030',['load',['../namespacenc.html#abec5f2e4d2a1598de762e32b839a3067',1,'nc']]], + ['log_2031',['log',['../namespacenc.html#a3f08d373ae167ac90d3bb6b6c4da0fb9',1,'nc::log(dtype inValue) noexcept'],['../namespacenc.html#aba925957229bf54bfe854be197cd3d52',1,'nc::log(const NdArray< dtype > &inArray)']]], + ['log10_2032',['log10',['../namespacenc.html#a0d8a5ffeaed868463a6e55645c625c8f',1,'nc::log10(dtype inValue) noexcept'],['../namespacenc.html#a3cd82f65b6ee069a7d6443646dfecf67',1,'nc::log10(const NdArray< dtype > &inArray)']]], + ['log1p_2033',['log1p',['../namespacenc.html#a5abcc8523a49a47fd2224d5588f128b4',1,'nc::log1p(dtype inValue) noexcept'],['../namespacenc.html#a1ae30700a2db1cd8e44fa59b84c2b547',1,'nc::log1p(const NdArray< dtype > &inArray)']]], + ['log2_2034',['log2',['../namespacenc.html#a48cbc16dc706678b6f85e655e935cd41',1,'nc::log2(dtype inValue) noexcept'],['../namespacenc.html#a536e5046481a32bd6955a222f323393a',1,'nc::log2(const NdArray< dtype > &inArray)']]], + ['log_5fgamma_2035',['log_gamma',['../namespacenc_1_1special.html#a11ec3d4677a53eafd8b0144cd6e42ce3',1,'nc::special::log_gamma(dtype inValue)'],['../namespacenc_1_1special.html#addebe777849a11f027a793975a53b653',1,'nc::special::log_gamma(const NdArray< dtype > &inArray)']]], + ['logb_2036',['logb',['../namespacenc.html#a4925bc774ee8c671be4e15ba4305d230',1,'nc::logb(dtype inValue, dtype inBase) noexcept'],['../namespacenc.html#a512c632dd9629cbc02ad96398f82ab2a',1,'nc::logb(const NdArray< dtype > &inArray, dtype inBase)']]], + ['logical_5fand_2037',['logical_and',['../namespacenc.html#a951c3f9acd6147a8e2be1ab2cda4d51c',1,'nc']]], + ['logical_5fnot_2038',['logical_not',['../namespacenc.html#ae90620999105f741609c7f279cac2907',1,'nc']]], + ['logical_5for_2039',['logical_or',['../namespacenc.html#a0492e302b114ab15b996b1330604478b',1,'nc']]], + ['logical_5fxor_2040',['logical_xor',['../namespacenc.html#a7b84e63b2d32e1b59bfef4690c918989',1,'nc']]], + ['lognormal_2041',['lognormal',['../namespacenc_1_1random.html#a03d5528a3a97b3731210ba2cc5d1c75d',1,'nc::random::lognormal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#a3adc9de1025d27ed485603980657225b',1,'nc::random::lognormal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], + ['logspace_2042',['logspace',['../namespacenc.html#a4342eee2bea5ed3c8ece78b9119efc31',1,'nc']]], + ['lstsq_2043',['lstsq',['../namespacenc_1_1linalg.html#a9c15421c77e6b4b12fca1515596d1414',1,'nc::linalg']]], + ['lu_5fdecomposition_2044',['lu_decomposition',['../namespacenc_1_1linalg.html#a153a90dbcc2ca94c664c429868d15bc4',1,'nc::linalg']]] ]; diff --git a/docs/doxygen/html/search/functions_c.html b/docs/doxygen/html/search/functions_c.html index f9b23c34f..c4f326877 100644 --- a/docs/doxygen/html/search/functions_c.html +++ b/docs/doxygen/html/search/functions_c.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_c.js b/docs/doxygen/html/search/functions_c.js index c0e1db3df..6473dbb8e 100644 --- a/docs/doxygen/html/search/functions_c.js +++ b/docs/doxygen/html/search/functions_c.js @@ -1,28 +1,28 @@ var searchData= [ - ['makepositiveandvalidate_1948',['makePositiveAndValidate',['../classnc_1_1_slice.html#a4d518d51dad679d9a9c6938b065e38f8',1,'nc::Slice']]], - ['matmul_1949',['matmul',['../namespacenc.html#a9f795cdfcf86a07f1a7febcb9d024c73',1,'nc::matmul(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a82209f3c03cb63a659d28e7c87f7ee23',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#ab39e4a1bc6bcd0f28dbd5806d5f2d0b9',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)']]], - ['matrix_5fpower_1950',['matrix_power',['../namespacenc_1_1linalg.html#ad27c1996e4e27a6f8ba5d2aed0743bba',1,'nc::linalg']]], - ['max_1951',['max',['../classnc_1_1_dtype_info.html#a2a3dc0ba2812411660219f61189d8aca',1,'nc::DtypeInfo::max()'],['../namespacenc.html#a4d5872f22ac07aeba503857cb5948bc1',1,'nc::max()'],['../classnc_1_1_nd_array.html#abbca6c205525a4b706729f9f36acc06d',1,'nc::NdArray::max()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#acdf46b23b24e1421c38e6297c56024d1',1,'nc::DtypeInfo< std::complex< dtype > >::max()']]], - ['max_5felement_1952',['max_element',['../namespacenc_1_1stl__algorithms.html#a334cd50f7f10f689f82fa2ba7c5d88b2',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a282a4146afe33e4abb012e5c6b332948',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], - ['maximum_1953',['maximum',['../namespacenc.html#a417e75e173adaf0f6a9905a60a62e135',1,'nc']]], - ['maximumfilter_1954',['maximumFilter',['../namespacenc_1_1filter.html#a237010b21fd77fa3b72c1fda0360f6a9',1,'nc::filter']]], - ['maximumfilter1d_1955',['maximumFilter1d',['../namespacenc_1_1filter.html#a6760bbaeefd6338527665fa2426cf418',1,'nc::filter']]], - ['mean_1956',['mean',['../namespacenc.html#ac0b868e518c5b489ce25b8a84ebc618b',1,'nc::mean(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ae215351046b49fec834d006fd35a4078',1,'nc::mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], - ['median_1957',['median',['../namespacenc.html#a737b54d3ec786235c90211a3ad4a5cfb',1,'nc::median()'],['../classnc_1_1_nd_array.html#a4d733d7a90d94c3f21e90ab79dc2cc14',1,'nc::NdArray::median()']]], - ['medianfilter_1958',['medianFilter',['../namespacenc_1_1filter.html#a6edb931e0ad73a60625c4854f11ab82a',1,'nc::filter']]], - ['medianfilter1d_1959',['medianFilter1d',['../namespacenc_1_1filter.html#a39fc9c2648f0d223b63a5f1b7253bb40',1,'nc::filter']]], - ['meshgrid_1960',['meshgrid',['../namespacenc.html#ae392e03f9e01b088a082c6055082df49',1,'nc::meshgrid(const NdArray< dtype > &inICoords, const NdArray< dtype > &inJCoords)'],['../namespacenc.html#a2338e094bb1195888e3f385d01627c4f',1,'nc::meshgrid(const Slice &inSlice1, const Slice &inSlice2)']]], - ['min_1961',['min',['../classnc_1_1_nd_array.html#a7f0c49ac50a79ba24ea8d351ee70fd55',1,'nc::NdArray::min()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a420b21e23e9673bea71980f55bf82d03',1,'nc::DtypeInfo< std::complex< dtype > >::min()'],['../classnc_1_1_dtype_info.html#ab566f68bc6b82c06b5a3df887f87ab74',1,'nc::DtypeInfo::min()'],['../namespacenc.html#a8a61a49362258590b70289fd63fb2d8e',1,'nc::min()']]], - ['min_5felement_1962',['min_element',['../namespacenc_1_1stl__algorithms.html#af6291d1011c61c416134bc28def6f3ac',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#acb252e962fc7cedee9f4257453480d2b',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], - ['minimum_1963',['minimum',['../namespacenc.html#a8499c0529d36d402e32b3990d31429e8',1,'nc']]], - ['minimumfilter_1964',['minimumFilter',['../namespacenc_1_1filter.html#ad4b7a2f39d82320559353b151aec3585',1,'nc::filter']]], - ['minmax_5felement_1965',['minmax_element',['../namespacenc_1_1stl__algorithms.html#a919ee9141ca95be989ad9b872a7ebd27',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#ae1007b77aafe5a99b4952d9a8d8307af',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], - ['minumumfilter1d_1966',['minumumFilter1d',['../namespacenc_1_1filter.html#aca02565c2b898228312ef781bf4ed29c',1,'nc::filter']]], - ['minutes_1967',['minutes',['../classnc_1_1coordinates_1_1_dec.html#aeaa851b538014aae5bf909117e8fcb42',1,'nc::coordinates::Dec::minutes()'],['../classnc_1_1coordinates_1_1_r_a.html#a7f4f4c06b26cad116e250a0dc7553b02',1,'nc::coordinates::RA::minutes()']]], - ['mirror1d_1968',['mirror1d',['../namespacenc_1_1filter_1_1boundary.html#aaeb7c9f1da6f817190da9daa622c9c8d',1,'nc::filter::boundary']]], - ['mirror2d_1969',['mirror2d',['../namespacenc_1_1filter_1_1boundary.html#a2aaf003bb59428d53d1849dd188e10b8',1,'nc::filter::boundary']]], - ['mod_1970',['mod',['../namespacenc.html#ad8b53ff84658514a7007efba44802c5c',1,'nc']]], - ['multi_5fdot_1971',['multi_dot',['../namespacenc_1_1linalg.html#a86ab79e41b748e7ea0ee4f2e0bc462a6',1,'nc::linalg']]], - ['multiply_1972',['multiply',['../namespacenc.html#a6d7cd3b57c93a891a00d881832fdba77',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#aa6c517bf71575054de46518d7c0fce92',1,'nc::multiply(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a4965aed453e169ec8cbcd09a76b8afda',1,'nc::multiply(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#ad413820c1e92c7dcf83366f33399d6ef',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a78bbe031000f44fa4cdc0ad6b7825b7e',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#ace4de2d438459be581bd9fbc0c85c8d7',1,'nc::multiply(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a8bf62ccb0b68f25de562a08315dbb58e',1,'nc::multiply(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a786f53f7de209bb989c5965861d5dc27',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#afe5c0aa7fc5442e1453159e1fa78115a',1,'nc::multiply(dtype value, const NdArray< std::complex< dtype >> &inArray)']]] + ['makepositiveandvalidate_2045',['makePositiveAndValidate',['../classnc_1_1_slice.html#a4d518d51dad679d9a9c6938b065e38f8',1,'nc::Slice']]], + ['matmul_2046',['matmul',['../namespacenc.html#a9f795cdfcf86a07f1a7febcb9d024c73',1,'nc::matmul(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#ab39e4a1bc6bcd0f28dbd5806d5f2d0b9',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#a82209f3c03cb63a659d28e7c87f7ee23',1,'nc::matmul(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)']]], + ['matrix_5fpower_2047',['matrix_power',['../namespacenc_1_1linalg.html#ad27c1996e4e27a6f8ba5d2aed0743bba',1,'nc::linalg']]], + ['max_2048',['max',['../classnc_1_1_dtype_info.html#a2a3dc0ba2812411660219f61189d8aca',1,'nc::DtypeInfo::max()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#acdf46b23b24e1421c38e6297c56024d1',1,'nc::DtypeInfo< std::complex< dtype > >::max()'],['../classnc_1_1_nd_array.html#abbca6c205525a4b706729f9f36acc06d',1,'nc::NdArray::max()'],['../namespacenc.html#a4d5872f22ac07aeba503857cb5948bc1',1,'nc::max()']]], + ['max_5felement_2049',['max_element',['../namespacenc_1_1stl__algorithms.html#a334cd50f7f10f689f82fa2ba7c5d88b2',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a282a4146afe33e4abb012e5c6b332948',1,'nc::stl_algorithms::max_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['maximum_2050',['maximum',['../namespacenc.html#a417e75e173adaf0f6a9905a60a62e135',1,'nc']]], + ['maximumfilter_2051',['maximumFilter',['../namespacenc_1_1filter.html#a237010b21fd77fa3b72c1fda0360f6a9',1,'nc::filter']]], + ['maximumfilter1d_2052',['maximumFilter1d',['../namespacenc_1_1filter.html#a6760bbaeefd6338527665fa2426cf418',1,'nc::filter']]], + ['mean_2053',['mean',['../namespacenc.html#ae215351046b49fec834d006fd35a4078',1,'nc::mean(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#ac0b868e518c5b489ce25b8a84ebc618b',1,'nc::mean(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['median_2054',['median',['../classnc_1_1_nd_array.html#a4d733d7a90d94c3f21e90ab79dc2cc14',1,'nc::NdArray::median()'],['../namespacenc.html#a737b54d3ec786235c90211a3ad4a5cfb',1,'nc::median()']]], + ['medianfilter_2055',['medianFilter',['../namespacenc_1_1filter.html#a6edb931e0ad73a60625c4854f11ab82a',1,'nc::filter']]], + ['medianfilter1d_2056',['medianFilter1d',['../namespacenc_1_1filter.html#a39fc9c2648f0d223b63a5f1b7253bb40',1,'nc::filter']]], + ['meshgrid_2057',['meshgrid',['../namespacenc.html#ae392e03f9e01b088a082c6055082df49',1,'nc::meshgrid(const NdArray< dtype > &inICoords, const NdArray< dtype > &inJCoords)'],['../namespacenc.html#a2338e094bb1195888e3f385d01627c4f',1,'nc::meshgrid(const Slice &inSlice1, const Slice &inSlice2)']]], + ['min_2058',['min',['../classnc_1_1_dtype_info.html#ab566f68bc6b82c06b5a3df887f87ab74',1,'nc::DtypeInfo::min()'],['../classnc_1_1_nd_array.html#a7f0c49ac50a79ba24ea8d351ee70fd55',1,'nc::NdArray::min()'],['../classnc_1_1_dtype_info_3_01std_1_1complex_3_01dtype_01_4_01_4.html#a420b21e23e9673bea71980f55bf82d03',1,'nc::DtypeInfo< std::complex< dtype > >::min()'],['../namespacenc.html#a8a61a49362258590b70289fd63fb2d8e',1,'nc::min()']]], + ['min_5felement_2059',['min_element',['../namespacenc_1_1stl__algorithms.html#af6291d1011c61c416134bc28def6f3ac',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#acb252e962fc7cedee9f4257453480d2b',1,'nc::stl_algorithms::min_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['minimum_2060',['minimum',['../namespacenc.html#a8499c0529d36d402e32b3990d31429e8',1,'nc']]], + ['minimumfilter_2061',['minimumFilter',['../namespacenc_1_1filter.html#ad4b7a2f39d82320559353b151aec3585',1,'nc::filter']]], + ['minmax_5felement_2062',['minmax_element',['../namespacenc_1_1stl__algorithms.html#a919ee9141ca95be989ad9b872a7ebd27',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#ae1007b77aafe5a99b4952d9a8d8307af',1,'nc::stl_algorithms::minmax_element(ForwardIt first, ForwardIt last, Compare comp) noexcept']]], + ['minumumfilter1d_2063',['minumumFilter1d',['../namespacenc_1_1filter.html#aca02565c2b898228312ef781bf4ed29c',1,'nc::filter']]], + ['minutes_2064',['minutes',['../classnc_1_1coordinates_1_1_dec.html#aeaa851b538014aae5bf909117e8fcb42',1,'nc::coordinates::Dec::minutes()'],['../classnc_1_1coordinates_1_1_r_a.html#a7f4f4c06b26cad116e250a0dc7553b02',1,'nc::coordinates::RA::minutes()']]], + ['mirror1d_2065',['mirror1d',['../namespacenc_1_1filter_1_1boundary.html#aaeb7c9f1da6f817190da9daa622c9c8d',1,'nc::filter::boundary']]], + ['mirror2d_2066',['mirror2d',['../namespacenc_1_1filter_1_1boundary.html#a2aaf003bb59428d53d1849dd188e10b8',1,'nc::filter::boundary']]], + ['mod_2067',['mod',['../namespacenc.html#ad8b53ff84658514a7007efba44802c5c',1,'nc']]], + ['multi_5fdot_2068',['multi_dot',['../namespacenc_1_1linalg.html#a86ab79e41b748e7ea0ee4f2e0bc462a6',1,'nc::linalg']]], + ['multiply_2069',['multiply',['../namespacenc.html#a6d7cd3b57c93a891a00d881832fdba77',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#aa6c517bf71575054de46518d7c0fce92',1,'nc::multiply(const NdArray< dtype > &inArray, dtype value)'],['../namespacenc.html#a4965aed453e169ec8cbcd09a76b8afda',1,'nc::multiply(dtype value, const NdArray< dtype > &inArray)'],['../namespacenc.html#ad413820c1e92c7dcf83366f33399d6ef',1,'nc::multiply(const NdArray< dtype > &inArray1, const NdArray< std::complex< dtype >> &inArray2)'],['../namespacenc.html#a78bbe031000f44fa4cdc0ad6b7825b7e',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray1, const NdArray< dtype > &inArray2)'],['../namespacenc.html#ace4de2d438459be581bd9fbc0c85c8d7',1,'nc::multiply(const NdArray< dtype > &inArray, const std::complex< dtype > &value)'],['../namespacenc.html#a8bf62ccb0b68f25de562a08315dbb58e',1,'nc::multiply(const std::complex< dtype > &value, const NdArray< dtype > &inArray)'],['../namespacenc.html#a786f53f7de209bb989c5965861d5dc27',1,'nc::multiply(const NdArray< std::complex< dtype >> &inArray, dtype value)'],['../namespacenc.html#afe5c0aa7fc5442e1453159e1fa78115a',1,'nc::multiply(dtype value, const NdArray< std::complex< dtype >> &inArray)']]] ]; diff --git a/docs/doxygen/html/search/functions_d.html b/docs/doxygen/html/search/functions_d.html index 858039b83..7a1ed065d 100644 --- a/docs/doxygen/html/search/functions_d.html +++ b/docs/doxygen/html/search/functions_d.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_d.js b/docs/doxygen/html/search/functions_d.js index c8174e07d..e88bbcb87 100644 --- a/docs/doxygen/html/search/functions_d.js +++ b/docs/doxygen/html/search/functions_d.js @@ -1,45 +1,48 @@ var searchData= [ - ['name_1973',['name',['../classnc_1_1filesystem_1_1_file.html#a29fd40eb720c1caad3dcef59e2f215a4',1,'nc::filesystem::File']]], - ['nan_5fto_5fnum_1974',['nan_to_num',['../namespacenc.html#ab5b2173fccfe4b4a8c91edb704c51b12',1,'nc']]], - ['nanargmax_1975',['nanargmax',['../namespacenc.html#a5f3d3d15fae35dc9538f6daa792f3e1b',1,'nc']]], - ['nanargmin_1976',['nanargmin',['../namespacenc.html#a0c69df200cbe88324129ae3c6fc05330',1,'nc']]], - ['nancumprod_1977',['nancumprod',['../namespacenc.html#ad22449b2b6c92860eed3670d68ea4ba4',1,'nc']]], - ['nancumsum_1978',['nancumsum',['../namespacenc.html#a626089b225be4978da275ef9a7ecf451',1,'nc']]], - ['nanmax_1979',['nanmax',['../namespacenc.html#a00ab1c4ed4358cba5e87a3d107720474',1,'nc']]], - ['nanmean_1980',['nanmean',['../namespacenc.html#acac66186b7fff8d8cdc1dd3f37b98297',1,'nc']]], - ['nanmedian_1981',['nanmedian',['../namespacenc.html#a60fd6cc6607d10bf8fe4913a5daa7f3a',1,'nc']]], - ['nanmin_1982',['nanmin',['../namespacenc.html#a2f4b9832c72a282a23da1dad186d36d8',1,'nc']]], - ['nanpercentile_1983',['nanpercentile',['../namespacenc.html#ade1f6fe4e6860b046b50e05252a61c0a',1,'nc']]], - ['nanprod_1984',['nanprod',['../namespacenc.html#a8121a0aa2907751c6fd7db34dfc28719',1,'nc']]], - ['nans_1985',['nans',['../classnc_1_1_nd_array.html#aa7592409ea9bc24e4324725e5ff74ee9',1,'nc::NdArray::nans()'],['../namespacenc.html#a6bec1d7117a467081676bfd8d31fcd87',1,'nc::nans(const Shape &inShape)'],['../namespacenc.html#aea74254d1b55e5b9adf1e6610b0da9d6',1,'nc::nans(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a1c3fe37572a53d83154138b2de5d5e8b',1,'nc::nans(uint32 inSquareSize)']]], - ['nans_5flike_1986',['nans_like',['../namespacenc.html#aae8b7e12e53ff6e21d555c1eabadf615',1,'nc']]], - ['nanstdev_1987',['nanstdev',['../namespacenc.html#a3ae8768b4362f564849bc2ba0115450a',1,'nc']]], - ['nansum_1988',['nansum',['../namespacenc.html#a69b05488ef7b28eefa3bc733836a4e48',1,'nc']]], - ['nanvar_1989',['nanvar',['../namespacenc.html#a333035c5f246c01da1de4ae7015f5715',1,'nc']]], - ['nbytes_1990',['nbytes',['../namespacenc.html#a66464387c8d92793b5355e2afd107cbc',1,'nc::nbytes()'],['../classnc_1_1_nd_array.html#a775e07af6829b5336969c703c4eddba7',1,'nc::NdArray::nbytes() const noexcept']]], - ['ndarray_1991',['NdArray',['../classnc_1_1_nd_array.html#a567a45c944672939e89fa507236d1158',1,'nc::NdArray::NdArray(const std::deque< std::deque< dtype >> &in2dDeque)'],['../classnc_1_1_nd_array.html#a46c4fbd999ab1d612586191a15ada4b7',1,'nc::NdArray::NdArray(Iterator inFirst, Iterator inLast)'],['../classnc_1_1_nd_array.html#ad94cfcf69d664d94e81fc98a0a61d193',1,'nc::NdArray::NdArray(const std::deque< dtype > &inDeque)'],['../classnc_1_1_nd_array.html#a00cddf06371547d613388cefeece2cc0',1,'nc::NdArray::NdArray(std::vector< std::array< dtype, Dim1Size >> &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a9d7045ecdff86bac3306a8bfd9a787eb',1,'nc::NdArray::NdArray(const std::vector< std::vector< dtype >> &in2dVector)'],['../classnc_1_1_nd_array.html#a1847487093139deb6a541cfaa43c3d90',1,'nc::NdArray::NdArray(std::vector< dtype > &inVector, bool copy=true)'],['../classnc_1_1_nd_array.html#ad9ccdeb2572f239a33ca5fbb473b513a',1,'nc::NdArray::NdArray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#ad724d08ab913c125a38bc528e68cad8e',1,'nc::NdArray::NdArray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a1877502ba79a59c3a9b144e6111def1a',1,'nc::NdArray::NdArray(const std::initializer_list< std::initializer_list< dtype > > &inList)'],['../classnc_1_1_nd_array.html#a9b5658aaaff185187c964a6bf3f4f5a3',1,'nc::NdArray::NdArray(const std::initializer_list< dtype > &inList)'],['../classnc_1_1_nd_array.html#af8cd2e1b7214c4b8b8b784e1b5265c11',1,'nc::NdArray::NdArray(const Shape &inShape)'],['../classnc_1_1_nd_array.html#a8509cda74ae6f29995dd8a9f27d30d11',1,'nc::NdArray::NdArray(size_type inNumRows, size_type inNumCols)'],['../classnc_1_1_nd_array.html#a91801907e76fd8ecc9ce7ff3b85ea9bd',1,'nc::NdArray::NdArray(size_type inSquareSize)'],['../classnc_1_1_nd_array.html#a7b46bea4f56ab2327fc291dac4e75788',1,'nc::NdArray::NdArray()=default'],['../classnc_1_1_nd_array.html#a7b0f43ea1853dcc471949c0e7eb977f5',1,'nc::NdArray::NdArray(const std::list< dtype > &inList)'],['../classnc_1_1_nd_array.html#ad8160a6009ce9c0c8bbb384261ce18bb',1,'nc::NdArray::NdArray(const_pointer inPtr, size_type size)'],['../classnc_1_1_nd_array.html#a7473135d0434a04abec09a884b5683cc',1,'nc::NdArray::NdArray(const_pointer inPtr, UIntType1 numRows, UIntType2 numCols)'],['../classnc_1_1_nd_array.html#aee44fee3e2c882d490898c082db39449',1,'nc::NdArray::NdArray(pointer inPtr, size_type size, Bool takeOwnership) noexcept'],['../classnc_1_1_nd_array.html#aa6bf0b18b1ebb54b2a1fd4e4b33253dd',1,'nc::NdArray::NdArray(NdArray< dtype > &&inOtherArray) noexcept'],['../classnc_1_1_nd_array.html#ae04a364f503fe72c06d2f7cd78e712d6',1,'nc::NdArray::NdArray(const NdArray< dtype > &inOtherArray)'],['../classnc_1_1_nd_array.html#a7fcb1cf40a8402e8ba6353e58eed8dbd',1,'nc::NdArray::NdArray(pointer inPtr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept']]], - ['ndarrayconstcolumniterator_1992',['NdArrayConstColumnIterator',['../classnc_1_1_nd_array_const_column_iterator.html#aff03e1020fa6e935fb0fe2a926a4f378',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator(pointer ptr, SizeType numRows, SizeType numCols) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a3c779a77e6a0920d8fc799931feb3c3d',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator()=default']]], - ['ndarrayconstiterator_1993',['NdArrayConstIterator',['../classnc_1_1_nd_array_const_iterator.html#a8f0504fbf9ea4d0f89cda5b7e120b6f0',1,'nc::NdArrayConstIterator::NdArrayConstIterator(pointer ptr)'],['../classnc_1_1_nd_array_const_iterator.html#a518e77992a6b8710c2d43734a84f2006',1,'nc::NdArrayConstIterator::NdArrayConstIterator()=default']]], - ['nearest1d_1994',['nearest1d',['../namespacenc_1_1filter_1_1boundary.html#ac5f60c43aa94490993eee9fcc1e105b1',1,'nc::filter::boundary']]], - ['nearest2d_1995',['nearest2d',['../namespacenc_1_1filter_1_1boundary.html#a7f70d66ead018652239bb3334a040850',1,'nc::filter::boundary']]], - ['negative_1996',['negative',['../namespacenc.html#a678a4671c949113db1578078d409bb91',1,'nc']]], - ['negativebinomial_1997',['negativeBinomial',['../namespacenc_1_1random.html#a1a15a08fe9134f5dcf5e7b32eb1de5e2',1,'nc::random::negativeBinomial(dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#ac6181e54b9cae303574f9c5fad33cfc2',1,'nc::random::negativeBinomial(const Shape &inShape, dtype inN, double inP=0.5)']]], - ['newbyteorder_1998',['newbyteorder',['../classnc_1_1_nd_array.html#ae5fe2e501921c3361c0edc66030b772d',1,'nc::NdArray::newbyteorder()'],['../namespacenc.html#a4d2ae51817f2acee83e2df0e04a8bac5',1,'nc::newbyteorder(dtype inValue, Endian inEndianess)'],['../namespacenc.html#adfc5c49151c50d90fce45c676b0fcaa4',1,'nc::newbyteorder(const NdArray< dtype > &inArray, Endian inEndianess)']]], - ['newton_1999',['Newton',['../classnc_1_1roots_1_1_newton.html#ab5b82361c4ce325e6165e023c0255d3e',1,'nc::roots::Newton::Newton(const double epsilon, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept'],['../classnc_1_1roots_1_1_newton.html#aecc72e3899f42b277536689439ea24bc',1,'nc::roots::Newton::Newton(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept']]], - ['nlerp_2000',['nlerp',['../classnc_1_1rotations_1_1_quaternion.html#a314478702a3da52f2be3f422057d8732',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)'],['../classnc_1_1rotations_1_1_quaternion.html#ab055510c1338490b957de867cecaf790',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat2, double inPercent) const']]], - ['noncentralchisquared_2001',['nonCentralChiSquared',['../namespacenc_1_1random.html#abf3cab0396026700ebf2d2ffa5e13fa6',1,'nc::random::nonCentralChiSquared(dtype inK=1, dtype inLambda=1)'],['../namespacenc_1_1random.html#af01395c7355ee4c0f36441c40039e82d',1,'nc::random::nonCentralChiSquared(const Shape &inShape, dtype inK=1, dtype inLambda=1)']]], - ['none_2002',['none',['../namespacenc.html#ada2840f1202c44082ee75b5f5705399d',1,'nc::none()'],['../classnc_1_1_nd_array.html#a379f8cd88dc84a38d668cb7bf97078ee',1,'nc::NdArray::none()']]], - ['none_5fof_2003',['none_of',['../namespacenc_1_1stl__algorithms.html#a2804ccb14980f96c7680838adc3b2762',1,'nc::stl_algorithms']]], - ['nonzero_2004',['nonzero',['../classnc_1_1_nd_array.html#a6cc8c7b53a707468d6da112849970904',1,'nc::NdArray::nonzero()'],['../namespacenc.html#a46ce9bcc6ba641e0550934b981175683',1,'nc::nonzero(const NdArray< dtype > &inArray)']]], - ['norm_2005',['norm',['../namespacenc.html#aa57b910a1d9a448a15e76bd72563ac5d',1,'nc::norm(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a13467936d679d6d078d585504bc42642',1,'nc::norm(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)'],['../classnc_1_1_vec2.html#ab6922f6c089b20e9d019301fddc6dc0a',1,'nc::Vec2::norm()'],['../classnc_1_1_vec3.html#a6c177e1f5c00584279a0527d3053dee8',1,'nc::Vec3::norm()']]], - ['normal_2006',['normal',['../namespacenc_1_1random.html#a0d52ff6ccaa63bc36348ba39e5936056',1,'nc::random::normal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#ab655c4af3dac07aeff39efd50c120f4d',1,'nc::random::normal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], - ['normalize_2007',['normalize',['../classnc_1_1_vec3.html#a6356b462b11a156b923a7c79b9747c25',1,'nc::Vec3::normalize()'],['../classnc_1_1_vec2.html#a8d8a3ec28ef8336ab02dcd964a3e836c',1,'nc::Vec2::normalize()']]], - ['not_5fequal_2008',['not_equal',['../namespacenc.html#ac6c0da616068bc667891c0a460431de3',1,'nc']]], - ['nth_5felement_2009',['nth_element',['../namespacenc_1_1stl__algorithms.html#af5ef45ab7814938799020ad24358b734',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a9928869b550b082898709c5671936079',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last, Compare comp) noexcept']]], - ['num2str_2010',['num2str',['../namespacenc_1_1utils.html#a16a6ad93c420ed7a003d9921bee1a7c6',1,'nc::utils']]], - ['numcols_2011',['numCols',['../classnc_1_1_nd_array.html#a0049b5d6d1d99463edc773f01eb7c091',1,'nc::NdArray']]], - ['numelements_2012',['numElements',['../classnc_1_1_slice.html#aab35be40c38521a4bd9b3c99b3d33731',1,'nc::Slice']]], - ['numiterations_2013',['numIterations',['../classnc_1_1roots_1_1_iteration.html#ab3192d0f9de4b8b27b23013c65489e5a',1,'nc::roots::Iteration']]], - ['numrows_2014',['numRows',['../classnc_1_1_nd_array.html#a2dbdc72c98c216a133f7e1a8d3c067f7',1,'nc::NdArray']]] + ['name_2070',['name',['../classnc_1_1filesystem_1_1_file.html#a29fd40eb720c1caad3dcef59e2f215a4',1,'nc::filesystem::File']]], + ['nan_5fto_5fnum_2071',['nan_to_num',['../namespacenc.html#ab5b2173fccfe4b4a8c91edb704c51b12',1,'nc']]], + ['nanargmax_2072',['nanargmax',['../namespacenc.html#a5f3d3d15fae35dc9538f6daa792f3e1b',1,'nc']]], + ['nanargmin_2073',['nanargmin',['../namespacenc.html#a0c69df200cbe88324129ae3c6fc05330',1,'nc']]], + ['nancumprod_2074',['nancumprod',['../namespacenc.html#ad22449b2b6c92860eed3670d68ea4ba4',1,'nc']]], + ['nancumsum_2075',['nancumsum',['../namespacenc.html#a626089b225be4978da275ef9a7ecf451',1,'nc']]], + ['nanmax_2076',['nanmax',['../namespacenc.html#a00ab1c4ed4358cba5e87a3d107720474',1,'nc']]], + ['nanmean_2077',['nanmean',['../namespacenc.html#acac66186b7fff8d8cdc1dd3f37b98297',1,'nc']]], + ['nanmedian_2078',['nanmedian',['../namespacenc.html#a60fd6cc6607d10bf8fe4913a5daa7f3a',1,'nc']]], + ['nanmin_2079',['nanmin',['../namespacenc.html#a2f4b9832c72a282a23da1dad186d36d8',1,'nc']]], + ['nanpercentile_2080',['nanpercentile',['../namespacenc.html#ade1f6fe4e6860b046b50e05252a61c0a',1,'nc']]], + ['nanprod_2081',['nanprod',['../namespacenc.html#a8121a0aa2907751c6fd7db34dfc28719',1,'nc']]], + ['nans_2082',['nans',['../classnc_1_1_nd_array.html#aa7592409ea9bc24e4324725e5ff74ee9',1,'nc::NdArray::nans()'],['../namespacenc.html#a6bec1d7117a467081676bfd8d31fcd87',1,'nc::nans(const Shape &inShape)'],['../namespacenc.html#aea74254d1b55e5b9adf1e6610b0da9d6',1,'nc::nans(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#a1c3fe37572a53d83154138b2de5d5e8b',1,'nc::nans(uint32 inSquareSize)']]], + ['nans_5flike_2083',['nans_like',['../namespacenc.html#aae8b7e12e53ff6e21d555c1eabadf615',1,'nc']]], + ['nanstdev_2084',['nanstdev',['../namespacenc.html#a3ae8768b4362f564849bc2ba0115450a',1,'nc']]], + ['nansum_2085',['nansum',['../namespacenc.html#a69b05488ef7b28eefa3bc733836a4e48',1,'nc']]], + ['nanvar_2086',['nanvar',['../namespacenc.html#a333035c5f246c01da1de4ae7015f5715',1,'nc']]], + ['nbytes_2087',['nbytes',['../classnc_1_1_nd_array.html#a775e07af6829b5336969c703c4eddba7',1,'nc::NdArray::nbytes()'],['../namespacenc.html#a66464387c8d92793b5355e2afd107cbc',1,'nc::nbytes()']]], + ['ndarray_2088',['NdArray',['../classnc_1_1_nd_array.html#a7b46bea4f56ab2327fc291dac4e75788',1,'nc::NdArray::NdArray()=default'],['../classnc_1_1_nd_array.html#a91801907e76fd8ecc9ce7ff3b85ea9bd',1,'nc::NdArray::NdArray(size_type inSquareSize)'],['../classnc_1_1_nd_array.html#a8509cda74ae6f29995dd8a9f27d30d11',1,'nc::NdArray::NdArray(size_type inNumRows, size_type inNumCols)'],['../classnc_1_1_nd_array.html#af8cd2e1b7214c4b8b8b784e1b5265c11',1,'nc::NdArray::NdArray(const Shape &inShape)'],['../classnc_1_1_nd_array.html#a66ae5664d66e900a48ca1d9a607f655e',1,'nc::NdArray::NdArray(std::initializer_list< dtype > inList)'],['../classnc_1_1_nd_array.html#a1877502ba79a59c3a9b144e6111def1a',1,'nc::NdArray::NdArray(const std::initializer_list< std::initializer_list< dtype > > &inList)'],['../classnc_1_1_nd_array.html#ad724d08ab913c125a38bc528e68cad8e',1,'nc::NdArray::NdArray(std::array< dtype, ArraySize > &inArray, bool copy=true)'],['../classnc_1_1_nd_array.html#a1847487093139deb6a541cfaa43c3d90',1,'nc::NdArray::NdArray(std::vector< dtype > &inVector, bool copy=true)'],['../classnc_1_1_nd_array.html#a9d7045ecdff86bac3306a8bfd9a787eb',1,'nc::NdArray::NdArray(const std::vector< std::vector< dtype >> &in2dVector)'],['../classnc_1_1_nd_array.html#a00cddf06371547d613388cefeece2cc0',1,'nc::NdArray::NdArray(std::vector< std::array< dtype, Dim1Size >> &in2dArray, bool copy=true)'],['../classnc_1_1_nd_array.html#ad94cfcf69d664d94e81fc98a0a61d193',1,'nc::NdArray::NdArray(const std::deque< dtype > &inDeque)'],['../classnc_1_1_nd_array.html#a567a45c944672939e89fa507236d1158',1,'nc::NdArray::NdArray(const std::deque< std::deque< dtype >> &in2dDeque)'],['../classnc_1_1_nd_array.html#a7b0f43ea1853dcc471949c0e7eb977f5',1,'nc::NdArray::NdArray(const std::list< dtype > &inList)'],['../classnc_1_1_nd_array.html#a46c4fbd999ab1d612586191a15ada4b7',1,'nc::NdArray::NdArray(Iterator inFirst, Iterator inLast)'],['../classnc_1_1_nd_array.html#ad8160a6009ce9c0c8bbb384261ce18bb',1,'nc::NdArray::NdArray(const_pointer inPtr, size_type size)'],['../classnc_1_1_nd_array.html#a7473135d0434a04abec09a884b5683cc',1,'nc::NdArray::NdArray(const_pointer inPtr, UIntType1 numRows, UIntType2 numCols)'],['../classnc_1_1_nd_array.html#aee44fee3e2c882d490898c082db39449',1,'nc::NdArray::NdArray(pointer inPtr, size_type size, Bool takeOwnership) noexcept'],['../classnc_1_1_nd_array.html#a7fcb1cf40a8402e8ba6353e58eed8dbd',1,'nc::NdArray::NdArray(pointer inPtr, uint32 numRows, uint32 numCols, Bool takeOwnership) noexcept'],['../classnc_1_1_nd_array.html#ae04a364f503fe72c06d2f7cd78e712d6',1,'nc::NdArray::NdArray(const NdArray< dtype > &inOtherArray)'],['../classnc_1_1_nd_array.html#aa6bf0b18b1ebb54b2a1fd4e4b33253dd',1,'nc::NdArray::NdArray(NdArray< dtype > &&inOtherArray) noexcept'],['../classnc_1_1_nd_array.html#ad9ccdeb2572f239a33ca5fbb473b513a',1,'nc::NdArray::NdArray(std::array< std::array< dtype, Dim1Size >, Dim0Size > &in2dArray, bool copy=true)']]], + ['ndarrayconstcolumniterator_2089',['NdArrayConstColumnIterator',['../classnc_1_1_nd_array_const_column_iterator.html#a3c779a77e6a0920d8fc799931feb3c3d',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator()=default'],['../classnc_1_1_nd_array_const_column_iterator.html#aff03e1020fa6e935fb0fe2a926a4f378',1,'nc::NdArrayConstColumnIterator::NdArrayConstColumnIterator(pointer ptr, SizeType numRows, SizeType numCols) noexcept']]], + ['ndarrayconstiterator_2090',['NdArrayConstIterator',['../classnc_1_1_nd_array_const_iterator.html#a8f0504fbf9ea4d0f89cda5b7e120b6f0',1,'nc::NdArrayConstIterator::NdArrayConstIterator(pointer ptr)'],['../classnc_1_1_nd_array_const_iterator.html#a518e77992a6b8710c2d43734a84f2006',1,'nc::NdArrayConstIterator::NdArrayConstIterator()=default']]], + ['nearest1d_2091',['nearest1d',['../namespacenc_1_1filter_1_1boundary.html#ac5f60c43aa94490993eee9fcc1e105b1',1,'nc::filter::boundary']]], + ['nearest2d_2092',['nearest2d',['../namespacenc_1_1filter_1_1boundary.html#a7f70d66ead018652239bb3334a040850',1,'nc::filter::boundary']]], + ['negative_2093',['negative',['../namespacenc.html#a678a4671c949113db1578078d409bb91',1,'nc']]], + ['negativebinomial_2094',['negativeBinomial',['../namespacenc_1_1random.html#ac6181e54b9cae303574f9c5fad33cfc2',1,'nc::random::negativeBinomial(const Shape &inShape, dtype inN, double inP=0.5)'],['../namespacenc_1_1random.html#a1a15a08fe9134f5dcf5e7b32eb1de5e2',1,'nc::random::negativeBinomial(dtype inN, double inP=0.5)']]], + ['newbyteorder_2095',['newbyteorder',['../namespacenc.html#adfc5c49151c50d90fce45c676b0fcaa4',1,'nc::newbyteorder(const NdArray< dtype > &inArray, Endian inEndianess)'],['../namespacenc.html#a4d2ae51817f2acee83e2df0e04a8bac5',1,'nc::newbyteorder(dtype inValue, Endian inEndianess)'],['../classnc_1_1_nd_array.html#ae5fe2e501921c3361c0edc66030b772d',1,'nc::NdArray::newbyteorder()']]], + ['newton_2096',['Newton',['../classnc_1_1roots_1_1_newton.html#aecc72e3899f42b277536689439ea24bc',1,'nc::roots::Newton::Newton(const double epsilon, const uint32 maxNumIterations, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept'],['../classnc_1_1roots_1_1_newton.html#ab5b82361c4ce325e6165e023c0255d3e',1,'nc::roots::Newton::Newton(const double epsilon, std::function< double(double)> f, std::function< double(double)> fPrime) noexcept']]], + ['nextpoweroftwo_2097',['nextPowerOfTwo',['../namespacenc_1_1edac_1_1detail.html#a279241a794bffbea6920299cf8e5c4a1',1,'nc::edac::detail']]], + ['nlerp_2098',['nlerp',['../classnc_1_1rotations_1_1_quaternion.html#ab055510c1338490b957de867cecaf790',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat2, double inPercent) const'],['../classnc_1_1rotations_1_1_quaternion.html#a314478702a3da52f2be3f422057d8732',1,'nc::rotations::Quaternion::nlerp(const Quaternion &inQuat1, const Quaternion &inQuat2, double inPercent)']]], + ['noncentralchisquared_2099',['nonCentralChiSquared',['../namespacenc_1_1random.html#af01395c7355ee4c0f36441c40039e82d',1,'nc::random::nonCentralChiSquared(const Shape &inShape, dtype inK=1, dtype inLambda=1)'],['../namespacenc_1_1random.html#abf3cab0396026700ebf2d2ffa5e13fa6',1,'nc::random::nonCentralChiSquared(dtype inK=1, dtype inLambda=1)']]], + ['none_2100',['none',['../classnc_1_1_nd_array.html#a379f8cd88dc84a38d668cb7bf97078ee',1,'nc::NdArray::none()'],['../namespacenc.html#ada2840f1202c44082ee75b5f5705399d',1,'nc::none()']]], + ['none_5fof_2101',['none_of',['../namespacenc_1_1stl__algorithms.html#a2804ccb14980f96c7680838adc3b2762',1,'nc::stl_algorithms']]], + ['nonzero_2102',['nonzero',['../classnc_1_1_nd_array.html#a6cc8c7b53a707468d6da112849970904',1,'nc::NdArray::nonzero()'],['../namespacenc.html#a46ce9bcc6ba641e0550934b981175683',1,'nc::nonzero()']]], + ['norm_2103',['norm',['../classnc_1_1_vec2.html#ab6922f6c089b20e9d019301fddc6dc0a',1,'nc::Vec2::norm()'],['../classnc_1_1_vec3.html#a6c177e1f5c00584279a0527d3053dee8',1,'nc::Vec3::norm()'],['../namespacenc.html#aa57b910a1d9a448a15e76bd72563ac5d',1,'nc::norm(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)'],['../namespacenc.html#a13467936d679d6d078d585504bc42642',1,'nc::norm(const NdArray< std::complex< dtype >> &inArray, Axis inAxis=Axis::NONE)']]], + ['normal_2104',['normal',['../namespacenc_1_1random.html#a0d52ff6ccaa63bc36348ba39e5936056',1,'nc::random::normal(dtype inMean=0, dtype inSigma=1)'],['../namespacenc_1_1random.html#ab655c4af3dac07aeff39efd50c120f4d',1,'nc::random::normal(const Shape &inShape, dtype inMean=0, dtype inSigma=1)']]], + ['normalize_2105',['normalize',['../classnc_1_1_vec2.html#a8d8a3ec28ef8336ab02dcd964a3e836c',1,'nc::Vec2::normalize()'],['../classnc_1_1_vec3.html#a6356b462b11a156b923a7c79b9747c25',1,'nc::Vec3::normalize()']]], + ['not_5fequal_2106',['not_equal',['../namespacenc.html#ac6c0da616068bc667891c0a460431de3',1,'nc']]], + ['nth_5felement_2107',['nth_element',['../namespacenc_1_1stl__algorithms.html#af5ef45ab7814938799020ad24358b734',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last) noexcept'],['../namespacenc_1_1stl__algorithms.html#a9928869b550b082898709c5671936079',1,'nc::stl_algorithms::nth_element(RandomIt first, RandomIt nth, RandomIt last, Compare comp) noexcept']]], + ['nth_5froot_2108',['nth_root',['../namespacenc.html#aae5eb97b7313026b451ac4d7c01db027',1,'nc::nth_root(dtype1 inValue, dtype2 inRoot) noexcept'],['../namespacenc.html#a6da3daf9d73c1cea2e69c77f62b267b0',1,'nc::nth_root(const NdArray< dtype1 > &inArray, dtype2 inRoot)']]], + ['num2str_2109',['num2str',['../namespacenc_1_1utils.html#a16a6ad93c420ed7a003d9921bee1a7c6',1,'nc::utils']]], + ['numcols_2110',['numCols',['../classnc_1_1_nd_array.html#a0049b5d6d1d99463edc773f01eb7c091',1,'nc::NdArray']]], + ['numelements_2111',['numElements',['../classnc_1_1_slice.html#aab35be40c38521a4bd9b3c99b3d33731',1,'nc::Slice']]], + ['numiterations_2112',['numIterations',['../classnc_1_1roots_1_1_iteration.html#ab3192d0f9de4b8b27b23013c65489e5a',1,'nc::roots::Iteration']]], + ['numrows_2113',['numRows',['../classnc_1_1_nd_array.html#a2dbdc72c98c216a133f7e1a8d3c067f7',1,'nc::NdArray']]], + ['numsecdedparitybitsneeded_2114',['numSecdedParityBitsNeeded',['../namespacenc_1_1edac_1_1detail.html#a6ee59971c08bfdc3e11a0245f17d5f9a',1,'nc::edac::detail']]] ]; diff --git a/docs/doxygen/html/search/functions_e.html b/docs/doxygen/html/search/functions_e.html index edb386f60..22d2a6bf5 100644 --- a/docs/doxygen/html/search/functions_e.html +++ b/docs/doxygen/html/search/functions_e.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_e.js b/docs/doxygen/html/search/functions_e.js index 05e25baef..933d17d44 100644 --- a/docs/doxygen/html/search/functions_e.js +++ b/docs/doxygen/html/search/functions_e.js @@ -1,44 +1,44 @@ var searchData= [ - ['ones_2015',['ones',['../classnc_1_1_nd_array.html#ac6e5a0c875c593a6bc1970745af3684b',1,'nc::NdArray::ones()'],['../namespacenc.html#a5a935c0d187c7a0cab3d7ada27ffafc5',1,'nc::ones(const Shape &inShape)'],['../namespacenc.html#a0f6db9a6dcb85c14639b515f53d6b893',1,'nc::ones(uint32 inNumRows, uint32 inNumCols)'],['../namespacenc.html#ac9ffd1a2fa29857f39a38a9dab1079a2',1,'nc::ones(uint32 inSquareSize)']]], - ['ones_5flike_2016',['ones_like',['../namespacenc.html#a90cb0bbdc492b0b10e635a79aa943e51',1,'nc']]], - ['operator_21_2017',['operator!',['../namespacenc.html#a5afb0ad958d78f15eb6617618aec0640',1,'nc']]], - ['operator_21_3d_2018',['operator!=',['../classnc_1_1coordinates_1_1_coordinate.html#a8d139bb6b4d2d315d32d6fa818dab93d',1,'nc::coordinates::Coordinate::operator!=()'],['../namespacenc.html#a631e6eb2bf338af6af8487fd2d94b0a8',1,'nc::operator!=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a4cb019941743262a028a62001cda4bd0',1,'nc::operator!=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a33e15d535856758fb49567aa71204426',1,'nc::operator!=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1_vec3.html#aad142760da8d2b3493462b4542e42673',1,'nc::Vec3::operator!=()'],['../classnc_1_1_vec2.html#ac83768c682c162ec9dffe1bfb9637338',1,'nc::Vec2::operator!=()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad7a25b0cb28882ed45417dd3ed01e094',1,'nc::NdArrayConstColumnIterator::operator!=()'],['../classnc_1_1coordinates_1_1_dec.html#a60c04d5b65d89ed8204a51247b31c733',1,'nc::coordinates::Dec::operator!=()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9354c5b4942674a815b2315e8b92978',1,'nc::coordinates::RA::operator!=()'],['../classnc_1_1_shape.html#a56c44db7af73bc585c83e094da8996b5',1,'nc::Shape::operator!=()'],['../classnc_1_1_slice.html#afd66bc2d5f975f986e62230b124ae607',1,'nc::Slice::operator!=()'],['../classnc_1_1image_processing_1_1_centroid.html#a89eb742174a9dd27b730ce4502e119cd',1,'nc::imageProcessing::Centroid::operator!=()'],['../classnc_1_1image_processing_1_1_cluster.html#aa023fb6ea06515f18cd629b155f96a2c',1,'nc::imageProcessing::Cluster::operator!=()'],['../classnc_1_1image_processing_1_1_pixel.html#a4b80694a366506909633ff28c74b4042',1,'nc::imageProcessing::Pixel::operator!=()'],['../classnc_1_1_nd_array_const_iterator.html#a96a196ff02ef70fe942c36afcb402f67',1,'nc::NdArrayConstIterator::operator!=()'],['../classnc_1_1rotations_1_1_quaternion.html#adcf57fd29d62e19f5c764750262ff7c3',1,'nc::rotations::Quaternion::operator!=()']]], - ['operator_25_2019',['operator%',['../namespacenc.html#a54ce1f6f396a09dddabae0f02d9aeeeb',1,'nc::operator%(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4c7d623473bf78038f36fe75395e685b',1,'nc::operator%(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a6c703ec4985bf1bc6ea5c4a32fd72fcf',1,'nc::operator%(const NdArray< dtype > &lhs, dtype rhs)']]], - ['operator_25_3d_2020',['operator%=',['../namespacenc.html#a02273630b6ed39b81c3341674a2ce527',1,'nc::operator%=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a112144152ae720509653d881e3a9d4f4',1,'nc::operator%=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_26_2021',['operator&',['../namespacenc.html#aaa9c45bb88e88461db334c8b933217e3',1,'nc::operator&(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a12d6f6d2a62496d8fe53f8b2daf0b6a8',1,'nc::operator&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a0c80b9ed3ff24fb25fb794e22a3467e6',1,'nc::operator&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_26_26_2022',['operator&&',['../namespacenc.html#aa73c70b154a9045312635eb5a9252875',1,'nc::operator&&(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7f508d7557317498384741bd76fe39d5',1,'nc::operator&&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aa9c15b56f7dc1eb4ce63b15285c7f8b1',1,'nc::operator&&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_26_3d_2023',['operator&=',['../namespacenc.html#ae104d25f74df02965d9ef6e4a9848659',1,'nc::operator&=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aedc89e1be7f41979fc870006016b6b46',1,'nc::operator&=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_28_29_2024',['operator()',['../classnc_1_1_nd_array.html#adfc2050efba624e48733775ae48da8ff',1,'nc::NdArray::operator()(Slice rowSlice, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#abf2c4d2e67b692c67e5aed62cd981800',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) noexcept'],['../classnc_1_1_nd_array.html#aac0b806c621ce85a61f1370cc618fcc8',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) const noexcept'],['../classnc_1_1_nd_array.html#a694ed71b52be045362ed9c9ed9d0d5a0',1,'nc::NdArray::operator()(Slice inRowSlice, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#a1583ae58b94d68e101079c4578fe1716',1,'nc::NdArray::operator()(Slice inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#a6ca54f3e1aca253d55dab87e38d21df1',1,'nc::NdArray::operator()(int32 inRowIndex, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#ab2b2913858d7d8427ef5c58ce2caee01',1,'nc::NdArray::operator()(const Indices &rowIndices, int32 colIndex) const'],['../classnc_1_1_nd_array.html#a9c33b3d44d196376aa9511f86c9c860c',1,'nc::NdArray::operator()(const Indices &rowIndices, Slice colSlice) const'],['../classnc_1_1_nd_array.html#ac97b34c8348f6a510820bc3887a088d1',1,'nc::NdArray::operator()(RowIndices rowIndices, ColIndices colIndices) const'],['../classnc_1_1_nd_array.html#a921862c636c42a394cb25d95b2c6e326',1,'nc::NdArray::operator()(int32 rowIndex, const Indices &colIndices) const'],['../classnc_1_1polynomial_1_1_poly1d.html#ac82910d648a2a3cfd2301e12907414dd',1,'nc::polynomial::Poly1d::operator()()']]], - ['operator_2a_2025',['operator*',['../namespacenc.html#ace6d6bf5d703e886d8f137cf73be5021',1,'nc::operator*(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#af51c9efd8dbadbdc664972bd96583a72',1,'nc::operator*(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#af4ecba4e059c6dcf672644a3c1bff75d',1,'nc::operator*(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a39b128708b2225a00de527c8ec83d72a',1,'nc::operator*(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a1769d68f44f9c98d94dd412bc32a9bb5',1,'nc::operator*(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a8248dae03ae96d459320f42d60fdf424',1,'nc::operator*(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a199168f4bff489c9ad1d0755e573c6aa',1,'nc::operator*(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9a0ff185c891d6c5af3d7150bc645dc8',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../classnc_1_1_nd_array_const_iterator.html#ad4ce15f95730d8c089db4f2a26b91090',1,'nc::NdArrayConstIterator::operator*()'],['../classnc_1_1_nd_array_iterator.html#ae1e918bc6718fe1ffa58f7c6a82fbe30',1,'nc::NdArrayIterator::operator*()'],['../classnc_1_1_nd_array_const_column_iterator.html#ac096213e50279dc023bbf6270c31969a',1,'nc::NdArrayConstColumnIterator::operator*()'],['../classnc_1_1_nd_array_column_iterator.html#af387e330729ecde7c09d388915ae346a',1,'nc::NdArrayColumnIterator::operator*()'],['../classnc_1_1polynomial_1_1_poly1d.html#aab8cce6bf7a9400862d98684de8ef355',1,'nc::polynomial::Poly1d::operator*()'],['../classnc_1_1rotations_1_1_quaternion.html#adad6ca92266f6090930addc585900805',1,'nc::rotations::Quaternion::operator*(const Quaternion &inRhs) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#ad63920fa01f5bd4949c0fbb3ff7c7137',1,'nc::rotations::Quaternion::operator*(double inScalar) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a10fd2d44927d59f19e37c45586072d14',1,'nc::rotations::Quaternion::operator*(const NdArray< double > &inVec) const'],['../classnc_1_1rotations_1_1_quaternion.html#a97a81255a6bb91049b1ad7e7b83e2f7f',1,'nc::rotations::Quaternion::operator*(const Vec3 &inVec3) const'],['../namespacenc.html#a7865c90c232341c387b0105ac4fdbfd9',1,'nc::operator*(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#af4f34a2e6e8b9011cb2d2fc5c564e10a',1,'nc::operator*(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#af09d0c6363ef9dc8e661e9254bcf109f',1,'nc::operator*(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#abf6f57d9d17019d8756b86bfa1019bc1',1,'nc::operator*(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a34212756103e0c821034e5469f0f0ed7',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a72a4a5ad03afcaf6e9f9b7ee6e145a80',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9188c8ea881ad55ea9dc85ae154cbc22',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], - ['operator_2a_3d_2026',['operator*=',['../namespacenc.html#a25ad051c1d98b01675e9c1a52eb8f8c8',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#af0a3674baebda83b99ba3b18ca4a59d3',1,'nc::operator*=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9211f93baeed5af8e00cfd30628d65f6',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a36c7c3a0be4e8652e52e1710f2808ddd',1,'nc::operator*=(NdArray< dtype > &lhs, dtype rhs)'],['../classnc_1_1polynomial_1_1_poly1d.html#a06293521430112062f975b4854090d24',1,'nc::polynomial::Poly1d::operator*=()'],['../classnc_1_1rotations_1_1_quaternion.html#aaaa8a1bd7130e7ce6a819284584a84c5',1,'nc::rotations::Quaternion::operator*=(const Quaternion &inRhs) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a17636913a3a1e810a81a558dc986fd54',1,'nc::rotations::Quaternion::operator*=(double inScalar) noexcept'],['../classnc_1_1_vec2.html#a72ac39ba88f909cb5552f6b379509f81',1,'nc::Vec2::operator*=()'],['../classnc_1_1_vec3.html#a02ec360e4ebb7b4a6b629eedf8d24a2f',1,'nc::Vec3::operator*=()']]], - ['operator_2b_2027',['operator+',['../classnc_1_1_nd_array_column_iterator.html#a6e4c3af43aa00d49305bcd50eaa477e1',1,'nc::NdArrayColumnIterator::operator+()'],['../classnc_1_1_nd_array_const_iterator.html#a55064001ba08765b1e97962ca82a91cd',1,'nc::NdArrayConstIterator::operator+()'],['../classnc_1_1_nd_array_iterator.html#ab26263e7aa624ed5dd5b0140f2adccb7',1,'nc::NdArrayIterator::operator+()'],['../classnc_1_1_nd_array_const_column_iterator.html#a0375a9e5bb7a8e268d80da41186d58a4',1,'nc::NdArrayConstColumnIterator::operator+()'],['../classnc_1_1rotations_1_1_quaternion.html#a53c84fdd06a1f980c7c74a185d568156',1,'nc::rotations::Quaternion::operator+()'],['../namespacenc.html#acf7b3bfdc67df0619847cd06cb2f0519',1,'nc::operator+(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#ac6f8a785c25c21f9b4b8328dfd7da6c6',1,'nc::operator+(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a26bec2e52fdab966f0f3714d1e2ea8bb',1,'nc::operator+(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a5ded64221f16b9a774bc35de58204e28',1,'nc::operator+(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#ab769651a09123be0a13a54a82aaa088a',1,'nc::operator+(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a43fad0472de9a72d2680623200138907',1,'nc::operator+(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a9f50afa50b63aea110be8b9b477d1cb4',1,'nc::operator+(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a9c2f64fa5154e84e1b33b518f75b2ee8',1,'nc::operator+(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a2d00329ee55367cc78bb5ec002d177cf',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#ae7a4dd062b1c5d1f495741e11947f3b5',1,'nc::operator+(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a5a056c387e8726b0612d920bfa55123f',1,'nc::operator+(typename NdArrayConstIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayConstIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a2fff3527567d94f0a1a62269549ad20a',1,'nc::operator+(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a050e6920070ccd078fc357b3ef0198e1',1,'nc::operator+(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a44bd86bfac8783b176ecb2242d3ae93f',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aae286fee26a3f654159dca70928e4060',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a98293d4bef0cd036ce30829e7965126e',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a675deb20abd6aec02f63f72e4c4787dd',1,'nc::operator+(typename NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#acb8250110150dfe1c585f48f988d703a',1,'nc::operator+(typename NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a3768e00a52c63b8bbc18d712cb4330c6',1,'nc::operator+(typename NdArrayIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../classnc_1_1polynomial_1_1_poly1d.html#a65afb72ad35683688c7fb71ee77f839e',1,'nc::polynomial::Poly1d::operator+()']]], - ['operator_2b_2b_2028',['operator++',['../classnc_1_1_nd_array_column_iterator.html#a388ac709c8d2b80c0ed5aa7fbb2047a6',1,'nc::NdArrayColumnIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#abd93d4f21e45188893fcb1c43f907ff0',1,'nc::NdArrayColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a82ded30f6199ce6c9f3630b28e971650',1,'nc::NdArrayConstColumnIterator::operator++()'],['../namespacenc.html#ad1dfa157bab28851bf97d9982df3f2f3',1,'nc::operator++(NdArray< dtype > &lhs, int)'],['../namespacenc.html#ab0ad6a59584ad4f4e277ddedd3c4d476',1,'nc::operator++(NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array_const_iterator.html#ae955fba21b22639a84b9b030283476a6',1,'nc::NdArrayConstIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a3d40f842cc5345a8f8051ae6bdebe321',1,'nc::NdArrayConstIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#ab832430f99b5ddfed996584e4c354f4a',1,'nc::NdArrayIterator::operator++() noexcept'],['../classnc_1_1_nd_array_iterator.html#a350b5406b062642ed48d6c3d9d2ce4b9',1,'nc::NdArrayIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#ad69593e9f3cbf04dff6941bd52827208',1,'nc::NdArrayConstColumnIterator::operator++() noexcept']]], - ['operator_2b_3d_2029',['operator+=',['../classnc_1_1_nd_array_const_column_iterator.html#aa6b2701798827af7b54de723628a20d7',1,'nc::NdArrayConstColumnIterator::operator+=()'],['../classnc_1_1_vec3.html#afef859d21f4332089843c5d337c1ce01',1,'nc::Vec3::operator+=()'],['../classnc_1_1_nd_array_column_iterator.html#acc186137be7b139f7fdcf323e716e5a0',1,'nc::NdArrayColumnIterator::operator+=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a44a0331a1cfc760d7b80bfc20b661366',1,'nc::polynomial::Poly1d::operator+=()'],['../classnc_1_1rotations_1_1_quaternion.html#af2b75597d538e55cfdd1215c35c9c6fe',1,'nc::rotations::Quaternion::operator+=()'],['../classnc_1_1_vec2.html#a21b1c9c0aa0b7e8886f1b4a7c255bb9e',1,'nc::Vec2::operator+=()'],['../classnc_1_1_vec3.html#a2b1c4e63a7233fb56e2f037807dffb68',1,'nc::Vec3::operator+=()'],['../classnc_1_1_vec2.html#af441d4bbee40c07f9b86fbd056ff637e',1,'nc::Vec2::operator+=()'],['../classnc_1_1_nd_array_iterator.html#af691ece9b6335b8191eeeb43a6168b00',1,'nc::NdArrayIterator::operator+=()'],['../classnc_1_1_nd_array_const_iterator.html#aedc3bbd86f2b1b678abb27109dd50ff6',1,'nc::NdArrayConstIterator::operator+=()'],['../namespacenc.html#a4f44f946519987633cf47549e5764298',1,'nc::operator+=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aad9f67cc0911a32f877365833eec3f95',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ae11d9ca1ca975cd511b91ddb512dd097',1,'nc::operator+=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7d26cc24b2a68f3ee89c701453e6c9a8',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], - ['operator_2d_2030',['operator-',['../classnc_1_1_nd_array_const_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayConstColumnIterator::operator-()'],['../classnc_1_1_nd_array_const_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayConstIterator::operator-()'],['../classnc_1_1_nd_array_iterator.html#a8bb1505ab1105805bd3ced24b69d17eb',1,'nc::NdArrayIterator::operator-()'],['../namespacenc.html#a88d16d314b7e1427529122d2434223e0',1,'nc::operator-()'],['../classnc_1_1_nd_array_const_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayConstIterator::operator-()'],['../namespacenc.html#aea4fe5d4daa75249a7b7765a219cbdb9',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#aae5b14c2febca550101675a55ee5e436',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array_const_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayConstColumnIterator::operator-()'],['../classnc_1_1_nd_array_column_iterator.html#a6dda98c1eba18dff31c9a66f528cd72b',1,'nc::NdArrayColumnIterator::operator-()'],['../classnc_1_1polynomial_1_1_poly1d.html#ade7b4f432e1056bc66d88a131a2cbf41',1,'nc::polynomial::Poly1d::operator-()'],['../classnc_1_1rotations_1_1_quaternion.html#ad6eb2370d77e01a944c4b32a48966e76',1,'nc::rotations::Quaternion::operator-(const Quaternion &inRhs) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a43fe6603ffbaaadf9348910e17e99519',1,'nc::rotations::Quaternion::operator-() const noexcept'],['../classnc_1_1_nd_array_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayColumnIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayColumnIterator::operator-(const self_type &rhs) const noexcept'],['../namespacenc.html#a419f15a00c80bffbe8446892e2015eae',1,'nc::operator-(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7c61e5d343e6439c26abb36db5a0b948',1,'nc::operator-(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#af87da9c66c9e535066221e4f85f3ed90',1,'nc::operator-(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a6935362e6d04b73f04c0e8191ae3098d',1,'nc::operator-(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#a7227073082d530baaf7ebb96ee06995b',1,'nc::operator-(const Vec3 &vec) noexcept'],['../namespacenc.html#a7cf1dfd7144b41f4d748af9fb8aa5ffb',1,'nc::operator-(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#ad279cbad60173006f6883e0d18b0147e',1,'nc::operator-(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#af29a28cada8fd30111a2c6d41a110ff8',1,'nc::operator-(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a31b3ca85817b7242152028c4fd3f32c3',1,'nc::operator-(const NdArray< dtype > &inArray)'],['../namespacenc.html#a5e63a7dbcbc5bf2e9e5ad41c0169df34',1,'nc::operator-(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9d459ed977535f74996fe4820343138d',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a305a3e10402251fc06871a84f8941298',1,'nc::operator-(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1c852c2418c1b5eac6da53972f82233e',1,'nc::operator-(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a9b0eb6f1f7c4c55004478a3eb99c5367',1,'nc::operator-(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7c52ae6f5c5daf9d27c292e0451cccc3',1,'nc::operator-(const Vec2 &vec) noexcept']]], - ['operator_2d_2d_2031',['operator--',['../classnc_1_1_nd_array_iterator.html#a3bcc95583b7a85e5d253b6c830d33ec4',1,'nc::NdArrayIterator::operator--() noexcept'],['../classnc_1_1_nd_array_iterator.html#adcd3b9918db13467bcd234e6f3eec61f',1,'nc::NdArrayIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a9813a585d99eb656cbe7e1e12476d30b',1,'nc::NdArrayConstColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a5fea275f4afdd1fca5b59830ce182bff',1,'nc::NdArrayConstColumnIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a145c2fa5cbd327fbba7dd4701ef27baf',1,'nc::NdArrayColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a8ee7c1ecf2dc107159aec64377f5d6bd',1,'nc::NdArrayColumnIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a526a13c16c0ef08b005f67184f80087a',1,'nc::NdArrayConstIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a6061cf25f89e41d3a77d0f4fb0ccc7e2',1,'nc::NdArrayConstIterator::operator--() noexcept'],['../namespacenc.html#ab1ac162f983d66eec0f6189325bd1720',1,'nc::operator--(NdArray< dtype > &lhs, int)'],['../namespacenc.html#aa7ea8977a2740af99f4c08c88d7a79e8',1,'nc::operator--(NdArray< dtype > &rhs)']]], - ['operator_2d_3d_2032',['operator-=',['../classnc_1_1_vec2.html#abfb0b00888fa37d52a895d06f2b39133',1,'nc::Vec2::operator-=()'],['../classnc_1_1_nd_array_iterator.html#a3ae9bd787a73639f2d0334d87f1fb720',1,'nc::NdArrayIterator::operator-=()'],['../namespacenc.html#aae2f4895eb95921ca77529137e603cd0',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#ac870e3973346560eba3380c11f216540',1,'nc::operator-=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a9093ebf2aaa2dbc811ae45e77ba52960',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a8ba0ad93a3ec2ca409cdb14785e1f679',1,'nc::operator-=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1_vec3.html#a208820649ed763a5dcc9405c4aa481f2',1,'nc::Vec3::operator-=(const Vec3 &rhs) noexcept'],['../classnc_1_1_vec3.html#a70251860269c7cb5becbe988a0b2c48e',1,'nc::Vec3::operator-=(double scaler) noexcept'],['../classnc_1_1_vec2.html#a13a2bbc2595248211e0bc97de51e13b5',1,'nc::Vec2::operator-=()'],['../classnc_1_1rotations_1_1_quaternion.html#a60f1f33144c887cde1338fd80183638f',1,'nc::rotations::Quaternion::operator-=()'],['../classnc_1_1_nd_array_const_iterator.html#a9ae2efc38005276adaa744e6bec116c3',1,'nc::NdArrayConstIterator::operator-=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a732cca31f4b6180d0ad035a6daeb160a',1,'nc::polynomial::Poly1d::operator-=()'],['../classnc_1_1_nd_array_column_iterator.html#a80924e15c192ee04843add79ad2efece',1,'nc::NdArrayColumnIterator::operator-=()'],['../classnc_1_1_nd_array_const_column_iterator.html#af68690450642df08758a9e067edeee47',1,'nc::NdArrayConstColumnIterator::operator-=()']]], - ['operator_2d_3e_2033',['operator->',['../classnc_1_1_nd_array_const_iterator.html#a36aee44e67ed7bdc2fd3ca660e1748fa',1,'nc::NdArrayConstIterator::operator->()'],['../classnc_1_1_nd_array_iterator.html#aa1627ff7d2b0089222794bfebaa29a32',1,'nc::NdArrayIterator::operator->()'],['../classnc_1_1_nd_array_const_column_iterator.html#a33d2e58d269f938c742ac25f46edf008',1,'nc::NdArrayConstColumnIterator::operator->()'],['../classnc_1_1_nd_array_column_iterator.html#ae66efdfa1252f405042276e3e9a25364',1,'nc::NdArrayColumnIterator::operator->()']]], - ['operator_2f_2034',['operator/',['../namespacenc.html#a04bf5ca073685e762d84932ae14b8caa',1,'nc::operator/(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ac8cd599e4b67e78c173894bc3d2bd7f2',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1eee81e10b382e6b0474508725831a4f',1,'nc::operator/(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a8d2ca407e7579acac2ca6496c4196d15',1,'nc::operator/(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a58862db40468f4be62b860990cf05336',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a06365d71ef5c147fee8e571b9fef7313',1,'nc::operator/(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#abe2fc114afe7f62aacf55a9288f45c4a',1,'nc::operator/(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a0a070b4ec8a29ee1a357c53857d4778a',1,'nc::operator/(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#a4dda3a7297e38679bf172d870090da1d',1,'nc::operator/(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a4bec4dbe25db0a2ec84e5999458a2c02',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a69481119ed4cf9e7fe41b0c9228693e3',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#ab054e067fc333a48582e291f95120866',1,'nc::rotations::Quaternion::operator/()']]], - ['operator_2f_3d_2035',['operator/=',['../classnc_1_1_vec3.html#a431b2ac6af51bf59d804adbe5c8a7700',1,'nc::Vec3::operator/=()'],['../classnc_1_1_vec2.html#a1a1c875b11ea5571cb2b71778a692472',1,'nc::Vec2::operator/=()'],['../classnc_1_1rotations_1_1_quaternion.html#a859df40774ccff755560604b930c934d',1,'nc::rotations::Quaternion::operator/=()'],['../namespacenc.html#ad554e38d21aec306a8e3e4cd4ca990a2',1,'nc::operator/=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a26c691c1a8a6ddea49796591063e7630',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a05414ec63ae42b4a3e9e81ceef072094',1,'nc::operator/=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7bbd0ddf9efe256d0c010e2c481da2d5',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], - ['operator_3c_2036',['operator<',['../namespacenc.html#a6500fd0898086f300bb7909249b3e50f',1,'nc::operator<(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a8b68828e75eb8bd91ccdc63e6c39511f',1,'nc::operator<(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#ac1e7489f428b83ed55b5d44963b4eab6',1,'nc::operator<(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a724cd71c78633aa5a757aa76b514f46a',1,'nc::operator<(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a6ae3aca3c7cb79a9fd985c1820b74c39',1,'nc::NdArrayConstIterator::operator<()'],['../classnc_1_1image_processing_1_1_centroid.html#a093719e81ed5bd5af0cb80dcfd03289f',1,'nc::imageProcessing::Centroid::operator<()'],['../classnc_1_1image_processing_1_1_pixel.html#a592926833195d4f2587efef12e4b1148',1,'nc::imageProcessing::Pixel::operator<()'],['../classnc_1_1_nd_array_const_column_iterator.html#ab0928638c653f5ed37088a3e5098064b',1,'nc::NdArrayConstColumnIterator::operator<()']]], - ['operator_3c_3c_2037',['operator<<',['../namespacenc.html#a0cf6f27f323d5bc34b6c56316c480865',1,'nc::operator<<(std::ostream &stream, const Vec3 &vec)'],['../namespacenc.html#aecdda46f9eca3e1f802bb5451ca952cb',1,'nc::operator<<(std::ostream &stream, const Vec2 &vec)'],['../namespacenc.html#a5df285ae528f83294768588fa622d41f',1,'nc::operator<<(std::ostream &inOStream, const NdArray< dtype > &inArray)'],['../namespacenc.html#a39964568372712a2a5427c44e59ffbe2',1,'nc::operator<<(const NdArray< dtype > &lhs, uint8 inNumBits)']]], - ['operator_3c_3c_3d_2038',['operator<<=',['../namespacenc.html#a9d82fca424a68c0042594e483b51ced2',1,'nc']]], - ['operator_3c_3d_2039',['operator<=',['../classnc_1_1_nd_array_const_iterator.html#a171276f9e90a1336d156c61c2b61bd23',1,'nc::NdArrayConstIterator::operator<=()'],['../namespacenc.html#accb22a9c6f4dc0452020b0a86ef8fdf9',1,'nc::operator<=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a4ceffb2e21de23701d431abde8e78592',1,'nc::operator<=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a496de942a0d74925ed64972dcb2cffe8',1,'nc::operator<=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9f9bb9e7b4ecf581498351e14f074145',1,'nc::operator<=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a8468d6928d88c7f34d1456261331f238',1,'nc::NdArrayConstColumnIterator::operator<=()']]], - ['operator_3d_2040',['operator=',['../classnc_1_1_nd_array.html#abe4cda5855bc5d6aee488293000d1acb',1,'nc::NdArray::operator=(const NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array.html#ae5150db09cf7f76269b3254ceb0c43a8',1,'nc::NdArray::operator=(value_type inValue) noexcept'],['../classnc_1_1_nd_array.html#a5ff24670b2173fccf1c9a35b688f2683',1,'nc::NdArray::operator=(NdArray< dtype > &&rhs) noexcept']]], - ['operator_3d_3d_2041',['operator==',['../classnc_1_1_shape.html#a0267d8b7eb226fdc442be5c914f9c870',1,'nc::Shape::operator==()'],['../namespacenc.html#a283fba259d2cd892a8cbb2782490b92a',1,'nc::operator==(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aa956dff0507eddc1c1d80e423f126383',1,'nc::operator==(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#afdcaaff39ed10311d74302a6e9be2fd4',1,'nc::operator==(dtype inValue, const NdArray< dtype > &inArray)'],['../classnc_1_1coordinates_1_1_coordinate.html#a96255907cf1af2c416c7dbe34e96b0d5',1,'nc::coordinates::Coordinate::operator==()'],['../classnc_1_1coordinates_1_1_dec.html#a5b264a9d7bb9b2c1b537b03a5eac7265',1,'nc::coordinates::Dec::operator==()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9e22496d5fdc265ee5a5d77ec97c184',1,'nc::coordinates::RA::operator==()'],['../classnc_1_1_slice.html#a769815d8fbb98ba34101c18a21efbbf5',1,'nc::Slice::operator==()'],['../classnc_1_1image_processing_1_1_centroid.html#a503a2542b388f65fb80710dd33610abc',1,'nc::imageProcessing::Centroid::operator==()'],['../classnc_1_1image_processing_1_1_cluster.html#a8308c5f0313872c9499de36d69d0ff19',1,'nc::imageProcessing::Cluster::operator==()'],['../classnc_1_1_nd_array_const_iterator.html#ac055ccace7f791cfb94d7df8e7100dc2',1,'nc::NdArrayConstIterator::operator==()'],['../classnc_1_1_nd_array_const_column_iterator.html#aec9953c2361595fc656a1a5d306e36c0',1,'nc::NdArrayConstColumnIterator::operator==()'],['../classnc_1_1rotations_1_1_quaternion.html#a82f40acb2292256faffab2b88aa38208',1,'nc::rotations::Quaternion::operator==()'],['../classnc_1_1_vec2.html#af04a7f20ae8ac7a59ae44f7819668fa0',1,'nc::Vec2::operator==()'],['../classnc_1_1_vec3.html#a2cc63855706091881f765b63dcf52c44',1,'nc::Vec3::operator==()'],['../classnc_1_1image_processing_1_1_pixel.html#a008757a06c498b1a31e26d53a54e51dc',1,'nc::imageProcessing::Pixel::operator==()']]], - ['operator_3e_2042',['operator>',['../classnc_1_1_nd_array_const_iterator.html#a8a312e1809eae90df625971d6b4ab62e',1,'nc::NdArrayConstIterator::operator>()'],['../classnc_1_1_nd_array_const_column_iterator.html#a827d0a8431ec616ef0161144b3d24af6',1,'nc::NdArrayConstColumnIterator::operator>()'],['../namespacenc.html#a20910640e1c1dd8bc9298561fedc84a4',1,'nc::operator>(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a5755bb93bff9c0cbd38dbf1296902374',1,'nc::operator>(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7433343db2634ef8f75e290370cfe21e',1,'nc::operator>(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a113de1155a4e2a71dcdad1709c58afe8',1,'nc::operator>(dtype inValue, const NdArray< dtype > &inArray)']]], - ['operator_3e_3d_2043',['operator>=',['../classnc_1_1_nd_array_const_column_iterator.html#a9935c5d4b3deff76207ccde7cfccbf62',1,'nc::NdArrayConstColumnIterator::operator>=()'],['../namespacenc.html#ac453f615df2e03778835908a70907145',1,'nc::operator>=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a0dfd9f5c1ec0c3d61959c4c54e6dc23a',1,'nc::operator>=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a48199b1c11d42106cd09ae57215520fe',1,'nc::operator>=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4a32b6c123eaa3f46c14159b243522de',1,'nc::operator>=(const NdArray< dtype > &lhs, dtype inValue)'],['../classnc_1_1_nd_array_const_iterator.html#a06871d8ba079130e84a892995c07a49a',1,'nc::NdArrayConstIterator::operator>=()']]], - ['operator_3e_3e_2044',['operator>>',['../namespacenc.html#a7e6fe3981b55cd4f381339b616a55ec8',1,'nc']]], - ['operator_3e_3e_3d_2045',['operator>>=',['../namespacenc.html#a7626eefaf34c6ac138da762c6ae930e7',1,'nc']]], - ['operator_5b_5d_2046',['operator[]',['../classnc_1_1image_processing_1_1_cluster.html#a386b222d5747fc2b77448ea5a56d24e4',1,'nc::imageProcessing::Cluster::operator[]()'],['../classnc_1_1_nd_array_column_iterator.html#a5dc1514332728850b8fbeaa7d1f8bda0',1,'nc::NdArrayColumnIterator::operator[]()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3a37dd5a1496ecf2249950325b0a388c',1,'nc::NdArrayConstColumnIterator::operator[]()'],['../classnc_1_1_nd_array_iterator.html#a40c132f8a7c1dd9fde17bcd3ddc2a18f',1,'nc::NdArrayIterator::operator[]()'],['../classnc_1_1_nd_array_const_iterator.html#a83ee672f75e74c4421a25a7816be12c6',1,'nc::NdArrayConstIterator::operator[]()'],['../classnc_1_1_nd_array.html#a0f53f1d4f5b259021cf61026f65759e0',1,'nc::NdArray::operator[](const Indices &inIndices) const'],['../classnc_1_1_nd_array.html#ab04b63c2794747b88b0e640f737c6b2c',1,'nc::NdArray::operator[](const NdArray< bool > &inMask) const'],['../classnc_1_1_nd_array.html#a4744ab68830cc2cc16d8804295662b6a',1,'nc::NdArray::operator[](const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#aeabee2aba11a885f3bd874b7a06d62ea',1,'nc::NdArray::operator[](int32 inIndex) const noexcept'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae92d75ae626bb18324b0dfe69ee44f25',1,'nc::imageProcessing::ClusterMaker::operator[]()'],['../classnc_1_1_nd_array.html#aa58a51df41648b4d39f2f972c60e09ae',1,'nc::NdArray::operator[]()'],['../classnc_1_1_data_cube.html#a1a16b98e982d79cc6a172b8e2bfad856',1,'nc::DataCube::operator[](uint32 inIndex) noexcept'],['../classnc_1_1_data_cube.html#a403c0b0df22fc5fa0858109fa7a65f87',1,'nc::DataCube::operator[](uint32 inIndex) const noexcept']]], - ['operator_5e_2047',['operator^',['../namespacenc.html#af4f0fce9397ab714d3567d454f143835',1,'nc::operator^(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aa6be940ce9eed012ca0fac881d884411',1,'nc::operator^(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#ae4befd8a03420464348fdfcc71b106bb',1,'nc::operator^(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1polynomial_1_1_poly1d.html#a548c945121cb39859f649cf39a6d0830',1,'nc::polynomial::Poly1d::operator^()']]], - ['operator_5e_3d_2048',['operator^=',['../namespacenc.html#a8d3d77fe59d533d1301aea0112e38fa8',1,'nc::operator^=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ad4f2748ac9b7ebe59f1592e118169ea7',1,'nc::operator^=(NdArray< dtype > &lhs, dtype rhs)'],['../classnc_1_1polynomial_1_1_poly1d.html#a930f53185992537e3eb5844ebb70bf38',1,'nc::polynomial::Poly1d::operator^=()']]], - ['operator_7c_2049',['operator|',['../namespacenc.html#a2dd868d584e1d65748cf04957eb97d99',1,'nc::operator|(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a129a0c61ca191919674576a76ee7fd93',1,'nc::operator|(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a50e6d418c92ccd6d7a2cf42a899a2203',1,'nc::operator|(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_7c_3d_2050',['operator|=',['../namespacenc.html#a958f4fd964269c7affaaff0e30b4dc01',1,'nc::operator|=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#afbb3e9d2eb28cad36a9de996263067d9',1,'nc::operator|=(NdArray< dtype > &lhs, dtype rhs)']]], - ['operator_7c_7c_2051',['operator||',['../namespacenc.html#a25c9ac2d82de1fd3c81890ad38ebfb25',1,'nc::operator||(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#affe1935670d985dfe387f429d68874e2',1,'nc::operator||(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a37ef6f1c023837fbe628c3838b14d940',1,'nc::operator||(dtype lhs, const NdArray< dtype > &rhs)']]], - ['operator_7e_2052',['operator~',['../namespacenc.html#ae9d44b86bb2c2968d5c67f11ca789d3e',1,'nc']]], - ['order_2053',['order',['../classnc_1_1polynomial_1_1_poly1d.html#ab978ca2f65c7cd640309c1be86aa9141',1,'nc::polynomial::Poly1d']]], - ['outer_2054',['outer',['../namespacenc.html#a395197f9b1d3f53a5fdcd234fa6e6baf',1,'nc']]], - ['ownsinternaldata_2055',['ownsInternalData',['../classnc_1_1_nd_array.html#a63a1c0f9fdef078770e4f8cbe2c249ec',1,'nc::NdArray']]] + ['ones_2115',['ones',['../classnc_1_1_nd_array.html#ac6e5a0c875c593a6bc1970745af3684b',1,'nc::NdArray::ones()'],['../namespacenc.html#a5a935c0d187c7a0cab3d7ada27ffafc5',1,'nc::ones(const Shape &inShape)'],['../namespacenc.html#ac9ffd1a2fa29857f39a38a9dab1079a2',1,'nc::ones(uint32 inSquareSize)'],['../namespacenc.html#a0f6db9a6dcb85c14639b515f53d6b893',1,'nc::ones(uint32 inNumRows, uint32 inNumCols)']]], + ['ones_5flike_2116',['ones_like',['../namespacenc.html#a90cb0bbdc492b0b10e635a79aa943e51',1,'nc']]], + ['operator_21_2117',['operator!',['../namespacenc.html#a5afb0ad958d78f15eb6617618aec0640',1,'nc']]], + ['operator_21_3d_2118',['operator!=',['../classnc_1_1coordinates_1_1_coordinate.html#a8d139bb6b4d2d315d32d6fa818dab93d',1,'nc::coordinates::Coordinate::operator!=()'],['../classnc_1_1coordinates_1_1_dec.html#a60c04d5b65d89ed8204a51247b31c733',1,'nc::coordinates::Dec::operator!=()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9354c5b4942674a815b2315e8b92978',1,'nc::coordinates::RA::operator!=()'],['../classnc_1_1_shape.html#a56c44db7af73bc585c83e094da8996b5',1,'nc::Shape::operator!=()'],['../classnc_1_1_slice.html#afd66bc2d5f975f986e62230b124ae607',1,'nc::Slice::operator!=()'],['../classnc_1_1image_processing_1_1_centroid.html#a89eb742174a9dd27b730ce4502e119cd',1,'nc::imageProcessing::Centroid::operator!=()'],['../classnc_1_1image_processing_1_1_cluster.html#aa023fb6ea06515f18cd629b155f96a2c',1,'nc::imageProcessing::Cluster::operator!=()'],['../classnc_1_1image_processing_1_1_pixel.html#a4b80694a366506909633ff28c74b4042',1,'nc::imageProcessing::Pixel::operator!=()'],['../classnc_1_1_nd_array_const_iterator.html#a96a196ff02ef70fe942c36afcb402f67',1,'nc::NdArrayConstIterator::operator!=()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad7a25b0cb28882ed45417dd3ed01e094',1,'nc::NdArrayConstColumnIterator::operator!=()'],['../classnc_1_1rotations_1_1_quaternion.html#adcf57fd29d62e19f5c764750262ff7c3',1,'nc::rotations::Quaternion::operator!=()'],['../classnc_1_1_vec2.html#ac83768c682c162ec9dffe1bfb9637338',1,'nc::Vec2::operator!=()'],['../classnc_1_1_vec3.html#aad142760da8d2b3493462b4542e42673',1,'nc::Vec3::operator!=()'],['../namespacenc.html#a4cb019941743262a028a62001cda4bd0',1,'nc::operator!=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a631e6eb2bf338af6af8487fd2d94b0a8',1,'nc::operator!=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a33e15d535856758fb49567aa71204426',1,'nc::operator!=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_25_2119',['operator%',['../namespacenc.html#a54ce1f6f396a09dddabae0f02d9aeeeb',1,'nc::operator%(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a6c703ec4985bf1bc6ea5c4a32fd72fcf',1,'nc::operator%(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#af2360d92e17c3bf8956f1ab391f0022a',1,'nc::operator%(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_25_3d_2120',['operator%=',['../namespacenc.html#a9b9a9ad49ab9cdaa1b3434038c6c983a',1,'nc::operator%=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a0dfaa5d06ddc26868216477f53b56b46',1,'nc::operator%=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_26_2121',['operator&',['../namespacenc.html#a12d6f6d2a62496d8fe53f8b2daf0b6a8',1,'nc::operator&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aaa9c45bb88e88461db334c8b933217e3',1,'nc::operator&(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a0c80b9ed3ff24fb25fb794e22a3467e6',1,'nc::operator&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_26_26_2122',['operator&&',['../namespacenc.html#aa9c15b56f7dc1eb4ce63b15285c7f8b1',1,'nc::operator&&(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a7f508d7557317498384741bd76fe39d5',1,'nc::operator&&(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aa73c70b154a9045312635eb5a9252875',1,'nc::operator&&(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_26_3d_2123',['operator&=',['../namespacenc.html#ae104d25f74df02965d9ef6e4a9848659',1,'nc::operator&=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#aedc89e1be7f41979fc870006016b6b46',1,'nc::operator&=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_28_29_2124',['operator()',['../classnc_1_1_nd_array.html#abf2c4d2e67b692c67e5aed62cd981800',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) noexcept'],['../classnc_1_1_nd_array.html#aac0b806c621ce85a61f1370cc618fcc8',1,'nc::NdArray::operator()(int32 inRowIndex, int32 inColIndex) const noexcept'],['../classnc_1_1_nd_array.html#a694ed71b52be045362ed9c9ed9d0d5a0',1,'nc::NdArray::operator()(Slice inRowSlice, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#a1583ae58b94d68e101079c4578fe1716',1,'nc::NdArray::operator()(Slice inRowSlice, int32 inColIndex) const'],['../classnc_1_1_nd_array.html#a6ca54f3e1aca253d55dab87e38d21df1',1,'nc::NdArray::operator()(int32 inRowIndex, Slice inColSlice) const'],['../classnc_1_1_nd_array.html#a9c33b3d44d196376aa9511f86c9c860c',1,'nc::NdArray::operator()(const Indices &rowIndices, Slice colSlice) const'],['../classnc_1_1_nd_array.html#a921862c636c42a394cb25d95b2c6e326',1,'nc::NdArray::operator()(int32 rowIndex, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#adfc2050efba624e48733775ae48da8ff',1,'nc::NdArray::operator()(Slice rowSlice, const Indices &colIndices) const'],['../classnc_1_1_nd_array.html#ac97b34c8348f6a510820bc3887a088d1',1,'nc::NdArray::operator()(RowIndices rowIndices, ColIndices colIndices) const'],['../classnc_1_1_nd_array.html#ab2b2913858d7d8427ef5c58ce2caee01',1,'nc::NdArray::operator()(const Indices &rowIndices, int32 colIndex) const'],['../classnc_1_1polynomial_1_1_poly1d.html#ac82910d648a2a3cfd2301e12907414dd',1,'nc::polynomial::Poly1d::operator()()']]], + ['operator_2a_2125',['operator*',['../classnc_1_1rotations_1_1_quaternion.html#a10fd2d44927d59f19e37c45586072d14',1,'nc::rotations::Quaternion::operator*()'],['../namespacenc.html#a39b128708b2225a00de527c8ec83d72a',1,'nc::operator*(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#af4ecba4e059c6dcf672644a3c1bff75d',1,'nc::operator*(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#af51c9efd8dbadbdc664972bd96583a72',1,'nc::operator*(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#a34212756103e0c821034e5469f0f0ed7',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a72a4a5ad03afcaf6e9f9b7ee6e145a80',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9188c8ea881ad55ea9dc85ae154cbc22',1,'nc::operator*(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../classnc_1_1rotations_1_1_quaternion.html#ad63920fa01f5bd4949c0fbb3ff7c7137',1,'nc::rotations::Quaternion::operator*()'],['../namespacenc.html#af4f34a2e6e8b9011cb2d2fc5c564e10a',1,'nc::operator*(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a7865c90c232341c387b0105ac4fdbfd9',1,'nc::operator*(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9a0ff185c891d6c5af3d7150bc645dc8',1,'nc::operator*(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a199168f4bff489c9ad1d0755e573c6aa',1,'nc::operator*(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a8248dae03ae96d459320f42d60fdf424',1,'nc::operator*(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a1769d68f44f9c98d94dd412bc32a9bb5',1,'nc::operator*(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#ace6d6bf5d703e886d8f137cf73be5021',1,'nc::operator*(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#ac096213e50279dc023bbf6270c31969a',1,'nc::NdArrayConstColumnIterator::operator*()'],['../classnc_1_1rotations_1_1_quaternion.html#a97a81255a6bb91049b1ad7e7b83e2f7f',1,'nc::rotations::Quaternion::operator*(const Vec3 &inVec3) const'],['../classnc_1_1rotations_1_1_quaternion.html#adad6ca92266f6090930addc585900805',1,'nc::rotations::Quaternion::operator*(const Quaternion &inRhs) const noexcept'],['../namespacenc.html#af09d0c6363ef9dc8e661e9254bcf109f',1,'nc::operator*()'],['../classnc_1_1_nd_array_column_iterator.html#af387e330729ecde7c09d388915ae346a',1,'nc::NdArrayColumnIterator::operator*()'],['../classnc_1_1_nd_array_iterator.html#ae1e918bc6718fe1ffa58f7c6a82fbe30',1,'nc::NdArrayIterator::operator*()'],['../classnc_1_1_nd_array_const_iterator.html#ad4ce15f95730d8c089db4f2a26b91090',1,'nc::NdArrayConstIterator::operator*()'],['../namespacenc.html#abf6f57d9d17019d8756b86bfa1019bc1',1,'nc::operator*()'],['../classnc_1_1polynomial_1_1_poly1d.html#aab8cce6bf7a9400862d98684de8ef355',1,'nc::polynomial::Poly1d::operator*(const Poly1d< dtype > &inOtherPoly) const']]], + ['operator_2a_3d_2126',['operator*=',['../classnc_1_1polynomial_1_1_poly1d.html#a06293521430112062f975b4854090d24',1,'nc::polynomial::Poly1d::operator*=()'],['../classnc_1_1rotations_1_1_quaternion.html#aaaa8a1bd7130e7ce6a819284584a84c5',1,'nc::rotations::Quaternion::operator*=(const Quaternion &inRhs) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a17636913a3a1e810a81a558dc986fd54',1,'nc::rotations::Quaternion::operator*=(double inScalar) noexcept'],['../classnc_1_1_vec2.html#a72ac39ba88f909cb5552f6b379509f81',1,'nc::Vec2::operator*=()'],['../classnc_1_1_vec3.html#a02ec360e4ebb7b4a6b629eedf8d24a2f',1,'nc::Vec3::operator*=()'],['../namespacenc.html#a36c7c3a0be4e8652e52e1710f2808ddd',1,'nc::operator*=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a25ad051c1d98b01675e9c1a52eb8f8c8',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#af0a3674baebda83b99ba3b18ca4a59d3',1,'nc::operator*=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9211f93baeed5af8e00cfd30628d65f6',1,'nc::operator*=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)']]], + ['operator_2b_2127',['operator+',['../classnc_1_1_nd_array_const_iterator.html#a55064001ba08765b1e97962ca82a91cd',1,'nc::NdArrayConstIterator::operator+()'],['../classnc_1_1_nd_array_iterator.html#ab26263e7aa624ed5dd5b0140f2adccb7',1,'nc::NdArrayIterator::operator+()'],['../classnc_1_1_nd_array_const_column_iterator.html#a0375a9e5bb7a8e268d80da41186d58a4',1,'nc::NdArrayConstColumnIterator::operator+()'],['../classnc_1_1_nd_array_column_iterator.html#a6e4c3af43aa00d49305bcd50eaa477e1',1,'nc::NdArrayColumnIterator::operator+()'],['../classnc_1_1polynomial_1_1_poly1d.html#a65afb72ad35683688c7fb71ee77f839e',1,'nc::polynomial::Poly1d::operator+()'],['../classnc_1_1rotations_1_1_quaternion.html#a53c84fdd06a1f980c7c74a185d568156',1,'nc::rotations::Quaternion::operator+()'],['../namespacenc.html#ae7a4dd062b1c5d1f495741e11947f3b5',1,'nc::operator+(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a2d00329ee55367cc78bb5ec002d177cf',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a9c2f64fa5154e84e1b33b518f75b2ee8',1,'nc::operator+(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a9f50afa50b63aea110be8b9b477d1cb4',1,'nc::operator+(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#ac6f8a785c25c21f9b4b8328dfd7da6c6',1,'nc::operator+(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a26bec2e52fdab966f0f3714d1e2ea8bb',1,'nc::operator+(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#a5ded64221f16b9a774bc35de58204e28',1,'nc::operator+(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#ab769651a09123be0a13a54a82aaa088a',1,'nc::operator+(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a3768e00a52c63b8bbc18d712cb4330c6',1,'nc::operator+(typename NdArrayIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a43fad0472de9a72d2680623200138907',1,'nc::operator+(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a5a056c387e8726b0612d920bfa55123f',1,'nc::operator+(typename NdArrayConstIterator< dtype, PointerType, DifferenceType >::difference_type offset, NdArrayConstIterator< dtype, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#acb8250110150dfe1c585f48f988d703a',1,'nc::operator+(typename NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayConstColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a675deb20abd6aec02f63f72e4c4787dd',1,'nc::operator+(typename NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType >::difference_type offset, NdArrayColumnIterator< dtype, SizeType, PointerType, DifferenceType > next) noexcept'],['../namespacenc.html#a98293d4bef0cd036ce30829e7965126e',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aae286fee26a3f654159dca70928e4060',1,'nc::operator+(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a44bd86bfac8783b176ecb2242d3ae93f',1,'nc::operator+(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a050e6920070ccd078fc357b3ef0198e1',1,'nc::operator+(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a2fff3527567d94f0a1a62269549ad20a',1,'nc::operator+(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#acf7b3bfdc67df0619847cd06cb2f0519',1,'nc::operator+(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)']]], + ['operator_2b_2b_2128',['operator++',['../classnc_1_1_nd_array_const_iterator.html#ae955fba21b22639a84b9b030283476a6',1,'nc::NdArrayConstIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a3d40f842cc5345a8f8051ae6bdebe321',1,'nc::NdArrayConstIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#ab832430f99b5ddfed996584e4c354f4a',1,'nc::NdArrayIterator::operator++() noexcept'],['../classnc_1_1_nd_array_iterator.html#a350b5406b062642ed48d6c3d9d2ce4b9',1,'nc::NdArrayIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#ad69593e9f3cbf04dff6941bd52827208',1,'nc::NdArrayConstColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a82ded30f6199ce6c9f3630b28e971650',1,'nc::NdArrayConstColumnIterator::operator++(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#abd93d4f21e45188893fcb1c43f907ff0',1,'nc::NdArrayColumnIterator::operator++() noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a388ac709c8d2b80c0ed5aa7fbb2047a6',1,'nc::NdArrayColumnIterator::operator++(int) noexcept'],['../namespacenc.html#ab0ad6a59584ad4f4e277ddedd3c4d476',1,'nc::operator++(NdArray< dtype > &rhs)'],['../namespacenc.html#ad1dfa157bab28851bf97d9982df3f2f3',1,'nc::operator++(NdArray< dtype > &lhs, int)']]], + ['operator_2b_3d_2129',['operator+=',['../classnc_1_1_nd_array_const_iterator.html#aedc3bbd86f2b1b678abb27109dd50ff6',1,'nc::NdArrayConstIterator::operator+=()'],['../classnc_1_1_nd_array_iterator.html#af691ece9b6335b8191eeeb43a6168b00',1,'nc::NdArrayIterator::operator+=()'],['../classnc_1_1_nd_array_const_column_iterator.html#aa6b2701798827af7b54de723628a20d7',1,'nc::NdArrayConstColumnIterator::operator+=()'],['../classnc_1_1_nd_array_column_iterator.html#acc186137be7b139f7fdcf323e716e5a0',1,'nc::NdArrayColumnIterator::operator+=()'],['../classnc_1_1rotations_1_1_quaternion.html#af2b75597d538e55cfdd1215c35c9c6fe',1,'nc::rotations::Quaternion::operator+=()'],['../classnc_1_1_vec2.html#a21b1c9c0aa0b7e8886f1b4a7c255bb9e',1,'nc::Vec2::operator+=(double scaler) noexcept'],['../classnc_1_1_vec2.html#af441d4bbee40c07f9b86fbd056ff637e',1,'nc::Vec2::operator+=(const Vec2 &rhs) noexcept'],['../classnc_1_1_vec3.html#afef859d21f4332089843c5d337c1ce01',1,'nc::Vec3::operator+=(double scaler) noexcept'],['../classnc_1_1_vec3.html#a2b1c4e63a7233fb56e2f037807dffb68',1,'nc::Vec3::operator+=(const Vec3 &rhs) noexcept'],['../classnc_1_1polynomial_1_1_poly1d.html#a44a0331a1cfc760d7b80bfc20b661366',1,'nc::polynomial::Poly1d::operator+=()'],['../namespacenc.html#a4f44f946519987633cf47549e5764298',1,'nc::operator+=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aad9f67cc0911a32f877365833eec3f95',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ae11d9ca1ca975cd511b91ddb512dd097',1,'nc::operator+=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7d26cc24b2a68f3ee89c701453e6c9a8',1,'nc::operator+=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], + ['operator_2d_2130',['operator-',['../classnc_1_1_nd_array_const_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayConstIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_const_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayConstIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_iterator.html#a8bb1505ab1105805bd3ced24b69d17eb',1,'nc::NdArrayIterator::operator-()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayConstColumnIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayConstColumnIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a6dda98c1eba18dff31c9a66f528cd72b',1,'nc::NdArrayColumnIterator::operator-()'],['../classnc_1_1polynomial_1_1_poly1d.html#ade7b4f432e1056bc66d88a131a2cbf41',1,'nc::polynomial::Poly1d::operator-()'],['../classnc_1_1rotations_1_1_quaternion.html#ad6eb2370d77e01a944c4b32a48966e76',1,'nc::rotations::Quaternion::operator-(const Quaternion &inRhs) const noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#a43fe6603ffbaaadf9348910e17e99519',1,'nc::rotations::Quaternion::operator-() const noexcept'],['../classnc_1_1_nd_array_iterator.html#a4eaa70b83644e14dbfeccbc227408b63',1,'nc::NdArrayIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_iterator.html#aa39c56b1301477ca5d9fb4b2e2d5e38e',1,'nc::NdArrayIterator::operator-(const self_type &rhs) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a6918b5de4f8eef3081abe3ce5ddefa7a',1,'nc::NdArrayColumnIterator::operator-(const difference_type offset) const noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a60c7f27f5b0574716750257d89ba7a70',1,'nc::NdArrayColumnIterator::operator-(const self_type &rhs) const noexcept'],['../namespacenc.html#a7c61e5d343e6439c26abb36db5a0b948',1,'nc::operator-(const Vec3 &lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#aea4fe5d4daa75249a7b7765a219cbdb9',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a7227073082d530baaf7ebb96ee06995b',1,'nc::operator-(const Vec3 &vec) noexcept'],['../namespacenc.html#a9b0eb6f1f7c4c55004478a3eb99c5367',1,'nc::operator-(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a419f15a00c80bffbe8446892e2015eae',1,'nc::operator-(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1c852c2418c1b5eac6da53972f82233e',1,'nc::operator-(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)'],['../namespacenc.html#a305a3e10402251fc06871a84f8941298',1,'nc::operator-(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a88d16d314b7e1427529122d2434223e0',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a9d459ed977535f74996fe4820343138d',1,'nc::operator-(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a5e63a7dbcbc5bf2e9e5ad41c0169df34',1,'nc::operator-(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#a31b3ca85817b7242152028c4fd3f32c3',1,'nc::operator-(const NdArray< dtype > &inArray)'],['../namespacenc.html#a7c52ae6f5c5daf9d27c292e0451cccc3',1,'nc::operator-(const Vec2 &vec) noexcept'],['../namespacenc.html#af29a28cada8fd30111a2c6d41a110ff8',1,'nc::operator-(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#ad279cbad60173006f6883e0d18b0147e',1,'nc::operator-(double lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a7cf1dfd7144b41f4d748af9fb8aa5ffb',1,'nc::operator-(const Vec2 &lhs, const Vec2 &rhs) noexcept'],['../namespacenc.html#a6935362e6d04b73f04c0e8191ae3098d',1,'nc::operator-(const Vec3 &lhs, double rhs) noexcept'],['../namespacenc.html#af87da9c66c9e535066221e4f85f3ed90',1,'nc::operator-(double lhs, const Vec3 &rhs) noexcept'],['../namespacenc.html#aae5b14c2febca550101675a55ee5e436',1,'nc::operator-(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_2d_2d_2131',['operator--',['../classnc_1_1_nd_array_const_iterator.html#a6061cf25f89e41d3a77d0f4fb0ccc7e2',1,'nc::NdArrayConstIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_iterator.html#a526a13c16c0ef08b005f67184f80087a',1,'nc::NdArrayConstIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_iterator.html#a3bcc95583b7a85e5d253b6c830d33ec4',1,'nc::NdArrayIterator::operator--() noexcept'],['../classnc_1_1_nd_array_iterator.html#adcd3b9918db13467bcd234e6f3eec61f',1,'nc::NdArrayIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a9813a585d99eb656cbe7e1e12476d30b',1,'nc::NdArrayConstColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_const_column_iterator.html#a5fea275f4afdd1fca5b59830ce182bff',1,'nc::NdArrayConstColumnIterator::operator--(int) noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a145c2fa5cbd327fbba7dd4701ef27baf',1,'nc::NdArrayColumnIterator::operator--() noexcept'],['../classnc_1_1_nd_array_column_iterator.html#a8ee7c1ecf2dc107159aec64377f5d6bd',1,'nc::NdArrayColumnIterator::operator--(int) noexcept'],['../namespacenc.html#ab1ac162f983d66eec0f6189325bd1720',1,'nc::operator--(NdArray< dtype > &lhs, int)'],['../namespacenc.html#aa7ea8977a2740af99f4c08c88d7a79e8',1,'nc::operator--(NdArray< dtype > &rhs)']]], + ['operator_2d_3d_2132',['operator-=',['../classnc_1_1_nd_array_const_iterator.html#a9ae2efc38005276adaa744e6bec116c3',1,'nc::NdArrayConstIterator::operator-=()'],['../classnc_1_1_nd_array_iterator.html#a3ae9bd787a73639f2d0334d87f1fb720',1,'nc::NdArrayIterator::operator-=()'],['../classnc_1_1_nd_array_const_column_iterator.html#af68690450642df08758a9e067edeee47',1,'nc::NdArrayConstColumnIterator::operator-=()'],['../classnc_1_1_nd_array_column_iterator.html#a80924e15c192ee04843add79ad2efece',1,'nc::NdArrayColumnIterator::operator-=()'],['../classnc_1_1polynomial_1_1_poly1d.html#a732cca31f4b6180d0ad035a6daeb160a',1,'nc::polynomial::Poly1d::operator-=()'],['../classnc_1_1rotations_1_1_quaternion.html#a60f1f33144c887cde1338fd80183638f',1,'nc::rotations::Quaternion::operator-=()'],['../classnc_1_1_vec2.html#abfb0b00888fa37d52a895d06f2b39133',1,'nc::Vec2::operator-=(double scaler) noexcept'],['../classnc_1_1_vec2.html#a13a2bbc2595248211e0bc97de51e13b5',1,'nc::Vec2::operator-=(const Vec2 &rhs) noexcept'],['../classnc_1_1_vec3.html#a70251860269c7cb5becbe988a0b2c48e',1,'nc::Vec3::operator-=(double scaler) noexcept'],['../classnc_1_1_vec3.html#a208820649ed763a5dcc9405c4aa481f2',1,'nc::Vec3::operator-=(const Vec3 &rhs) noexcept'],['../namespacenc.html#a9093ebf2aaa2dbc811ae45e77ba52960',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a8ba0ad93a3ec2ca409cdb14785e1f679',1,'nc::operator-=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aae2f4895eb95921ca77529137e603cd0',1,'nc::operator-=(NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#ac870e3973346560eba3380c11f216540',1,'nc::operator-=(NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_2d_3e_2133',['operator->',['../classnc_1_1_nd_array_iterator.html#aa1627ff7d2b0089222794bfebaa29a32',1,'nc::NdArrayIterator::operator->()'],['../classnc_1_1_nd_array_const_column_iterator.html#a33d2e58d269f938c742ac25f46edf008',1,'nc::NdArrayConstColumnIterator::operator->()'],['../classnc_1_1_nd_array_column_iterator.html#ae66efdfa1252f405042276e3e9a25364',1,'nc::NdArrayColumnIterator::operator->()'],['../classnc_1_1_nd_array_const_iterator.html#a36aee44e67ed7bdc2fd3ca660e1748fa',1,'nc::NdArrayConstIterator::operator->()']]], + ['operator_2f_2134',['operator/',['../namespacenc.html#a8d2ca407e7579acac2ca6496c4196d15',1,'nc::operator/(const std::complex< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a58862db40468f4be62b860990cf05336',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, dtype rhs)'],['../namespacenc.html#a06365d71ef5c147fee8e571b9fef7313',1,'nc::operator/(dtype lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#abe2fc114afe7f62aacf55a9288f45c4a',1,'nc::operator/(const Vec2 &lhs, double rhs) noexcept'],['../namespacenc.html#a0a070b4ec8a29ee1a357c53857d4778a',1,'nc::operator/(const Vec3 &lhs, double rhs) noexcept'],['../classnc_1_1rotations_1_1_quaternion.html#ab054e067fc333a48582e291f95120866',1,'nc::rotations::Quaternion::operator/()'],['../namespacenc.html#a69481119ed4cf9e7fe41b0c9228693e3',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< std::complex< dtype >> &rhs)'],['../namespacenc.html#ac8cd599e4b67e78c173894bc3d2bd7f2',1,'nc::operator/(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4bec4dbe25db0a2ec84e5999458a2c02',1,'nc::operator/(const NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4dda3a7297e38679bf172d870090da1d',1,'nc::operator/(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a04bf5ca073685e762d84932ae14b8caa',1,'nc::operator/(dtype lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a1eee81e10b382e6b0474508725831a4f',1,'nc::operator/(const NdArray< dtype > &lhs, const std::complex< dtype > &rhs)']]], + ['operator_2f_3d_2135',['operator/=',['../classnc_1_1_vec3.html#a431b2ac6af51bf59d804adbe5c8a7700',1,'nc::Vec3::operator/=()'],['../classnc_1_1_vec2.html#a1a1c875b11ea5571cb2b71778a692472',1,'nc::Vec2::operator/=()'],['../classnc_1_1rotations_1_1_quaternion.html#a859df40774ccff755560604b930c934d',1,'nc::rotations::Quaternion::operator/=()'],['../namespacenc.html#ad554e38d21aec306a8e3e4cd4ca990a2',1,'nc::operator/=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a26c691c1a8a6ddea49796591063e7630',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a05414ec63ae42b4a3e9e81ceef072094',1,'nc::operator/=(NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a7bbd0ddf9efe256d0c010e2c481da2d5',1,'nc::operator/=(NdArray< std::complex< dtype >> &lhs, dtype rhs)']]], + ['operator_3c_2136',['operator<',['../classnc_1_1_nd_array_const_iterator.html#a6ae3aca3c7cb79a9fd985c1820b74c39',1,'nc::NdArrayConstIterator::operator<()'],['../classnc_1_1image_processing_1_1_pixel.html#a592926833195d4f2587efef12e4b1148',1,'nc::imageProcessing::Pixel::operator<()'],['../classnc_1_1image_processing_1_1_centroid.html#a093719e81ed5bd5af0cb80dcfd03289f',1,'nc::imageProcessing::Centroid::operator<()'],['../classnc_1_1_nd_array_const_column_iterator.html#ab0928638c653f5ed37088a3e5098064b',1,'nc::NdArrayConstColumnIterator::operator<()'],['../namespacenc.html#a724cd71c78633aa5a757aa76b514f46a',1,'nc::operator<(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#ac1e7489f428b83ed55b5d44963b4eab6',1,'nc::operator<(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a8b68828e75eb8bd91ccdc63e6c39511f',1,'nc::operator<(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a6500fd0898086f300bb7909249b3e50f',1,'nc::operator<(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3c_3c_2137',['operator<<',['../namespacenc.html#a39964568372712a2a5427c44e59ffbe2',1,'nc::operator<<(const NdArray< dtype > &lhs, uint8 inNumBits)'],['../namespacenc.html#a5df285ae528f83294768588fa622d41f',1,'nc::operator<<(std::ostream &inOStream, const NdArray< dtype > &inArray)'],['../namespacenc.html#aecdda46f9eca3e1f802bb5451ca952cb',1,'nc::operator<<(std::ostream &stream, const Vec2 &vec)'],['../namespacenc.html#a0cf6f27f323d5bc34b6c56316c480865',1,'nc::operator<<(std::ostream &stream, const Vec3 &vec)']]], + ['operator_3c_3c_3d_2138',['operator<<=',['../namespacenc.html#a9d82fca424a68c0042594e483b51ced2',1,'nc']]], + ['operator_3c_3d_2139',['operator<=',['../classnc_1_1_nd_array_const_iterator.html#a171276f9e90a1336d156c61c2b61bd23',1,'nc::NdArrayConstIterator::operator<=()'],['../classnc_1_1_nd_array_const_column_iterator.html#a8468d6928d88c7f34d1456261331f238',1,'nc::NdArrayConstColumnIterator::operator<=()'],['../namespacenc.html#a9f9bb9e7b4ecf581498351e14f074145',1,'nc::operator<=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a496de942a0d74925ed64972dcb2cffe8',1,'nc::operator<=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a4ceffb2e21de23701d431abde8e78592',1,'nc::operator<=(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#accb22a9c6f4dc0452020b0a86ef8fdf9',1,'nc::operator<=(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3d_2140',['operator=',['../classnc_1_1_nd_array.html#abe4cda5855bc5d6aee488293000d1acb',1,'nc::NdArray::operator=(const NdArray< dtype > &rhs)'],['../classnc_1_1_nd_array.html#a5ff24670b2173fccf1c9a35b688f2683',1,'nc::NdArray::operator=(NdArray< dtype > &&rhs) noexcept'],['../classnc_1_1_nd_array.html#ae5150db09cf7f76269b3254ceb0c43a8',1,'nc::NdArray::operator=(value_type inValue) noexcept']]], + ['operator_3d_3d_2141',['operator==',['../classnc_1_1_vec2.html#af04a7f20ae8ac7a59ae44f7819668fa0',1,'nc::Vec2::operator==()'],['../classnc_1_1rotations_1_1_quaternion.html#a82f40acb2292256faffab2b88aa38208',1,'nc::rotations::Quaternion::operator==()'],['../classnc_1_1_nd_array_const_column_iterator.html#aec9953c2361595fc656a1a5d306e36c0',1,'nc::NdArrayConstColumnIterator::operator==()'],['../classnc_1_1_nd_array_const_iterator.html#ac055ccace7f791cfb94d7df8e7100dc2',1,'nc::NdArrayConstIterator::operator==()'],['../classnc_1_1image_processing_1_1_pixel.html#a008757a06c498b1a31e26d53a54e51dc',1,'nc::imageProcessing::Pixel::operator==()'],['../classnc_1_1image_processing_1_1_cluster.html#a8308c5f0313872c9499de36d69d0ff19',1,'nc::imageProcessing::Cluster::operator==()'],['../classnc_1_1image_processing_1_1_centroid.html#a503a2542b388f65fb80710dd33610abc',1,'nc::imageProcessing::Centroid::operator==()'],['../classnc_1_1_slice.html#a769815d8fbb98ba34101c18a21efbbf5',1,'nc::Slice::operator==()'],['../classnc_1_1_shape.html#a0267d8b7eb226fdc442be5c914f9c870',1,'nc::Shape::operator==()'],['../classnc_1_1coordinates_1_1_r_a.html#ab9e22496d5fdc265ee5a5d77ec97c184',1,'nc::coordinates::RA::operator==()'],['../classnc_1_1coordinates_1_1_dec.html#a5b264a9d7bb9b2c1b537b03a5eac7265',1,'nc::coordinates::Dec::operator==()'],['../classnc_1_1coordinates_1_1_coordinate.html#a96255907cf1af2c416c7dbe34e96b0d5',1,'nc::coordinates::Coordinate::operator==()'],['../namespacenc.html#aa956dff0507eddc1c1d80e423f126383',1,'nc::operator==()'],['../classnc_1_1_vec3.html#a2cc63855706091881f765b63dcf52c44',1,'nc::Vec3::operator==()'],['../namespacenc.html#a283fba259d2cd892a8cbb2782490b92a',1,'nc::operator==(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#afdcaaff39ed10311d74302a6e9be2fd4',1,'nc::operator==(dtype inValue, const NdArray< dtype > &inArray)']]], + ['operator_3e_2142',['operator>',['../classnc_1_1_nd_array_const_iterator.html#a8a312e1809eae90df625971d6b4ab62e',1,'nc::NdArrayConstIterator::operator>()'],['../classnc_1_1_nd_array_const_column_iterator.html#a827d0a8431ec616ef0161144b3d24af6',1,'nc::NdArrayConstColumnIterator::operator>()'],['../namespacenc.html#a113de1155a4e2a71dcdad1709c58afe8',1,'nc::operator>(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a20910640e1c1dd8bc9298561fedc84a4',1,'nc::operator>(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept'],['../namespacenc.html#a7433343db2634ef8f75e290370cfe21e',1,'nc::operator>(const NdArray< dtype > &lhs, dtype inValue)'],['../namespacenc.html#a5755bb93bff9c0cbd38dbf1296902374',1,'nc::operator>(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)']]], + ['operator_3e_3d_2143',['operator>=',['../classnc_1_1_nd_array_const_column_iterator.html#a9935c5d4b3deff76207ccde7cfccbf62',1,'nc::NdArrayConstColumnIterator::operator>=()'],['../namespacenc.html#a4a32b6c123eaa3f46c14159b243522de',1,'nc::operator>=()'],['../classnc_1_1_nd_array_const_iterator.html#a06871d8ba079130e84a892995c07a49a',1,'nc::NdArrayConstIterator::operator>=()'],['../namespacenc.html#ac453f615df2e03778835908a70907145',1,'nc::operator>=(dtype inValue, const NdArray< dtype > &inArray)'],['../namespacenc.html#a48199b1c11d42106cd09ae57215520fe',1,'nc::operator>=(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a0dfd9f5c1ec0c3d61959c4c54e6dc23a',1,'nc::operator>=(const std::complex< T > &lhs, const std::complex< T > &rhs) noexcept']]], + ['operator_3e_3e_2144',['operator>>',['../namespacenc.html#a7e6fe3981b55cd4f381339b616a55ec8',1,'nc']]], + ['operator_3e_3e_3d_2145',['operator>>=',['../namespacenc.html#a7626eefaf34c6ac138da762c6ae930e7',1,'nc']]], + ['operator_5b_5d_2146',['operator[]',['../classnc_1_1image_processing_1_1_cluster.html#a386b222d5747fc2b77448ea5a56d24e4',1,'nc::imageProcessing::Cluster::operator[]()'],['../classnc_1_1_nd_array.html#aeabee2aba11a885f3bd874b7a06d62ea',1,'nc::NdArray::operator[](int32 inIndex) const noexcept'],['../classnc_1_1_nd_array.html#a4744ab68830cc2cc16d8804295662b6a',1,'nc::NdArray::operator[](const Slice &inSlice) const'],['../classnc_1_1_nd_array.html#ab04b63c2794747b88b0e640f737c6b2c',1,'nc::NdArray::operator[](const NdArray< bool > &inMask) const'],['../classnc_1_1_nd_array.html#a0f53f1d4f5b259021cf61026f65759e0',1,'nc::NdArray::operator[](const Indices &inIndices) const'],['../classnc_1_1_nd_array_const_iterator.html#a83ee672f75e74c4421a25a7816be12c6',1,'nc::NdArrayConstIterator::operator[]()'],['../classnc_1_1_nd_array_iterator.html#a40c132f8a7c1dd9fde17bcd3ddc2a18f',1,'nc::NdArrayIterator::operator[]()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3a37dd5a1496ecf2249950325b0a388c',1,'nc::NdArrayConstColumnIterator::operator[]()'],['../classnc_1_1_nd_array.html#aa58a51df41648b4d39f2f972c60e09ae',1,'nc::NdArray::operator[]()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#ae92d75ae626bb18324b0dfe69ee44f25',1,'nc::imageProcessing::ClusterMaker::operator[]()'],['../classnc_1_1_nd_array_column_iterator.html#a5dc1514332728850b8fbeaa7d1f8bda0',1,'nc::NdArrayColumnIterator::operator[]()'],['../classnc_1_1_data_cube.html#a1a16b98e982d79cc6a172b8e2bfad856',1,'nc::DataCube::operator[](uint32 inIndex) noexcept'],['../classnc_1_1_data_cube.html#a403c0b0df22fc5fa0858109fa7a65f87',1,'nc::DataCube::operator[](uint32 inIndex) const noexcept']]], + ['operator_5e_2147',['operator^',['../classnc_1_1polynomial_1_1_poly1d.html#a548c945121cb39859f649cf39a6d0830',1,'nc::polynomial::Poly1d::operator^()'],['../namespacenc.html#ae4befd8a03420464348fdfcc71b106bb',1,'nc::operator^(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#aa6be940ce9eed012ca0fac881d884411',1,'nc::operator^(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#af4f0fce9397ab714d3567d454f143835',1,'nc::operator^(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_5e_3d_2148',['operator^=',['../classnc_1_1polynomial_1_1_poly1d.html#a930f53185992537e3eb5844ebb70bf38',1,'nc::polynomial::Poly1d::operator^=()'],['../namespacenc.html#a8d3d77fe59d533d1301aea0112e38fa8',1,'nc::operator^=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#ad4f2748ac9b7ebe59f1592e118169ea7',1,'nc::operator^=(NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_7c_2149',['operator|',['../namespacenc.html#a2dd868d584e1d65748cf04957eb97d99',1,'nc::operator|(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#a129a0c61ca191919674576a76ee7fd93',1,'nc::operator|(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a50e6d418c92ccd6d7a2cf42a899a2203',1,'nc::operator|(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_7c_3d_2150',['operator|=',['../namespacenc.html#a958f4fd964269c7affaaff0e30b4dc01',1,'nc::operator|=(NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#afbb3e9d2eb28cad36a9de996263067d9',1,'nc::operator|=(NdArray< dtype > &lhs, dtype rhs)']]], + ['operator_7c_7c_2151',['operator||',['../namespacenc.html#a25c9ac2d82de1fd3c81890ad38ebfb25',1,'nc::operator||(const NdArray< dtype > &lhs, const NdArray< dtype > &rhs)'],['../namespacenc.html#affe1935670d985dfe387f429d68874e2',1,'nc::operator||(const NdArray< dtype > &lhs, dtype rhs)'],['../namespacenc.html#a37ef6f1c023837fbe628c3838b14d940',1,'nc::operator||(dtype lhs, const NdArray< dtype > &rhs)']]], + ['operator_7e_2152',['operator~',['../namespacenc.html#ae9d44b86bb2c2968d5c67f11ca789d3e',1,'nc']]], + ['order_2153',['order',['../classnc_1_1polynomial_1_1_poly1d.html#ab978ca2f65c7cd640309c1be86aa9141',1,'nc::polynomial::Poly1d']]], + ['outer_2154',['outer',['../namespacenc.html#a395197f9b1d3f53a5fdcd234fa6e6baf',1,'nc']]], + ['ownsinternaldata_2155',['ownsInternalData',['../classnc_1_1_nd_array.html#a63a1c0f9fdef078770e4f8cbe2c249ec',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/functions_f.html b/docs/doxygen/html/search/functions_f.html index d84063c14..54b7dee08 100644 --- a/docs/doxygen/html/search/functions_f.html +++ b/docs/doxygen/html/search/functions_f.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/functions_f.js b/docs/doxygen/html/search/functions_f.js index a70fc3fdd..e7cb94759 100644 --- a/docs/doxygen/html/search/functions_f.js +++ b/docs/doxygen/html/search/functions_f.js @@ -1,31 +1,33 @@ var searchData= [ - ['pad_2056',['pad',['../namespacenc.html#a54ebb23ac2a5fef9013f82afd8efd143',1,'nc']]], - ['partition_2057',['partition',['../classnc_1_1_nd_array.html#a2fa17d38624fabcae789cfa3323b66d8',1,'nc::NdArray::partition()'],['../namespacenc.html#a4756e923c974025e793ede125bf0902f',1,'nc::partition()']]], - ['peakpixelintensity_2058',['peakPixelIntensity',['../classnc_1_1image_processing_1_1_cluster.html#aab51c1c4539c3824bcdbd20a5db1fd4a',1,'nc::imageProcessing::Cluster']]], - ['percentile_2059',['percentile',['../namespacenc.html#aea6e5b5c0255660d4968b657b06b4d58',1,'nc']]], - ['percentilefilter_2060',['percentileFilter',['../namespacenc_1_1filter.html#a357d5be7b2dc0b511d398acc4c8af1fd',1,'nc::filter']]], - ['percentilefilter1d_2061',['percentileFilter1d',['../namespacenc_1_1filter.html#aee202739b753a067c7cb2aa32a9b1519',1,'nc::filter']]], - ['permutation_2062',['permutation',['../namespacenc_1_1random.html#a01eed1c9d55b68fa4c93afef918dd3e0',1,'nc::random::permutation(dtype inValue)'],['../namespacenc_1_1random.html#ac2ddd4fda3731e5f66378b191804085f',1,'nc::random::permutation(const NdArray< dtype > &inArray)']]], - ['pitch_2063',['pitch',['../classnc_1_1rotations_1_1_d_c_m.html#a726e1d9c5e2a88dbd7e70b8fc9d55fbf',1,'nc::rotations::DCM::pitch()'],['../classnc_1_1rotations_1_1_quaternion.html#a601b444c8c8f820700844d7ab5f743ba',1,'nc::rotations::Quaternion::pitch()']]], - ['pivotlu_5fdecomposition_2064',['pivotLU_decomposition',['../namespacenc_1_1linalg.html#a390c3d32ed4b8ed7e718cbe121025ebd',1,'nc::linalg']]], - ['pixel_2065',['Pixel',['../classnc_1_1image_processing_1_1_pixel.html#a4d1db82b1617d892266270d2bec28f61',1,'nc::imageProcessing::Pixel::Pixel(uint32 inRow, uint32 inCol, dtype inIntensity) noexcept'],['../classnc_1_1image_processing_1_1_pixel.html#a0d7095db72d4478f37d6e371e77509be',1,'nc::imageProcessing::Pixel::Pixel()=default']]], - ['pnr_2066',['pnr',['../namespacenc_1_1special.html#ab52643e0c6a859c47871094023c834b5',1,'nc::special']]], - ['poisson_2067',['poisson',['../namespacenc_1_1random.html#ae103ffefefe45e4b64067d52a1763f24',1,'nc::random::poisson(const Shape &inShape, double inMean=1)'],['../namespacenc_1_1random.html#ae18029c16ca489ea9db6331c609b20e8',1,'nc::random::poisson(double inMean=1)']]], - ['polar_2068',['polar',['../namespacenc.html#abbf3200fe11e4cb7ae6363b00099c2fe',1,'nc::polar(dtype magnitude, dtype phaseAngle)'],['../namespacenc.html#a4f674e5cab66c911b212a5eae86a641b',1,'nc::polar(const NdArray< dtype > &magnitude, const NdArray< dtype > &phaseAngle)']]], - ['poly1d_2069',['Poly1d',['../classnc_1_1polynomial_1_1_poly1d.html#a33c01905d846d32e7d49dc4e7e884551',1,'nc::polynomial::Poly1d::Poly1d(const NdArray< dtype > &inValues, bool isRoots=false)'],['../classnc_1_1polynomial_1_1_poly1d.html#a30777a0dd9351cf64f96959dad0d9ba5',1,'nc::polynomial::Poly1d::Poly1d()=default']]], - ['polygamma_2070',['polygamma',['../namespacenc_1_1special.html#a132b29cd86870cdd360652baeb54c663',1,'nc::special::polygamma(uint32 n, dtype inValue)'],['../namespacenc_1_1special.html#a1aab975128b9cfbd175699a9587b34d0',1,'nc::special::polygamma(uint32 n, const NdArray< dtype > &inArray)']]], - ['pop_5fback_2071',['pop_back',['../classnc_1_1_data_cube.html#a8e261e08fd074073771b98dc96726b0f',1,'nc::DataCube']]], - ['power_2072',['power',['../namespacenc.html#a1f059635ecfc805979db6973dfa29008',1,'nc::power(dtype inValue, uint8 inExponent) noexcept'],['../namespacenc.html#a545b7daab1de503eed95d64b2d6b6002',1,'nc::power(const NdArray< dtype > &inArray, uint8 inExponent)'],['../namespacenc.html#ad09cd336cd7c12dd32a84c91654fa5d1',1,'nc::power(const NdArray< dtype > &inArray, const NdArray< uint8 > &inExponents)'],['../namespacenc_1_1utils.html#a716a63ef8627c73f6cc4146481fcabdf',1,'nc::utils::power(dtype inValue, uint8 inPower) noexcept']]], - ['powerf_2073',['powerf',['../namespacenc_1_1utils.html#ac113b30b96f9c707c0cbe2eecbabe85f',1,'nc::utils::powerf()'],['../namespacenc.html#a1284308e19d619e53362f5784256c99f',1,'nc::powerf(const NdArray< dtype1 > &inArray, const NdArray< dtype2 > &inExponents)'],['../namespacenc.html#afa339e99c7bf037352cf0f2a0751f7fd',1,'nc::powerf(const NdArray< dtype1 > &inArray, dtype2 inExponent)'],['../namespacenc.html#acc759e42feb1633b521ed7138cf4bfe3',1,'nc::powerf(dtype1 inValue, dtype2 inExponent) noexcept']]], - ['prime_2074',['prime',['../namespacenc_1_1special.html#a9fa95a2e2a03a5eff8ea2f9e0594b206',1,'nc::special::prime(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a2e0b9f447fd033ac62a0dfe3eadb46cd',1,'nc::special::prime(uint32 n)']]], - ['print_2075',['print',['../classnc_1_1coordinates_1_1_dec.html#aaf14d802f311f155310a8efa1bf18567',1,'nc::coordinates::Dec::print()'],['../classnc_1_1image_processing_1_1_cluster.html#afdb1943f70f28747a1e83b74de984972',1,'nc::imageProcessing::Cluster::print()'],['../classnc_1_1image_processing_1_1_pixel.html#a3a8fb91578395ef70a5f6038c4c48062',1,'nc::imageProcessing::Pixel::print()'],['../classnc_1_1_nd_array.html#a8729dc551775ca022cbfbf66b22c999b',1,'nc::NdArray::print()'],['../classnc_1_1polynomial_1_1_poly1d.html#ab17f5e0983d6c66a3419cb331d158395',1,'nc::polynomial::Poly1d::print()'],['../classnc_1_1rotations_1_1_quaternion.html#a815d72f9b492ff821077d5d4652b7985',1,'nc::rotations::Quaternion::print()'],['../classnc_1_1image_processing_1_1_centroid.html#a139efcdd994d1bacdf62d65b3c427d8d',1,'nc::imageProcessing::Centroid::print()'],['../classnc_1_1_slice.html#a24c1eb77b94d3120bb02868cc965c058',1,'nc::Slice::print()'],['../classnc_1_1_shape.html#a494a3d8467911c47d56aa881e11a69f1',1,'nc::Shape::print()'],['../classnc_1_1coordinates_1_1_r_a.html#a1f935f2825ee66373e5a5b0635851d8e',1,'nc::coordinates::RA::print()'],['../classnc_1_1coordinates_1_1_coordinate.html#afb451d6e6c10d1f6cacd98bea67850a2',1,'nc::coordinates::Coordinate::print()'],['../namespacenc.html#aad1fad7ba0ba94b118bdceb29178488b',1,'nc::print()']]], - ['prod_2076',['prod',['../classnc_1_1_nd_array.html#a1a95a48b1434d2260a265d13509f864d',1,'nc::NdArray::prod()'],['../namespacenc.html#afadd339ab80158ebd9f1dc294052e58d',1,'nc::prod(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], - ['proj_2077',['proj',['../namespacenc.html#a7d1c3835da6ff00937ae62a975240957',1,'nc::proj(const NdArray< std::complex< dtype >> &inArray)'],['../namespacenc.html#a645f790a7dfb01c78317ff23e000db52',1,'nc::proj(const std::complex< dtype > &inValue)']]], - ['project_2078',['project',['../classnc_1_1_vec3.html#aaba2a76701fbf17582641cefeb513f1c',1,'nc::Vec3::project()'],['../classnc_1_1_vec2.html#aa5cb2f954360d7be97c443da16694383',1,'nc::Vec2::project()']]], - ['ptp_2079',['ptp',['../classnc_1_1_nd_array.html#aabfb3d013e77626b7e423da910ab9ffb',1,'nc::NdArray::ptp()'],['../namespacenc.html#ae336fd0ff89427cca931a05fd9a9697a',1,'nc::ptp()']]], - ['push_5fback_2080',['push_back',['../classnc_1_1_data_cube.html#a00f652afe3e8734f7d0707b12afd6a65',1,'nc::DataCube']]], - ['put_2081',['put',['../namespacenc.html#a5047b3f195605e63ef655048a8d07279',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)'],['../namespacenc.html#aa1ecdda42e74eaa37516ee8032a9a84e',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, dtype inValue)'],['../classnc_1_1_nd_array.html#ad74b89f5bac37d089ee940ae8c225703',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#af062cf00ee693dbd74d0f440b1cbded7',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a17398abb49993b960a33bd14c0db399e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a7ae6272ff9d4dea6c890ef6dcbae6eb4',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a2ebd28ce6f5227d42bd5c990a22d9f29',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#a094424d8f368eaa3730102a5f75f0c2e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#ab67c8f364caab7706d32041b2d01012d',1,'nc::NdArray::put(const Slice &inSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#ae8213735dca5d0ad895138f01aa70947',1,'nc::NdArray::put(const Slice &inSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a6a0bd2406380b080b0ab7565759bb660',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#aa8f52298436a941b3e53b8204b0b85df',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, value_type inValue)'],['../classnc_1_1_nd_array.html#a57e1fc57f28b17f5ba6b421b82066388',1,'nc::NdArray::put(int32 inRow, int32 inCol, value_type inValue)'],['../classnc_1_1_nd_array.html#a02a06425d6284dbc370807ed11b1f7b2',1,'nc::NdArray::put(int32 inIndex, value_type inValue)']]], - ['putmask_2082',['putMask',['../classnc_1_1_nd_array.html#aaf9229244e8984f557a823223ac35a29',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a52e65ffbf29d168d53ac7605acb69b4e',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, value_type inValue)']]], - ['putmask_2083',['putmask',['../namespacenc.html#af6468198b46c36c8a93068c936617725',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, dtype inValue)'],['../namespacenc.html#a0ae15cbd793c43445aca3660fc209a0c',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, const NdArray< dtype > &inValues)']]] + ['pad_2156',['pad',['../namespacenc.html#a54ebb23ac2a5fef9013f82afd8efd143',1,'nc']]], + ['partition_2157',['partition',['../classnc_1_1_nd_array.html#a2fa17d38624fabcae789cfa3323b66d8',1,'nc::NdArray::partition()'],['../namespacenc.html#a4756e923c974025e793ede125bf0902f',1,'nc::partition()']]], + ['peakpixelintensity_2158',['peakPixelIntensity',['../classnc_1_1image_processing_1_1_cluster.html#aab51c1c4539c3824bcdbd20a5db1fd4a',1,'nc::imageProcessing::Cluster']]], + ['percentile_2159',['percentile',['../namespacenc.html#aea6e5b5c0255660d4968b657b06b4d58',1,'nc']]], + ['percentilefilter_2160',['percentileFilter',['../namespacenc_1_1filter.html#a357d5be7b2dc0b511d398acc4c8af1fd',1,'nc::filter']]], + ['percentilefilter1d_2161',['percentileFilter1d',['../namespacenc_1_1filter.html#aee202739b753a067c7cb2aa32a9b1519',1,'nc::filter']]], + ['permutation_2162',['permutation',['../namespacenc_1_1random.html#ac2ddd4fda3731e5f66378b191804085f',1,'nc::random::permutation(const NdArray< dtype > &inArray)'],['../namespacenc_1_1random.html#a01eed1c9d55b68fa4c93afef918dd3e0',1,'nc::random::permutation(dtype inValue)']]], + ['pitch_2163',['pitch',['../classnc_1_1rotations_1_1_d_c_m.html#a726e1d9c5e2a88dbd7e70b8fc9d55fbf',1,'nc::rotations::DCM::pitch()'],['../classnc_1_1rotations_1_1_quaternion.html#a601b444c8c8f820700844d7ab5f743ba',1,'nc::rotations::Quaternion::pitch()']]], + ['pivotlu_5fdecomposition_2164',['pivotLU_decomposition',['../namespacenc_1_1linalg.html#a390c3d32ed4b8ed7e718cbe121025ebd',1,'nc::linalg']]], + ['pixel_2165',['Pixel',['../classnc_1_1image_processing_1_1_pixel.html#a0d7095db72d4478f37d6e371e77509be',1,'nc::imageProcessing::Pixel::Pixel()=default'],['../classnc_1_1image_processing_1_1_pixel.html#a4d1db82b1617d892266270d2bec28f61',1,'nc::imageProcessing::Pixel::Pixel(uint32 inRow, uint32 inCol, dtype inIntensity) noexcept']]], + ['place_2166',['place',['../namespacenc.html#a171da00c79cfbc9500916b6ac4d3de70',1,'nc']]], + ['pnr_2167',['pnr',['../namespacenc_1_1special.html#ab52643e0c6a859c47871094023c834b5',1,'nc::special']]], + ['poisson_2168',['poisson',['../namespacenc_1_1random.html#ae103ffefefe45e4b64067d52a1763f24',1,'nc::random::poisson(const Shape &inShape, double inMean=1)'],['../namespacenc_1_1random.html#ae18029c16ca489ea9db6331c609b20e8',1,'nc::random::poisson(double inMean=1)']]], + ['polar_2169',['polar',['../namespacenc.html#a4f674e5cab66c911b212a5eae86a641b',1,'nc::polar(const NdArray< dtype > &magnitude, const NdArray< dtype > &phaseAngle)'],['../namespacenc.html#abbf3200fe11e4cb7ae6363b00099c2fe',1,'nc::polar(dtype magnitude, dtype phaseAngle)']]], + ['poly1d_2170',['Poly1d',['../classnc_1_1polynomial_1_1_poly1d.html#a30777a0dd9351cf64f96959dad0d9ba5',1,'nc::polynomial::Poly1d::Poly1d()=default'],['../classnc_1_1polynomial_1_1_poly1d.html#a33c01905d846d32e7d49dc4e7e884551',1,'nc::polynomial::Poly1d::Poly1d(const NdArray< dtype > &inValues, bool isRoots=false)']]], + ['polygamma_2171',['polygamma',['../namespacenc_1_1special.html#a1aab975128b9cfbd175699a9587b34d0',1,'nc::special::polygamma(uint32 n, const NdArray< dtype > &inArray)'],['../namespacenc_1_1special.html#a132b29cd86870cdd360652baeb54c663',1,'nc::special::polygamma(uint32 n, dtype inValue)']]], + ['pop_5fback_2172',['pop_back',['../classnc_1_1_data_cube.html#a8e261e08fd074073771b98dc96726b0f',1,'nc::DataCube']]], + ['power_2173',['power',['../namespacenc.html#a1f059635ecfc805979db6973dfa29008',1,'nc::power(dtype inValue, uint8 inExponent) noexcept'],['../namespacenc.html#a545b7daab1de503eed95d64b2d6b6002',1,'nc::power(const NdArray< dtype > &inArray, uint8 inExponent)'],['../namespacenc.html#ad09cd336cd7c12dd32a84c91654fa5d1',1,'nc::power(const NdArray< dtype > &inArray, const NdArray< uint8 > &inExponents)'],['../namespacenc_1_1utils.html#a716a63ef8627c73f6cc4146481fcabdf',1,'nc::utils::power()']]], + ['powerf_2174',['powerf',['../namespacenc.html#acc759e42feb1633b521ed7138cf4bfe3',1,'nc::powerf(dtype1 inValue, dtype2 inExponent) noexcept'],['../namespacenc.html#afa339e99c7bf037352cf0f2a0751f7fd',1,'nc::powerf(const NdArray< dtype1 > &inArray, dtype2 inExponent)'],['../namespacenc.html#a1284308e19d619e53362f5784256c99f',1,'nc::powerf(const NdArray< dtype1 > &inArray, const NdArray< dtype2 > &inExponents)'],['../namespacenc_1_1utils.html#ac113b30b96f9c707c0cbe2eecbabe85f',1,'nc::utils::powerf()']]], + ['powersoftwo_2175',['powersOfTwo',['../namespacenc_1_1edac_1_1detail.html#ad4328ffa9ba9949a9c4b494592496055',1,'nc::edac::detail']]], + ['prime_2176',['prime',['../namespacenc_1_1special.html#a9fa95a2e2a03a5eff8ea2f9e0594b206',1,'nc::special::prime(const NdArray< uint32 > &inArray)'],['../namespacenc_1_1special.html#a2e0b9f447fd033ac62a0dfe3eadb46cd',1,'nc::special::prime(uint32 n)']]], + ['print_2177',['print',['../classnc_1_1rotations_1_1_quaternion.html#a815d72f9b492ff821077d5d4652b7985',1,'nc::rotations::Quaternion::print()'],['../classnc_1_1coordinates_1_1_coordinate.html#afb451d6e6c10d1f6cacd98bea67850a2',1,'nc::coordinates::Coordinate::print()'],['../classnc_1_1coordinates_1_1_dec.html#aaf14d802f311f155310a8efa1bf18567',1,'nc::coordinates::Dec::print()'],['../classnc_1_1coordinates_1_1_r_a.html#a1f935f2825ee66373e5a5b0635851d8e',1,'nc::coordinates::RA::print()'],['../classnc_1_1_shape.html#a494a3d8467911c47d56aa881e11a69f1',1,'nc::Shape::print()'],['../classnc_1_1_slice.html#a24c1eb77b94d3120bb02868cc965c058',1,'nc::Slice::print()'],['../classnc_1_1image_processing_1_1_centroid.html#a139efcdd994d1bacdf62d65b3c427d8d',1,'nc::imageProcessing::Centroid::print()'],['../classnc_1_1image_processing_1_1_cluster.html#afdb1943f70f28747a1e83b74de984972',1,'nc::imageProcessing::Cluster::print()'],['../classnc_1_1image_processing_1_1_pixel.html#a3a8fb91578395ef70a5f6038c4c48062',1,'nc::imageProcessing::Pixel::print()'],['../classnc_1_1_nd_array.html#a8729dc551775ca022cbfbf66b22c999b',1,'nc::NdArray::print()'],['../classnc_1_1polynomial_1_1_poly1d.html#ab17f5e0983d6c66a3419cb331d158395',1,'nc::polynomial::Poly1d::print()'],['../namespacenc.html#aad1fad7ba0ba94b118bdceb29178488b',1,'nc::print()']]], + ['prod_2178',['prod',['../classnc_1_1_nd_array.html#a1a95a48b1434d2260a265d13509f864d',1,'nc::NdArray::prod()'],['../namespacenc.html#afadd339ab80158ebd9f1dc294052e58d',1,'nc::prod(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)']]], + ['proj_2179',['proj',['../namespacenc.html#a645f790a7dfb01c78317ff23e000db52',1,'nc::proj(const std::complex< dtype > &inValue)'],['../namespacenc.html#a7d1c3835da6ff00937ae62a975240957',1,'nc::proj(const NdArray< std::complex< dtype >> &inArray)']]], + ['project_2180',['project',['../classnc_1_1_vec3.html#aaba2a76701fbf17582641cefeb513f1c',1,'nc::Vec3::project()'],['../classnc_1_1_vec2.html#aa5cb2f954360d7be97c443da16694383',1,'nc::Vec2::project()']]], + ['ptp_2181',['ptp',['../classnc_1_1_nd_array.html#aabfb3d013e77626b7e423da910ab9ffb',1,'nc::NdArray::ptp()'],['../namespacenc.html#ae336fd0ff89427cca931a05fd9a9697a',1,'nc::ptp()']]], + ['push_5fback_2182',['push_back',['../classnc_1_1_data_cube.html#a00f652afe3e8734f7d0707b12afd6a65',1,'nc::DataCube']]], + ['put_2183',['put',['../classnc_1_1_nd_array.html#aa8f52298436a941b3e53b8204b0b85df',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, value_type inValue)'],['../classnc_1_1_nd_array.html#a57e1fc57f28b17f5ba6b421b82066388',1,'nc::NdArray::put(int32 inRow, int32 inCol, value_type inValue)'],['../classnc_1_1_nd_array.html#a02a06425d6284dbc370807ed11b1f7b2',1,'nc::NdArray::put(int32 inIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#ad74b89f5bac37d089ee940ae8c225703',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#af062cf00ee693dbd74d0f440b1cbded7',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a17398abb49993b960a33bd14c0db399e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a7ae6272ff9d4dea6c890ef6dcbae6eb4',1,'nc::NdArray::put(int32 inRowIndex, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#a2ebd28ce6f5227d42bd5c990a22d9f29',1,'nc::NdArray::put(const Slice &inRowSlice, int32 inColIndex, value_type inValue)'],['../classnc_1_1_nd_array.html#a094424d8f368eaa3730102a5f75f0c2e',1,'nc::NdArray::put(const Slice &inRowSlice, const Slice &inColSlice, value_type inValue)'],['../classnc_1_1_nd_array.html#ab67c8f364caab7706d32041b2d01012d',1,'nc::NdArray::put(const Slice &inSlice, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a6a0bd2406380b080b0ab7565759bb660',1,'nc::NdArray::put(const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#ae8213735dca5d0ad895138f01aa70947',1,'nc::NdArray::put(const Slice &inSlice, value_type inValue)'],['../namespacenc.html#aa1ecdda42e74eaa37516ee8032a9a84e',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, dtype inValue)'],['../namespacenc.html#a5047b3f195605e63ef655048a8d07279',1,'nc::put(NdArray< dtype > &inArray, const NdArray< uint32 > &inIndices, const NdArray< dtype > &inValues)']]], + ['putmask_2184',['putMask',['../classnc_1_1_nd_array.html#aaf9229244e8984f557a823223ac35a29',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, const NdArray< dtype > &inValues)'],['../classnc_1_1_nd_array.html#a52e65ffbf29d168d53ac7605acb69b4e',1,'nc::NdArray::putMask(const NdArray< bool > &inMask, value_type inValue)']]], + ['putmask_2185',['putmask',['../namespacenc.html#af6468198b46c36c8a93068c936617725',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, dtype inValue)'],['../namespacenc.html#a0ae15cbd793c43445aca3660fc209a0c',1,'nc::putmask(NdArray< dtype > &inArray, const NdArray< bool > &inMask, const NdArray< dtype > &inValues)']]] ]; diff --git a/docs/doxygen/html/search/namespaces_0.html b/docs/doxygen/html/search/namespaces_0.html index 5b42bb2aa..21db2c3a5 100644 --- a/docs/doxygen/html/search/namespaces_0.html +++ b/docs/doxygen/html/search/namespaces_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/namespaces_0.js b/docs/doxygen/html/search/namespaces_0.js index 35de88d96..067620a12 100644 --- a/docs/doxygen/html/search/namespaces_0.js +++ b/docs/doxygen/html/search/namespaces_0.js @@ -1,21 +1,23 @@ var searchData= [ - ['boundary_1200',['boundary',['../namespacenc_1_1filter_1_1boundary.html',1,'nc::filter']]], - ['constants_1201',['constants',['../namespacenc_1_1constants.html',1,'nc']]], - ['coordinates_1202',['coordinates',['../namespacenc_1_1coordinates.html',1,'nc']]], - ['endian_1203',['endian',['../namespacenc_1_1endian.html',1,'nc']]], - ['error_1204',['error',['../namespacenc_1_1error.html',1,'nc']]], - ['filesystem_1205',['filesystem',['../namespacenc_1_1filesystem.html',1,'nc']]], - ['filter_1206',['filter',['../namespacenc_1_1filter.html',1,'nc']]], - ['imageprocessing_1207',['imageProcessing',['../namespacenc_1_1image_processing.html',1,'nc']]], - ['integrate_1208',['integrate',['../namespacenc_1_1integrate.html',1,'nc']]], - ['linalg_1209',['linalg',['../namespacenc_1_1linalg.html',1,'nc']]], - ['nc_1210',['nc',['../namespacenc.html',1,'']]], - ['polynomial_1211',['polynomial',['../namespacenc_1_1polynomial.html',1,'nc']]], - ['random_1212',['random',['../namespacenc_1_1random.html',1,'nc']]], - ['roots_1213',['roots',['../namespacenc_1_1roots.html',1,'nc']]], - ['rotations_1214',['rotations',['../namespacenc_1_1rotations.html',1,'nc']]], - ['special_1215',['special',['../namespacenc_1_1special.html',1,'nc']]], - ['stl_5falgorithms_1216',['stl_algorithms',['../namespacenc_1_1stl__algorithms.html',1,'nc']]], - ['utils_1217',['utils',['../namespacenc_1_1utils.html',1,'nc']]] + ['boundary_1254',['boundary',['../namespacenc_1_1filter_1_1boundary.html',1,'nc::filter']]], + ['constants_1255',['constants',['../namespacenc_1_1constants.html',1,'nc']]], + ['coordinates_1256',['coordinates',['../namespacenc_1_1coordinates.html',1,'nc']]], + ['detail_1257',['detail',['../namespacenc_1_1edac_1_1detail.html',1,'nc::edac']]], + ['edac_1258',['edac',['../namespacenc_1_1edac.html',1,'nc']]], + ['endian_1259',['endian',['../namespacenc_1_1endian.html',1,'nc']]], + ['error_1260',['error',['../namespacenc_1_1error.html',1,'nc']]], + ['filesystem_1261',['filesystem',['../namespacenc_1_1filesystem.html',1,'nc']]], + ['filter_1262',['filter',['../namespacenc_1_1filter.html',1,'nc']]], + ['imageprocessing_1263',['imageProcessing',['../namespacenc_1_1image_processing.html',1,'nc']]], + ['integrate_1264',['integrate',['../namespacenc_1_1integrate.html',1,'nc']]], + ['linalg_1265',['linalg',['../namespacenc_1_1linalg.html',1,'nc']]], + ['nc_1266',['nc',['../namespacenc.html',1,'']]], + ['polynomial_1267',['polynomial',['../namespacenc_1_1polynomial.html',1,'nc']]], + ['random_1268',['random',['../namespacenc_1_1random.html',1,'nc']]], + ['roots_1269',['roots',['../namespacenc_1_1roots.html',1,'nc']]], + ['rotations_1270',['rotations',['../namespacenc_1_1rotations.html',1,'nc']]], + ['special_1271',['special',['../namespacenc_1_1special.html',1,'nc']]], + ['stl_5falgorithms_1272',['stl_algorithms',['../namespacenc_1_1stl__algorithms.html',1,'nc']]], + ['utils_1273',['utils',['../namespacenc_1_1utils.html',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/pages_0.html b/docs/doxygen/html/search/pages_0.html index 179054040..8517b48f0 100644 --- a/docs/doxygen/html/search/pages_0.html +++ b/docs/doxygen/html/search/pages_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/pages_0.js b/docs/doxygen/html/search/pages_0.js index bbeddc3da..4c16c9a63 100644 --- a/docs/doxygen/html/search/pages_0.js +++ b/docs/doxygen/html/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['building_2347',['Building',['../md__mnt_c__github__num_cpp_docs_markdown__building.html',1,'']]] + ['building_2449',['Building',['../md__c___github__num_cpp_docs_markdown__building.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/pages_1.html b/docs/doxygen/html/search/pages_1.html index 1ffd4f9a0..a0fb67963 100644 --- a/docs/doxygen/html/search/pages_1.html +++ b/docs/doxygen/html/search/pages_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/pages_1.js b/docs/doxygen/html/search/pages_1.js index 70a252b5d..d184caae7 100644 --- a/docs/doxygen/html/search/pages_1.js +++ b/docs/doxygen/html/search/pages_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['compiler_20flags_2348',['Compiler Flags',['../md__mnt_c__github__num_cpp_docs_markdown__compiler_flags.html',1,'']]] + ['compiler_20flags_2450',['Compiler Flags',['../md__c___github__num_cpp_docs_markdown__compiler_flags.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/pages_2.html b/docs/doxygen/html/search/pages_2.html index fb2527e90..084edfd03 100644 --- a/docs/doxygen/html/search/pages_2.html +++ b/docs/doxygen/html/search/pages_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/pages_2.js b/docs/doxygen/html/search/pages_2.js index 3c7a58abb..097281f88 100644 --- a/docs/doxygen/html/search/pages_2.js +++ b/docs/doxygen/html/search/pages_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['installation_2349',['Installation',['../md__mnt_c__github__num_cpp_docs_markdown__installation.html',1,'']]] + ['installation_2451',['Installation',['../md__c___github__num_cpp_docs_markdown__installation.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/pages_3.html b/docs/doxygen/html/search/pages_3.html index 063756b74..c0b45b0fc 100644 --- a/docs/doxygen/html/search/pages_3.html +++ b/docs/doxygen/html/search/pages_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/pages_3.js b/docs/doxygen/html/search/pages_3.js index eb0e7937a..54d582345 100644 --- a/docs/doxygen/html/search/pages_3.js +++ b/docs/doxygen/html/search/pages_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['numcpp_2350',['NumCpp',['../index.html',1,'']]] + ['release_20notes_2452',['Release Notes',['../md__c___github__num_cpp_docs_markdown__release_notes.html',1,'']]] ]; diff --git a/docs/doxygen/html/search/related_0.html b/docs/doxygen/html/search/related_0.html index fd2abf1b9..506aaecc0 100644 --- a/docs/doxygen/html/search/related_0.html +++ b/docs/doxygen/html/search/related_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/related_0.js b/docs/doxygen/html/search/related_0.js index a2b65f2c0..b3a963381 100644 --- a/docs/doxygen/html/search/related_0.js +++ b/docs/doxygen/html/search/related_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['operator_3c_3c_2337',['operator<<',['../classnc_1_1coordinates_1_1_coordinate.html#aa9e34ee6b7a8425e6af5a715935a4251',1,'nc::coordinates::Coordinate::operator<<()'],['../classnc_1_1coordinates_1_1_dec.html#a83e1fb757cb9153e02dcecd2a37976c1',1,'nc::coordinates::Dec::operator<<()'],['../classnc_1_1coordinates_1_1_r_a.html#aa7b5289b9d14da6e7b4393be2fddfc33',1,'nc::coordinates::RA::operator<<()'],['../classnc_1_1_shape.html#a520d818f31bbdacdf8cfbe6de9e88a28',1,'nc::Shape::operator<<()'],['../classnc_1_1_slice.html#ad6889d2df295fef3796aebb769b8cac0',1,'nc::Slice::operator<<()'],['../classnc_1_1image_processing_1_1_centroid.html#a787da1f79223e97a2788a2ad47e1c394',1,'nc::imageProcessing::Centroid::operator<<()'],['../classnc_1_1image_processing_1_1_cluster.html#a1b1adec296082d83ee2f87484bfe07cb',1,'nc::imageProcessing::Cluster::operator<<()'],['../classnc_1_1image_processing_1_1_pixel.html#a157a2e98ace3e2185af571a68e5a5b9c',1,'nc::imageProcessing::Pixel::operator<<()'],['../classnc_1_1polynomial_1_1_poly1d.html#a589d9ff132413fa86a20f2fa7910e5df',1,'nc::polynomial::Poly1d::operator<<()'],['../classnc_1_1rotations_1_1_quaternion.html#a6d11f3a719f010cdd220642d2bb586e6',1,'nc::rotations::Quaternion::operator<<()']]] + ['operator_3c_3c_2439',['operator<<',['../classnc_1_1coordinates_1_1_coordinate.html#aa9e34ee6b7a8425e6af5a715935a4251',1,'nc::coordinates::Coordinate::operator<<()'],['../classnc_1_1coordinates_1_1_dec.html#a83e1fb757cb9153e02dcecd2a37976c1',1,'nc::coordinates::Dec::operator<<()'],['../classnc_1_1coordinates_1_1_r_a.html#aa7b5289b9d14da6e7b4393be2fddfc33',1,'nc::coordinates::RA::operator<<()'],['../classnc_1_1_shape.html#a520d818f31bbdacdf8cfbe6de9e88a28',1,'nc::Shape::operator<<()'],['../classnc_1_1_slice.html#ad6889d2df295fef3796aebb769b8cac0',1,'nc::Slice::operator<<()'],['../classnc_1_1image_processing_1_1_centroid.html#a787da1f79223e97a2788a2ad47e1c394',1,'nc::imageProcessing::Centroid::operator<<()'],['../classnc_1_1image_processing_1_1_cluster.html#a1b1adec296082d83ee2f87484bfe07cb',1,'nc::imageProcessing::Cluster::operator<<()'],['../classnc_1_1image_processing_1_1_pixel.html#a157a2e98ace3e2185af571a68e5a5b9c',1,'nc::imageProcessing::Pixel::operator<<()'],['../classnc_1_1polynomial_1_1_poly1d.html#a589d9ff132413fa86a20f2fa7910e5df',1,'nc::polynomial::Poly1d::operator<<()'],['../classnc_1_1rotations_1_1_quaternion.html#a6d11f3a719f010cdd220642d2bb586e6',1,'nc::rotations::Quaternion::operator<<()']]] ]; diff --git a/docs/doxygen/html/search/searchdata.js b/docs/doxygen/html/search/searchdata.js index e4ee9d713..61c01ff30 100644 --- a/docs/doxygen/html/search/searchdata.js +++ b/docs/doxygen/html/search/searchdata.js @@ -1,9 +1,9 @@ var indexSectionsWithContent = { 0: "abcdefghijklmnopqrstuvwxyz~", - 1: "abcdfilnpqrstv", + 1: "abcdfgilnpqrstv", 2: "n", - 3: "abcdefghilmnopqrstuvwz", + 3: "abcdefghiklmnopqrstuvwz", 4: "abcdefghijklmnopqrstuvwxyz~", 5: "acdeghijmnprsvxyz", 6: "acdeiprstuv", @@ -11,7 +11,7 @@ var indexSectionsWithContent = 8: "bclmnprw", 9: "o", 10: "cst", - 11: "bcinr" + 11: "bcir" }; var indexSectionNames = diff --git a/docs/doxygen/html/search/typedefs_0.html b/docs/doxygen/html/search/typedefs_0.html index 96fc8469a..a4684c4ad 100644 --- a/docs/doxygen/html/search/typedefs_0.html +++ b/docs/doxygen/html/search/typedefs_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_0.js b/docs/doxygen/html/search/typedefs_0.js index c36ba4429..4f14aaf59 100644 --- a/docs/doxygen/html/search/typedefs_0.js +++ b/docs/doxygen/html/search/typedefs_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['allocator_5ftype_2292',['allocator_type',['../classnc_1_1_nd_array.html#a86488494684f55c32dd82e90b818f77e',1,'nc::NdArray']]] + ['allocator_5ftype_2394',['allocator_type',['../classnc_1_1_nd_array.html#a86488494684f55c32dd82e90b818f77e',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/typedefs_1.html b/docs/doxygen/html/search/typedefs_1.html index 8bab1725f..46cf01e62 100644 --- a/docs/doxygen/html/search/typedefs_1.html +++ b/docs/doxygen/html/search/typedefs_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_1.js b/docs/doxygen/html/search/typedefs_1.js index 916104814..329efce54 100644 --- a/docs/doxygen/html/search/typedefs_1.js +++ b/docs/doxygen/html/search/typedefs_1.js @@ -1,11 +1,11 @@ var searchData= [ - ['chronoclock_2293',['ChronoClock',['../classnc_1_1_timer.html#a968ad8ca046ae73671e211e644682c8d',1,'nc::Timer']]], - ['column_5fiterator_2294',['column_iterator',['../classnc_1_1_nd_array.html#a379e1e1ed2a61de6aa44226679620d47',1,'nc::NdArray']]], - ['const_5fcolumn_5fiterator_2295',['const_column_iterator',['../classnc_1_1_nd_array.html#a1307cf472f722baa8850200dcb7a3a89',1,'nc::NdArray']]], - ['const_5fiterator_2296',['const_iterator',['../classnc_1_1_data_cube.html#a1ea7b9bd30731c3325545fbcd2678761',1,'nc::DataCube::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster.html#a3b344c255dfcfcf18e0fc9f1e84979ae',1,'nc::imageProcessing::Cluster::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a870aeb2f713b4efba22a2f978704c215',1,'nc::imageProcessing::ClusterMaker::const_iterator()'],['../classnc_1_1_nd_array.html#a49deeee0db98eae1c16ac6bca6fa6f31',1,'nc::NdArray::const_iterator()']]], - ['const_5fpointer_2297',['const_pointer',['../classnc_1_1_nd_array.html#a94982f81d8aa8c8a72abe0327f22b4dd',1,'nc::NdArray']]], - ['const_5freference_2298',['const_reference',['../classnc_1_1_nd_array.html#a2e9001eb3a7fb5b44f6400b3cc3b3222',1,'nc::NdArray']]], - ['const_5freverse_5fcolumn_5fiterator_2299',['const_reverse_column_iterator',['../classnc_1_1_nd_array.html#aa4f80e21b4b0f30ff98d1b90ae4fd70d',1,'nc::NdArray']]], - ['const_5freverse_5fiterator_2300',['const_reverse_iterator',['../classnc_1_1_nd_array.html#a6de6f2ef3b2519edd272623a9681b527',1,'nc::NdArray']]] + ['chronoclock_2395',['ChronoClock',['../classnc_1_1_timer.html#a968ad8ca046ae73671e211e644682c8d',1,'nc::Timer']]], + ['column_5fiterator_2396',['column_iterator',['../classnc_1_1_nd_array.html#a379e1e1ed2a61de6aa44226679620d47',1,'nc::NdArray']]], + ['const_5fcolumn_5fiterator_2397',['const_column_iterator',['../classnc_1_1_nd_array.html#a1307cf472f722baa8850200dcb7a3a89',1,'nc::NdArray']]], + ['const_5fiterator_2398',['const_iterator',['../classnc_1_1_data_cube.html#a1ea7b9bd30731c3325545fbcd2678761',1,'nc::DataCube::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster.html#a3b344c255dfcfcf18e0fc9f1e84979ae',1,'nc::imageProcessing::Cluster::const_iterator()'],['../classnc_1_1image_processing_1_1_cluster_maker.html#a870aeb2f713b4efba22a2f978704c215',1,'nc::imageProcessing::ClusterMaker::const_iterator()'],['../classnc_1_1_nd_array.html#a49deeee0db98eae1c16ac6bca6fa6f31',1,'nc::NdArray::const_iterator()']]], + ['const_5fpointer_2399',['const_pointer',['../classnc_1_1_nd_array.html#a94982f81d8aa8c8a72abe0327f22b4dd',1,'nc::NdArray']]], + ['const_5freference_2400',['const_reference',['../classnc_1_1_nd_array.html#a2e9001eb3a7fb5b44f6400b3cc3b3222',1,'nc::NdArray']]], + ['const_5freverse_5fcolumn_5fiterator_2401',['const_reverse_column_iterator',['../classnc_1_1_nd_array.html#aa4f80e21b4b0f30ff98d1b90ae4fd70d',1,'nc::NdArray']]], + ['const_5freverse_5fiterator_2402',['const_reverse_iterator',['../classnc_1_1_nd_array.html#a6de6f2ef3b2519edd272623a9681b527',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/typedefs_2.html b/docs/doxygen/html/search/typedefs_2.html index 7aba79e5a..6835ee65b 100644 --- a/docs/doxygen/html/search/typedefs_2.html +++ b/docs/doxygen/html/search/typedefs_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_2.js b/docs/doxygen/html/search/typedefs_2.js index 2ef8a3fa8..33cf59111 100644 --- a/docs/doxygen/html/search/typedefs_2.js +++ b/docs/doxygen/html/search/typedefs_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['difference_5ftype_2301',['difference_type',['../classnc_1_1_nd_array.html#a612cdd532e56b711ebb9c2478971c04f',1,'nc::NdArray::difference_type()'],['../classnc_1_1_nd_array_const_iterator.html#a16aa191e5615d641693ff077b56771ad',1,'nc::NdArrayConstIterator::difference_type()'],['../classnc_1_1_nd_array_iterator.html#a871a849294da1c7e7b99250008471138',1,'nc::NdArrayIterator::difference_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad4e9c4a6df66608a4d6ea6e7608337ce',1,'nc::NdArrayConstColumnIterator::difference_type()'],['../classnc_1_1_nd_array_column_iterator.html#addc363984d95db8bed56843682372e44',1,'nc::NdArrayColumnIterator::difference_type()']]] + ['difference_5ftype_2403',['difference_type',['../classnc_1_1_nd_array.html#a612cdd532e56b711ebb9c2478971c04f',1,'nc::NdArray::difference_type()'],['../classnc_1_1_nd_array_const_iterator.html#a16aa191e5615d641693ff077b56771ad',1,'nc::NdArrayConstIterator::difference_type()'],['../classnc_1_1_nd_array_iterator.html#a871a849294da1c7e7b99250008471138',1,'nc::NdArrayIterator::difference_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#ad4e9c4a6df66608a4d6ea6e7608337ce',1,'nc::NdArrayConstColumnIterator::difference_type()'],['../classnc_1_1_nd_array_column_iterator.html#addc363984d95db8bed56843682372e44',1,'nc::NdArrayColumnIterator::difference_type()']]] ]; diff --git a/docs/doxygen/html/search/typedefs_3.html b/docs/doxygen/html/search/typedefs_3.html index 643350c0c..017004765 100644 --- a/docs/doxygen/html/search/typedefs_3.html +++ b/docs/doxygen/html/search/typedefs_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_3.js b/docs/doxygen/html/search/typedefs_3.js index 4fbae22b4..601a7aa25 100644 --- a/docs/doxygen/html/search/typedefs_3.js +++ b/docs/doxygen/html/search/typedefs_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['enable_5fif_5ft_2302',['enable_if_t',['../namespacenc.html#ae6f8d4a50bd2b4254f00085e7f17ce01',1,'nc']]] + ['enable_5fif_5ft_2404',['enable_if_t',['../namespacenc.html#ae6f8d4a50bd2b4254f00085e7f17ce01',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/typedefs_4.html b/docs/doxygen/html/search/typedefs_4.html index 0e9086be6..81466a5d2 100644 --- a/docs/doxygen/html/search/typedefs_4.html +++ b/docs/doxygen/html/search/typedefs_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_4.js b/docs/doxygen/html/search/typedefs_4.js index a89c0ef94..ea747e9b2 100644 --- a/docs/doxygen/html/search/typedefs_4.js +++ b/docs/doxygen/html/search/typedefs_4.js @@ -1,9 +1,9 @@ var searchData= [ - ['int16_2303',['int16',['../namespacenc.html#a8f5045ed0f0a08d87fd76d7a74ac128d',1,'nc']]], - ['int32_2304',['int32',['../namespacenc.html#a9386099a0fdc2bc9fb0dbfde5606584d',1,'nc']]], - ['int64_2305',['int64',['../namespacenc.html#a6223a7f3b0f7886036f64276f36c921e',1,'nc']]], - ['int8_2306',['int8',['../namespacenc.html#a0815baab2bc081f4250ba9cb1cf361b4',1,'nc']]], - ['iterator_2307',['iterator',['../classnc_1_1_data_cube.html#a623df8fc48ba169d221b1c26249e5853',1,'nc::DataCube::iterator()'],['../classnc_1_1_nd_array.html#a33ce0c581a22e809cfc5a79a534bf798',1,'nc::NdArray::iterator()']]], - ['iterator_5fcategory_2308',['iterator_category',['../classnc_1_1_nd_array_const_iterator.html#a17535e5dcb696923adaa626c86cc3c00',1,'nc::NdArrayConstIterator::iterator_category()'],['../classnc_1_1_nd_array_iterator.html#a7b2c0794eac54ab2c3847776a8383283',1,'nc::NdArrayIterator::iterator_category()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3ed61bf2a830e89fd8fbbb6efc2e7171',1,'nc::NdArrayConstColumnIterator::iterator_category()'],['../classnc_1_1_nd_array_column_iterator.html#a3785618b3936e835ccc15b39440f3da5',1,'nc::NdArrayColumnIterator::iterator_category()']]] + ['int16_2405',['int16',['../namespacenc.html#a8f5045ed0f0a08d87fd76d7a74ac128d',1,'nc']]], + ['int32_2406',['int32',['../namespacenc.html#a9386099a0fdc2bc9fb0dbfde5606584d',1,'nc']]], + ['int64_2407',['int64',['../namespacenc.html#a6223a7f3b0f7886036f64276f36c921e',1,'nc']]], + ['int8_2408',['int8',['../namespacenc.html#a0815baab2bc081f4250ba9cb1cf361b4',1,'nc']]], + ['iterator_2409',['iterator',['../classnc_1_1_data_cube.html#a623df8fc48ba169d221b1c26249e5853',1,'nc::DataCube::iterator()'],['../classnc_1_1_nd_array.html#a33ce0c581a22e809cfc5a79a534bf798',1,'nc::NdArray::iterator()']]], + ['iterator_5fcategory_2410',['iterator_category',['../classnc_1_1_nd_array_const_iterator.html#a17535e5dcb696923adaa626c86cc3c00',1,'nc::NdArrayConstIterator::iterator_category()'],['../classnc_1_1_nd_array_iterator.html#a7b2c0794eac54ab2c3847776a8383283',1,'nc::NdArrayIterator::iterator_category()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3ed61bf2a830e89fd8fbbb6efc2e7171',1,'nc::NdArrayConstColumnIterator::iterator_category()'],['../classnc_1_1_nd_array_column_iterator.html#a3785618b3936e835ccc15b39440f3da5',1,'nc::NdArrayColumnIterator::iterator_category()']]] ]; diff --git a/docs/doxygen/html/search/typedefs_5.html b/docs/doxygen/html/search/typedefs_5.html index cfd706941..43fbec1fe 100644 --- a/docs/doxygen/html/search/typedefs_5.html +++ b/docs/doxygen/html/search/typedefs_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_5.js b/docs/doxygen/html/search/typedefs_5.js index c51dda5f2..c81166e30 100644 --- a/docs/doxygen/html/search/typedefs_5.js +++ b/docs/doxygen/html/search/typedefs_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['pointer_2309',['pointer',['../classnc_1_1_nd_array.html#a288e6b26205492751717d3fb8854ca30',1,'nc::NdArray::pointer()'],['../classnc_1_1_nd_array_const_iterator.html#a47936ba0f04dbcad7ab4e239bfb7da03',1,'nc::NdArrayConstIterator::pointer()'],['../classnc_1_1_nd_array_iterator.html#a60d5e768fcd13cedd43febeb28148aea',1,'nc::NdArrayIterator::pointer()'],['../classnc_1_1_nd_array_const_column_iterator.html#a4070d7ef2c99fec46a8df015769f58b6',1,'nc::NdArrayConstColumnIterator::pointer()'],['../classnc_1_1_nd_array_column_iterator.html#aeb402bf56941dc24138dc9f33845be81',1,'nc::NdArrayColumnIterator::pointer()']]] + ['pointer_2411',['pointer',['../classnc_1_1_nd_array.html#a288e6b26205492751717d3fb8854ca30',1,'nc::NdArray::pointer()'],['../classnc_1_1_nd_array_const_iterator.html#a47936ba0f04dbcad7ab4e239bfb7da03',1,'nc::NdArrayConstIterator::pointer()'],['../classnc_1_1_nd_array_iterator.html#a60d5e768fcd13cedd43febeb28148aea',1,'nc::NdArrayIterator::pointer()'],['../classnc_1_1_nd_array_const_column_iterator.html#a4070d7ef2c99fec46a8df015769f58b6',1,'nc::NdArrayConstColumnIterator::pointer()'],['../classnc_1_1_nd_array_column_iterator.html#aeb402bf56941dc24138dc9f33845be81',1,'nc::NdArrayColumnIterator::pointer()']]] ]; diff --git a/docs/doxygen/html/search/typedefs_6.html b/docs/doxygen/html/search/typedefs_6.html index fb1fd4fa4..99479c2d5 100644 --- a/docs/doxygen/html/search/typedefs_6.html +++ b/docs/doxygen/html/search/typedefs_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_6.js b/docs/doxygen/html/search/typedefs_6.js index 4e7a270d5..7e26e3289 100644 --- a/docs/doxygen/html/search/typedefs_6.js +++ b/docs/doxygen/html/search/typedefs_6.js @@ -1,6 +1,6 @@ var searchData= [ - ['reference_2310',['reference',['../classnc_1_1_nd_array.html#adb4a1e1a3c3420c4b2133ba81a44a0e0',1,'nc::NdArray::reference()'],['../classnc_1_1_nd_array_const_iterator.html#aba1912cb4e7cc39898af1ea385847544',1,'nc::NdArrayConstIterator::reference()'],['../classnc_1_1_nd_array_iterator.html#a0782b66e4d3632cd4ce99333fe86d0a3',1,'nc::NdArrayIterator::reference()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6903047bac2424843ca26ed9116abb77',1,'nc::NdArrayConstColumnIterator::reference()'],['../classnc_1_1_nd_array_column_iterator.html#aaccb5a94c10e92de24e5bc465c663305',1,'nc::NdArrayColumnIterator::reference()']]], - ['reverse_5fcolumn_5fiterator_2311',['reverse_column_iterator',['../classnc_1_1_nd_array.html#abc1bc6a854968940dac643396b2fb1b5',1,'nc::NdArray']]], - ['reverse_5fiterator_2312',['reverse_iterator',['../classnc_1_1_nd_array.html#a9987ced72f8182d4b55807c0177eab11',1,'nc::NdArray']]] + ['reference_2412',['reference',['../classnc_1_1_nd_array.html#adb4a1e1a3c3420c4b2133ba81a44a0e0',1,'nc::NdArray::reference()'],['../classnc_1_1_nd_array_const_iterator.html#aba1912cb4e7cc39898af1ea385847544',1,'nc::NdArrayConstIterator::reference()'],['../classnc_1_1_nd_array_iterator.html#a0782b66e4d3632cd4ce99333fe86d0a3',1,'nc::NdArrayIterator::reference()'],['../classnc_1_1_nd_array_const_column_iterator.html#a6903047bac2424843ca26ed9116abb77',1,'nc::NdArrayConstColumnIterator::reference()'],['../classnc_1_1_nd_array_column_iterator.html#aaccb5a94c10e92de24e5bc465c663305',1,'nc::NdArrayColumnIterator::reference()']]], + ['reverse_5fcolumn_5fiterator_2413',['reverse_column_iterator',['../classnc_1_1_nd_array.html#abc1bc6a854968940dac643396b2fb1b5',1,'nc::NdArray']]], + ['reverse_5fiterator_2414',['reverse_iterator',['../classnc_1_1_nd_array.html#a9987ced72f8182d4b55807c0177eab11',1,'nc::NdArray']]] ]; diff --git a/docs/doxygen/html/search/typedefs_7.html b/docs/doxygen/html/search/typedefs_7.html index b0aa9726f..9a825e0a2 100644 --- a/docs/doxygen/html/search/typedefs_7.html +++ b/docs/doxygen/html/search/typedefs_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_7.js b/docs/doxygen/html/search/typedefs_7.js index 8d64d4d7b..64cf70d23 100644 --- a/docs/doxygen/html/search/typedefs_7.js +++ b/docs/doxygen/html/search/typedefs_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['size_5ftype_2313',['size_type',['../classnc_1_1_nd_array.html#ae2bdede667042f52176de3f3649735f6',1,'nc::NdArray::size_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a99d31459bd356031b795095a38366706',1,'nc::NdArrayConstColumnIterator::size_type()'],['../classnc_1_1_nd_array_column_iterator.html#a845a41edc124e1c38ccf1940c02e272d',1,'nc::NdArrayColumnIterator::size_type()']]] + ['size_5ftype_2415',['size_type',['../classnc_1_1_nd_array.html#ae2bdede667042f52176de3f3649735f6',1,'nc::NdArray::size_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a99d31459bd356031b795095a38366706',1,'nc::NdArrayConstColumnIterator::size_type()'],['../classnc_1_1_nd_array_column_iterator.html#a845a41edc124e1c38ccf1940c02e272d',1,'nc::NdArrayColumnIterator::size_type()']]] ]; diff --git a/docs/doxygen/html/search/typedefs_8.html b/docs/doxygen/html/search/typedefs_8.html index 6126c6ff9..e968613ec 100644 --- a/docs/doxygen/html/search/typedefs_8.html +++ b/docs/doxygen/html/search/typedefs_8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_8.js b/docs/doxygen/html/search/typedefs_8.js index c0735bf6f..22af00e8d 100644 --- a/docs/doxygen/html/search/typedefs_8.js +++ b/docs/doxygen/html/search/typedefs_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['timepoint_2314',['TimePoint',['../classnc_1_1_timer.html#a29e54a50e709622942a33e70b1b1e8f6',1,'nc::Timer']]] + ['timepoint_2416',['TimePoint',['../classnc_1_1_timer.html#a29e54a50e709622942a33e70b1b1e8f6',1,'nc::Timer']]] ]; diff --git a/docs/doxygen/html/search/typedefs_9.html b/docs/doxygen/html/search/typedefs_9.html index c647c84ff..2e9153256 100644 --- a/docs/doxygen/html/search/typedefs_9.html +++ b/docs/doxygen/html/search/typedefs_9.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_9.js b/docs/doxygen/html/search/typedefs_9.js index 47f098886..777189142 100644 --- a/docs/doxygen/html/search/typedefs_9.js +++ b/docs/doxygen/html/search/typedefs_9.js @@ -1,7 +1,7 @@ var searchData= [ - ['uint16_2315',['uint16',['../namespacenc.html#a8146518cf6c6a8029c3d84a376167793',1,'nc']]], - ['uint32_2316',['uint32',['../namespacenc.html#af0f49663fb63332596e2e6327009d581',1,'nc']]], - ['uint64_2317',['uint64',['../namespacenc.html#a773f8535ba713f886e9e1b8378f6d76d',1,'nc']]], - ['uint8_2318',['uint8',['../namespacenc.html#a9ba5a0aa26753a185985b8273fb9062d',1,'nc']]] + ['uint16_2417',['uint16',['../namespacenc.html#a8146518cf6c6a8029c3d84a376167793',1,'nc']]], + ['uint32_2418',['uint32',['../namespacenc.html#af0f49663fb63332596e2e6327009d581',1,'nc']]], + ['uint64_2419',['uint64',['../namespacenc.html#a773f8535ba713f886e9e1b8378f6d76d',1,'nc']]], + ['uint8_2420',['uint8',['../namespacenc.html#a9ba5a0aa26753a185985b8273fb9062d',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/typedefs_a.html b/docs/doxygen/html/search/typedefs_a.html index 3e904e453..bb6ac2a82 100644 --- a/docs/doxygen/html/search/typedefs_a.html +++ b/docs/doxygen/html/search/typedefs_a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/typedefs_a.js b/docs/doxygen/html/search/typedefs_a.js index 26fbcf17d..f30ef019f 100644 --- a/docs/doxygen/html/search/typedefs_a.js +++ b/docs/doxygen/html/search/typedefs_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['value_5ftype_2319',['value_type',['../classnc_1_1_nd_array.html#aed76b0d590eff875e09a6f0d7968e7db',1,'nc::NdArray::value_type()'],['../classnc_1_1_nd_array_const_iterator.html#af4d3be6b1470162a26b34cdaa5a2addd',1,'nc::NdArrayConstIterator::value_type()'],['../classnc_1_1_nd_array_iterator.html#adeb90525f10a8bf2748dafbb2ea154dc',1,'nc::NdArrayIterator::value_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3b124e1120c2fb329dcb5d81abe39e1d',1,'nc::NdArrayConstColumnIterator::value_type()'],['../classnc_1_1_nd_array_column_iterator.html#a7191b7c13b188f2a0abaf8477f0bd2d4',1,'nc::NdArrayColumnIterator::value_type()']]] + ['value_5ftype_2421',['value_type',['../classnc_1_1_nd_array.html#aed76b0d590eff875e09a6f0d7968e7db',1,'nc::NdArray::value_type()'],['../classnc_1_1_nd_array_const_iterator.html#af4d3be6b1470162a26b34cdaa5a2addd',1,'nc::NdArrayConstIterator::value_type()'],['../classnc_1_1_nd_array_iterator.html#adeb90525f10a8bf2748dafbb2ea154dc',1,'nc::NdArrayIterator::value_type()'],['../classnc_1_1_nd_array_const_column_iterator.html#a3b124e1120c2fb329dcb5d81abe39e1d',1,'nc::NdArrayConstColumnIterator::value_type()'],['../classnc_1_1_nd_array_column_iterator.html#a7191b7c13b188f2a0abaf8477f0bd2d4',1,'nc::NdArrayColumnIterator::value_type()']]] ]; diff --git a/docs/doxygen/html/search/variables_0.html b/docs/doxygen/html/search/variables_0.html index 67493c603..1e477c08c 100644 --- a/docs/doxygen/html/search/variables_0.html +++ b/docs/doxygen/html/search/variables_0.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_0.js b/docs/doxygen/html/search/variables_0.js index 015ff738d..6ad8c6850 100644 --- a/docs/doxygen/html/search/variables_0.js +++ b/docs/doxygen/html/search/variables_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['all_5farithmetic_5fv_2250',['all_arithmetic_v',['../namespacenc.html#a0b7796ffd2609d1e093207d8546e091a',1,'nc']]], - ['all_5fsame_5fv_2251',['all_same_v',['../namespacenc.html#ad3769ded44b203686d0a33dd6623e142',1,'nc']]] + ['all_5farithmetic_5fv_2351',['all_arithmetic_v',['../namespacenc.html#a0b7796ffd2609d1e093207d8546e091a',1,'nc']]], + ['all_5fsame_5fv_2352',['all_same_v',['../namespacenc.html#ad3769ded44b203686d0a33dd6623e142',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/variables_1.html b/docs/doxygen/html/search/variables_1.html index 44416bd1d..ea73d9a49 100644 --- a/docs/doxygen/html/search/variables_1.html +++ b/docs/doxygen/html/search/variables_1.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_1.js b/docs/doxygen/html/search/variables_1.js index 6b0613346..ed35ffb57 100644 --- a/docs/doxygen/html/search/variables_1.js +++ b/docs/doxygen/html/search/variables_1.js @@ -1,7 +1,7 @@ var searchData= [ - ['c_2252',['c',['../namespacenc_1_1constants.html#ac3fc62713ed109e451648c67faab7581',1,'nc::constants']]], - ['clusterid_2253',['clusterId',['../classnc_1_1image_processing_1_1_pixel.html#ac22936e8b5b80a1c557faaf9722b3183',1,'nc::imageProcessing::Pixel']]], - ['col_2254',['col',['../classnc_1_1image_processing_1_1_pixel.html#a6749c7a5513e2b7ee5c027aef104b269',1,'nc::imageProcessing::Pixel']]], - ['cols_2255',['cols',['../classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d',1,'nc::Shape']]] + ['c_2353',['c',['../namespacenc_1_1constants.html#ac3fc62713ed109e451648c67faab7581',1,'nc::constants']]], + ['clusterid_2354',['clusterId',['../classnc_1_1image_processing_1_1_pixel.html#ac22936e8b5b80a1c557faaf9722b3183',1,'nc::imageProcessing::Pixel']]], + ['col_2355',['col',['../classnc_1_1image_processing_1_1_pixel.html#a6749c7a5513e2b7ee5c027aef104b269',1,'nc::imageProcessing::Pixel']]], + ['cols_2356',['cols',['../classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d',1,'nc::Shape']]] ]; diff --git a/docs/doxygen/html/search/variables_10.html b/docs/doxygen/html/search/variables_10.html index 719e57837..dc9920b6d 100644 --- a/docs/doxygen/html/search/variables_10.html +++ b/docs/doxygen/html/search/variables_10.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_10.js b/docs/doxygen/html/search/variables_10.js index b27b1e700..4d93beaaf 100644 --- a/docs/doxygen/html/search/variables_10.js +++ b/docs/doxygen/html/search/variables_10.js @@ -1,4 +1,4 @@ var searchData= [ - ['z_2291',['z',['../classnc_1_1_vec3.html#a0896ee691f46ce0bd669b869fe6acb41',1,'nc::Vec3']]] + ['z_2393',['z',['../classnc_1_1_vec3.html#a0896ee691f46ce0bd669b869fe6acb41',1,'nc::Vec3']]] ]; diff --git a/docs/doxygen/html/search/variables_2.html b/docs/doxygen/html/search/variables_2.html index 117be3aec..0580462e9 100644 --- a/docs/doxygen/html/search/variables_2.html +++ b/docs/doxygen/html/search/variables_2.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_2.js b/docs/doxygen/html/search/variables_2.js index 6f3070d70..85d9d6870 100644 --- a/docs/doxygen/html/search/variables_2.js +++ b/docs/doxygen/html/search/variables_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['days_5fper_5fweek_2256',['DAYS_PER_WEEK',['../namespacenc_1_1constants.html#a2c11c386e1a07a17f95122fc4630cbe9',1,'nc::constants']]] + ['days_5fper_5fweek_2357',['DAYS_PER_WEEK',['../namespacenc_1_1constants.html#a2c11c386e1a07a17f95122fc4630cbe9',1,'nc::constants']]] ]; diff --git a/docs/doxygen/html/search/variables_3.html b/docs/doxygen/html/search/variables_3.html index c583cd67d..0d69e7619 100644 --- a/docs/doxygen/html/search/variables_3.html +++ b/docs/doxygen/html/search/variables_3.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_3.js b/docs/doxygen/html/search/variables_3.js index cc5a03510..9de226180 100644 --- a/docs/doxygen/html/search/variables_3.js +++ b/docs/doxygen/html/search/variables_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['e_2257',['e',['../namespacenc_1_1constants.html#aebabe96d6c2be3df3d71922b399e24c7',1,'nc::constants']]], - ['epsilon_5f_2258',['epsilon_',['../classnc_1_1roots_1_1_iteration.html#a5eafe219bb90f82da4ece84f012a411a',1,'nc::roots::Iteration']]] + ['e_2358',['e',['../namespacenc_1_1constants.html#aebabe96d6c2be3df3d71922b399e24c7',1,'nc::constants']]], + ['epsilon_5f_2359',['epsilon_',['../classnc_1_1roots_1_1_iteration.html#a5eafe219bb90f82da4ece84f012a411a',1,'nc::roots::Iteration']]] ]; diff --git a/docs/doxygen/html/search/variables_4.html b/docs/doxygen/html/search/variables_4.html index c78c42f2b..a4b6506bb 100644 --- a/docs/doxygen/html/search/variables_4.html +++ b/docs/doxygen/html/search/variables_4.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_4.js b/docs/doxygen/html/search/variables_4.js index f7013b19b..d4ac1d60a 100644 --- a/docs/doxygen/html/search/variables_4.js +++ b/docs/doxygen/html/search/variables_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['generator_5f_2259',['generator_',['../namespacenc_1_1random.html#aa541047e6b742f1c5251e72f3b7aec95',1,'nc::random']]] + ['generator_5f_2360',['generator_',['../namespacenc_1_1random.html#aa541047e6b742f1c5251e72f3b7aec95',1,'nc::random']]], + ['greaterthan_5fv_2361',['greaterThan_v',['../namespacenc.html#a4cdb8bc70afcd7483d200f235181471c',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/variables_5.html b/docs/doxygen/html/search/variables_5.html index 2fc8b5efa..7e345d16c 100644 --- a/docs/doxygen/html/search/variables_5.html +++ b/docs/doxygen/html/search/variables_5.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_5.js b/docs/doxygen/html/search/variables_5.js index c297adbb1..384244540 100644 --- a/docs/doxygen/html/search/variables_5.js +++ b/docs/doxygen/html/search/variables_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['hours_5fper_5fday_2260',['HOURS_PER_DAY',['../namespacenc_1_1constants.html#aef903b1f40001bc712b61f5dec7de716',1,'nc::constants']]] + ['hours_5fper_5fday_2362',['HOURS_PER_DAY',['../namespacenc_1_1constants.html#aef903b1f40001bc712b61f5dec7de716',1,'nc::constants']]] ]; diff --git a/docs/doxygen/html/search/variables_6.html b/docs/doxygen/html/search/variables_6.html index d47102084..7d48e75e2 100644 --- a/docs/doxygen/html/search/variables_6.html +++ b/docs/doxygen/html/search/variables_6.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_6.js b/docs/doxygen/html/search/variables_6.js index 33476e553..66b84bbd7 100644 --- a/docs/doxygen/html/search/variables_6.js +++ b/docs/doxygen/html/search/variables_6.js @@ -1,11 +1,11 @@ var searchData= [ - ['inf_2261',['inf',['../namespacenc_1_1constants.html#a4649bfc00f6360ccda3b3f9316e2dc0e',1,'nc::constants']]], - ['intensity_2262',['intensity',['../classnc_1_1image_processing_1_1_pixel.html#a2ffea8fff18945da4971ab4c847a49bd',1,'nc::imageProcessing::Pixel']]], - ['is_5farithmetic_5fv_2263',['is_arithmetic_v',['../namespacenc.html#ad5ef02185c876c1c30e12824c3b9aba5',1,'nc']]], - ['is_5fcomplex_5fv_2264',['is_complex_v',['../namespacenc.html#af8be3598b0e2894429842d64d3ce4050',1,'nc']]], - ['is_5ffloating_5fpoint_5fv_2265',['is_floating_point_v',['../namespacenc.html#a33d8e465a48ee094f340d8a5bab416bd',1,'nc']]], - ['is_5fintegral_5fv_2266',['is_integral_v',['../namespacenc.html#a157cdac039a66a88d2aa922781d060f6',1,'nc']]], - ['is_5fsame_5fv_2267',['is_same_v',['../namespacenc.html#a04829dab261829c5ee2570febfa287eb',1,'nc']]], - ['is_5fvalid_5fdtype_5fv_2268',['is_valid_dtype_v',['../namespacenc.html#aae4eab83016ec7dcaa7d78b6d1e78481',1,'nc']]] + ['inf_2363',['inf',['../namespacenc_1_1constants.html#a4649bfc00f6360ccda3b3f9316e2dc0e',1,'nc::constants']]], + ['intensity_2364',['intensity',['../classnc_1_1image_processing_1_1_pixel.html#a2ffea8fff18945da4971ab4c847a49bd',1,'nc::imageProcessing::Pixel']]], + ['is_5farithmetic_5fv_2365',['is_arithmetic_v',['../namespacenc.html#ad5ef02185c876c1c30e12824c3b9aba5',1,'nc']]], + ['is_5fcomplex_5fv_2366',['is_complex_v',['../namespacenc.html#af8be3598b0e2894429842d64d3ce4050',1,'nc']]], + ['is_5ffloating_5fpoint_5fv_2367',['is_floating_point_v',['../namespacenc.html#a33d8e465a48ee094f340d8a5bab416bd',1,'nc']]], + ['is_5fintegral_5fv_2368',['is_integral_v',['../namespacenc.html#a157cdac039a66a88d2aa922781d060f6',1,'nc']]], + ['is_5fsame_5fv_2369',['is_same_v',['../namespacenc.html#a04829dab261829c5ee2570febfa287eb',1,'nc']]], + ['is_5fvalid_5fdtype_5fv_2370',['is_valid_dtype_v',['../namespacenc.html#aae4eab83016ec7dcaa7d78b6d1e78481',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/variables_7.html b/docs/doxygen/html/search/variables_7.html index e6f8bf8cb..5c2634092 100644 --- a/docs/doxygen/html/search/variables_7.html +++ b/docs/doxygen/html/search/variables_7.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_7.js b/docs/doxygen/html/search/variables_7.js index 66099500b..d5f787fe0 100644 --- a/docs/doxygen/html/search/variables_7.js +++ b/docs/doxygen/html/search/variables_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['j_2269',['j',['../namespacenc_1_1constants.html#a0e933571f05ee6af915fc327260517e9',1,'nc::constants']]] + ['j_2371',['j',['../namespacenc_1_1constants.html#a0e933571f05ee6af915fc327260517e9',1,'nc::constants']]] ]; diff --git a/docs/doxygen/html/search/variables_8.html b/docs/doxygen/html/search/variables_8.html index 3b3de0a50..dc9ec54a5 100644 --- a/docs/doxygen/html/search/variables_8.html +++ b/docs/doxygen/html/search/variables_8.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_8.js b/docs/doxygen/html/search/variables_8.js index 714a189c5..b54ab571e 100644 --- a/docs/doxygen/html/search/variables_8.js +++ b/docs/doxygen/html/search/variables_8.js @@ -1,8 +1,8 @@ var searchData= [ - ['maxnumiterations_5f_2270',['maxNumIterations_',['../classnc_1_1roots_1_1_iteration.html#a9b1c4ea8cf91c5308020c105293b4a02',1,'nc::roots::Iteration']]], - ['milliseconds_5fper_5fday_2271',['MILLISECONDS_PER_DAY',['../namespacenc_1_1constants.html#a2838aa56f95be8020a326aa6b9ba5c68',1,'nc::constants']]], - ['milliseconds_5fper_5fsecond_2272',['MILLISECONDS_PER_SECOND',['../namespacenc_1_1constants.html#a4373df6d6df75334290f4240f174aeb0',1,'nc::constants']]], - ['minutes_5fper_5fday_2273',['MINUTES_PER_DAY',['../namespacenc_1_1constants.html#aa018ab3bca299694899f51683d5b3c0f',1,'nc::constants']]], - ['minutes_5fper_5fhour_2274',['MINUTES_PER_HOUR',['../namespacenc_1_1constants.html#a84dfb71171d2a19b89afea89be57bc52',1,'nc::constants']]] + ['maxnumiterations_5f_2372',['maxNumIterations_',['../classnc_1_1roots_1_1_iteration.html#a9b1c4ea8cf91c5308020c105293b4a02',1,'nc::roots::Iteration']]], + ['milliseconds_5fper_5fday_2373',['MILLISECONDS_PER_DAY',['../namespacenc_1_1constants.html#a2838aa56f95be8020a326aa6b9ba5c68',1,'nc::constants']]], + ['milliseconds_5fper_5fsecond_2374',['MILLISECONDS_PER_SECOND',['../namespacenc_1_1constants.html#a4373df6d6df75334290f4240f174aeb0',1,'nc::constants']]], + ['minutes_5fper_5fday_2375',['MINUTES_PER_DAY',['../namespacenc_1_1constants.html#aa018ab3bca299694899f51683d5b3c0f',1,'nc::constants']]], + ['minutes_5fper_5fhour_2376',['MINUTES_PER_HOUR',['../namespacenc_1_1constants.html#a84dfb71171d2a19b89afea89be57bc52',1,'nc::constants']]] ]; diff --git a/docs/doxygen/html/search/variables_9.html b/docs/doxygen/html/search/variables_9.html index 803220a03..7b0147509 100644 --- a/docs/doxygen/html/search/variables_9.html +++ b/docs/doxygen/html/search/variables_9.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_9.js b/docs/doxygen/html/search/variables_9.js index 4e1d500a6..4ed1a7200 100644 --- a/docs/doxygen/html/search/variables_9.js +++ b/docs/doxygen/html/search/variables_9.js @@ -1,5 +1,5 @@ var searchData= [ - ['nan_2275',['nan',['../namespacenc_1_1constants.html#af94758715a9a5157d7ca95ab89d390ac',1,'nc::constants']]], - ['numiterations_5f_2276',['numIterations_',['../classnc_1_1roots_1_1_iteration.html#a84d7f2f7412d1f54861edeacc7bc0c20',1,'nc::roots::Iteration']]] + ['nan_2377',['nan',['../namespacenc_1_1constants.html#af94758715a9a5157d7ca95ab89d390ac',1,'nc::constants']]], + ['numiterations_5f_2378',['numIterations_',['../classnc_1_1roots_1_1_iteration.html#a84d7f2f7412d1f54861edeacc7bc0c20',1,'nc::roots::Iteration']]] ]; diff --git a/docs/doxygen/html/search/variables_a.html b/docs/doxygen/html/search/variables_a.html index 0f55e75b5..52a724d19 100644 --- a/docs/doxygen/html/search/variables_a.html +++ b/docs/doxygen/html/search/variables_a.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_a.js b/docs/doxygen/html/search/variables_a.js index 5fc649c09..72eb901ca 100644 --- a/docs/doxygen/html/search/variables_a.js +++ b/docs/doxygen/html/search/variables_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['pi_2277',['pi',['../namespacenc_1_1constants.html#a2f1219a120c9cc1434486d9de75a8221',1,'nc::constants']]] + ['pi_2379',['pi',['../namespacenc_1_1constants.html#a2f1219a120c9cc1434486d9de75a8221',1,'nc::constants']]] ]; diff --git a/docs/doxygen/html/search/variables_b.html b/docs/doxygen/html/search/variables_b.html index 44d030c83..f376b27af 100644 --- a/docs/doxygen/html/search/variables_b.html +++ b/docs/doxygen/html/search/variables_b.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_b.js b/docs/doxygen/html/search/variables_b.js index 511b8cc32..6c0f7fa19 100644 --- a/docs/doxygen/html/search/variables_b.js +++ b/docs/doxygen/html/search/variables_b.js @@ -1,5 +1,5 @@ var searchData= [ - ['row_2278',['row',['../classnc_1_1image_processing_1_1_pixel.html#a6e712ef3b6547f5cafb6e8db1349658e',1,'nc::imageProcessing::Pixel']]], - ['rows_2279',['rows',['../classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a',1,'nc::Shape']]] + ['row_2380',['row',['../classnc_1_1image_processing_1_1_pixel.html#a6e712ef3b6547f5cafb6e8db1349658e',1,'nc::imageProcessing::Pixel']]], + ['rows_2381',['rows',['../classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a',1,'nc::Shape']]] ]; diff --git a/docs/doxygen/html/search/variables_c.html b/docs/doxygen/html/search/variables_c.html index aa86a08b1..6019eba96 100644 --- a/docs/doxygen/html/search/variables_c.html +++ b/docs/doxygen/html/search/variables_c.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_c.js b/docs/doxygen/html/search/variables_c.js index 3d1a333c6..99d436226 100644 --- a/docs/doxygen/html/search/variables_c.js +++ b/docs/doxygen/html/search/variables_c.js @@ -1,10 +1,10 @@ var searchData= [ - ['seconds_5fper_5fday_2280',['SECONDS_PER_DAY',['../namespacenc_1_1constants.html#a766ec3bf1f6fb57f586f943cea1946c3',1,'nc::constants']]], - ['seconds_5fper_5fhour_2281',['SECONDS_PER_HOUR',['../namespacenc_1_1constants.html#ad635a54557e853e1ee098d0ead5f1902',1,'nc::constants']]], - ['seconds_5fper_5fminute_2282',['SECONDS_PER_MINUTE',['../namespacenc_1_1constants.html#ad89620cbdf9102f40ec7c0fd52c16a5e',1,'nc::constants']]], - ['seconds_5fper_5fweek_2283',['SECONDS_PER_WEEK',['../namespacenc_1_1constants.html#ac36cac5f19ce5f81b2acc562f247f0be',1,'nc::constants']]], - ['start_2284',['start',['../classnc_1_1_slice.html#a36ddb261d9057db4a9794b4fc46e9d3f',1,'nc::Slice']]], - ['step_2285',['step',['../classnc_1_1_slice.html#a112855a11aa1737b7859e3d63feb09c4',1,'nc::Slice']]], - ['stop_2286',['stop',['../classnc_1_1_slice.html#ac2d72f4ca003ed645bc82efcafee87f5',1,'nc::Slice']]] + ['seconds_5fper_5fday_2382',['SECONDS_PER_DAY',['../namespacenc_1_1constants.html#a766ec3bf1f6fb57f586f943cea1946c3',1,'nc::constants']]], + ['seconds_5fper_5fhour_2383',['SECONDS_PER_HOUR',['../namespacenc_1_1constants.html#ad635a54557e853e1ee098d0ead5f1902',1,'nc::constants']]], + ['seconds_5fper_5fminute_2384',['SECONDS_PER_MINUTE',['../namespacenc_1_1constants.html#ad89620cbdf9102f40ec7c0fd52c16a5e',1,'nc::constants']]], + ['seconds_5fper_5fweek_2385',['SECONDS_PER_WEEK',['../namespacenc_1_1constants.html#ac36cac5f19ce5f81b2acc562f247f0be',1,'nc::constants']]], + ['start_2386',['start',['../classnc_1_1_slice.html#a36ddb261d9057db4a9794b4fc46e9d3f',1,'nc::Slice']]], + ['step_2387',['step',['../classnc_1_1_slice.html#a112855a11aa1737b7859e3d63feb09c4',1,'nc::Slice']]], + ['stop_2388',['stop',['../classnc_1_1_slice.html#ac2d72f4ca003ed645bc82efcafee87f5',1,'nc::Slice']]] ]; diff --git a/docs/doxygen/html/search/variables_d.html b/docs/doxygen/html/search/variables_d.html index 17d25e040..f61ae7511 100644 --- a/docs/doxygen/html/search/variables_d.html +++ b/docs/doxygen/html/search/variables_d.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_d.js b/docs/doxygen/html/search/variables_d.js index b974c1215..fcf28212a 100644 --- a/docs/doxygen/html/search/variables_d.js +++ b/docs/doxygen/html/search/variables_d.js @@ -1,5 +1,5 @@ var searchData= [ - ['value_2287',['value',['../structnc_1_1all__arithmetic_3_01_head_00_01_tail_8_8_8_01_4.html#a6e1a48ad3dc95bb666261cd0e3503f5c',1,'nc::all_arithmetic< Head, Tail... >::value()'],['../structnc_1_1all__arithmetic_3_01_t_01_4.html#aeb8a99e0539f9d4d01b6ac63dfe6c186',1,'nc::all_arithmetic< T >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_head_00_01_tail_8_8_8_01_4.html#a35efae6bdf247952d31021b7e811a653',1,'nc::all_same< T1, Head, Tail... >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_t2_01_4.html#a02b49e4936f586c2407c089400ee891f',1,'nc::all_same< T1, T2 >::value()'],['../structnc_1_1is__valid__dtype.html#af383f42b2b624cc161c1748b98cc541e',1,'nc::is_valid_dtype::value()'],['../structnc_1_1is__complex.html#a273a78ae8b41cf81e633f259204ce5dd',1,'nc::is_complex::value()'],['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html#add526ed6ceb3045a816385e5c2c6d553',1,'nc::is_complex< std::complex< T > >::value()']]], - ['version_2288',['VERSION',['../namespacenc.html#a8fa2b5de82ba40f346d1ba1e3ad0397a',1,'nc']]] + ['value_2389',['value',['../structnc_1_1all__arithmetic_3_01_head_00_01_tail_8_8_8_01_4.html#a6e1a48ad3dc95bb666261cd0e3503f5c',1,'nc::all_arithmetic< Head, Tail... >::value()'],['../structnc_1_1all__arithmetic_3_01_t_01_4.html#aeb8a99e0539f9d4d01b6ac63dfe6c186',1,'nc::all_arithmetic< T >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_head_00_01_tail_8_8_8_01_4.html#a35efae6bdf247952d31021b7e811a653',1,'nc::all_same< T1, Head, Tail... >::value()'],['../structnc_1_1all__same_3_01_t1_00_01_t2_01_4.html#a02b49e4936f586c2407c089400ee891f',1,'nc::all_same< T1, T2 >::value()'],['../structnc_1_1is__valid__dtype.html#af383f42b2b624cc161c1748b98cc541e',1,'nc::is_valid_dtype::value()'],['../structnc_1_1is__complex.html#a273a78ae8b41cf81e633f259204ce5dd',1,'nc::is_complex::value()'],['../structnc_1_1is__complex_3_01std_1_1complex_3_01_t_01_4_01_4.html#add526ed6ceb3045a816385e5c2c6d553',1,'nc::is_complex< std::complex< T > >::value()'],['../structnc_1_1greater_than.html#a6664c509bb1b73d1547aeffa4ea2afec',1,'nc::greaterThan::value()']]], + ['version_2390',['VERSION',['../namespacenc.html#a8fa2b5de82ba40f346d1ba1e3ad0397a',1,'nc']]] ]; diff --git a/docs/doxygen/html/search/variables_e.html b/docs/doxygen/html/search/variables_e.html index 0b5f5700f..7bfd37215 100644 --- a/docs/doxygen/html/search/variables_e.html +++ b/docs/doxygen/html/search/variables_e.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_e.js b/docs/doxygen/html/search/variables_e.js index b9ef18eea..eb6afdefd 100644 --- a/docs/doxygen/html/search/variables_e.js +++ b/docs/doxygen/html/search/variables_e.js @@ -1,4 +1,4 @@ var searchData= [ - ['x_2289',['x',['../classnc_1_1_vec2.html#a36a67b9395b397e1b8e9364a39a5c458',1,'nc::Vec2::x()'],['../classnc_1_1_vec3.html#a7f71dd08d58a1327739de6041e3362bb',1,'nc::Vec3::x()']]] + ['x_2391',['x',['../classnc_1_1_vec2.html#a36a67b9395b397e1b8e9364a39a5c458',1,'nc::Vec2::x()'],['../classnc_1_1_vec3.html#a7f71dd08d58a1327739de6041e3362bb',1,'nc::Vec3::x()']]] ]; diff --git a/docs/doxygen/html/search/variables_f.html b/docs/doxygen/html/search/variables_f.html index e034bd28f..d97920d08 100644 --- a/docs/doxygen/html/search/variables_f.html +++ b/docs/doxygen/html/search/variables_f.html @@ -2,7 +2,7 @@ - + diff --git a/docs/doxygen/html/search/variables_f.js b/docs/doxygen/html/search/variables_f.js index f02508e1a..b733678d0 100644 --- a/docs/doxygen/html/search/variables_f.js +++ b/docs/doxygen/html/search/variables_f.js @@ -1,4 +1,4 @@ var searchData= [ - ['y_2290',['y',['../classnc_1_1_vec2.html#ad7a5bc1612f92f7e49112cf58caeaace',1,'nc::Vec2::y()'],['../classnc_1_1_vec3.html#a969dd1c195f4c78fc3a93292391e29c1',1,'nc::Vec3::y()']]] + ['y_2392',['y',['../classnc_1_1_vec2.html#ad7a5bc1612f92f7e49112cf58caeaace',1,'nc::Vec2::y()'],['../classnc_1_1_vec3.html#a969dd1c195f4c78fc3a93292391e29c1',1,'nc::Vec3::y()']]] ]; diff --git a/docs/doxygen/html/select_8hpp.html b/docs/doxygen/html/select_8hpp.html new file mode 100644 index 000000000..e03a7d7d9 --- /dev/null +++ b/docs/doxygen/html/select_8hpp.html @@ -0,0 +1,136 @@ + + + + + + + +NumCpp: select.hpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Namespaces | +Functions
+
+
select.hpp File Reference
+
+
+
#include "NumCpp/NdArray.hpp"
+#include "NumCpp/Core/Shape.hpp"
+#include "NumCpp/Core/Internal/Error.hpp"
+#include <cstdlib>
+#include <initializer_list>
+#include <limits>
+#include <vector>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 nc
 
+ + + + + + + +

+Functions

template<typename dtype >
NdArray< dtype > nc::select (const std::vector< const NdArray< bool > * > &condVec, const std::vector< const NdArray< dtype > * > &choiceVec, dtype defaultValue=dtype{0})
 
template<typename dtype >
NdArray< dtype > nc::select (const std::vector< NdArray< bool >> &condList, const std::vector< NdArray< dtype >> &choiceList, dtype defaultValue=dtype{0})
 
+

Detailed Description

+
Author
David Pilger dpilg.nosp@m.er26.nosp@m.@gmai.nosp@m.l.co.nosp@m.m GitHub Repository
+

License Copyright 2018-2022 David Pilger

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+

Description Functions for working with NdArrays

+
+
+ + + + diff --git a/docs/doxygen/html/select_8hpp.js b/docs/doxygen/html/select_8hpp.js new file mode 100644 index 000000000..6e78178d3 --- /dev/null +++ b/docs/doxygen/html/select_8hpp.js @@ -0,0 +1,5 @@ +var select_8hpp = +[ + [ "select", "select_8hpp.html#aab95eb9e265a3daf251b7e1926a42dac", null ], + [ "select", "select_8hpp.html#acbb2b67807944a713b19844d2fe3dcc6", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/select_8hpp_source.html b/docs/doxygen/html/select_8hpp_source.html new file mode 100644 index 000000000..8128db6f9 --- /dev/null +++ b/docs/doxygen/html/select_8hpp_source.html @@ -0,0 +1,216 @@ + + + + + + + +NumCpp: select.hpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
select.hpp
+
+
+Go to the documentation of this file.
1 #pragma once
+
29 
+
30 #include "NumCpp/NdArray.hpp"
+
31 #include "NumCpp/Core/Shape.hpp"
+
32 #include "NumCpp/Core/Internal/Error.hpp"
+
33 
+
34 #include <cstdlib>
+
35 #include <initializer_list>
+
36 #include <limits>
+
37 #include <vector>
+
38 
+
39 namespace nc
+
40 {
+
41  //============================================================================
+
42  // Method Description:
+
55  template<typename dtype>
+
56  NdArray<dtype> select(const std::vector<const NdArray<bool>*>& condVec,
+
57  const std::vector<const NdArray<dtype>*>& choiceVec, dtype defaultValue = dtype{0})
+
58  {
+
59  if (choiceVec.size() != condVec.size())
+
60  {
+
61  THROW_INVALID_ARGUMENT_ERROR("condVec and choiceVec need to be the same size");
+
62  }
+
63 
+
64  if (choiceVec.size() == 0)
+
65  {
+
66  THROW_INVALID_ARGUMENT_ERROR("choiceVec is size 0");
+
67  }
+
68 
+
69  auto theShape = condVec.front()->shape();
+
70  for (const auto cond : condVec)
+
71  {
+
72  const auto& theCond = *cond;
+
73  if (theCond.shape() != theShape)
+
74  {
+
75  THROW_INVALID_ARGUMENT_ERROR("all NdArrays of the condVec must be the same shape");
+
76  }
+
77  }
+
78 
+
79  for (const auto choice : choiceVec)
+
80  {
+
81  const auto& theChoice = *choice;
+
82  if (theChoice.shape() != theShape)
+
83  {
+
84  THROW_INVALID_ARGUMENT_ERROR("all NdArrays of the choiceVec must be the same shape, and the same as condVec");
+
85  }
+
86  }
+
87 
+
88  using size_type = typename NdArray<dtype>::size_type;
+
89  constexpr auto nullChoice = std::numeric_limits<size_type>::max();
+
90 
+
91  NdArray<size_type> choiceIndices(theShape);
+
92  choiceIndices.fill(nullChoice);
+
93  for (size_type condIdx = 0; condIdx < condVec.size(); ++condIdx)
+
94  {
+
95  const auto& theCond = *condVec[condIdx];
+
96  for (size_type i = 0; i < theCond.size(); ++i)
+
97  {
+
98  if (theCond[i] && choiceIndices[i] == nullChoice)
+
99  {
+
100  choiceIndices[i] = condIdx;
+
101  }
+
102  }
+
103  }
+
104 
+
105  NdArray<dtype> result(theShape);
+
106  result.fill(defaultValue);
+
107  for (size_type i = 0; i < choiceIndices.size(); ++i)
+
108  {
+
109  const auto choiceIndex = choiceIndices[i];
+
110  if (choiceIndex != nullChoice)
+
111  {
+
112  const auto& theChoice = *choiceVec[choiceIndex];
+
113  result[i] = theChoice[i];
+
114  }
+
115  }
+
116 
+
117  return result;
+
118  }
+
119 
+
120  //============================================================================
+
121  // Method Description:
+
134  template<typename dtype>
+
135  NdArray<dtype> select(const std::vector<NdArray<bool>>& condList,
+
136  const std::vector<NdArray<dtype>>& choiceList,
+
137  dtype defaultValue = dtype{0})
+
138  {
+
139  std::vector<const NdArray<bool>*> condVec;
+
140  condVec.reserve(condList.size());
+
141  for (auto& cond : condList)
+
142  {
+
143  condVec.push_back(&cond);
+
144  }
+
145 
+
146  std::vector<const NdArray<dtype>*> choiceVec;
+
147  choiceVec.reserve(choiceList.size());
+
148  for (auto& choice : choiceList)
+
149  {
+
150  choiceVec.push_back(&choice);
+
151  }
+
152 
+
153  return select(condVec, choiceVec, defaultValue);
+
154  }
+
155 } // namespace nc
+ + +
THROW_INVALID_ARGUMENT_ERROR
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:36
+ +
nc::NdArray
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:72
+
nc::NdArray::size_type
uint32 size_type
Definition: NdArrayCore.hpp:87
+
nc::random::choice
dtype choice(const NdArray< dtype > &inArray)
Definition: choice.hpp:51
+
nc
Definition: Coordinate.hpp:45
+
nc::max
NdArray< dtype > max(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: max.hpp:44
+
nc::select
NdArray< dtype > select(const std::vector< const NdArray< bool > * > &condVec, const std::vector< const NdArray< dtype > * > &choiceVec, dtype defaultValue=dtype{0})
Definition: select.hpp:56
+
+
+ + + + diff --git a/docs/doxygen/html/setdiff1d_8hpp.html b/docs/doxygen/html/setdiff1d_8hpp.html index ee6fb6fdd..f310640f9 100644 --- a/docs/doxygen/html/setdiff1d_8hpp.html +++ b/docs/doxygen/html/setdiff1d_8hpp.html @@ -3,7 +3,7 @@ - + NumCpp: setdiff1d.hpp File Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - + + + + + + + + + + + + + +
+
+ + + + + + + +
+
NumCpp +  2.7.0 +
+
A Templatized Header Only C++ Implementation of the Python NumPy Library
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Static Public Attributes
+
+
nc::greaterThan< Value1, Value2 > Struct Template Reference
+
+
+ +

#include <TypeTraits.hpp>

+ + + + +

+Static Public Attributes

static constexpr bool value = Value1 > Value2
 
+

Detailed Description

+

template<std::size_t Value1, std::size_t Value2>
+struct nc::greaterThan< Value1, Value2 >

+ +

type trait to test if one value is larger than another at compile time

+

Field Documentation

+ +

◆ value

+ +
+
+
+template<std::size_t Value1, std::size_t Value2>
+ + + + + +
+ + + + +
constexpr bool nc::greaterThan< Value1, Value2 >::value = Value1 > Value2
+ 		+staticconstexpr
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/docs/doxygen/html/structnc_1_1greater_than.js b/docs/doxygen/html/structnc_1_1greater_than.js new file mode 100644 index 000000000..dbb6a3aeb --- /dev/null +++ b/docs/doxygen/html/structnc_1_1greater_than.js @@ -0,0 +1,4 @@ +var structnc_1_1greater_than = +[ + [ "value", "structnc_1_1greater_than.html#a6664c509bb1b73d1547aeffa4ea2afec", null ] +]; \ No newline at end of file diff --git a/docs/doxygen/html/structnc_1_1is__complex.html b/docs/doxygen/html/structnc_1_1is__complex.html index 4b80fe4b4..15e3a05c8 100644 --- a/docs/doxygen/html/structnc_1_1is__complex.html +++ b/docs/doxygen/html/structnc_1_1is__complex.html @@ -3,7 +3,7 @@ - + NumCpp: nc::is_complex< T > Struct Template Reference @@ -28,7 +28,7 @@ Logo
NumCpp -  2.6.2 +  2.7.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
@@ -37,7 +37,7 @@ - +