joules 0.3.0 → 0.3.1

data/lib/joules/kinematics.rb

@@ -3,128 +3,133 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)
 
-# Calculates the average speed given distance and time.
-# @param distance [Int, Float]
-#   distance >= 0; distance is in meters
-# @param time [Int, Float]
-#   time > 0; time is in seconds
-# @return [Float]
-#   return value >= 0; return value is in meters per second
-# @example
-#   avg_speed(30, 2.4) #=> 12.5
-def avg_speed(distance, time)
-  return distance / time.to_f 
-end
+module Joules
+  module_function
 
-# Calculates the average velocity given displacement and time.
-# @param displacement [Int, Float]
-#   displacement is in meters
-# @param time [Int, Float]
-#   time > 0; time is in seconds
-# @return [Float]
-#   return value is in meters per second
-# @example
-#   avg_velocity(180, 4.8) #=> 37.5 
-def avg_velocity(displacement, time)
-  return displacement / time.to_f
-end
+  # Calculates the average speed given distance and time.
+  # @param distance [Int, Float]
+  #   distance >= 0; distance is in meters
+  # @param time [Int, Float]
+  #   time > 0; time is in seconds
+  # @return [Float]
+  #   return value >= 0; return value is in meters per second
+  # @example
+  #   Joules.avg_speed(30, 2.4) #=> 12.5
+  def avg_speed(distance, time)
+    return distance / time.to_f 
+  end
 
-# Calculates the acceleration given initial velocity, final velocity, and time.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param final_velocity [Int, Float]
-#   final_velocity is in meters per second
-# @param time [Int, Float]
-#   time > 0; time is in seconds
-# @return [Float]
-#   return value is in meters per second squared
-# @example
-#   acceleration(20, 35, 2.4) #=> 6.25
-def acceleration(initial_velocity, final_velocity, time)
-  return (final_velocity - initial_velocity) / time.to_f
-end
+  # Calculates the average velocity given displacement and time.
+  # @param displacement [Int, Float]
+  #   displacement is in meters
+  # @param time [Int, Float]
+  #   time > 0; time is in seconds
+  # @return [Float]
+  #   return value is in meters per second
+  # @example
+  #   Joules.avg_velocity(180, 4.8) #=> 37.5 
+  def avg_velocity(displacement, time)
+    return displacement / time.to_f
+  end
 
-# Calculates the final velocity given initial velocity, acceleration, and time.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param acceleration [Int, Float]
-#   acceleration is in meters per second squared
-# @param time [Int, Float]
-#   time >= 0; time is in seconds
-# @return [Float]
-#   return value is in meters per second
-# @example
-#   final_velocity_v1(20, 6.25, 2.4) #=> 35.0
-# @note There is one other method for calculating final velocity.
-def final_velocity_v1(initial_velocity, acceleration, time)
-  return initial_velocity + (acceleration * time.to_f)
-end
+  # Calculates the acceleration given initial velocity, final velocity, and time.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param final_velocity [Int, Float]
+  #   final_velocity is in meters per second
+  # @param time [Int, Float]
+  #   time > 0; time is in seconds
+  # @return [Float]
+  #   return value is in meters per second squared
+  # @example
+  #   Joules.acceleration(20, 35, 2.4) #=> 6.25
+  def acceleration(initial_velocity, final_velocity, time)
+    return (final_velocity - initial_velocity) / time.to_f
+  end
 
-# Calculates the final velocity given initial velocity, acceleration, and displacement.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param acceleration [Int, Float]
-#   acceleration is in meters per second squared
-# @param displacement [Int, Float]
-#   displacement is in meters
-# @return [Float]
-#   return value is in meters per second
-# @example
-#   final_velocity_v2(20, 6.25, 66) #=> 35.0
-# @note There is one other method for calculating final velocity.
-def final_velocity_v2(initial_velocity, acceleration, displacement)
-  return ((initial_velocity ** 2) + (2 * acceleration * displacement)) ** 0.5
-end
+  # Calculates the final velocity given initial velocity, acceleration, and time.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param acceleration [Int, Float]
+  #   acceleration is in meters per second squared
+  # @param time [Int, Float]
+  #   time >= 0; time is in seconds
+  # @return [Float]
+  #   return value is in meters per second
+  # @example
+  #   Joules.final_velocity_v1(20, 6.25, 2.4) #=> 35.0
+  # @note There is one other method for calculating final velocity.
+  def final_velocity_v1(initial_velocity, acceleration, time)
+    return initial_velocity + (acceleration * time.to_f)
+  end
 
