PDI 1.4.0-alpha.2021-08-04.09fd084

the PDI data interface

scalar_datatype.h
1 /*******************************************************************************
2  * Copyright (C) 2015-2019 Commissariat a l'energie atomique et aux energies alternatives (CEA)
3  * Copyright (C) 2020-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_SCALAR_DATATYPE_H_
27 #define PDI_SCALAR_DATATYPE_H_
28 
29 #include <functional>
30 #include <string>
31 
32 #include <pdi/pdi_fwd.h>
33 #include <pdi/datatype.h>
34 
35 
36 namespace PDI {
37 
38 class PDI_EXPORT Scalar_datatype:
39  public Datatype
40 {
42  size_t m_size;
43 
45  size_t m_dense_size;
46 
48  size_t m_align;
49 
51  Scalar_kind m_kind;
52 
54  std::function<void* (void*, const void*)> m_copy;
55 
57  std::function<void(void*)> m_destroy;
58 
59 public:
66  Scalar_datatype(Scalar_kind kind, size_t size, const Attributes_map& attributes = {});
67 
75  Scalar_datatype(Scalar_kind kind, size_t size, size_t align, const Attributes_map& attributes = {});
76 
86  Scalar_datatype(Scalar_kind kind, size_t size, size_t align, size_t dense_size, std::function<void* (void*, const void*)> copy, std::function<void(void*)> destroy, const Attributes_map& attributes = {});
87 
90  Scalar_kind kind() const;
91 
92  Datatype_template_uptr clone() const override;
93 
94  Datatype_uptr clone_type() const override;
95 
96  Datatype_uptr densify() const override;
97 
98  Datatype_uptr evaluate(Context&) const override;
99 
100  bool dense() const override;
101 
102  size_t datasize() const override;
103 
104  size_t buffersize() const override;
105 
106  size_t alignment() const override;
107 
108  bool simple() const override;
109 
110  void* data_to_dense_copy(void* to, const void* from) const override;
111 
112  void* data_from_dense_copy(void* to, const void* from) const override;
113 
114  void destroy_data(void* ptr) const override;
115 
116  std::string debug_string() const override;
117 
118  bool operator== (const Datatype&) const override;
119 
120 };
121 
123 
124 } // namespace PDI
125 
126 #endif // PDI_SCALAR_DATATYPE_H_
Definition: context.h:44
Definition: scalar_datatype.h:38
A Datatype is a Datatype_template that accepts no argument.
Definition: datatype.h:46
std::unique_ptr< Datatype_template > Datatype_template_uptr
Definition: pdi_fwd.h:70
std::unique_ptr< Datatype > Datatype_uptr
Definition: pdi_fwd.h:74
Scalar_kind
Different possible interpretations for a scalar.
Definition: pdi_fwd.h:97
std::unordered_map< std::string, Expression > Attributes_map
Definition: datatype_template.h:40
const Scalar_datatype UNDEF_TYPE
Definition: scalar_datatype.h:122
Definition: array_datatype.h:37