ofcp_card_counter 0.0.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a1251c53679102578debc70663578bd58e4e506
-  data.tar.gz: c992980f629937f1e24af3f7e72b22d4cf5bd82f
+  metadata.gz: 4a7db1c369a3f53e929f1dd91dec95f997937138
+  data.tar.gz: e119cf48733a3852042c82bd0c26b3c3b89c74fb
 SHA512:
-  metadata.gz: 184da69c8026dd5c220b407a324626ba4108d9376fdc199ea1e6030c0a43e0eb39f2db89d8e0c0c699cf3c19afc5c6434b5132c9c0a0e5d4bf393b40c4788353
-  data.tar.gz: 8a22059b16454160f78b11665d0ea792c6fc85bf9649426b7e2f14d4c7aa45a18c265781ba476a7e9d2e12618f43ca331088774b7eca0fbd2eb052e8c756c36b
+  metadata.gz: c5ed956225a1d03adc79297006eee98e61b2461a54661bf7734d85e0877bb402c37e5ee1b74374370228c1c46d3361d20935b243b5942a5d57b075878f0d1e65
+  data.tar.gz: 8613ec66e3cfb074d44b82f133ac60edb713be4bcaddd1481169321f1b2b7c3b8e69ff9ca9cccf1873b687bc3f1306965d1437030c2bee6f799d7a8ef7236df8

data/Gemfile

@@ -5,3 +5,4 @@ gem "rspec"
 gem 'autotest-doom'
 gem 'autotest-growl'
 gem 'ZenTest'
+gem 'yard'

data/Gemfile.lock

@@ -17,6 +17,7 @@ GEM
     rspec-mocks (2.14.3)
     test_notifier (0.4.0)
       notifier
+    yard (0.8.7)
 
 PLATFORMS
   ruby
@@ -26,3 +27,4 @@ DEPENDENCIES
   autotest-doom
   autotest-growl
   rspec
+  yard

data/lib/ofcp_card_counter/card_counter.rb

@@ -1,9 +1,26 @@
 class OfcpCardCounter::CardCounter
+  # Creates a new instance of CardCounter
+  #
+  # @param [Hash] options :turns_left:
+  # @option options [Number] :turns_left the number of cards yet to be dealt to the player
+  # @option options [Array<String>]  :cards a collection containing the cards that are already known
+  # @return [CardCounter] a fresh new instance of CardCounter
   def initialize(options={})
     @turns_left = options[:turns_left]
     @cards      = options[:cards]
   end
 
+  # Calculate the dependent probability of receiving a specific quantity of
+  # of cards from a pool of desired options
+  #
+  # @param [Number] number the number of cards from the desired array that you need
+  # @param [Hash] options
+  # @option options [Array<String>] :of the pool of cards you desire
+  # @return [Float] dependent probability as a scalar between 0 and 1
+  # @example probability of getting 2 of the 3 remaining 4's
+  #   @card_counter = OfcpCardCounter::CardCounter.new(:turns_left => 2, :cards => %w{4S 3H 3D})
+  #   @card_counter.probability_of_getting(2, :of => %w{4H 4D 4C}) #=> 0.002551020408163265
+
   def probability_of_getting(number, options={})
     return 1.0 if number <= 0 || options[:of].nil?
 

data/lib/ofcp_card_counter/version.rb

@@ -1,3 +1,3 @@
 module OfcpCardCounter
-  VERSION = '0.0.1'
+  VERSION = '0.9.0'
 end

data/ofcp_card_counter.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ofcp_card_counter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Roy van de Water
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Open Face Chinese Poker Statistics
 email:
 - me@royvandewater.com
@@ -102,3 +116,4 @@ summary: Statistics calculations for Open Face Chinese Poker hands
 test_files:
 - spec/card_counter_spec.rb
 - spec/spec_helper.rb
+has_rdoc: