PNG  IHDR pHYs   OiCCPPhotoshop ICC profilexڝSgTS=BKKoR RB&*! J!QEEȠQ, !{kּ> H3Q5 B.@ $pd!s#~<<+"x M0B\t8K@zB@F&S`cbP-`'{[! eDh;VEX0fK9-0IWfH  0Q){`##xFW<+*x<$9E[-qWW.(I+6aa@.y24x6_-"bbϫp@t~,/;m%h^ uf@Wp~<5j>{-]cK'Xto(hw?G%fIq^D$.Tʳ?D*A, `6B$BB dr`)B(Ͱ*`/@4Qhp.U=pa( Aa!ڈbX#!H$ ɈQ"K5H1RT UH=r9\F;2G1Q= C7F dt1r=6Ыhڏ>C03l0.B8, c˱" VcϱwE 6wB aAHXLXNH $4 7 Q'"K&b21XH,#/{C7$C2'ITFnR#,4H#dk9, +ȅ3![ b@qS(RjJ4e2AURݨT5ZBRQ4u9̓IKhhitݕNWGw Ljg(gwLӋT071oUX**| J&*/Tު UUT^S}FU3S ԖUPSSg;goT?~YYLOCQ_ cx,!k u5&|v*=9C3J3WRf?qtN (~))4L1e\kXHQG6EYAJ'\'GgSSݧ M=:.kDwn^Loy}/TmG X $ <5qo</QC]@Caaᄑ.ȽJtq]zۯ6iܟ4)Y3sCQ? 0k߬~OCOg#/c/Wװwa>>r><72Y_7ȷOo_C#dz%gA[z|!?:eAAA!h쐭!ΑiP~aa~ 'W?pX15wCsDDDޛg1O9-J5*>.j<74?.fYXXIlK9.*6nl {/]py.,:@LN8A*%w% yg"/6шC\*NH*Mz쑼5y$3,幄'L Lݛ:v m2=:1qB!Mggfvˬen/kY- BTZ(*geWf͉9+̳ې7ᒶKW-X潬j9(xoʿܔĹdff-[n ڴ VE/(ۻCɾUUMfeI?m]Nmq#׹=TR+Gw- 6 U#pDy  :v{vg/jBFS[b[O>zG499?rCd&ˮ/~јѡ򗓿m|x31^VwwO| (hSЧc3- cHRMz%u0`:o_F@8N ' p @8N@8}' p '#@8N@8N pQ9p!i~}|6-ӪG` VP.@*j>[ K^<֐Z]@8N'KQ<Q(`s" 'hgpKB`R@Dqj '  'P$a ( `D$Na L?u80e J,K˷NI'0eݷ(NI'؀ 2ipIIKp`:O'`ʤxB8Ѥx Ѥx $ $P6 :vRNb 'p,>NB 'P]-->P T+*^h& p '‰a ‰ (ĵt#u33;Nt̵'ޯ; [3W ~]0KH1q@8]O2]3*̧7# *p>us p _6]/}-4|t'|Smx= DoʾM×M_8!)6lq':l7!|4} '\ne t!=hnLn (~Dn\+‰_4k)0e@OhZ`F `.m1} 'vp{F`ON7Srx 'D˸nV`><;yMx!IS钦OM)Ե٥x 'DSD6bS8!" ODz#R >S8!7ّxEh0m$MIPHi$IvS8IN$I p$O8I,sk&I)$IN$Hi$I^Ah.p$MIN$IR8I·N "IF9Ah0m$MIN$IR8IN$I 3jIU;kO$ɳN$+ q.x* tEXtComment

Viewing File: /opt/alt/alt-nodejs18/root/usr/share/doc/alt-nodejs18-libicu-doc/classicu_1_1PluralRules.html

<!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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 74.2: icu::PluralRules Class 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="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 74.2
   &#160;<span id="projectnumber">74.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1PluralRules.html">PluralRules</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">icu::PluralRules Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Defines rules for mapping non-negative numeric values onto a small set of keywords.  
 <a href="classicu_1_1PluralRules.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="plurrule_8h_source.html">plurrule.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for icu::PluralRules:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classicu_1_1PluralRules.png" usemap="#icu::PluralRules_map" alt=""/>
  <map id="icu::PluralRules_map" name="icu::PluralRules_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU &quot;boilerplate&quot; class." alt="icu::UObject" shape="rect" coords="0,56,99,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class." alt="icu::UMemory" shape="rect" coords="0,0,99,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a52405d678e0c1c8120f95b15e96842fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a52405d678e0c1c8120f95b15e96842fb">PluralRules</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a52405d678e0c1c8120f95b15e96842fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classicu_1_1PluralRules.html#a52405d678e0c1c8120f95b15e96842fb">More...</a><br /></td></tr>
<tr class="separator:a52405d678e0c1c8120f95b15e96842fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d6658aa865e1a118a0d07f4ce8da76"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a63d6658aa865e1a118a0d07f4ce8da76">PluralRules</a> (const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;other)</td></tr>
<tr class="memdesc:a63d6658aa865e1a118a0d07f4ce8da76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="classicu_1_1PluralRules.html#a63d6658aa865e1a118a0d07f4ce8da76">More...</a><br /></td></tr>
<tr class="separator:a63d6658aa865e1a118a0d07f4ce8da76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b3290ba522285fbb1ff6382b7d2ac95"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a7b3290ba522285fbb1ff6382b7d2ac95">~PluralRules</a> ()</td></tr>
<tr class="memdesc:a7b3290ba522285fbb1ff6382b7d2ac95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="classicu_1_1PluralRules.html#a7b3290ba522285fbb1ff6382b7d2ac95">More...</a><br /></td></tr>
<tr class="separator:a7b3290ba522285fbb1ff6382b7d2ac95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e0a1025ba0e1e8b0be9ea3d6f3bfd94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a7e0a1025ba0e1e8b0be9ea3d6f3bfd94">clone</a> () const</td></tr>
<tr class="memdesc:a7e0a1025ba0e1e8b0be9ea3d6f3bfd94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone.  <a href="classicu_1_1PluralRules.html#a7e0a1025ba0e1e8b0be9ea3d6f3bfd94">More...</a><br /></td></tr>
<tr class="separator:a7e0a1025ba0e1e8b0be9ea3d6f3bfd94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a131ad396652cc2cd03308547f242ea5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a131ad396652cc2cd03308547f242ea5e">operator=</a> (const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;)</td></tr>
<tr class="memdesc:a131ad396652cc2cd03308547f242ea5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="classicu_1_1PluralRules.html#a131ad396652cc2cd03308547f242ea5e">More...</a><br /></td></tr>
<tr class="separator:a131ad396652cc2cd03308547f242ea5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa580f6f012d4167e7ac32c6fe273b00c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c">select</a> (int32_t number) const</td></tr>
<tr class="memdesc:aa580f6f012d4167e7ac32c6fe273b00c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given an integer, returns the keyword of the first rule that applies to the number.  <a href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c">More...</a><br /></td></tr>
<tr class="separator:aa580f6f012d4167e7ac32c6fe273b00c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a838daac203377d5a61474fbc25529b3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a838daac203377d5a61474fbc25529b3d">select</a> (double number) const</td></tr>
<tr class="memdesc:a838daac203377d5a61474fbc25529b3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a floating-point number, returns the keyword of the first rule that applies to the number.  <a href="classicu_1_1PluralRules.html#a838daac203377d5a61474fbc25529b3d">More...</a><br /></td></tr>
<tr class="separator:a838daac203377d5a61474fbc25529b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e3b5db553ade93319e7ba98503283c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a1e3b5db553ade93319e7ba98503283c3">select</a> (const <a class="el" href="classicu_1_1number_1_1FormattedNumber.html">number::FormattedNumber</a> &amp;number, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status) const</td></tr>
<tr class="memdesc:a1e3b5db553ade93319e7ba98503283c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a formatted number, returns the keyword of the first rule that applies to the number.  <a href="classicu_1_1PluralRules.html#a1e3b5db553ade93319e7ba98503283c3">More...</a><br /></td></tr>
<tr class="separator:a1e3b5db553ade93319e7ba98503283c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c0abd3c600c72c3ddd932f308450412"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a2c0abd3c600c72c3ddd932f308450412">select</a> (const <a class="el" href="classicu_1_1number_1_1FormattedNumberRange.html">number::FormattedNumberRange</a> &amp;range, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status) const</td></tr>
<tr class="memdesc:a2c0abd3c600c72c3ddd932f308450412"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a formatted number range, returns the overall plural form of the range.  <a href="classicu_1_1PluralRules.html#a2c0abd3c600c72c3ddd932f308450412">More...</a><br /></td></tr>
<tr class="separator:a2c0abd3c600c72c3ddd932f308450412"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca3e2ff95381edb13563217ea373aeeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#aca3e2ff95381edb13563217ea373aeeb">select</a> (const IFixedDecimal &amp;number) const</td></tr>
<tr class="separator:aca3e2ff95381edb13563217ea373aeeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a724020b697ed12c5a0952002686ba4bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a724020b697ed12c5a0952002686ba4bc">select</a> (const number::impl::UFormattedNumberRangeData *urange, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status) const</td></tr>
<tr class="separator:a724020b697ed12c5a0952002686ba4bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bca6dcd52b4ea7084d9c68a06028c56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a1bca6dcd52b4ea7084d9c68a06028c56">getKeywords</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status) const</td></tr>
<tr class="memdesc:a1bca6dcd52b4ea7084d9c68a06028c56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a list of all rule keywords used in this <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object.  <a href="classicu_1_1PluralRules.html#a1bca6dcd52b4ea7084d9c68a06028c56">More...</a><br /></td></tr>
<tr class="separator:a1bca6dcd52b4ea7084d9c68a06028c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f73a4b7a787b93832c8c19cf66e8d5a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a6f73a4b7a787b93832c8c19cf66e8d5a">getUniqueKeywordValue</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;keyword)</td></tr>
<tr class="memdesc:a6f73a4b7a787b93832c8c19cf66e8d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated Function, does not return useful results.  <a href="classicu_1_1PluralRules.html#a6f73a4b7a787b93832c8c19cf66e8d5a">More...</a><br /></td></tr>
<tr class="separator:a6f73a4b7a787b93832c8c19cf66e8d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac880a9ac428c7dbfcd52ec0c8a11c4ab"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#ac880a9ac428c7dbfcd52ec0c8a11c4ab">getAllKeywordValues</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;keyword, double *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:ac880a9ac428c7dbfcd52ec0c8a11c4ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated Function, does not produce useful results.  <a href="classicu_1_1PluralRules.html#ac880a9ac428c7dbfcd52ec0c8a11c4ab">More...</a><br /></td></tr>
<tr class="separator:ac880a9ac428c7dbfcd52ec0c8a11c4ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab20320b1f7ddc48f900712a9a88948a7"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#ab20320b1f7ddc48f900712a9a88948a7">getSamples</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;keyword, double *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:ab20320b1f7ddc48f900712a9a88948a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns sample values for which <a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c" title="Given an integer, returns the keyword of the first rule that applies to the number.">select()</a> would return the keyword.  <a href="classicu_1_1PluralRules.html#ab20320b1f7ddc48f900712a9a88948a7">More...</a><br /></td></tr>
<tr class="separator:ab20320b1f7ddc48f900712a9a88948a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab97296809532852ed88b975319482ed9"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#ab97296809532852ed88b975319482ed9">getSamples</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;keyword, DecimalQuantity *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:ab97296809532852ed88b975319482ed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal-only function that returns DecimalQuantitys instead of doubles.  <a href="classicu_1_1PluralRules.html#ab97296809532852ed88b975319482ed9">More...</a><br /></td></tr>
<tr class="separator:ab97296809532852ed88b975319482ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cddc6eef6354bb39fb2e9ebefc6157a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a4cddc6eef6354bb39fb2e9ebefc6157a">isKeyword</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;keyword) const</td></tr>
<tr class="memdesc:a4cddc6eef6354bb39fb2e9ebefc6157a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the given keyword is defined in this <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object.  <a href="classicu_1_1PluralRules.html#a4cddc6eef6354bb39fb2e9ebefc6157a">More...</a><br /></td></tr>
<tr class="separator:a4cddc6eef6354bb39fb2e9ebefc6157a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a870a1b30d44337df274037efbceec6a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a870a1b30d44337df274037efbceec6a6">getKeywordOther</a> () const</td></tr>
<tr class="memdesc:a870a1b30d44337df274037efbceec6a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns keyword for default plural form.  <a href="classicu_1_1PluralRules.html#a870a1b30d44337df274037efbceec6a6">More...</a><br /></td></tr>
<tr class="separator:a870a1b30d44337df274037efbceec6a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b45c746e7d9ca64fc9dbcd994701eb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a9b45c746e7d9ca64fc9dbcd994701eb4">getRules</a> () const</td></tr>
<tr class="separator:a9b45c746e7d9ca64fc9dbcd994701eb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca902facb0d1ea29a1a1f8aa060c2661"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#aca902facb0d1ea29a1a1f8aa060c2661">operator==</a> (const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;other) const</td></tr>
<tr class="memdesc:aca902facb0d1ea29a1a1f8aa060c2661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the equality of two <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> objects.  <a href="classicu_1_1PluralRules.html#aca902facb0d1ea29a1a1f8aa060c2661">More...</a><br /></td></tr>
<tr class="separator:aca902facb0d1ea29a1a1f8aa060c2661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba513b1d554580dafc7f9bafc559b4c5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#aba513b1d554580dafc7f9bafc559b4c5">operator!=</a> (const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;other) const</td></tr>
<tr class="memdesc:aba513b1d554580dafc7f9bafc559b4c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the inequality of two <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> objects.  <a href="classicu_1_1PluralRules.html#aba513b1d554580dafc7f9bafc559b4c5">More...</a><br /></td></tr>
<tr class="separator:aba513b1d554580dafc7f9bafc559b4c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ebba248ab85e8711955097ef03e65a8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a2ebba248ab85e8711955097ef03e65a8">getDynamicClassID</a> () const override</td></tr>
<tr class="memdesc:a2ebba248ab85e8711955097ef03e65a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class.  <a href="classicu_1_1PluralRules.html#a2ebba248ab85e8711955097ef03e65a8">More...</a><br /></td></tr>
<tr class="separator:a2ebba248ab85e8711955097ef03e65a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr>
<tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a441a6a1769272dca17e4af3c43fffcb2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a441a6a1769272dca17e4af3c43fffcb2">createRules</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;description, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a441a6a1769272dca17e4af3c43fffcb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> from a description if it is parsable, otherwise returns nullptr.  <a href="classicu_1_1PluralRules.html#a441a6a1769272dca17e4af3c43fffcb2">More...</a><br /></td></tr>
<tr class="separator:a441a6a1769272dca17e4af3c43fffcb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4859a720d5a9a68bc34e98c51ef485b8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a4859a720d5a9a68bc34e98c51ef485b8">createDefaultRules</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a4859a720d5a9a68bc34e98c51ef485b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default rules that accept any number.  <a href="classicu_1_1PluralRules.html#a4859a720d5a9a68bc34e98c51ef485b8">More...</a><br /></td></tr>
<tr class="separator:a4859a720d5a9a68bc34e98c51ef485b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eea7bd79c325a93386b86356c4c0847"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a2eea7bd79c325a93386b86356c4c0847">forLocale</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a2eea7bd79c325a93386b86356c4c0847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the predefined cardinal-number <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> for a given locale.  <a href="classicu_1_1PluralRules.html#a2eea7bd79c325a93386b86356c4c0847">More...</a><br /></td></tr>
<tr class="separator:a2eea7bd79c325a93386b86356c4c0847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2339320cb3578b7734da68502d59e30"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#aa2339320cb3578b7734da68502d59e30">forLocale</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;locale, <a class="el" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:aa2339320cb3578b7734da68502d59e30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the predefined <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> for a given locale and the plural type.  <a href="classicu_1_1PluralRules.html#aa2339320cb3578b7734da68502d59e30">More...</a><br /></td></tr>
<tr class="separator:aa2339320cb3578b7734da68502d59e30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f46bf2cc839e8faf97e7a29dec528df"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a2f46bf2cc839e8faf97e7a29dec528df">getAvailableLocales</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a2f46bf2cc839e8faf97e7a29dec528df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for &#39;pure&#39; C++ implementations of uenum api.">StringEnumeration</a> over the locales for which there is plurals data.  <a href="classicu_1_1PluralRules.html#a2f46bf2cc839e8faf97e7a29dec528df">More...</a><br /></td></tr>
<tr class="separator:a2f46bf2cc839e8faf97e7a29dec528df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a367e63364bb0785089e6adb6dd02d2ff"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a367e63364bb0785089e6adb6dd02d2ff">internalForLocale</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;locale, <a class="el" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a367e63364bb0785089e6adb6dd02d2ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">For ICU use only.  <a href="classicu_1_1PluralRules.html#a367e63364bb0785089e6adb6dd02d2ff">More...</a><br /></td></tr>
<tr class="separator:a367e63364bb0785089e6adb6dd02d2ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9caef6e34123c38e9b3667d20d0fb7ac"><td class="memItemLeft" align="right" valign="top">static const SharedPluralRules *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#a9caef6e34123c38e9b3667d20d0fb7ac">createSharedInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;locale, <a class="el" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;status)</td></tr>
<tr class="memdesc:a9caef6e34123c38e9b3667d20d0fb7ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">For ICU use only.  <a href="classicu_1_1PluralRules.html#a9caef6e34123c38e9b3667d20d0fb7ac">More...</a><br /></td></tr>
<tr class="separator:a9caef6e34123c38e9b3667d20d0fb7ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae741f376cc3a23cc6339d3bbbdbd4bd8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1PluralRules.html#ae741f376cc3a23cc6339d3bbbdbd4bd8">getStaticClassID</a> (void)</td></tr>
<tr class="memdesc:ae741f376cc3a23cc6339d3bbbdbd4bd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class.  <a href="classicu_1_1PluralRules.html#ae741f376cc3a23cc6339d3bbbdbd4bd8">More...</a><br /></td></tr>
<tr class="separator:ae741f376cc3a23cc6339d3bbbdbd4bd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a92891fa2064833da14ca335f2f82a9b0"><td class="memItemLeft" align="right" valign="top"><a id="a92891fa2064833da14ca335f2f82a9b0"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>PluralRuleParser</b></td></tr>
<tr class="separator:a92891fa2064833da14ca335f2f82a9b0"><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>Defines rules for mapping non-negative numeric values onto a small set of keywords. </p>
<p>Rules are constructed from a text description, consisting of a series of keywords and conditions. The <a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c">select</a> method examines each condition in order and returns the keyword for the first condition that matches the number. If none match, default rule(other) is returned.</p>
<p>For more information, details, and tips for writing rules, see the LDML spec, Part 3.5 Language Plural Rules: <a href="https://www.unicode.org/reports/tr35/tr35-numbers.html#Language_Plural_Rules">https://www.unicode.org/reports/tr35/tr35-numbers.html#Language_Plural_Rules</a></p>
<p>Examples:</p><pre>
   "one: n is 1; few: n in 2..4"</pre><p> This defines two rules, for 'one' and 'few'. The condition for 'one' is "n is 1" which means that the number must be equal to 1 for this condition to pass. The condition for 'few' is "n in 2..4" which means that the number must be between 2 and 4 inclusive for this condition to pass. All other numbers are assigned the keyword "other" by the default rule. </p>
