Compute Library
 22.02
Utils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021 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 SRC_COMMON_UTILS_H
25 #define SRC_COMMON_UTILS_H
26 
27 #include <type_traits>
28 
29 namespace arm_compute
30 {
31 namespace utils
32 {
33 /** Convert a strongly typed enum to an old plain c enum
34  *
35  * @tparam E Plain old C enum
36  * @tparam SE Strongly typed resulting enum
37  *
38  * @param[in] v Value to convert
39  *
40  * @return A corresponding plain old C enumeration
41  */
42 template <typename E, typename SE>
43 constexpr E as_cenum(const SE v) noexcept
44 {
45  return static_cast<E>(static_cast<std::underlying_type_t<SE>>(v));
46 }
47 
48 /** Convert plain old enumeration to a strongly typed enum
49  *
50  * @tparam SE Strongly typed resulting enum
51  * @tparam E Plain old C enum
52  *
53  * @param[in] val Value to convert
54  *
55  * @return A corresponding strongly typed enumeration
56  */
57 template <typename SE, typename E>
58 constexpr SE as_enum(const E val) noexcept
59 {
60  return static_cast<SE>(val);
61 }
62 
63 /** Check if the given value is in the given enum value list
64  *
65  * @tparam E The type of the enum
66  *
67  * @param[in] check Value to check
68  * @param[in] list List of enum values to check against
69  *
70  * @return True if the given value is found in the list
71  */
72 template <typename E>
73 bool is_in(E check, std::initializer_list<E> list)
74 {
75  return std::any_of(std::cbegin(list), std::cend(list), [&check](E e)
76  {
77  return check == e;
78  });
79 }
80 } // namespace utils
81 } // namespace arm_compute
82 
83 #endif /* SRC_COMMON_UTILS_H */
constexpr SE as_enum(const E val) noexcept
Convert plain old enumeration to a strongly typed enum.
Definition: Utils.h:58
constexpr E as_cenum(const SE v) noexcept
Convert a strongly typed enum to an old plain c enum.
Definition: Utils.h:43
Copyright (c) 2017-2021 Arm Limited.
bool is_in(E check, std::initializer_list< E > list)
Check if the given value is in the given enum value list.
Definition: Utils.h:73