21 Apr 2013 02:18:18 UTC
- Distribution: Algorithm-Damm
- Module version: v1.1.2
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (0)
- Testers (400 / 1 / 0)
- KwaliteeBus factor: 0
- License: perl_5
- Perl: v5.6.0
- Activity24 month
- Download (4.43KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionMLX Brian T. Wightmanand 1 contributors
- Brian T. Wightman
Algorithm::Damm - Calculate the Damm error correction check digit.
use Algorithm::Damm qw/check_digit is_valid/; $c = check_digit("43881234567"); print "It works\n" if is_valid("43881234567$c");
This module implements the Damm algorithm for calculating a check digit.
You can find information about the algorithm by searching the web for "Damm ECC". In particular, see the "SEE ALSO" section (below).
- is_valid CHECKSUMMED_NUM
This function returns 1 if the final character of CHECKSUMMED_NUM is the correct checksum for the rest of the number, 0 if not, and undef if CHECKSUMMED_NUM contains an invalid character or does not contain at least two digits (one for the number, and one for the checksum).
This function is equivalent to
substr $N,length($N)-1 eq check_digit(substr $N,0,length($N)-1)
Additionally, due to the way this algorithm works, if you crank the checksum calculation through the last digit (checkdigit included), you will end up with a value of 0.
- check_digit NUM
This function returns the checksum of the given number. It will return undef if it is not able to calculate the checksum.
This module came about as I was reverse engineering a checksum method being used on another project of mine. History of the method used was lost to the sands of time, and I needed something to run some quick tests on various checksum algorithms.
This module is a reimplementation of one of the algorithms I had tested.
Algorithm::CheckDigits is a module that this probably should have been written as a part of. There is an open issue (https://github.com/MidLifeXis/perl-algorithm-damm/issues/1) to add an integration layer for this module to Algorithm::CheckDigits.
Original code based on Algorithm::LUHN by Tim Ayers.
Slightly different approach to generating check digits.
http://en.wikipedia.org/wiki/Damm_algorithm - Article explaining the Damm error correction algorithm.
You can find the source at https://www.github.org/MidLifeXis/perl-algorithm-damm.
None known at this time, but feel free to submit them to RT or the issue tracker for this source at GitHub.
This module was written by Brian T. Wightman (http://search.cpan.org/search?author=MLX) based on the module Algorithm::LUHN by Tim Ayers.
Copyright (c) 2013 Brian T. Wightman. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Module Install Instructions
To install Algorithm::Damm, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Algorithm::Damm
For more information on module installation, please visit the detailed CPAN module installation guide.