Compute Library
 21.02
Cast.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_MISC_CAST_H
25 #define ARM_COMPUTE_MISC_CAST_H
26 
27 #include "arm_compute/core/Error.h"
28 
29 namespace arm_compute
30 {
31 namespace utils
32 {
33 namespace cast
34 {
35 /** Polymorphic cast between two types
36  *
37  * @warning Will throw an exception if cast cannot take place
38  *
39  * @tparam Target Target to cast type
40  * @tparam Source Source from cast type
41  *
42  * @param[in] v Value to cast
43  *
44  * @return The casted value
45  */
46 template <typename Target, typename Source>
47 inline Target polymorphic_cast(Source *v)
48 {
49  if(dynamic_cast<Target>(v) == nullptr)
50  {
51  ARM_COMPUTE_THROW(std::bad_cast());
52  }
53  return static_cast<Target>(v);
54 }
55 
56 /** Polymorphic down cast between two types
57  *
58  * @warning Will assert if cannot take place
59  *
60  * @tparam Target Target to cast type
61  * @tparam Source Source from cast type
62  *
63  * @param[in] v Value to cast
64  *
65  * @return The casted value
66  */
67 template <typename Target, typename Source>
68 inline Target polymorphic_downcast(Source *v)
69 {
70  ARM_COMPUTE_ERROR_ON(dynamic_cast<Target>(v) != static_cast<Target>(v));
71  return static_cast<Target>(v);
72 }
73 
74 /** Polymorphic cast between two unique pointer types
75  *
76  * @warning Will throw an exception if cast cannot take place
77  *
78  * @tparam Target Target to cast type
79  * @tparam Source Source from cast type
80  * @tparam Deleter Deleter function type
81  *
82  * @param[in] v Value to cast
83  *
84  * @return The casted value
85  */
86 template <typename Target, typename Source, typename Deleter>
87 std::unique_ptr<Target, Deleter> polymorphic_cast_unique_ptr(std::unique_ptr<Source, Deleter> &&v)
88 {
89  if(dynamic_cast<Target *>(v.get()) == nullptr)
90  {
91  ARM_COMPUTE_THROW(std::bad_cast());
92  }
93  auto r = static_cast<Target *>(v.release());
94  return std::unique_ptr<Target, Deleter>(r, std::move(v.get_deleter()));
95 }
96 
97 /** Polymorphic down cast between two unique pointer types
98  *
99  * @warning Will assert if cannot take place
100  *
101  * @tparam Target Target to cast type
102  * @tparam Source Source from cast type
103  * @tparam Deleter Deleter function type
104  *
105  * @param[in] v Value to cast
106  *
107  * @return The casted value
108  */
109 template <typename Target, typename Source, typename Deleter>
110 std::unique_ptr<Target, Deleter> polymorphic_downcast_unique_ptr(std::unique_ptr<Source, Deleter> &&v)
111 {
112  ARM_COMPUTE_ERROR_ON(dynamic_cast<Target *>(v.get()) != static_cast<Target *>(v.get()));
113  auto r = static_cast<Target *>(v.release());
114  return std::unique_ptr<Target, Deleter>(r, std::move(v.get_deleter()));
115 }
116 } // namespace cast
117 } // namespace utils
118 } // namespace arm_compute
119 #endif /* ARM_COMPUTE_MISC_CAST_H */
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
Copyright (c) 2017-2021 Arm Limited.
Target polymorphic_downcast(Source *v)
Polymorphic down cast between two types.
Definition: Cast.h:68
std::unique_ptr< Target, Deleter > polymorphic_downcast_unique_ptr(std::unique_ptr< Source, Deleter > &&v)
Polymorphic down cast between two unique pointer types.
Definition: Cast.h:110
Target polymorphic_cast(Source *v)
Polymorphic cast between two types.
Definition: Cast.h:47
std::unique_ptr< Target, Deleter > polymorphic_cast_unique_ptr(std::unique_ptr< Source, Deleter > &&v)
Polymorphic cast between two unique pointer types.
Definition: Cast.h:87
#define ARM_COMPUTE_THROW(ex)
Definition: Error.h:480