Skip to content

Commit 1e1c617

Browse files
Align docs ufunc with NumPy/CuPy short names
1 parent 9df7605 commit 1e1c617

File tree

1 file changed

+110
-108
lines changed

1 file changed

+110
-108
lines changed

doc/reference/ufunc.rst

Lines changed: 110 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.. _ufunc:
22

3-
Universal Functions (ufunc)
4-
===========================
3+
.. currentmodule:: dpnp
54

6-
.. https://numpy.org/doc/stable/reference/ufuncs.html
5+
Universal functions
6+
===================
7+
8+
.. hint:: `NumPy API Reference: Universal functions (numpy.ufunc) <https://numpy.org/doc/stable/reference/ufuncs.html>`_
79

810
DPNP provides universal functions (a.k.a. ufuncs) to support various element-wise operations.
911

@@ -17,46 +19,46 @@ Math operations
1719
:toctree: generated/
1820
:nosignatures:
1921

20-
dpnp.add
21-
dpnp.subtract
22-
dpnp.multiply
23-
dpnp.matmul
24-
dpnp.divide
25-
dpnp.logaddexp
26-
dpnp.logaddexp2
27-
dpnp.true_divide
28-
dpnp.floor_divide
29-
dpnp.negative
30-
dpnp.positive
31-
dpnp.power
32-
dpnp.pow
33-
dpnp.float_power
34-
dpnp.remainder
35-
dpnp.mod
36-
dpnp.fmod
37-
dpnp.divmod
38-
dpnp.absolute
39-
dpnp.fabs
40-
dpnp.rint
41-
dpnp.sign
42-
dpnp.heaviside
43-
dpnp.conj
44-
dpnp.conjugate
45-
dpnp.exp
46-
dpnp.exp2
47-
dpnp.log
48-
dpnp.log2
49-
dpnp.log10
50-
dpnp.expm1
51-
dpnp.log1p
52-
dpnp.proj
53-
dpnp.sqrt
54-
dpnp.square
55-
dpnp.cbrt
56-
dpnp.reciprocal
57-
dpnp.rsqrt
58-
dpnp.gcd
59-
dpnp.lcm
22+
add
23+
subtract
24+
multiply
25+
matmul
26+
divide
27+
logaddexp
28+
logaddexp2
29+
true_divide
30+
floor_divide
31+
negative
32+
positive
33+
power
34+
pow
35+
float_power
36+
remainder
37+
mod
38+
fmod
39+
divmod
40+
absolute
41+
fabs
42+
rint
43+
sign
44+
heaviside
45+
conj
46+
conjugate
47+
exp
48+
exp2
49+
log
50+
log2
51+
log10
52+
expm1
53+
log1p
54+
proj
55+
sqrt
56+
square
57+
cbrt
58+
reciprocal
59+
rsqrt
60+
gcd
61+
lcm
6062

6163
.. tip::
6264

@@ -79,31 +81,31 @@ The ratio of degrees to radians is :math:`180^{\circ}/\pi.`
7981
:toctree: generated/
8082
:nosignatures:
8183

82-
dpnp.sin
83-
dpnp.cos
84-
dpnp.tan
85-
dpnp.arcsin
86-
dpnp.asin
87-
dpnp.arccos
88-
dpnp.acos
89-
dpnp.arctan
90-
dpnp.atan
91-
dpnp.arctan2
92-
dpnp.atan2
93-
dpnp.hypot
94-
dpnp.sinh
95-
dpnp.cosh
96-
dpnp.tanh
97-
dpnp.arcsinh
98-
dpnp.asinh
99-
dpnp.arccosh
100-
dpnp.acosh
101-
dpnp.arctanh
102-
dpnp.atanh
103-
dpnp.degrees
104-
dpnp.radians
105-
dpnp.deg2rad
106-
dpnp.rad2deg
84+
sin
85+
cos
86+
tan
87+
arcsin
88+
asin
89+
arccos
90+
acos
91+
arctan
92+
atan
93+
arctan2
94+
atan2
95+
hypot
96+
sinh
97+
cosh
98+
tanh
99+
arcsinh
100+
asinh
101+
arccosh
102+
acosh
103+
arctanh
104+
atanh
105+
degrees
106+
radians
107+
deg2rad
108+
rad2deg
107109

108110

109111
Bit-twiddling functions
@@ -113,17 +115,17 @@ Bit-twiddling functions
113115
:toctree: generated/
114116
:nosignatures:
115117

116-
dpnp.bitwise_and
117-
dpnp.bitwise_not
118-
dpnp.bitwise_or
119-
dpnp.bitwise_xor
120-
dpnp.invert
121-
dpnp.bitwise_invert
122-
dpnp.left_shift
123-
dpnp.bitwise_left_shift
124-
dpnp.right_shift
125-
dpnp.bitwise_right_shift
126-
dpnp.bitwise_count
118+
bitwise_and
119+
bitwise_not
120+
bitwise_or
121+
bitwise_xor
122+
invert
123+
bitwise_invert
124+
left_shift
125+
bitwise_left_shift
126+
right_shift
127+
bitwise_right_shift
128+
bitwise_count
127129

128130

129131
Comparison functions
@@ -133,22 +135,22 @@ Comparison functions
133135
:toctree: generated/
134136
:nosignatures:
135137

136-
dpnp.greater
137-
dpnp.greater_equal
138-
dpnp.less
139-
dpnp.less_equal
140-
dpnp.not_equal
141-
dpnp.equal
138+
greater
139+
greater_equal
140+
less
141+
less_equal
142+
not_equal
143+
equal
142144

143-
dpnp.logical_and
144-
dpnp.logical_or
145-
dpnp.logical_xor
146-
dpnp.logical_not
145+
logical_and
146+
logical_or
147+
logical_xor
148+
logical_not
147149

148-
dpnp.maximum
149-
dpnp.minimum
150-
dpnp.fmax
151-
dpnp.fmin
150+
maximum
151+
minimum
152+
fmax
153+
fmin
152154

153155

154156
Floating functions
@@ -158,18 +160,18 @@ Floating functions
158160
:toctree: generated/
159161
:nosignatures:
160162

161-
dpnp.isfinite
162-
dpnp.isinf
163-
dpnp.isnan
164-
dpnp.fabs
165-
dpnp.signbit
166-
dpnp.copysign
167-
dpnp.nextafter
168-
dpnp.spacing
169-
dpnp.modf
170-
dpnp.ldexp
171-
dpnp.frexp
172-
dpnp.fmod
173-
dpnp.floor
174-
dpnp.ceil
175-
dpnp.trunc
163+
isfinite
164+
isinf
165+
isnan
166+
fabs
167+
signbit
168+
copysign
169+
nextafter
170+
spacing
171+
modf
172+
ldexp
173+
frexp
174+
fmod
175+
floor
176+
ceil
177+
trunc

0 commit comments

Comments
 (0)