diff --git a/blas/blas.go b/blas/blas.go index b292534d..8de23a4a 100644 --- a/blas/blas.go +++ b/blas/blas.go @@ -4,6 +4,109 @@ //go:generate ./conversions.bash +/* +Package blas provides interfaces for the BLAS linear algebra standard. + +All methods must perform appropriate parameter checking and panic if +provided parameters that do not conform to the requirements specified +by the BLAS standard. + +Quick Reference Guide to the BLAS from http://www.netlib.org/lapack/lug/node145.html + +This version is modified to remove the "order" option. All matrix operations are +on row-order matrices. + +Level 1 BLAS + + dim scalar vector vector scalars 5-element prefixes + struct + + _rotg ( a, b ) S, D + _rotmg( d1, d2, a, b ) S, D + _rot ( n, x, incX, y, incY, c, s ) S, D + _rotm ( n, x, incX, y, incY, param ) S, D + _swap ( n, x, incX, y, incY ) S, D, C, Z + _scal ( n, alpha, x, incX ) S, D, C, Z, Cs, Zd + _copy ( n, x, incX, y, incY ) S, D, C, Z + _axpy ( n, alpha, x, incX, y, incY ) S, D, C, Z + _dot ( n, x, incX, y, incY ) S, D, Ds + _dotu ( n, x, incX, y, incY ) C, Z + _dotc ( n, x, incX, y, incY ) C, Z + __dot ( n, alpha, x, incX, y, incY ) Sds + _nrm2 ( n, x, incX ) S, D, Sc, Dz + _asum ( n, x, incX ) S, D, Sc, Dz + I_amax( n, x, incX ) s, d, c, z + +Level 2 BLAS + + options dim b-width scalar matrix vector scalar vector prefixes + + _gemv ( trans, m, n, alpha, a, lda, x, incX, beta, y, incY ) S, D, C, Z + _gbmv ( trans, m, n, kL, kU, alpha, a, lda, x, incX, beta, y, incY ) S, D, C, Z + _hemv ( uplo, n, alpha, a, lda, x, incX, beta, y, incY ) C, Z + _hbmv ( uplo, n, k, alpha, a, lda, x, incX, beta, y, incY ) C, Z + _hpmv ( uplo, n, alpha, ap, x, incX, beta, y, incY ) C, Z + _symv ( uplo, n, alpha, a, lda, x, incX, beta, y, incY ) S, D + _sbmv ( uplo, n, k, alpha, a, lda, x, incX, beta, y, incY ) S, D + _spmv ( uplo, n, alpha, ap, x, incX, beta, y, incY ) S, D + _trmv ( uplo, trans, diag, n, a, lda, x, incX ) S, D, C, Z + _tbmv ( uplo, trans, diag, n, k, a, lda, x, incX ) S, D, C, Z + _tpmv ( uplo, trans, diag, n, ap, x, incX ) S, D, C, Z + _trsv ( uplo, trans, diag, n, a, lda, x, incX ) S, D, C, Z + _tbsv ( uplo, trans, diag, n, k, a, lda, x, incX ) S, D, C, Z + _tpsv ( uplo, trans, diag, n, ap, x, incX ) S, D, C, Z + + options dim scalar vector vector matrix prefixes + + _ger ( m, n, alpha, x, incX, y, incY, a, lda ) S, D + _geru ( m, n, alpha, x, incX, y, incY, a, lda ) C, Z + _gerc ( m, n, alpha, x, incX, y, incY, a, lda ) C, Z + _her ( uplo, n, alpha, x, incX, a, lda ) C, Z + _hpr ( uplo, n, alpha, x, incX, ap ) C, Z + _her2 ( uplo, n, alpha, x, incX, y, incY, a, lda ) C, Z + _hpr2 ( uplo, n, alpha, x, incX, y, incY, ap ) C, Z + _syr ( uplo, n, alpha, x, incX, a, lda ) S, D + _spr ( uplo, n, alpha, x, incX, ap ) S, D + _syr2 ( uplo, n, alpha, x, incX, y, incY, a, lda ) S, D + _spr2 ( uplo, n, alpha, x, incX, y, incY, ap ) S, D + +Level 3 BLAS + + options dim scalar matrix matrix scalar matrix prefixes + + _gemm ( transA, transB, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc ) S, D, C, Z + _symm ( side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc ) S, D, C, Z + _hemm ( side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc ) C, Z + _syrk ( uplo, trans, n, k, alpha, a, lda, beta, c, ldc ) S, D, C, Z + _herk ( uplo, trans, n, k, alpha, a, lda, beta, c, ldc ) C, Z + _syr2k( uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc ) S, D, C, Z + _her2k( uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc ) C, Z + _trmm ( side, uplo, transA, diag, m, n, alpha, a, lda, b, ldb ) S, D, C, Z + _trsm ( side, uplo, transA, diag, m, n, alpha, a, lda, b, ldb ) S, D, C, Z + +Meaning of prefixes + + S - float32 C - complex64 + D - float64 Z - complex128 + +Matrix types + + GE - GEneral GB - General Band + SY - SYmmetric SB - Symmetric Band SP - Symmetric Packed + HE - HErmitian HB - Hermitian Band HP - Hermitian Packed + TR - TRiangular TB - Triangular Band TP - Triangular Packed + +Options + + trans = NoTrans, Trans, ConjTrans + uplo = Upper, Lower + diag = Nonunit, Unit + side = Left, Right (A or op(A) on the left, or A or op(A) on the right) + +For real matrices, Trans and ConjTrans have the same meaning. +For Hermitian matrices, trans = Trans is not allowed. +For complex symmetric matrices, trans = ConjTrans is not allowed. +*/ package blas // import "gonum.org/v1/gonum/blas" // Flag constants indicate Givens transformation H matrix state. diff --git a/blas/blas32/blas32.go b/blas/blas32/blas32.go index acac900e..ad1e430c 100644 --- a/blas/blas32/blas32.go +++ b/blas/blas32/blas32.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package blas32 provides a simple interface to the float32 BLAS API. package blas32 // import "gonum.org/v1/gonum/blas/blas32" import ( diff --git a/blas/blas32/doc.go b/blas/blas32/doc.go deleted file mode 100644 index 27e66ab9..00000000 --- a/blas/blas32/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package blas32 provides a simple interface to the float32 BLAS API. -*/ -package blas32 // import "gonum.org/v1/gonum/blas/blas32" diff --git a/blas/blas64/blas64.go b/blas/blas64/blas64.go index e2eb749d..072801bf 100644 --- a/blas/blas64/blas64.go +++ b/blas/blas64/blas64.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package blas64 provides a simple interface to the float64 BLAS API. package blas64 // import "gonum.org/v1/gonum/blas/blas64" import ( diff --git a/blas/blas64/doc.go b/blas/blas64/doc.go deleted file mode 100644 index 7255995c..00000000 --- a/blas/blas64/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package blas64 provides a simple interface to the float64 BLAS API. -*/ -package blas64 // import "gonum.org/v1/gonum/blas/blas64" diff --git a/blas/cblas128/cblas128.go b/blas/cblas128/cblas128.go index f1dd2b9d..1dd5bf0b 100644 --- a/blas/cblas128/cblas128.go +++ b/blas/cblas128/cblas128.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package cblas128 provides a simple interface to the complex128 BLAS API. package cblas128 // import "gonum.org/v1/gonum/blas/cblas128" import ( diff --git a/blas/cblas128/doc.go b/blas/cblas128/doc.go deleted file mode 100644 index f0f81e0f..00000000 --- a/blas/cblas128/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package cblas128 provides a simple interface to the complex128 BLAS API. -*/ -package cblas128 // import "gonum.org/v1/gonum/blas/cblas128" diff --git a/blas/cblas64/cblas64.go b/blas/cblas64/cblas64.go index 9c5f93c7..1e6d4a96 100644 --- a/blas/cblas64/cblas64.go +++ b/blas/cblas64/cblas64.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package cblas64 provides a simple interface to the complex64 BLAS API. package cblas64 // import "gonum.org/v1/gonum/blas/cblas64" import ( diff --git a/blas/cblas64/doc.go b/blas/cblas64/doc.go deleted file mode 100644 index fa1595b2..00000000 --- a/blas/cblas64/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package cblas64 provides a simple interface to the complex64 BLAS API. -*/ -package cblas64 // import "gonum.org/v1/gonum/blas/cblas64" diff --git a/blas/doc.go b/blas/doc.go deleted file mode 100644 index 0c1ff2e8..00000000 --- a/blas/doc.go +++ /dev/null @@ -1,104 +0,0 @@ -/* -Package blas provides interfaces for the BLAS linear algebra standard. - -All methods must perform appropriate parameter checking and panic if -provided parameters that do not conform to the requirements specified -by the BLAS standard. - -Quick Reference Guide to the BLAS from http://www.netlib.org/lapack/lug/node145.html - -This version is modified to remove the "order" option. All matrix operations are -on row-order matrices. - -Level 1 BLAS - - dim scalar vector vector scalars 5-element prefixes - struct - - _rotg ( a, b ) S, D - _rotmg( d1, d2, a, b ) S, D - _rot ( n, x, incX, y, incY, c, s ) S, D - _rotm ( n, x, incX, y, incY, param ) S, D - _swap ( n, x, incX, y, incY ) S, D, C, Z - _scal ( n, alpha, x, incX ) S, D, C, Z, Cs, Zd - _copy ( n, x, incX, y, incY ) S, D, C, Z - _axpy ( n, alpha, x, incX, y, incY ) S, D, C, Z - _dot ( n, x, incX, y, incY ) S, D, Ds - _dotu ( n, x, incX, y, incY ) C, Z - _dotc ( n, x, incX, y, incY ) C, Z - __dot ( n, alpha, x, incX, y, incY ) Sds - _nrm2 ( n, x, incX ) S, D, Sc, Dz - _asum ( n, x, incX ) S, D, Sc, Dz - I_amax( n, x, incX ) s, d, c, z - -Level 2 BLAS - - options dim b-width scalar matrix vector scalar vector prefixes - - _gemv ( trans, m, n, alpha, a, lda, x, incX, beta, y, incY ) S, D, C, Z - _gbmv ( trans, m, n, kL, kU, alpha, a, lda, x, incX, beta, y, incY ) S, D, C, Z - _hemv ( uplo, n, alpha, a, lda, x, incX, beta, y, incY ) C, Z - _hbmv ( uplo, n, k, alpha, a, lda, x, incX, beta, y, incY ) C, Z - _hpmv ( uplo, n, alpha, ap, x, incX, beta, y, incY ) C, Z - _symv ( uplo, n, alpha, a, lda, x, incX, beta, y, incY ) S, D - _sbmv ( uplo, n, k, alpha, a, lda, x, incX, beta, y, incY ) S, D - _spmv ( uplo, n, alpha, ap, x, incX, beta, y, incY ) S, D - _trmv ( uplo, trans, diag, n, a, lda, x, incX ) S, D, C, Z - _tbmv ( uplo, trans, diag, n, k, a, lda, x, incX ) S, D, C, Z - _tpmv ( uplo, trans, diag, n, ap, x, incX ) S, D, C, Z - _trsv ( uplo, trans, diag, n, a, lda, x, incX ) S, D, C, Z - _tbsv ( uplo, trans, diag, n, k, a, lda, x, incX ) S, D, C, Z - _tpsv ( uplo, trans, diag, n, ap, x, incX ) S, D, C, Z - - options dim scalar vector vector matrix prefixes - - _ger ( m, n, alpha, x, incX, y, incY, a, lda ) S, D - _geru ( m, n, alpha, x, incX, y, incY, a, lda ) C, Z - _gerc ( m, n, alpha, x, incX, y, incY, a, lda ) C, Z - _her ( uplo, n, alpha, x, incX, a, lda ) C, Z - _hpr ( uplo, n, alpha, x, incX, ap ) C, Z - _her2 ( uplo, n, alpha, x, incX, y, incY, a, lda ) C, Z - _hpr2 ( uplo, n, alpha, x, incX, y, incY, ap ) C, Z - _syr ( uplo, n, alpha, x, incX, a, lda ) S, D - _spr ( uplo, n, alpha, x, incX, ap ) S, D - _syr2 ( uplo, n, alpha, x, incX, y, incY, a, lda ) S, D - _spr2 ( uplo, n, alpha, x, incX, y, incY, ap ) S, D - -Level 3 BLAS - - options dim scalar matrix matrix scalar matrix prefixes - - _gemm ( transA, transB, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc ) S, D, C, Z - _symm ( side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc ) S, D, C, Z - _hemm ( side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc ) C, Z - _syrk ( uplo, trans, n, k, alpha, a, lda, beta, c, ldc ) S, D, C, Z - _herk ( uplo, trans, n, k, alpha, a, lda, beta, c, ldc ) C, Z - _syr2k( uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc ) S, D, C, Z - _her2k( uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc ) C, Z - _trmm ( side, uplo, transA, diag, m, n, alpha, a, lda, b, ldb ) S, D, C, Z - _trsm ( side, uplo, transA, diag, m, n, alpha, a, lda, b, ldb ) S, D, C, Z - -Meaning of prefixes - - S - float32 C - complex64 - D - float64 Z - complex128 - -Matrix types - - GE - GEneral GB - General Band - SY - SYmmetric SB - Symmetric Band SP - Symmetric Packed - HE - HErmitian HB - Hermitian Band HP - Hermitian Packed - TR - TRiangular TB - Triangular Band TP - Triangular Packed - -Options - - trans = NoTrans, Trans, ConjTrans - uplo = Upper, Lower - diag = Nonunit, Unit - side = Left, Right (A or op(A) on the left, or A or op(A) on the right) - -For real matrices, Trans and ConjTrans have the same meaning. -For Hermitian matrices, trans = Trans is not allowed. -For complex symmetric matrices, trans = ConjTrans is not allowed. -*/ -package blas // import "gonum.org/v1/gonum/blas" diff --git a/blas/testblas/benchautogen/autogen_bench_level1double.go b/blas/testblas/benchautogen/autogen_bench_level1double.go index e7ca0cf8..944a1ab7 100644 --- a/blas/testblas/benchautogen/autogen_bench_level1double.go +++ b/blas/testblas/benchautogen/autogen_bench_level1double.go @@ -2,6 +2,7 @@ // Use of this code is governed by a BSD-style // license that can be found in the LICENSE file +// Script for automatic code generation of the benchmark routines package main import ( diff --git a/blas/testblas/benchautogen/doc.go b/blas/testblas/benchautogen/doc.go deleted file mode 100644 index 4129406e..00000000 --- a/blas/testblas/benchautogen/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Script for automatic code generation of the benchmark routines -*/ -package main // import "gonum.org/v1/gonum/blas/testblas/benchautogen" diff --git a/blas/testblas/doc.go b/blas/testblas/doc.go deleted file mode 100644 index 4f09c7ba..00000000 --- a/blas/testblas/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package testblas provides tests for blas implementations. -*/ -package testblas // import "gonum.org/v1/gonum/blas/testblas" diff --git a/blas/testblas/level1double.go b/blas/testblas/level1double.go index 76a2fb33..4a47542b 100644 --- a/blas/testblas/level1double.go +++ b/blas/testblas/level1double.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package testblas provides tests for blas implementations. package testblas // import "gonum.org/v1/gonum/blas/testblas" import ( diff --git a/diff/fd/diff.go b/diff/fd/diff.go index 63391c9f..322e988d 100644 --- a/diff/fd/diff.go +++ b/diff/fd/diff.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package fd provides functions to approximate derivatives using finite differences. package fd // import "gonum.org/v1/gonum/diff/fd" import ( diff --git a/diff/fd/doc.go b/diff/fd/doc.go deleted file mode 100644 index f1dca9af..00000000 --- a/diff/fd/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package fd provides functions to approximate derivatives using finite differences. -*/ -package fd // import "gonum.org/v1/gonum/diff/fd" diff --git a/floats/doc.go b/floats/doc.go deleted file mode 100644 index 6eaa162e..00000000 --- a/floats/doc.go +++ /dev/null @@ -1,9 +0,0 @@ -/* -Package floats provides a set of helper routines for dealing with slices -of float64. The functions avoid allocations to allow for use within tight -loops without garbage collection overhead. - -The convention used is that when a slice is being modified in place, it has -the name dst. -*/ -package floats // import "gonum.org/v1/gonum/floats" diff --git a/floats/floats.go b/floats/floats.go index 8400ca85..32b645ba 100644 --- a/floats/floats.go +++ b/floats/floats.go @@ -2,6 +2,12 @@ // Use of this code is governed by a BSD-style // license that can be found in the LICENSE file +// Package floats provides a set of helper routines for dealing with slices +// of float64. The functions avoid allocations to allow for use within tight +// loops without garbage collection overhead. +// +// The convention used is that when a slice is being modified in place, it has +// the name dst. package floats // import "gonum.org/v1/gonum/floats" import ( diff --git a/graph/community/doc.go b/graph/community/doc.go deleted file mode 100644 index 079cda6a..00000000 --- a/graph/community/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package community provides graph community detection functions. -*/ -package community // import "gonum.org/v1/gonum/graph/community" diff --git a/graph/community/louvain_common.go b/graph/community/louvain_common.go index 90c7a484..6abedce9 100644 --- a/graph/community/louvain_common.go +++ b/graph/community/louvain_common.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package community provides graph community detection functions. package community // import "gonum.org/v1/gonum/graph/community" import ( diff --git a/graph/encoding/doc.go b/graph/encoding/doc.go deleted file mode 100644 index 0c346cea..00000000 --- a/graph/encoding/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package encoding provides a common graph encoding API. -*/ -package encoding // import "gonum.org/v1/gonum/graph/encoding" diff --git a/graph/encoding/dot/doc.go b/graph/encoding/dot/doc.go deleted file mode 100644 index 609b6b96..00000000 --- a/graph/encoding/dot/doc.go +++ /dev/null @@ -1,11 +0,0 @@ -/* -Package dot implements GraphViz DOT marshaling and unmarshaling of graphs. - -See the GraphViz DOT Guide and the DOT grammar for more information -on using specific aspects of the DOT language: - -DOT Guide: http://www.graphviz.org/Documentation/dotguide.pdf - -DOT grammar: http://www.graphviz.org/doc/info/lang.html -*/ -package dot // import "gonum.org/v1/gonum/graph/encoding/dot" diff --git a/graph/encoding/dot/dot.go b/graph/encoding/dot/dot.go index cc5e978e..464afe6e 100644 --- a/graph/encoding/dot/dot.go +++ b/graph/encoding/dot/dot.go @@ -2,4 +2,13 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package dot implements GraphViz DOT marshaling and unmarshaling of graphs. +// +// See the GraphViz DOT Guide and the DOT grammar for more information +// on using specific aspects of the DOT language: +// +// DOT Guide: http://www.graphviz.org/Documentation/dotguide.pdf +// +// DOT grammar: http://www.graphviz.org/doc/info/lang.html +// package dot // import "gonum.org/v1/gonum/graph/encoding/dot" diff --git a/graph/encoding/encoding.go b/graph/encoding/encoding.go index d819ce57..4a6dab92 100644 --- a/graph/encoding/encoding.go +++ b/graph/encoding/encoding.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package encoding provides a common graph encoding API. package encoding // import "gonum.org/v1/gonum/graph/encoding" import "gonum.org/v1/gonum/graph" diff --git a/graph/encoding/graphql/doc.go b/graph/encoding/graphql/doc.go deleted file mode 100644 index e5f24cff..00000000 --- a/graph/encoding/graphql/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package graphql implements JSON marshaling and unmarshaling of graph as -used by GraphQL -*/ -package graphql // import "gonum.org/v1/gonum/graph/encoding/graphql" diff --git a/graph/encoding/graphql/graphql.go b/graph/encoding/graphql/graphql.go index fd2ac368..dd405034 100644 --- a/graph/encoding/graphql/graphql.go +++ b/graph/encoding/graphql/graphql.go @@ -2,4 +2,6 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package graphql implements JSON marshaling and unmarshaling of graph as +// used by GraphQL package graphql // import "gonum.org/v1/gonum/graph/encoding/graphql" diff --git a/graph/formats/dot/ast/ast.go b/graph/formats/dot/ast/ast.go index 533f72fc..6ddfa11b 100644 --- a/graph/formats/dot/ast/ast.go +++ b/graph/formats/dot/ast/ast.go @@ -8,6 +8,8 @@ // This file is made available under a Creative Commons CC0 1.0 // Universal Public Domain Dedication. +// Package ast declares the types used to represent abstract syntax trees of +// Graphviz DOT graphs. package ast // import "gonum.org/v1/gonum/graph/formats/dot/ast" import ( diff --git a/graph/formats/dot/ast/doc.go b/graph/formats/dot/ast/doc.go deleted file mode 100644 index 2ecafa39..00000000 --- a/graph/formats/dot/ast/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package ast declares the types used to represent abstract syntax trees of -Graphviz DOT graphs. -*/ -package ast // import "gonum.org/v1/gonum/graph/formats/dot/ast" diff --git a/graph/formats/dot/doc.go b/graph/formats/dot/doc.go deleted file mode 100644 index d20f274f..00000000 --- a/graph/formats/dot/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package dot implements a parser for Graphviz DOT files. -*/ -package dot // import "gonum.org/v1/gonum/graph/formats/dot" diff --git a/graph/formats/dot/dot.go b/graph/formats/dot/dot.go index 36b44308..07967c7f 100644 --- a/graph/formats/dot/dot.go +++ b/graph/formats/dot/dot.go @@ -10,6 +10,7 @@ //go:generate ./makeinternal.bash +// Package dot implements a parser for Graphviz DOT files. package dot // import "gonum.org/v1/gonum/graph/formats/dot" import ( diff --git a/graph/formats/dot/internal/astx/astx.go b/graph/formats/dot/internal/astx/astx.go index 34479d93..925171fd 100644 --- a/graph/formats/dot/internal/astx/astx.go +++ b/graph/formats/dot/internal/astx/astx.go @@ -8,6 +8,8 @@ // This file is made available under a Creative Commons CC0 1.0 // Universal Public Domain Dedication. +// Package astx implements utility functions for generating abstract syntax +// trees of Graphviz DOT graphs. package astx // import "gonum.org/v1/gonum/graph/formats/dot/internal/astx" import ( diff --git a/graph/formats/dot/internal/astx/doc.go b/graph/formats/dot/internal/astx/doc.go deleted file mode 100644 index 0c582d53..00000000 --- a/graph/formats/dot/internal/astx/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package astx implements utility functions for generating abstract syntax -trees of Graphviz DOT graphs. -*/ -package astx // import "gonum.org/v1/gonum/graph/formats/dot/internal/astx" diff --git a/graph/graphs/gen/doc.go b/graph/graphs/gen/doc.go deleted file mode 100644 index 983846ea..00000000 --- a/graph/graphs/gen/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package gen provides random graph generation functions. -*/ -package gen // import "gonum.org/v1/gonum/graph/graphs/gen" diff --git a/graph/graphs/gen/gen.go b/graph/graphs/gen/gen.go index 7fb852fc..6834ac6c 100644 --- a/graph/graphs/gen/gen.go +++ b/graph/graphs/gen/gen.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package gen provides random graph generation functions. package gen // import "gonum.org/v1/gonum/graph/graphs/gen" import "gonum.org/v1/gonum/graph" diff --git a/graph/internal/linear/doc.go b/graph/internal/linear/doc.go deleted file mode 100644 index fd73bc84..00000000 --- a/graph/internal/linear/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package linear provides common linear data structures. -*/ -package linear // import "gonum.org/v1/gonum/graph/internal/linear" diff --git a/graph/internal/linear/linear.go b/graph/internal/linear/linear.go index f08f985c..191012ee 100644 --- a/graph/internal/linear/linear.go +++ b/graph/internal/linear/linear.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package linear provides common linear data structures. package linear // import "gonum.org/v1/gonum/graph/internal/linear" import ( diff --git a/graph/internal/ordered/doc.go b/graph/internal/ordered/doc.go deleted file mode 100644 index 865215c8..00000000 --- a/graph/internal/ordered/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package ordered provides common sort ordering types. -*/ -package ordered // import "gonum.org/v1/gonum/graph/internal/ordered" diff --git a/graph/internal/ordered/sort.go b/graph/internal/ordered/sort.go index 0a5af043..e0cce8ef 100644 --- a/graph/internal/ordered/sort.go +++ b/graph/internal/ordered/sort.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package ordered provides common sort ordering types. package ordered // import "gonum.org/v1/gonum/graph/internal/ordered" import "gonum.org/v1/gonum/graph" diff --git a/graph/internal/set/doc.go b/graph/internal/set/doc.go deleted file mode 100644 index 200c43dc..00000000 --- a/graph/internal/set/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package set provides integer and graph.Node sets. -*/ -package set // import "gonum.org/v1/gonum/graph/internal/set" diff --git a/graph/internal/set/set.go b/graph/internal/set/set.go index 004a5879..1397dabb 100644 --- a/graph/internal/set/set.go +++ b/graph/internal/set/set.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package set provides integer and graph.Node sets. package set // import "gonum.org/v1/gonum/graph/internal/set" import "gonum.org/v1/gonum/graph" diff --git a/graph/network/doc.go b/graph/network/doc.go deleted file mode 100644 index 91dbcf03..00000000 --- a/graph/network/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package network provides network analysis functions. -*/ -package network // import "gonum.org/v1/gonum/graph/network" diff --git a/graph/network/network.go b/graph/network/network.go index e664e8f3..13726c03 100644 --- a/graph/network/network.go +++ b/graph/network/network.go @@ -10,4 +10,5 @@ // http://www.vldb.org/pvldb/vol7/p1023-maehara.pdf // * other centrality measures +// Package network provides network analysis functions. package network // import "gonum.org/v1/gonum/graph/network" diff --git a/graph/simple/doc.go b/graph/simple/doc.go deleted file mode 100644 index 0c48c04e..00000000 --- a/graph/simple/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package simple provides a suite of simple graph implementations satisfying -the gonum/graph interfaces. -*/ -package simple // import "gonum.org/v1/gonum/graph/simple" diff --git a/graph/simple/simple.go b/graph/simple/simple.go index a6b0b5cb..f64dc9c3 100644 --- a/graph/simple/simple.go +++ b/graph/simple/simple.go @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package simple provides a suite of simple graph implementations satisfying +// the gonum/graph interfaces. package simple // import "gonum.org/v1/gonum/graph/simple" import ( diff --git a/graph/topo/doc.go b/graph/topo/doc.go deleted file mode 100644 index 1d37486f..00000000 --- a/graph/topo/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package topo provides graph topology analysis functions. -*/ -package topo // import "gonum.org/v1/gonum/graph/topo" diff --git a/graph/topo/topo.go b/graph/topo/topo.go index 2c5fc9e9..ec2fb087 100644 --- a/graph/topo/topo.go +++ b/graph/topo/topo.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package topo provides graph topology analysis functions. package topo // import "gonum.org/v1/gonum/graph/topo" import ( diff --git a/graph/traverse/doc.go b/graph/traverse/doc.go deleted file mode 100644 index 809da675..00000000 --- a/graph/traverse/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package traverse provides basic graph traversal primitives. -*/ -package traverse // import "gonum.org/v1/gonum/graph/traverse" diff --git a/graph/traverse/traverse.go b/graph/traverse/traverse.go index 98e8b1c9..b6c82ac8 100644 --- a/graph/traverse/traverse.go +++ b/graph/traverse/traverse.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package traverse provides basic graph traversal primitives. package traverse // import "gonum.org/v1/gonum/graph/traverse" import ( diff --git a/integrate/quad/doc.go b/integrate/quad/doc.go deleted file mode 100644 index 607f97b1..00000000 --- a/integrate/quad/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package quad provides numerical evaluation of definite integrals of single-variable functions. -*/ -package quad // import "gonum.org/v1/gonum/integrate/quad" diff --git a/integrate/quad/quad.go b/integrate/quad/quad.go index 69786164..2f58358e 100644 --- a/integrate/quad/quad.go +++ b/integrate/quad/quad.go @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package quad provides numerical evaluation of definite integrals of single-variable functions. +// package quad // import "gonum.org/v1/gonum/integrate/quad" import ( diff --git a/internal/cmplx64/abs.go b/internal/cmplx64/abs.go index 65b8c985..a4b22e1e 100644 --- a/internal/cmplx64/abs.go +++ b/internal/cmplx64/abs.go @@ -6,6 +6,8 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package cmplx64 provides complex64 versions of standard library math/cmplx +// package routines used by gonum/blas. package cmplx64 import math "gonum.org/v1/gonum/internal/math32" diff --git a/internal/cmplx64/doc.go b/internal/cmplx64/doc.go deleted file mode 100644 index 442c86ba..00000000 --- a/internal/cmplx64/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package cmplx64 provides complex64 versions of standard library math/cmplx -package routines used by gonum/blas. -*/ -package cmplx64 // import "gonum.org/v1/gonum/internal/cmplx64" diff --git a/internal/math32/doc.go b/internal/math32/doc.go deleted file mode 100644 index 27ad96ce..00000000 --- a/internal/math32/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package math32 provides float32 versions of standard library math package -routines used by gonum/blas/native. -*/ -package math32 // import "gonum.org/v1/gonum/internal/math32" diff --git a/internal/math32/math.go b/internal/math32/math.go index e5f90653..658cb831 100644 --- a/internal/math32/math.go +++ b/internal/math32/math.go @@ -6,6 +6,8 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package math32 provides float32 versions of standard library math package +// routines used by gonum/blas/native. package math32 // import "gonum.org/v1/gonum/internal/math32" import ( diff --git a/lapack/lapack64/doc.go b/lapack/lapack64/doc.go deleted file mode 100644 index da1cc244..00000000 --- a/lapack/lapack64/doc.go +++ /dev/null @@ -1,18 +0,0 @@ -/* -Package lapack64 provides a set of convenient wrapper functions for LAPACK -calls, as specified in the netlib standard (www.netlib.org). - -The native Go routines are used by default, and the Use function can be used -to set an alternative implementation. - -If the type of matrix (General, Symmetric, etc.) is known and fixed, it is -used in the wrapper signature. In many cases, however, the type of the matrix -changes during the call to the routine, for example the matrix is symmetric on -entry and is triangular on exit. In these cases the correct types should be checked -in the documentation. - -The full set of Lapack functions is very large, and it is not clear that a -full implementation is desirable, let alone feasible. Please open up an issue -if there is a specific function you need and/or are willing to implement. -*/ -package lapack64 // import "gonum.org/v1/gonum/lapack/lapack64" diff --git a/lapack/lapack64/lapack64.go b/lapack/lapack64/lapack64.go index 94acb688..cc37061f 100644 --- a/lapack/lapack64/lapack64.go +++ b/lapack/lapack64/lapack64.go @@ -2,6 +2,21 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package lapack64 provides a set of convenient wrapper functions for LAPACK +// calls, as specified in the netlib standard (www.netlib.org). +// +// The native Go routines are used by default, and the Use function can be used +// to set an alternative implementation. +// +// If the type of matrix (General, Symmetric, etc.) is known and fixed, it is +// used in the wrapper signature. In many cases, however, the type of the matrix +// changes during the call to the routine, for example the matrix is symmetric on +// entry and is triangular on exit. In these cases the correct types should be checked +// in the documentation. +// +// The full set of Lapack functions is very large, and it is not clear that a +// full implementation is desirable, let alone feasible. Please open up an issue +// if there is a specific function you need and/or are willing to implement. package lapack64 // import "gonum.org/v1/gonum/lapack/lapack64" import ( diff --git a/mathext/internal/amos/amos.go b/mathext/internal/amos/amos.go index 2bd74d43..a3fb5b55 100644 --- a/mathext/internal/amos/amos.go +++ b/mathext/internal/amos/amos.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// package amos implements functions originally in the Netlab code by Donald Amos. package amos import ( diff --git a/mathext/internal/amos/doc.go b/mathext/internal/amos/doc.go deleted file mode 100644 index 61aa33df..00000000 --- a/mathext/internal/amos/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -package amos implements functions originally in the Netlab code by Donald Amos. -*/ -package amos // import "gonum.org/v1/gonum/mathext/internal/amos" diff --git a/mathext/internal/cephes/cephes.go b/mathext/internal/cephes/cephes.go index 6502ec93..e61f3465 100644 --- a/mathext/internal/cephes/cephes.go +++ b/mathext/internal/cephes/cephes.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package cephes implements functions originally in the Netlib code by Stephen Mosher. package cephes // import "gonum.org/v1/gonum/mathext/internal/cephes" import "math" diff --git a/mathext/internal/cephes/doc.go b/mathext/internal/cephes/doc.go deleted file mode 100644 index 7f33dc21..00000000 --- a/mathext/internal/cephes/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package cephes implements functions originally in the Netlib code by Stephen Mosher. -*/ -package cephes // import "gonum.org/v1/gonum/mathext/internal/cephes" diff --git a/mathext/internal/gonum/doc.go b/mathext/internal/gonum/doc.go deleted file mode 100644 index 913e582b..00000000 --- a/mathext/internal/gonum/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -package gonum contains functions implemented by the gonum team. It is here to -avoid circular imports and/or double coding of functions. -*/ -package gonum // import "gonum.org/v1/gonum/mathext/internal/gonum" diff --git a/mathext/internal/gonum/gonum.go b/mathext/internal/gonum/gonum.go index eae3e1c4..2aa56ca9 100644 --- a/mathext/internal/gonum/gonum.go +++ b/mathext/internal/gonum/gonum.go @@ -2,4 +2,6 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// package gonum contains functions implemented by the gonum team. It is here to +// avoid circular imports and/or double coding of functions. package gonum diff --git a/stat/combin/combin.go b/stat/combin/combin.go index b66fdaf8..4bd75a34 100644 --- a/stat/combin/combin.go +++ b/stat/combin/combin.go @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package combin implements routines involving combinatorics (permutations, +// combinations, etc.). package combin // import "gonum.org/v1/gonum/stat/combin" import "math" diff --git a/stat/combin/doc.go b/stat/combin/doc.go deleted file mode 100644 index 0cf3807e..00000000 --- a/stat/combin/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -/* -Package combin implements routines involving combinatorics (permutations, -combinations, etc.). -*/ -package combin // import "gonum.org/v1/gonum/stat/combin" diff --git a/stat/distmat/doc.go b/stat/distmat/doc.go deleted file mode 100644 index 7bdc6c43..00000000 --- a/stat/distmat/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package distmat provides probability distributions over matrices. -*/ -package distmat // import "gonum.org/v1/gonum/stat/distmat" diff --git a/stat/distmat/general.go b/stat/distmat/general.go index bf70ccc7..7a834e66 100644 --- a/stat/distmat/general.go +++ b/stat/distmat/general.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package distmat provides probability distributions over matrices. package distmat // import "gonum.org/v1/gonum/stat/distmat" var badDim = "distmat: dimension mismatch" diff --git a/stat/distmv/doc.go b/stat/distmv/doc.go deleted file mode 100644 index 4ca53c71..00000000 --- a/stat/distmv/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package distmv provides multivariate random distribution types. -*/ -package distmv // import "gonum.org/v1/gonum/stat/distmv" diff --git a/stat/distmv/general.go b/stat/distmv/general.go index 810f5e23..9cb47eea 100644 --- a/stat/distmv/general.go +++ b/stat/distmv/general.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package distmv provides multivariate random distribution types. package distmv // import "gonum.org/v1/gonum/stat/distmv" var ( diff --git a/stat/distuv/doc.go b/stat/distuv/doc.go deleted file mode 100644 index 3fc366cd..00000000 --- a/stat/distuv/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package distuv provides univariate random distribution types. -*/ -package distuv // import "gonum.org/v1/gonum/stat/distuv" diff --git a/stat/distuv/general.go b/stat/distuv/general.go index ffb62099..d6717700 100644 --- a/stat/distuv/general.go +++ b/stat/distuv/general.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package distuv provides univariate random distribution types. package distuv // import "gonum.org/v1/gonum/stat/distuv" import "math" diff --git a/stat/doc.go b/stat/doc.go deleted file mode 100644 index 017f734d..00000000 --- a/stat/doc.go +++ /dev/null @@ -1,4 +0,0 @@ -/* -Package stat provides generalized statistical functions. -*/ -package stat // import "gonum.org/v1/gonum/stat" diff --git a/stat/samplemv/doc.go b/stat/samplemv/doc.go deleted file mode 100644 index ad2419cd..00000000 --- a/stat/samplemv/doc.go +++ /dev/null @@ -1,9 +0,0 @@ -/* -Package samplemv implements advanced sampling routines from explicit and implicit -probability distributions. - -Each sampling routine is implemented as a stateless function with a -complementary wrapper type. The wrapper types allow the sampling routines -to implement interfaces. -*/ -package samplemv // import "gonum.org/v1/gonum/stat/samplemv" diff --git a/stat/samplemv/samplemv.go b/stat/samplemv/samplemv.go index 009833da..be878854 100644 --- a/stat/samplemv/samplemv.go +++ b/stat/samplemv/samplemv.go @@ -2,6 +2,12 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package samplemv implements advanced sampling routines from explicit and implicit +// probability distributions. +// +// Each sampling routine is implemented as a stateless function with a +// complementary wrapper type. The wrapper types allow the sampling routines +// to implement interfaces. package samplemv // import "gonum.org/v1/gonum/stat/samplemv" import ( diff --git a/stat/sampleuv/doc.go b/stat/sampleuv/doc.go deleted file mode 100644 index 9754e617..00000000 --- a/stat/sampleuv/doc.go +++ /dev/null @@ -1,9 +0,0 @@ -/* -Package sampleuv implements advanced sampling routines from explicit and implicit -probability distributions. - -Each sampling routine is implemented as a stateless function with a -complementary wrapper type. The wrapper types allow the sampling routines -to implement interfaces. -*/ -package sampleuv // import "gonum.org/v1/gonum/stat/sampleuv" diff --git a/stat/sampleuv/sample.go b/stat/sampleuv/sample.go index 5d5dd309..d3a6290b 100644 --- a/stat/sampleuv/sample.go +++ b/stat/sampleuv/sample.go @@ -2,6 +2,12 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package sampleuv implements advanced sampling routines from explicit and implicit +// probability distributions. +// +// Each sampling routine is implemented as a stateless function with a +// complementary wrapper type. The wrapper types allow the sampling routines +// to implement interfaces. package sampleuv // import "gonum.org/v1/gonum/stat/sampleuv" import ( diff --git a/stat/stat.go b/stat/stat.go index 148edc9d..9b62f1ec 100644 --- a/stat/stat.go +++ b/stat/stat.go @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// Package stat provides generalized statistical functions. package stat // import "gonum.org/v1/gonum/stat" import (