-# Calculates the displacement given initial velocity, final velocity, and time.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param final_velocity [Int, Float]
-#   final_velocity is in meters per second
-# @param time [Int, Float]
-#   time >= 0; time is in seconds
-# @return [Float]
-#   return value is in meters
-# @example
-#   displacement_v1(20, 35, 2.4) #=> 66.0
-# @note There are two other methods for calculating displacement.
-def displacement_v1(initial_velocity, final_velocity, time)
-  return 0.5 * (initial_velocity + final_velocity) * time
-end
+  # Calculates the final velocity given initial velocity, acceleration, and displacement.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param acceleration [Int, Float]
+  #   acceleration is in meters per second squared
+  # @param displacement [Int, Float]
+  #   displacement is in meters
+  # @return [Float]
+  #   return value is in meters per second
+  # @example
+  #   Joules.final_velocity_v2(20, 6.25, 66) #=> 35.0
+  # @note There is one other method for calculating final velocity.
+  def final_velocity_v2(initial_velocity, acceleration, displacement)
+    return ((initial_velocity ** 2) + (2 * acceleration * displacement)) ** 0.5
+  end
 
-# Calculates the displacement given initial velocity, acceleration, and time.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param acceleration [Int, Float]
-#   acceleration is in meters per second squared
-# @param time [Int, Float]
-#   time >= 0; time is in seconds
-# @return [Float]
-#   return value is in meters
-# @example
-#   displacement_v2(20, 6.25, 2.4) #=> 66.0
-# @note There are two other methods for calculating displacement.
-def displacement_v2(initial_velocity, acceleration, time)
-  return (initial_velocity * time) + (0.5 * acceleration * (time ** 2))
-end
+  # Calculates the displacement given initial velocity, final velocity, and time.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param final_velocity [Int, Float]
+  #   final_velocity is in meters per second
+  # @param time [Int, Float]
+  #   time >= 0; time is in seconds
+  # @return [Float]
+  #   return value is in meters
+  # @example
+  #   Joules.displacement_v1(20, 35, 2.4) #=> 66.0
+  # @note There are two other methods for calculating displacement.
+  def displacement_v1(initial_velocity, final_velocity, time)
+    return 0.5 * (initial_velocity + final_velocity) * time
+  end
+
+  # Calculates the displacement given initial velocity, acceleration, and time.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param acceleration [Int, Float]
+  #   acceleration is in meters per second squared
+  # @param time [Int, Float]
+  #   time >= 0; time is in seconds
+  # @return [Float]
+  #   return value is in meters
+  # @example
+  #   Joules.displacement_v2(20, 6.25, 2.4) #=> 66.0
+  # @note There are two other methods for calculating displacement.
+  def displacement_v2(initial_velocity, acceleration, time)
+    return (initial_velocity * time) + (0.5 * acceleration * (time ** 2))
+  end
+
+  # Calculates the displacement given final velocity, acceleration, and time.
+  # @param final_velocity [Int, Float]
+  #   final_velocity is in meters per second
+  # @param acceleration [Int, Float]
+  #   acceleration is in meters per second squared
+  # @param time [Int, Float]
+  #   time >= 0; time is in seconds
+  # @return [Float]
+  #   return value is in meters
+  # @example
+  #   Joules.displacement_v3(35, 6.25, 2.4) #=> 66.0
+  # @note There are two other methods for calculating displacement.
+  def displacement_v3(final_velocity, acceleration, time)
+    return (final_velocity * time) - (0.5 * acceleration * (time ** 2))
+  end
 
