-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path__cmath_2round_8hpp_source.html
180 lines (178 loc) · 19.3 KB
/
__cmath_2round_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tetl: include/etl/_cmath/round.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tetl<span id="projectnumber"> 0.1.0</span>
</div>
<div id="projectbrief">Embedded Template Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('__cmath_2round_8hpp_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">round.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="__cmath_2round_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// SPDX-License-Identifier: BSL-1.0</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#ifndef TETL_CMATH_ROUND_HPP</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#define TETL_CMATH_ROUND_HPP</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <<a class="code" href="all_8hpp.html">etl/_config/all.hpp</a>></span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <etl/_3rd_party/gcem/gcem.hpp></span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="code" href="integral_8hpp.html">etl/_concepts/integral.hpp</a>></span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <<a class="code" href="is__constant__evaluated_8hpp.html">etl/_type_traits/is_constant_evaluated.hpp</a>></span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <<a class="code" href="is__same_8hpp.html">etl/_type_traits/is_same.hpp</a>></span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceetl.html">etl</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> round(T <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> T</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>{</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">if</span> (not <a class="code hl_function" href="namespaceetl.html#a135ea1c61ce77c9bf27e83df6a1fec64">is_constant_evaluated</a>()) {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (<a class="code hl_variable" href="namespaceetl.html#aa6c6bde5fd020a928e6d7b5fe8db7bb0">is_same_v<T, float></a>) {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if __has_builtin(__builtin_roundf)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">return</span> __builtin_roundf(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (<a class="code hl_variable" href="namespaceetl.html#aa6c6bde5fd020a928e6d7b5fe8db7bb0">is_same_v<T, double></a>) {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#if __has_builtin(__builtin_round)</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> __builtin_round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> detail::gcem::round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>}</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>} <span class="comment">// namespace detail</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="group__cmath.html#ga8ece6b0eeb98b1650638dbbbb09cda23"> 45</a></span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_function" href="group__cmath.html#ga8ece6b0eeb98b1650638dbbbb09cda23">round</a>(<span class="keywordtype">float</span> <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> <span class="keywordtype">float</span> { <span class="keywordflow">return</span> etl::detail::round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>); }</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="group__cmath.html#ga25f67bbe153f9daa0cbd56587131bfd3"> 46</a></span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_function" href="group__cmath.html#ga25f67bbe153f9daa0cbd56587131bfd3">roundf</a>(<span class="keywordtype">float</span> <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> <span class="keywordtype">float</span> { <span class="keywordflow">return</span> etl::detail::round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>); }</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="group__cmath.html#gad20c80803dd9917b164ebef227db3ed1"> 47</a></span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_function" href="group__cmath.html#ga8ece6b0eeb98b1650638dbbbb09cda23">round</a>(<span class="keywordtype">double</span> <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> <span class="keywordtype">double</span> { <span class="keywordflow">return</span> etl::detail::round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>); }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="group__cmath.html#ga3cc8394cdaabbc0790662af74f6574a3"> 48</a></span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_function" href="group__cmath.html#ga8ece6b0eeb98b1650638dbbbb09cda23">round</a>(<span class="keywordtype">long</span> <span class="keywordtype">double</span> <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> <span class="keywordtype">long</span> <span class="keywordtype">double</span> { <span class="keywordflow">return</span> etl::detail::round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>); }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="group__cmath.html#gae94747d1de39c6586935e11628963eee"> 49</a></span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_function" href="group__cmath.html#gae94747d1de39c6586935e11628963eee">roundl</a>(<span class="keywordtype">long</span> <span class="keywordtype">double</span> <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> <span class="keywordtype">long</span> <span class="keywordtype">double</span> { <span class="keywordflow">return</span> etl::detail::round(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>); }</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="group__cmath.html#ga594cdef05f79d80bbcb2c5f4b599b52e"> 50</a></span>[[nodiscard]] <span class="keyword">constexpr</span> <span class="keyword">auto</span> <a class="code hl_function" href="group__cmath.html#ga8ece6b0eeb98b1650638dbbbb09cda23">round</a>(<a class="code hl_concept" href="conceptetl_1_1integral.html">integral</a> <span class="keyword">auto</span> <a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>) <span class="keyword">noexcept</span> -> <span class="keywordtype">double</span> { <span class="keywordflow">return</span> etl::detail::round(<span class="keywordtype">double</span>(<a class="code hl_function" href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">arg</a>)); }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace etl</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif </span><span class="comment">// TETL_CMATH_ROUND_HPP</span></div>
<div class="ttc" id="aall_8hpp_html"><div class="ttname"><a href="all_8hpp.html">all.hpp</a></div></div>
<div class="ttc" id="aconceptetl_1_1integral_html"><div class="ttname"><a href="conceptetl_1_1integral.html">etl::integral</a></div><div class="ttdoc">The concept integral<T> is satisfied if and only if T is an integral type.</div><div class="ttdef"><b>Definition</b> integral.hpp:13</div></div>
<div class="ttc" id="agroup__cmath_html_ga25f67bbe153f9daa0cbd56587131bfd3"><div class="ttname"><a href="group__cmath.html#ga25f67bbe153f9daa0cbd56587131bfd3">etl::roundf</a></div><div class="ttdeci">constexpr auto roundf(float arg) noexcept -> float</div><div class="ttdoc">Computes the nearest integer value to arg (in floating-point format), rounding halfway cases away fro...</div><div class="ttdef"><b>Definition</b> round.hpp:46</div></div>
<div class="ttc" id="agroup__cmath_html_ga8ece6b0eeb98b1650638dbbbb09cda23"><div class="ttname"><a href="group__cmath.html#ga8ece6b0eeb98b1650638dbbbb09cda23">etl::round</a></div><div class="ttdeci">constexpr auto round(float arg) noexcept -> float</div><div class="ttdoc">Computes the nearest integer value to arg (in floating-point format), rounding halfway cases away fro...</div><div class="ttdef"><b>Definition</b> round.hpp:45</div></div>
<div class="ttc" id="agroup__cmath_html_gae94747d1de39c6586935e11628963eee"><div class="ttname"><a href="group__cmath.html#gae94747d1de39c6586935e11628963eee">etl::roundl</a></div><div class="ttdeci">constexpr auto roundl(long double arg) noexcept -> long double</div><div class="ttdoc">Computes the nearest integer value to arg (in floating-point format), rounding halfway cases away fro...</div><div class="ttdef"><b>Definition</b> round.hpp:49</div></div>
<div class="ttc" id="agroup__complex_html_ga0c18e9f715e3983b7a71347ce6e0e2c1"><div class="ttname"><a href="group__complex.html#ga0c18e9f715e3983b7a71347ce6e0e2c1">etl::arg</a></div><div class="ttdeci">constexpr auto arg(complex< T > const &z) noexcept -> T</div><div class="ttdef"><b>Definition</b> arg.hpp:15</div></div>
<div class="ttc" id="aintegral_8hpp_html"><div class="ttname"><a href="integral_8hpp.html">integral.hpp</a></div></div>
<div class="ttc" id="ais__constant__evaluated_8hpp_html"><div class="ttname"><a href="is__constant__evaluated_8hpp.html">is_constant_evaluated.hpp</a></div></div>
<div class="ttc" id="ais__same_8hpp_html"><div class="ttname"><a href="is__same_8hpp.html">is_same.hpp</a></div></div>
<div class="ttc" id="anamespaceetl_html"><div class="ttname"><a href="namespaceetl.html">etl</a></div><div class="ttdef"><b>Definition</b> adjacent_find.hpp:8</div></div>
<div class="ttc" id="anamespaceetl_html_a135ea1c61ce77c9bf27e83df6a1fec64"><div class="ttname"><a href="namespaceetl.html#a135ea1c61ce77c9bf27e83df6a1fec64">etl::is_constant_evaluated</a></div><div class="ttdeci">constexpr auto is_constant_evaluated() noexcept -> bool</div><div class="ttdoc">Detects whether the function call occurs within a constant-evaluated context. Returns true if the eva...</div><div class="ttdef"><b>Definition</b> is_constant_evaluated.hpp:16</div></div>
<div class="ttc" id="anamespaceetl_html_aa6c6bde5fd020a928e6d7b5fe8db7bb0"><div class="ttname"><a href="namespaceetl.html#aa6c6bde5fd020a928e6d7b5fe8db7bb0">etl::is_same_v</a></div><div class="ttdeci">constexpr bool is_same_v</div><div class="ttdef"><b>Definition</b> is_same.hpp:11</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_088299f779bf7d891f9a291787866d6f.html">etl</a></li><li class="navelem"><a class="el" href="dir_0a8451822ead037db42f7b180ec45725.html">_cmath</a></li><li class="navelem"><a class="el" href="__cmath_2round_8hpp.html">round.hpp</a></li>
<li class="footer">Generated on Sat Mar 8 2025 16:19:59 for tetl by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>