File: //opt/alt/alt-nodejs24/root/usr/share/doc/alt-nodejs24-libicu-doc/unumberoptions_8h.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 77.1: i18n/unicode/unumberoptions.h File 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 77.1
 <span id="projectnumber">77.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_73bc6a9bb617ea1bc89a10aa59ce84e4.html">i18n</a></li><li class="navelem"><a class="el" href="dir_0119ce638985e8a1561a00fdb5f76ff6.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">unumberoptions.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Header-only input options for various number formatting APIs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br />
</div>
<p><a href="unumberoptions_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa1ac9fe6671c075159e2fdff4ca05c73"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">UNumberFormatRoundingMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberoptions_8h.html#aa1ac9fe6671c075159e2fdff4ca05c73">UNumberFormatRoundingMode</a></td></tr>
<tr class="memdesc:aa1ac9fe6671c075159e2fdff4ca05c73"><td class="mdescLeft"> </td><td class="mdescRight">The possible number format rounding modes. <a href="#aa1ac9fe6671c075159e2fdff4ca05c73">More...</a><br /></td></tr>
<tr class="separator:aa1ac9fe6671c075159e2fdff4ca05c73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8949f9736aac0b0a652a61266d631c58"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberoptions_8h.html#a8949f9736aac0b0a652a61266d631c58">UNumberGroupingStrategy</a></td></tr>
<tr class="memdesc:a8949f9736aac0b0a652a61266d631c58"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). <a href="#a8949f9736aac0b0a652a61266d631c58">More...</a><br /></td></tr>
<tr class="separator:a8949f9736aac0b0a652a61266d631c58"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a2f46653ee48f5d8d5b8e67d4a1b8230a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">UNumberFormatRoundingMode</a> { <br />
  <b>UNUM_ROUND_CEILING</b>,
<b>UNUM_ROUND_FLOOR</b>,
<b>UNUM_ROUND_DOWN</b>,
<b>UNUM_ROUND_UP</b>,
<br />
  <a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230aa1fd90821fab4b77604c05712ab1b5678">UNUM_ROUND_HALFEVEN</a>,
<a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230aaaf65c3f66231f695a558eb526c1215f6">UNUM_FOUND_HALFEVEN</a> = UNUM_ROUND_HALFEVEN,
<b>UNUM_ROUND_HALFDOWN</b> = UNUM_ROUND_HALFEVEN + 1,
<b>UNUM_ROUND_HALFUP</b>,
<br />
  <a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230aa0f59afe5c61b0334a1f1fbb89d054595">UNUM_ROUND_UNNECESSARY</a>,
<a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230aaa6cd55fb2dcc24f67008a38795745731">UNUM_ROUND_HALF_ODD</a>,
<a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230aacffbb1ef6bf1389df9a73e52cc6f14e0">UNUM_ROUND_HALF_CEILING</a>,
<a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230aac10772676875a08271190462bcb62978">UNUM_ROUND_HALF_FLOOR</a>
<br />
}</td></tr>
<tr class="memdesc:a2f46653ee48f5d8d5b8e67d4a1b8230a"><td class="mdescLeft"> </td><td class="mdescRight">The possible number format rounding modes. <a href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">More...</a><br /></td></tr>
<tr class="separator:a2f46653ee48f5d8d5b8e67d4a1b8230a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af65963668dc167072ff07ee8d844e87e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a> { <br />
  <a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87eac60d2b94abb99aea4787c2dd367110c0">UNUM_GROUPING_OFF</a>,
<a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87ea30ca25de042e6f4fda0fab0551024854">UNUM_GROUPING_MIN2</a>,
<a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87ea574af658ab523f91dfe05577d1e7a7f9">UNUM_GROUPING_AUTO</a>,
<a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87ea37fb1e6f342dce66f12802a8218b81c4">UNUM_GROUPING_ON_ALIGNED</a>,
<br />
  <a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87ea2df6e82442d711199dceebe6df80dbe6">UNUM_GROUPING_THOUSANDS</a>,
