joules 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe0112745ba13a5455d979a35367768cdaa2f382
-  data.tar.gz: eca09701308ea046cf92d8a6b2777af12d4011b0
+  metadata.gz: b7a405f59eae561b636acb954b03228a898fe036
+  data.tar.gz: fbc765fa0f3a42672c49068e9db10ab840899f04
 SHA512:
-  metadata.gz: bc5a94a2b8b9c9674d971c556335fb1ab4ccd116f2e95fe29c56f501d6b7daf89c7157a5cb1d38406d24c5cd71c1a359e9da3cdb6ec006283d99d73b6312520a
-  data.tar.gz: dea84c2a922ef20939c23216253bdaf0370e4b693609fb838f12c7f4260adc7517a594772134c74fcd9a66fb59d1abe916d6d00bea06c56d16964e83a843d32b
+  metadata.gz: f3301f33a9aab8819c5e5d86c53840ae9304e723f45da88c1c0f5921543bd3168baacb80b6c6b6aa2c5d377eb956a2df3f58a1e50626a194fafa74623098ac77
+  data.tar.gz: 1bea761dbed0cffff0e120e67131dcd2d37b44f06020ef539683e70f8033fcb433df670126a01baba0ad252707baae1e3301a2f7a342939055484f20e869fd90

data/README.md

