From dcb0ddf0c91458b5e089c2ade96a43e4b7f514bc Mon Sep 17 00:00:00 2001
From: Thibault Hallouin <thibault.hallouin@inrae.fr>
Date: Wed, 28 Jun 2023 12:09:13 +0200
Subject: [PATCH] fix typos in docstrings for event-based deterministic metrics
---
include/evalhyd/detail/determinist/events.hpp | 26 +++++++++----------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/include/evalhyd/detail/determinist/events.hpp b/include/evalhyd/detail/determinist/events.hpp
index 794ccef..8c2da1f 100644
--- a/include/evalhyd/detail/determinist/events.hpp
+++ b/include/evalhyd/detail/determinist/events.hpp
@@ -100,13 +100,13 @@ namespace evalhyd
///
/// \param obs_event
/// Observed event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \param prd_event
/// Predicted event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \return
/// Hits.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_a(
const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event
@@ -119,13 +119,13 @@ namespace evalhyd
///
/// \param obs_event
/// Observed event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \param prd_event
/// Predicted event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \return
/// False alarms.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_b(
const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event
@@ -138,13 +138,13 @@ namespace evalhyd
///
/// \param obs_event
/// Observed event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \param prd_event
/// Predicted event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \return
/// Misses.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_c(
const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event
@@ -157,13 +157,13 @@ namespace evalhyd
///
/// \param obs_event
/// Observed event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \param prd_event
/// Predicted event outcome.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
/// \return
/// Correct rejections.
- /// shape: (sites, thresholds, time)
+ /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_d(
const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event
@@ -209,7 +209,7 @@ namespace evalhyd
/// \param n_exp
/// Number of bootstrap samples.
/// \return
- /// Probabilities of detection.
+ /// Contingency tables.
/// shape: (series, subsets, samples, thresholds, cells)
template<class XD2>
inline xt::xtensor<double, 5> calc_CONT_TBL(
--
GitLab