1 /*
2 * Copyright (c) 2024, The OpenThread Authors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the copyright holder nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file
31 * This file includes definitions for generic number utility functions (min, max).
32 */
33
34 #ifndef LIB_UTILS_MATH_HPP_
35 #define LIB_UTILS_MATH_HPP_
36
37 namespace ot {
38 namespace Lib {
39 namespace Utils {
40
41 /**
42 * This template function returns the minimum of two given values.
43 *
44 * Uses `operator<` to compare the values.
45 *
46 * @tparam Type The value type.
47 *
48 * @param[in] aFirst The first value.
49 * @param[in] aSecond The second value.
50 *
51 * @returns The minimum of @p aFirst and @p aSecond.
52 */
Min(Type aFirst,Type aSecond)53 template <typename Type> Type Min(Type aFirst, Type aSecond) { return (aFirst < aSecond) ? aFirst : aSecond; }
54
55 /**
56 * This template function returns the maximum of two given values.
57 *
58 * Uses `operator<` to compare the values.
59 *
60 * @tparam Type The value type.
61 *
62 * @param[in] aFirst The first value.
63 * @param[in] aSecond The second value.
64 *
65 * @returns The maximum of @p aFirst and @p aSecond.
66 */
Max(Type aFirst,Type aSecond)67 template <typename Type> Type Max(Type aFirst, Type aSecond) { return (aFirst < aSecond) ? aSecond : aFirst; }
68
69 /**
70 * Casts a given `uint32_t` to `unsigned long`.
71 *
72 * @param[in] aUint32 A `uint32_t` value.
73 *
74 * @returns The @p aUint32 value as `unsigned long`.
75 */
ToUlong(uint32_t aUint32)76 inline unsigned long ToUlong(uint32_t aUint32) { return static_cast<unsigned long>(aUint32); }
77
78 } // namespace Utils
79 } // namespace Lib
80 } // namespace ot
81
82 #endif // LIB_UTILS_MATH_HPP_
83