combo_data 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 666509fb955a1c397e5c4edc70374e5533a79339
-  data.tar.gz: efe126f84a931246077df6da5349297f91542284
+  metadata.gz: 64a45ca20b228dedaaf1cdbd7261d1ff9909654e
+  data.tar.gz: 19dbece0dc1e4189ca6262a2120beeecdf2479c3
 SHA512:
-  metadata.gz: c25c1f498f8ee1a988b5608628c1c5f1e769435a53fa1390eea7e3c7a5b4b59e4e3d9d5fcfbe6510a074c2a602c25ca7d6b50f8f63f807f24c85c8f5b1181bce
-  data.tar.gz: d4d0dcfffd66a9747937262b3b6d0d1e36b5ce3eb539bd68143b9a929edfff47f2a93fc0ef264a13e20ff73e5760c66e9c3e3215f437943cfc82bfc81fd5a371
+  metadata.gz: bb4683a0a6a121b8511aa0e6f605daa8ee15e3faeeb7b0fe26345c83a698d6802a3d4c7cdb5db2a83617c896a41b114d37c2d0c79478f5e762c94ef457882c9c
+  data.tar.gz: ff860f86d3c91bacc438071bdcc94764e77e6cab8f155fef2bcecc65fa4d229b9cb7d4aebdfc41ee0a8e2ffea412f8d71628a8fbad5a57dc9ee6cd8f2a65dab4

data/README.md

@@ -1,6 +1,8 @@
 # ComboData
 
-TODO: Write a gem description
+Analyze a data set for combinations adding to a given value.
+
+Analyze a data set for pairs with a difference of a given value.
 
 ## Installation
 
@@ -17,8 +19,37 @@ Or install it yourself as:
     $ gem install combo_data
 
 ## Usage
+    
+Create a ComboData::DataSet object with an array of values:
+
+    data_set = ComboData::DataSet.new((1..1000).to_a)
+    
+Analyze the data set for combinations adding to a given value.
+
+    data_set.combinations_summing_to 20
+    => {[1, 19]=>20, [2, 18]=>20, [3, 17]=>20, [4, 16]=>20, [5, 15]=>20, [6, 14]=>20, [7, 13]=>20, [8, 12]=>20, [9, 11]=>20, [20]=>20}
+    
+Change the max combination length:
+
+    data_set.max_combination_length = 3 # defaults to 2
+    => 3
+    hate.combinations_summing_to 20
+    => {[1, 2, 17]=>20, [1, 3, 16]=>20, [1, 4, 15]=>20, [1, 5, 14]=>20, [1, 6, 13]=>20, [1, 7, 12]=>20, [1, 8, 11]=>20, [1, 9, 10]=>20, [2, 3, 15]=>20, [2, 4, 14]=>20, [2, 5, 13]=>20, [2, 6, 12]=>20, [2, 7, 11]=>20, [2, 8, 10]=>20, [3, 4, 13]=>20, [3, 5, 12]=>20, [3, 6, 11]=>20, [3, 7, 10]=>20, [3, 8, 9]=>20, [4, 5, 11]=>20, [4, 6, 10]=>20, [4, 7, 9]=>20, [5, 6, 9]=>20, [5, 7, 8]=>20, [1, 19]=>20, [2, 18]=>20, [3, 17]=>20, [4, 16]=>20, [5, 15]=>20, [6, 14]=>20, [7, 13]=>20, [8, 12]=>20, [9, 11]=>20, [20]=>20}
+
+Analyze the data set for pairs with a difference of a given value.
+
+    data_set.pairs_with_a_difference_of 997
+     => {[1, 998]=>997, [2, 999]=>997, [3, 1000]=>997} 
+
+Change the timeout for processing:
+
+    data_set.timeout = 120 # seconds, defaults to 60
+    => 120
+
+Change the precision while making comparisons:
 
-TODO: Write usage instructions here
+    data_set.precision = 3 # decimal places
+    => 3
 
 ## Contributing
 

data/combo_data.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ksmith@wspackaging.com"]
   spec.description   = %q{Perform analysis of data sets.}
   spec.summary       = %q{Data Analysis}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/K-Y-L-E/combo_data"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/combo_data/version.rb

@@ -1,3 +1,3 @@
 module ComboData
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: combo_data
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kyle Smith
@@ -54,7 +54,7 @@ files:
 - lib/combo_data.rb
 - lib/combo_data/combo_data.rb
 - lib/combo_data/version.rb
-homepage: ''
+homepage: https://github.com/K-Y-L-E/combo_data
 licenses:
 - MIT
 metadata: {}