continuance 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b2ff83fc36a7f79a356a419b11a1cdfb3fdeb62
-  data.tar.gz: 851972478e16c62e9a33e41cdb11c4750394df50
+  metadata.gz: 0f85dde2c72f37d014fbdbf60a9d865f2d5c4145
+  data.tar.gz: 5eb50ea0f31770157c7f869c1cec32f25c91c544
 SHA512:
-  metadata.gz: 9ed917c455c20968392edc32465c8a53403cb513c43f38476c2095467d701381d670ca71a0ced2b2277251b4b86602b3ce6b74deb13ac5cfae2993eb89551f8c
-  data.tar.gz: 041c3ce7a2242e60e226ee3362526a353e494c71c20c5754b40549d483a42b35df5110a61b2f80675118a09d12e5b8ffeb22b815e90dff14a0eec81f575b1968
+  metadata.gz: 63585a59e6d9dbbfd7d71e174ef2ab0d6cebc1019f7b1deb52217004eda3050a319496fef6ed0bde801e8189dec3400b7e8ae93fb3fdc2ad32bfd891227de88e
+  data.tar.gz: 6cddbdec9d506974f3d12b9703b3046dd6943bfebe9a719b619206efaa3893812cbfdedb3672306dbd2fde67eff627a189a58d80fea0558c9e54ec9c1525b73b

data/README.md

@@ -56,6 +56,8 @@ Continuance::Duration.new(1, 0, 5, 0) + Continuance::Duration.new(0, 0, 6, 32)
 
 ## Collection Operations
 
+### Total & average
+
 At present Continuance provides `total` and `average` aggregate operations on a collection of duration objects. The Ruby code below demonstrates how to use these collection operations.
 
  ```ruby
@@ -66,6 +68,14 @@ average = durations.average
 total = durations.total
 ```
 
-The average method returns a Duration object, where as total returns the total number of seconds as a floating point value, this could change in the future. The order of complexity of both operations is `O(n)`.
+The average method returns a Duration object, where as total returns the total number of seconds as a floating point value, this could change in the future. The order of complexity of both operations is `O(n)`. In mathematics average is also referred to as the arithmetic mean and median. The average is aliased as arithmetic mean and median.
+
+### Min & Max
+
+The library also supports retrieving the minimum and maximum value for a collection of durations. Like the total and average operations, the order of complexity of the min and max operation is `O(n)`.
+
+### Variance & Standard Deviation
+
+The library also supports retrieving the variance and standard deviation for a collection of durations.
 
 Report bugs on GitHub.

data/lib/continuance/durations.rb

@@ -18,6 +18,11 @@ module Continuance
       Duration.create(time, '%H:%M:%S:%L')
     end
 
+    # In mathematics average is also known by the terms median and
+    # arithmetic mean
+    alias_method :arithmetic_mean, :average
+    alias_method :median, :average
+
     # Provides a sum of all the durations
     def total
       items.inject(0.0) do |sum, duration|
@@ -25,6 +30,33 @@ module Continuance
       end
     end
 
+    # Tells us what the smallest duration is of the given ones
+    def min
+      items.map(&:to_f).min
+    end
+
+    # Tells us what the largest duration is of the given ones
+    def max
+      items.map(&:to_f).max
+    end
+
+    # TODO: Add a variance and standard deviation methods to this class
+    def variance
+      if items.empty?
+        0
+      else
+        mean = average # Cache the average for future use
+        diffs = items.map { |duration| duration.to_f - mean.to_f }
+        diff_squares = diffs.map { |diff| diff**2 }
+        diff_squares.inject(:+) / items.size
+      end
+    end
+
+    # The standard deviation is simply the square root of the variance
+    def standard_deviation
+      Math.sqrt(variance)
+    end
+
     private
 
     # Calculates the average of the time as a float

data/lib/continuance/version.rb

@@ -1,4 +1,4 @@
 # Major.Minor.Patch version numbering
 module Continuance
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/continuance/durations_spec.rb

@@ -15,6 +15,22 @@ module Continuance
       it 'should be able to calculate an average' do
         expect(durations.average).to eq(Duration.new)
       end
+
+      it 'should be able to extract the minimum' do
+        expect(durations.min).to be_nil
+      end
+
+      it 'should be able to extract the maximum' do
+        expect(durations.max).to be_nil
+      end
+
+      it 'should be able to calculate the variance' do
+        expect(durations.variance).to eq(0.0)
+      end
+
+      it 'should be able to calculate the standard deviation' do
+        expect(durations.standard_deviation).to eq(0.0)
+      end
     end
 
     context 'with a single duration' do
@@ -28,6 +44,14 @@ module Continuance
       it 'should be able to calculate an average' do
         expect(durations.average).to eq(Duration.new(1, 1, 1, 0))
       end
+
+      it 'should be able to extract the minimum' do
+        expect(durations.min).to eq(Duration.new(1, 1, 1, 0))
+      end
+
+      it 'should be able to extract the maximum' do
+        expect(durations.max).to eq(Duration.new(1, 1, 1, 0))
+      end
     end
 
     context 'with multiple durations' do
@@ -35,7 +59,7 @@ module Continuance
       let(:duration2)  { Duration.new(0, 1, 0, 0) }
       let(:duration3)  { Duration.new(0, 0, 1, 0) }
       let(:duration4)  { Duration.new(0, 0, 0, 1_000_000) }
-      let(:durations) { Durations.new([duration1, duration2, duration3, duration4]) }
+      let(:durations)  { Durations.new([duration1, duration2, duration3, duration4]) }
 
       it 'should be able to calculate the total' do
         expect(durations.total).to eq(3661.001)
@@ -44,6 +68,40 @@ module Continuance
       it 'should be able to calculate an average' do
         expect(durations.average).to eq(Duration.new(0, 15, 15, 250_250_000))
       end
+
+      it 'should be able to extract the minimum' do
+        expect(durations.min).to eq(Duration.new(0, 0, 0, 1_000_000))
+      end
+
+      it 'should be able to extract the maximum' do
+        expect(durations.max).to eq(Duration.new(1, 0, 0, 0))
+      end
+
+      it 'should alias arithmetic mean to average' do
+        expect(durations.arithmetic_mean).to eq(durations.average)
+      end
+
+      it 'should alias median to average' do
+        expect(durations.median).to eq(durations.average)
+      end
+    end
+
+    context 'like the six side of a dice' do
+      let(:side1)  { Duration.new(0, 0, 1, 0) }
+      let(:side2)  { Duration.new(0, 0, 2, 0) }
+      let(:side3)  { Duration.new(0, 0, 3, 0) }
+      let(:side4)  { Duration.new(0, 0, 4, 0) }
+      let(:side5)  { Duration.new(0, 0, 5, 0) }
+      let(:side6)  { Duration.new(0, 0, 6, 0) }
+      let(:sides)  { Durations.new([side1, side2, side3, side4, side5, side6]) }
+
+      it 'should be able to calculate the variance' do
+        expect(sides.variance).to eq(2.9166666666666665)
+      end
+
+      it 'should be able to calculate the standard deviation' do
+        expect(sides.standard_deviation).to eq(1.707825127659933)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: continuance
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shirren Premaratne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Continuance is a library for handling durations as opposed to time. A
   duration represents a finite period of time meaurable in hours, minutes, seconds
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Continuance is a library for handling durations as opposed to time.