Awkward Array: include/awkward/type/PrimitiveType.h Source File

Loading...
Searching...
No Matches
PrimitiveType.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_PRIMITIVETYPE_H_
4#define AWKWARD_PRIMITIVETYPE_H_
5
6#include "awkward/common.h"
7#include "awkward/util.h"
8#include "awkward/type/Type.h"
9
10namespace awkward {
17 class LIBAWKWARD_EXPORT_SYMBOL PrimitiveType: public Type {
18 public:
26 PrimitiveType(const util::Parameters& parameters,
27 const std::string& typestr, util::dtype dtype);
28
30 util::dtype
31 dtype() const;
32
33 std::string
34 tostring_part(const std::string& indent,
35 const std::string& pre,
36 const std::string& post) const override;
37
38 const TypePtr
39 shallow_copy() const override;
40
41 bool
42 equal(const TypePtr& other, bool check_parameters) const override;
43
44 int64_t
45 numfields() const override;
46
47 int64_t
48 fieldindex(const std::string& key) const override;
49
50 const std::string
51 key(int64_t fieldindex) const override;
52
53 bool
54 haskey(const std::string& key) const override;
55
56 const std::vector<std::string>
57 keys() const override;
58
59 const ContentPtr
60 empty() const override;
61
62 private:
64 const util::dtype dtype_;
65 };
66
67}
68
69#endif // AWKWARD_PRIMITIVETYPE_H_
Type.h
awkward::PrimitiveType
Describes the high level type of an array that contains fixed-size items, such as numbers or booleans...
Definition: PrimitiveType.h:17
awkward::PrimitiveType::tostring_part
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.
awkward::PrimitiveType::shallow_copy
const TypePtr shallow_copy() const override
Copies this Type without copying any hierarchically nested types.
awkward::PrimitiveType::PrimitiveType
PrimitiveType(const util::Parameters &parameters, const std::string &typestr, util::dtype dtype)
awkward::PrimitiveType::fieldindex
int64_t fieldindex(const std::string &key) const override
The position of a tuple or record key name if this array contains a RecordType.
awkward::PrimitiveType::empty
const ContentPtr empty() const override
Returns an empty array (Content) with this type.
awkward::PrimitiveType::keys
const std::vector< std::string > keys() const override
A list of RecordType keys or an empty list if this type does not contain a RecordType.
awkward::PrimitiveType::key
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....
awkward::PrimitiveType::dtype
util::dtype dtype() const
The tag that defines this PrimitiveType.
awkward::PrimitiveType::numfields
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...
awkward::PrimitiveType::haskey
bool haskey(const std::string &key) const override
Returns true if the type contains a RecordType with the specified key; false otherwise.
awkward::PrimitiveType::equal
bool equal(const TypePtr &other, bool check_parameters) const override
Returns true if this type is equal to other; false otherwise.
awkward::Type
Abstract superclass of all high level types (flat hierarchy).
Definition: Type.h:23
common.h
LIBAWKWARD_EXPORT_SYMBOL
#define LIBAWKWARD_EXPORT_SYMBOL
Definition: common.h:45
awkward::util::Parameters
std::map< std::string, std::string > Parameters
Definition: util.h:165
awkward::util::dtype
dtype
NumPy dtypes that can be interpreted within Awkward C++ (only the primitive, fixed-width types)....
Definition: util.h:26
awkward
Definition: BitMaskedArray.h:15
awkward::ContentPtr
std::shared_ptr< Content > ContentPtr
Definition: Content.h:15
awkward::TypePtr
std::shared_ptr< Type > TypePtr
Definition: Content.h:23
util.h