Add cross reference in api/xmath.rst

xtensor-stack · Apr 7, 2022 · 4d43375 · 4d43375
1 parent 7e5a943
commit 4d43375
Show file tree

Hide file tree

Showing 13 changed files with 284 additions and 355 deletions.
diff --git a/docs/source/api/accumulating_functions.rst b/docs/source/api/accumulating_functions.rst
@@ -11,16 +11,14 @@ Accumulating functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _cumsum-function-reference:
 .. doxygenfunction:: cumsum(E&&)
    :project: xtensor
 
 .. doxygenfunction:: cumsum(E&&, std::ptrdiff_t)
    :project: xtensor
 
-.. _cumprod-function-reference:
 .. doxygenfunction:: cumprod(E&&)
    :project: xtensor
 
 .. doxygenfunction:: cumprod(E&&, std::ptrdiff_t)
-   :project: xtensor
+   :project: xtensor
diff --git a/docs/source/api/basic_functions.rst b/docs/source/api/basic_functions.rst
@@ -11,51 +11,39 @@ Basic functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _abs-function-reference:
 .. doxygenfunction:: abs(E&&)
    :project: xtensor
 
-.. _fabs-function-reference:
 .. doxygenfunction:: fabs(E&&)
    :project: xtensor
 
-.. _fmod-function-reference:
 .. doxygenfunction:: fmod(E1&&, E2&&)
    :project: xtensor
 
-.. _remainder-func-ref:
 .. doxygenfunction:: remainder(E1&&, E2&&)
    :project: xtensor
 
-.. _fma-function-reference:
 .. doxygenfunction:: fma(E1&&, E2&&, E3&&)
    :project: xtensor
 
-.. _maximum-func-ref:
 .. doxygenfunction:: maximum(E1&&, E2&&)
    :project: xtensor
 
-.. _minimum-func-ref:
 .. doxygenfunction:: minimum(E1&&, E2&&)
    :project: xtensor
 
-.. _fmax-function-reference:
 .. doxygenfunction:: fmax(E1&&, E2&&)
    :project: xtensor
 
-.. _fmin-function-reference:
 .. doxygenfunction:: fmin(E1&&, E2&&)
    :project: xtensor
 
-.. _fdim-function-reference:
 .. doxygenfunction:: fdim(E1&&, E2&&)
    :project: xtensor
 
-.. _clip-function-reference:
 .. doxygenfunction:: clip(E1&&, E2&&, E3&&)
    :project: xtensor
 
-.. _sign-function-reference:
 .. doxygenfunction:: sign(E&&)
    :project: xtensor
 
diff --git a/docs/source/api/classif_functions.rst b/docs/source/api/classif_functions.rst
@@ -11,23 +11,18 @@ Classification functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _isfinite-func-ref:
 .. doxygenfunction:: isfinite(E&&)
    :project: xtensor
 
-.. _isinf-func-ref:
 .. doxygenfunction:: isinf(E&&)
    :project: xtensor
 
-.. _isnan-func-ref:
 .. doxygenfunction:: isnan(E&&)
    :project: xtensor
 
-.. _isclose-func-ref:
 .. doxygenfunction:: isclose(E1&&, E2&&, double, double, bool)
    :project: xtensor
 
-.. _allclose-func-ref:
 .. doxygenfunction:: allclose(E1&&, E2&, double, double)
    :project: xtensor
 
diff --git a/docs/source/api/error_functions.rst b/docs/source/api/error_functions.rst
@@ -11,19 +11,15 @@ Error and gamma functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _erf-function-reference:
 .. doxygenfunction:: erf(E&&)
    :project: xtensor
 
-.. _erfc-function-reference:
 .. doxygenfunction:: erfc(E&&)
    :project: xtensor
 
-.. _tgamma-func-ref:
 .. doxygenfunction:: tgamma(E&&)
    :project: xtensor
 
-.. _lgamma-func-ref:
 .. doxygenfunction:: lgamma(E&&)
    :project: xtensor
 
diff --git a/docs/source/api/exponential_functions.rst b/docs/source/api/exponential_functions.rst
@@ -11,31 +11,24 @@ Exponential functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _exp-function-reference:
 .. doxygenfunction:: exp(E&&)
    :project: xtensor
 
-.. _exp2-function-reference:
 .. doxygenfunction:: exp2(E&&)
    :project: xtensor
 
