summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Anderson <ejona86@gmail.com>2014-07-03 16:34:22 -0700
committerEric Anderson <ejona86@gmail.com>2014-07-03 16:34:22 -0700
commit459fac21019be383c7892228959fc234d29b2dc3 (patch)
tree19a149498664654bba5afda3c69031e95c30158c
parentb6760656190618d5e0f82ff3555b081afb24450d (diff)
downloadcapset-459fac21019be383c7892228959fc234d29b2dc3.tar.gz
capset-459fac21019be383c7892228959fc234d29b2dc3.zip
Add docs for Capset
-rw-r--r--capset.go10
1 files changed, 7 insertions, 3 deletions
diff --git a/capset.go b/capset.go
index a7e6171..421f7f1 100644
--- a/capset.go
+++ b/capset.go
@@ -182,10 +182,14 @@ func (d *Deck) FindCard(cardStr string) (card Card, ok bool) {
}
type Capset struct {
- d *Deck
+ // d is the search space to find capsets.
+ d *Deck
+ // tableau is the current attempt to find a capset.
tableau []Card
- maxim int
- hasSet bool
+ // maxim is the minimum size for found capsets.
+ maxim int
+ // hasSet is true if the current tableau contains at least one set.
+ hasSet bool
}
// NewCapset makes an initialized Capset for the provided deck. If maxim is -1,