Skip to content

Commit 4d43375

Browse files
AntoinePrvtdegeus
AntoinePrv
authored and
tdegeus
committed
Add cross reference in api/xmath.rst
1 parent 7e5a943 commit 4d43375

13 files changed

+284
-355
lines changed

‎docs/source/api/accumulating_functions.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,14 @@ Accumulating functions
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _cumsum-function-reference:
1514
.. doxygenfunction:: cumsum(E&&)
1615
:project: xtensor
1716

1817
.. doxygenfunction:: cumsum(E&&, std::ptrdiff_t)
1918
:project: xtensor
2019

21-
.. _cumprod-function-reference:
2220
.. doxygenfunction:: cumprod(E&&)
2321
:project: xtensor
2422

2523
.. doxygenfunction:: cumprod(E&&, std::ptrdiff_t)
26-
:project: xtensor
24+
:project: xtensor

‎docs/source/api/basic_functions.rst‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,51 +11,39 @@ Basic functions
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _abs-function-reference:
1514
.. doxygenfunction:: abs(E&&)
1615
:project: xtensor
1716

18-
.. _fabs-function-reference:
1917
.. doxygenfunction:: fabs(E&&)
2018
:project: xtensor
2119

22-
.. _fmod-function-reference:
2320
.. doxygenfunction:: fmod(E1&&, E2&&)
2421
:project: xtensor
2522

26-
.. _remainder-func-ref:
2723
.. doxygenfunction:: remainder(E1&&, E2&&)
2824
:project: xtensor
2925

30-
.. _fma-function-reference:
3126
.. doxygenfunction:: fma(E1&&, E2&&, E3&&)
3227
:project: xtensor
3328

34-
.. _maximum-func-ref:
3529
.. doxygenfunction:: maximum(E1&&, E2&&)
3630
:project: xtensor
3731

38-
.. _minimum-func-ref:
3932
.. doxygenfunction:: minimum(E1&&, E2&&)
4033
:project: xtensor
4134

42-
.. _fmax-function-reference:
4335
.. doxygenfunction:: fmax(E1&&, E2&&)
4436
:project: xtensor
4537

46-
.. _fmin-function-reference:
4738
.. doxygenfunction:: fmin(E1&&, E2&&)
4839
:project: xtensor
4940

50-
.. _fdim-function-reference:
5141
.. doxygenfunction:: fdim(E1&&, E2&&)
5242
:project: xtensor
5343

54-
.. _clip-function-reference:
5544
.. doxygenfunction:: clip(E1&&, E2&&, E3&&)
5645
:project: xtensor
5746

58-
.. _sign-function-reference:
5947
.. doxygenfunction:: sign(E&&)
6048
:project: xtensor
6149

‎docs/source/api/classif_functions.rst‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,18 @@ Classification functions
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _isfinite-func-ref:
1514
.. doxygenfunction:: isfinite(E&&)
1615
:project: xtensor
1716

18-
.. _isinf-func-ref:
1917
.. doxygenfunction:: isinf(E&&)
2018
:project: xtensor
2119

22-
.. _isnan-func-ref:
2320
.. doxygenfunction:: isnan(E&&)
2421
:project: xtensor
2522

26-
.. _isclose-func-ref:
2723
.. doxygenfunction:: isclose(E1&&, E2&&, double, double, bool)
2824
:project: xtensor
2925

30-
.. _allclose-func-ref:
3126
.. doxygenfunction:: allclose(E1&&, E2&, double, double)
3227
:project: xtensor
3328

‎docs/source/api/error_functions.rst‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,15 @@ Error and gamma functions
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _erf-function-reference:
1514
.. doxygenfunction:: erf(E&&)
1615
:project: xtensor
1716

18-
.. _erfc-function-reference:
1917
.. doxygenfunction:: erfc(E&&)
2018
:project: xtensor
2119

22-
.. _tgamma-func-ref:
2320
.. doxygenfunction:: tgamma(E&&)
2421
:project: xtensor
2522

26-
.. _lgamma-func-ref:
2723
.. doxygenfunction:: lgamma(E&&)
2824
:project: xtensor
2925

‎docs/source/api/exponential_functions.rst‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,24 @@ Exponential functions
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _exp-function-reference:
1514
.. doxygenfunction:: exp(E&&)
1615
:project: xtensor
1716

18-
.. _exp2-function-reference:
1917
.. doxygenfunction:: exp2(E&&)
2018
:project: xtensor
2119

22-
.. _expm1-func-ref:
2320
.. doxygenfunction:: expm1(E&&)
2421
:project: xtensor
2522

26-
.. _log-function-reference:
2723
.. doxygenfunction:: log(E&&)
2824
:project: xtensor
2925

30-
.. _log2-function-reference:
3126
.. doxygenfunction:: log2(E&&)
3227
:project: xtensor
3328

34-
.. _log10-func-ref:
3529
.. doxygenfunction:: log10(E&&)
3630
:project: xtensor
3731

38-
.. _log1p-func-ref:
3932
.. doxygenfunction:: log1p(E&&)
4033
:project: xtensor
4134

‎docs/source/api/index_related.rst‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,14 @@ Index related functions
99

1010
Defined in ``xtensor/xoperation.hpp``
1111

12-
.. _wherec-op-ref:
1312
.. doxygenfunction:: where(const T&)
1413
:project: xtensor
1514

16-
.. _nonzero-op-ref:
1715
.. doxygenfunction:: nonzero(const T&)
1816
:project: xtensor
1917

20-
.. _argwhere-op-ref:
2118
.. doxygenfunction:: argwhere
2219
:project: xtensor
2320

24-
.. _frindices-op-ref:
2521
.. doxygenfunction:: from_indices
2622
:project: xtensor

‎docs/source/api/nan_functions.rst‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,36 @@ NaN functions
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _nan-to-num-function-reference:
1514
.. doxygenfunction:: nan_to_num(E&&)
1615
:project: xtensor
1716

18-
.. _nanmin-function-reference:
1917
.. doxygenfunction:: nanmin(E&&, X&&, EVS)
2018
:project: xtensor
2119

22-
.. _nanmax-function-reference:
2320
.. doxygenfunction:: nanmax(E&&, X&&, EVS)
2421
:project: xtensor
2522

26-
.. _nansum-function-reference:
2723
.. doxygenfunction:: nansum(E&&, X&&, EVS)
2824
:project: xtensor
2925

30-
.. _nanmean-function-reference:
3126
.. doxygenfunction:: nanmean(E&&, X&&, EVS)
3227
:project: xtensor
3328

34-
.. _nanvar-function-reference:
3529
.. doxygenfunction:: nanvar(E&&, X&&, EVS)
3630
:project: xtensor
3731

38-
.. _nanstd-function-reference:
3932
.. doxygenfunction:: nanstd(E&&, X&&, EVS)
4033
:project: xtensor
4134

42-
.. _nanprod-function-reference:
4335
.. doxygenfunction:: nanprod(E&&, X&&, EVS)
4436
:project: xtensor
4537

46-
.. _nancumsum-function-reference:
4738
.. doxygenfunction:: nancumsum(E&&)
4839
:project: xtensor
4940

5041
.. doxygenfunction:: nancumsum(E&&, std::ptrdiff_t)
5142
:project: xtensor
5243

53-
.. _nancumprod-function-reference:
5444
.. doxygenfunction:: nancumprod(E&&)
5545
:project: xtensor
5646

‎docs/source/api/nearint_operations.rst‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,21 @@ Nearest integer floating point operations
1111

1212
Defined in ``xtensor/xmath.hpp``
1313

14-
.. _ceil-function-reference:
1514
.. doxygenfunction:: ceil(E&&)
1615
:project: xtensor
1716

18-
.. _floor-func-ref:
1917
.. doxygenfunction:: floor(E&&)
2018
:project: xtensor
2119

22-
.. _trunc-func-ref:
2320
.. doxygenfunction:: trunc(E&&)
2421
:project: xtensor
2522

26-
.. _round-func-ref:
2723
.. doxygenfunction:: round(E&&)
2824
:project: xtensor
2925

30-
.. _nearbyint-func-ref:
3126
.. doxygenfunction:: nearbyint(E&&)
3227
:project: xtensor
3328

34-
.. _rint-function-reference:
3529
.. doxygenfunction:: rint(E&&)
3630
:project: xtensor
3731

‎docs/source/api/operators.rst‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,134 +9,101 @@ Operators and related functions
99

1010
Defined in ``xtensor/xmath.hpp`` and ``xtensor/xoperation.hpp``
1111

12-
.. _identity-op-ref:
1312
.. doxygenfunction:: operator+(E&&)
1413
:project: xtensor
1514

16-
.. _neg-op-ref:
1715
.. doxygenfunction:: operator-(E&&)
1816
:project: xtensor
1917

20-
.. _plus-op-ref:
2118
.. doxygenfunction:: operator+(E1&&, E2&&)
2219
:project: xtensor
2320

24-
.. _minus-op-ref:
2521
.. doxygenfunction:: operator-(E1&&, E2&&)
2622
:project: xtensor
2723

28-
.. _mul-op-ref:
2924
.. doxygenfunction:: operator*(E1&&, E2&&)
3025
:project: xtensor
3126

32-
.. _div-op-ref:
3327
.. doxygenfunction:: operator/(E1&&, E2&&)
3428
:project: xtensor
3529

36-
.. _or-op-ref:
3730
.. doxygenfunction:: operator||(E1&&, E2&&)
3831
:project: xtensor
3932