-# Calculates the displacement given final velocity, acceleration, and time.
-# @param final_velocity [Int, Float]
-#   final_velocity is in meters per second
-# @param acceleration [Int, Float]
-#   acceleration is in meters per second squared
-# @param time [Int, Float]
-#   time >= 0; time is in seconds
-# @return [Float]
-#   return value is in meters
-# @example
-#   displacement_v3(35, 6.25, 2.4) #=> 66.0
-# @note There are two other methods for calculating displacement.
-def displacement_v3(final_velocity, acceleration, time)
-  return (final_velocity * time) - (0.5 * acceleration * (time ** 2))
 end

data/lib/joules/mass_weight.rb

@@ -3,31 +3,34 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)
 
-require_relative 'constants'
+module Joules
+  module_function
 
-# Calculates the weight given mass.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @return [Float]
-#   return value >= 0; return value is in newtons
-# @example
-#   weight(79.41) #=> 779.0121
-def weight(mass)
-  return mass * FREE_FALL_ACCELERATION 
-end
+  # Calculates the weight given mass.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @return [Float]
+  #   return value >= 0; return value is in newtons
+  # @example
+  #   Joules.weight(79.41) #=> 779.0121
+  def weight(mass)
+    return mass * FREE_FALL_ACCELERATION 
+  end
+
+  # Calculates the mass given weight.
+  # @param weight [Int, Float]
+  #   weight >= 0; weight is in newtons
+  # @return [Float]
+  #   return value >= 0; return value is in kilograms
+  # @example
+  #   Joules.mass(779.0121) #=> 79.41
+  def mass(weight)
+    return weight / FREE_FALL_ACCELERATION
+  end
 
-# Calculates the mass given weight.
-# @param weight [Int, Float]
-#   weight >= 0; weight is in newtons
-# @return [Float]
-#   return value >= 0; return value is in kilograms
-# @example
-#   mass(779.0121) #=> 79.41
-def mass(weight)
-  return weight / FREE_FALL_ACCELERATION
 end

data/lib/joules/momentum_impulse.rb

@@ -3,50 +3,55 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)
 
-# Calculates the momentum given mass and velocity.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param velocity [Int, Float]
-#   velocity is in meters per second
-# @return [Float]
-#   return value is in newton seconds
-# @example
-#   momentum(52, 4.7) #=> 244.4
-def momentum(mass, velocity)
-  return mass * velocity.to_f
-end
+module Joules
+  module_function
 
-# Calculates the impulse given force and time.
-# @param force [Int, Float]
-#   force is in newtons
-# @param time [Int, Float]
-#   time >= 0; time is in seconds
-# @return [Float]
-#   return value is in newton seconds
-# @example
-#   impulse_v1(30.8, 9.6) #=> 295.68
-# @note There is one other method for calculating impulse.
-def impulse_v1(force, time)
-  return force * time.to_f
-end
+  # Calculates the momentum given mass and velocity.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param velocity [Int, Float]
+  #   velocity is in meters per second
+  # @return [Float]
+  #   return value is in newton seconds
+  # @example
+  #   Joules.momentum(52, 4.7) #=> 244.4
+  def momentum(mass, velocity)
+    return mass * velocity.to_f
+  end
+
+  # Calculates the impulse given force and time.
+  # @param force [Int, Float]
+  #   force is in newtons
+  # @param time [Int, Float]
+  #   time >= 0; time is in seconds
+  # @return [Float]
+  #   return value is in newton seconds
+  # @example
+  #   Joules.impulse_v1(30.8, 9.6) #=> 295.68
+  # @note There is one other method for calculating impulse.
+  def impulse_v1(force, time)
+    return force * time.to_f
+  end
+
+  # Calculates the impulse given initial velocity, final velocity, and mass.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param final_velocity [Int, Float]
+  #   final_velocity is in meters per second
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @return [Float]
+  #   return value is in newton seconds
+  # @example
+  #   Joules.impulse_v2(20, 35, 2.4) #=> 36.0
+  # @note There is one other method for calculating impulse.
+  def impulse_v2(initial_velocity, final_velocity, mass)
+    return (final_velocity - initial_velocity) * mass.to_f
+  end
 
-# Calculates the impulse given initial velocity, final velocity, and mass.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param final_velocity [Int, Float]
-#   final_velocity is in meters per second
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @return [Float]
-#   return value is in newton seconds
-# @example
-#   impulse_v2(20, 35, 2.4) #=> 36.0
-# @note There is one other method for calculating impulse.
-def impulse_v2(initial_velocity, final_velocity, mass)
-  return (final_velocity - initial_velocity) * mass.to_f
 end

data/lib/joules/pressure.rb

@@ -3,35 +3,38 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)
 
-require_relative 'constants'
+module Joules
+  module_function
 
-# Calculates the pressure given force and area.
-# @param force [Int, Float]
-#   force >= 0; force is in newtons
-# @param area [Int, Float]
-#   area > 0; area is in meters cubed
-# @return [Float]
-#   return value >= 0; return value is in pascals
-# @example
-#   pressure(98, 0.04) #=> 2450.0 
-def pressure(force, area)
-  return force / area.to_f
-end
+  # Calculates the pressure given force and area.
+  # @param force [Int, Float]
+  #   force >= 0; force is in newtons
+  # @param area [Int, Float]
+  #   area > 0; area is in meters cubed
+  # @return [Float]
+  #   return value >= 0; return value is in pascals
+  # @example
+  #   Joules.pressure(98, 0.04) #=> 2450.0 
+  def pressure(force, area)
+    return force / area.to_f
+  end
+
+  # Calculates the hydrostatic pressure given density and height.
+  # @param density [Int, Float]
+  #   density >= 0; density is in kilograms per meter cubed
+  # @param height [Int, Float]
+  #   height >= 0; height is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in pascals
+  # @example
+  #   Joules.hydrostatic_pressure(1000, 5) #=> 49050.0
+  def hydrostatic_pressure(density, height)
+    return density * FREE_FALL_ACCELERATION * height
+  end
 
-# Calculates the hydrostatic pressure given density and height.
-# @param density [Int, Float]
-#   density >= 0; density is in kilograms per meter cubed
-# @param height [Int, Float]
-#   height >= 0; height is in meters
-# @return [Float]
-#   return value >= 0; return value is in pascals
-# @example
-#   hydrostatic_pressure(1000, 5) #=> 49050.0
-def hydrostatic_pressure(density, height)
-  return density * FREE_FALL_ACCELERATION * height
 end

data/lib/joules/quantum.rb

@@ -3,54 +3,57 @@
 #
 # @description: Module for providing quantum formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Quantum module (quantum.rb)
 
-require_relative 'constants'
+module Joules
+  module_function
 
-# Calculates the photon energy given frequency.
-# @param frequency [Int, Float]
-#   frequency > 0; frequency is in hertz
-# @return [Float]
-#   return value > 0; return value is in joules
-# @example
-#   photon_energy(509337860780984.75) #=> 3.376910016977929e-19
-def photon_energy(frequency)
-  return PLANCK_CONSTANT * frequency
-end
+  # Calculates the photon energy given frequency.
+  # @param frequency [Int, Float]
+  #   frequency > 0; frequency is in hertz
+  # @return [Float]
+  #   return value > 0; return value is in joules
+  # @example
+  #   Joules.photon_energy(509337860780984.75) #=> 3.376910016977929e-19
+  def photon_energy(frequency)
+    return PLANCK_CONSTANT * frequency
+  end
 
-# Calculates the energy given mass.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @return [Float]
-#   return value >= 0; return value is in joules
-# @example
-#   energy_v4(60.5) #=> 5.445e+18
-# @note There are three other methods for calculating energy.
-def energy_v4(mass)
-  return mass * (SPEED_OF_LIGHT ** 2)
-end
+  # Calculates the energy given mass.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @return [Float]
+  #   return value >= 0; return value is in joules
+  # @example
+  #   Joules.energy_v4(60.5) #=> 5.445e+18
+  # @note There are three other methods for calculating energy.
+  def energy_v4(mass)
+    return mass * (SPEED_OF_LIGHT ** 2)
+  end
 
