1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
.. toctree::
:caption: High-level data types
generated/ak.Array
generated/ak.Record
.. toctree::
:caption: Converting untyped data
generated/ak.from_iter
generated/ak.to_list
generated/ak.from_json
generated/ak.to_json
.. toctree::
:caption: Converting rectangular arrays
generated/ak.from_numpy
generated/ak.to_numpy
generated/ak.from_cupy
generated/ak.to_cupy
generated/ak.from_dlpack
generated/ak.from_jax
generated/ak.to_jax
.. toctree::
:caption: Reading and writing files
generated/ak.from_parquet
generated/ak.metadata_from_parquet
generated/ak.to_parquet
generated/ak.to_parquet_dataset
generated/ak.to_parquet_row_groups
generated/ak.from_arrow
generated/ak.from_arrow_schema
generated/ak.to_arrow
generated/ak.to_arrow_table
generated/ak.from_feather
generated/ak.to_feather
generated/ak.from_avro_file
.. toctree::
:caption: Conversions for machine learning
generated/ak.from_raggedtensor
generated/ak.to_raggedtensor
generated/ak.from_tensorflow
generated/ak.to_tensorflow
generated/ak.from_torch
generated/ak.to_torch
.. toctree::
:caption: Converting to Pandas DataFrames
generated/ak.to_dataframe
.. toctree::
:caption: Converting ROOT RDataFrames
generated/ak.from_rdataframe
generated/ak.to_rdataframe
.. toctree::
:caption: Append-only builder
generated/ak.ArrayBuilder
.. toctree::
:caption: Low-level conversion primitives
generated/ak.from_buffers
generated/ak.to_buffers
generated/ak.to_packed
generated/ak.copy
.. toctree::
:caption: Materializing virtual arrays
generated/ak.materialize
.. toctree::
:caption: Validity checking
generated/ak.is_valid
generated/ak.validity_error
.. toctree::
:caption: Restructuring records (columns)
generated/ak.zip
generated/ak.zip_no_broadcast
generated/ak.unzip
generated/ak.merge_union_of_records
generated/ak.merge_option_of_records
.. toctree::
:caption: Merging arrays (rows)
generated/ak.concatenate
generated/ak.where
.. toctree::
:caption: Flattening lists and missing values
generated/ak.flatten
generated/ak.unflatten
generated/ak.ravel
.. toctree::
:caption: Lengths of lists
generated/ak.num
generated/ak.count
.. toctree::
:caption: Reducers
generated/ak.count_nonzero
generated/ak.sum
generated/ak.nansum
generated/ak.prod
generated/ak.nanprod
generated/ak.any
generated/ak.all
.. toctree::
:caption: Minimum and maximum
generated/ak.min
generated/ak.nanmin
generated/ak.max
generated/ak.nanmax
generated/ak.argmin
generated/ak.nanargmin
generated/ak.argmax
generated/ak.nanargmax
.. toctree::
:caption: Descriptive statistics
generated/ak.moment
generated/ak.mean
generated/ak.nanmean
generated/ak.var
generated/ak.nanvar
generated/ak.std
generated/ak.nanstd
generated/ak.covar
generated/ak.corr
generated/ak.linear_fit
generated/ak.ptp
generated/ak.softmax
.. toctree::
:caption: Sorting
generated/ak.sort
generated/ak.argsort
.. toctree::
:caption: Missing value handling
generated/ak.mask
generated/ak.is_none
generated/ak.drop_none
generated/ak.pad_none
generated/ak.fill_none
generated/ak.firsts
generated/ak.singletons
.. toctree::
:caption: Ragged and regular dimensions
generated/ak.from_regular
generated/ak.to_regular
.. toctree::
:caption: Broadcasting
generated/ak.broadcast_arrays
generated/ak.broadcast_fields
.. toctree::
:caption: Combinatorics ("for loop" replacements)
generated/ak.cartesian
generated/ak.argcartesian
generated/ak.combinations
generated/ak.argcombinations
.. toctree::
:caption: String predicates
generated/ak.str.is_alnum
generated/ak.str.is_alpha
generated/ak.str.is_ascii
generated/ak.str.is_decimal
generated/ak.str.is_digit
generated/ak.str.is_lower
generated/ak.str.is_numeric
generated/ak.str.is_printable
generated/ak.str.is_space
generated/ak.str.is_title
generated/ak.str.is_upper
.. toctree::
:caption: String transforms
generated/ak.str.capitalize
generated/ak.str.length
generated/ak.str.lower
generated/ak.str.repeat
generated/ak.str.replace_slice
generated/ak.str.replace_substring
generated/ak.str.replace_substring_regex
generated/ak.str.reverse
generated/ak.str.swapcase
generated/ak.str.title
generated/ak.str.upper
.. toctree::
:caption: String padding and trimming
generated/ak.str.center
generated/ak.str.lpad
generated/ak.str.rpad
generated/ak.str.ltrim
generated/ak.str.ltrim_whitespace
generated/ak.str.rtrim
generated/ak.str.rtrim_whitespace
generated/ak.str.trim
generated/ak.str.trim_whitespace
.. toctree::
:caption: String splitting and joining
generated/ak.str.split_pattern
generated/ak.str.split_pattern_regex
generated/ak.str.split_whitespace
generated/ak.str.join
generated/ak.str.join_element_wise
.. toctree::
:caption: String slicing and decomposition
generated/ak.str.slice
generated/ak.str.extract_regex
.. toctree::
:caption: String containment tests
generated/ak.str.count_substring
generated/ak.str.count_substring_regex
generated/ak.str.ends_with
generated/ak.str.find_substring
generated/ak.str.find_substring_regex
generated/ak.str.index_in
generated/ak.str.is_in
generated/ak.str.match_like
generated/ak.str.match_substring
generated/ak.str.match_substring_regex
generated/ak.str.starts_with
.. toctree::
:caption: Value and type conversions
generated/ak.enforce_type
generated/ak.nan_to_none
generated/ak.nan_to_num
generated/ak.values_astype
generated/ak.strings_astype
.. toctree::
:caption: Arrays of categorical data
generated/ak.from_categorical
generated/ak.is_categorical
generated/ak.categories
generated/ak.str.to_categorical
.. toctree::
:caption: Indexing and grouping
generated/ak.local_index
generated/ak.run_lengths
.. toctree::
:caption: Extracting type metadata
generated/ak.type
generated/ak.parameters
generated/ak.fields
generated/ak.is_tuple
.. toctree::
:caption: Manipulating type metadata
generated/ak.with_name
generated/ak.with_field
generated/ak.without_field
generated/ak.with_parameter
generated/ak.without_parameters
generated/ak.with_named_axis
generated/ak.without_named_axis
.. toctree::
:caption: Overriding behavior
ak.behavior
generated/ak.mixin_class
generated/ak.mixin_class_method
.. toctree::
:caption: Computational backends
generated/ak.to_backend
generated/ak.backend
.. toctree::
:caption: Approximation and comparison
generated/ak.round
generated/ak.isclose
generated/ak.almost_equal
generated/ak.array_equal
.. toctree::
:caption: NumPy compatibility
generated/ak.real
generated/ak.imag
generated/ak.angle
generated/ak.zeros_like
generated/ak.ones_like
generated/ak.full_like
.. toctree::
:caption: Third-party integration
generated/ak.numba.register_and_check
generated/ak.jax.assert_registered
generated/ak.jax.import_jax
generated/ak.jax.register_and_check
generated/ak.jax.register_behavior_class
.. toctree::
:caption: High-level data types
generated/ak.types.Type
generated/ak.types.ArrayType
generated/ak.types.ScalarType
generated/ak.types.ListType
generated/ak.types.NumpyType
generated/ak.types.OptionType
generated/ak.types.RecordType
generated/ak.types.RegularType
generated/ak.types.UnionType
generated/ak.types.UnknownType
generated/ak.types.from_datashape
generated/ak.types.is_primitive
generated/ak.types.primitive_to_dtype
generated/ak.types.dtype_to_primitive
.. toctree::
:caption: Low-level array layouts
generated/ak.contents.Content
generated/ak.contents.BitMaskedArray
generated/ak.contents.ByteMaskedArray
generated/ak.contents.EmptyArray
generated/ak.contents.IndexedArray
generated/ak.contents.IndexedOptionArray
generated/ak.contents.ListArray
generated/ak.contents.ListOffsetArray
generated/ak.contents.NumpyArray
generated/ak.contents.RecordArray
generated/ak.contents.RegularArray
generated/ak.contents.UnionArray
generated/ak.contents.UnmaskedArray
generated/ak.record.Record
generated/ak.to_layout
generated/ak.transform
.. toctree::
:caption: Index for layout nodes
generated/ak.index.Index
generated/ak.index.Index8
generated/ak.index.IndexU8
generated/ak.index.Index32
generated/ak.index.IndexU32
generated/ak.index.Index64
.. toctree::
:caption: Low-level types: "forms"
generated/ak.forms.Form
generated/ak.forms.BitMaskedForm
generated/ak.forms.ByteMaskedForm
generated/ak.forms.EmptyForm
generated/ak.forms.IndexedForm
generated/ak.forms.IndexedOptionForm
generated/ak.forms.ListForm
generated/ak.forms.ListOffsetForm
generated/ak.forms.NumpyForm
generated/ak.forms.RecordForm
generated/ak.forms.RegularForm
generated/ak.forms.UnionForm
generated/ak.forms.UnmaskedForm
generated/ak.forms.from_dict
generated/ak.forms.from_json
generated/ak.forms.from_type
.. toctree::
:caption: Low-level data ingest
:maxdepth: 1
awkwardforth
.. toctree::
:caption: Low-level kernels
:maxdepth: 1
generated/kernels
|
