.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "String::Koremutake 3pm"
.TH String::Koremutake 3pm "2015-06-06" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
String::Koremutake \- Convert to/from Koremutake Memorable Random Strings
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use String::Koremutake;
\&  my $k = String::Koremutake\->new;
\&
\&  my $s = $k\->integer_to_koremutake(65535);        # botretre
\&  my $i = $k\->koremutake_to_integer(\*(Aqkoremutake\*(Aq); # 10610353957
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The String::Koremutake module converts to and from Koremutake
Memorable Random Strings.
.PP
The term \*(L"Memorable Random String\*(R" was thought up by Sean B. Palmer as
a name for those strings like dopynl, glargen, glonknic, spoopwiddle,
and kebble etc. that don't have any conventional sense, but can be
used as random identifiers, especially in URIs to keep them
persistent. See http://infomesh.net/2001/07/MeRS/
.PP
Koremutake is a MeRS algorithm which is used by Shorl
(http://shorl.com/koremutake.php). As they explain: \*(L"It is, in plain
language, a way to express any large number as a sequence of
syllables. The general idea is that word-sounding pieces of
information are a lot easier to remember than a sequence of digits.\*(R"
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "\fInew()\fP"
.IX Subsection "new()"
The \fInew()\fR method is the constructor:
.SS "integer_to_koremutake($i)"
.IX Subsection "integer_to_koremutake($i)"
The integer_to_koremutake method converts a positive integer to a
Koremutake string:
.PP
.Vb 1
\&  my $s = $k\->integer_to_koremutake(65535);        # botretre
.Ve
.SS "koremutake_to_integer($s)"
.IX Subsection "koremutake_to_integer($s)"
The koremutake_to_integer method converts a Koremutake string to the
integer it represents:
.PP
.Vb 1
\&  my $i = $k\->koremutake_to_integer(\*(Aqkoremutake\*(Aq); # 10610353957
.Ve
.SH "CAVEATS"
.IX Header "CAVEATS"
You need to \*(L"use bigint;\*(R" if you want String::Koremutake to work with
integers larger than what fits into a normal Perl integer before it
gets converted to a floating point number on your platform.
.SS "Example"
.IX Subsection "Example"
Without \*(L"use bigint;\*(R" big integers get converted to fixed precision
floating point numbers:
.PP
.Vb 10
\&  $ perl \-MString::Koremutake \-le \*(Aq
\&    my $a = 65536**4;
\&    my $k = String::Koremutake\->new;
\&    foreach my $b ($a, $a+1, $a+2, $a+3) {
\&      print "$b: ".$k\->integer_to_koremutake($b);
\&    }\*(Aq
\&  1.84467440737096e+19: bibababababababababa
\&  1.84467440737096e+19: bibababababababababa
\&  1.84467440737096e+19: bibababababababababa
\&  1.84467440737096e+19: bibababababababababa
.Ve
.PP
If you use that large integers, you should add \*(L"use bigint;\*(R" to your
program which solves that issue:
.PP
.Vb 10
\&  $ perl \-Mbigint \-MString::Koremutake \-le \*(Aq
\&    my $a = 65536**4;
\&    my $k = String::Koremutake\->new;
\&    foreach my $b ($a, $a+1, $a+2, $a+3) {
\&      print "$b: ".$k\->integer_to_koremutake($b);
\&    }\*(Aq
\&  18446744073709551616: bibababababababababa
\&  18446744073709551617: bibababababababababe
\&  18446744073709551618: bibababababababababi
\&  18446744073709551619: bibababababababababo
.Ve
.PP
It will likely save you from other issues with big integers, too.
.PP
Note that \*(L"foreach my \f(CW$b\fR ($a .. \f(CW$a\fR+3)\*(R" doesn't work either as the \*(L"..\*(R"
operator can't be overloaded. See \s-1CAVEATS\s0 in \*(L"perldoc bigint\*(R" for
details.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.PP
Please report any bugs or feature requests to                                   
\&\f(CW\*(C`bug\-String\-Koremutake@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Leon Brocard \f(CW\*(C`acme@astray.com\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2005, Leon Brocard \f(CW\*(C`acme@astray.com\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or                    
modify it under the same terms as Perl itself.