joules 0.3.0 → 0.3.1

data/lib/joules/waves.rb

@@ -3,134 +3,137 @@
 #
 # @description: Module for providing waves formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Waves module (waves.rb)
 
-require_relative 'conversion'
+module Joules
+  module_function
 
-# Calculates the wave speed given frequency and wavelength.
-# @param frequency [Int, Float]
-#   frequency > 0; frequency is in hertz
-# @param wavelength [Int, Float]
-#   wavelength >= 0; wavelength is in meters
-# @return [Float]
-#   return value >= 0; return value is in meters per second
-# @example
-#    wave_speed(3250, 0.1) #=> 325.0
-def wave_speed(frequency, wavelength)
-  return frequency * wavelength.to_f
-end
+  # Calculates the wave speed given frequency and wavelength.
+  # @param frequency [Int, Float]
+  #   frequency > 0; frequency is in hertz
+  # @param wavelength [Int, Float]
+  #   wavelength >= 0; wavelength is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in meters per second
+  # @example
+  #   Joules.wave_speed(3250, 0.1) #=> 325.0
+  def wave_speed(frequency, wavelength)
+    return frequency * wavelength.to_f
+  end
 
-# Calculates the wavelength given wave speed and frequency.
-# @param wave_speed [Int, Float]
-#   wave_speed >= 0; wave_speed is in meters per second
-# @param frequency [Int, Float]
-#   frequency > 0; frequency is in hertz
-# @return [Float]
-#   return value is in meters
-# @example
-#   wavelength(325, 3250) #=> 0.1
-def wavelength(wave_speed, frequency)
-  return wave_speed / frequency.to_f
-end
+  # Calculates the wavelength given wave speed and frequency.
+  # @param wave_speed [Int, Float]
+  #   wave_speed >= 0; wave_speed is in meters per second
+  # @param frequency [Int, Float]
+  #   frequency > 0; frequency is in hertz
+  # @return [Float]
+  #   return value is in meters
+  # @example
+  #   Joules.wavelength(325, 3250) #=> 0.1
+  def wavelength(wave_speed, frequency)
+    return wave_speed / frequency.to_f
+  end
 
-# Calculates the frequency given wave speed and wavelength.
-# @param wave_speed [Int, Float]
-#   wave_speed >= 0; wave_speed is in meters per second
-# @param wavelength [Int, Float]
-#   wavelength > 0; wavelength is in meters
-# @return [Float]
-#   return value is in hertz
-# @example
-#   frequency_v1(325, 0.1) #=> 3250.0
-# @note There is one other method for calculating frequency.
-def frequency_v1(wave_speed, wavelength)
-  return wave_speed / wavelength.to_f
-end
+  # Calculates the frequency given wave speed and wavelength.
+  # @param wave_speed [Int, Float]
+  #   wave_speed >= 0; wave_speed is in meters per second
+  # @param wavelength [Int, Float]
+  #   wavelength > 0; wavelength is in meters
+  # @return [Float]
+  #   return value is in hertz
+  # @example
+  #   Joules.frequency_v1(325, 0.1) #=> 3250.0
+  # @note There is one other method for calculating frequency.
+  def frequency_v1(wave_speed, wavelength)
+    return wave_speed / wavelength.to_f
+  end
 
-# Calculates the frequency given time period.
-# @param time_period [Int, Float]
-#   time_period > 0; time_period is in seconds
-# @return [Float]
-#   return value > 0; return value is in hertz
-# @example
-#   frequency_v2(12.5) #=> 0.08
-# @note There is one other method for calculating frequency.
-def frequency_v2(time_period)
-  return 1.0 / time_period
-end
+  # Calculates the frequency given time period.
+  # @param time_period [Int, Float]
+  #   time_period > 0; time_period is in seconds
+  # @return [Float]
+  #   return value > 0; return value is in hertz
+  # @example
+  #   Joules.frequency_v2(12.5) #=> 0.08
+  # @note There is one other method for calculating frequency.
+  def frequency_v2(time_period)
+    return 1.0 / time_period
+  end
 
-# Calculates the time period given frequency.
-# @param frequency [Int, Float]
-#   frequency > 0; frequency is in hertz
-# @return [Float]
-#   return value > 0; return value is in hertz
-# @example
-#   time_period(0.08) #=> 12.5
-def time_period(frequency)
-  return 1.0 / frequency
-end
+  # Calculates the time period given frequency.
+  # @param frequency [Int, Float]
+  #   frequency > 0; frequency is in hertz
+  # @return [Float]
+  #   return value > 0; return value is in hertz
+  # @example
+  #   Joules.time_period(0.08) #=> 12.5
+  def time_period(frequency)
+    return 1.0 / frequency
+  end
 