@@ -0,0 +1,67 @@
+![Joules Logo](https://cloud.githubusercontent.com/assets/7763904/7764836/ef617b0a-0024-11e5-8044-3cf354a4a306.png)
+
+[![forthebadge](http://forthebadge.com/images/badges/built-with-ruby.svg)](http://forthebadge.com)
+
+[![Gem Version](https://badge.fury.io/rb/joules.svg)](http://badge.fury.io/rb/joules)
+
+### About
+Joules is a library (gem) for providing simple Physics formulas in kinematics, forces, waves, electricity, and so much more. A selection of fundamental constants are also provided. It is written entirely in Ruby.
+> Note: For library download, please visit [https://www.rubygems.org/gems/joules](https://www.rubygems.org/gems/joules).
+
+### Library Compilation
+```Bash
+gem build joules.gemspec
+```
+
+### Library Installation
+```Bash
+gem install joules-0.3.0.gem
+```
+
+### Library Import
+```Ruby
+require 'joules'
+```
+
+### Usage
+#### Simple Method Call
+```Ruby
+gravitational_potential_energy(0.5, 6)
+```
+This would return 29.43.
+#### Method Composition
+```Ruby
+power(work_done(40, 2.34), 4)
+```
+This would return 23.4.
+> Note: For documentation on methods and constants, please visit [http://www.rubydoc.info/gems/joules/](http://www.rubydoc.info/gems/joules/).
+
+### Change Log
+#### Version 0.0.1
+* Added Physics formulas in kinematics, mass, weight, density, forces, momentum, impulse, energy, work, power, and pressure
+* Added the following Physics constants: speed of light in free space and acceleration of free fall
+
+#### Version 0.0.2
+* Fixed publishing date in gem specification
+
+#### Version 0.0.3
+* Added the following Physics constants: permeability of free space, permittivity of free space, elementary charge, Planck constant, unified atomic mass unit, rest mass of electron, rest mass of proton, molar gas constant, avogadro constant, Boltzmann constant, and gravitational constant
+
+#### Version 0.1.0
+* Added Physics formulas in waves and thermodynamics
+* Added the following Physics constants: rest mass of neutron, Stefan constant, and Wien constant
+* Updated existing documentation style to YARD documentation style
+
+#### Version 0.2.0
+* Added Physics formulas in electricity
+* Added geometric and conversion formulas commonly used in Physics
+
+#### Version 0.3.0
+* Added Physics formulas in quantum
+* Added more geometric and conversion formulas commonly used in Physics
+
+### Contribution
+Please feel free to submit any ideas, questions, or problems by reporting an issue. 
+
+### License
+* Joules is licensed under the [MIT license](https://github.com/elailai94/Joules/blob/master/LICENSE.md).

data/lib/joules/constants.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Constants module (constants.rb)

data/lib/joules/conversion.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing conversion formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Conversion module (conversion.rb)

data/lib/joules/density.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing density formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Density module (density.rb)

data/lib/joules/electricity.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing electricity formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Electricity module (electricity.rb)
@@ -91,10 +91,54 @@ end
 #   voltage != 0; voltage is in volts
 # @return [Float]
 #   return value is in farads
+# @example
+#   capacitance(2e-3, 100) #=> 2.0e-05
 def capacitance(charge, voltage)
   return charge / voltage.to_f
 end
 
+# Calculates the capacitor potential energy given charge and voltage.
+# @param charge [Int, Float]
+#   charge is in coulombs
+# @param voltage [Int, Float]
+#   voltage is in volts
+# @return [Float]
+#   return value is in joules
+# @example
+#   capacitor_potential_energy_v1(1.5, 30) #=> 22.5
+# @note There are two other methods for calculating capacitor potential energy.
+def capacitor_potential_energy_v1(charge, voltage)
+  return 0.5 * charge * voltage
+end
+
+# Calculates the capacitor potential energy given capacitance and voltage.
+# @param capacitance [Int, Float]
+#   capacitance is in farads
+# @param voltage [Int, Float]
+#   voltage is in volts
+# @return [Float]
+#   return value is in joules
+# @example
+#   capacitor_potential_energy_v2(10e-6, 20) #=> 0.002
+# @note There are two other methods for calculating capacitor potential energy.
+def capacitor_potential_energy_v2(capacitance, voltage)
+  return 0.5 * capacitance * (voltage ** 2)
+end
+
+# Calculates the capacitor potential energy given charge and capacitance.
+# @param charge [Int, Float]
+#   charge is in coulombs
+# @param capacitance [Int, Float]
+#   capacitance is in farads
+# @return [Float]
+#   return value is in joules
+# @example
+#   capacitor_potential_energy_v3(25, 50) #=> 6.25
+# @note There are two other methods for calculating capacitor potential energy.
+def capacitor_potential_energy_v3(charge, capacitance)
+  return (0.5 * (charge ** 2)) / capacitance
+end
+
 # Calculates the total capacitance of capacitors in series.
 # @param capacitances [Array<Int, Float>]
 #   each capacitance in resistances != 0; each capacitance in capacitances is in farads
@@ -164,9 +208,9 @@ end
 # @return [Float]
 #   return value is in watts
 # @example
-#   power_v2(1.8, 0.6) #=> 1.08
-# @note There are three other methods for calculating power.
-def power_v2(voltage, current)
+#   power_v3(1.8, 0.6) #=> 1.08
+# @note There are four other methods for calculating power.
+def power_v3(voltage, current)
   return voltage * current.to_f
 end
 
@@ -178,9 +222,9 @@ end
 # @return [Float]
 #   return value is in watts
 # @example
-#   power_v3(0.6, 3) #=> 1.08
-# @note There are three other methods for calculating power.
-def power_v3(current, resistance)
+#   power_v4(0.6, 3) #=> 1.08
+# @note There are four other methods for calculating power.
+def power_v4(current, resistance)
   return (current ** 2.0) * resistance
 end
 
@@ -192,9 +236,9 @@ end
 # @return [Float]
 #   return value is in watts
 # @example
-#   power_v4(1.8, 3) #=> 1.08
-# @note There are three other methods for calculating power.
-def power_v4(voltage, resistance)
+#   power_v5(1.8, 3) #=> 1.08
+# @note There are four other methods for calculating power.
+def power_v5(voltage, resistance)
   return (voltage ** 2.0) / resistance
 end
 

data/lib/joules/energy_work_power.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing energy, work, and power formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
@@ -49,17 +49,17 @@ def kinetic_energy(mass, velocity)
   return 0.5 * mass * (velocity ** 2)
 end
 
-# Calculates the work done given force and distance.
+# Calculates the work done given force and displacement.
 # @param force [Int, Float]
 #   force is in newtons
-# @param distance [Int, Float]
-#   distance >= 0; distance is in meters
+# @param displacement [Int, Float]
+#   displacement is in meters
 # @return [Float]
 #   return value is in joules
 # @example
 #   work_done(40, 2.34) #=> 93.6
-def work_done(force, distance)
-  return force * distance.to_f
+def work_done(force, displacement)
+  return force * displacement.to_f
 end
 
 # Calculates the power given work done and time.
@@ -71,11 +71,25 @@ end
 #   return value is in watts
 # @example
 #   power_v1(28, 7) #=> 4.0
-# @note There are three other methods for calculating power.
+# @note There are four other methods for calculating power.
 def power_v1(work_done, time)
   return work_done / time.to_f
 end
 
+# Calculates the power given force and velocity.
+# @param force [Int, Float]
+#   force is in newtons
+# @param velocity [Int, Float]
+#   velocity is in meters per second
+# @return [Float]
+#   return value is in watts
+# @example
+#   power_v2(42, 2.3) #=> 96.6
+# @note There are four other methods for calculating power.
+def power_v2(force, velocity)
+  return force * velocity.to_f
+end
+
 # Calculates the energy efficiency given useful energy output and energy input.
 # @param useful_energy_output [Int, Float]
 #   0 <= useful_energy_output <= energy_input; useful_energy_output is in joules

data/lib/joules/forces.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Forces module (forces.rb)

data/lib/joules/geometry.rb

@@ -3,11 +3,24 @@
 #
 # @description: Module for providing geometry formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Geometry module (geometry.rb)
 
+# Calculates the area of a rectangle given length and width.
+# @param length [Int, Float]
+#   length >= 0; length is in a unit of length
+# @param width [Int, Float]
+#   width >= 0; width has the same units as length
+# @return [Float]
+#   return value >= 0; return value has the same units as length
+# @example
+#   rectangle_area(2, 3.4) #=> 6.8
+def rectangle_area(length, width)
+  return length * width.to_f
+end
+
 # Calculates the arc length of a circle given radius and central angle.
 # @param radius [Int, Float]
 #   radius >= 0; radius is in a unit of length
@@ -49,9 +62,9 @@ end
 # @return [Float]
 #   return value >= 0; return value has the same units as radius
 # @example
-#   sphere_surface_area(12) #=> 1809.55736846772
+#   sphere_surface_area(12) #=> 1809.5573684677208
 def sphere_surface_area(radius)
-  return 4 * Math::PI * (radius ** 2)
+  return 4 * circle_area(radius)
 end
 
 # Calculates the volume of a sphere given radius.
@@ -60,9 +73,35 @@ end
 # @return [Float]
 #   return value >= 0; return value has the same units as radius
 # @example
-#   sphere_volume(12) #=> 7238.22947387088
+#   sphere_volume(12) #=> 7238.229473870883
 def sphere_volume(radius)
-  return (4 * Math::PI * (radius ** 3)) / 3
+  return (4 * circle_area(radius) * radius) / 3
+end
+
+# Calculates the surface area of a cone given radius and slant height.
+# @param radius [Int, Float]
+#   radius >= 0; radius is in a unit of length
+# @param slant_height [Int, Float]
+#   slant_height >= 0; slant_height has the same units as radius
+# @return [Float]
+#   return value >= 0; return value has the same units as radius
+# @example
+#   cone_surface_area(3, 5.83) #=> 83.22078939359362
+def cone_surface_area(radius, slant_height)
+  return circle_area(radius) + (Math::PI * radius * slant_height)
+end
+
+# Calculates the volume of a cone given radius and height.
+# @param radius [Int, Float]
+#   radius >= 0; radius is in a unit of length
+# @param height [Int, Float]
+#   height >= 0; height has the same units as radius
+# @return [Float]
+#   return value >= 0; return value has the same units as radius
+# @example
+#   cone_volume(6.5, 3) #=> 132.73228961416876
+def cone_volume(radius, height)
+  return (circle_area(radius) * height) / 3
 end
 
 # Calulates the surface area of a cylinder given radius and height.

data/lib/joules/kinematics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)

data/lib/joules/mass_weight.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)

data/lib/joules/momentum_impulse.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)

data/lib/joules/pressure.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)

data/lib/joules/quantum.rb

@@ -0,0 +1,56 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing quantum formulas
+# @author: Elisha Lai
+# @version: 0.3.0 29/05/2015
+#==============================================================================
+
+# Quantum module (quantum.rb)
+
+require_relative 'constants'
+
+# 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 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 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 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,7 +3,7 @@
 #
 # @description: Module for providing thermodynamics formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Thermodynamics module (thermodynamics.rb)

data/lib/joules/waves.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing waves formulas
 # @author: Elisha Lai
-# @version: 0.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Waves module (waves.rb)
@@ -97,3 +97,40 @@ end
 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 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 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.2.0 25/05/2015
+# @version: 0.3.0 29/05/2015
 #==============================================================================
 
 # Joules module (joules.rb)
@@ -19,5 +19,6 @@ require 'joules/pressure'
 require 'joules/thermodynamics'
 require 'joules/waves'
 require 'joules/electricity'
+require 'joules/quantum'
 require 'joules/geometry'
 require 'joules/conversion'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-05-29 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,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/joules.rb
 - lib/joules/constants.rb
 - lib/joules/conversion.rb
@@ -30,6 +31,7 @@ files:
 - lib/joules/mass_weight.rb
 - lib/joules/momentum_impulse.rb
 - lib/joules/pressure.rb
+- lib/joules/quantum.rb
 - lib/joules/thermodynamics.rb
 - lib/joules/waves.rb
 homepage: http://elailai94.github.io/Joules