Loading...
Searching...
No Matches
ByteMaskedArrayBuilder.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_BYTEMASKEDARRAYBUILDER_H_
4#define AWKWARD_BYTEMASKEDARRAYBUILDER_H_
5
7
8namespace awkward {
9
13 template <typename T, typename I>
15 public:
18 const util::Parameters& parameters,
19 const std::string& form_key,
20 const std::string attribute = "mask",
21 const std::string partition = "0");
22
24 const std::string
25 classname() const override;
26
27 const std::string
28 to_buffers(BuffersContainer& container, const ForthOutputBufferMap& outputs) const override;
29
31 const std::string
32 vm_output() const override;
33
35 const std::string
36 vm_output_data() const override;
37
39 const std::string
40 vm_func() const override;
41
43 const std::string
44 vm_func_name() const override;
45
47 const std::string
48 vm_func_type() const override;
49
52 const std::string
53 vm_from_stack() const override;
54
56 const std::string
57 vm_error() const override;
58
60 void
61 boolean(bool x, LayoutBuilderPtr<T, I> builder) override;
62
64 void
65 int64(int64_t x, LayoutBuilderPtr<T, I> builder) override;
66
68 void
69 float64(double x, LayoutBuilderPtr<T, I> builder) override;
70
72 void
73 complex(std::complex<double> x, LayoutBuilderPtr<T, I> builder) override;
74
77 void
78 bytestring(const std::string& x, LayoutBuilderPtr<T, I> builder) override;
79
82 void
83 string(const std::string& x, LayoutBuilderPtr<T, I> builder) override;
84
86 void
88
90 void
92
93 const FormBuilderPtr<T, I> content() const { return content_; }
94
101 const util::Parameters&
102 form_parameters() const { return parameters_; }
103
104 ssize_t
105 len(const ForthOutputBufferMap& outputs) const override {
106 return content().get()->len(outputs);
107 }
108
109 private:
111 const FormBuilderPtr<T, I> content_;
112
114 const util::Parameters parameters_;
115
121 std::string vm_output_data_;
122 std::string vm_output_;
123 std::string vm_func_name_;
124 std::string vm_func_;
125 std::string vm_func_type_;
126 std::string vm_data_from_stack_;
127 std::string vm_error_;
128 };
129
130}
131
132#endif // AWKWARD_BYTEMASKEDARRAYBUILDER_H_
Abstract class to represent the output of ak.to_buffers. In Python, this would be a dict of NumPy arr...
Definition: Builder.h:20
Definition: ByteMaskedArrayBuilder.h:14
const std::string vm_output() const override
AwkwardForth virtual machine instructions of the data outputs.
void begin_list(LayoutBuilderPtr< T, I > builder) override
Begins building a nested list.
ssize_t len(const ForthOutputBufferMap &outputs) const override
The builder's output buffer length.
Definition: ByteMaskedArrayBuilder.h:105
void float64(double x, LayoutBuilderPtr< T, I > builder) override
Adds a real value x to the accumulated data.
const std::string to_buffers(BuffersContainer &container, const ForthOutputBufferMap &outputs) const override
Copy the current snapshot into the BuffersContainer and return a Form as a std::string (JSON).
void string(const std::string &x, LayoutBuilderPtr< T, I > builder) override
Adds a UTF-8 encoded bytestring x in STL format to the accumulated data.
void int64(int64_t x, LayoutBuilderPtr< T, I > builder) override
Adds an integer value x to the accumulated data.
const util::Parameters & form_parameters() const
String-to-JSON map that augments the meaning of this builder Form.
Definition: ByteMaskedArrayBuilder.h:102
const std::string vm_func_name() const override
The array builder VM function name.
const std::string vm_output_data() const override
The data output key.
const std::string vm_func() const override
AwkwardForth virtual machine instructions of the array builder function.
const FormBuilderPtr< T, I > content() const
Definition: ByteMaskedArrayBuilder.h:93
const std::string vm_func_type() const override
The array builder VM function type.
void boolean(bool x, LayoutBuilderPtr< T, I > builder) override
Adds a boolean value x to the accumulated data.
const std::string vm_error() const override
Error messages in the AwkwardForth virtual machine instructions.
void bytestring(const std::string &x, LayoutBuilderPtr< T, I > builder) override
Adds an unencoded bytestring x in STL format to the accumulated data.
void complex(std::complex< double > x, LayoutBuilderPtr< T, I > builder) override
Adds a complex value x to the accumulated data.
ByteMaskedArrayBuilder(const FormBuilderPtr< T, I > content, const util::Parameters &parameters, const std::string &form_key, const std::string attribute="mask", const std::string partition="0")
Creates a ByteMaskedArrayBuilder from a full set of parameters.
const std::string vm_from_stack() const override
AwkwardForth virtual machine instructions to retrieve the data from the VM stack.
void end_list(LayoutBuilderPtr< T, I > builder) override
Ends a nested list.
const std::string classname() const override
User-friendly name of this class.
Abstract base class for nodes within a LayoutBuilder Every builder will have an output buffer based o...
Definition: FormBuilder.h:30
User interface to the FormBuilder system: the LayoutBuilder is a fixed reference while the FormBuilde...
Definition: LayoutBuilder.h:62
#define LIBAWKWARD_EXPORT_SYMBOL
Definition: common.h:45
std::map< std::string, std::string > Parameters
Definition: util.h:165
Definition: BitMaskedArray.h:15
std::map< std::string, std::shared_ptr< ForthOutputBuffer > > ForthOutputBufferMap
Definition: FormBuilder.h:16
std::shared_ptr< FormBuilder< T, I > > FormBuilderPtr
Definition: FormBuilder.h:177