debian man page for algorithm::checkdigits::m10_008

CheckDigits::M10_008(3pm)				User Contributed Perl Documentation				 CheckDigits::M10_008(3pm)

NAME
       CheckDigits::M10_008 - compute check digits for Sedol (GB)

SYNOPSIS
	 use Algorithm::CheckDigits;

	 $sedol = CheckDigits('sedol');

	 if ($sedol->is_valid('0123457')) {
	       # do something
	 }

	 $cn = $sedol->complete('012345');
	 # $cn = '0123457'

	 $cd = $sedol->checkdigit('0123457');
	 # $cd = '7'

	 $bn = $sedol->basenumber('0123457');
	 # $bn = '012345'

DESCRIPTION
   ALGORITHM
       1.  Beginning left all numbers are weighted with 1,3,1,7,3,9 and 1 (checkdigit)

       2.  The sum of all products is computed.

       3.  The check digit is the difference of the sum from step 3 to the next multiple of 10.

   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.

   EXPORT
       None by default.

AUTHOR
       Mathias Weidner, <mathias@weidner.in-bad-schmiedeberg.de>

SEE ALSO
       perl, CheckDigits, www.pruefziffernberechnung.de.

perl v5.10.0							    2008-05-17						 CheckDigits::M10_008(3pm)