Skip to content

Commit

Permalink
mat: Clean up TriBand documentation (#710)
Browse files Browse the repository at this point in the history
  • Loading branch information
btracey committed Nov 25, 2018
1 parent 9a52444 commit b630de2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion mat/diagonal.go
Expand Up @@ -45,7 +45,7 @@ type Diagonal interface {
Bandwidth() (kl, ku int)
TBand() Banded

// Triangular and TTri are included in the Diagonal interface
// Triangle and TTri are included in the Diagonal interface
// to allow the use of Diagonal types in triangular functions.
Triangle() (int, TriKind)
TTri() Triangular
Expand Down
6 changes: 3 additions & 3 deletions mat/triband.go
Expand Up @@ -68,7 +68,7 @@ var (
_ UntransposeTriBander = tTriBand
)

// TransposeBandTri is a type for performing an implicit transpose of a TriBanded
// TransposeTriBand is a type for performing an implicit transpose of a TriBanded
// matrix. It implements the TriBanded interface, returning values from the
// transpose of the matrix within.
type TransposeTriBand struct {
Expand Down Expand Up @@ -110,7 +110,7 @@ func (t TransposeTriBand) Bandwidth() (kl, ku int) {
return ku, kl
}

// TTri performs an implicit transpose by returning the TriBand field.
// TBand performs an implicit transpose by returning the TriBand field.
func (t TransposeTriBand) TBand() Banded {
return t.TriBanded
}
Expand Down Expand Up @@ -294,7 +294,7 @@ func (t *TriBandDense) TriBand() (n, k int, kind TriKind) {
return t.mat.N, t.mat.K, TriKind(!t.IsZero()) && t.triKind()
}

// TBandTri performs an implicit transpose by returning the receiver inside a TransposeTriBand.
// TTriBand performs an implicit transpose by returning the receiver inside a TransposeTriBand.
func (t *TriBandDense) TTriBand() TriBanded {
return TransposeTriBand{t}
}
Expand Down

0 comments on commit b630de2

Please sign in to comment.