PDI 1.6.0-alpha.2022-04-22.b70acbf

the PDI data interface

tuple_datatype.h
1/*******************************************************************************
2 * Copyright (C) 2021 Commissariat a l'energie atomique et aux energies alternatives (CEA)
3 * Copyright (C) 2021 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of CEA nor the names of its contributors may be used to
14 * endorse or promote products derived from this software without specific
15 * prior written permission.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 ******************************************************************************/
25
26#ifndef PDI_TUPLE_DATATYPE_H_
27#define PDI_TUPLE_DATATYPE_H_
28
29#include <string>
30#include <vector>
31
32#include <pdi/pdi_fwd.h>
33#include <pdi/datatype.h>
34
35
36namespace PDI {
37
42class PDI_EXPORT Tuple_datatype:
43 public Datatype
44{
45 // Required to make_shared due to private ctor
46 struct Shared_enabler;
47
48public:
51 class Element
52 {
54 size_t m_offset;
55
57 Datatype_sptr m_type;
58
59 public:
65 Element(size_t offset, Datatype_sptr type);
66
71 Element(const Element& o);
72
77 size_t offset() const;
78
84
90 bool operator==(const Element& rhs) const;
91
97 bool operator!=(const Element& rhs) const;
98
99 };
100
101private:
103 std::vector<Element> m_elements;
104
106 size_t m_buffersize;
107
108public:
111 const std::vector<Element>& elements() const;
112
116 size_t size() const;
117
118 Datatype_sptr densify() const override;
119
121
122 bool dense() const override;
123
124 size_t datasize() const override;
125
126 size_t buffersize() const override;
127
128 size_t alignment() const override;
129
130 bool simple() const override;
131
132 void* data_to_dense_copy(void*, const void*) const override;
133
134 void* data_from_dense_copy(void*, const void*) const override;
135
136 Datatype_sptr index ( size_t ) const override;
137
138 std::pair<void*, Datatype_sptr> index ( size_t, void* ) const override;
139
140 Datatype_sptr slice ( size_t, size_t ) const override;
141
142 std::pair<void*, Datatype_sptr> slice ( size_t, size_t, void* ) const override;
143
144 void destroy_data(void*) const override;
145
146 std::string debug_string() const override;
147
148 bool operator== (const Datatype&) const override;
149
150private:
158 Tuple_datatype(std::vector<Element> elements, size_t buffersize, const Attributes_map& attributes = {});
159
160public:
168 static std::shared_ptr<Tuple_datatype> make(std::vector<Element> elements, size_t buffersize, const Attributes_map& attributes = {});
169
170};
171
172} // namespace PDI
173
174#endif // PDI_TUPLE_DATATYPE_H_
Definition: context.h:45
A Datatype is a Datatype_template that accepts no argument.
Definition: datatype.h:49
A Element is one of the elements inside a Tuple_datatype.
Definition: tuple_datatype.h:52
bool operator!=(const Element &rhs) const
Tests another element for inequality.
Datatype_sptr type() const
Access the type of the contained element.
bool operator==(const Element &rhs) const
Tests another element for equality.
size_t offset() const
Access the offset in byte from the Tuple_datatype start.
Element(size_t offset, Datatype_sptr type)
Construct a new element.
Element(const Element &o)
Construct a new element by copy.
A Tuple_datatype is a Datatype that represents a fixed number of elements of potentially different ty...
Definition: tuple_datatype.h:44
Datatype_sptr evaluate(Context &) const override
Creates a new datatype by resolving the value of all metadata references.
Datatype_sptr densify() const override
Creates a new datatype as the dense copy of this one.
bool simple() const override
Tells if data can be copied as bytes (if type is dense) and doesn't need a destroyer.
Datatype_sptr index(size_t) const override
Access the type of the element at the provided index.
bool dense() const override
Indicate if the datatype is dense or not.
void * data_from_dense_copy(void *, const void *) const override
Creates a sparse deep copy of dense data.
void * data_to_dense_copy(void *, const void *) const override
Creates a dense deep copy of data.
std::pair< void *, Datatype_sptr > index(size_t, void *) const override
Access the type and value of the element at the provided index.
static std::shared_ptr< Tuple_datatype > make(std::vector< Element > elements, size_t buffersize, const Attributes_map &attributes={})
Constructs a new Tuple_datatype.
size_t alignment() const override
Returns the required alignment for a type.
size_t datasize() const override
Computes the data size of a type, excluding potentially unused memory from a sparse type.
std::string debug_string() const override
Returns the datatype yaml representation as a string.
size_t size() const
Number of elements of the tuple.
Datatype_sptr slice(size_t, size_t) const override
Access the type of the elements slice between the provided indices.
size_t buffersize() const override
Computes the data size of a type, including potentially unused memory from a sparse type.
std::pair< void *, Datatype_sptr > slice(size_t, size_t, void *) const override
Access the type and value of the elements slice between the provided indices.
void destroy_data(void *) const override
Delete data whose type is described by the Datatype.
const std::vector< Element > & elements() const
Accesses the elements in increasing offset order.
Definition: array_datatype.h:38
std::unordered_map< std::string, Expression > Attributes_map
Definition: datatype_template.h:40
std::shared_ptr< const Datatype > Datatype_sptr
Definition: pdi_fwd.h:78