Algori...M11_008(3pm)

✨ CheckDigits::M11_008 💖

okay bestie, so this is a little module from the Algorithm::CheckDigits family and it's literally here to compute check digits for VAT Registration Number (DK). yep. Denmark's VAT numbers. we're doing modulus math and we're doing it cutely. 💅

it's User Contributed Perl Documentation, so shoutout to the community, and it's a 3pm page, iykyk.

---

🌸 SYNOPSIS 🌸

like, here's the whole vibe in code form:

use Algorithm::CheckDigits;

$ustid = CheckDigits('ustid_dk');

if ($ustid->is_valid('13585628')) {
      # do something
}

$cn = $ustid->complete('1358562');
# $cn = '13585628'

$cd = $ustid->checkdigit('13585628');
# $cd = '8'

$bn = $ustid->basenumber('13585628');
# $bn = '1358562';

see how it all flows?? chef's kiss. you load it up, you grab your 'ustid_dk' checker, and then you just… ask it things. 💖

---

🦋 DESCRIPTION 🦋

ALGORITHM

okay so this is the actual math, and it's not scary, i promise. fr fr:

1. Beginning left every digit is weighted with 2, 7, 6, 5, 4, 3, 2, 1
2. The weighted digits are added.
3. The sum from step 2 is taken modulo 11.
4. The number is valid if the sum from step 3 is zero (0).

that's it. that's the whole thing. eight digits, eight weights, add them up, mod 11, and if you land on 0 you're valid and you ate. 🎀

METHODS

so here's what you can actually call on your checker object:

• is_valid($number) — returns true only if $number consists solely of numbers and the sum computed according to the algorithm given above is 0. returns false otherwise. (yes, both conditions. digits only. no letters, no vibes, no exceptions. 💀)
• complete($number) — returns $number if $number is valid according to the algorithm given above, and returns '' otherwise. note that it just hands you back what you gave it when it's valid.
• basenumber($number) — returns $number if $number is valid according to the algorithm given above, and returns '' otherwise. same deal, exactly as written.
• checkdigit($number) — returns '' if $number is valid, and returns undef otherwise. yep, this one's a little gremlin: it's the opposite polarity of the others and it gives you '' on success and undef on failure. not me side-eyeing this API design 🙈

bestie PLEASE clock that the return conventions here are not all the same. complete and basenumber return your number (or ''), checkdigit returns '' (or undef), and is_valid returns a boolean. read the docs, don't assume, that's the whole lesson. 💅

EXPORT

None by default.

(nothing gets exported into your namespace unless you ask. very polite of it. ✨)

---

👑 AUTHOR 👑

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

---

🌈 SEE ALSO 🌈

• perl
• CheckDigits
• www.pruefziffernberechnung.de

---

and that's the page!! it's from perl v5.36.0, dated 2022-10-13, and it's a 3pm page from the User Contributed Perl Documentation — so go forth, validate those Danish VAT numbers, and slay. 🫶🌸💜