"c-hook/C-hook" ("U+0188/U+0187") with 0E65, and "c-curl"

"CH" ordered between "c-curl" and "D".

- see 7.1.4 Trailing Weights, UTS #10.

If a true value is given (non-zero but should be positive), it will

be added as a terminator primary weight to the end of every stan-

dard Hangul syllable. Secondary and any higher weights for termina-

Boundaries of Hangul syllables are determined according to conjoin-

ing Jamo behavior in the Unicode Standard and HangulSyllable-

be added between collation elements, even if Hangul syllable bound-

(2) Non-conjoining Hangul letters (Compatibility Jamo, halfwidth

- see 3.2.2 Variable Weighting, UTS #10.

Through "ignoreChar", any character matching "qr/$ignoreChar/" will

in the "table" file as a comment) matches "qr/$ignoreName/" will be

- see 7.3.1 Tertiary Weight Table, UTS #10.

NNOOTTEE: This parameter simplemindedly assumes that any hira-

at level 3 must be same as those mentioned in 7.3.1, UTS #10. If

- see 4.3 Form Sort Key, UTS #10.

Level 4: tie-breaking (e.g. in the case when variable is 'shifted')

- see 4.1 Normalize, UTS #10.

applied as $normalizationform. Acceptable names include 'NFD',

used, though they are not concerned with "Unicode::Normalize::nor-

tailoring easier if any normalization is not desired). Under "(nor-

e.g. even if "A-ring" (and "A-ring-cedilla") is ordered after "Z",

"A-cedilla-ring" would be primary equal to "A". In this point,

In the case of "(normalization => "prenormalized")", any normaliza-

tion is not performed, but non-contiguous contractions with combin-

- see 7.1 Derived Collation Elements, UTS #10.

"U+4E00..U+9FBB") are lesser than "CJK Unified Ideographs Exten-

my $u = shift; # get a Unicode codepoint

my $b = pack('n', $u); # to UTF-16BE

my $s = yourunicodetosjisconverter($b); # convert

my $n = unpack('n', $s); # convert sjis to short

[ $n, 0x20, 0x2, $u ]; # return the collation element

overrideCJK => sub {()}, # CODEREF returning empty list

# where ->eq("Pe\x{4E00}rl", "Perl") is true

# as U+4E00 is a CJK Unified Ideograph and to be ignorable.

for CJK Unified Ideographs are treated as undefined. But assign-

- see 7.1 Derived Collation Elements, UTS #10.

and FCD are not appropriate, since they will decompose Hangul Syl-

- see 5.1 Preprocessing, UTS #10.

If specified, the coderef is used to preprocess before the forma-

my $str = shift;

$str =~ s/\b(?:an?|the)\s+//gi;

return $str;

- see 3.1.3 Rearrangement, UTS #10.

Characters that are not coded in logical order and to be rear-

If "UCAVersion" is equal to 14, default is "[]" (i.e. no re-

- see 3.2 Default Unicode Collation Element Table, UTS #10.

$onlyABC = Unicode::Collate->new(

0061 ; [.0101.0020.0002.0061] # LATIN SMALL LETTER A

0041 ; [.0101.0020.0008.0041] # LATIN CAPITAL LETTER A

0062 ; [.0102.0020.0002.0062] # LATIN SMALL LETTER B

0042 ; [.0102.0020.0008.0042] # LATIN CAPITAL LETTER B

0063 ; [.0103.0020.0002.0063] # LATIN SMALL LETTER C

0043 ; [.0103.0020.0008.0043] # LATIN CAPITAL LETTER C

specified as a comment (following "#") on each line.

- see 6.3.4 Reducing the Repertoire, UTS #10.

Undefines the collation element as if it were unassigned in the ta-

ble. This reduces the size of the table. If an unassigned charac-

its codepoint as a single-character collation element, as it is

greater than any other assigned collation elements (in the code-

Through "undefChar", any character matching "qr/$undefChar/" will

in the "table" file as a comment) matches "qr/$undefName/" will be

ex. Collation weights for beyond-BMP characters are not stored in

undefChar => qr/[^\0-\x{fffd}]/,

- see 6.6 Case Comparisons, UTS #10.

NNOOTTEE: This parameter simplemindedly assumes that any lower-

#10. If you define your collation elements which differs from this

- see 3.2.2 Variable Weighting, UTS #10.

This key allows to variable weighting for variable collation ele-

ments, which are marked with an ASTERISK in the table (NOTE: Many

variable => 'blanked', 'non-ignorable', 'shifted', or 'shift-trimmed'.

These names are case-insensitive. By default (if specification is

'Non-Ignorable' Variable elements are not reset to ignorable.

Level 4 weight for Non-Variable elements is 0xFFFF.

'Shift-Trimmed' Same as 'shifted', but all FFFF's at the 4th level

"@sorted = $Collator->sort(@notsorted)"

"$result = $Collator->cmp($a, $b)"

Returns 1 (when $a is greater than $b) or 0 (when $a is equal to

$b) or -1 (when $a is lesser than $b).

"$result = $Collator->eq($a, $b)"

"$result = $Collator->ne($a, $b)"

"$result = $Collator->lt($a, $b)"

"$result = $Collator->le($a, $b)"

"$result = $Collator->gt($a, $b)"

"$result = $Collator->ge($a, $b)"

eq : whether $a is equal to $b.

ne : whether $a is not equal to $b.

lt : whether $a is lesser than $b.

le : whether $a is lesser than $b or equal to $b.

gt : whether $a is greater than $b.

ge : whether $a is greater than $b or equal to $b.

"$sortKey = $Collator->getSortKey($string)"

- see 4.3 Form Sort Key, UTS #10.

$Collator->getSortKey($a) cmp $Collator->getSortKey($b)

$Collator->cmp($a, $b)

"$sortKeyForm = $Collator->viewSortKey($string)"

Converts a sorting key into its representation form. If "UCAVer-

use Unicode::Collate;

my $c = Unicode::Collate->new();

print $c->viewSortKey("Perl"),"\n";

# output:

# [0B67 0A65 0B7F 0B03 | 0020 0020 0020 0020 | 0008 0002 0002 0002 | FFFF FFFF FFFF FFFF]

# Level 1 Level 2 Level 3 Level 4

$Collator, calling these methods ("index", "match", "gmatch", "subst",

those on the specified string. (And "rearrange" and "hangultermina-

"$position = $Collator->index($string, $substring[, $position])"

"($position, $length) = $Collator->index($string, $substring[, $posi-

If $substring matches a part of $string, returns the position of

list context, returns a two-element list of the position and the

If $substring does not match any part of $string, returns "-1" in

my $Collator = Unicode::Collate->new( normalization => undef, level => 1 );

# (normalization => undef) is REQUIRED.

my $str = "Ich muB studieren Perl.";

my $sub = "M"USS";

my $match;

if (my($pos,$len) = $Collator->index($str, $sub)) {

$match = substr($str, $pos, $len);

and get "muB" in $match since "muB" is primary equal to "M"USS".

"$matchref = $Collator->match($string, $substring)"

"($match) = $Collator->match($string, $substring)"

If $substring matches a part of $string, in scalar context, returns

($matchref is always true if matches, since every reference is

ttrruuee); in list context, returns the first occurrence of the match-

If $substring does not match any part of $string, returns "undef"

if ($matchref = $Collator->match($str, $sub)) { # scalar context

print "matches [$$matchref].\n";

if (($match) = $Collator->match($str, $sub)) { # list context

print "matches [$match].\n";

"@match = $Collator->gmatch($string, $substring)"

If $substring matches a part of $string, returns all the matching

If $substring does not match any part of $string, returns an empty

"$count = $Collator->subst($string, $substring, $replacement)"

If $substring matches a part of $string, the first occurrence of

the matching part is replaced by $replacement ($string is modified)

and return $count (always equals to 1).

$replacement can be a "CODEREF", taking the matching part as an

bit similar to "s/(..)/$coderef->($1)/e").

"$count = $Collator->gsubst($string, $substring, $replacement)"

If $substring matches a part of $string, all the occurrences of the

matching part is replaced by $replacement ($string is modified) and

return $count.

$replacement can be a "CODEREF", taking the matching part as an

bit similar to "s/(..)/$coderef->($1)/eg").

my $Collator = Unicode::Collate->new( normalization => undef, level => 1 );

# (normalization => undef) is REQUIRED.

my $str = "Camel donkey zebra came\x{301}l CAMEL horse cAm\0E\0L...";

$Collator->gsubst($str, "camel", sub { "$[0]" });

# now $str is "Camel donkey zebra came\x{301}l CAMEL horse cAm\0E\0L...";

# i.e., all the camels are made bold-faced.

"%oldtailoring = $Collator->change(%newtailoring)"

$Collator = Unicode::Collate->new(level => 4);

$Collator->eq("perl", "PERL"); # false

%old = $Collator->change(level => 2); # returns (level => 4).

$Collator->eq("perl", "PERL"); # true

$Collator->change(%old); # returns (level => 2).

$Collator->eq("perl", "PERL"); # false

Not all "(key,value)"s are allowed to be changed. See also @Uni-

code::Collate::ChangeOK and @Unicode::Collate::ChangeNG.

$Collator->change(level => 2)->eq("perl", "PERL"); # true

$Collator->eq("perl", "PERL"); # true; now max level is 2nd.

$Collator->change(level => 4)->eq("perl", "PERL"); # false

"$version = $Collator->version()"

Returns the tracking version number of UTS #10 this module con-

Returns the version number of UTS #10 this module consults.

The most preferable one is "The Default Unicode Collation Element Ta-

Use of the "normalization" parameter requires the UUnniiccooddee::::NNoorrmmaall-

- see 6.5 Avoiding Normalization, UTS #10.