aboutsummaryrefslogtreecommitdiff
path: root/include/armnn/utility/NumericCast.hpp
blob: cdbfd896385bfa31a3519b928c76b0389e6de93c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
//
// Copyright © 2020 Arm Ltd and Contributors. All rights reserved.
// SPDX-License-Identifier: MIT
//

#pragma once

#include "Assert.hpp"

#include <type_traits>
#include <limits>

namespace armnn
{

#if !defined(NDEBUG) || defined(ARMNN_NUMERIC_CAST_TESTABLE)
#define ENABLE_NUMERIC_CAST_CHECKS 1
#else
#define ENABLE_NUMERIC_CAST_CHECKS 0
#endif

#if defined(ARMNN_NUMERIC_CAST_TESTABLE)
#   define ARMNN_NUMERIC_CAST_CHECK(cond, msg) ConditionalThrow<std::bad_cast>(cond)
#else
#define ARMNN_NUMERIC_CAST_CHECK(cond, msg) ARMNN_ASSERT_MSG(cond, msg)
#endif

// Unsigned to Unsigned

template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_unsigned<Source>::value &&
    std::is_unsigned<Dest>::value,
    Dest>
numeric_cast(Source source)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (source > std::numeric_limits<Dest>::max())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting unsigned type to "
                                        "narrower unsigned type. Overflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(source);
}

// Signed to Signed

// numeric cast from signed integral to signed integral types, checked for narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_signed<Source>::value &&
    std::is_integral<Source>::value &&
    std::is_signed<Dest>::value &&
    std::is_integral<Dest>::value,
    Dest>
numeric_cast(Source source)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (source > std::numeric_limits<Dest>::max())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting signed integral type to narrower signed type. "
                                        "Overflow detected.");
    }

    if (source < std::numeric_limits<Dest>::lowest())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting signed integral type to narrower signed type. "
                                        "Underflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(source);
}

// numeric cast from floating point to floating point types, checked for narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_floating_point<Source>::value &&
    std::is_floating_point<Dest>::value,
    Dest>
numeric_cast(Source source)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (source > std::numeric_limits<Dest>::max())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting floating point type to narrower signed type. "
                                        "Overflow detected.");
    }

    if (source < std::numeric_limits<Dest>::lowest())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting floating point type to narrower signed type. "
                                        "Underflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(source);
}

// numeric cast from floating point types (signed) to signed integral types, checked for narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_floating_point<Source>::value &&
    std::is_signed<Dest>::value &&
    std::is_integral<Dest>::value,
    Dest>
numeric_cast(Source source)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (source > static_cast<Source>(std::numeric_limits<Dest>::max()))
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting floating point type to narrower signed type. "
                                        "Overflow detected.");
    }

    if (source < static_cast<Source>(std::numeric_limits<Dest>::lowest()))
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting floating point type to narrower signed type. "
                                        "Underflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(source);
}

// numeric cast from signed integral types to floating point types (signed), checked for narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_signed<Source>::value &&
    std::is_integral<Source>::value &&
    std::is_floating_point<Dest>::value,
    Dest>
numeric_cast(Source source)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    Dest sourceConverted = static_cast<Dest>(source);

    if (sourceConverted > std::numeric_limits<Dest>::max())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting signed type to narrower floating point type. "
                                        "Overflow detected.");
    }

    if (sourceConverted < std::numeric_limits<Dest>::lowest())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting signed type to narrower floating point type. "
                                        "Underflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(source);
}

// Unsigned to Signed

// numeric cast from unsigned integral type to signed integral type, checked for narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_signed<Dest>::value &&
    std::is_integral<Dest>::value &&
    std::is_unsigned<Source>::value,
    Dest>
numeric_cast(Source sValue)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (sValue > static_cast< typename std::make_unsigned<Dest>::type >(std::numeric_limits<Dest>::max()))
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting unsigned type to signed type. "
                                        "Overflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(sValue);
}

// numeric cast from unsigned integral type to floating point (signed), checked for narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_floating_point<Dest>::value &&
    std::is_unsigned<Source>::value,
    Dest>
numeric_cast(Source sValue)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (static_cast<Dest>(sValue) > std::numeric_limits<Dest>::max())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting unsigned type to floating point type. "
                                        "Overflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS

    return static_cast<Dest>(sValue);
}

// Signed to Unsigned

// numeric cast from signed integral types to unsigned integral type, checked for underflows and narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_unsigned<Dest>::value &&
    std::is_signed<Source>::value &&
    std::is_integral<Source>::value,
    Dest>
numeric_cast(Source sValue)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (sValue < 0)
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting negative value to unsigned type. "
                                        "Underflow detected.");
    }

    if (static_cast< typename std::make_unsigned<Source>::type >(sValue) > std::numeric_limits<Dest>::max())
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting signed type to unsigned type. "
                                        "Overflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS
    return static_cast<Dest>(sValue);
}

// numeric cast from floating point (signed) to unsigned integral type, checked for underflows and narrowing overflows
template<typename Dest, typename Source>
typename std::enable_if_t<
    std::is_unsigned<Dest>::value &&
    std::is_floating_point<Source>::value,
    Dest>
numeric_cast(Source sValue)
{
#if ENABLE_NUMERIC_CAST_CHECKS
    if (sValue < 0)
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting negative value to unsigned type. "
                                        "Underflow detected.");
    }

    if (sValue > static_cast<Source>(std::numeric_limits<Dest>::max()))
    {
        ARMNN_NUMERIC_CAST_CHECK(false, "numeric_cast failed casting floating point type to unsigned type. "
                                        "Overflow detected.");
    }
#endif // ENABLE_NUMERIC_CAST_CHECKS
    return static_cast<Dest>(sValue);
}

#undef ENABLE_NUMERIC_CAST_CHECKS

} //namespace armnn