Commit 6b27aa18 authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

bring note on dimensionality in higher level docstring to show in docs

Showing with 9 additions and 17 deletions
+9 -17
...@@ -17,6 +17,13 @@ namespace evalhyd ...@@ -17,6 +17,13 @@ namespace evalhyd
{ {
/// Function to evaluate deterministic streamflow predictions. /// 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 /// \rst
/// ///
/// :Template Parameters: /// :Template Parameters:
...@@ -29,11 +36,11 @@ namespace evalhyd ...@@ -29,11 +36,11 @@ namespace evalhyd
/// ///
/// q_obs: ``xt::xexpression<A>`` /// q_obs: ``xt::xexpression<A>``
/// Streamflow observations. /// Streamflow observations.
/// shape: (1+, time) /// shape: ({1+, ...}, time)
/// ///
/// q_prd: ``xt::xexpression<A>`` /// q_prd: ``xt::xexpression<A>``
/// Streamflow predictions. /// Streamflow predictions.
/// shape: (1+, time) /// shape: ({1+, ...}, time)
/// ///
/// metrics: ``std::vector<std::string>`` /// metrics: ``std::vector<std::string>``
/// The sequence of evaluation metrics to be computed. /// The sequence of evaluation metrics to be computed.
......
...@@ -214,11 +214,6 @@ namespace evalhyd ...@@ -214,11 +214,6 @@ namespace evalhyd
// Compute the Nash-Sutcliffe Efficiency (NSE). // 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: // \require quad_err:
// Quadratic errors between observations and predictions. // Quadratic errors between observations and predictions.
// shape: ({1+, ...}, time) // shape: ({1+, ...}, time)
...@@ -241,11 +236,6 @@ namespace evalhyd ...@@ -241,11 +236,6 @@ namespace evalhyd
// Compute the Kling-Gupta Efficiency (KGE). // 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: // \require q_obs:
// Streamflow observations. // Streamflow observations.
// shape: ({1, ...}, time) // shape: ({1, ...}, time)
...@@ -279,11 +269,6 @@ namespace evalhyd ...@@ -279,11 +269,6 @@ namespace evalhyd
// Compute the modified Kling-Gupta Efficiency (KGEPRIME). // 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: // \require q_obs:
// Streamflow observations. // Streamflow observations.
// shape: ({1, ...}, time) // shape: ({1, ...}, time)
......
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