.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
.\"
.\" 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 "Algorithm::CheckDigits::MXX_001 3pm"
.TH Algorithm::CheckDigits::MXX_001 3pm "2022-10-13" "perl v5.34.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::MXX_001 \- compute check digits for german Personalausweis
(pa_de) or ABA routing numbers (aba_rn)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Algorithm::CheckDigits;
\&
\&  $pa = CheckDigits(\*(Aqpa_de\*(Aq);
\&
\&  if ($pa\->is_valid(\*(Aq2406055684D<<6810203<0705109<6\*(Aq)) {
\&        # do something
\&  }
\&
\&  if ($pa\->is_valid(\*(Aq2406055684\*(Aq) {
\&        # do_something
\&  }
\&
\&  $cn = $pa\->complete(\*(Aq240605568_D<<681020_<070510_<_\*(Aq);
\&  # $cn = \*(Aq2406055684D<<6810203<0705109<6\*(Aq
\&
\&  $cd = $pa\->checkdigit(\*(Aq2406055684D<<6810203<0705109<6\*(Aq);
\&  # $cd = \*(Aq6\*(Aq
\&
\&  $bn = $pa\->basenumber(\*(Aq2406055684D<<6810203<0705109<6\*(Aq);
\&  # $bn = \*(Aq240605568_D<<681020_<070510_<_\*(Aq
\&
\&  $aba = CheckDigits(\*(Aqaba_rn\*(Aq);
\&  if ($aba\->is_valid(\*(Aq789456124\*(Aq)) {
\&       # do something
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "\s-1ALGORITHM\s0"
.IX Subsection "ALGORITHM"
.IP "1." 4
Beginning left all digits are weighted with 7,3,1,7,3,1,... for \fIpa_de\fR
or 3,7,1,3,7,1,3,7,1 for \fIaba_rn\fR.
.IP "2." 4
The sum of those products is computed.
.IP "3." 4
For \fIpa_de\fR the checksum is the last digit of the sum from step 2 (modulo 10).
.Sp
For \fIaba_rn\fR the checksum is the difference of the sum from step 2 to the
next multiple of 10.
.IP "4." 4
For the german Personalausweis step 1 to 3 is performed for every part of
the number and for all 3
parts including the particular checkdigit to compute the total
checksum.
.Sp
If the number solely consists of digits, the checksum is just computed
once according to algorithm given above.
.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 the last digit
is a valid check digit 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 concatenated to the end
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 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 checkdigit of \f(CW$number\fR if \f(CW$number\fR has a valid check
digit.
.Sp
Return '' otherwise.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mathias Weidner, \f(CW\*(C`<mamawe@cpan.org>\*(C'\fR
.SH "THANKS"
.IX Header "THANKS"
Aaron W. West pointed me to a fault in the computing of the check
digit. Jim Hickstein made me aware of the \s-1ABA\s0 routing numbers.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl,
CheckDigits,
\&\fIwww.pruefziffernberechnung.de\fR,
\&\fIhttp://answers.google.com/answers/threadview/id/43619.html\fR,
\&\fIhttp://www.brainjar.com/js/validation/\fR