diff --git a/include/evalhyd/evald.hpp b/include/evalhyd/evald.hpp index 7976a9563afb52dccd79ee0d43e02c78f2cd985d..352cc6211d90cfae8e62fdb31688e4f0b8d6b7e7 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 9b037172248fda6348dfbd352a5236ede5b47c98..da85e3fbe4228f80e5e21d399cb041f010062528 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)