Class: Eymiha::Units

The Units framework

Units is the top level that you‘ll typically never have to deal with directly. While it provides a few chunks of general functionality such as getting defined units and ranking, most of its guts are devoted to defining new UnitsMeasures - unless you‘re setting up your own sets of specialized units, you will hardly know it‘s here.

Methods

[] clear create debug= defining? delete derive find_by_derivation lookup names_of rank size units_measures

Public Class methods

[](name)

Returns the named UnitsMeasure.

clear()

Clears the Units framework of all defined elements.

create(name, &block)

Creates or extends a UnitsMeasure.

debug=(value)

defining?()

Answers the question of whether a UnitsMeasure is being defined with the instance if true, or nil if false.

delete(name)

Removes the named UnitsMeasure from the Units framework.

derive(name, target, &block)

Creates or extends a UnitsMeasure derived from other UnitsMeasures.

find_by_derivation(derivation)

Returns the UnitsMeasure with the given derivation.

lookup(unit_identifier)

Returns an Array of UnitsUnit associated with a singular, plural or abbreviated name.

names_of(units_measure)

Returns an Array containing the names of a given UnitsMeasure.

rank(unit_choices = {},samples = []) {|n| ...}

Given a Hash of units to raking weights, a set of samples, and optionally a block that returns rankings, returns an Array of units ordered by best weighted fit over the samples. Like golf, low scores rank best. In absence of a block, ranking is based on the number of unit values whose magnitudes are between 1 and 10.

size()

Returns the number of defined UnitsMeasures.

units_measures()

Returns an Array of the defined UnitsMeasures.