-.. _expm1-func-ref:
 .. doxygenfunction:: expm1(E&&)
    :project: xtensor
 
-.. _log-function-reference:
 .. doxygenfunction:: log(E&&)
    :project: xtensor
 
-.. _log2-function-reference:
 .. doxygenfunction:: log2(E&&)
    :project: xtensor
 
-.. _log10-func-ref:
 .. doxygenfunction:: log10(E&&)
    :project: xtensor
 
-.. _log1p-func-ref:
 .. doxygenfunction:: log1p(E&&)
    :project: xtensor
 
diff --git a/docs/source/api/index_related.rst b/docs/source/api/index_related.rst
@@ -9,18 +9,14 @@ Index related functions
 
 Defined in ``xtensor/xoperation.hpp``
 
-.. _wherec-op-ref:
 .. doxygenfunction:: where(const T&)
    :project: xtensor
 
-.. _nonzero-op-ref:
 .. doxygenfunction:: nonzero(const T&)
    :project: xtensor
 
-.. _argwhere-op-ref:
 .. doxygenfunction:: argwhere
    :project: xtensor
 
-.. _frindices-op-ref:
 .. doxygenfunction:: from_indices
    :project: xtensor
diff --git a/docs/source/api/nan_functions.rst b/docs/source/api/nan_functions.rst
@@ -11,46 +11,36 @@ NaN functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _nan-to-num-function-reference:
 .. doxygenfunction:: nan_to_num(E&&)
    :project: xtensor
 
