WPILibC++ 2024.3.2
lcm.hpp
Go to the documentation of this file.
1/*################################################################################
2 ##
3 ## Copyright (C) 2016-2023 Keith O'Hara
4 ##
5 ## This file is part of the GCE-Math C++ library.
6 ##
8 ## you may not use this file except in compliance with the License.
9 ## You may obtain a copy of the License at
10 ##
12 ##
13 ## Unless required by applicable law or agreed to in writing, software
15 ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 ## See the License for the specific language governing permissions and
17 ## limitations under the License.
18 ##
19 ################################################################################*/
20
21#ifndef _gcem_lcm_HPP
22#define _gcem_lcm_HPP
23
24namespace gcem
25{
26
27namespace internal
28{
29
30template<typename T>
31constexpr
32T
33lcm_compute(const T a, const T b)
34noexcept
35{
36 return abs(a * (b / gcd(a,b)));
37}
38
39template<typename T1, typename T2, typename TC = common_t<T1,T2>>
40constexpr
41TC
42lcm_type_check(const T1 a, const T2 b)
43noexcept
44{
45 return lcm_compute(static_cast<TC>(a),static_cast<TC>(b));
46}
47
48}
49
50/**
51 * Compile-time least common multiple (LCM) function
52 *
53 * @param a integral-valued input.
54 * @param b integral-valued input.
55 * @return the least common multiple between integers \c a and \c b using the representation \f[ \text{lcm}(a,b) = \dfrac{| a b |}{\text{gcd}(a,b)} \f]
56 * where \f$\text{gcd}(a,b) \f$ denotes the greatest common divisor between \f$a \f$ and \f$b \f$.
57 */
58
59template<typename T1, typename T2>
60constexpr
61common_t<T1,T2>
62lcm(const T1 a, const T2 b)
63noexcept
64{
66}
67
68}
69
70#endif
constexpr TC lcm_type_check(const T1 a, const T2 b) noexcept
Definition: lcm.hpp:42
constexpr T lcm_compute(const T a, const T b) noexcept
Definition: lcm.hpp:33
Definition: is_even.hpp:29
constexpr T abs(const T x) noexcept
Compile-time absolute value function.
Definition: abs.hpp:40
constexpr common_t< T1, T2 > gcd(const T1 a, const T2 b) noexcept
Compile-time greatest common divisor (GCD) function.
Definition: gcd.hpp:79
constexpr common_t< T1, T2 > lcm(const T1 a, const T2 b) noexcept
Compile-time least common multiple (LCM) function.
Definition: lcm.hpp:62
b
Definition: data.h:44