Loading...
Searching...
No Matches
ListArray.h
Go to the documentation of this file.
1// BSD 3-Clause License; see https://github.com/scikit-hep/awkward-1.0/blob/main/LICENSE
2
3#ifndef AWKWARD_LISTARRAY_H_
4#define AWKWARD_LISTARRAY_H_
5
6#include <memory>
7
8#include "awkward/common.h"
9#include "awkward/Index.h"
10#include "awkward/Identities.h"
11#include "awkward/Content.h"
12
13namespace awkward {
18 public:
21 ListForm(bool has_identities,
22 const util::Parameters& parameters,
23 const FormKey& form_key,
24 Index::Form starts,
25 Index::Form stops,
26 const FormPtr& content);
27
29 starts() const;
30
32 stops() const;
33
34 const FormPtr
35 content() const;
36
37 const TypePtr
38 type(const util::TypeStrs& typestrs) const override;
39
40 void
41 tojson_part(ToJson& builder, bool verbose) const override;
42
43 const FormPtr
44 shallow_copy() const override;
45
46 const FormPtr
47 with_form_key(const FormKey& form_key) const override;
48
49 const std::string
50 purelist_parameter(const std::string& key) const override;
51
52 bool
53 purelist_isregular() const override;
54
55 int64_t
56 purelist_depth() const override;
57
58 bool
59 dimension_optiontype() const override;
60
61 const std::pair<int64_t, int64_t>
62 minmax_depth() const override;
63
64 const std::pair<bool, int64_t>
65 branch_depth() const override;
66
67 int64_t
68 numfields() const override;
69
70 int64_t
71 fieldindex(const std::string& key) const override;
72
73 const std::string
74 key(int64_t fieldindex) const override;
75
76 bool
77 haskey(const std::string& key) const override;
78
79 const std::vector<std::string>
80 keys() const override;
81
82 bool
83 istuple() const override;
84
85 bool
86 equal(const FormPtr& other,
87 bool check_identities,
88 bool check_parameters,
89 bool check_form_key,
90 bool compatibility_check) const override;
91
92 const FormPtr
93 getitem_field(const std::string& key) const override;
94
95 const FormPtr
96 getitem_fields(const std::vector<std::string>& keys) const override;
97
98 private:
99 Index::Form starts_;
100 Index::Form stops_;
101 const FormPtr content_;
102 };
103
113 template <typename T>
114 class
115#ifdef AWKWARD_LISTARRAY_NO_EXTERN_TEMPLATE
117#endif
118 ListArrayOf: public Content {
119 public:
139 ListArrayOf<T>(const IdentitiesPtr& identities,
140 const util::Parameters& parameters,
141 const IndexOf<T>& starts,
142 const IndexOf<T>& stops,
143 const ContentPtr& content);
144
153 const IndexOf<T>
154 starts() const;
155
164 const IndexOf<T>
165 stops() const;
166
172 const ContentPtr
173 content() const;
174
182 Index64
183 compact_offsets64(bool start_at_zero) const;
184
194 const ContentPtr
195 broadcast_tooffsets64(const Index64& offsets) const;
196
204 const ContentPtr
206
219 const ContentPtr
220 toListOffsetArray64(bool start_at_zero) const;
221
224 const std::string
225 classname() const override;
226
227 void
228 setidentities() override;
229
230 void
231 setidentities(const IdentitiesPtr& identities) override;
232
233 const TypePtr
234 type(const util::TypeStrs& typestrs) const override;
235
236 const FormPtr
237 form(bool materialize) const override;
238
240 kernels() const override;
241
242 void
243 caches(std::vector<ArrayCachePtr>& out) const override;
244
245 const std::string
246 tostring_part(const std::string& indent,
247 const std::string& pre,
248 const std::string& post) const override;
249
250 void
251 tojson_part(ToJson& builder, bool include_beginendlist) const override;
252
253 void
254 nbytes_part(std::map<size_t, int64_t>& largest) const override;
255
259 int64_t
260 length() const override;
261
262 const ContentPtr
263 shallow_copy() const override;
264
265 const ContentPtr
266 deep_copy(bool copyarrays,
267 bool copyindexes,
268 bool copyidentities) const override;
269
270 void
271 check_for_iteration() const override;
272
273 const ContentPtr
274 getitem_nothing() const override;
275
276 const ContentPtr
277 getitem_at(int64_t at) const override;
278
279 const ContentPtr
280 getitem_at_nowrap(int64_t at) const override;
281
282 const ContentPtr
283 getitem_range(int64_t start, int64_t stop) const override;
284
285 const ContentPtr
286 getitem_range_nowrap(int64_t start, int64_t stop) const override;
287
288 const ContentPtr
289 getitem_field(const std::string& key) const override;
290
291 const ContentPtr
292 getitem_field(const std::string& key,
293 const Slice& only_fields) const override;
294
295 const ContentPtr
296 getitem_fields(const std::vector<std::string>& keys) const override;
297
298 const ContentPtr
299 getitem_fields(const std::vector<std::string>& keys,
300 const Slice& only_fields) const override;
301
302 const ContentPtr
303 carry(const Index64& carry, bool allow_lazy) const override;
304
305 int64_t
306 purelist_depth() const override;
307
308 const std::pair<int64_t, int64_t>
309 minmax_depth() const override;
310
311 const std::pair<bool, int64_t>
312 branch_depth() const override;
313
314 int64_t
315 numfields() const override;
316
317 int64_t
318 fieldindex(const std::string& key) const override;
319
320 const std::string
321 key(int64_t fieldindex) const override;
322
323 bool
324 haskey(const std::string& key) const override;
325
326 const std::vector<std::string>
327 keys() const override;
328
329 bool
330 istuple() const override;
331
332 // operations
333 const std::string
334 validityerror(const std::string& path) const override;
335
340 const ContentPtr
341 shallow_simplify() const override;
342
343 const ContentPtr
344 num(int64_t axis, int64_t depth) const override;
345
346 const std::pair<Index64, ContentPtr>
347 offsets_and_flattened(int64_t axis, int64_t depth) const override;
348
349 bool
350 mergeable(const ContentPtr& other, bool mergebool) const override;
351
352 bool
353 referentially_equal(const ContentPtr& other) const override;
354
355 const ContentPtr
356 mergemany(const ContentPtrVec& others) const override;
357
358 const SliceItemPtr
359 asslice() const override;
360
361 const ContentPtr
362 fillna(const ContentPtr& value) const override;
363
364 const ContentPtr
365 rpad(int64_t target, int64_t axis, int64_t depth) const override;
366
367 const ContentPtr
368 rpad_and_clip(int64_t target,
369 int64_t axis,
370 int64_t depth) const override;
371
372 const ContentPtr
373 reduce_next(const Reducer& reducer,
374 int64_t negaxis,
375 const Index64& starts,
376 const Index64& shifts,
377 const Index64& parents,
378 int64_t outlength,
379 bool mask,
380 bool keepdims) const override;
381
382 const ContentPtr
383 sort_next(int64_t negaxis,
384 const Index64& starts,
385 const Index64& parents,
386 int64_t outlength,
387 bool ascending,
388 bool stable) const override;
389
390 const ContentPtr
391 argsort_next(int64_t negaxis,
392 const Index64& starts,
393 const Index64& shifts,
394 const Index64& parents,
395 int64_t outlength,
396 bool ascending,
397 bool stable) const override;
398
399 const ContentPtr
400 localindex(int64_t axis, int64_t depth) const override;
401
402 const ContentPtr
403 combinations(int64_t n,
404 bool replacement,
405 const util::RecordLookupPtr& recordlookup,
406 const util::Parameters& parameters,
407 int64_t axis,
408 int64_t depth) const override;
409
410 const ContentPtr
412 const Slice& tail,
413 const Index64& advanced) const override;
414
415 const ContentPtr
417 const Slice& tail,
418 const Index64& advanced) const override;
419
420 const ContentPtr
422 const Slice& tail,
423 const Index64& advanced) const override;
424
425 const ContentPtr
427 const Slice& tail,
428 const Index64& advanced) const override;
429
430 const ContentPtr
431 getitem_next_jagged(const Index64& slicestarts,
432 const Index64& slicestops,
433 const SliceArray64& slicecontent,
434 const Slice& tail) const override;
435
436 const ContentPtr
437 getitem_next_jagged(const Index64& slicestarts,
438 const Index64& slicestops,
439 const SliceMissing64& slicecontent,
440 const Slice& tail) const override;
441
442 const ContentPtr
443 getitem_next_jagged(const Index64& slicestarts,
444 const Index64& slicestops,
445 const SliceJagged64& slicecontent,
446 const Slice& tail) const override;
447
448 const ContentPtr
449 copy_to(kernel::lib ptr_lib) const override;
450
451 const ContentPtr
452 numbers_to_type(const std::string& name) const override;
453
455 bool
456 is_unique() const override;
457
459 const ContentPtr
460 unique() const override;
461
463 bool
464 is_subrange_equal(const Index64& start, const Index64& stop) const override;
465
466 private:
468 const IndexOf<T> starts_;
470 const IndexOf<T> stops_;
472 const ContentPtr content_;
473 };
474
475#ifndef AWKWARD_LISTARRAY_NO_EXTERN_TEMPLATE
476 extern template class ListArrayOf<int32_t>;
477 extern template class ListArrayOf<uint32_t>;
478 extern template class ListArrayOf<int64_t>;
479#endif
480
484}
485
486#endif // AWKWARD_LISTARRAY_H_
Abstract superclass of all array node types (flat hierarchy). Any Content can be nested within any ot...
Definition: Content.h:276
Abstract superclass of all array node forms, which expresses the nesting structure without any large ...
Definition: Content.h:39
A contiguous, one-dimensional array of integers used to represent data structures,...
Definition: Index.h:82
Form
Integer type of an Index, used by ListForm, IndexedForm, etc.
Definition: Index.h:34
Represents an array of nested lists that can have different lengths using two indexes named starts an...
Definition: ListArray.h:118
int64_t purelist_depth() const override
The list-depth of this array, not counting any contained within a RecordArray.
const ContentPtr argsort_next(int64_t negaxis, const Index64 &starts, const Index64 &shifts, const Index64 &parents, int64_t outlength, bool ascending, bool stable) const override
This array sorted indices.
void caches(std::vector< ArrayCachePtr > &out) const override
Accumulates all the unique #ArrayCache objects from nested #VirtualArray nodes. (Uniqueness is determ...
const ContentPtr getitem_fields(const std::vector< std::string > &keys) const override
This array with the first nested RecordArray replaced by a RecordArray of a given subset of keys.
const ContentPtr getitem_next_jagged(const Index64 &slicestarts, const Index64 &slicestops, const SliceArray64 &slicecontent, const Slice &tail) const override
Internal function that propagates a jagged array (array with irregular-length dimensions) slice throu...
const ContentPtr getitem_at(int64_t at) const override
Returns the element at a given position in the array, handling negative indexing and bounds-checking ...
void setidentities() override
Assign a surrogate index of Identities to this array (in-place).
const ContentPtr toRegularArray() const
Converts this array to a RegularArray if all nested lists have the same size (error otherwise).
const ContentPtr getitem_field(const std::string &key, const Slice &only_fields) const override
const ContentPtr getitem_next(const SliceArray64 &array, const Slice &tail, const Index64 &advanced) const override
Internal function that propagates a generic getitem request through one axis (including advanced inde...
const ContentPtr unique() const override
Returns an array where all components are unique.
const ContentPtr sort_next(int64_t negaxis, const Index64 &starts, const Index64 &parents, int64_t outlength, bool ascending, bool stable) const override
This array sorted.
const IndexOf< T > stops() const
Positions where each nested list stops in the content.
void tojson_part(ToJson &builder, bool include_beginendlist) const override
Internal function to produce a JSON representation one node at a time.
const ContentPtr getitem_fields(const std::vector< std::string > &keys, const Slice &only_fields) const override
int64_t length() const override
The number of elements in the array.
const ContentPtr deep_copy(bool copyarrays, bool copyindexes, bool copyidentities) const override
Copies this node and all nodes hierarchically nested within it, optionally copying the associated arr...
const std::string validityerror(const std::string &path) const override
Returns an error message if this array is invalid; otherwise, returns an empty string.
const ContentPtr getitem_next(const SliceAt &at, const Slice &tail, const Index64 &advanced) const override
Internal function that propagates a generic getitem request through one axis (including advanced inde...
bool istuple() const override
Returns true if the outermost RecordArray is a tuple.
const IndexOf< T > starts() const
Positions where each nested list starts in the content.
const ContentPtr getitem_nothing() const override
Internal function to get an empty slice (with the correct type).
kernel::lib kernels() const override
Returns the kernel library enum for all nested ptr_lib within the array's tree structure....
const ContentPtr carry(const Index64 &carry, bool allow_lazy) const override
Returns an array of the same type with elements filtered, rearranged, and possibly duplicated by the ...
const ContentPtr combinations(int64_t n, bool replacement, const util::RecordLookupPtr &recordlookup, const util::Parameters &parameters, int64_t axis, int64_t depth) const override
Tuples or records of all n-tuple combinations of list items at some axis depth.
void setidentities(const IdentitiesPtr &identities) override
Assign a specified set of Identities to this array (in-place).
const ContentPtr toListOffsetArray64(bool start_at_zero) const
Returns this array as a ListOffsetArray with 64-bit offsets and possibly starting with offsets[0] = 0...
const ContentPtr localindex(int64_t axis, int64_t depth) const override
A (possibly nested) array of integers indicating the positions of elements within each nested list.
const ContentPtr getitem_range_nowrap(int64_t start, int64_t stop) const override
Subinterval of this array, without handling negative indexing or bounds-checking.
const std::pair< Index64, ContentPtr > offsets_and_flattened(int64_t axis, int64_t depth) const override
Returns (a) an offsets Index and (b) a flattened version of the array at some axis depth.
int64_t fieldindex(const std::string &key) const override
The position of a tuple or record key name if this array contains a RecordArray.
void check_for_iteration() const override
Performs up-front validity checks on an array so that they don't have to be checked in getitem_at_now...
const std::vector< std::string > keys() const override
A list of RecordArray keys or an empty list if this array does not contain a RecordArray.
const ContentPtr getitem_field(const std::string &key) const override
This array with the first nested RecordArray replaced by the field at key.
const std::pair< bool, int64_t > branch_depth() const override
Returns (a) whether the list-depth of this array "branches," or differs when followed through differe...
const ContentPtr rpad(int64_t target, int64_t axis, int64_t depth) const override
If axis = 0, returns a view of this array padded on the right with None values to have a minimum leng...
const ContentPtr getitem_at_nowrap(int64_t at) const override
Returns the element at a given position in the array, without handling negative indexing or bounds-ch...
void nbytes_part(std::map< size_t, int64_t > &largest) const override
Internal function used to calculate nbytes.
const ContentPtr mergemany(const ContentPtrVec &others) const override
Returns an array with this and the others concatenated (in order, this first, others last).
const std::string key(int64_t fieldindex) const override
The record name associated with a given field index or the tuple index as a string (e....
const ContentPtr shallow_copy() const override
Copies this node without copying any nodes hierarchically nested within it or any array/index/identit...
const std::pair< int64_t, int64_t > minmax_depth() const override
Returns (a) the minimum list-depth and (b) the maximum list-depth of the array, which can differ if t...
bool is_unique() const override
Returns 'true' if all components of the array are unique.
const FormPtr form(bool materialize) const override
Low-level Form describing all the features of this array except the actual data buffers (Index,...
const SliceItemPtr asslice() const override
Converts this array into a SliceItem that can be used in getitem.
const std::string tostring_part(const std::string &indent, const std::string &pre, const std::string &post) const override
Internal function to build an output string for tostring.
const ContentPtr rpad_and_clip(int64_t target, int64_t axis, int64_t depth) const override
If axis = 0, returns a view of this array padded on the right.
const ContentPtr getitem_next(const SliceJagged64 &jagged, const Slice &tail, const Index64 &advanced) const override
Internal function that propagates a generic getitem request through one axis (including advanced inde...
const ContentPtr getitem_range(int64_t start, int64_t stop) const override
Subinterval of this array, handling negative indexing and bounds-checking like Python.
bool is_subrange_equal(const Index64 &start, const Index64 &stop) const override
Returns 'true' if subranges are equal.
const ContentPtr fillna(const ContentPtr &value) const override
Returns this array with None values replaced by a given value.
int64_t numfields() const override
The number of fields in the first nested tuple or records or -1 if this array does not contain a Reco...
bool referentially_equal(const ContentPtr &other) const override
Returns true if this array has all the same buffers and parameters as other; false otherwise.
const TypePtr type(const util::TypeStrs &typestrs) const override
High-level Type describing this array.
const ContentPtr num(int64_t axis, int64_t depth) const override
The length of this array (as a NumpyArray scalar) if axis = 0 or the lengths of subarrays (as an arra...
const ContentPtr broadcast_tooffsets64(const Index64 &offsets) const
Moves content elements if necessary to match a given set of offsets and return a ListOffsetArray that...
bool mergeable(const ContentPtr &other, bool mergebool) const override
Returns true if this array can be merged with the other; false otherwise.
Index64 compact_offsets64(bool start_at_zero) const
Returns 64-bit offsets, possibly starting with offsets[0] = 0, that would represent this array's star...
bool haskey(const std::string &key) const override
Returns true if the array contains a RecordArray with the specified key; false otherwise.
const ContentPtr getitem_next_jagged(const Index64 &slicestarts, const Index64 &slicestops, const SliceJagged64 &slicecontent, const Slice &tail) const override
Internal function that propagates a jagged array (array with irregular-length dimensions) slice throu...
const ContentPtr getitem_next_jagged(const Index64 &slicestarts, const Index64 &slicestops, const SliceMissing64 &slicecontent, const Slice &tail) const override
Internal function that propagates a jagged array (array with irregular-length dimensions) slice throu...
const ContentPtr getitem_next(const SliceRange &range, const Slice &tail, const Index64 &advanced) const override
Internal function that propagates a generic getitem request through one axis (including advanced inde...
const ContentPtr shallow_simplify() const override
Returns an equivalent array simplified at one level only using simplify_optiontype if an option-type ...
const ContentPtr content() const
Data referenced by the starts and stops to build nested lists.
const ContentPtr reduce_next(const Reducer &reducer, int64_t negaxis, const Index64 &starts, const Index64 &shifts, const Index64 &parents, int64_t outlength, bool mask, bool keepdims) const override
This array with one axis removed by applying a Reducer (e.g. "sum", "max", "any", "all).
const ContentPtr numbers_to_type(const std::string &name) const override
Change the leaf types to 'totype'.
const std::string classname() const override
User-friendly name of this class: "ListArray32", "ListArrayU32", or "ListArray64".
const ContentPtr copy_to(kernel::lib ptr_lib) const override
Recursively copies components of the array from main memory to a GPU (if ptr_lib == kernel::lib::cuda...
Form describing ListArray.
Definition: ListArray.h:17
int64_t purelist_depth() const override
The list-depth of this array, not counting any contained within a RecordForm.
const FormPtr with_form_key(const FormKey &form_key) const override
Copies this node, adding or replacing a form_key.
bool equal(const FormPtr &other, bool check_identities, bool check_parameters, bool check_form_key, bool compatibility_check) const override
Returns true if this Form is equal to the other Form; false otherwise.
Index::Form stops() const
bool istuple() const override
Returns true if the outermost RecordArray is a tuple.
const FormPtr shallow_copy() const override
Copies this node without copying any nodes hierarchically nested within it.
void tojson_part(ToJson &builder, bool verbose) const override
Internal function to produce a JSON representation one node at a time.
const FormPtr getitem_fields(const std::vector< std::string > &keys) const override
Returns the Form that would result from a fields-slice.
Index::Form starts() const
int64_t fieldindex(const std::string &key) const override
The position of a tuple or record key name if this array contains a RecordForm.
const std::vector< std::string > keys() const override
A list of RecordArray keys or an empty list if this array does not contain a RecordArray.
const std::pair< bool, int64_t > branch_depth() const override
Returns (a) whether the list-depth of this array "branches," or differs when followed through differe...
const std::string key(int64_t fieldindex) const override
The record name associated with a given field index or the tuple index as a string (e....
ListForm(bool has_identities, const util::Parameters &parameters, const FormKey &form_key, Index::Form starts, Index::Form stops, const FormPtr &content)
Creates a ListForm. See LinkArray for documentation.
const std::pair< int64_t, int64_t > minmax_depth() const override
Returns (a) the minimum list-depth and (b) the maximum list-depth of the array, which can differ if t...
const FormPtr content() const
const FormPtr getitem_field(const std::string &key) const override
Returns the Form that would result from a field-slice.
int64_t numfields() const override
The number of fields in the first nested tuple or records or -1 if this array does not contain a Reco...
const TypePtr type(const util::TypeStrs &typestrs) const override
High-level Type describing this Form.
const std::string purelist_parameter(const std::string &key) const override
The parameter associated with key at the first level that has a non-null value, descending only as de...
bool haskey(const std::string &key) const override
Returns true if the array contains a RecordForm with the specified key; false otherwise.
bool purelist_isregular() const override
Returns true if all nested lists down to the first RecordForm are RegularForm nodes; false otherwise.
bool dimension_optiontype() const override
Returns true if this dimension has option-type; false otherwise.
Abstract class for all reducer algorithms.
Definition: Reducer.h:20
Represents an array of integers in a slice (possibly converted from an array of booleans).
Definition: Slice.h:229
Represents an integer in a tuple of slices passed to __getitem__ in Python.
Definition: Slice.h:58
Represents an array of nested lists, where the content may be SliceArrayOf, SliceMissingOf,...
Definition: Slice.h:515
Represents a SliceArrayOf, SliceMissingOf, or SliceJaggedOf with missing values: None (no equivalent ...
Definition: Slice.h:435
Represents a Python slice object (usual syntax: array[start:stop:step]).
Definition: Slice.h:93
A sequence of SliceItem objects representing a tuple passed to Python's __getitem__.
Definition: Slice.h:585
Definition: json.h:21
#define LIBAWKWARD_EXPORT_SYMBOL
Definition: common.h:45
lib
Definition: kernel-dispatch.h:20
std::map< std::string, std::string > Parameters
Definition: util.h:165
std::shared_ptr< RecordLookup > RecordLookupPtr
Definition: util.h:130
std::map< std::string, std::string > TypeStrs
Definition: util.h:215
Definition: BitMaskedArray.h:15
std::shared_ptr< std::string > FormKey
Definition: Content.h:19
std::vector< std::shared_ptr< Content > > ContentPtrVec
Definition: Content.h:16
std::shared_ptr< SliceItem > SliceItemPtr
Definition: Slice.h:15
std::shared_ptr< Content > ContentPtr
Definition: Content.h:15
std::shared_ptr< Form > FormPtr
Definition: Content.h:18
std::shared_ptr< Type > TypePtr
Definition: Content.h:23
std::shared_ptr< Identities > IdentitiesPtr
Definition: Identities.h:16