.\" 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::MXX_001 3pm"
.TH CheckDigits::MXX_001 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::MXX_001 \- compute check digits for PA (DE)
.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
\&  }
\&
\&  $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
.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,...
.IP "2." 4
The sum of those products is computed.
.IP "3." 4
The checksum is the last digit of the sum from step 2 (modulo 10).
.IP "4." 4
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.
.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, <mathias@weidner.in\-bad\-schmiedeberg.de>
.SH "THANKS"
.IX Header "THANKS"
Aaron W. West pointed me to a fault in the computing of the check
digit.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl,
CheckDigits,
\&\fIwww.pruefziffernberechnung.de\fR,
\&\fIwww.export911.com/e911/coding/upcChar.htm\fR,
\&\fIwww.adams1.com/pub/russadam/upccode.html\fR,
\&\fIhttp://www.upcdatabase.com\fR.