<pre>
    "zero: n is 0; one: n is 1; zero: n mod 100 in 1..19"</pre><p> This illustrates that the same keyword can be defined multiple times. Each rule is examined in order, and the first keyword whose condition passes is the one returned. Also notes that a modulus is applied to n in the last rule. Thus its condition holds for 119, 219, 319... </p>
<pre>
    "one: n is 1; few: n mod 10 in 2..4 and n mod 100 not in 12..14"</pre><p> This illustrates conjunction and negation. The condition for 'few' has two parts, both of which must be met: "n mod 10 in 2..4" and "n mod 100 not in 12..14". The first part applies a modulus to n before the test as in the previous example. The second part applies a different modulus and also uses negation, thus it matches all numbers <em>not</em> in 12, 13, 14, 112, 113, 114, 212, 213, 214... </p>
<p>Syntax:</p><pre>
<div class="fragment"><div class="line">rules         = rule (<span class="charliteral">&#39;;&#39;</span> rule)*</div>
<div class="line">rule          = keyword <span class="charliteral">&#39;:&#39;</span> condition</div>
<div class="line">keyword       = &lt;identifier&gt;</div>
<div class="line">condition     = and_condition (<span class="stringliteral">&#39;or&#39;</span> and_condition)*</div>
<div class="line">and_condition = relation (<span class="stringliteral">&#39;and&#39;</span> relation)*</div>
<div class="line">relation      = is_relation | in_relation | within_relation | <span class="charliteral">&#39;n&#39;</span> &lt;EOL&gt;</div>
<div class="line">is_relation   = expr <span class="stringliteral">&#39;is&#39;</span> (<span class="stringliteral">&#39;not&#39;</span>)? value</div>
<div class="line">in_relation   = expr (<span class="stringliteral">&#39;not&#39;</span>)? <span class="stringliteral">&#39;in&#39;</span> range_list</div>
<div class="line">within_relation = expr (<span class="stringliteral">&#39;not&#39;</span>)? <span class="stringliteral">&#39;within&#39;</span> range</div>
<div class="line">expr          = (<span class="charliteral">&#39;n&#39;</span> | <span class="charliteral">&#39;i&#39;</span> | <span class="charliteral">&#39;f&#39;</span> | <span class="charliteral">&#39;v&#39;</span> | <span class="charliteral">&#39;j&#39;</span>) (<span class="stringliteral">&#39;mod&#39;</span> value)?</div>
<div class="line">range_list    = (range | value) (<span class="charliteral">&#39;,&#39;</span> range_list)*</div>
<div class="line">value         = digit+  (<span class="charliteral">&#39;.&#39;</span> digit+)?</div>
<div class="line">digit         = 0|1|2|3|4|5|6|7|8|9</div>
<div class="line">range         = value<span class="stringliteral">&#39;..&#39;</span>value</div>
</div><!-- fragment -->
 </pre><p>&lt;/p</p><blockquote class="doxtable">
<p></p>
</blockquote>
<p>The i, f, and v values are defined as follows: </p>
<ul>
<li>
i to be the integer digits. </li>
<li>
f to be the visible fractional digits, as an integer. </li>
<li>
v to be the number of visible fraction digits. </li>
<li>
j is defined to only match integers. That is j is 3 fails if v != 0 (eg for 3.1 or 3.0). </li>
</ul>
<p>Examples are in the following table: </p>
<table border="1" style="border-collapse:collapse">
<tr>
<th>n </th><th>i </th><th>f </th><th>v  </th></tr>
<tr>
<td>1.0 </td><td>1 </td><td align="right">0 </td><td>1  </td></tr>
<tr>
<td>1.00 </td><td>1 </td><td align="right">0 </td><td>2  </td></tr>
<tr>
<td>1.3 </td><td>1 </td><td align="right">3 </td><td>1  </td></tr>
<tr>
<td>1.03 </td><td>1 </td><td align="right">3 </td><td>2  </td></tr>
<tr>
<td>1.23 </td><td>1 </td><td align="right">23 </td><td>2  </td></tr>
</table>
<p>The difference between 'in' and 'within' is that 'in' only includes integers in the specified range, while 'within' includes all values. Using 'within' with a range_list consisting entirely of values is the same as using 'in' (it's not an error). </p>
<p>An "identifier" is a sequence of characters that do not have the Unicode Pattern_Syntax or Pattern_White_Space properties. </p>
<p>The difference between 'in' and 'within' is that 'in' only includes integers in the specified range, while 'within' includes all values. Using 'within' with a range_list consisting entirely of values is the same as using 'in' (it's not an error). </p>
<p>Keywords could be defined by users or from ICU locale data. There are 6 predefined values in ICU - 'zero', 'one', 'two', 'few', 'many' and 'other'. Callers need to check the value of keyword returned by <a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c">select</a> method. </p>
<p>Examples:</p><pre>
 <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> keyword = pl-&gt;select(number);
 if (keyword== <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>("one") {
     ...
 }
 else if ( ... )
 </pre><p> <b>Note:</b><br  />
 </p>
<p>ICU defines plural rules for many locales based on CLDR <em>Language Plural Rules</em>. For these predefined rules, see CLDR page at <a href="https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/language_plural_rules.html">https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/language_plural_rules.html</a> </p>

<p class="definition">Definition at line <a class="el" href="plurrule_8h_source.html#l00212">212</a> of file <a class="el" href="plurrule_8h_source.html">plurrule.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a52405d678e0c1c8120f95b15e96842fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52405d678e0c1c8120f95b15e96842fb">&#9670;&nbsp;</a></span>PluralRules() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">icu::PluralRules::PluralRules </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">status</td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call.</td></tr>
  </table>
  </dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005075">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a63d6658aa865e1a118a0d07f4ce8da76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d6658aa865e1a118a0d07f4ce8da76">&#9670;&nbsp;</a></span>PluralRules() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">icu::PluralRules::PluralRules </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy constructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005076">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a7b3290ba522285fbb1ff6382b7d2ac95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b3290ba522285fbb1ff6382b7d2ac95">&#9670;&nbsp;</a></span>~PluralRules()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual icu::PluralRules::~PluralRules </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005077">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7e0a1025ba0e1e8b0be9ea3d6f3bfd94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e0a1025ba0e1e8b0be9ea3d6f3bfd94">&#9670;&nbsp;</a></span>clone()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>* icu::PluralRules::clone </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clone. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005078">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a4859a720d5a9a68bc34e98c51ef485b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4859a720d5a9a68bc34e98c51ef485b8">&#9670;&nbsp;</a></span>createDefaultRules()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>* icu::PluralRules::createDefaultRules </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The default rules that accept any number. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">status</td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> pointer. nullptr if there is an error. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005081">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a441a6a1769272dca17e4af3c43fffcb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a441a6a1769272dca17e4af3c43fffcb2">&#9670;&nbsp;</a></span>createRules()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>* icu::PluralRules::createRules </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;&#160;</td>
          <td class="paramname"><em>description</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> from a description if it is parsable, otherwise returns nullptr. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">description</td><td>rule description </td></tr>
    <tr><td class="paramname">status</td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> pointer. nullptr if there is an error. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005080">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a9caef6e34123c38e9b3667d20d0fb7ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9caef6e34123c38e9b3667d20d0fb7ac">&#9670;&nbsp;</a></span>createSharedInstance()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const SharedPluralRules* icu::PluralRules::createSharedInstance </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;&#160;</td>
          <td class="paramname"><em>locale</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>For ICU use only. </p>
<p>Returns handle to the shared, cached <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> instance. Caller must call removeRef() on returned value once it is done with the shared instance. </p><dl class="internal"><dt><b><a class="el" href="internal.html#_internal000469">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

</div>
</div>
<a id="a2eea7bd79c325a93386b86356c4c0847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2eea7bd79c325a93386b86356c4c0847">&#9670;&nbsp;</a></span>forLocale() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>* icu::PluralRules::forLocale </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;&#160;</td>
          <td class="paramname"><em>locale</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Provides access to the predefined cardinal-number <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> for a given locale. </p>
<p>Same as forLocale(locale, UPLURAL_TYPE_CARDINAL, status).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">locale</td><td>The locale for which a <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object is returned. </td></tr>
    <tr><td class="paramname">status</td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The predefined <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object pointer for this locale. If there's no predefined rules for this locale, the rules for the closest parent in the locale hierarchy that has one will be returned. The final fallback always returns the default 'other' rules. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005082">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="aa2339320cb3578b7734da68502d59e30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2339320cb3578b7734da68502d59e30">&#9670;&nbsp;</a></span>forLocale() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>* icu::PluralRules::forLocale </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;&#160;</td>
          <td class="paramname"><em>locale</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Provides access to the predefined <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> for a given locale and the plural type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">locale</td><td>The locale for which a <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object is returned. </td></tr>
    <tr><td class="paramname">type</td><td>The plural type (e.g., cardinal or ordinal). </td></tr>
    <tr><td class="paramname">status</td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The predefined <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object pointer for this locale. If there's no predefined rules for this locale, the rules for the closest parent in the locale hierarchy that has one will be returned. The final fallback always returns the default 'other' rules. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005083">Stable:</a></b></dt><dd>ICU 50 </dd></dl>

</div>
</div>
<a id="ac880a9ac428c7dbfcd52ec0c8a11c4ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac880a9ac428c7dbfcd52ec0c8a11c4ab">&#9670;&nbsp;</a></span>getAllKeywordValues()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t icu::PluralRules::getAllKeywordValues </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;&#160;</td>
          <td class="paramname"><em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>destCapacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deprecated Function, does not produce useful results. </p>
<p>Originally intended to return all the values for which <a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c" title="Given an integer, returns the keyword of the first rule that applies to the number.">select()</a> would return the keyword. If the keyword is unknown, returns no values, but this is not an error. If the number of values is unlimited, returns no values and -1 as the count.</p>
<p>The number of returned values is typically small.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keyword</td><td>The keyword. </td></tr>
    <tr><td class="paramname">dest</td><td>Array into which to put the returned values. May be nullptr if destCapacity is 0. </td></tr>
    <tr><td class="paramname">destCapacity</td><td>The capacity of the array, must be at least 0. </td></tr>
    <tr><td class="paramname">status</td><td>The error code. Deprecated function, always sets U_UNSUPPORTED_ERROR. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The count of values available, or -1. This count can be larger than destCapacity, but no more than destCapacity values will be written. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000356">Deprecated:</a></b></dt><dd>ICU 55 </dd></dl>

</div>
</div>
<a id="a2f46bf2cc839e8faf97e7a29dec528df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f46bf2cc839e8faf97e7a29dec528df">&#9670;&nbsp;</a></span>getAvailableLocales()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::PluralRules::getAvailableLocales </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for &#39;pure&#39; C++ implementations of uenum api.">StringEnumeration</a> over the locales for which there is plurals data. </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for &#39;pure&#39; C++ implementations of uenum api.">StringEnumeration</a> over the locales available. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000467">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

</div>
</div>
<a id="a2ebba248ab85e8711955097ef03e65a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ebba248ab85e8711955097ef03e65a8">&#9670;&nbsp;</a></span>getDynamicClassID()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::PluralRules::getDynamicClassID </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>ICU "poor man's RTTI", returns a UClassID for the actual class. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005095">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1UObject.html#aca1169c4978c52ce2b76eda104e9a214">icu::UObject</a>.</p>

</div>
</div>
<a id="a870a1b30d44337df274037efbceec6a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a870a1b30d44337df274037efbceec6a6">&#9670;&nbsp;</a></span>getKeywordOther()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::getKeywordOther </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns keyword for default plural form. </p>
<dl class="section return"><dt>Returns</dt><dd>keyword for default plural form. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005091">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a1bca6dcd52b4ea7084d9c68a06028c56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bca6dcd52b4ea7084d9c68a06028c56">&#9670;&nbsp;</a></span>getKeywords()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::PluralRules::getKeywords </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a list of all rule keywords used in this <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object. </p>
<p>The rule 'other' is always present by default.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">status</td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for &#39;pure&#39; C++ implementations of uenum api.">StringEnumeration</a> with the keywords. The caller must delete the object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005088">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="a9b45c746e7d9ca64fc9dbcd994701eb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b45c746e7d9ca64fc9dbcd994701eb4">&#9670;&nbsp;</a></span>getRules()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::getRules </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000473">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>

</div>
</div>
<a id="ab97296809532852ed88b975319482ed9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab97296809532852ed88b975319482ed9">&#9670;&nbsp;</a></span>getSamples() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t icu::PluralRules::getSamples </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;&#160;</td>
          <td class="paramname"><em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">DecimalQuantity *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>destCapacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internal-only function that returns DecimalQuantitys instead of doubles. </p>
<p>Returns sample values for which <a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c" title="Given an integer, returns the keyword of the first rule that applies to the number.">select()</a> would return the keyword. If the keyword is unknown, returns no values, but this is not an error.</p>
<p>The number of returned values is typically small.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keyword</td><td>The keyword. </td></tr>
    <tr><td class="paramname">dest</td><td>Array into which to put the returned values. May be nullptr if destCapacity is 0. </td></tr>
    <tr><td class="paramname">destCapacity</td><td>The capacity of the array, must be at least 0. </td></tr>
    <tr><td class="paramname">status</td><td>The error code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The count of values written. If more than destCapacity samples are available, then only destCapacity are written, and destCapacity is returned as the count, rather than setting a U_BUFFER_OVERFLOW_ERROR. (The actual number of keyword values could be unlimited.) </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000472">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

</div>
</div>
<a id="ab20320b1f7ddc48f900712a9a88948a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab20320b1f7ddc48f900712a9a88948a7">&#9670;&nbsp;</a></span>getSamples() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t icu::PluralRules::getSamples </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;&#160;</td>
          <td class="paramname"><em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>destCapacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns sample values for which <a class="el" href="classicu_1_1PluralRules.html#aa580f6f012d4167e7ac32c6fe273b00c" title="Given an integer, returns the keyword of the first rule that applies to the number.">select()</a> would return the keyword. </p>
<p>If the keyword is unknown, returns no values, but this is not an error.</p>
<p>The number of returned values is typically small.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keyword</td><td>The keyword. </td></tr>
    <tr><td class="paramname">dest</td><td>Array into which to put the returned values. May be nullptr if destCapacity is 0. </td></tr>
    <tr><td class="paramname">destCapacity</td><td>The capacity of the array, must be at least 0. </td></tr>
    <tr><td class="paramname">status</td><td>The error code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The count of values written. If more than destCapacity samples are available, then only destCapacity are written, and destCapacity is returned as the count, rather than setting a U_BUFFER_OVERFLOW_ERROR. (The actual number of keyword values could be unlimited.) </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005089">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>

</div>
</div>
<a id="ae741f376cc3a23cc6339d3bbbdbd4bd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae741f376cc3a23cc6339d3bbbdbd4bd8">&#9670;&nbsp;</a></span>getStaticClassID()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::PluralRules::getStaticClassID </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>ICU "poor man's RTTI", returns a UClassID for this class. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005094">Stable:</a></b></dt><dd>ICU 4.0</dd></dl>

</div>
</div>
<a id="a6f73a4b7a787b93832c8c19cf66e8d5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f73a4b7a787b93832c8c19cf66e8d5a">&#9670;&nbsp;</a></span>getUniqueKeywordValue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double icu::PluralRules::getUniqueKeywordValue </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;&#160;</td>
          <td class="paramname"><em>keyword</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deprecated Function, does not return useful results. </p>
<p>Originally intended to return a unique value for this keyword if it exists, else the constant UPLRULES_NO_UNIQUE_VALUE.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keyword</td><td>The keyword. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Stub deprecated function returns UPLRULES_NO_UNIQUE_VALUE always. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000355">Deprecated:</a></b></dt><dd>ICU 55 </dd></dl>

</div>
</div>
<a id="a367e63364bb0785089e6adb6dd02d2ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a367e63364bb0785089e6adb6dd02d2ff">&#9670;&nbsp;</a></span>internalForLocale()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>* icu::PluralRules::internalForLocale </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> &amp;&#160;</td>
          <td class="paramname"><em>locale</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>For ICU use only. </p>
<p>creates a SharedPluralRules object </p><dl class="internal"><dt><b><a class="el" href="internal.html#_internal000468">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

</div>
</div>
<a id="a4cddc6eef6354bb39fb2e9ebefc6157a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cddc6eef6354bb39fb2e9ebefc6157a">&#9670;&nbsp;</a></span>isKeyword()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::PluralRules::isKeyword </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;&#160;</td>
          <td class="paramname"><em>keyword</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if the given keyword is defined in this <code><a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a></code> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keyword</td><td>the input keyword. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the input keyword is defined. Otherwise, return false. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005090">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="aba513b1d554580dafc7f9bafc559b4c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba513b1d554580dafc7f9bafc559b4c5">&#9670;&nbsp;</a></span>operator!=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool icu::PluralRules::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Compares the inequality of two <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">other</td><td>The <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> object to be compared with. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the given <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> is not the same as this <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a>; false otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005093">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

<p class="definition">Definition at line <a class="el" href="plurrule_8h_source.html#l00547">547</a> of file <a class="el" href="plurrule_8h_source.html">plurrule.h</a>.</p>

<p class="reference">References <a class="el" href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0">icu::operator==()</a>.</p>

</div>
</div>
<a id="a131ad396652cc2cd03308547f242ea5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a131ad396652cc2cd03308547f242ea5e">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1PluralRules.html">PluralRules</a>&amp; icu::PluralRules::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Assignment operator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005079">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="aca902facb0d1ea29a1a1f8aa060c2661"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca902facb0d1ea29a1a1f8aa060c2661">&#9670;&nbsp;</a></span>operator==()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool icu::PluralRules::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1PluralRules.html">PluralRules</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Compares the equality of two <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">other</td><td>The other <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> object to be compared with. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the given <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> is the same as this <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a>; false otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005092">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="aca3e2ff95381edb13563217ea373aeeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca3e2ff95381edb13563217ea373aeeb">&#9670;&nbsp;</a></span>select() <span class="overload">[1/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::select </td>
          <td>(</td>
          <td class="paramtype">const IFixedDecimal &amp;&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000470">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>

</div>
</div>
<a id="a1e3b5db553ade93319e7ba98503283c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e3b5db553ade93319e7ba98503283c3">&#9670;&nbsp;</a></span>select() <span class="overload">[2/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::select </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1number_1_1FormattedNumber.html">number::FormattedNumber</a> &amp;&#160;</td>
          <td class="paramname"><em>number</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Given a formatted number, returns the keyword of the first rule that applies to the number. </p>
<p>This function can be used with isKeyword* functions to determine the keyword for default plural rules.</p>
<p>A FormattedNumber allows you to specify an exponent or trailing zeros, which can affect the plural category. To get a FormattedNumber, see NumberFormatter.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">number</td><td>The number for which the rule has to be determined. </td></tr>
    <tr><td class="paramname">status</td><td>Set if an error occurs while selecting plural keyword. This could happen if the FormattedNumber is invalid. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The keyword of the selected rule. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005086">Stable:</a></b></dt><dd>ICU 64 </dd></dl>

</div>
</div>
<a id="a2c0abd3c600c72c3ddd932f308450412"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c0abd3c600c72c3ddd932f308450412">&#9670;&nbsp;</a></span>select() <span class="overload">[3/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::select </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classicu_1_1number_1_1FormattedNumberRange.html">number::FormattedNumberRange</a> &amp;&#160;</td>
          <td class="paramname"><em>range</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Given a formatted number range, returns the overall plural form of the range. </p>
<p>For example, "3-5" returns "other" in English.</p>
<p>To get a FormattedNumberRange, see NumberRangeFormatter.</p>
<p>This method only works if <a class="el" href="classicu_1_1PluralRules.html" title="Defines rules for mapping non-negative numeric values onto a small set of keywords.">PluralRules</a> was created with a locale. If it was created from <a class="el" href="classicu_1_1PluralRules.html#a441a6a1769272dca17e4af3c43fffcb2" title="Creates a PluralRules from a description if it is parsable, otherwise returns nullptr.">PluralRules::createRules()</a>, this method sets status code U_UNSUPPORTED_ERROR.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">range</td><td>The number range onto which the rules will be applied. </td></tr>
    <tr><td class="paramname">status</td><td>Set if an error occurs while selecting plural keyword. This could happen if the FormattedNumberRange is invalid, or if plural ranges data is unavailable. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The keyword of the selected rule. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005087">Stable:</a></b></dt><dd>ICU 68 </dd></dl>

</div>
</div>
<a id="a724020b697ed12c5a0952002686ba4bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a724020b697ed12c5a0952002686ba4bc">&#9670;&nbsp;</a></span>select() <span class="overload">[4/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::select </td>
          <td>(</td>
          <td class="paramtype">const number::impl::UFormattedNumberRangeData *&#160;</td>
          <td class="paramname"><em>urange</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp;&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000471">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>

</div>
</div>
<a id="a838daac203377d5a61474fbc25529b3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a838daac203377d5a61474fbc25529b3d">&#9670;&nbsp;</a></span>select() <span class="overload">[5/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::select </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Given a floating-point number, returns the keyword of the first rule that applies to the number. </p>
<p>This function can be used with isKeyword* functions to determine the keyword for default plural rules.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">number</td><td>The number for which the rule has to be determined. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The keyword of the selected rule. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005085">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<a id="aa580f6f012d4167e7ac32c6fe273b00c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa580f6f012d4167e7ac32c6fe273b00c">&#9670;&nbsp;</a></span>select() <span class="overload">[6/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::PluralRules::select </td>
          <td>(</td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Given an integer, returns the keyword of the first rule that applies to the number. </p>
<p>This function can be used with isKeyword* functions to determine the keyword for default plural rules.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">number</td><td>The number for which the rule has to be determined. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The keyword of the selected rule. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005084">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>i18n/unicode/<a class="el" href="plurrule_8h_source.html">plurrule.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.1
</small></address>
</body>
</html>
Back to Directory=ceiIENDB`