WPILibC++ 2023.4.3-108-ge5452e3
is_finite.hpp
Go to the documentation of this file.
1/*################################################################################
2 ##
3 ## Copyright (C) 2016-2022 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 internal
29{
30
31template<typename T>
32constexpr
33bool
34is_finite(const T x)
35noexcept
36{
37 return (!is_nan(x)) && (!is_inf(x));
38}
39
40template<typename T1, typename T2>
41constexpr
42bool
43any_finite(const T1 x, const T2 y)
44noexcept
45{
46 return( is_finite(x) || is_finite(y) );
47}
48
49template<typename T1, typename T2>
50constexpr
51bool
52all_finite(const T1 x, const T2 y)
53noexcept
54{
55 return( is_finite(x) && is_finite(y) );
56}
57
58template<typename T1, typename T2, typename T3>
59constexpr
60bool
61any_finite(const T1 x, const T2 y, const T3 z)
62noexcept
63{
64 return( is_finite(x) || is_finite(y) || is_finite(z) );
65}
66
67template<typename T1, typename T2, typename T3>
68constexpr
69bool
70all_finite(const T1 x, const T2 y, const T3 z)
71noexcept
72{
73 return( is_finite(x) && is_finite(y) && is_finite(z) );
74}
75
76}
77
78#endif
const Scalar & y
Definition: MathFunctions.h:821
Definition: Eigen_Colamd.h:50
constexpr bool is_nan(const T x) noexcept
Definition: is_nan.hpp:36
constexpr bool is_finite(const T x) noexcept
Definition: is_finite.hpp:34
constexpr bool all_finite(const T1 x, const T2 y) noexcept
Definition: is_finite.hpp:52
constexpr bool any_finite(const T1 x, const T2 y) noexcept
Definition: is_finite.hpp:43
constexpr bool is_inf(const T x) noexcept
Definition: is_inf.hpp:128