-# Calculates the half-life of a decaying quantity given decay constant.
-# @param decay_constant [Int, Float]
-#   decay_constant != 0; decay_constant is in per second
-# @return [Float]
-#   return value is in seconds
-# @example
-#   half_life(7.7e4) #=> 9.001911435843445e-06
-def half_life(decay_constant)
-  return Math.log(2) / decay_constant
-end
+  # Calculates the half-life of a decaying quantity given decay constant.
+  # @param decay_constant [Int, Float]
+  #   decay_constant != 0; decay_constant is in per second
+  # @return [Float]
+  #   return value is in seconds
+  # @example
+  #   Joules.half_life(7.7e4) #=> 9.001911435843445e-06
+  def half_life(decay_constant)
+    return Math.log(2) / decay_constant
+  end
+
+  # Calculates the decay constant of a decaying quantity given half-life.
+  # @param half_life [Int, Float]
+  #   half_life != 0; half_life is in seconds
+  # @return [Float]
+  #   return value is in per second
+  # @example
+  #   Joules.decay_constant(9) #=> 0.0770163533955495
+  def decay_constant(half_life)
+    return Math.log(2) / half_life
+  end
 
-# Calculates the decay constant of a decaying quantity given half-life.
-# @param half_life [Int, Float]
-#   half_life != 0; half_life is in seconds
-# @return [Float]
-#   return value is in per second
-# @example
-#   decay_constant(9) #=> 0.0770163533955495
-def decay_constant(half_life)
-  return Math.log(2) / half_life
 end

data/lib/joules/thermodynamics.rb

@@ -3,37 +3,42 @@
 #
 # @description: Module for providing thermodynamics formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Thermodynamics module (thermodynamics.rb)
 
-# Calculates the energy given mass, specific heat capacity, and temperature change.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param specific_heat_capacity [Int, Float]
-#   specific_heat_capacity >= 0; specific_heat_capacity is in joules per kilogram celcius
-# @param temperature_change [Int, Float]
-#   temperature_change is in celcius
-# @return [Float]
-#   return value is in joules
-# @example
-#   energy_v1(500, 2.46, 3.6) #=> 4428.0
-# @note There are two other methods for calculating energy.
-def energy_v1(mass, specific_heat_capacity, temperature_change)
-  return mass * specific_heat_capacity * temperature_change.to_f
-end
+module Joules
+  module_function
+
+  # Calculates the energy given mass, specific heat capacity, and temperature change.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param specific_heat_capacity [Int, Float]
+  #   specific_heat_capacity >= 0; specific_heat_capacity is in joules per kilogram celcius
+  # @param temperature_change [Int, Float]
+  #   temperature_change is in celcius
+  # @return [Float]
+  #   return value is in joules
+  # @example
+  #   Joules.energy_v1(500, 2.46, 3.6) #=> 4428.0
+  # @note There are two other methods for calculating energy.
+  def energy_v1(mass, specific_heat_capacity, temperature_change)
+    return mass * specific_heat_capacity * temperature_change.to_f
+  end
+
+  # Calculates the energy given mass and specific latent heat.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param specific_latent_heat [Int, Float]
+  #   specific_latent_heat >= 0; specific_latent_heat is in joules per kilogram
+  # @return [Float]
+  #   return value is in joules
+  # @example
+  #   Joules.energy_v2(84.3, 72.1) #=> 6078.03
+  # @note There are two other methods for calculating energy.
+  def energy_v2(mass, specific_latent_heat)
+    return mass * specific_latent_heat.to_f
+  end
 
-# Calculates the energy given mass and specific latent heat.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param specific_latent_heat [Int, Float]
-#   specific_latent_heat >= 0; specific_latent_heat is in joules per kilogram
-# @return [Float]
-#   return value is in joules
-# @example
-#   energy_v2(84.3, 72.1) #=> 6078.03
-# @note There are two other methods for calculating energy.
-def energy_v2(mass, specific_latent_heat)
-  return mass * specific_latent_heat.to_f
 end