spla
scalar.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of spla project */
3 /* https://github.com/SparseLinearAlgebra/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_SCALAR_HPP
29 #define SPLA_SCALAR_HPP
30 
31 #include "object.hpp"
32 #include "type.hpp"
33 
34 namespace spla {
35 
45  class Scalar : public Object {
46  public:
47  SPLA_API ~Scalar() override = default;
49  SPLA_API virtual Status set_int(std::int32_t value) = 0;
50  SPLA_API virtual Status set_uint(std::uint32_t value) = 0;
51  SPLA_API virtual Status set_float(float value) = 0;
52  SPLA_API virtual Status get_int(std::int32_t& value) = 0;
53  SPLA_API virtual Status get_uint(std::uint32_t& value) = 0;
54  SPLA_API virtual Status get_float(float& value) = 0;
55  SPLA_API virtual T_INT as_int() = 0;
56  SPLA_API virtual T_UINT as_uint() = 0;
57  SPLA_API virtual T_FLOAT as_float() = 0;
58 
59  SPLA_API static ref_ptr<Scalar> make(const ref_ptr<Type>& type);
60  SPLA_API static ref_ptr<Scalar> make_int(std::int32_t value);
61  SPLA_API static ref_ptr<Scalar> make_uint(std::uint32_t value);
62  SPLA_API static ref_ptr<Scalar> make_float(float value);
63  };
64 
69 }// namespace spla
70 
71 #endif//SPLA_SCALAR_HPP
Status of library operation execution.
Base class for any library primitive.
Definition: object.hpp:47
Box for a single typed scalar value.
Definition: scalar.hpp:45
virtual T_UINT as_uint()=0
~Scalar() override=default
virtual Status set_uint(std::uint32_t value)=0
static ref_ptr< Scalar > make_int(std::int32_t value)
Definition: scalar.cpp:55
virtual Status get_int(std::int32_t &value)=0
virtual Status set_float(float value)=0
static ref_ptr< Scalar > make_uint(std::uint32_t value)
Definition: scalar.cpp:58
virtual Status set_int(std::int32_t value)=0
virtual Status get_float(float &value)=0
virtual T_INT as_int()=0
virtual T_FLOAT as_float()=0
virtual Status get_uint(std::uint32_t &value)=0
static ref_ptr< Scalar > make_float(float value)
static ref_ptr< Scalar > make(const ref_ptr< Type > &type)
Definition: scalar.cpp:33
virtual ref_ptr< Type > get_type()=0
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 T_UINT
Definition: type.hpp:59
float T_FLOAT
Definition: type.hpp:60
Definition: algorithm.hpp:37