WPILibC++ 2024.3.2
is_finite.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 ##
7 ## Licensed under the Apache License, Version 2.0 (the "License");
8 ## you may not use this file except in compliance with the License.
9 ## You may obtain a copy of the License at
10 ##
11 ## http://www.apache.org/licenses/LICENSE-2.0
12 ##
13 ## Unless required by applicable law or agreed to in writing, software
14 ## distributed under the License is distributed on an "AS IS" BASIS,
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/*
22 * compile-time check if a float is not NaN-valued or +/-Inf
23 */
24
25#ifndef _gcem_is_finite_HPP
26#define _gcem_is_finite_HPP
27
28namespace gcem
29{
30
31namespace internal
32{
33
34template<typename T>
35constexpr
36bool
37is_finite(const T x)
38noexcept
39{
40 return (!is_nan(x)) && (!is_inf(x));
41}
42
43template<typename T1, typename T2>
44constexpr
45bool
46any_finite(const T1 x, const T2 y)
47noexcept
48{
49 return( is_finite(x) || is_finite(y) );
50}
51
52template<typename T1, typename T2>
53constexpr
54bool
55all_finite(const T1 x, const T2 y)
56noexcept
57{
58 return( is_finite(x) && is_finite(y) );
59}
60
61template<typename T1, typename T2, typename T3>
62constexpr
63bool
64any_finite(const T1 x, const T2 y, const T3 z)
65noexcept
66{
67 return( is_finite(x) || is_finite(y) || is_finite(z) );
68}
69
70template<typename T1, typename T2, typename T3>
71constexpr
72bool
73all_finite(const T1 x, const T2 y, const T3 z)
74noexcept
75{
76 return( is_finite(x) && is_finite(y) && is_finite(z) );
77}
78
79}
80
81}
82
83#endif
constexpr bool all_finite(const T1 x, const T2 y) noexcept
Definition: is_finite.hpp:55
constexpr bool is_inf(const T x) noexcept
Definition: is_inf.hpp:131
constexpr bool is_nan(const T x) noexcept
Definition: is_nan.hpp:39
constexpr bool is_finite(const T x) noexcept
Definition: is_finite.hpp:37
constexpr bool any_finite(const T1 x, const T2 y) noexcept
Definition: is_finite.hpp:46
Definition: is_even.hpp:29