Update erasure documentation

This commit is contained in:
Harshavardhana
2015-02-23 13:39:16 -08:00
parent 3b3e446102
commit f4b5519451
3 changed files with 32 additions and 8 deletions

View File

@@ -56,9 +56,9 @@ type Encoder struct {
// ParseEncoderParams creates an EncoderParams object.
//
// k and n represent the matrix size, which corresponds to the protection level.
//
// k and m represent the matrix size, which corresponds to the protection level
// technique is the matrix type. Valid inputs are CAUCHY (recommended) or VANDERMONDE.
//
func ParseEncoderParams(k, m, technique int) (*EncoderParams, error) {
if k < 1 {
return nil, errors.New("k cannot be zero")
@@ -88,7 +88,7 @@ func ParseEncoderParams(k, m, technique int) (*EncoderParams, error) {
}, nil
}
// NewEncoder creates an encoder with a given set of parameters.
// NewEncoder creates an encoder object with a given set of parameters.
func NewEncoder(ep *EncoderParams) *Encoder {
var k = C.int(ep.K)
var m = C.int(ep.M)