Commit dcb0ddf0 authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

fix typos in docstrings for event-based deterministic metrics

1 merge request!7release v0.1.2
Pipeline #49688 passed with stage
in 3 minutes and 38 seconds
Showing with 13 additions and 13 deletions
+13 -13
...@@ -100,13 +100,13 @@ namespace evalhyd ...@@ -100,13 +100,13 @@ namespace evalhyd
/// ///
/// \param obs_event /// \param obs_event
/// Observed event outcome. /// Observed event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \param prd_event /// \param prd_event
/// Predicted event outcome. /// Predicted event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \return /// \return
/// Hits. /// Hits.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_a( inline xt::xtensor<double, 3> calc_ct_a(
const xt::xtensor<double, 3>& obs_event, const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event const xt::xtensor<double, 3>& prd_event
...@@ -119,13 +119,13 @@ namespace evalhyd ...@@ -119,13 +119,13 @@ namespace evalhyd
/// ///
/// \param obs_event /// \param obs_event
/// Observed event outcome. /// Observed event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \param prd_event /// \param prd_event
/// Predicted event outcome. /// Predicted event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \return /// \return
/// False alarms. /// False alarms.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_b( inline xt::xtensor<double, 3> calc_ct_b(
const xt::xtensor<double, 3>& obs_event, const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event const xt::xtensor<double, 3>& prd_event
...@@ -138,13 +138,13 @@ namespace evalhyd ...@@ -138,13 +138,13 @@ namespace evalhyd
/// ///
/// \param obs_event /// \param obs_event
/// Observed event outcome. /// Observed event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \param prd_event /// \param prd_event
/// Predicted event outcome. /// Predicted event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \return /// \return
/// Misses. /// Misses.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_c( inline xt::xtensor<double, 3> calc_ct_c(
const xt::xtensor<double, 3>& obs_event, const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event const xt::xtensor<double, 3>& prd_event
...@@ -157,13 +157,13 @@ namespace evalhyd ...@@ -157,13 +157,13 @@ namespace evalhyd
/// ///
/// \param obs_event /// \param obs_event
/// Observed event outcome. /// Observed event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \param prd_event /// \param prd_event
/// Predicted event outcome. /// Predicted event outcome.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
/// \return /// \return
/// Correct rejections. /// Correct rejections.
/// shape: (sites, thresholds, time) /// shape: (series, thresholds, time)
inline xt::xtensor<double, 3> calc_ct_d( inline xt::xtensor<double, 3> calc_ct_d(
const xt::xtensor<double, 3>& obs_event, const xt::xtensor<double, 3>& obs_event,
const xt::xtensor<double, 3>& prd_event const xt::xtensor<double, 3>& prd_event
...@@ -209,7 +209,7 @@ namespace evalhyd ...@@ -209,7 +209,7 @@ namespace evalhyd
/// \param n_exp /// \param n_exp
/// Number of bootstrap samples. /// Number of bootstrap samples.
/// \return /// \return
/// Probabilities of detection. /// Contingency tables.
/// shape: (series, subsets, samples, thresholds, cells) /// shape: (series, subsets, samples, thresholds, cells)
template<class XD2> template<class XD2>
inline xt::xtensor<double, 5> calc_CONT_TBL( inline xt::xtensor<double, 5> calc_CONT_TBL(
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment