Module: Math

Defined in:
lib/ruby_units/math.rb

Overview

Math will convert unit objects to radians and then attempt to use the value for trigonometric functions.

Class Method Summary collapse

Class Method Details

.atan2(x, y) ⇒ Numeric

Returns:

Raises:

  • (ArgumentError) 


115
116
117
118
119
120
121
122
 
# File 'lib/ruby_units/math.rb', line 115

def atan2(x, y)
  raise ArgumentError, 'Incompatible RubyUnits::Units' if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && !x.compatible?(y)
  if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && x.compatible?(y)
    Math.unit_atan2(x.base_scalar, y.base_scalar)
  else
    Math.unit_atan2(x, y)
  end
end

.cbrt(n) ⇒ Numeric

Returns:



24
25
26
27
28
29
30
 
# File 'lib/ruby_units/math.rb', line 24

def cbrt(n)
  if RubyUnits::Unit === n
    (n**Rational(1, 3)).to_unit
  else
    unit_cbrt(n)
  end
end

.cos(n) ⇒ Numeric

Returns:



50
51
52
 
# File 'lib/ruby_units/math.rb', line 50

def cos(n)
  RubyUnits::Unit === n ? unit_cos(n.convert_to('radian').scalar) : unit_cos(n)
end

.cosh(n) ⇒ Numeric

Returns:



70
71
72
 
# File 'lib/ruby_units/math.rb', line 70

def cosh(n)
  RubyUnits::Unit === n ? unit_cosh(n.convert_to('radian').scalar) : unit_cosh(n)
end

.hypot(x, y) ⇒ Numeric

Convert parameters to consistent units and perform the function

Returns:



101
102
103
104
105
106
107
 
# File 'lib/ruby_units/math.rb', line 101

def hypot(x, y)
  if RubyUnits::Unit === x && RubyUnits::Unit === y
    (x**2 + y**2)**(1 / 2)
  else
    unit_hypot(x, y)
  end
end

.sin(n) ⇒ Numeric

Returns:



40
41
42
 
# File 'lib/ruby_units/math.rb', line 40

def sin(n)
  RubyUnits::Unit === n ? unit_sin(n.convert_to('radian').scalar) : unit_sin(n)
end

.sinh(n) ⇒ Numeric

Returns:



60
61
62
 
# File 'lib/ruby_units/math.rb', line 60

def sinh(n)
  RubyUnits::Unit === n ? unit_sinh(n.convert_to('radian').scalar) : unit_sinh(n)
end

.sqrt(n) ⇒ Numeric

Returns:



8
9
10
11
12
13
14
 
# File 'lib/ruby_units/math.rb', line 8

def sqrt(n)
  if n.is_a?(RubyUnits::Unit)
    (n**Rational(1, 2)).to_unit
  else
    unit_sqrt(n)
  end
end

.tan(n) ⇒ Numeric

Returns:



80
81
82
 
# File 'lib/ruby_units/math.rb', line 80

def tan(n)
  RubyUnits::Unit === n ? unit_tan(n.convert_to('radian').scalar) : unit_tan(n)
end

.tanh(n) ⇒ Numeric

Returns:



90
91
92
 
# File 'lib/ruby_units/math.rb', line 90

def tanh(n)
  RubyUnits::Unit === n ? unit_tanh(n.convert_to('radian').scalar) : unit_tanh(n)
end

.unit_atan2 ⇒ Object 



113
 
# File 'lib/ruby_units/math.rb', line 113

alias unit_atan2 atan2

.unit_cbrt ⇒ Object 



22
 
# File 'lib/ruby_units/math.rb', line 22

alias unit_cbrt cbrt

.unit_cos ⇒ Object 



48
 
# File 'lib/ruby_units/math.rb', line 48

alias unit_cos cos

.unit_cosh ⇒ Object 



68
 
# File 'lib/ruby_units/math.rb', line 68

alias unit_cosh cosh

.unit_hypot ⇒ Object 



98
 
# File 'lib/ruby_units/math.rb', line 98

alias unit_hypot hypot

.unit_sin ⇒ Object

:nocov:



38
 
# File 'lib/ruby_units/math.rb', line 38

alias unit_sin sin

.unit_sinh ⇒ Object 



58
 
# File 'lib/ruby_units/math.rb', line 58

alias unit_sinh sinh

.unit_sqrt ⇒ Object 



6
 
# File 'lib/ruby_units/math.rb', line 6

alias unit_sqrt sqrt

.unit_tan ⇒ Object 



78
 
# File 'lib/ruby_units/math.rb', line 78

alias unit_tan tan

.unit_tanh ⇒ Object 



88
 
# File 'lib/ruby_units/math.rb', line 88

alias unit_tanh tanh