forked from unicode-org/icu-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassCollationKey.html
694 lines (636 loc) · 49.7 KB
/
classCollationKey.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 75.1: icu::CollationKey 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">ICU 75.1<span id="projectnumber"> 75.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1CollationKey.html">CollationKey</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle"><div class="title">icu::CollationKey Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Collation keys are generated by the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> class.
<a href="classicu_1_1CollationKey.html#details">More...</a></p>
<p><code>#include <<a class="el" href="sortkey_8h_source.html">sortkey.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::CollationKey:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1CollationKey.png" usemap="#icu::CollationKey_map" alt=""/>
<map id="icu::CollationKey_map" name="icu::CollationKey_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class." alt="icu::UObject" shape="rect" coords="0,56,106,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class." alt="icu::UMemory" shape="rect" coords="0,0,106,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abca92dc37f5a3202815dfd07a0f404ff" id="r_abca92dc37f5a3202815dfd07a0f404ff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#abca92dc37f5a3202815dfd07a0f404ff">CollationKey</a> ()</td></tr>
<tr class="memdesc:abca92dc37f5a3202815dfd07a0f404ff"><td class="mdescLeft"> </td><td class="mdescRight">This creates an empty collation key based on the null string. <br /></td></tr>
<tr class="separator:abca92dc37f5a3202815dfd07a0f404ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa41763b6bcf56a0cb10fff00aa0da039" id="r_aa41763b6bcf56a0cb10fff00aa0da039"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#aa41763b6bcf56a0cb10fff00aa0da039">CollationKey</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">uint8_t</a> *<a class="el" href="classicu_1_1LocalPointerBase.html">values</a>, <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> count)</td></tr>
<tr class="memdesc:aa41763b6bcf56a0cb10fff00aa0da039"><td class="mdescLeft"> </td><td class="mdescRight">Creates a collation key based on the collation key values. <br /></td></tr>
<tr class="separator:aa41763b6bcf56a0cb10fff00aa0da039"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f4bc5da09ccd4f2157002c87d7ac1cb" id="r_a3f4bc5da09ccd4f2157002c87d7ac1cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a3f4bc5da09ccd4f2157002c87d7ac1cb">CollationKey</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">other</a>)</td></tr>
<tr class="memdesc:a3f4bc5da09ccd4f2157002c87d7ac1cb"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a3f4bc5da09ccd4f2157002c87d7ac1cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b24b0443f4d54dd4c0539ea4694820c" id="r_a2b24b0443f4d54dd4c0539ea4694820c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a2b24b0443f4d54dd4c0539ea4694820c">~CollationKey</a> ()</td></tr>
<tr class="memdesc:a2b24b0443f4d54dd4c0539ea4694820c"><td class="mdescLeft"> </td><td class="mdescRight">Sort key destructor. <br /></td></tr>
<tr class="separator:a2b24b0443f4d54dd4c0539ea4694820c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a378bce68539ac77543e4226ca01a1842" id="r_a378bce68539ac77543e4226ca01a1842"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a378bce68539ac77543e4226ca01a1842">operator=</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">other</a>)</td></tr>
<tr class="memdesc:a378bce68539ac77543e4226ca01a1842"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a378bce68539ac77543e4226ca01a1842"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4f579d374b648d60584ada39a12b0d5" id="r_ac4f579d374b648d60584ada39a12b0d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#ac4f579d374b648d60584ada39a12b0d5">operator==</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &source) <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:ac4f579d374b648d60584ada39a12b0d5"><td class="mdescLeft"> </td><td class="mdescRight">Compare if two collation keys are the same. <br /></td></tr>
<tr class="separator:ac4f579d374b648d60584ada39a12b0d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfea18546e4a6fb9d6c987f6519e54fe" id="r_acfea18546e4a6fb9d6c987f6519e54fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#acfea18546e4a6fb9d6c987f6519e54fe">operator!=</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &source) <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:acfea18546e4a6fb9d6c987f6519e54fe"><td class="mdescLeft"> </td><td class="mdescRight">Compare if two collation keys are not the same. <br /></td></tr>
<tr class="separator:acfea18546e4a6fb9d6c987f6519e54fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fb3d6ace97ade8f95bf0bbe24dff712" id="r_a5fb3d6ace97ade8f95bf0bbe24dff712"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a5fb3d6ace97ade8f95bf0bbe24dff712">isBogus</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a5fb3d6ace97ade8f95bf0bbe24dff712"><td class="mdescLeft"> </td><td class="mdescRight">Test to see if the key is in an invalid state. <br /></td></tr>
<tr class="separator:a5fb3d6ace97ade8f95bf0bbe24dff712"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a214561cfeda892fdd7ef8595bebc06ba" id="r_a214561cfeda892fdd7ef8595bebc06ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">uint8_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a214561cfeda892fdd7ef8595bebc06ba">getByteArray</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> &count) <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a214561cfeda892fdd7ef8595bebc06ba"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the collation key values. <br /></td></tr>
<tr class="separator:a214561cfeda892fdd7ef8595bebc06ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab087d29231b801ffca0b95d52c9b78e7" id="r_ab087d29231b801ffca0b95d52c9b78e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">Collator::EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#ab087d29231b801ffca0b95d52c9b78e7">compareTo</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &target) <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:ab087d29231b801ffca0b95d52c9b78e7"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method which does a string(bit-wise) comparison of the two collation keys. <br /></td></tr>
<tr class="separator:ab087d29231b801ffca0b95d52c9b78e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa16d772633dcf7d975a216acc4df2713" id="r_aa16d772633dcf7d975a216acc4df2713"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#aa16d772633dcf7d975a216acc4df2713">compareTo</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &target, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>) <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:aa16d772633dcf7d975a216acc4df2713"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method which does a string(bit-wise) comparison of the two collation keys. <br /></td></tr>
<tr class="separator:aa16d772633dcf7d975a216acc4df2713"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb6b60f1dfff6ae336b38cc0f2a89dac" id="r_adb6b60f1dfff6ae336b38cc0f2a89dac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#adb6b60f1dfff6ae336b38cc0f2a89dac">hashCode</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:adb6b60f1dfff6ae336b38cc0f2a89dac"><td class="mdescLeft"> </td><td class="mdescRight">Creates an integer that is unique to the collation key. <br /></td></tr>
<tr class="separator:adb6b60f1dfff6ae336b38cc0f2a89dac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a0f7d6da75a78941fced2dab048b704" id="r_a6a0f7d6da75a78941fced2dab048b704"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a6a0f7d6da75a78941fced2dab048b704">getDynamicClassID</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">override</a></td></tr>
<tr class="memdesc:a6a0f7d6da75a78941fced2dab048b704"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <br /></td></tr>
<tr class="separator:a6a0f7d6da75a78941fced2dab048b704"><td class="memSeparator" colspan="2"> </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="-"/> 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" id="r_af10026497704f510d3d1f2eff50acb18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> </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"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa18953913575f713f4d76452cc8ee002" id="r_aa18953913575f713f4d76452cc8ee002"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">static</a> <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#aa18953913575f713f4d76452cc8ee002">getStaticClassID</a> ()</td></tr>
<tr class="memdesc:aa18953913575f713f4d76452cc8ee002"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <br /></td></tr>
<tr class="separator:aa18953913575f713f4d76452cc8ee002"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a1918e53ed4bb8208fdd6df3ed4ec2548" id="r_a1918e53ed4bb8208fdd6df3ed4ec2548"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">class</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a1918e53ed4bb8208fdd6df3ed4ec2548">RuleBasedCollator</a></td></tr>
<tr class="memdesc:a1918e53ed4bb8208fdd6df3ed4ec2548"><td class="mdescLeft"> </td><td class="mdescRight">Allow private access to <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.">RuleBasedCollator</a>. <br /></td></tr>
<tr class="separator:a1918e53ed4bb8208fdd6df3ed4ec2548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a662b535af7127c0a09c1df2f442f6501" id="r_a662b535af7127c0a09c1df2f442f6501"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">class</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollationKey.html#a662b535af7127c0a09c1df2f442f6501">CollationKeyByteSink</a></td></tr>
<tr class="separator:a662b535af7127c0a09c1df2f442f6501"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Collation keys are generated by the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> class. </p>
<p>Use the <a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> objects instead of <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> to compare strings multiple times. A <a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> preprocesses the comparison information from the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> object to make the comparison faster. If you are not going to comparing strings multiple times, then using the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> object is generally faster, since it only processes as much of the string as needed to make a comparison. </p>
<p>For example (with strength == tertiary) </p>
<p>When comparing "Abernathy" to "Baggins-Smythworthy", <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> only needs to process a couple of characters, while a comparison with CollationKeys will process all of the characters. On the other hand, if you are doing a sort of a number of fields, it is much faster to use CollationKeys, since you will be comparing strings multiple times. </p>
<p>Typical use of CollationKeys are in databases, where you store a <a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> in a hidden field, and use it for sorting or indexing.</p>
<p>Example of use: </p><pre>
<div class="fragment"><div class="line"><a class="code hl_enumeration" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">success</a> = <a class="code hl_enumvalue" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;</div>
<div class="line"><a class="code hl_class" href="classicu_1_1Collator.html">Collator</a>* <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">myCollator</a> = <a class="code hl_function" href="classicu_1_1Collator.html#a0326ea47da9a3e107adeaf3709ac053e">Collator::createInstance</a>(<a class="code hl_class" href="classicu_1_1LocalPointerBase.html">success</a>);</div>
<div class="line"><a class="code hl_class" href="classicu_1_1CollationKey.html">CollationKey</a>* keys = <span class="keyword">new</span> <a class="code hl_class" href="classicu_1_1CollationKey.html">CollationKey</a> [3];</div>
<div class="line"><a class="code hl_class" href="classicu_1_1LocalPointerBase.html">myCollator</a>->getCollationKey(<span class="stringliteral">"Tom"</span>, keys[0], <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">success</a> );</div>
<div class="line"><a class="code hl_class" href="classicu_1_1LocalPointerBase.html">myCollator</a>->getCollationKey(<span class="stringliteral">"Dick"</span>, keys[1], <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">success</a> );</div>
<div class="line"><a class="code hl_class" href="classicu_1_1LocalPointerBase.html">myCollator</a>->getCollationKey(<span class="stringliteral">"Harry"</span>, keys[2], <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">success</a> );</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Inside body of sort routine, compare keys this way:</span></div>
<div class="line"><a class="code hl_class" href="classicu_1_1CollationKey.html">CollationKey</a> <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">tmp</a>;</div>
<div class="line"><span class="keywordflow">if</span>(keys[0].<a class="code hl_function" href="classicu_1_1CollationKey.html#ab087d29231b801ffca0b95d52c9b78e7">compareTo</a>( keys[1] ) > 0 ) {</div>
<div class="line"> <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">tmp</a> = keys[0]; keys[0] = keys[1]; keys[1] = <a class="code hl_class" href="classicu_1_1LocalPointerBase.html">tmp</a>;</div>
<div class="line">}</div>
<div class="line"><span class="comment">//...</span></div>
<div class="ttc" id="aclassicu_1_1CollationKey_html"><div class="ttname"><a href="classicu_1_1CollationKey.html">icu::CollationKey</a></div><div class="ttdoc">Collation keys are generated by the Collator class.</div><div class="ttdef"><b>Definition</b> <a href="sortkey_8h_source.html#l00101">sortkey.h:101</a></div></div>
<div class="ttc" id="aclassicu_1_1CollationKey_html_ab087d29231b801ffca0b95d52c9b78e7"><div class="ttname"><a href="classicu_1_1CollationKey.html#ab087d29231b801ffca0b95d52c9b78e7">icu::CollationKey::compareTo</a></div><div class="ttdeci">Collator::EComparisonResult compareTo(const CollationKey &target) const</div><div class="ttdoc">Convenience method which does a string(bit-wise) comparison of the two collation keys.</div></div>
<div class="ttc" id="aclassicu_1_1Collator_html"><div class="ttname"><a href="classicu_1_1Collator.html">icu::Collator</a></div><div class="ttdoc">The Collator class performs locale-sensitive string comparison.</div><div class="ttdef"><b>Definition</b> <a href="coll_8h_source.html#l00167">coll.h:167</a></div></div>
<div class="ttc" id="aclassicu_1_1Collator_html_a0326ea47da9a3e107adeaf3709ac053e"><div class="ttname"><a href="classicu_1_1Collator.html#a0326ea47da9a3e107adeaf3709ac053e">icu::Collator::createInstance</a></div><div class="ttdeci">static Collator * createInstance(UErrorCode &err)</div><div class="ttdoc">Creates the Collator object for the current default locale.</div></div>
<div class="ttc" id="aclassicu_1_1LocalPointerBase_html"><div class="ttname"><a href="classicu_1_1LocalPointerBase.html">icu::LocalPointerBase</a></div><div class="ttdoc">"Smart pointer" base class; do not use directly: use LocalPointer etc.</div><div class="ttdef"><b>Definition</b> <a href="localpointer_8h_source.html#l00068">localpointer.h:68</a></div></div>
<div class="ttc" id="autypes_8h_html_a3343c1c8a8377277046774691c98d78c"><div class="ttname"><a href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a></div><div class="ttdeci">UErrorCode</div><div class="ttdoc">Standard ICU4C error code type, a substitute for exceptions.</div><div class="ttdef"><b>Definition</b> <a href="utypes_8h_source.html#l00415">utypes.h:415</a></div></div>
<div class="ttc" id="autypes_8h_html_a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9"><div class="ttname"><a href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a></div><div class="ttdeci">@ U_ZERO_ERROR</div><div class="ttdoc">No error, no warning.</div><div class="ttdef"><b>Definition</b> <a href="utypes_8h_source.html#l00450">utypes.h:450</a></div></div>
</div><!-- fragment -->
</pre> <p>Because <a class="el" href="classicu_1_1Collator.html#a40b92eb7b4a2f37c89fcf1caf957fff0" title="The comparison function compares the character data stored in two different strings.">Collator::compare()</a>'s algorithm is complex, it is faster to sort long lists of words by retrieving collation keys with <a class="el" href="classicu_1_1Collator.html#a8c3f49201ce5bdfbdfc0378ee7d54ded" title="Transforms the string into a series of characters that can be compared with CollationKey::compareTo.">Collator::getCollationKey()</a>. You can then cache the collation keys and compare them using <a class="el" href="classicu_1_1CollationKey.html#ab087d29231b801ffca0b95d52c9b78e7" title="Convenience method which does a string(bit-wise) comparison of the two collation keys.">CollationKey::compareTo()</a>. </p>
<p><b>Note:</b> <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a></code>s with different <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>, CollationStrength and DecompositionMode settings will return different CollationKeys for the same set of strings. Locales have specific collation rules, and the way in which secondary and tertiary differences are taken into account, for example, will result in different CollationKeys for same strings. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> </dd>
<dd>
<a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.">RuleBasedCollator</a> </dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.3 12/18/96 </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Helena Shih </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005489">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="sortkey_8h_source.html#l00101">101</a> of file <a class="el" href="sortkey_8h_source.html">sortkey.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="abca92dc37f5a3202815dfd07a0f404ff" name="abca92dc37f5a3202815dfd07a0f404ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abca92dc37f5a3202815dfd07a0f404ff">◆ </a></span>CollationKey() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::CollationKey::CollationKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This creates an empty collation key based on the null string. </p>
<p>An empty collation key contains no sorting information. When comparing two empty collation keys, the result is Collator::EQUAL. Comparing empty collation key with non-empty collation key is always Collator::LESS. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable005490">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="aa41763b6bcf56a0cb10fff00aa0da039" name="aa41763b6bcf56a0cb10fff00aa0da039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa41763b6bcf56a0cb10fff00aa0da039">◆ </a></span>CollationKey() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::CollationKey::CollationKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">uint8_t</a> * </td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a collation key based on the collation key values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">values</td><td>the collation key values </td></tr>
<tr><td class="paramname">count</td><td>number of collation key values, including trailing nulls. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005491">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="a3f4bc5da09ccd4f2157002c87d7ac1cb" name="a3f4bc5da09ccd4f2157002c87d7ac1cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f4bc5da09ccd4f2157002c87d7ac1cb">◆ </a></span>CollationKey() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::CollationKey::CollationKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>the object to be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005492">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="a2b24b0443f4d54dd4c0539ea4694820c" name="a2b24b0443f4d54dd4c0539ea4694820c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b24b0443f4d54dd4c0539ea4694820c">◆ </a></span>~CollationKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> icu::CollationKey::~CollationKey </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>Sort key destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005493">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab087d29231b801ffca0b95d52c9b78e7" name="ab087d29231b801ffca0b95d52c9b78e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab087d29231b801ffca0b95d52c9b78e7">◆ </a></span>compareTo() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">Collator::EComparisonResult</a> icu::CollationKey::compareTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>target</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method which does a string(bit-wise) comparison of the two collation keys. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>target collation key to be compared with </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns Collator::LESS if sourceKey < targetKey, Collator::GREATER if sourceKey > targetKey and Collator::EQUAL otherwise. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000721">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with error code </dd></dl>
</div>
</div>
<a id="aa16d772633dcf7d975a216acc4df2713" name="aa16d772633dcf7d975a216acc4df2713"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa16d772633dcf7d975a216acc4df2713">◆ </a></span>compareTo() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::CollationKey::compareTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method which does a string(bit-wise) comparison of the two collation keys. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>target collation key to be compared with </td></tr>
<tr><td class="paramname">status</td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns UCOL_LESS if sourceKey < targetKey, UCOL_GREATER if sourceKey > targetKey and UCOL_EQUAL otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005499">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a id="a214561cfeda892fdd7ef8595bebc06ba" name="a214561cfeda892fdd7ef8595bebc06ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a214561cfeda892fdd7ef8595bebc06ba">◆ </a></span>getByteArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">uint8_t</a> * icu::CollationKey::getByteArray </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> & </td>
<td class="paramname"><em>count</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>Returns a pointer to the collation key values. </p>
<p>The storage is owned by the collation key and the pointer will become invalid if the key is deleted. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>the output parameter of number of collation key values, including any trailing nulls. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the collation key values. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005498">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="sortkey_8h_source.html#l00332">332</a> of file <a class="el" href="sortkey_8h_source.html">sortkey.h</a>.</p>
</div>
</div>
<a id="a6a0f7d6da75a78941fced2dab048b704" name="a6a0f7d6da75a78941fced2dab048b704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a0f7d6da75a78941fced2dab048b704">◆ </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"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::CollationKey::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#_stable005501">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1UObject.html#aca1169c4978c52ce2b76eda104e9a214">icu::UObject</a>.</p>
</div>
</div>
<a id="aa18953913575f713f4d76452cc8ee002" name="aa18953913575f713f4d76452cc8ee002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa18953913575f713f4d76452cc8ee002">◆ </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"><a class="el" href="classicu_1_1LocalPointerBase.html">static</a> <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::CollationKey::getStaticClassID </td>
<td>(</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#_stable005502">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div>
<a id="adb6b60f1dfff6ae336b38cc0f2a89dac" name="adb6b60f1dfff6ae336b38cc0f2a89dac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb6b60f1dfff6ae336b38cc0f2a89dac">◆ </a></span>hashCode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::CollationKey::hashCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an integer that is unique to the collation key. </p>
<p>NOTE: this is not the same as String.hashCode. </p>
<p>Example of use: </p><pre>
. UErrorCode status = U_ZERO_ERROR;
. <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> *myCollation = Collator::createInstance(Locale::US, status);
. if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(status)</a>) return;
. <a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> key1, key2;
. UErrorCode status1 = U_ZERO_ERROR, status2 = U_ZERO_ERROR;
. myCollation->getCollationKey("abc", key1, status1);
. if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(status1)</a>) { delete myCollation; return; }
. myCollation->getCollationKey("ABC", key2, status2);
. if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(status2)</a>) { delete myCollation; return; }
. // key1.hashCode() != key2.hashCode()
</pre> <dl class="section return"><dt>Returns</dt><dd>the hash value based on the string's collation order. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1UnicodeString.html#a0ada6cdae332b4deb74b78dc3c174869" title="Generate a hash code for this object.">UnicodeString::hashCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005500">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="a5fb3d6ace97ade8f95bf0bbe24dff712" name="a5fb3d6ace97ade8f95bf0bbe24dff712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fb3d6ace97ade8f95bf0bbe24dff712">◆ </a></span>isBogus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::CollationKey::isBogus </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test to see if the key is in an invalid state. </p>
<p>The key will be in an invalid state if it couldn't allocate memory for some operation. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if the key is in an invalid, false otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005497">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="sortkey_8h_source.html#l00326">326</a> of file <a class="el" href="sortkey_8h_source.html">sortkey.h</a>.</p>
</div>
</div>
<a id="acfea18546e4a6fb9d6c987f6519e54fe" name="acfea18546e4a6fb9d6c987f6519e54fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfea18546e4a6fb9d6c987f6519e54fe">◆ </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"><a class="el" href="classicu_1_1LocalPointerBase.html">bool</a> icu::CollationKey::operator!= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>source</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>Compare if two collation keys are not the same. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the collation key to compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if two collation keys are different, false otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005496">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="sortkey_8h_source.html#l00320">320</a> of file <a class="el" href="sortkey_8h_source.html">sortkey.h</a>.</p>
</div>
</div>
<a id="a378bce68539ac77543e4226ca01a1842" name="a378bce68539ac77543e4226ca01a1842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a378bce68539ac77543e4226ca01a1842">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & icu::CollationKey::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>the object to be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005494">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a id="ac4f579d374b648d60584ada39a12b0d5" name="ac4f579d374b648d60584ada39a12b0d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4f579d374b648d60584ada39a12b0d5">◆ </a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">bool</a> icu::CollationKey::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare if two collation keys are the same. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the collation key to compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if two collation keys are equal, false otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005495">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a662b535af7127c0a09c1df2f442f6501" name="a662b535af7127c0a09c1df2f442f6501"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a662b535af7127c0a09c1df2f442f6501">◆ </a></span>CollationKeyByteSink</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">friend</a> <a class="el" href="classicu_1_1LocalPointerBase.html">class</a> CollationKeyByteSink</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sortkey_8h_source.html#l00286">286</a> of file <a class="el" href="sortkey_8h_source.html">sortkey.h</a>.</p>
</div>
</div>
<a id="a1918e53ed4bb8208fdd6df3ed4ec2548" name="a1918e53ed4bb8208fdd6df3ed4ec2548"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1918e53ed4bb8208fdd6df3ed4ec2548">◆ </a></span>RuleBasedCollator</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">friend</a> <a class="el" href="classicu_1_1LocalPointerBase.html">class</a> <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allow private access to <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.">RuleBasedCollator</a>. </p>
<p class="definition">Definition at line <a class="el" href="sortkey_8h_source.html#l00285">285</a> of file <a class="el" href="sortkey_8h_source.html">sortkey.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>i18n/unicode/<a class="el" href="sortkey_8h_source.html">sortkey.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>