From 6b27aa189be4cfcf116141ad113a48e1f757f6c0 Mon Sep 17 00:00:00 2001
From: Thibault Hallouin <thibault.hallouin@inrae.fr>
Date: Mon, 1 Aug 2022 10:45:17 +0200
Subject: [PATCH] bring note on dimensionality in higher level docstring to
show in docs
---
include/evalhyd/evald.hpp | 11 +++++++++--
src/determinist/evaluator.hpp | 15 ---------------
2 files changed, 9 insertions(+), 17 deletions(-)
diff --git a/include/evalhyd/evald.hpp b/include/evalhyd/evald.hpp
index 7976a95..352cc62 100644
--- a/include/evalhyd/evald.hpp
+++ b/include/evalhyd/evald.hpp
@@ -17,6 +17,13 @@ namespace evalhyd
{
/// Function to evaluate deterministic streamflow predictions.
///
+ /// .. note::
+ ///
+ /// If multi-dimensional arrays are provided, the arrays of predictions
+ /// and observations must feature the same number of dimensions, they
+ /// must be broadcastable, and their temporal dimensions must be along
+ /// their last axis.
+ ///
/// \rst
///
/// :Template Parameters:
@@ -29,11 +36,11 @@ namespace evalhyd
///
/// q_obs: ``xt::xexpression<A>``
/// Streamflow observations.
- /// shape: (1+, time)
+ /// shape: ({1+, ...}, time)
///
/// q_prd: ``xt::xexpression<A>``
/// Streamflow predictions.
- /// shape: (1+, time)
+ /// shape: ({1+, ...}, time)
///
/// metrics: ``std::vector<std::string>``
/// The sequence of evaluation metrics to be computed.
diff --git a/src/determinist/evaluator.hpp b/src/determinist/evaluator.hpp
index 9b03717..da85e3f 100644
--- a/src/determinist/evaluator.hpp
+++ b/src/determinist/evaluator.hpp
@@ -214,11 +214,6 @@ namespace evalhyd
// Compute the Nash-Sutcliffe Efficiency (NSE).
//
- // If multi-dimensional arrays are provided, the arrays of predictions
- // and observations must feature the same number of dimensions, they
- // must be broadcastable, and their temporal dimensions must be along
- // their last axis.
- //
// \require quad_err:
// Quadratic errors between observations and predictions.
// shape: ({1+, ...}, time)
@@ -241,11 +236,6 @@ namespace evalhyd
// Compute the Kling-Gupta Efficiency (KGE).
//
- // If multi-dimensional arrays are provided, the arrays of predictions
- // and observations must feature the same number of dimensions, they
- // must be broadcastable, and their temporal dimensions must be along
- // their last axis.
- //
// \require q_obs:
// Streamflow observations.
// shape: ({1, ...}, time)
@@ -279,11 +269,6 @@ namespace evalhyd
// Compute the modified Kling-Gupta Efficiency (KGEPRIME).
//
- // If multi-dimensional arrays are provided, the arrays of predictions
- // and observations must feature the same number of dimensions, they
- // must be broadcastable, and their temporal dimensions must be along
- // their last axis.
- //
// \require q_obs:
// Streamflow observations.
// shape: ({1, ...}, time)
--
GitLab