Updated documentation.

compiler/ssa/program.go

@@ -49,7 +49,7 @@ func NewProgram(params *utils.Params, in, out circuit.IO,
 		Outputs:   out,
 		Constants: consts,
 		Steps:     steps,
-		walloc:    NewWAllocValue(),
+		walloc:    NewWAllocString(),
 	}
 
 	// Inputs into wires.
@@ -262,6 +262,7 @@ func (prog *Program) DefineConstants(zero, one *circuits.Wire) error {
 	return nil
 }
 
+// StreamDebug print debugging information about streaming mode.
 func (prog *Program) StreamDebug() {
 	prog.walloc.Debug()
 }

compiler/ssa/wire_allocator.go

@@ -11,6 +11,7 @@ import (
 	"github.com/markkurossi/mpc/types"
 )
 
+// WireAllocator implements dynamic wire allocation.
 type WireAllocator interface {
 	// Allocated tests if the wires have been allocated for the value.
 	Allocated(v Value) bool

compiler/ssa/wire_allocator_string.go

@@ -14,6 +14,8 @@ import (
 	"github.com/markkurossi/mpc/types"
 )
 
+// WAllocString implements WireAllocator using Value.String to map
+// values to wires.
 type WAllocString struct {
 	freeWires  map[types.Size][][]*circuits.Wire
 	wires      map[string]*wireAlloc
@@ -22,6 +24,7 @@ type WAllocString struct {
 	flMiss     int
 }
 
+// NewWAllocString creates a new WAllocString.
 func NewWAllocString() WireAllocator {
 	return &WAllocString{
 		wires:     make(map[string]*wireAlloc),

compiler/ssa/wire_allocator_value.go

@@ -13,6 +13,8 @@ import (
 	"github.com/markkurossi/mpc/types"
 )
 
+// WAllocValue implements WireAllocator using Value.HashCode to map
+// values to wires.
 type WAllocValue struct {
 	freeWires  map[types.Size][][]*circuits.Wire
 	wires      [10240]*allocByValue
@@ -35,6 +37,7 @@ func (alloc *allocByValue) String() string {
 		alloc.base, len(alloc.wires))
 }
 
+// NewWAllocValue creates a new WAllocValue.
 func NewWAllocValue() WireAllocator {
 	return &WAllocValue{
 		freeWires: make(map[types.Size][][]*circuits.Wire),