Merge branch 'main' into multichannel_econd_fix

Author: andpet1324

CMakeLists.txt

@@ -73,6 +73,8 @@ add_library(utility SHARED
   src/pflib/utility/str_to_int.cxx
   src/pflib/utility/median.cxx
   src/pflib/utility/efficiency.cxx
+  src/pflib/utility/mean.cxx
+  src/pflib/utility/stdev.cxx
 )
 target_include_directories(utility PUBLIC 
   "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>"

include/pflib/utility/mean.h

@@ -0,0 +1,23 @@
+#pragma once
+
+#include <vector>
+
+namespace pflib::utility {
+
+/**
+ * find the mean of the input vector of samples
+ *
+ * @param[in] samples list of samples to find mean of
+ * @return mean of the samples
+ */
+double mean(const std::vector<int>& samples);
+
+/**
+ * find the mean of the input vector of samples
+ *
+ * @param[in] samples list of samples to find mean of
+ * @return mean of the samples
+ */
+double mean(const std::vector<double>& samples);
+
+}  // namespace pflib::utility

include/pflib/utility/stdev.h

@@ -0,0 +1,27 @@
+#pragma once
+
+#include <vector>
+
+namespace pflib::utility {
+
+/**
+ * find the stdev of the input vector of samples
+ *
+ * @param[in] samples list of samples to find stdev of
+ * @return stdev of the samples
+ *
+ * Method based on the method used by numpy.std. See numpy.std documentation.
+ */
+double stdev(const std::vector<int>& samples);
+
+/**
+ * find the stdev of the input vector of samples
+ *
+ * @param[in] samples list of samples to find stdev of
+ * @return stdev of the samples
+ *
+ * Method based on the method used by numpy.std. See numpy.std documentation.
+ */
+double stdev(const std::vector<double>& samples);
+
+}  // namespace pflib::utility

src/pflib/utility/mean.cxx

@@ -0,0 +1,20 @@
+#include "pflib/utility/mean.h"
+
+#include <limits>
+#include <numeric>  // std::accumulate
+
+namespace pflib::utility {
+
+template <typename T>
+double mean_impl(const std::vector<T>& samples) {
+  if (samples.size() == 0) {
+    return std::numeric_limits<double>::quiet_NaN();
+  }
+  return std::accumulate(samples.begin(), samples.end(), 0.0) / samples.size();
+}
+
+double mean(const std::vector<double>& samples) { return mean_impl(samples); }
+
+double mean(const std::vector<int>& samples) { return mean_impl(samples); }
+
+}  // namespace pflib::utility

src/pflib/utility/stdev.cxx

@@ -0,0 +1,28 @@
+#include "pflib/utility/stdev.h"
+
+#include <cmath>  // std::sqrt, std::pow, std::abs
+#include <limits>
+#include <numeric>  // std::accumulate
+
+#include "pflib/utility/mean.h"
+
+namespace pflib::utility {
+
+template <typename T>
+double stdev_impl(const std::vector<T>& samples) {
+  if (samples.size() == 0) {
+    return std::numeric_limits<double>::quiet_NaN();
+  }
+  double mean = pflib::utility::mean(samples);
+  double sum = std::accumulate(samples.begin(), samples.end(), 0.0,
+                               [mean](double acc, double v) {
+                                 return acc + std::pow(std::abs((v - mean)), 2);
+                               });
+  return std::sqrt(sum / samples.size());
+}
+
+double stdev(const std::vector<double>& samples) { return stdev_impl(samples); }
+
+double stdev(const std::vector<int>& samples) { return stdev_impl(samples); }
+
+}  // namespace pflib::utility