++ed by:

3 non-PAUSE users.

Mathias Weidner

# NAME

CheckDigits::M10_011 - compute check digits UPS (US)

# SYNOPSIS

``````  use Algorithm::CheckDigits;

\$ups = CheckDigits('ups');

if (\$ups->is_valid('1Z 591580 68 55587736')) {
# do something
}

\$cn = \$ups->complete('1Z 591580 68 5558773');
# \$cn = '1Z 591580 68 55587736'

\$cd = \$ups->checkdigit('1Z 591580 68 55587736');
# \$cd = '6'

\$bn = \$ups->basenumber('1Z 591580 68 55587736');
# \$bn = '1Z 591580 68 5558773'
``````

# DESCRIPTION

## ALGORITHM

1. Beginning left all numbers are weighted alternatively 1 and 2.

3. The sum of step 3 ist taken modulo 10.

4. The check digit is the difference between 10 and the number from step 3.

## METHODS

is_valid(\$number)

Returns true only if `\$number` consists solely of numbers and the last digit is a valid check digit according to the algorithm given above.

Returns false otherwise,

complete(\$number)

The check digit for `\$number` is computed and concatenated to the end of `\$number`.

Returns the complete number with check digit or '' if `\$number` does not consist solely of digits and spaces.

basenumber(\$number)

Returns the basenumber of `\$number` if `\$number` has a valid check digit.

Return '' otherwise.

checkdigit(\$number)

Returns the checkdigit of `\$number` if `\$number` has a valid check digit.

Return '' otherwise.

None by default.

# AUTHOR

Mathias Weidner, `<mamawe@cpan.org>`