10000 Merge pull request #23509 from F3eQnxN3RriK/doc-npy-types · seiko2plus/numpy@40bb77e · GitHub
[go: up one dir, main page]
Skip to content

Commit 40bb77e

Browse files
charrischarris
authored
Merge pull request numpy#23509 from F3eQnxN3RriK/doc-npy-types
DOC: Fix a structure in `NPY_TYPES`
2 parents 2f84f0d + b086f1c commit 40bb77e

File tree

1 file changed

+97
-97
lines changed

1 file changed

+97
-97
lines changed

‎doc/source/reference/c-api/dtype.rst

Lines changed: 97 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -25,161 +25,161 @@ select the precision desired.
2525
Enumerated Types
2626
----------------
2727

28-
.. c:enumerator:: NPY_TYPES
28+
.. c:enum:: NPY_TYPES
2929
30-
There is a list of enumerated types defined providing the basic 24
31-
data types plus some useful generic names. Whenever the code requires
32-
a type number, one of these enumerated types is requested. The types
33-
are all called ``NPY_{NAME}``:
30+
There is a list of enumerated types defined providing the basic 24
31+
data types plus some useful generic names. Whenever the code requires
32+
a type number, one of these enumerated types is requested. The types
33+
are all called ``NPY_{NAME}``:
3434

35-
.. c:enumerator:: NPY_BOOL
35+
.. c:enumerator:: NPY_BOOL
3636
37-
The enumeration value for the boolean type, stored as one byte.
38-
It may only be set to the values 0 and 1.
37+
The enumeration value for the boolean type, stored as one byte.
38+
It may only be set to the values 0 and 1.
3939

40-
.. c:enumerator:: NPY_BYTE
41-
.. c:enumerator:: NPY_INT8
40+
.. c:enumerator:: NPY_BYTE
41+
.. c:enumerator:: NPY_INT8
4242
43-
The enumeration value for an 8-bit/1-byte signed integer.
43+
The enumeration value for an 8-bit/1-byte signed integer.
4444

45-
.. c:enumerator:: NPY_SHORT
46-
.. c:enumerator:: NPY_INT16
45+
.. c:enumerator:: NPY_SHORT
46+
.. c:enumerator:: NPY_INT16
4747
48-
The enumeration value for a 16-bit/2-byte signed integer.
48+
The enumeration value for a 16-bit/2-byte signed integer.
4949

50-
.. c:enumerator:: NPY_INT
51-
.. c:enumerator:: NPY_INT32
50+
.. c:enumerator:: NPY_INT
51+
.. c:enumerator:: NPY_INT32
5252
53-
The enumeration value for a 32-bit/4-byte signed integer.
53+
The enumeration value for a 32-bit/4-byte signed integer.
5454

55-
.. c:enumerator:: NPY_LONG
55+
.. c:enumerator:: NPY_LONG
5656
57-
Equivalent to either NPY_INT or NPY_LONGLONG, depending on the
58-
platform.
57+
Equivalent to either NPY_INT or NPY_LONGLONG, depending on the
58+
platform.
5959

60-
.. c:enumerator:: NPY_LONGLONG
61-
.. c:enumerator:: NPY_INT64
60+
.. c:enumerator:: NPY_LONGLONG
61+
.. c:enumerator:: NPY_INT64
6262
63-
The enumeration value for a 64-bit/8-byte signed integer.
63+
The enumeration value for a 64-bit/8-byte signed integer.
6464

65-
.. c:enumerator:: NPY_UBYTE
66-
.. c:enumerator:: NPY_UINT8
65+
.. c:enumerator:: NPY_UBYTE
66+
.. c:enumerator:: NPY_UINT8
6767
68-
The enumeration value for an 8-bit/1-byte unsigned integer.
68+
The enumeration value for an 8-bit/1-byte unsigned integer.
6969

70-
.. c:enumerator:: NPY_USHORT
71-
.. c:enumerator:: NPY_UINT16
70+
.. c:enumerator:: NPY_USHORT
71+
.. c:enumerator:: NPY_UINT16
7272
73-
The enumeration value for a 16-bit/2-byte unsigned integer.
73+
The enumeration value for a 16-bit/2-byte unsigned integer.
7474

