GCC Code Coverage Report


Directory: ../../../builds/dumux-repositories/
File: dumux/dumux/common/optionalscalar.hh
Date: 2025-04-19 19:19:10
Exec Total Coverage
Lines: 6 6 100.0%
Functions: 0 0 -%
Branches: 173 261 66.3%

Line Branch Exec Source
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 //
4 // SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
5 // SPDX-License-Identifier: GPL-3.0-or-later
6 //
7 /*!
8 * \file
9 * \ingroup Core
10 * \brief A wrapper that can either contain a valid Scalar or NaN
11 */
12 #ifndef DUMUX_COMMON_OPTIONAL_SCALAR_HH
13 #define DUMUX_COMMON_OPTIONAL_SCALAR_HH
14
15 #include <limits>
16 #include <cmath>
17
18 namespace Dumux {
19
20 /*!
21 * \ingroup Core
22 * \brief A type for an optional scalar (contains either a valid number or NaN)
23 * \tparam T Type of the underlying floating point number type
24 */
25 template<class T>
26 struct OptionalScalar
27 {
28 static_assert(std::numeric_limits<T>::has_quiet_NaN, "T has to be able to represent a quiet NaN!");
29
30
3/5
✓ Branch 6 taken 3 times.
✗ Branch 7 not taken.
✓ Branch 1 taken 4651181 times.
✗ Branch 2 not taken.
✓ Branch 0 taken 4887295 times.
1745828193 OptionalScalar() = default;
31
32
2/2
✓ Branch 0 taken 370791 times.
✓ Branch 1 taken 808402 times.
280204164 OptionalScalar(T value)
33 : value_(value)
34 {}
35
36 1501434 T value() const
37
48/74
✗ Branch 0 not taken.
✓ Branch 1 taken 99 times.
✓ Branch 2 taken 41564 times.
✓ Branch 3 taken 98 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 99 times.
✓ Branch 6 taken 41564 times.
✓ Branch 7 taken 98 times.
✗ Branch 8 not taken.
✓ Branch 9 taken 99 times.
✓ Branch 10 taken 1 times.
✓ Branch 11 taken 98 times.
✗ Branch 12 not taken.
✓ Branch 13 taken 99 times.
✓ Branch 14 taken 1 times.
✓ Branch 15 taken 98 times.
✓ Branch 16 taken 1 times.
✓ Branch 17 taken 16819 times.
✗ Branch 18 not taken.
✓ Branch 19 taken 1 times.
✓ Branch 20 taken 999 times.
✓ Branch 21 taken 98 times.
✓ Branch 22 taken 1 times.
✓ Branch 23 taken 98 times.
✗ Branch 24 not taken.
✓ Branch 25 taken 1 times.
✗ Branch 26 not taken.
✓ Branch 27 taken 98 times.
✓ Branch 28 taken 1 times.
✓ Branch 29 taken 98 times.
✗ Branch 30 not taken.
✓ Branch 31 taken 1 times.
✗ Branch 32 not taken.
✓ Branch 33 taken 98 times.
✓ Branch 34 taken 1 times.
✓ Branch 35 taken 98 times.
✗ Branch 36 not taken.
✓ Branch 37 taken 1 times.
✗ Branch 38 not taken.
✓ Branch 39 taken 98 times.
✓ Branch 44 taken 1 times.
✓ Branch 45 taken 8 times.
✗ Branch 46 not taken.
✓ Branch 47 taken 817 times.
✓ Branch 48 taken 1 times.
✓ Branch 49 taken 8 times.
✓ Branch 50 taken 130440 times.
✗ Branch 51 not taken.
✓ Branch 52 taken 1 times.
✓ Branch 53 taken 8 times.
✗ Branch 54 not taken.
✗ Branch 55 not taken.
✓ Branch 56 taken 1 times.
✓ Branch 57 taken 8 times.
✗ Branch 58 not taken.
✗ Branch 59 not taken.
✗ Branch 60 not taken.
✓ Branch 61 taken 396 times.
✓ Branch 62 taken 4 times.
✓ Branch 63 taken 392 times.
✓ Branch 64 taken 4 times.
✓ Branch 65 taken 392 times.
✗ Branch 66 not taken.
✓ Branch 67 taken 4 times.
✗ Branch 68 not taken.
✓ Branch 69 taken 392 times.
✓ Branch 71 taken 4 times.
✓ Branch 72 taken 32 times.
✗ Branch 73 not taken.
✗ Branch 74 not taken.
✗ Branch 40 not taken.
✗ Branch 41 not taken.
✗ Branch 42 not taken.
✗ Branch 43 not taken.
1369915 { return value_; }
38
39 1853615852 explicit operator bool() const
40 {
41 using std::isnan;
42
120/180
✓ Branch 0 taken 32608941 times.
✓ Branch 1 taken 15338879 times.
✓ Branch 2 taken 35670112 times.
✓ Branch 3 taken 77408505 times.
✓ Branch 4 taken 56589345 times.
✓ Branch 5 taken 798346155 times.
✓ Branch 6 taken 30534040 times.
✓ Branch 7 taken 758548164 times.
✓ Branch 8 taken 10770638 times.
✓ Branch 9 taken 33741691 times.
✓ Branch 10 taken 1183016 times.
✓ Branch 11 taken 49304 times.
✓ Branch 12 taken 9403 times.
✓ Branch 13 taken 255 times.
✓ Branch 14 taken 1847 times.
✓ Branch 15 taken 667 times.
✗ Branch 16 not taken.
✓ Branch 17 taken 1 times.
✗ Branch 18 not taken.
✓ Branch 19 taken 99 times.
✗ Branch 20 not taken.
✓ Branch 21 taken 99 times.
✗ Branch 22 not taken.
✓ Branch 23 taken 1 times.
✗ Branch 24 not taken.
✓ Branch 25 taken 99 times.
✗ Branch 26 not taken.
✓ Branch 27 taken 1 times.
✗ Branch 28 not taken.
✓ Branch 29 taken 98 times.
✗ Branch 30 not taken.
✓ Branch 31 taken 99 times.
✗ Branch 32 not taken.
✓ Branch 33 taken 1 times.
✗ Branch 34 not taken.
✓ Branch 35 taken 98 times.
✗ Branch 36 not taken.
✓ Branch 37 taken 99 times.
✗ Branch 38 not taken.
✓ Branch 39 taken 1 times.
✗ Branch 40 not taken.
✓ Branch 41 taken 98 times.
✗ Branch 42 not taken.
✓ Branch 43 taken 99 times.
✓ Branch 44 taken 16721 times.
✓ Branch 45 taken 1 times.
✓ Branch 46 taken 16721 times.
✓ Branch 47 taken 98 times.
✗ Branch 48 not taken.
✓ Branch 49 taken 3 times.
✓ Branch 50 taken 999 times.
✗ Branch 51 not taken.
✓ Branch 52 taken 1017359 times.
✓ Branch 53 taken 3 times.
✓ Branch 54 taken 88522 times.
✗ Branch 55 not taken.
✗ Branch 56 not taken.
✓ Branch 57 taken 3 times.
✗ Branch 58 not taken.
✗ Branch 59 not taken.
✗ Branch 60 not taken.
✓ Branch 61 taken 3 times.
✗ Branch 62 not taken.
✗ Branch 63 not taken.
✓ Branch 64 taken 1 times.
✓ Branch 65 taken 5 times.
✓ Branch 66 taken 28793 times.
✓ Branch 67 taken 12867 times.
✓ Branch 68 taken 1 times.
✓ Branch 69 taken 5 times.
✗ Branch 70 not taken.
✗ Branch 71 not taken.
✓ Branch 72 taken 1 times.
✓ Branch 73 taken 5 times.
✗ Branch 74 not taken.
✗ Branch 75 not taken.
✓ Branch 76 taken 1 times.
✓ Branch 77 taken 5 times.
✗ Branch 78 not taken.
✗ Branch 79 not taken.
✓ Branch 80 taken 2 times.
✓ Branch 81 taken 98 times.
✓ Branch 82 taken 2 times.
✓ Branch 83 taken 98 times.
✓ Branch 84 taken 819 times.
✓ Branch 85 taken 98 times.
✓ Branch 86 taken 819 times.
✓ Branch 87 taken 98 times.
✓ Branch 88 taken 2 times.
✓ Branch 89 taken 98 times.
✓ Branch 90 taken 130442 times.
✓ Branch 91 taken 98 times.
✓ Branch 92 taken 2 times.
✓ Branch 93 taken 98 times.
✓ Branch 94 taken 2 times.
✓ Branch 95 taken 98 times.
✓ Branch 96 taken 4 times.
✓ Branch 97 taken 196 times.
✓ Branch 98 taken 4 times.
✓ Branch 99 taken 196 times.
✓ Branch 100 taken 4 times.
✓ Branch 101 taken 196 times.
✓ Branch 102 taken 4 times.
✓ Branch 103 taken 196 times.
✓ Branch 104 taken 1 times.
✓ Branch 105 taken 8 times.
✓ Branch 106 taken 1237139 times.
✓ Branch 107 taken 252608 times.
✗ Branch 108 not taken.
✗ Branch 109 not taken.
✗ Branch 110 not taken.
✗ Branch 111 not taken.
✓ Branch 112 taken 1 times.
✓ Branch 113 taken 8 times.
✓ Branch 114 taken 1 times.
✓ Branch 115 taken 8 times.
✗ Branch 116 not taken.
✗ Branch 117 not taken.
✗ Branch 118 not taken.
✗ Branch 119 not taken.
✓ Branch 120 taken 1 times.
✓ Branch 121 taken 8 times.
✓ Branch 122 taken 1 times.
✓ Branch 123 taken 8 times.
✗ Branch 124 not taken.
✗ Branch 125 not taken.
✗ Branch 126 not taken.
✗ Branch 127 not taken.
✓ Branch 128 taken 1 times.
✓ Branch 129 taken 8 times.
✓ Branch 130 taken 1 times.
✓ Branch 131 taken 8 times.
✗ Branch 132 not taken.
✗ Branch 133 not taken.
✗ Branch 134 not taken.
✗ Branch 135 not taken.
✗ Branch 136 not taken.
✓ Branch 137 taken 396 times.
✗ Branch 138 not taken.
✓ Branch 139 taken 396 times.
✗ Branch 140 not taken.
✓ Branch 141 taken 4 times.
✗ Branch 142 not taken.
✓ Branch 143 taken 396 times.
✗ Branch 144 not taken.
✓ Branch 145 taken 4 times.
✗ Branch 146 not taken.
✓ Branch 147 taken 392 times.
✗ Branch 148 not taken.
✓ Branch 149 taken 12 times.
✗ Branch 150 not taken.
✗ Branch 151 not taken.
✓ Branch 152 taken 4 times.
✓ Branch 153 taken 20 times.
✗ Branch 154 not taken.
✗ Branch 155 not taken.
✓ Branch 156 taken 12 times.
✓ Branch 157 taken 588 times.
✓ Branch 158 taken 12 times.
✓ Branch 159 taken 588 times.
✓ Branch 160 taken 12 times.
✓ Branch 161 taken 588 times.
✓ Branch 162 taken 12 times.
✓ Branch 163 taken 588 times.
✓ Branch 164 taken 8 times.
✓ Branch 165 taken 392 times.
✓ Branch 166 taken 8 times.
✓ Branch 167 taken 392 times.
✓ Branch 168 taken 16 times.
✓ Branch 169 taken 784 times.
✓ Branch 170 taken 4 times.
✓ Branch 171 taken 32 times.
✓ Branch 172 taken 4 times.
✓ Branch 173 taken 32 times.
✗ Branch 174 not taken.
✗ Branch 175 not taken.
✗ Branch 176 not taken.
✗ Branch 177 not taken.
✓ Branch 178 taken 48 times.
✓ Branch 179 taken 2652 times.
1853615788 return !isnan(value_);
43 }
44 private:
45 T value_ = std::numeric_limits<T>::quiet_NaN();
46 };
47
48 } // namespace Dumux
49
50 #endif
51