Commit 562e4e16 authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

rephrase explanation for mask in docstring and add example for it

Showing with 11 additions and 5 deletions
+11 -5
......@@ -90,11 +90,11 @@ namespace evalhyd
/// <https://doi.org/10.1016/j.jhydrol.2011.11.055>`_.
///
/// t_msk: ``xt::xexpression<A>``, optional
/// Mask(s) used to generate temporal subsets of the whole streamflow
/// time series (where True/False is used for the time steps to
/// include/discard in a given subset). Masks must feature the same
/// number of dimensions as observations and predictions, and it must
/// broadcastable with both of them.
/// Mask used to temporally subset of the whole streamflow time series
/// (where True/False is used for the time steps to include/discard in
/// the subset). Masks must feature the same number of dimensions as
/// observations and predictions, and it must broadcastable with both
/// of them.
/// shape: ({... ,} time)
///
/// :Returns:
......@@ -129,6 +129,12 @@ namespace evalhyd
///
/// evalhyd::evald(obs, prd, {"NSE"}, "log", 1, 0.05);
///
/// .. code-block:: c++
///
/// xt::xtensor<double, 2> msk = {{ 1, 1, 0, 1, 0 }};
///
/// evalhyd::evald(obs, prd, {"NSE"}, "none", 1, -9, msk);
///
/// \endrst
template <class A>
std::vector<xt::xarray<double>> evald(
......
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