OptionType.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_OPTIONTYPE_H_
4 #define AWKWARD_OPTIONTYPE_H_
5 
6 #include "awkward/common.h"
7 #include "awkward/util.h"
8 #include "awkward/type/Type.h"
9 
10 namespace awkward {
19  public:
27  OptionType(const util::Parameters& parameters,
28  const std::string& typestr,
29  const TypePtr& type);
30 
32  const TypePtr
33  type() const;
34 
35  std::string
36  tostring_part(const std::string& indent,
37  const std::string& pre,
38  const std::string& post) const override;
39 
40  const TypePtr
41  shallow_copy() const override;
42 
43  bool
44  equal(const TypePtr& other, bool check_parameters) const override;
45 
46  int64_t
47  numfields() const override;
48 
49  int64_t
50  fieldindex(const std::string& key) const override;
51 
52  const std::string
53  key(int64_t fieldindex) const override;
54 
55  bool
56  haskey(const std::string& key) const override;
57 
58  const std::vector<std::string>
59  keys() const override;
60 
61  const ContentPtr
62  empty() const override;
63 
64  private:
66  const TypePtr type_;
67  };
68 }
69 
70 #endif // AWKWARD_OPTIONTYPE_H_
#define LIBAWKWARD_EXPORT_SYMBOL
Definition: common.h:45
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...
Definition: BitMaskedArray.h:15
Abstract superclass of all high level types (flat hierarchy).
Definition: Type.h:23
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.
Describes the high level type of data with possible missing values, represented by None in python...
Definition: OptionType.h:18
std::map< std::string, std::string > Parameters
Definition: util.h:165
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...
bool haskey(const RecordLookupPtr &recordlookup, const std::string &key, int64_t numfields)
Returns true if a RecordLookup has a given key; false otherwise.
std::shared_ptr< Type > TypePtr
Definition: Content.h:23
std::shared_ptr< Content > ContentPtr
Definition: ArrayBuilder.h:16