.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "CheckDigits::MBase_003 3pm"
.TH CheckDigits::MBase_003 3pm "2021-01-03" "perl v5.32.0" "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"
CheckDigits::MBase_003 \- compute check digits for SICI (Serial Item
and Contribution Identifier)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Algorithm::CheckDigits;
\&
\&  $sici = CheckDigits(\*(Aqsici\*(Aq);
\&
\&  if ($sici\->is_valid(\*(Aq0784\-8679(20040308)6:<138>2.0.TX;2\-H\*(Aq)) {
\&        # do something
\&  }
\&
\&  $cn = $sici\->complete(\*(Aq0784\-8679(20040308)6:<138>2.0.TX;2\-\*(Aq);
\&  # $cn = \*(Aq0784\-8679(20040308)6:<138>2.0.TX;2\-H\*(Aq
\&
\&  $cd = $sici\->checkdigit(\*(Aq0784\-8679(20040308)6:<138>2.0.TX;2\-H\*(Aq);
\&  # $cd = \*(AqH\*(Aq
\&
\&  $bn = $sici\->basenumber(\*(Aq0784\-8679(20040308)6:<138>2.0.TX;2\-H\*(Aq);
\&  # $bn = \*(Aq0784\-8679(20040308)6:<138>2.0.TX;2\-\*(Aq;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "\s-1ALGORITHM\s0"
.IX Subsection "ALGORITHM"
.IP "0" 4
In the string describing the number all letters (A\-Z) are replaced
with numbers 10\-35 accordingly. All other non-numbers are replaced by
36.
.IP "1" 4
.IX Item "1"
Beginning right the numbers at all odd positions are added.
.IP "2" 4
.IX Item "2"
The sum from step 1 is multiplied by 3.
.IP "3" 4
.IX Item "3"
Beginning right the numbers at all even positions are added.
.IP "4" 4
.IX Item "4"
The sums from step 2 and 3 are added.
.IP "5" 4
.IX Item "5"
The sum from step 4 is taken modulo 37.
.IP "6" 4
.IX Item "6"
The checksum is 37 minus the sum from step 5 where numbers from 10 to
35 are represented by 'A' to 'Z' accordingly and 36 is represented by
\&'#'.
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.IP "is_valid($number)" 4
.IX Item "is_valid($number)"
Returns true only if \f(CW$number\fR consists solely of numbers and hyphens
and the two digits in the middle
are valid check digits according to the algorithm given above.
.Sp
Returns false otherwise,
.IP "complete($number)" 4
.IX Item "complete($number)"
The check digit for \f(CW$number\fR is computed and inserted into the
middle of \f(CW$number\fR.
.Sp
Returns the complete number with check digit or '' if \f(CW$number\fR
does not consist solely of digits, hyphens and spaces.
.IP "basenumber($number)" 4
.IX Item "basenumber($number)"
Returns the basenumber of \f(CW$number\fR if \f(CW$number\fR has a valid check
digit.
.Sp
Return '' otherwise.
.IP "checkdigit($number)" 4
.IX Item "checkdigit($number)"
Returns the check digits of \f(CW$number\fR if \f(CW$number\fR has valid check
digits.
.Sp
Return '' otherwise.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mathias Weidner, <mathias@weidner.in\-bad\-schmiedeberg.de>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl,
CheckDigits,
\&\fIwww.pruefziffernberechnung.de\fR,
\&\fIhttp://sunsite.berkeley.edu/SICI/sici.pdf\fR
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 144:" 4
.IX Item "Around line 144:"
Expected text after =item, not a number
.IP "Around line 148:" 4
.IX Item "Around line 148:"
Expected text after =item, not a number
.IP "Around line 152:" 4
.IX Item "Around line 152:"
Expected text after =item, not a number
.IP "Around line 156:" 4
.IX Item "Around line 156:"
Expected text after =item, not a number
.IP "Around line 160:" 4
.IX Item "Around line 160:"
Expected text after =item, not a number
.IP "Around line 164:" 4
.IX Item "Around line 164:"
Expected text after =item, not a number