Loading...
Searching...
No Matches
EmptyArray.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_EMPTYARRAY_H_
4#define AWKWARD_EMPTYARRAY_H_
5
6#include <string>
7#include <memory>
8#include <vector>
9
10#include "awkward/common.h"
11#include "awkward/Slice.h"
12#include "awkward/Content.h"
13
14namespace awkward {
15 class NumpyArray;
16
21 public:
23 EmptyForm(bool has_identities,
24 const util::Parameters& parameters,
25 const FormKey& form_key);
26
27 const TypePtr
28 type(const util::TypeStrs& typestrs) const override;
29
30 void
31 tojson_part(ToJson& builder, bool verbose) const override;
32
33 const FormPtr
34 shallow_copy() const override;
35
36 const FormPtr
37 with_form_key(const FormKey& form_key) const override;
38
39 const std::string
40 purelist_parameter(const std::string& key) const override;
41
42 bool
43 purelist_isregular() const override;
44
45 int64_t
46 purelist_depth() const override;
47
48 bool
49 dimension_optiontype() const override;
50
51 const std::pair<int64_t, int64_t>
52 minmax_depth() const override;
53
54 const std::pair<bool, int64_t>
55 branch_depth() const override;
56
57 int64_t
58 numfields() const override;
59
60 int64_t
61 fieldindex(const std::string& key) const override;
62
63 const std::string
64 key(int64_t fieldindex) const override;
65
66 bool
67 haskey(const std::string& key) const override;
68
69 const std::vector<std::string>
70 keys() const override;
71
72 bool
73 istuple() const override;
74
75 bool
76 equal(const FormPtr& other,
77 bool check_identities,
78 bool check_parameters,
79 bool check_form_key,
80 bool compatibility_check) const override;
81
82 const FormPtr
83 getitem_field(const std::string& key) const override;
84
85 const FormPtr
86 getitem_fields(const std::vector<std::string>& keys) const override;
87
88 };
89
97 public:
104 EmptyArray(const IdentitiesPtr& identities,
105 const util::Parameters& parameters);
106
109 const std::shared_ptr<NumpyArray>
110 toNumpyArray(const std::string& format,
111 ssize_t itemsize,
112 util::dtype npdtype) const;
113
115 const std::string
116 classname() const override;
117
118 void
119 setidentities() override;
120
121 void
122 setidentities(const IdentitiesPtr& identities) override;
123
124 const TypePtr
125 type(const util::TypeStrs& typestrs) const override;
126
127 const FormPtr
128 form(bool materialize) const override;
129
131 kernels() const override;
132
133 void
134 caches(std::vector<ArrayCachePtr>& out) const override;
135
136 const std::string
137 tostring_part(const std::string& indent,
138 const std::string& pre,
139 const std::string& post) const override;
140
141 void
142 tojson_part(ToJson& builder, bool include_beginendlist) const override;
143
144 void
145 nbytes_part(std::map<size_t, int64_t>& largest) const override;
146
147 int64_t
148 length() const override;
149
150 const ContentPtr
151 shallow_copy() const override;
152
153 const ContentPtr
154 deep_copy(bool copyarrays,
155 bool copyindexes,
156 bool copyidentities) const override;
157
158 void
159 check_for_iteration() const override;
160
161 const ContentPtr
162 getitem_nothing() const override;
163
164 const ContentPtr
165 getitem_at(int64_t at) const override;
166
167 const ContentPtr
168 getitem_at_nowrap(int64_t at) const override;
169
170 const ContentPtr
171 getitem_range(int64_t start, int64_t stop) const override;
172
173 const ContentPtr
174 getitem_range_nowrap(int64_t start, int64_t stop) const override;
175
176 const ContentPtr
177 getitem_field(const std::string& key) const override;
178
179 const ContentPtr
180 getitem_field(const std::string& key,
181 const Slice& only_fields) const override;
182
183 const ContentPtr
184 getitem_fields(const std::vector<std::string>& keys) const override;
185
186 const ContentPtr
187 getitem_fields(const std::vector<std::string>& keys,
188 const Slice& only_fields) const override;
189
190 const ContentPtr
191 carry(const Index64& carry, bool allow_lazy) const override;
192
193 int64_t
194 purelist_depth() const override;
195
196 const std::pair<int64_t, int64_t>
197 minmax_depth() const override;
198
199 const std::pair<bool, int64_t>
200 branch_depth() const override;
201
202 int64_t
203 numfields() const override;
204
205 int64_t
206 fieldindex(const std::string& key) const override;
207
208 const std::string
209 key(int64_t fieldindex) const override;
210
211 bool
212 haskey(const std::string& key) const override;
213
214 const std::vector<std::string>
215 keys() const override;
216
217 bool
218 istuple() const override;
219
220 // operations
221 const std::string
222 validityerror(const std::string& path) const override;
223
227 const ContentPtr
228 shallow_simplify() const override;
229
230 const ContentPtr
231 num(int64_t axis, int64_t depth) const override;
232
233 const std::pair<Index64, ContentPtr>
234 offsets_and_flattened(int64_t axis, int64_t depth) const override;
235
236 bool
237 mergeable(const ContentPtr& other, bool mergebool) const override;
238
239 bool
240 referentially_equal(const ContentPtr& other) const override;
241
242 const ContentPtr
243 mergemany(const ContentPtrVec& others) const override;
244
245 const SliceItemPtr
246 asslice() const override;
247
248 const ContentPtr
249 fillna(const ContentPtr& value) const override;
250
251 const ContentPtr
252 rpad(int64_t target, int64_t axis, int64_t depth) const override;
253
254 const ContentPtr
255 rpad_and_clip(int64_t target,
256 int64_t axis,
257 int64_t depth) const override;
258
259 const ContentPtr
260 reduce_next(const Reducer& reducer,
261 int64_t negaxis,
262 const Index64& starts,
263 const Index64& shifts,
264 const Index64& parents,
265 int64_t outlength,
266 bool mask,
267 bool keepdims) const override;
268
269 const ContentPtr
270 sort_next(int64_t negaxis,
271 const Index64& starts,
272 const Index64& parents,
273 int64_t outlength,
274 bool ascending,
275 bool stable) const override;
276
277 const ContentPtr
278 argsort_next(int64_t negaxis,
279 const Index64& starts,
280 const Index64& shifts,
281 const Index64& parents,
282 int64_t outlength,
283 bool ascending,
284 bool stable) const override;
285
286 const ContentPtr
287 localindex(int64_t axis, int64_t depth) const override;
288
289 const ContentPtr
290 combinations(int64_t n,
291 bool replacement,
292 const util::RecordLookupPtr& recordlookup,
293 const util::Parameters& parameters,
294 int64_t axis,
295 int64_t depth) const override;
296
297 const ContentPtr
299 const Slice& tail,
300 const Index64& advanced) const override;
301
302 const ContentPtr
304 const Slice& tail,
305 const Index64& advanced) const override;
306
307 const ContentPtr
309 const Slice& tail,
310 const Index64& advanced) const override;
311
312 const ContentPtr
314 const Slice& tail,
315 const Index64& advanced) const override;
316
317 const ContentPtr
319 const Slice& tail,
320 const Index64& advanced) const override;
321
322 const ContentPtr
324 const Slice& tail,
325 const Index64& advanced) const override;
326
327 const ContentPtr
328 getitem_next_jagged(const Index64& slicestarts,
329 const Index64& slicestops,
330 const SliceArray64& slicecontent,
331 const Slice& tail) const override;
332
333 const ContentPtr
334 getitem_next_jagged(const Index64& slicestarts,
335 const Index64& slicestops,
336 const SliceMissing64& slicecontent,
337 const Slice& tail) const override;
338
339 const ContentPtr
340 getitem_next_jagged(const Index64& slicestarts,
341 const Index64& slicestops,
342 const SliceJagged64& slicecontent,
343 const Slice& tail) const override;
344
345 const ContentPtr
346 copy_to(kernel::lib ptr_lib) const override;
347
348 const ContentPtr
349 numbers_to_type(const std::string& name) const override;
350
352 bool
353 is_unique() const override;
354
356 const ContentPtr
357 unique() const override;
358
360 bool
361 is_subrange_equal(const Index64& start, const Index64& stop) const override;
362
363 };
364
365}
366
367#endif // AWKWARD_EMPTYARRAY_H_
Abstract superclass of all array node types (flat hierarchy). Any Content can be nested within any ot...
Definition: Content.h:276
Represents an array with length zero and (perhaps as a consequence) UnknownType.
Definition: EmptyArray.h:96
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 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.
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 ContentPtr getitem_next(const SliceField &field, 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_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....
EmptyArray(const IdentitiesPtr &identities, const util::Parameters &parameters)
Creates an EmptyArray from a full set of parameters.
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 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.
const std::shared_ptr< NumpyArray > toNumpyArray(const std::string &format, ssize_t itemsize, util::dtype npdtype) const
Converts this array into a NumpyArray with a given {NumpyArray::format format}.
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 getitem_next(const SliceFields &fields, const Slice &tail, const Index64 &advanced) const override
Internal function that propagates a generic getitem request through one axis (including advanced inde...
bool mergeable(const ContentPtr &other, bool mergebool) const override
Returns true if this array can be merged with the other; false otherwise.
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 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: "EmptyArray".
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 EmptyArray.
Definition: EmptyArray.h:20
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.
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.
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....
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 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.
EmptyForm(bool has_identities, const util::Parameters &parameters, const FormKey &form_key)
Creates a EmptyForm. See EmptyArray for documentation.
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 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
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 a single string in a slice tuple, indicating that a RecordArray should be replaced by one ...
Definition: Slice.h:340
Definition: Slice.h:384
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
dtype
NumPy dtypes that can be interpreted within Awkward C++ (only the primitive, fixed-width types)....
Definition: util.h:26
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