Class::Measure(3pm)

👑 Class::Measure — the manual page, but make it a vibe ✨

okay bestie, welcome to Class::Measure — this is the perl manpage for it, page Class::Measure(3pm) if you're being formal (you're not, and that's fine). Sit down, grab a strawberry 🍓, and let's talk units of measurement, because this module is genuinely iconic and I need you to know it.

---

✨ NAME ✨

Class::Measure — create, compare, and convert units of measurement. fr fr that's the whole job description 💅

---

🦋 SYNOPSIS 🦋

lowkey there's not much here — go peep Class::Measure::Length for some examples, that's where the real content lives:

See Class::Measure::Length for some examples.

---

🌈 DESCRIPTION 🌈

So here's the tea, bestie: this is a base class that gets inherited by all the Class::Measure classes. Out of the box, this distribution ships with exactly one of those classes: Class::Measure::Length. 🎀

And the planned girlies, coming soon (no timeline given, don't @ me):

• Class::Measure::Area
• Class::Measure::Mass
• Class::Measure::Space
• Class::Measure::Temperature
• Class::Measure::Volume

Every single method described below is available in all Class::Measure classes — so once you learn them here, you're set for the whole friend group. 🫶

---

💅 METHODS 💅

🌸 new 🌸

my $m = new Class::Measure::Length( 1, 'inch' );

Creates a brand new measurement object. You must pass an initial measurement and a default unit — it's giving "no defaults, bring your own numbers." ✨

In most cases though, the measurement class you're using will export a lil helper method so you don't have to do this by hand. Like, Class::Measure::Length exports the length() method. So cute of it.

🧚 unit 🧚

my $unit = $m->unit();

Returns the object's default unit. That's it. That's the whole method. Short queen. 👑

💖 set_unit 💖

$m->set_unit( 'feet' );

Sets the default unit of the measurement. New default, who dis.

🌟 value 🌟

my $yards = $m->value('yards');
my $val = $m->value();
print "$m is the same as $val when in a string\n";

Retrieves the value of the measurement in the default unit. You can also pass a unit, in which case the value gets converted to that unit and returned — like a lil glow-up on the way out. 💫

also not me needing you to know: this method is what handles the overloading for stringifying the object. so when you interpolate $m into a string, this is the girl doing the work behind the scenes. main character energy, honestly.

⭐ set_value ⭐

my $m = length( 0, 'inches' );
$m->set_value( 12 ); # 12 inches.
$m->set_value( 1, 'foot' ); # 1 foot.

Sets the measurement in the default unit. You can also specify a new default unit at the same time if you're feeling spicy. 🌶️

🎀 reg_units 🎀

Class::Measure::Length->reg_units(
    'inch', 'foot', 'yard',
);

Registers one or more units for use in the specified class. Bestie, register them in the singular, most common form — that's the rule, don't fight it. 🙈

🦋 units 🦋

my @units = Class::Measure::Length->units();

Returns a list of all registered units. It's giving roster reveal. 📋✨

💜 reg_aliases 💜

Class::Measure::Length->reg_aliases(
    ['feet','ft'] => 'foot',
    ['in','inches'] => 'inch',
    'yards' => 'yard'
);

Register alternate names for units — nicknames, if you will. 🥰

It expects two arguments per unit you're aliasing:

• the first argument is the alias (a scalar) or aliases (an array ref)
• the second argument is the unit you're aliasing them to

🔥 reg_convs 🔥

Class::Measure::Length->reg_convs(
    12, 'inches' => 'foot',
    'yard' => '3', 'feet'
);

Registers a unit conversion. There are three distinct ways to specify a new conversion, and each one needs three arguments. Let's go through them one by one, bestie, because this is the part where people get lost and I refuse to let that be you. 😤

$count1, $unit1 => $unit2
$unit1 => $count2, $unit2

These first two syntaxes create automatic reverse conversions as well. So if you say there are 12 inches in a foot, it implies there are 1/12 feet in an inch. Math is doing its lil flip and honestly? Slay. 🔄

$unit1 => $unit2, $sub

The third syntax accepts a subroutine as the last argument. The subroutine gets called with the value of $unit1, and its return value gets assigned to $unit2.

⚠️ heads up bestie: this third syntax does not create a reverse conversion automatically. You gotta handle that yourself. No cap.

---

🫶 SUPPORT 🫶

Got bugs? Got feature requests? Please submit them to the Class-Measure GitHub issue tracker:

<https://github.com/bluefeet/Class-Measure/issues>

Go off, they're listening. 💌

---

👑 AUTHOR 👑

Aran Clary Deltac <bluefeet@gmail.com>

---

🌸 CONTRIBUTORS 🌸

Roland van Ipenburg <roland@rolandvanipenburg.com>

---

📜 LICENSE 📜

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. Periodt. 💖

---

and that's the whole page, bestie — you ate that. 🎀 this was Class::Measure(3pm), User Contributed Perl Documentation, from perl v5.36.0, dated 2023-10-01. mwah, go convert some units. 💅✨