-# Calculates the refractive index of a substance given angle of incidence and angle of refraction.
-# @param angle_of_incidence [Int, Float]
-#   angle_of_incidence is in degrees
-# @param angle_of_refraction [Int, Float]
-#   angle_of_refraction is in degrees
-# @return [Float]
-# @example
-#   refractive_index_v1(50, 35) #=> 1.3355577296591308
-# @note There is one other method for calculating refractive index.
-def refractive_index_v1(angle_of_incidence, angle_of_refraction)
-  return Math.sin(to_radians(angle_of_incidence)) /
-         Math.sin(to_radians(angle_of_refraction))
-end
+  # Calculates the refractive index of a substance given angle of incidence and angle of refraction.
+  # @param angle_of_incidence [Int, Float]
+  #   angle_of_incidence is in degrees
+  # @param angle_of_refraction [Int, Float]
+  #   angle_of_refraction is in degrees
+  # @return [Float]
+  # @example
+  #   Joules.refractive_index_v1(50, 35) #=> 1.3355577296591308
+  # @note There is one other method for calculating refractive index.
+  def refractive_index_v1(angle_of_incidence, angle_of_refraction)
+    return Math.sin(to_radians(angle_of_incidence)) /
+           Math.sin(to_radians(angle_of_refraction))
+  end
 
-# Calculates the refractive index of a substance given critical angle.
-# @param critical_angle [Int, Float]
-#   critical_angle != 0; critical_angle is in degrees
-# @return [Float]
-# @example
-#   refractive_index_v2(48.7535) #=> 1.3299993207924483
-# @note There is one other method for calculating refractive index.
-def refractive_index_v2(critical_angle)
-  return 1.0 / Math.sin(to_radians(critical_angle))
-end
+  # Calculates the refractive index of a substance given critical angle.
+  # @param critical_angle [Int, Float]
+  #   critical_angle != 0; critical_angle is in degrees
+  # @return [Float]
+  # @example
+  #   Joules.refractive_index_v2(48.7535) #=> 1.3299993207924483
+  # @note There is one other method for calculating refractive index.
+  def refractive_index_v2(critical_angle)
+    return 1.0 / Math.sin(to_radians(critical_angle))
+  end
 
-# Calculates the magnification given image_height and object_height.
-# @param image_height [Int, Float]
-#   image_height >= 0; image_height is in a unit of length
-# @param object_height [Int, Float]
-#   object_height > 0; object_height has the same units as image_height
-# @return [Float]
-#   return value >= 0
-# @example
-#   magnification(10, 5) #=> 2.0 
-def magnification(image_height, object_height)
-  return image_height / object_height.to_f
-end
+  # Calculates the magnification given image height and object height.
+  # @param image_height [Int, Float]
+  #   image_height >= 0; image_height is in a unit of length
+  # @param object_height [Int, Float]
+  #   object_height > 0; object_height has the same units as image_height
+  # @return [Float]
+  #   return value >= 0
+  # @example
+  #   Joules.magnification(10, 5) #=> 2.0 
+  def magnification(image_height, object_height)
+    return image_height / object_height.to_f
+  end
 
-# Calculates the focal length of a lens given object distance and image distance.
-# @param object_distance [Int, Float]
-#   object_distance > 0; object_distance is in meters
-# @param image_distance [Int, Float]
-#   image_distance > 0; image_distance is in meters
-# @return [Float]
-#   return value >= 0; return value is in meters
-# @example
-#   focal_length(45.7, 22.8) #=> 15.21109489051095
-def focal_length(object_distance, image_distance)
-  return 1 / ((1.0 / object_distance) + (1.0 / image_distance))
-end
+  # Calculates the focal length of a lens given object distance and image distance.
+  # @param object_distance [Int, Float]
+  #   object_distance > 0; object_distance is in meters
+  # @param image_distance [Int, Float]
+  #   image_distance > 0; image_distance is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in meters
+  # @example
+  #   Joules.focal_length(45.7, 22.8) #=> 15.21109489051095
+  def focal_length(object_distance, image_distance)
+    return 1 / ((1.0 / object_distance) + (1.0 / image_distance))
+  end
+
+  # Calculates the power of a lens given focal length.
+  # @param focal_length [Int, Float]
+  #   focal_length > 0; focal_length is in meters
+  # @return [Float]
+  #   return value > 0; return value is in dioptres
+  # @example
+  #   Joules.power_of_lens(2) #=> 0.5
+  def power_of_lens(focal_length)
+    return 1.0 / focal_length
+  end
 
-# Calculates the power of a lens given focal length.
-# @param focal_length [Int, Float]
-#   focal_length > 0; focal_length is in meters
-# @return [Float]
-#   return value > 0; return value is in dioptres
-# @example
-#   power_of_lens(2) #=> 0.5
-def power_of_lens(focal_length)
-  return 1.0 / focal_length
 end

data/lib/joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Joules module (joules.rb)
@@ -20,5 +20,7 @@ require 'joules/thermodynamics'
 require 'joules/waves'
 require 'joules/electricity'
 require 'joules/quantum'
+require 'joules/gravitational_fields'
+require 'joules/electric_fields'
 require 'joules/geometry'
 require 'joules/conversion'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies: []
 description: "    Joules is a library (gem) for providing simple Physics formulas\n
   \   in kinematics, forces, waves, electricity, and so much more. A\n    selection
@@ -18,15 +18,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
 - lib/joules.rb
 - lib/joules/constants.rb
 - lib/joules/conversion.rb
 - lib/joules/density.rb
+- lib/joules/electric_fields.rb
 - lib/joules/electricity.rb
 - lib/joules/energy_work_power.rb
 - lib/joules/forces.rb
 - lib/joules/geometry.rb
+- lib/joules/gravitational_fields.rb
 - lib/joules/kinematics.rb
 - lib/joules/mass_weight.rb
 - lib/joules/momentum_impulse.rb