blob: 5b6e7f8d91290a5009a741a01cda8f02b5ddc642 [file]
<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::FieldMetrics Struct Reference</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>
<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>
<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">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="structiceberg_1_1FieldMetrics.html">FieldMetrics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structiceberg_1_1FieldMetrics-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::FieldMetrics Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Field-level metrics for a single column.
<a href="structiceberg_1_1FieldMetrics.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="metrics_8h_source.html">metrics.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a74e7b16be3cf9d1447f15f93b0eb64ca" id="r_a74e7b16be3cf9d1447f15f93b0eb64ca"><td class="memItemLeft" align="right" valign="top"><a id="a74e7b16be3cf9d1447f15f93b0eb64ca" name="a74e7b16be3cf9d1447f15f93b0eb64ca"></a>
int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>field_id</b> = -1</td></tr>
<tr class="memdesc:a74e7b16be3cf9d1447f15f93b0eb64ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">The field ID this metrics belongs to. <br /></td></tr>
<tr class="separator:a74e7b16be3cf9d1447f15f93b0eb64ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbb6f7b781db27961bb698e7792845ad" id="r_afbb6f7b781db27961bb698e7792845ad"><td class="memItemLeft" align="right" valign="top"><a id="afbb6f7b781db27961bb698e7792845ad" name="afbb6f7b781db27961bb698e7792845ad"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>value_count</b> = -1</td></tr>
<tr class="memdesc:afbb6f7b781db27961bb698e7792845ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">The total number of values (including nulls) for this field. A negative value indicates the count is unknown. <br /></td></tr>
<tr class="separator:afbb6f7b781db27961bb698e7792845ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa83ce731bb0ecf18c7d55790f6ea83e0" id="r_aa83ce731bb0ecf18c7d55790f6ea83e0"><td class="memItemLeft" align="right" valign="top"><a id="aa83ce731bb0ecf18c7d55790f6ea83e0" name="aa83ce731bb0ecf18c7d55790f6ea83e0"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>null_value_count</b> = -1</td></tr>
<tr class="memdesc:aa83ce731bb0ecf18c7d55790f6ea83e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of null values for this field. A negative value indicates the count is unknown. <br /></td></tr>
<tr class="separator:aa83ce731bb0ecf18c7d55790f6ea83e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1a664de1ca783302621ab695082ddab" id="r_ab1a664de1ca783302621ab695082ddab"><td class="memItemLeft" align="right" valign="top"><a id="ab1a664de1ca783302621ab695082ddab" name="ab1a664de1ca783302621ab695082ddab"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>nan_value_count</b> = -1</td></tr>
<tr class="memdesc:ab1a664de1ca783302621ab695082ddab"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of NaN values for this field. A negative value indicates the count is unknown. <br /></td></tr>
<tr class="separator:ab1a664de1ca783302621ab695082ddab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206fd2af6f4cba5c26a7ad606a2939fc" id="r_a206fd2af6f4cba5c26a7ad606a2939fc"><td class="memItemLeft" align="right" valign="top"><a id="a206fd2af6f4cba5c26a7ad606a2939fc" name="a206fd2af6f4cba5c26a7ad606a2939fc"></a>
std::optional&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>lower_bound</b> = std::nullopt</td></tr>
<tr class="memdesc:a206fd2af6f4cba5c26a7ad606a2939fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The lower bound value as a <a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a>. Empty if no lower bound is available. <br /></td></tr>
<tr class="separator:a206fd2af6f4cba5c26a7ad606a2939fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dd2a538baeffa8a5559d19b9dd9b24d" id="r_a4dd2a538baeffa8a5559d19b9dd9b24d"><td class="memItemLeft" align="right" valign="top"><a id="a4dd2a538baeffa8a5559d19b9dd9b24d" name="a4dd2a538baeffa8a5559d19b9dd9b24d"></a>
std::optional&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>upper_bound</b> = std::nullopt</td></tr>
<tr class="memdesc:a4dd2a538baeffa8a5559d19b9dd9b24d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The upper bound value as a <a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a>. Empty if no upper bound is available. <br /></td></tr>
<tr class="separator:a4dd2a538baeffa8a5559d19b9dd9b24d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Field-level metrics for a single column. </p>
<p>This structure captures value counts, null counts, NaN counts, and optional lower/upper bounds for a specific field identified by its field_id. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>iceberg/<a class="el" href="metrics_8h_source.html">metrics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>