pangrammic_surplus 0.0.1 → 1.0.0

data/README.md

@@ -44,6 +44,21 @@ And therefore, the following is a true self-enumerating pangram:
 
 "This pangram lists four a's, one b, one c, two d's, twenty-nine e's, eight f's, three g's, five h's, eleven i's, one j, one k, three l's, two m's, twenty-two n's, fifteen o's, two p's, one q, seven r's, twenty-six s's, nineteen t's, four u's, five v's, nine w's, two x's, four y's, and one z."
 
+## Satisfiability
+
+Self-enumerating pangrams can only be constructed from surpluses of positive integers because we can't remove characters from the minimal sentence structures:
+
+A pangram can not be created from on**e** **e**, because two have been used for that term alone. The surplus would infact be -1 before you even consider other terms.
+
+In cases where there are no satisfiable pangrams for a given input, ```PangrammicSurplus.for``` returns nil, unless you pass true in for its second argument:
+
+```ruby
+PangrammicSurplus.for({ 'e' => 1 }, allow_negatives = true)
+#=> { 'e' => -1 }
+```
+
+This may be useful if you're writing an algorithm that checks just how unsatisfiable the given attempt was.
+
 ## Contribution
 
 Feel free to contribute. No commit is too small.

data/lib/pangrammic_surplus/base.rb

@@ -1,8 +1,16 @@
 class PangrammicSurplus
   class << self
 
-    def for(input)
-      Vector.subtract(input, MinimalCount.for(input))
+    def for(input, allow_negatives = false)
+      minimal = MinimalCount.for(input)
+      surplus = Vector.subtract(input, minimal)
+
+      (allow_negatives || satisfiable?(surplus)) ? surplus : nil
+    end
+
+    private
+    def satisfiable?(surplus)
+      surplus.all? { |_, v| v >= 0 }
     end
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pangrammic_surplus
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Christopher Patuzzo