-.. _nanmin-function-reference:
 .. doxygenfunction:: nanmin(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nanmax-function-reference:
 .. doxygenfunction:: nanmax(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nansum-function-reference:
 .. doxygenfunction:: nansum(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nanmean-function-reference:
 .. doxygenfunction:: nanmean(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nanvar-function-reference:
 .. doxygenfunction:: nanvar(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nanstd-function-reference:
 .. doxygenfunction:: nanstd(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nanprod-function-reference:
 .. doxygenfunction:: nanprod(E&&, X&&, EVS)
    :project: xtensor
 
-.. _nancumsum-function-reference:
 .. doxygenfunction:: nancumsum(E&&)
    :project: xtensor
 
 .. doxygenfunction:: nancumsum(E&&, std::ptrdiff_t)
    :project: xtensor
 
-.. _nancumprod-function-reference:
 .. doxygenfunction:: nancumprod(E&&)
    :project: xtensor
 

diff --git a/docs/source/api/nearint_operations.rst b/docs/source/api/nearint_operations.rst
@@ -11,27 +11,21 @@ Nearest integer floating point operations
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _ceil-function-reference:
 .. doxygenfunction:: ceil(E&&)
    :project: xtensor
 
-.. _floor-func-ref:
 .. doxygenfunction:: floor(E&&)
    :project: xtensor
 
-.. _trunc-func-ref:
 .. doxygenfunction:: trunc(E&&)
    :project: xtensor
 
-.. _round-func-ref:
 .. doxygenfunction:: round(E&&)
    :project: xtensor
 
-.. _nearbyint-func-ref:
 .. doxygenfunction:: nearbyint(E&&)
    :project: xtensor
 
-.. _rint-function-reference:
 .. doxygenfunction:: rint(E&&)
    :project: xtensor
 
diff --git a/docs/source/api/operators.rst b/docs/source/api/operators.rst
@@ -9,134 +9,101 @@ Operators and related functions
 
 Defined in ``xtensor/xmath.hpp`` and ``xtensor/xoperation.hpp``
 
-.. _identity-op-ref:
 .. doxygenfunction:: operator+(E&&)
    :project: xtensor
 
-.. _neg-op-ref:
 .. doxygenfunction:: operator-(E&&)
    :project: xtensor
 
-.. _plus-op-ref:
 .. doxygenfunction:: operator+(E1&&, E2&&)
    :project: xtensor
 
-.. _minus-op-ref:
 .. doxygenfunction:: operator-(E1&&, E2&&)
    :project: xtensor
 
-.. _mul-op-ref:
 .. doxygenfunction:: operator*(E1&&, E2&&)
    :project: xtensor
 
-.. _div-op-ref:
 .. doxygenfunction:: operator/(E1&&, E2&&)
    :project: xtensor
 
-.. _or-op-ref:
 .. doxygenfunction:: operator||(E1&&, E2&&)
    :project: xtensor
 
-.. _and-op-ref:
 .. doxygenfunction:: operator&&(E1&&, E2&&)
    :project: xtensor
 
-.. _not-op-ref:
 .. doxygenfunction:: operator!(E&&)
    :project: xtensor
 
-.. _where-op-ref:
 .. doxygenfunction:: where(E1&&, E2&&, E3&&)
    :project: xtensor
 
-.. _any-op-ref:
 .. doxygenfunction:: any(E&&)
    :project: xtensor
 
-.. _all-op-ref:
 .. doxygenfunction:: all(E&&)
    :project: xtensor
 
-.. _less-op-ref:
 .. doxygenfunction:: operator<(E1&&, E2&&)
    :project: xtensor
 
-.. _less-eq-op-ref:
 .. doxygenfunction:: operator<=(E1&&, E2&&)
    :project: xtensor
 
-.. _greater-op-ref:
 .. doxygenfunction:: operator>(E1&&, E2&&)
    :project: xtensor
 
-.. _greater-eq-op-ref:
 .. doxygenfunction:: operator>=(E1&&, E2&&)
    :project: xtensor
 
-.. _equal-op-ref:
 .. doxygenfunction:: operator==(const xexpression<E1>&, const xexpression<E2>&)
    :project: xtensor
 
-.. _nequal-op-ref:
 .. doxygenfunction:: operator!=(const xexpression<E1>&, const xexpression<E2>&)
    :project: xtensor
 
-.. _equal-fn-ref:
 .. doxygenfunction:: equal(E1&&, E2&&)
    :project: xtensor
 
-.. _nequal-fn-ref:
 .. doxygenfunction:: not_equal(E1&&, E2&&)
    :project: xtensor
 
-.. _less-fn-ref:
 .. doxygenfunction:: less(E1&& e1, E2&& e2)
    :project: xtensor
 
-.. _less-eq-fn-ref:
 .. doxygenfunction:: less_equal(E1&& e1, E2&& e2)
    :project: xtensor
 
-.. _greater-fn-ref:
 .. doxygenfunction:: greater(E1&& e1, E2&& e2)
    :project: xtensor
 
-.. _greate-eq-fn-ref:
 .. doxygenfunction:: greater_equal(E1&& e1, E2&& e2)
    :project: xtensor
 
-.. _bitwise-and-op-ref:
 .. doxygenfunction:: operator&(E1&&, E2&&)
    :project: xtensor
 
-.. _bitwise-or-op-ref:
 .. doxygenfunction:: operator|(E1&&, E2&&)
    :project: xtensor
 
-.. _bitwise-xor-op-ref:
 .. doxygenfunction:: operator^(E1&&, E2&&)
    :project: xtensor
 
-.. _bitwise-not-op-ref:
 .. doxygenfunction:: operator~(E&&)
    :project: xtensor
 
-.. _left-shift-fn-ref:
 .. doxygenfunction:: left_shift(E1&&, E2&&)
    :project: xtensor
 
-.. _right-shift-fn-ref:
 .. doxygenfunction:: right_shift(E1&&, E2&&)
    :project: xtensor
 
-.. _left-sh-op-ref:
 .. doxygenfunction:: operator<<(E1&&, E2&&)
    :project: xtensor
 
-.. _right-sh-op-ref:
 .. doxygenfunction:: operator>>(E1&&, E2&&)
    :project: xtensor
 
-.. _cast-ref:
 .. doxygenfunction:: cast(E&&)
    :project: xtensor
diff --git a/docs/source/api/power_functions.rst b/docs/source/api/power_functions.rst
@@ -12,7 +12,6 @@ Power functions
 
 Defined in ``xtensor/xmath.hpp``
 
-.. _pow-function-reference:
 .. doxygenfunction:: pow(E1&&, E2&&)
    :project: xtensor
 
@@ -25,15 +24,12 @@ Defined in ``xtensor/xmath.hpp``
 .. doxygenfunction:: cube(E1&&)
    :project: xtensor
 
-.. _sqrt-function-reference:
 .. doxygenfunction:: sqrt(E&&)
    :project: xtensor
 
-.. _cbrt-function-reference:
 .. doxygenfunction:: cbrt(E&&)
    :project: xtensor
 
-.. _hypot-func-ref:
 .. doxygenfunction:: hypot(E1&&, E2&&)
    :project: xtensor