<a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87ead8dfc5546d9b427968743e004c3ff43c">UNUM_GROUPING_COUNT</a>
<br />
}</td></tr>
<tr class="memdesc:af65963668dc167072ff07ee8d844e87e"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). <a href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87e">More...</a><br /></td></tr>
<tr class="separator:af65963668dc167072ff07ee8d844e87e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: Header-only input options for various number formatting APIs. </p>
<p>You do not normally need to include this header file directly, because it is included in all files that use these enums. </p>
<p class="definition">Definition in file <a class="el" href="unumberoptions_8h_source.html">unumberoptions.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="aa1ac9fe6671c075159e2fdff4ca05c73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1ac9fe6671c075159e2fdff4ca05c73">◆ </a></span>UNumberFormatRoundingMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">UNumberFormatRoundingMode</a> <a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">UNumberFormatRoundingMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The possible number format rounding modes. </p>
<p>For more detail on rounding modes, see: <a href="https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes">https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes</a></p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006749">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="a8949f9736aac0b0a652a61266d631c58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8949f9736aac0b0a652a61266d631c58">◆ </a></span>UNumberGroupingStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a> <a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). </p>
<p>The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in <em>en-IN</em>:</p>
<ul>
<li>
OFF: 1234 and 12345 </li>
<li>
MIN2: 1234 and 12,34,567 </li>
<li>
AUTO: 1,234 and 12,34,567 </li>
<li>
ON_ALIGNED: 1,234 and 12,34,567 </li>
<li>
THOUSANDS: 1,234 and 1,234,567 </li>
</ul>
<p>The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.</p>
<p>Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006750">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a2f46653ee48f5d8d5b8e67d4a1b8230a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f46653ee48f5d8d5b8e67d4a1b8230a">◆ </a></span>UNumberFormatRoundingMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="unumberoptions_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">UNumberFormatRoundingMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The possible number format rounding modes. </p>
<p>For more detail on rounding modes, see: <a href="https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes">https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes</a></p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006749">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a2f46653ee48f5d8d5b8e67d4a1b8230aa1fd90821fab4b77604c05712ab1b5678"></a>UNUM_ROUND_HALFEVEN </td><td class="fielddoc"><p>Half-even rounding. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006751">Stable:</a></b></dt><dd>, ICU 3.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a2f46653ee48f5d8d5b8e67d4a1b8230aaaf65c3f66231f695a558eb526c1215f6"></a>UNUM_FOUND_HALFEVEN </td><td class="fielddoc"><p>Half-even rounding, misspelled name. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000751">Deprecated:</a></b></dt><dd>, ICU 3.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a2f46653ee48f5d8d5b8e67d4a1b8230aa0f59afe5c61b0334a1f1fbb89d054595"></a>UNUM_ROUND_UNNECESSARY </td><td class="fielddoc"><p>ROUND_UNNECESSARY reports an error if formatted result is not exact. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006752">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a2f46653ee48f5d8d5b8e67d4a1b8230aaa6cd55fb2dcc24f67008a38795745731"></a>UNUM_ROUND_HALF_ODD </td><td class="fielddoc"><p>Rounds ties toward the odd number. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006753">Stable:</a></b></dt><dd>ICU 69 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a2f46653ee48f5d8d5b8e67d4a1b8230aacffbb1ef6bf1389df9a73e52cc6f14e0"></a>UNUM_ROUND_HALF_CEILING </td><td class="fielddoc"><p>Rounds ties toward +∞. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006754">Stable:</a></b></dt><dd>ICU 69 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a2f46653ee48f5d8d5b8e67d4a1b8230aac10772676875a08271190462bcb62978"></a>UNUM_ROUND_HALF_FLOOR </td><td class="fielddoc"><p>Rounds ties toward -∞. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006755">Stable:</a></b></dt><dd>ICU 69 </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="unumberoptions_8h_source.html#l00028">28</a> of file <a class="el" href="unumberoptions_8h_source.html">unumberoptions.h</a>.</p>
</div>
</div>
<a id="af65963668dc167072ff07ee8d844e87e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af65963668dc167072ff07ee8d844e87e">◆ </a></span>UNumberGroupingStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="unumberoptions_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). </p>
<p>The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in <em>en-IN</em>:</p>
<ul>
<li>
OFF: 1234 and 12345 </li>
<li>
MIN2: 1234 and 12,34,567 </li>
<li>
AUTO: 1,234 and 12,34,567 </li>
<li>
ON_ALIGNED: 1,234 and 12,34,567 </li>
<li>
THOUSANDS: 1,234 and 1,234,567 </li>
</ul>
<p>The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.</p>
<p>Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006750">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87eac60d2b94abb99aea4787c2dd367110c0"></a>UNUM_GROUPING_OFF </td><td class="fielddoc"><p>Do not display grouping separators in any locale. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006756">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea30ca25de042e6f4fda0fab0551024854"></a>UNUM_GROUPING_MIN2 </td><td class="fielddoc"><p>Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (such that there is a <em>minimum of two digits</em> before the first separator). </p>
<p>Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).</p>
<p>Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006757">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea574af658ab523f91dfe05577d1e7a7f9"></a>UNUM_GROUPING_AUTO </td><td class="fielddoc"><p>Display grouping using the default strategy for all locales. </p>
<p>This is the default behavior.</p>
<p>Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).</p>
<p>Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006758">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea37fb1e6f342dce66f12802a8218b81c4"></a>UNUM_GROUPING_ON_ALIGNED </td><td class="fielddoc"><p>Always display the grouping separator on values of at least 1000. </p>
<p>This option ignores the locale data that restricts or disables grouping, described in MIN2 and AUTO. This option may be useful to normalize the alignment of numbers, such as in a spreadsheet.</p>
<p>Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006759">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea2df6e82442d711199dceebe6df80dbe6"></a>UNUM_GROUPING_THOUSANDS </td><td class="fielddoc"><p>Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater. </p>
<p>Do not use locale data for determining the grouping strategy.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006760">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ead8dfc5546d9b427968743e004c3ff43c"></a>UNUM_GROUPING_COUNT </td><td class="fielddoc"><p>One more than the highest UNumberGroupingStrategy value. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000899">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 62: The numeric value may change over time; see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="unumberoptions_8h_source.html#l00096">96</a> of file <a class="el" href="unumberoptions_8h_source.html">unumberoptions.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>