40-
.. _and-op-ref:
4133
.. doxygenfunction:: operator&&(E1&&, E2&&)
4234
:project: xtensor
4335

44-
.. _not-op-ref:
4536
.. doxygenfunction:: operator!(E&&)
4637
:project: xtensor
4738

48-
.. _where-op-ref:
4939
.. doxygenfunction:: where(E1&&, E2&&, E3&&)
5040
:project: xtensor
5141

52-
.. _any-op-ref:
5342
.. doxygenfunction:: any(E&&)
5443
:project: xtensor
5544

56-
.. _all-op-ref:
5745
.. doxygenfunction:: all(E&&)
5846
:project: xtensor
5947

60-
.. _less-op-ref:
6148
.. doxygenfunction:: operator<(E1&&, E2&&)
6249
:project: xtensor
6350

64-
.. _less-eq-op-ref:
6551
.. doxygenfunction:: operator<=(E1&&, E2&&)
6652
:project: xtensor
6753

68-
.. _greater-op-ref:
6954
.. doxygenfunction:: operator>(E1&&, E2&&)
7055
:project: xtensor
7156

72-
.. _greater-eq-op-ref:
7357
.. doxygenfunction:: operator>=(E1&&, E2&&)
7458
:project: xtensor
7559

76-
.. _equal-op-ref:
7760
.. doxygenfunction:: operator==(const xexpression<E1>&, const xexpression<E2>&)
7861
:project: xtensor
7962

80-
.. _nequal-op-ref:
8163
.. doxygenfunction:: operator!=(const xexpression<E1>&, const xexpression<E2>&)
8264
:project: xtensor
8365

84-
.. _equal-fn-ref:
8566
.. doxygenfunction:: equal(E1&&, E2&&)
8667
:project: xtensor
8768

88-
.. _nequal-fn-ref:
8969
.. doxygenfunction:: not_equal(E1&&, E2&&)
9070
:project: xtensor
9171

92-
.. _less-fn-ref:
9372
.. doxygenfunction:: less(E1&& e1, E2&& e2)
9473
:project: xtensor
9574

96-
.. _less-eq-fn-ref:
9775
.. doxygenfunction:: less_equal(E1&& e1, E2&& e2)
9876
:project: xtensor
9977

100-
.. _greater-fn-ref:
10178
.. doxygenfunction:: greater(E1&& e1, E2&& e2)
10279
:project: xtensor
10380

104-
.. _greate-eq-fn-ref:
10581
.. doxygenfunction:: greater_equal(E1&& e1, E2&& e2)
10682
:project: xtensor
10783

108-
.. _bitwise-and-op-ref:
10984
.. doxygenfunction:: operator&(E1&&, E2&&)
11085
:project: xtensor
11186

112-
.. _bitwise-or-op-ref:
11387
.. doxygenfunction:: operator|(E1&&, E2&&)
11488
:project: xtensor
11589

116-
.. _bitwise-xor-op-ref:
11790
.. doxygenfunction:: operator^(E1&&, E2&&)
11891
:project: xtensor
11992

120-
.. _bitwise-not-op-ref:
12193
.. doxygenfunction:: operator~(E&&)
12294
:project: xtensor
12395

124-
.. _left-shift-fn-ref:
12596
.. doxygenfunction:: left_shift(E1&&, E2&&)
12697
:project: xtensor
12798

128-
.. _right-shift-fn-ref:
12999
.. doxygenfunction:: right_shift(E1&&, E2&&)
130100
:project: xtensor
131101

132-
.. _left-sh-op-ref:
133102
.. doxygenfunction:: operator<<(E1&&, E2&&)
134103
:project: xtensor
135104

136-
.. _right-sh-op-ref:
137105
.. doxygenfunction:: operator>>(E1&&, E2&&)
138106
:project: xtensor
139107

140-
.. _cast-ref:
141108
.. doxygenfunction:: cast(E&&)
142109
:project: xtensor

‎docs/source/api/power_functions.rst‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Power functions
1212

1313
Defined in ``xtensor/xmath.hpp``
1414

15-
.. _pow-function-reference:
1615
.. doxygenfunction:: pow(E1&&, E2&&)
1716
:project: xtensor
1817

@@ -25,15 +24,12 @@ Defined in ``xtensor/xmath.hpp``
2524
.. doxygenfunction:: cube(E1&&)
2625
:project: xtensor
2726

28-
.. _sqrt-function-reference:
2927
.. doxygenfunction:: sqrt(E&&)
3028
:project: xtensor
3129

32-
.. _cbrt-function-reference:
3330
.. doxygenfunction:: cbrt(E&&)
3431
:project: xtensor
3532

36-
.. _hypot-func-ref:
3733
.. doxygenfunction:: hypot(E1&&, E2&&)
3834
:project: xtensor
3935

0 commit comments

Comments
 (0)