75-
.. c:enumerator:: NPY_UINT
76-
.. c:enumerator:: NPY_UINT32
75+
.. c:enumerator:: NPY_UINT
76+
.. c:enumerator:: NPY_UINT32
7777
78-
The enumeration value for a 32-bit/4-byte unsigned integer.
78+
The enumeration value for a 32-bit/4-byte unsigned integer.
7979

80-
.. c:enumerator:: NPY_ULONG
80+
.. c:enumerator:: NPY_ULONG
8181
82-
Equivalent to either NPY_UINT or NPY_ULONGLONG, depending on the
83-
platform.
82+
Equivalent to either NPY_UINT or NPY_ULONGLONG, depending on the
83+
platform.
8484

85-
.. c:enumerator:: NPY_ULONGLONG
86-
.. c:enumerator:: NPY_UINT64
85+
.. c:enumerator:: NPY_ULONGLONG
86+
.. c:enumerator:: NPY_UINT64
8787
88-
The enumeration value for a 64-bit/8-byte unsigned integer.
88+
The enumeration value for a 64-bit/8-byte unsigned integer.
8989

90-
.. c:enumerator:: NPY_HALF
91-
.. c:enumerator:: NPY_FLOAT16
90+
.. c:enumerator:: NPY_HALF
91+
.. c:enumerator:: NPY_FLOAT16
9292
93-
The enumeration value for a 16-bit/2-byte IEEE 754-2008 compatible floating
94-
point type.
93+
The enumeration value for a 16-bit/2-byte IEEE 754-2008 compatible floating
94+
point type.
9595

96-
.. c:enumerator:: NPY_FLOAT
97-
.. c:enumerator:: NPY_FLOAT32
96+
.. c:enumerator:: NPY_FLOAT
97+
.. c:enumerator:: NPY_FLOAT32
9898
99-
The enumeration value for a 32-bit/4-byte IEEE 754 compatible floating
100-
point type.
99+
The enumeration value for a 32-bit/4-byte IEEE 754 compatible floating
100+
point type.
101101

102-
.. c:enumerator:: NPY_DOUBLE
103-
.. c:enumerator:: NPY_FLOAT64
102+
.. c:enumerator:: NPY_DOUBLE
103+
.. c:enumerator:: NPY_FLOAT64
104104
105-
The enumeration value for a 64-bit/8-byte IEEE 754 compatible floating
106-
point type.
105+
The enumeration value for a 64-bit/8-byte IEEE 754 compatible floating
106+
point type.
107107

108-
.. c:enumerator:: NPY_LONGDOUBLE
108+
.. c:enumerator:: NPY_LONGDOUBLE
109109
110-
The enumeration value for a platform-specific floating point type which is
111-
at least as large as NPY_DOUBLE, but larger on many platforms.
110+
The enumeration value for a platform-specific floating point type which is
111+
at least as large as NPY_DOUBLE, but larger on many platforms.
112112

113-
.. c:enumerator:: NPY_CFLOAT
114-
.. c:enumerator:: NPY_COMPLEX64
113+
.. c:enumerator:: NPY_CFLOAT
114+
.. c:enumerator:: NPY_COMPLEX64
115115
116-
The enumeration value for a 64-bit/8-byte complex type made up of
117-
two NPY_FLOAT values.
116+
The enumeration value for a 64-bit/8-byte complex type made up of
117+
two NPY_FLOAT values.
118118

119-
.. c:enumerator:: NPY_CDOUBLE
120-
.. c:enumerator:: NPY_COMPLEX128
119+
.. c:enumerator:: NPY_CDOUBLE
120+
.. c:enumerator:: NPY_COMPLEX128
121121
122-
The enumeration value for a 128-bit/16-byte complex type made up of
123-
two NPY_DOUBLE values.
122+
The enumeration value for a 128-bit/16-byte complex type made up of
123+
two NPY_DOUBLE values.
124124

