Class: RubyUnits::Unit
- Includes:
- Comparable
- Defined in:
- lib/ruby_units/unit.rb,
lib/ruby_units/cache.rb,
lib/ruby_units/version.rb,
lib/ruby_units/definition.rb
Defined Under Namespace
Modules: Version Classes: Cache, Definition
Constant Summary collapse
- VERSION =
Unit::Version::STRING
- UNITY =
'<1>'.freeze
- UNITY_ARRAY =
[UNITY].freeze
- FEET_INCH_UNITS_REGEX =
ideally we would like to generate this regex from the alias for a ‘feet’ and ‘inches’, but they aren’t defined at the point in the code where we need this regex.
/(?:'|ft|feet)\s*(\d+)\s*(?:"|in|inch(?:es)?)/
- FEET_INCH_REGEX =
/(\d+)\s*#{FEET_INCH_UNITS_REGEX}/
- LBS_OZ_UNIT_REGEX =
ideally we would like to generate this regex from the alias for a ‘pound’ and ‘ounce’, but they aren’t defined at the point in the code where we need this regex.
/(?:#|lbs?|pounds?|pound-mass)+[\s,]*(\d+)\s*(?:ozs?|ounces?)/
- LBS_OZ_REGEX =
/(\d+)\s*#{LBS_OZ_UNIT_REGEX}/
- STONE_LB_UNIT_REGEX =
ideally we would like to generate this regex from the alias for a ‘stone’ and ‘pound’, but they aren’t defined at the point in the code where we need this regex. also note that the plural of ‘stone’ is still ‘stone’, but we accept ‘stones’ anyway.
/(?:sts?|stones?)+[\s,]*(\d+)\s*(?:#|lbs?|pounds?|pound-mass)*/
- STONE_LB_REGEX =
/(\d+)\s*#{STONE_LB_UNIT_REGEX}/
- TIME_REGEX =
/(\d+)*:(\d+)*:*(\d+)*[:,]*(\d+)*/
- SCI_NUMBER =
/([+-]?\d*[.]?\d+(?:[Ee][+-]?)?\d*)/
- RATIONAL_NUMBER =
%r{\(?([+-])?(\d+[ -])?(\d+)\/(\d+)\)?}
- COMPLEX_NUMBER =
/#{SCI_NUMBER}?#{SCI_NUMBER}i\b/
- NUMBER_REGEX =
/#{SCI_NUMBER}*\s*(.+)?/
- UNIT_STRING_REGEX =
%r{#{SCI_NUMBER}*\s*([^\/]*)\/*(.+)*}
- TOP_REGEX =
/([^ \*]+)(?:\^|\*\*)([\d-]+)/
- BOTTOM_REGEX =
/([^* ]+)(?:\^|\*\*)(\d+)/
- NUMBER_UNIT_REGEX =
/#{SCI_NUMBER}?(.*)/
- COMPLEX_REGEX =
/#{COMPLEX_NUMBER}\s?(.+)?/
- RATIONAL_REGEX =
/#{RATIONAL_NUMBER}\s?(.+)?/
- KELVIN =
['<kelvin>'].freeze
- FAHRENHEIT =
['<fahrenheit>'].freeze
- RANKINE =
['<rankine>'].freeze
- CELSIUS =
['<celsius>'].freeze
- SIGNATURE_VECTOR =
%i( length time temperature mass current substance luminosity currency information angle ).freeze
- @@definitions =
{}
- @@prefix_values =
{}
- @@prefix_map =
{}
- @@unit_map =
{}
- @@unit_values =
{}
- @@unit_regex =
nil
- @@unit_match_regex =
nil
- @@temp_regex =
nil
- @@kinds =
{ -312_078 => :elastance, -312_058 => :resistance, -312_038 => :inductance, -152_040 => :magnetism, -152_038 => :magnetism, -152_058 => :potential, -7997 => :specific_volume, -79 => :snap, -59 => :jolt, -39 => :acceleration, -38 => :radiation, -20 => :frequency, -19 => :speed, -18 => :viscosity, -17 => :volumetric_flow, -1 => :wavenumber, 0 => :unitless, 1 => :length, 2 => :area, 3 => :volume, 20 => :time, 400 => :temperature, 7941 => :yank, 7942 => :power, 7959 => :pressure, 7962 => :energy, 7979 => :viscosity, 7961 => :force, 7981 => :momentum, 7982 => :angular_momentum, 7997 => :density, 7998 => :area_density, 8000 => :mass, 152_020 => :radiation_exposure, 159_999 => :magnetism, 160_000 => :current, 160_020 => :charge, 312_058 => :conductance, 312_078 => :capacitance, 3_199_980 => :activity, 3_199_997 => :molar_concentration, 3_200_000 => :substance, 63_999_998 => :illuminance, 64_000_000 => :luminous_power, 1_280_000_000 => :currency, 25_600_000_000 => :information, 511_999_999_980 => :angular_velocity, 512_000_000_000 => :angle }.freeze
- @@cached_units =
{}
- @@base_unit_cache =
{}
Instance Attribute Summary collapse
- #base_denominator ⇒ Array
- #base_numerator ⇒ Array
- #base_scalar ⇒ Numeric
- #denominator ⇒ Array
- #numerator ⇒ Array
- #output ⇒ String
- #scalar ⇒ Numeric
- #signature ⇒ Integer
- #unit_name ⇒ String
Class Method Summary collapse
- .base_unit_cache ⇒ Hash
-
.base_units ⇒ Array
return an array of base units.
- .cached ⇒ Hash
- .clear_cache ⇒ true
-
.define(unit_definition, &block) ⇒ RubyUnits::Unit::Definition
Unpack a unit definition and add it to the array of defined units.
-
.defined?(unit) ⇒ Boolean
determine if a unit is already defined.
-
.definition(unit_name) ⇒ RubyUnits::Unit::Definition?
return the unit definition for a unit.
-
.definitions ⇒ Array
return a list of all defined units.
- .eliminate_terms(q, n, d) ⇒ Hash
- .parse(input) ⇒ Unit
-
.parse_into_numbers_and_units(string) ⇒ Array
parse a string consisting of a number and a unit string NOTE: This does not properly handle units formatted like ‘12mg/6ml’.
-
.prefix_regex ⇒ String
return a regexp fragment used to match prefixes.
-
.redefine!(name) {|RubyUnits::Unit::Definition| ... } ⇒ RubyUnits::Unit::Definition
Get the definition for a unit and allow it to be redefined.
-
.setup ⇒ true
setup internal arrays and hashes.
- .temp_regex ⇒ Object
-
.undefine!(unit) ⇒ true
Undefine a unit.
-
.unit_match_regex ⇒ RegExp
return a regex used to match units.
-
.unit_regex ⇒ String
return a fragment of a regex to be used for matching units or reconstruct it if hasn’t been used yet.
-
.use_definition(definition) ⇒ Object
inject a definition into the internal array and set it up for use.
Instance Method Summary collapse
-
#%(other) ⇒ Integer
perform a modulo on a unit, will raise an exception if the units are not compatible.
-
#*(other) ⇒ Unit
Multiply two units.
-
#**(other) ⇒ Unit
Exponentiate.
-
#+(other) ⇒ Unit
Add two units together.
-
#-(other) ⇒ Unit
Subtract two units.
-
#-@ ⇒ Numeric, Unit
negates the scalar of the Unit.
-
#/(other) ⇒ Unit
Divide two units.
-
#<=>(other) ⇒ -1|0|1|nil
Compare two Unit objects.
-
#==(other) ⇒ Boolean
Compare Units for equality this is necessary mostly for Complex units.
-
#===(other) ⇒ Boolean
(also: #same?, #same_as?)
Compare two units.
-
#=~(other) ⇒ Boolean
(also: #compatible?, #compatible_with?)
check to see if units are compatible, but not the scalar part this check is done by comparing signatures for performance reasons if passed a string, it will create a unit object with the string and then do the comparison.
-
#abs ⇒ Numeric, Unit
absolute value of a unit.
- #ago ⇒ Unit
-
#as_json ⇒ String
Returns string formatted for json.
-
#base? ⇒ Boolean
(also: #is_base?)
Is this unit in base form?.
- #before(time_point = ::Time.now) ⇒ Unit (also: #before_now)
-
#best_prefix ⇒ Object
returns a new unit that has been scaled to be more in line with typical usage.
-
#ceil ⇒ Numeric, Unit
ceil of a unit.
-
#coerce(other) ⇒ Array
automatically coerce objects to units when possible if an object defines a ‘to_unit’ method, it will be coerced using that method.
-
#convert_to(other) ⇒ Unit
(also: #>>, #to)
convert to a specified unit string or to the same units as another Unit.
-
#copy(from) ⇒ Unit
Used to copy one unit to another.
-
#degree? ⇒ Boolean
(also: #is_degree?)
true if a degree unit or equivalent.
-
#divmod(other) ⇒ Array
divide two units and return quotient and remainder when both units are in the same units we just use divmod on the raw scalars otherwise we use the scalar of the base unit which will be a float.
- #floor ⇒ Numeric, Unit
- #from(time_point) ⇒ Time, ... (also: #after, #from_now)
-
#hash ⇒ Object
override hash method so objects with same values are considered equal.
-
#initialize(*options) ⇒ Unit
constructor
Create a new Unit object.
- #inspect(dump = nil) ⇒ String deprecated Deprecated.
-
#inverse ⇒ Unit
returns inverse of Unit (1/unit).
-
#kind ⇒ Symbol
@todo: figure out how to handle :counting units.
-
#power(n) ⇒ Unit
returns the unit raised to the n-th power.
-
#pred ⇒ Unit
returns previous unit in a range.
-
#root(n) ⇒ Unit
Calculates the n-th root of a unit if n < 0, returns 1/unit^(1/n).
- #round(ndigits = 0) ⇒ Numeric, Unit
- #since(time_point) ⇒ Unit
-
#succ ⇒ Unit
(also: #next)
returns next unit in a range.
-
#temperature? ⇒ Boolean
(also: #is_temperature?)
true if unit is a ‘temperature’, false if a ‘degree’ or anything else.
-
#temperature_scale ⇒ String
returns the ‘degree’ unit associated with a temperature unit.
-
#to_base ⇒ Unit
(also: #base)
convert to base SI units results of the conversion are cached so subsequent calls to this will be fast.
-
#to_c ⇒ Complex
converts the unit back to a complex if it is unitless.
- #to_date ⇒ Date
-
#to_datetime ⇒ DateTime
convert a duration to a DateTime.
-
#to_f ⇒ Float
converts the unit back to a float if it is unitless.
-
#to_i ⇒ Integer
(also: #to_int)
if unitless, returns an int, otherwise raises an error.
-
#to_r ⇒ Rational
if unitless, returns a Rational, otherwise raises an error.
-
#to_s(target_units = nil) ⇒ String
Generate human readable output.
-
#to_time ⇒ Time
(also: #time)
Tries to make a Time object from current unit.
- #to_unit ⇒ Unit (also: #unit)
- #truncate ⇒ Numeric, Unit
-
#unitless? ⇒ Boolean
returns true if no associated units false, even if the units are “unitless” like ‘radians, each, etc’.
-
#units(with_prefix: true) ⇒ String
returns the ‘unit’ part of the Unit object without the scalar.
- #until(time_point) ⇒ Unit
-
#zero? ⇒ Boolean
true if scalar is zero.
Constructor Details
#initialize(*options) ⇒ Unit
Create a new Unit object. Can be initialized using a String, a Hash, an Array, Time, DateTime
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 |
# File 'lib/ruby_units/unit.rb', line 463 def initialize(*) @scalar = nil @base_scalar = nil @unit_name = nil @signature = nil @output = {} raise ArgumentError, 'Invalid Unit Format' if [0].nil? if .size == 2 # options[0] is the scalar # options[1] is a unit string begin cached = @@cached_units[[1]] * [0] copy(cached) rescue initialize("#{[0]} #{([1].units rescue [1])}") end return end if .size == 3 [1] = [1].join if [1].is_a?(Array) [2] = [2].join if [2].is_a?(Array) begin cached = @@cached_units["#{[1]}/#{[2]}"] * [0] copy(cached) rescue initialize("#{[0]} #{[1]}/#{[2]}") end return end case [0] when Unit copy([0]) return when Hash @scalar = [0][:scalar] || 1 @numerator = [0][:numerator] || UNITY_ARRAY @denominator = [0][:denominator] || UNITY_ARRAY @signature = [0][:signature] when Array initialize(*[0]) return when Numeric @scalar = [0] @numerator = @denominator = UNITY_ARRAY when Time @scalar = [0].to_f @numerator = ['<second>'] @denominator = UNITY_ARRAY when DateTime, Date @scalar = [0].ajd @numerator = ['<day>'] @denominator = UNITY_ARRAY when /^\s*$/ raise ArgumentError, 'No Unit Specified' when String parse([0]) else raise ArgumentError, 'Invalid Unit Format' end update_base_scalar raise ArgumentError, 'Temperatures must not be less than absolute zero' if temperature? && base_scalar < 0 unary_unit = units || '' if .first.instance_of?(String) _opt_scalar, opt_units = RubyUnits::Unit.parse_into_numbers_and_units([0]) unless @@cached_units.keys.include?(opt_units) || (opt_units =~ %r{\D/[\d+\.]+}) || (opt_units =~ %r{(#{RubyUnits::Unit.temp_regex})|(#{STONE_LB_UNIT_REGEX})|(#{LBS_OZ_UNIT_REGEX})|(#{FEET_INCH_UNITS_REGEX})|%|(#{TIME_REGEX})|i\s?(.+)?|±|\+\/-}) @@cached_units[opt_units] = (scalar == 1 ? self : opt_units.to_unit) if opt_units && !opt_units.empty? end end unless @@cached_units.keys.include?(unary_unit) || (unary_unit =~ /#{RubyUnits::Unit.temp_regex}/) @@cached_units[unary_unit] = (scalar == 1 ? self : unary_unit.to_unit) end [@scalar, @numerator, @denominator, @base_scalar, @signature, @base].each(&:freeze) self end |
Instance Attribute Details
#base_denominator ⇒ Array
421 422 423 |
# File 'lib/ruby_units/unit.rb', line 421 def base_denominator @base_denominator end |
#base_numerator ⇒ Array
418 419 420 |
# File 'lib/ruby_units/unit.rb', line 418 def base_numerator @base_numerator end |
#base_scalar ⇒ Numeric
415 416 417 |
# File 'lib/ruby_units/unit.rb', line 415 def base_scalar @base_scalar end |
#denominator ⇒ Array
409 410 411 |
# File 'lib/ruby_units/unit.rb', line 409 def denominator @denominator end |
#numerator ⇒ Array
406 407 408 |
# File 'lib/ruby_units/unit.rb', line 406 def numerator @numerator end |
#signature ⇒ Integer
412 413 414 |
# File 'lib/ruby_units/unit.rb', line 412 def signature @signature end |
#unit_name ⇒ String
427 428 429 |
# File 'lib/ruby_units/unit.rb', line 427 def unit_name @unit_name end |
Class Method Details
.base_unit_cache ⇒ Hash
235 236 237 |
# File 'lib/ruby_units/unit.rb', line 235 def self.base_unit_cache @@base_unit_cache end |
.base_units ⇒ Array
return an array of base units
302 303 304 |
# File 'lib/ruby_units/unit.rb', line 302 def self.base_units @@base_units ||= @@definitions.dup.delete_if { |_, defn| !defn.base? }.keys.map { |u| RubyUnits::Unit.new(u) } end |
.cached ⇒ Hash
222 223 224 |
# File 'lib/ruby_units/unit.rb', line 222 def self.cached @@cached_units end |
.clear_cache ⇒ true
227 228 229 230 231 232 |
# File 'lib/ruby_units/unit.rb', line 227 def self.clear_cache @@cached_units = {} @@base_unit_cache = {} RubyUnits::Unit.new(1) true end |
.define(unit_definition, &block) ⇒ RubyUnits::Unit::Definition
Unpack a unit definition and add it to the array of defined units
187 188 189 190 191 192 193 194 195 |
# File 'lib/ruby_units/unit.rb', line 187 def self.define(unit_definition, &block) if block_given? raise ArgumentError, 'When using the block form of RubyUnits::Unit.define, pass the name of the unit' unless unit_definition.instance_of?(String) unit_definition = RubyUnits::Unit::Definition.new(unit_definition, &block) end RubyUnits::Unit.definitions[unit_definition.name] = unit_definition RubyUnits::Unit.use_definition(unit_definition) unit_definition end |
.defined?(unit) ⇒ Boolean
determine if a unit is already defined
155 156 157 |
# File 'lib/ruby_units/unit.rb', line 155 def self.defined?(unit) definitions.values.any? { |d| d.aliases.include?(unit) } end |
.definition(unit_name) ⇒ RubyUnits::Unit::Definition?
return the unit definition for a unit
162 163 164 165 |
# File 'lib/ruby_units/unit.rb', line 162 def self.definition(unit_name) unit = unit_name =~ /^<.+>$/ ? unit_name : "<#{unit_name}>" @@definitions[unit] end |
.definitions ⇒ Array
return a list of all defined units
169 170 171 |
# File 'lib/ruby_units/unit.rb', line 169 def self.definitions @@definitions end |
.eliminate_terms(q, n, d) ⇒ Hash
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/ruby_units/unit.rb', line 252 def self.eliminate_terms(q, n, d) num = n.dup den = d.dup num.delete_if { |v| v == UNITY } den.delete_if { |v| v == UNITY } combined = Hash.new(0) i = 0 loop do break if i > num.size if @@prefix_values.key? num[i] k = [num[i], num[i + 1]] i += 2 else k = num[i] i += 1 end combined[k] += 1 unless k.nil? || k == UNITY end j = 0 loop do break if j > den.size if @@prefix_values.key? den[j] k = [den[j], den[j + 1]] j += 2 else k = den[j] j += 1 end combined[k] -= 1 unless k.nil? || k == UNITY end num = [] den = [] combined.each do |key, value| if value >= 0 value.times { num << key } elsif value < 0 value.abs.times { den << key } end end num = UNITY_ARRAY if num.empty? den = UNITY_ARRAY if den.empty? { scalar: q, numerator: num.flatten.compact, denominator: den.flatten.compact } end |
.parse(input) ⇒ Unit
243 244 245 246 |
# File 'lib/ruby_units/unit.rb', line 243 def self.parse(input) first, second = input.scan(/(.+)\s(?:in|to|as)\s(.+)/i).first second.nil? ? RubyUnits::Unit.new(first) : RubyUnits::Unit.new(first).convert_to(second) end |
.parse_into_numbers_and_units(string) ⇒ Array
parse a string consisting of a number and a unit string NOTE: This does not properly handle units formatted like ‘12mg/6ml’
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/ruby_units/unit.rb', line 310 def self.parse_into_numbers_and_units(string) # scientific notation.... 123.234E22, -123.456e-10 sci = /[+-]?\d*[.]?\d+(?:[Ee][+-]?)?\d*/ # rational numbers.... -1/3, 1/5, 20/100, -6 1/2, -6-1/2 rational = %r{\(?[+-]?(?:\d+[ -])?\d+\/\d+\)?} # complex numbers... -1.2+3i, +1.2-3.3i complex = /#{sci}{2,2}i/ anynumber = /(?:(#{complex}|#{rational}|#{sci}))?\s?([^-\d\.].*)?/ num, unit = string.scan(anynumber).first [ case num when NilClass 1 when complex if num.respond_to?(:to_c) num.to_c else #:nocov_19: Complex(*num.scan(/(#{sci})(#{sci})i/).flatten.map(&:to_i)) #:nocov_19: end when rational # if it has whitespace, it will be of the form '6 1/2' if num =~ RATIONAL_NUMBER sign = $1 == '-' ? -1 : 1 n = $2.to_i f = Rational($3.to_i, $4.to_i) sign * (n + f) else Rational(*num.split('/').map(&:to_i)) end else num.to_f end, unit.to_s.strip ] end |
.prefix_regex ⇒ String
return a regexp fragment used to match prefixes
366 367 368 |
# File 'lib/ruby_units/unit.rb', line 366 def self.prefix_regex @@prefix_regex ||= @@prefix_map.keys.sort_by { |prefix| [prefix.length, prefix] }.reverse.join('|') end |
.redefine!(name) {|RubyUnits::Unit::Definition| ... } ⇒ RubyUnits::Unit::Definition
Get the definition for a unit and allow it to be redefined
203 204 205 206 207 208 209 210 211 |
# File 'lib/ruby_units/unit.rb', line 203 def self.redefine!(name) raise ArgumentError, 'A block is required to redefine a unit' unless block_given? unit_definition = definition(name) raise(ArgumentError, "'#{name}' Unit not recognized") unless unit_definition yield unit_definition @@definitions.delete("<#{name}>") define(unit_definition) RubyUnits::Unit.setup end |
.setup ⇒ true
setup internal arrays and hashes
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/ruby_units/unit.rb', line 134 def self.setup clear_cache @@prefix_values = {} @@prefix_map = {} @@unit_values = {} @@unit_map = {} @@unit_regex = nil @@unit_match_regex = nil @@prefix_regex = nil @@definitions.each do |_name, definition| use_definition(definition) end RubyUnits::Unit.new(1) true end |
.temp_regex ⇒ Object
370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/ruby_units/unit.rb', line 370 def self.temp_regex @@temp_regex ||= begin temp_units = %w(tempK tempC tempF tempR degK degC degF degR) aliases = temp_units.map do |unit| d = RubyUnits::Unit.definition(unit) d && d.aliases end.flatten.compact regex_str = aliases.empty? ? '(?!x)x' : aliases.join('|') Regexp.new "(?:#{regex_str})" end end |
.undefine!(unit) ⇒ true
Undefine a unit. Will not raise an exception for unknown units.
216 217 218 219 |
# File 'lib/ruby_units/unit.rb', line 216 def self.undefine!(unit) @@definitions.delete("<#{unit}>") RubyUnits::Unit.setup end |
.unit_match_regex ⇒ RegExp
return a regex used to match units
359 360 361 |
# File 'lib/ruby_units/unit.rb', line 359 def self.unit_match_regex @@unit_match_regex ||= /(#{RubyUnits::Unit.prefix_regex})??(#{RubyUnits::Unit.unit_regex})\b/ end |
.unit_regex ⇒ String
return a fragment of a regex to be used for matching units or reconstruct it if hasn’t been used yet. Unit names are reverse sorted by length so the regexp matcher will prefer longer and more specific names
353 354 355 |
# File 'lib/ruby_units/unit.rb', line 353 def self.unit_regex @@unit_regex ||= @@unit_map.keys.sort_by { |unit_name| [unit_name.length, unit_name] }.reverse.join('|') end |
.use_definition(definition) ⇒ Object
inject a definition into the internal array and set it up for use
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'lib/ruby_units/unit.rb', line 383 def self.use_definition(definition) @@unit_match_regex = nil # invalidate the unit match regex @@temp_regex = nil # invalidate the temp regex if definition.prefix? @@prefix_values[definition.name] = definition.scalar definition.aliases.each { |alias_name| @@prefix_map[alias_name] = definition.name } @@prefix_regex = nil # invalidate the prefix regex else @@unit_values[definition.name] = {} @@unit_values[definition.name][:scalar] = definition.scalar @@unit_values[definition.name][:numerator] = definition.numerator if definition.numerator @@unit_values[definition.name][:denominator] = definition.denominator if definition.denominator definition.aliases.each { |alias_name| @@unit_map[alias_name] = definition.name } @@unit_regex = nil # invalidate the unit regex end end |
Instance Method Details
#%(other) ⇒ Integer
perform a modulo on a unit, will raise an exception if the units are not compatible
943 944 945 |
# File 'lib/ruby_units/unit.rb', line 943 def %(other) divmod(other).last end |
#*(other) ⇒ Unit
Multiply two units.
891 892 893 894 895 896 897 898 899 900 901 902 903 904 |
# File 'lib/ruby_units/unit.rb', line 891 def *(other) case other when Unit raise ArgumentError, 'Cannot multiply by temperatures' if [other, self].any?(&:temperature?) opts = RubyUnits::Unit.eliminate_terms(@scalar * other.scalar, @numerator + other.numerator, @denominator + other.denominator) opts[:signature] = @signature + other.signature RubyUnits::Unit.new(opts) when Numeric RubyUnits::Unit.new(scalar: @scalar * other, numerator: @numerator, denominator: @denominator, signature: @signature) else x, y = coerce(other) x * y end end |
#**(other) ⇒ Unit
Exponentiate. Only takes integer powers. Note that anything raised to the power of 0 results in a Unit object with a scalar of 1, and no units. Throws an exception if exponent is not an integer. Ideally this routine should accept a float for the exponent It should then convert the float to a rational and raise the unit by the numerator and root it by the denominator but, sadly, floats can’t be converted to rationals.
For now, if a rational is passed in, it will be used, otherwise we are stuck with integers and certain floats < 1
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 |
# File 'lib/ruby_units/unit.rb', line 961 def **(other) raise ArgumentError, 'Cannot raise a temperature to a power' if temperature? if other.is_a?(Numeric) return inverse if other == -1 return self if other == 1 return 1 if other.zero? end case other when Rational return power(other.numerator).root(other.denominator) when Integer return power(other) when Float return self**other.to_i if other == other.to_i valid = (1..9).map { |x| 1 / x } raise ArgumentError, 'Not a n-th root (1..9), use 1/n' unless valid.include? other.abs return root((1 / other).to_int) when Complex raise ArgumentError, 'exponentiation of complex numbers is not yet supported.' else raise ArgumentError, 'Invalid Exponent' end end |
#+(other) ⇒ Unit
Add two units together. Result is same units as receiver and scalar and base_scalar are updated appropriately throws an exception if the units are not compatible. It is possible to add Time objects to units of time
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 |
# File 'lib/ruby_units/unit.rb', line 822 def +(other) case other when Unit if zero? other.dup elsif self =~ other raise ArgumentError, 'Cannot add two temperatures' if [self, other].all?(&:temperature?) if [self, other].any?(&:temperature?) if temperature? RubyUnits::Unit.new(scalar: (scalar + other.convert_to(temperature_scale).scalar), numerator: @numerator, denominator: @denominator, signature: @signature) else RubyUnits::Unit.new(scalar: (other.scalar + convert_to(other.temperature_scale).scalar), numerator: other.numerator, denominator: other.denominator, signature: other.signature) end else @q ||= ((@@cached_units[units].scalar / @@cached_units[units].base_scalar) rescue units.to_unit.to_base.scalar) RubyUnits::Unit.new(scalar: (base_scalar + other.base_scalar) * @q, numerator: @numerator, denominator: @denominator, signature: @signature) end else raise ArgumentError, "Incompatible Units ('#{self}' not compatible with '#{other}')" end when Date, Time raise ArgumentError, 'Date and Time objects represent fixed points in time and cannot be added to a Unit' else x, y = coerce(other) y + x end end |
#-(other) ⇒ Unit
Subtract two units. Result is same units as receiver and scalar and base_scalar are updated appropriately
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 |
# File 'lib/ruby_units/unit.rb', line 856 def -(other) case other when Unit if zero? if other.zero? other.dup * -1 # preserve Units class else -other.dup end elsif self =~ other if [self, other].all?(&:temperature?) RubyUnits::Unit.new(scalar: (base_scalar - other.base_scalar), numerator: KELVIN, denominator: UNITY_ARRAY, signature: @signature).convert_to(temperature_scale) elsif temperature? RubyUnits::Unit.new(scalar: (base_scalar - other.base_scalar), numerator: ['<tempK>'], denominator: UNITY_ARRAY, signature: @signature).convert_to(self) elsif other.temperature? raise ArgumentError, 'Cannot subtract a temperature from a differential degree unit' else @q ||= ((@@cached_units[units].scalar / @@cached_units[units].base_scalar) rescue (units.to_unit.scalar / units.to_unit.to_base.scalar)) RubyUnits::Unit.new(scalar: (base_scalar - other.base_scalar) * @q, numerator: @numerator, denominator: @denominator, signature: @signature) end else raise ArgumentError, "Incompatible Units ('#{self}' not compatible with '#{other}')" end when Time raise ArgumentError, 'Date and Time objects represent fixed points in time and cannot be subtracted from to a Unit, which can only represent time spans' else x, y = coerce(other) y - x end end |
#-@ ⇒ Numeric, Unit
negates the scalar of the Unit
1217 1218 1219 1220 |
# File 'lib/ruby_units/unit.rb', line 1217 def -@ return -@scalar if unitless? dup * -1 end |
#/(other) ⇒ Unit
Divide two units. Throws an exception if divisor is 0
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 |
# File 'lib/ruby_units/unit.rb', line 912 def /(other) case other when Unit raise ZeroDivisionError if other.zero? raise ArgumentError, 'Cannot divide with temperatures' if [other, self].any?(&:temperature?) opts = RubyUnits::Unit.eliminate_terms(@scalar / other.scalar, @numerator + other.denominator, @denominator + other.numerator) opts[:signature] = @signature - other.signature RubyUnits::Unit.new(opts) when Numeric raise ZeroDivisionError if other.zero? RubyUnits::Unit.new(scalar: @scalar / other, numerator: @numerator, denominator: @denominator, signature: @signature) else x, y = coerce(other) y / x end end |
#<=>(other) ⇒ -1|0|1|nil
Compare two Unit objects. Throws an exception if they are not of compatible types. Comparisons are done based on the value of the unit in base SI units.
726 727 728 729 730 731 732 733 734 735 736 737 738 739 |
# File 'lib/ruby_units/unit.rb', line 726 def <=>(other) raise NoMethodError, "undefined method `<=>' for #{base_scalar.inspect}" unless base_scalar.respond_to?(:<=>) if other.nil? base_scalar <=> nil elsif !temperature? && other.respond_to?(:zero?) && other.zero? base_scalar <=> 0 elsif other.instance_of?(Unit) raise ArgumentError, "Incompatible Units ('#{units}' not compatible with '#{other.units}')" unless self =~ other base_scalar <=> other.base_scalar else x, y = coerce(other) y <=> x end end |
#==(other) ⇒ Boolean
Compare Units for equality this is necessary mostly for Complex units. Complex units do not have a <=> operator so we define this one here so that we can properly check complex units for equality. Units of incompatible types are not equal, except when they are both zero and neither is a temperature Equality checks can be tricky since round off errors may make essentially equivalent units appear to be different.
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 |
# File 'lib/ruby_units/unit.rb', line 749 def ==(other) if other.respond_to?(:zero?) && other.zero? zero? elsif other.instance_of?(Unit) return false unless self =~ other base_scalar == other.base_scalar else begin x, y = coerce(other) x == y rescue ArgumentError # return false when object cannot be coerced false end end end |
#===(other) ⇒ Boolean Also known as: same?, same_as?
Compare two units. Returns true if quantities and units match
797 798 799 800 801 802 803 804 805 806 807 808 809 |
# File 'lib/ruby_units/unit.rb', line 797 def ===(other) case other when Unit (scalar == other.scalar) && (units == other.units) else begin x, y = coerce(other) return x === y rescue ArgumentError return false end end end |
#=~(other) ⇒ Boolean Also known as: compatible?, compatible_with?
if you want to do a regexp comparison of the unit string do this … unit.units =~ /regexp/
check to see if units are compatible, but not the scalar part this check is done by comparing signatures for performance reasons if passed a string, it will create a unit object with the string and then do the comparison
774 775 776 777 778 779 780 781 782 783 784 785 786 |
# File 'lib/ruby_units/unit.rb', line 774 def =~(other) case other when Unit signature == other.signature else begin x, y = coerce(other) return x =~ y rescue ArgumentError return false end end end |
#abs ⇒ Numeric, Unit
absolute value of a unit
1224 1225 1226 1227 |
# File 'lib/ruby_units/unit.rb', line 1224 def abs return @scalar.abs if unitless? RubyUnits::Unit.new(@scalar.abs, @numerator, @denominator) end |
#as_json ⇒ String
Returns string formatted for json
1151 1152 1153 |
# File 'lib/ruby_units/unit.rb', line 1151 def as_json(*) to_s end |
#base? ⇒ Boolean Also known as: is_base?
Is this unit in base form?
557 558 559 560 561 562 563 564 565 |
# File 'lib/ruby_units/unit.rb', line 557 def base? return @base if defined? @base @base = (@numerator + @denominator) .compact .uniq .map { |unit| RubyUnits::Unit.definition(unit) } .all? { |element| element.unity? || element.base? } @base end |
#before(time_point = ::Time.now) ⇒ Unit Also known as: before_now
1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'lib/ruby_units/unit.rb', line 1308 def before(time_point = ::Time.now) case time_point when Time, Date, DateTime return (time_point - self rescue time_point.to_datetime - self) else raise ArgumentError, 'Must specify a Time, Date, or DateTime' end end |
#best_prefix ⇒ Object
returns a new unit that has been scaled to be more in line with typical usage.
1379 1380 1381 1382 1383 1384 1385 1386 1387 |
# File 'lib/ruby_units/unit.rb', line 1379 def best_prefix return to_base if scalar.zero? best_prefix = if kind == :information @@prefix_values.key(2**((Math.log(base_scalar, 2) / 10.0).floor * 10)) else @@prefix_values.key(10**((Math.log10(base_scalar) / 3.0).floor * 3)) end to(RubyUnits::Unit.new(@@prefix_map.key(best_prefix) + units(with_prefix: false))) end |
#ceil ⇒ Numeric, Unit
ceil of a unit
1231 1232 1233 1234 |
# File 'lib/ruby_units/unit.rb', line 1231 def ceil return @scalar.ceil if unitless? RubyUnits::Unit.new(@scalar.ceil, @numerator, @denominator) end |
#coerce(other) ⇒ Array
automatically coerce objects to units when possible if an object defines a ‘to_unit’ method, it will be coerced using that method
1368 1369 1370 1371 1372 1373 1374 1375 1376 |
# File 'lib/ruby_units/unit.rb', line 1368 def coerce(other) return [other.to_unit, self] if other.respond_to? :to_unit case other when Unit [other, self] else [RubyUnits::Unit.new(other), self] end end |
#convert_to(other) ⇒ Unit Also known as: >>, to
If temperature is part of a compound unit, the temperature will be treated as a differential and the units will be scaled appropriately.
convert to a specified unit string or to the same units as another Unit
unit.convert_to "kg" will covert to kilograms
unit1.convert_to unit2 converts to same units as unit2 object
To convert a Unit object to match another Unit object, use:
unit1 >>= unit2
Special handling for temperature conversions is supported. If the Unit object is converted from one temperature unit to another, the proper temperature offsets will be used. Supports Kelvin, Celsius, Fahrenheit, and Rankine scales.
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 |
# File 'lib/ruby_units/unit.rb', line 1059 def convert_to(other) return self if other.nil? return self if TrueClass === other return self if FalseClass === other if (Unit === other && other.temperature?) || (String === other && other =~ /temp[CFRK]/) raise ArgumentError, 'Receiver is not a temperature unit' unless degree? start_unit = units target_unit = other.units rescue other unless @base_scalar @base_scalar = case @@unit_map[start_unit] when '<tempC>' @scalar + 273.15 when '<tempK>' @scalar when '<tempF>' (@scalar + 459.67) * Rational(5, 9) when '<tempR>' @scalar * Rational(5, 9) end end q = case @@unit_map[target_unit] when '<tempC>' @base_scalar - 273.15 when '<tempK>' @base_scalar when '<tempF>' @base_scalar * Rational(9, 5) - 459.67 when '<tempR>' @base_scalar * Rational(9, 5) end return RubyUnits::Unit.new("#{q} #{target_unit}") else case other when Unit return self if other.units == units target = other when String target = RubyUnits::Unit.new(other) else raise ArgumentError, 'Unknown target units' end raise ArgumentError, "Incompatible Units ('#{self}' not compatible with '#{other}')" unless self =~ target numerator1 = @numerator.map { |x| @@prefix_values[x] ? @@prefix_values[x] : x }.map { |i| i.is_a?(Numeric) ? i : @@unit_values[i][:scalar] }.compact denominator1 = @denominator.map { |x| @@prefix_values[x] ? @@prefix_values[x] : x }.map { |i| i.is_a?(Numeric) ? i : @@unit_values[i][:scalar] }.compact numerator2 = target.numerator.map { |x| @@prefix_values[x] ? @@prefix_values[x] : x }.map { |x| x.is_a?(Numeric) ? x : @@unit_values[x][:scalar] }.compact denominator2 = target.denominator.map { |x| @@prefix_values[x] ? @@prefix_values[x] : x }.map { |x| x.is_a?(Numeric) ? x : @@unit_values[x][:scalar] }.compact q = @scalar * ((numerator1 + denominator2).inject(1) { |acc, elem| acc * elem }) / ((numerator2 + denominator1).inject(1) { |acc, elem| acc * elem }) return RubyUnits::Unit.new(scalar: q, numerator: target.numerator, denominator: target.denominator, signature: target.signature) end end |
#copy(from) ⇒ Unit
Used to copy one unit to another
432 433 434 435 436 437 438 439 440 441 |
# File 'lib/ruby_units/unit.rb', line 432 def copy(from) @scalar = from.scalar @numerator = from.numerator @denominator = from.denominator @base = from.base? @signature = from.signature @base_scalar = from.base_scalar @unit_name = from.unit_name rescue nil self end |
#degree? ⇒ Boolean Also known as: is_degree?
true if a degree unit or equivalent.
699 700 701 |
# File 'lib/ruby_units/unit.rb', line 699 def degree? kind == :temperature end |
#divmod(other) ⇒ Array
divide two units and return quotient and remainder when both units are in the same units we just use divmod on the raw scalars otherwise we use the scalar of the base unit which will be a float
934 935 936 937 938 |
# File 'lib/ruby_units/unit.rb', line 934 def divmod(other) raise ArgumentError, "Incompatible Units ('#{self}' not compatible with '#{other}')" unless self =~ other return scalar.divmod(other.scalar) if units == other.units to_base.scalar.divmod(other.to_base.scalar) end |
#floor ⇒ Numeric, Unit
1237 1238 1239 1240 |
# File 'lib/ruby_units/unit.rb', line 1237 def floor return @scalar.floor if unitless? RubyUnits::Unit.new(@scalar.floor, @numerator, @denominator) end |
#from(time_point) ⇒ Time, ... Also known as: after, from_now
1352 1353 1354 1355 1356 1357 1358 1359 |
# File 'lib/ruby_units/unit.rb', line 1352 def from(time_point) case time_point when Time, DateTime, Date (time_point + self rescue time_point.to_datetime + self) else raise ArgumentError, 'Must specify a Time, Date, or DateTime' end end |
#hash ⇒ Object
override hash method so objects with same values are considered equal
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 |
# File 'lib/ruby_units/unit.rb', line 1390 def hash [ @scalar, @numerator, @denominator, @base, @signature, @base_scalar, @unit_name ].hash end |
#inspect(dump = nil) ⇒ String
Normally pretty prints the unit, but if you really want to see the guts of it, pass ‘:dump’
683 684 685 686 |
# File 'lib/ruby_units/unit.rb', line 683 def inspect(dump = nil) return super() if dump to_s end |
#inverse ⇒ Unit
returns inverse of Unit (1/unit)
1036 1037 1038 |
# File 'lib/ruby_units/unit.rb', line 1036 def inverse RubyUnits::Unit.new('1') / self end |
#kind ⇒ Symbol
@todo: figure out how to handle :counting units. This method should probably return :counting instead of :unitless for ‘each’ return the kind of the unit (:mass, :length, etc…)
544 545 546 |
# File 'lib/ruby_units/unit.rb', line 544 def kind @@kinds[signature] end |
#power(n) ⇒ Unit
returns the unit raised to the n-th power
990 991 992 993 994 995 996 997 998 |
# File 'lib/ruby_units/unit.rb', line 990 def power(n) raise ArgumentError, 'Cannot raise a temperature to a power' if temperature? raise ArgumentError, 'Exponent must an Integer' unless n.is_a?(Integer) return inverse if n == -1 return 1 if n.zero? return self if n == 1 return (1..(n - 1).to_i).inject(self) { |acc, _elem| acc * self } if n >= 0 (1..-(n - 1).to_i).inject(self) { |acc, _elem| acc / self } end |
#pred ⇒ Unit
returns previous unit in a range. ‘2 mm’.to_unit.pred #=> ‘1 mm’.to_unit only works when the scalar is an integer
1269 1270 1271 1272 |
# File 'lib/ruby_units/unit.rb', line 1269 def pred raise ArgumentError, 'Non Integer Scalar' unless @scalar == @scalar.to_i RubyUnits::Unit.new(@scalar.to_i.pred, @numerator, @denominator) end |
#root(n) ⇒ Unit
Calculates the n-th root of a unit if n < 0, returns 1/unit^(1/n)
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 |
# File 'lib/ruby_units/unit.rb', line 1007 def root(n) raise ArgumentError, 'Cannot take the root of a temperature' if temperature? raise ArgumentError, 'Exponent must an Integer' unless n.is_a?(Integer) raise ArgumentError, '0th root undefined' if n.zero? return self if n == 1 return root(n.abs).inverse if n < 0 vec = unit_signature_vector vec = vec.map { |x| x % n } raise ArgumentError, 'Illegal root' unless vec.max.zero? num = @numerator.dup den = @denominator.dup @numerator.uniq.each do |item| x = num.find_all { |i| i == item }.size r = ((x / n) * (n - 1)).to_int r.times { num.delete_at(num.index(item)) } end @denominator.uniq.each do |item| x = den.find_all { |i| i == item }.size r = ((x / n) * (n - 1)).to_int r.times { den.delete_at(den.index(item)) } end RubyUnits::Unit.new(scalar: @scalar**Rational(1, n), numerator: num, denominator: den) end |
#round(ndigits = 0) ⇒ Numeric, Unit
1243 1244 1245 1246 |
# File 'lib/ruby_units/unit.rb', line 1243 def round(ndigits = 0) return @scalar.round(ndigits) if unitless? RubyUnits::Unit.new(@scalar.round(ndigits), @numerator, @denominator) end |
#since(time_point) ⇒ Unit
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'lib/ruby_units/unit.rb', line 1323 def since(time_point) case time_point when Time (Time.now - time_point).to_unit('s').convert_to(self) when DateTime, Date (DateTime.now - time_point).to_unit('d').convert_to(self) else raise ArgumentError, 'Must specify a Time, Date, or DateTime' end end |
#succ ⇒ Unit Also known as: next
returns next unit in a range. ‘1 mm’.to_unit.succ #=> ‘2 mm’.to_unit only works when the scalar is an integer
1258 1259 1260 1261 |
# File 'lib/ruby_units/unit.rb', line 1258 def succ raise ArgumentError, 'Non Integer Scalar' unless @scalar == @scalar.to_i RubyUnits::Unit.new(@scalar.to_i.succ, @numerator, @denominator) end |
#temperature? ⇒ Boolean Also known as: is_temperature?
use unit definition to determine if it’s a temperature instead of a regex
true if unit is a ‘temperature’, false if a ‘degree’ or anything else
691 692 693 |
# File 'lib/ruby_units/unit.rb', line 691 def temperature? degree? && !(@@unit_map[units] =~ /temp[CFRK]/).nil? end |
#temperature_scale ⇒ String
returns the ‘degree’ unit associated with a temperature unit
708 709 710 711 |
# File 'lib/ruby_units/unit.rb', line 708 def temperature_scale return nil unless temperature? "deg#{@@unit_map[units][/temp([CFRK])/, 1]}" end |
#to_base ⇒ Unit Also known as: base
this is brittle as it depends on the display_name of a unit, which can be changed
convert to base SI units results of the conversion are cached so subsequent calls to this will be fast
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
# File 'lib/ruby_units/unit.rb', line 573 def to_base return self if base? if @@unit_map[units] =~ /\A<(?:temp|deg)[CRF]>\Z/ @signature = @@kinds.key(:temperature) base = if temperature? convert_to('tempK') elsif degree? convert_to('degK') end return base end cached = ((@@base_unit_cache[units] * scalar) rescue nil) return cached if cached num = [] den = [] q = 1 @numerator.compact.each do |unit| if @@prefix_values[unit] q *= @@prefix_values[unit] else q *= @@unit_values[unit][:scalar] if @@unit_values[unit] num << @@unit_values[unit][:numerator] if @@unit_values[unit] && @@unit_values[unit][:numerator] den << @@unit_values[unit][:denominator] if @@unit_values[unit] && @@unit_values[unit][:denominator] end end @denominator.compact.each do |unit| if @@prefix_values[unit] q /= @@prefix_values[unit] else q /= @@unit_values[unit][:scalar] if @@unit_values[unit] den << @@unit_values[unit][:numerator] if @@unit_values[unit] && @@unit_values[unit][:numerator] num << @@unit_values[unit][:denominator] if @@unit_values[unit] && @@unit_values[unit][:denominator] end end num = num.flatten.compact den = den.flatten.compact num = UNITY_ARRAY if num.empty? base = RubyUnits::Unit.new(RubyUnits::Unit.eliminate_terms(q, num, den)) @@base_unit_cache[units] = base base * @scalar end |
#to_c ⇒ Complex
converts the unit back to a complex if it is unitless. Otherwise raises an exception
1126 1127 1128 1129 |
# File 'lib/ruby_units/unit.rb', line 1126 def to_c return Complex(@scalar) if unitless? raise "Cannot convert '#{self}' to Complex unless unitless. Use Unit#scalar" end |
#to_date ⇒ Date
1290 1291 1292 |
# File 'lib/ruby_units/unit.rb', line 1290 def to_date Date.new0(convert_to('d').scalar) end |
#to_datetime ⇒ DateTime
convert a duration to a DateTime. This will work so long as the duration is the duration from the zero date defined by DateTime
1285 1286 1287 |
# File 'lib/ruby_units/unit.rb', line 1285 def to_datetime DateTime.new!(convert_to('d').scalar) end |
#to_f ⇒ Float
converts the unit back to a float if it is unitless. Otherwise raises an exception
1118 1119 1120 1121 |
# File 'lib/ruby_units/unit.rb', line 1118 def to_f return @scalar.to_f if unitless? raise "Cannot convert '#{self}' to Float unless unitless. Use Unit#scalar" end |
#to_i ⇒ Integer Also known as: to_int
if unitless, returns an int, otherwise raises an error
1134 1135 1136 1137 |
# File 'lib/ruby_units/unit.rb', line 1134 def to_i return @scalar.to_int if unitless? raise "Cannot convert '#{self}' to Integer unless unitless. Use Unit#scalar" end |
#to_r ⇒ Rational
if unitless, returns a Rational, otherwise raises an error
1144 1145 1146 1147 |
# File 'lib/ruby_units/unit.rb', line 1144 def to_r return @scalar.to_r if unitless? raise "Cannot convert '#{self}' to Rational unless unitless. Use Unit#scalar" end |
#to_s(target_units = nil) ⇒ String
Generate human readable output. If the name of a unit is passed, the unit will first be converted to the target unit before output. some named conversions are available
You can also pass a standard format string (i.e., ‘%0.2f’) or a strftime format string.
output is cached so subsequent calls for the same format will be fast
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 |
# File 'lib/ruby_units/unit.rb', line 635 def to_s(target_units = nil) out = @output[target_units] return out if out separator = RubyUnits.configuration.separator case target_units when :ft inches = convert_to('in').scalar.to_int out = "#{(inches / 12).truncate}\'#{(inches % 12).round}\"" when :lbs ounces = convert_to('oz').scalar.to_int out = "#{(ounces / 16).truncate}#{separator}lbs, #{(ounces % 16).round}#{separator}oz" when :stone pounds = convert_to('lbs').scalar.to_int out = "#{(pounds / 14).truncate}#{separator}stone, #{(pounds % 14).round}#{separator}lb" when String out = case target_units.strip when /\A\s*\Z/ # whitespace only '' when /(%[\-+\.\w#]+)\s*(.+)*/ # format string like '%0.2f in' begin if $2 # unit specified, need to convert convert_to($2).to_s($1) else "#{$1 % @scalar}#{separator}#{$2 || units}".strip end rescue # parse it like a strftime format string (DateTime.new(0) + self).strftime(target_units) end when /(\S+)/ # unit only 'mm' or '1/mm' convert_to($1).to_s else raise 'unhandled case' end else out = case @scalar when Rational, Complex "#{@scalar}#{separator}#{units}" else "#{'%g' % @scalar}#{separator}#{units}" end.strip end @output[target_units] = out out end |
#to_time ⇒ Time Also known as: time
Tries to make a Time object from current unit. Assumes the current unit hold the duration in seconds from the epoch.
1276 1277 1278 |
# File 'lib/ruby_units/unit.rb', line 1276 def to_time Time.at(self) end |
#to_unit ⇒ Unit Also known as: unit
549 550 551 |
# File 'lib/ruby_units/unit.rb', line 549 def to_unit self end |
#truncate ⇒ Numeric, Unit
1249 1250 1251 1252 |
# File 'lib/ruby_units/unit.rb', line 1249 def truncate return @scalar.truncate if unitless? RubyUnits::Unit.new(@scalar.truncate, @numerator, @denominator) end |
#unitless? ⇒ Boolean
returns true if no associated units false, even if the units are “unitless” like ‘radians, each, etc’
716 717 718 |
# File 'lib/ruby_units/unit.rb', line 716 def unitless? (@numerator == UNITY_ARRAY && @denominator == UNITY_ARRAY) end |
#units(with_prefix: true) ⇒ String
returns the ‘unit’ part of the Unit object without the scalar
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 |
# File 'lib/ruby_units/unit.rb', line 1157 def units(with_prefix: true) return '' if @numerator == UNITY_ARRAY && @denominator == UNITY_ARRAY output_numerator = ['1'] output_denominator = [] num = @numerator.clone.compact den = @denominator.clone.compact unless num == UNITY_ARRAY definitions = num.map { |element| RubyUnits::Unit.definition(element) } definitions.reject!(&:prefix?) unless with_prefix # there is a bug in jruby 9.1.6.0's implementation of chunk_while # see https://github.com/jruby/jruby/issues/4410 # TODO: fix this after jruby fixes their bug. definitions = if definitions.respond_to?(:chunk_while) && RUBY_ENGINE != 'jruby' definitions.chunk_while { |defn, _| defn.prefix? }.to_a else # chunk_while is new to ruby 2.3+, so fallback to less efficient methods for older ruby result = [] enumerator = definitions.to_enum loop do first = enumerator.next result << (first.prefix? ? [first, enumerator.next] : [first]) end result end output_numerator = definitions.map { |element| element.map(&:display_name).join } end unless den == UNITY_ARRAY definitions = den.map { |element| RubyUnits::Unit.definition(element) } definitions.reject!(&:prefix?) unless with_prefix # there is a bug in jruby 9.1.6.0's implementation of chunk_while # see https://github.com/jruby/jruby/issues/4410 # TODO: fix this after jruby fixes their bug. definitions = if definitions.respond_to?(:chunk_while) && RUBY_ENGINE != 'jruby' definitions.chunk_while { |defn, _| defn.prefix? }.to_a else # chunk_while is new to ruby 2.3+, so fallback to less efficient methods for older ruby result = [] enumerator = definitions.to_enum loop do first = enumerator.next result << (first.prefix? ? [first, enumerator.next] : [first]) end result end output_denominator = definitions.map { |element| element.map(&:display_name).join } end on = output_numerator .uniq .map { |x| [x, output_numerator.count(x)] } .map { |element, power| (element.to_s.strip + (power > 1 ? "^#{power}" : '')) } od = output_denominator .uniq .map { |x| [x, output_denominator.count(x)] } .map { |element, power| (element.to_s.strip + (power > 1 ? "^#{power}" : '')) } "#{on.join('*')}#{od.empty? ? '' : '/' + od.join('*')}".strip end |
#until(time_point) ⇒ Unit
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 |
# File 'lib/ruby_units/unit.rb', line 1337 def until(time_point) case time_point when Time (time_point - Time.now).to_unit('s').convert_to(self) when DateTime, Date (time_point - DateTime.now).to_unit('d').convert_to(self) else raise ArgumentError, 'Must specify a Time, Date, or DateTime' end end |
#zero? ⇒ Boolean
true if scalar is zero
1296 1297 1298 |
# File 'lib/ruby_units/unit.rb', line 1296 def zero? base_scalar.zero? end |