This class represents a Value with a numeric value
and a Unit. The numeric value can be any Numeric, though it is not recommended to use
Values.
A Value can be added to, subtracted from and
multiplied with another value, though only when both Values are using the
same Converter. While multiplication is always
possible, adding or subtracting values with incompatible units results in a
TypeError. When two units are compatible but not the same, the Value with the larger of the units is converted to
the smaller of the units. For example adding 100 seconds and 1 minute, the
latter is converted to 60 seconds because a second is smaller than a
minute. The result is 160 seconds.
div(other)
click to toggle source
436: def div(other)
437: do_additive_op(:div, other)[0]
438: end
divmod(other)
click to toggle source
431: def divmod(other)
432: (q, r), unit = *do_additive_op(:divmod, other)
433: [q, Units::Value.new(r, unit)]
434: end
hash()
click to toggle source
464: def hash
465: @value.hash ^ @unit.hash
466: end
inspect()
click to toggle source
method_missing(m, *args, &blk)
click to toggle source
562: def method_missing(m, *args, &blk)
563: if args.length == 1
564: args[0] = (Units::Converter.converter(args[0]) rescue nil) if not args[0].is_a? Units::Converter
565: return self * Units::Value.new(1, Units::Unit.new({m => 1}, args[0])) if args[0] && args[0].registered?(m)
566: elsif (Units::Converter.current.registered?(m) rescue false)
567: raise ::ArgumentError, "Wrong number of arguments" if args.length != 0
568: return self * Units::Value.new(1, Units::Unit.new({m => 1}, Units::Converter.current))
569: end
570: ::Exception.with_clean_backtrace("method_missing") {
571: super
572: }
573: end
simplify()
click to toggle source
Forces simplification of the Unit part of this Value. Returns a new Value
or a Float.
546: def simplify
547: mul, new_unit = *@unit.simplify
548: if new_unit.unitless?
549: @value * mul
550: else
551: Units::Value.new(@value * mul, new_unit)
552: end
553: end
to(to_unit, converter = nil)
click to toggle source
Converts this Value to the given Unit. This only works if the Converters used by this
Value’s Unit and the given Unit are the same. It obviously fails if the Units are not compatible (can’t add apples
and oranges).
488: def to(to_unit, converter = nil)
489: raise ArgumentError, "Wrong number of arguments" if converter && !(::String === to_unit)
490: to_unit = to_unit.to_unit(converter)
491: raise TypeError, "cannot convert to Unit" unless Units::Unit === to_unit
492: conv1, conv2 = unit.coerce(to_unit)
493: raise TypeError, "incompatible units for operation" if conv1.units != conv2.units
494: mult = conv1.multiplier / conv2.multiplier
495: Units::Value.new(value * mult, to_unit)
496: end
to_f()
click to toggle source
Returns a float if this Value is unitless, and
raises an exception otherwise.
513: def to_f
514: val = simplify
515: if Units::Value === val
516: raise TypeError, "Cannot convert to float"
517: else
518: val.to_f
519: end
520: end
to_i()
click to toggle source
Returns an int if this Value is unitless, and
raises an exception otherwise.
524: def to_i
525: val = simplify
526: if Units::Value === val
527: raise TypeError, "Cannot convert to integer"
528: else
529: val.to_i
530: end
531: end
to_int()
click to toggle source
Returns an int if this Value is unitless, and
raises an exception otherwise.
535: def to_int
536: val = simplify
537: if Units::Value === val
538: raise TypeError, "Cannot convert to integer"
539: else
540: val.to_int
541: end
542: end
to_s()
click to toggle source
Returns a human readable string representation.
507: def to_s
508: "#{@value} #{@unit}"
509: end
to_value(converter = nil)
click to toggle source
Returns self.
556: def to_value(converter = nil)
557: self
558: end
![[+]](../../images/find.png "show/hide quicksearch")