125-
.. c:enumerator:: NPY_CLONGDOUBLE
125+
.. c:enumerator:: NPY_CLONGDOUBLE
126126
127-
The enumeration value for a platform-specific complex floating point
128-
type which is made up of two NPY_LONGDOUBLE values.
127+
The enumeration value for a platform-specific complex floating point
128+
type which is made up of two NPY_LONGDOUBLE values.
129129

130-
.. c:enumerator:: NPY_DATETIME
130+
.. c:enumerator:: NPY_DATETIME
131131
132-
The enumeration value for a data type which holds dates or datetimes with
133-
a precision based on selectable date or time units.
132+
The enumeration value for a data type which holds dates or datetimes with
133+
a precision based on selectable date or time units.
134134

135-
.. c:enumerator:: NPY_TIMEDELTA
135+
.. c:enumerator:: NPY_TIMEDELTA
136136
137-
The enumeration value for a data type which holds lengths of times in
138-
integers of selectable date or time units.
137+
The enumeration value for a data type which holds lengths of times in
138+
integers of selectable date or time units.
139139

140-
.. c:enumerator:: NPY_STRING
140+
.. c:enumerator:: NPY_STRING
141141
142-
The enumeration value for ASCII strings of a selectable size. The
143-
strings have a fixed maximum size within a given array.
142+
The enumeration value for ASCII strings of a selectable size. The
143+
strings have a fixed maximum size within a given array.
144144

145-
.. c:enumerator:: NPY_UNICODE
145+
.. c:enumerator:: NPY_UNICODE
146146
147-
The enumeration value for UCS4 strings of a selectable size. The
148-
strings have a fixed maximum size within a given array.
147+
The enumeration value for UCS4 strings of a selectable size. The
148+
strings have a fixed maximum size within a given array.
149149

150-
.. c:enumerator:: NPY_OBJECT
150+
.. c:enumerator:: NPY_OBJECT
151151
152-
The enumeration value for references to arbitrary Python objects.
152+
The enumeration value for references to arbitrary Python objects.
153153

154-
.. c:enumerator:: NPY_VOID
154+
.. c:enumerator:: NPY_VOID
155155
156-
Primarily used to hold struct dtypes, but can contain arbitrary
157-
binary data.
156+
Primarily used to hold struct dtypes, but can contain arbitrary
157+
binary data.
158158

159-
Some useful aliases of the above types are
159+
Some useful aliases of the above types are
160160

161-
.. c:enumerator:: NPY_INTP
161+
.. c:enumerator:: NPY_INTP
162162
163-
The enumeration value for a signed integer type which is the same
164-
size as a (void \*) pointer. This is the type used by all
165-
arrays of indices.
163+
The enumeration value for a signed integer type which is the same
164+
size as a (void \*) pointer. This is the type used by all
165+
arrays of indices.
166166

167-
.. c:enumerator:: NPY_UINTP
167+
.. c:enumerator:: NPY_UINTP
168168
169-
The enumeration value for an unsigned integer type which is the
170-
same size as a (void \*) pointer.
169+
The enumeration value for an unsigned integer type which is the
170+
same size as a (void \*) pointer.
171171

172-
.. c:enumerator:: NPY_MASK
172+
.. c:enumerator:: NPY_MASK
173173
174-
The enumeration value of the type used for masks, such as with
175-
the :c:data:`NPY_ITER_ARRAYMASK` iterator flag. This is equivalent
176-
to :c:data:`NPY_UINT8`.
174+
The enumeration value of the type used for masks, such as with
175+
the :c:data:`NPY_ITER_ARRAYMASK` iterator flag. This is equivalent
176+
to :c:data:`NPY_UINT8`.
177177

178-
.. c:enumerator:: NPY_DEFAULT_TYPE
178+
.. c:enumerator:: NPY_DEFAULT_TYPE
179179
180-
The default type to use when no dtype is explicitly specified, for
181-
example when calling np.zero(shape). This is equivalent to
182-
:c:data:`NPY_DOUBLE`.
180+
The default type to use when no dtype is explicitly specified, for
181+
example when calling np.zero(shape). This is equivalent to
182+
:c:data:`NPY_DOUBLE`.
183183

184184
Other useful related constants are
185185

0 commit comments

Comments
 (0)
0