BitMaskedArray.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_BITMASKEDARRAY_H_
4 #define AWKWARD_BITMASKEDARRAY_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/Index.h"
13 #include "awkward/Content.h"
14 
15 namespace awkward {
16  template <typename T, bool ISOPTION>
17  class IndexedArrayOf;
18 
19  class ByteMaskedArray;
20 
24  class LIBAWKWARD_EXPORT_SYMBOL BitMaskedForm: public Form {
25  public:
27  BitMaskedForm(bool has_identities,
28  const util::Parameters& parameters,
29  const FormKey& form_key,
30  Index::Form mask,
31  const FormPtr& content,
32  bool valid_when,
33  bool lsb_order);
34 
35  Index::Form
36  mask() const;
37 
38  const FormPtr
39  content() const;
40 
41  bool
42  valid_when() const;
43 
44  bool
45  lsb_order() const;
46 
47  const TypePtr
48  type(const util::TypeStrs& typestrs) const override;
49 
50  void
51  tojson_part(ToJson& builder, bool verbose) const override;
52 
53  const FormPtr
54  shallow_copy() const override;
55 
56  const FormPtr
57  with_form_key(const FormKey& form_key) const override;
58 
59  const std::string
60  purelist_parameter(const std::string& key) const override;
61 
62  bool
63  purelist_isregular() const override;
64 
65  int64_t
66  purelist_depth() const override;
67 
68  bool
69  dimension_optiontype() const override;
70 
71  const std::pair<int64_t, int64_t>
72  minmax_depth() const override;
73 
74  const std::pair<bool, int64_t>
75  branch_depth() const override;
76 
77  int64_t
78  numfields() const override;
79 
80  int64_t
81  fieldindex(const std::string& key) const override;
82 
83  const std::string
84  key(int64_t fieldindex) const override;
85 
86  bool
87  haskey(const std::string& key) const override;
88 
89  const std::vector<std::string>
90  keys() const override;
91 
92  bool
93  istuple() const override;
94 
95  bool
96  equal(const FormPtr& other,
97  bool check_identities,
98  bool check_parameters,
99  bool check_form_key,
100  bool compatibility_check) const override;
101 
102  virtual const FormPtr
103  getitem_range() const override;
104 
105  const FormPtr
106  getitem_field(const std::string& key) const override;
107 
108  const FormPtr
109  getitem_fields(const std::vector<std::string>& keys) const override;
110 
111  const FormPtr
112  simplify_optiontype() const;
113 
114  private:
115  Index::Form mask_;
116  const FormPtr content_;
117  bool valid_when_;
118  bool lsb_order_;
119  };
120 
127  class LIBAWKWARD_EXPORT_SYMBOL BitMaskedArray: public Content {
128  public:
155  BitMaskedArray(const IdentitiesPtr& identities,
156  const util::Parameters& parameters,
157  const IndexU8& mask,
158  const ContentPtr& content,
159  bool valid_when,
160  int64_t length,
161  bool lsb_order);
162 
169  const IndexU8
170  mask() const;
171 
174  const ContentPtr
175  content() const;
176 
181  bool
182  valid_when() const;
183 
190  bool
191  lsb_order() const;
192 
195  const ContentPtr
196  project() const;
197 
202  const ContentPtr
203  project(const Index8& mask) const;
204 
208  const Index8
209  bytemask() const;
210 
216  const ContentPtr
217  simplify_optiontype() const;
218 
220  const std::shared_ptr<ByteMaskedArray>
221  toByteMaskedArray() const;
222 
225  const std::shared_ptr<IndexedArrayOf<int64_t, true>>
226  toIndexedOptionArray64() const;
227 
229  const std::string
230  classname() const override;
231 
232  void
233  setidentities() override;
234 
235  void
236  setidentities(const IdentitiesPtr& identities) override;
237 
238  const TypePtr
239  type(const util::TypeStrs& typestrs) const override;
240 
241  const FormPtr
242  form(bool materialize) const override;
243 
244  kernel::lib
245  kernels() const override;
246 
247  void
248  caches(std::vector<ArrayCachePtr>& out) const override;
249 
250  const std::string
251  tostring_part(const std::string& indent,
252  const std::string& pre,
253  const std::string& post) const override;
254 
255  void
256  tojson_part(ToJson& builder, bool include_beginendlist) const override;
257 
258  void
259  nbytes_part(std::map<size_t, int64_t>& largest) const override;
260 
264  int64_t
265  length() const override;
266 
267  const ContentPtr
268  shallow_copy() const override;
269 
270  const ContentPtr
271  deep_copy(bool copyarrays,
272  bool copyindexes,
273  bool copyidentities) const override;
274 
275  void
276  check_for_iteration() const override;
277 
278  const ContentPtr
279  getitem_nothing() const override;
280 
281  const ContentPtr
282  getitem_at(int64_t at) const override;
283 
284  const ContentPtr
285  getitem_at_nowrap(int64_t at) const override;
286 
287  const ContentPtr
288  getitem_range(int64_t start, int64_t stop) const override;
289 
290  const ContentPtr
291  getitem_range_nowrap(int64_t start, int64_t stop) const override;
292 
293  const ContentPtr
294  getitem_field(const std::string& key) const override;
295 
296  const ContentPtr
297  getitem_field(const std::string& key,
298  const Slice& only_fields) const override;
299 
300  const ContentPtr
301  getitem_fields(const std::vector<std::string>& keys) const override;
302 
303  const ContentPtr
304  getitem_fields(const std::vector<std::string>& keys,
305  const Slice& only_fields) const override;
306 
307  const ContentPtr
308  getitem_next(const SliceItemPtr& head,
309  const Slice& tail,
310  const Index64& advanced) const override;
311 
312  const ContentPtr
313  carry(const Index64& carry, bool allow_lazy) const override;
314 
315  int64_t
316  purelist_depth() const override;
317 
318  const std::pair<int64_t, int64_t>
319  minmax_depth() const override;
320 
321  const std::pair<bool, int64_t>
322  branch_depth() const override;
323 
324  int64_t
325  numfields() const override;
326 
327  int64_t
328  fieldindex(const std::string& key) const override;
329 
330  const std::string
331  key(int64_t fieldindex) const override;
332 
333  bool
334  haskey(const std::string& key) const override;
335 
336  const std::vector<std::string>
337  keys() const override;
338 
339  bool
340  istuple() const override;
341 
342  // operations
343  const std::string
344  validityerror(const std::string& path) const override;
345 
349  const ContentPtr
350  shallow_simplify() const override;
351 
352  const ContentPtr
353  num(int64_t axis, int64_t depth) const override;
354 
355  const std::pair<Index64, ContentPtr>
356  offsets_and_flattened(int64_t axis, int64_t depth) const override;
357 
358  bool
359  mergeable(const ContentPtr& other, bool mergebool) const override;
360 
361  bool
362  referentially_equal(const ContentPtr& other) const override;
363 
364  const ContentPtr
365  reverse_merge(const ContentPtr& other) const override;
366 
367  const ContentPtr
368  mergemany(const ContentPtrVec& others) const override;
369 
370  const SliceItemPtr
371  asslice() const override;
372 
373  const ContentPtr
374  fillna(const ContentPtr& value) const override;
375 
376  const ContentPtr
377  rpad(int64_t target, int64_t axis, int64_t depth) const override;
378 
379  const ContentPtr
380  rpad_and_clip(int64_t target,
381  int64_t axis,
382  int64_t depth) const override;
383 
384  const ContentPtr
385  reduce_next(const Reducer& reducer,
386  int64_t negaxis,
387  const Index64& starts,
388  const Index64& shifts,
389  const Index64& parents,
390  int64_t outlength,
391  bool mask,
392  bool keepdims) const override;
393 
394  const ContentPtr
395  sort_next(int64_t negaxis,
396  const Index64& starts,
397  const Index64& parents,
398  int64_t outlength,
399  bool ascending,
400  bool stable) const override;
401 
402  const ContentPtr
403  argsort_next(int64_t negaxis,
404  const Index64& starts,
405  const Index64& shifts,
406  const Index64& parents,
407  int64_t outlength,
408  bool ascending,
409  bool stable) const override;
410 
411  const ContentPtr
412  localindex(int64_t axis, int64_t depth) const override;
413 
414  const ContentPtr
415  combinations(int64_t n,
416  bool replacement,
417  const util::RecordLookupPtr& recordlookup,
418  const util::Parameters& parameters,
419  int64_t axis,
420  int64_t depth) const override;
421 
422  const ContentPtr
423  getitem_next(const SliceAt& at,
424  const Slice& tail,
425  const Index64& advanced) const override;
426 
427  const ContentPtr
428  getitem_next(const SliceRange& range,
429  const Slice& tail,
430  const Index64& advanced) const override;
431 
432  const ContentPtr
433  getitem_next(const SliceArray64& array,
434  const Slice& tail,
435  const Index64& advanced) const override;
436 
437  const ContentPtr
438  getitem_next(const SliceJagged64& jagged,
439  const Slice& tail,
440  const Index64& advanced) const override;
441 
442  const ContentPtr
443  getitem_next_jagged(const Index64& slicestarts,
444  const Index64& slicestops,
445  const SliceArray64& slicecontent,
446  const Slice& tail) const override;
447 
448  const ContentPtr
449  getitem_next_jagged(const Index64& slicestarts,
450  const Index64& slicestops,
451  const SliceMissing64& slicecontent,
452  const Slice& tail) const override;
453 
454  const ContentPtr
455  getitem_next_jagged(const Index64& slicestarts,
456  const Index64& slicestops,
457  const SliceJagged64& slicecontent,
458  const Slice& tail) const override;
459 
460  const ContentPtr
461  copy_to(kernel::lib ptr_lib) const override;
462 
463  const ContentPtr
464  numbers_to_type(const std::string& name) const override;
465 
467  bool
468  is_unique() const override;
469 
471  const ContentPtr
472  unique() const override;
473 
475  bool
476  is_subrange_equal(const Index64& start, const Index64& stop) const override;
477 
478  private:
480  const IndexU8 mask_;
482  const ContentPtr content_;
484  const bool valid_when_;
486  const int64_t length_;
488  const bool lsb_order_;
489  };
490 
491 }
492 
493 #endif // AWKWARD_BITMASKEDARRAY_H_
awkward::SliceRange
Represents a Python slice object (usual syntax: array[start:stop:step]).
Definition: Slice.h:93
LIBAWKWARD_EXPORT_SYMBOL
#define LIBAWKWARD_EXPORT_SYMBOL
Definition: common.h:45
awkward::util::key
const std::string key(const RecordLookupPtr &recordlookup, int64_t fieldindex, int64_t numfields)
Returns the key associated with a field index, given a RecordLookup and a number of fields...
awkward::Content
Abstract superclass of all array node types (flat hierarchy). Any Content can be nested within any ot...
Definition: Content.h:276
awkward::ToJson
Definition: json.h:19
awkward
Definition: BitMaskedArray.h:15
awkward::IndexOf
A contiguous, one-dimensional array of integers used to represent data structures, rather than numerical data in the arrays themselves.
Definition: Index.h:16
awkward::util::name
std::string name(Mapping a, V value)
Definition: datetime_util.h:39
awkward::BitMaskedForm
Form describing BitMaskedArray.
Definition: BitMaskedArray.h:24
awkward::SliceMissingOf
Represents a SliceArrayOf, SliceMissingOf, or SliceJaggedOf with missing values: None (no equivalent ...
Definition: Slice.h:431
Content.h
awkward::Reducer
Abstract class for all reducer algorithms.
Definition: Reducer.h:20
awkward::kernel::combinations
ERROR combinations(kernel::lib ptr_lib, T *toindex, int64_t n, bool replacement, int64_t singlelen)
awkward::util::keys
const std::vector< std::string > keys(const RecordLookupPtr &recordlookup, int64_t numfields)
Returns a given RecordLookup as keys or generate anonymous ones form a number of fields.
awkward::IndexedArrayOf
Filters, rearranges, and/or duplicates items in its content through an index, which has the same effe...
Definition: BitMaskedArray.h:17
awkward::Index::Form
Form
Integer type of an Index, used by ListForm, IndexedForm, etc.
Definition: Index.h:34
awkward::FormKey
std::shared_ptr< std::string > FormKey
Definition: Content.h:19
awkward::kernel::unique
ERROR unique(kernel::lib ptr_lib, T *toptr, int64_t length, int64_t *tolength)
awkward::SliceArrayOf
Represents an array of integers in a slice (possibly converted from an array of booleans).
Definition: Slice.h:225
awkward::util::Parameters
std::map< std::string, std::string > Parameters
Definition: util.h:165
awkward::kernel::copy_to
ERROR copy_to(kernel::lib to_lib, kernel::lib from_lib, void *to_ptr, void *from_ptr, int64_t bytelength)
Internal Function an array buffer from library FROM to library TO, usually between main memory and a ...
awkward::FormPtr
std::shared_ptr< Form > FormPtr
Definition: Content.h:18
awkward::util::fieldindex
int64_t fieldindex(const RecordLookupPtr &recordlookup, const std::string &key, int64_t numfields)
Returns the field index associated with a key, given a RecordLookup and a number of fields...
awkward::SliceJaggedOf
Represents an array of nested lists, where the content may be SliceArrayOf, SliceMissingOf, or SliceJaggedOf (no equivalent in NumPy).
Definition: Slice.h:511
awkward::ContentPtrVec
std::vector< std::shared_ptr< Content > > ContentPtrVec
Definition: Content.h:16
awkward::util::value
Mapping::value_type::value_type value(Mapping a, const std::string &name)
Definition: datetime_util.h:49
awkward::Slice
A sequence of SliceItem objects representing a tuple passed to Python&#39;s __getitem__.
Definition: Slice.h:585
awkward::util::haskey
bool haskey(const RecordLookupPtr &recordlookup, const std::string &key, int64_t numfields)
Returns true if a RecordLookup has a given key; false otherwise.
awkward::TypePtr
std::shared_ptr< Type > TypePtr
Definition: Content.h:23
awkward::util::RecordLookupPtr
std::shared_ptr< RecordLookup > RecordLookupPtr
Definition: util.h:130
awkward::SliceAt
Represents an integer in a tuple of slices passed to __getitem__ in Python.
Definition: Slice.h:58
awkward::util::TypeStrs
std::map< std::string, std::string > TypeStrs
Definition: util.h:215
awkward::Form
Abstract superclass of all array node forms, which expresses the nesting structure without any large ...
Definition: Content.h:39
awkward::BitMaskedArray
Represents potentially missing data by overlaying a bit mask over its content.
Definition: BitMaskedArray.h:127
awkward::IdentitiesPtr
std::shared_ptr< Identities > IdentitiesPtr
Definition: Identities.h:16
awkward::ContentPtr
std::shared_ptr< Content > ContentPtr
Definition: ArrayBuilder.h:16
awkward::ByteMaskedArray
Represents potentially missing data by overlaying a byte mask over its content.
Definition: ByteMaskedArray.h:117
awkward::SliceItemPtr
std::shared_ptr< SliceItem > SliceItemPtr
Definition: Slice.h:15
awkward::kernel::lib
lib
Definition: kernel-dispatch.h:20