Compute Library
 21.02
Rounding.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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_ROUNDING_H
25 #define ARM_COMPUTE_ROUNDING_H
26 
27 namespace arm_compute
28 {
29 /** Rounding method */
30 enum class RoundingPolicy
31 {
32  TO_ZERO, /**< Truncates the least significant values that are lost in operations. */
33  TO_NEAREST_UP, /**< Rounds to nearest value; half rounds away from zero */
34  TO_NEAREST_EVEN, /**< Rounds to nearest value; half rounds to nearest even */
35 };
36 
37 /** Return a rounded value of x. Rounding is done according to the rounding_policy.
38  *
39  * @param[in] x Float value to be rounded.
40  * @param[in] rounding_policy Policy determining how rounding is done.
41  *
42  * @return Rounded value of the argument x.
43  */
44 int round(float x, RoundingPolicy rounding_policy);
45 }
46 #endif /*ARM_COMPUTE_ROUNDING_H */
Rounds to nearest value; half rounds away from zero.
Copyright (c) 2017-2021 Arm Limited.
RoundingPolicy
Rounding method.
Definition: Rounding.h:30
int round(float x, RoundingPolicy rounding_policy)
Return a rounded value of x.
Definition: Rounding.cpp:35
Rounds to nearest value; half rounds to nearest even.
Truncates the least significant values that are lost in operations.