spla
array.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of spla project */
3 /* https://github.com/JetBrains-Research/spla */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2023 SparseLinearAlgebra */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef SPLA_ARRAY_HPP
29 #define SPLA_ARRAY_HPP
30 
31 #include "config.hpp"
32 #include "memview.hpp"
33 #include "object.hpp"
34 #include "type.hpp"
35 
36 namespace spla {
37 
50  class Array : public Object {
51  public:
52  SPLA_API ~Array() override = default;
53  SPLA_API virtual uint get_n_values() = 0;
55  SPLA_API virtual Status set_int(uint i, T_INT value) = 0;
56  SPLA_API virtual Status set_uint(uint i, T_UINT value) = 0;
57  SPLA_API virtual Status set_float(uint i, T_FLOAT value) = 0;
58  SPLA_API virtual Status get_int(uint i, T_INT& value) = 0;
59  SPLA_API virtual Status get_uint(uint i, T_UINT& value) = 0;
60  SPLA_API virtual Status get_float(uint i, T_FLOAT& value) = 0;
61  SPLA_API virtual Status resize(uint n_values) = 0;
62  SPLA_API virtual Status build(const ref_ptr<MemView>& view) = 0;
63  SPLA_API virtual Status read(ref_ptr<MemView>& view) = 0;
64  SPLA_API virtual Status clear() = 0;
65 
66  SPLA_API static ref_ptr<Array> make(uint n_values, const ref_ptr<Type>& type);
67  };
68 
69 
70 }// namespace spla
71 
72 #endif//SPLA_ARRAY_HPP
Status of library operation execution.
One-dimensional dense tightly packed array of typed values.
Definition: array.hpp:50
virtual Status read(ref_ptr< MemView > &view)=0
virtual Status get_int(uint i, T_INT &value)=0
virtual Status build(const ref_ptr< MemView > &view)=0
virtual Status clear()=0
virtual Status set_float(uint i, T_FLOAT value)=0
~Array() override=default
virtual Status resize(uint n_values)=0
static ref_ptr< Array > make(uint n_values, const ref_ptr< Type > &type)
Definition: array.cpp:33
virtual Status set_uint(uint i, T_UINT value)=0
virtual Status get_uint(uint i, T_UINT &value)=0
virtual Status set_int(uint i, T_INT value)=0
virtual Status get_float(uint i, T_FLOAT &value)=0
virtual ref_ptr< Type > get_type()=0
virtual uint get_n_values()=0
Base class for any library primitive.
Definition: object.hpp:47
Automates reference counting and behaves as shared smart pointer.
Definition: ref.hpp:117
#define SPLA_API
Definition: config.hpp:43
std::int32_t T_INT
Definition: type.hpp:58
std::uint32_t uint
Library index and size type.
Definition: config.hpp:56
std::uint32_t T_UINT
Definition: type.hpp:59
float T_FLOAT
Definition: type.hpp:60
Definition: algorithm.hpp:37