Update documentation for index-related functions and operators, and clarify overload families for xjson, xreducer, and xset_operation

Author: Alex-PLACET

docs/source/api/index_related.rst

@@ -9,10 +9,7 @@ Index related functions
 
 Defined in ``xtensor/core/xoperation.hpp``
 
-.. doxygenfunction:: where(const T&)
+The logical operator group documents the index-producing overloads of
+``xt::where``, ``xt::nonzero`` and ``xt::argwhere``.
 
-.. doxygenfunction:: nonzero(const T&)
-
-.. doxygenfunction:: argwhere
-
-.. doxygenfunction:: from_indices
+``xt::from_indices`` is documented on the ``xtensor`` API page.

docs/source/api/operators.rst

@@ -9,68 +9,17 @@ Operators and related functions
 
 Defined in ``xtensor/core/xmath.hpp`` and ``xtensor/core/xoperation.hpp``
 
-.. doxygenfunction:: operator+(E&&)
+.. doxygengroup:: arithmetic_operators
+   :members:
 
-.. doxygenfunction:: operator-(E&&)
+.. doxygengroup:: logical_operators
+   :members:
 
-.. doxygenfunction:: operator+(E1&&, E2&&)
+.. doxygengroup:: comparison_operators
+   :members:
 
-.. doxygenfunction:: operator-(E1&&, E2&&)
+.. doxygengroup:: bitwise_operators
+   :members:
 
-.. doxygenfunction:: operator*(E1&&, E2&&)
-
-.. doxygenfunction:: operator/(E1&&, E2&&)
-
-.. doxygenfunction:: operator||(E1&&, E2&&)
-
-.. doxygenfunction:: operator&&(E1&&, E2&&)
-
-.. doxygenfunction:: operator!(E&&)
-
-.. doxygenfunction:: where(E1&&, E2&&, E3&&)
-
-.. doxygenfunction:: any(E&&)
-
-.. doxygenfunction:: all(E&&)
-
-.. doxygenfunction:: operator<(E1&&, E2&&)
-
-.. doxygenfunction:: operator<=(E1&&, E2&&)
-
-.. doxygenfunction:: operator>(E1&&, E2&&)
-
-.. doxygenfunction:: operator>=(E1&&, E2&&)
-
-.. doxygenfunction:: operator==(const xexpression<E1>&, const xexpression<E2>&)
-
-.. doxygenfunction:: operator!=(const xexpression<E1>&, const xexpression<E2>&)
-
-.. doxygenfunction:: equal(E1&&, E2&&)
-
-.. doxygenfunction:: not_equal(E1&&, E2&&)
-
-.. doxygenfunction:: less(E1&& e1, E2&& e2)
-
-.. doxygenfunction:: less_equal(E1&& e1, E2&& e2)
-
-.. doxygenfunction:: greater(E1&& e1, E2&& e2)
-
-.. doxygenfunction:: greater_equal(E1&& e1, E2&& e2)
-
-.. doxygenfunction:: operator&(E1&&, E2&&)
-
-.. doxygenfunction:: operator|(E1&&, E2&&)
-
-.. doxygenfunction:: operator^(E1&&, E2&&)
-
-.. doxygenfunction:: operator~(E&&)
-
-.. doxygenfunction:: left_shift(E1&&, E2&&)
-
-.. doxygenfunction:: right_shift(E1&&, E2&&)
-
-.. doxygenfunction:: operator<<(E1&&, E2&&)
-
-.. doxygenfunction:: operator>>(E1&&, E2&&)
-
-.. doxygenfunction:: cast(E&&)
+.. doxygengroup:: casting_operators
+   :members:

docs/source/api/xjson.rst

@@ -9,6 +9,10 @@ xjson: serialize to/from JSON
 
 Defined in ``xtensor/io/xjson.hpp``
 
-.. doxygenfunction:: xt::to_json(nlohmann::json&, const E&);
+Available overload families
+---------------------------
 
-.. doxygenfunction:: xt::from_json(const nlohmann::json&, E&);
+- ``xt::to_json(nlohmann::basic_json<M>&, const E&)``
+- ``xt::from_json(const nlohmann::basic_json<M>&, E&)``
+
+``xt::from_json`` is provided for both container and view semantics.

docs/source/api/xreducer.rst

@@ -12,4 +12,9 @@ Defined in ``xtensor/reducers/xreducer.hpp``
 .. doxygenclass:: xt::xreducer
    :members:
 
-.. doxygenfunction:: xt::reduce(F&&, E&&, X&&, EVS&&)
+Available overload families
+---------------------------
+
+- ``xt::reduce(f, e, axes, options)``
+- ``xt::reduce(f, e, options)``
+- ``xt::reduce(f, e, const I (&axes)[N], options)``

docs/source/api/xset_operation.rst

@@ -9,19 +9,13 @@ xset_operation
 
 Defined in ``xtensor/misc/xset_operation.hpp``
 
-.. doxygenenum:: xt::isin(E&&, F&&)
+``xt::searchsorted(a, v, right)`` returns insertion indices for values ``v``
+in the sorted array ``a``.
 
-.. doxygenenum:: xt::in1d(E&&, F&&)
+Available functions
+-------------------
 
-.. doxygenenum:: xt::searchsorted(E1&&, E2&&, bool)
-
-Further overloads
------------------
-
-.. doxygenenum:: xt::isin(E&&, std::initializer_list<T>)
-
-.. doxygenenum:: xt::isin(E&&, I&&, I&&)
-
-.. doxygenenum:: xt::in1d(E&&, std::initializer_list<T>)
-
-.. doxygenenum:: xt::in1d(E&&, I&&, I&&)
+- ``xt::isin(element, test_elements)``
+- ``xt::in1d(element, test_elements)``
+- ``xt::isin(element, begin, end)``
+- ``xt::in1d(element, begin, end)``