package/gonum
1
0
Fork 0
mirror of https://github.com/gonum/gonum.git synced 2025-10-06 23:52:47 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

blas,lapack,mat,unit: remove "Please" from documentation

Browse Source
This commit is contained in:
Vladimir Chalupecky
2018-01-02 14:50:24 +01:00
committed by Vladimír Chalupecký
parent 87056319dc
commit d4533cd4f6
9 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
blas/gonum/doc.go
View File

@@ -7,12 +7,12 @@
/* /*
Package native is a Go implementation of the BLAS API. This implementation Package native is a Go implementation of the BLAS API. This implementation
panics when the input arguments are invalid as per the standard, for example panics when the input arguments are invalid as per the standard, for example
if a vector increment is zero. Please note that the treatment of NaN values if a vector increment is zero. Note that the treatment of NaN values
is not specified, and differs among the BLAS implementations. is not specified, and differs among the BLAS implementations.
gonum.org/v1/gonum/blas/blas64 provides helpful wrapper functions to the BLAS gonum.org/v1/gonum/blas/blas64 provides helpful wrapper functions to the BLAS
interface. The rest of this text describes the layout of the data for the input types. interface. The rest of this text describes the layout of the data for the input types.
Please note that in the function documentation, x[i] refers to the i^th element Note that in the function documentation, x[i] refers to the i^th element
of the vector, which will be different from the i^th element of the slice if of the vector, which will be different from the i^th element of the slice if
incX != 1. incX != 1.

2
lapack/gonum/dlarft.go
View File

@@ -22,7 +22,7 @@ import (
// and lower triangular otherwise. This function will panic if t is not of // and lower triangular otherwise. This function will panic if t is not of
// sufficient size. // sufficient size.
// //
// store describes the storage of the elementary reflectors in v. Please see // store describes the storage of the elementary reflectors in v. See
// Dlarfb for a description of layout. // Dlarfb for a description of layout.
// //
// tau contains the scalar factors of the elementary reflectors H_i. // tau contains the scalar factors of the elementary reflectors H_i.

2
lapack/gonum/doc.go
View File

@@ -6,7 +6,7 @@
// a set of algorithms for advanced matrix operations. // a set of algorithms for advanced matrix operations.
// //
// The function definitions and implementations follow that of the netlib reference // The function definitions and implementations follow that of the netlib reference
// implementation. Please see http://www.netlib.org/lapack/explore-html/ for more // implementation. See http://www.netlib.org/lapack/explore-html/ for more
// information, and http://www.netlib.org/lapack/explore-html/d4/de1/_l_i_c_e_n_s_e_source.html // information, and http://www.netlib.org/lapack/explore-html/d4/de1/_l_i_c_e_n_s_e_source.html
// for more license information. // for more license information.
// //

6
mat/lq.go
View File

@@ -142,8 +142,8 @@ func (lq *LQ) QTo(dst *Dense) *Dense {
// Solve finds a minimum-norm solution to a system of linear equations defined // Solve finds a minimum-norm solution to a system of linear equations defined
// by the matrices A and b, where A is an m×n matrix represented in its LQ factorized // by the matrices A and b, where A is an m×n matrix represented in its LQ factorized
// form. If A is singular or near-singular a Condition error is returned. Please // form. If A is singular or near-singular a Condition error is returned.
// see the documentation for Condition for more information. // See the documentation for Condition for more information.
// //
// The minimization problem solved depends on the input parameters. // The minimization problem solved depends on the input parameters.
// If trans == false, find the minimum norm solution of A * X = b. // If trans == false, find the minimum norm solution of A * X = b.
@@ -208,7 +208,7 @@ func (lq *LQ) Solve(m *Dense, trans bool, b Matrix) error {
} }
// SolveVec finds a minimum-norm solution to a system of linear equations. // SolveVec finds a minimum-norm solution to a system of linear equations.
// Please see LQ.Solve for the full documentation. // See LQ.Solve for the full documentation.
func (lq *LQ) SolveVec(v *VecDense, trans bool, b Vector) error { func (lq *LQ) SolveVec(v *VecDense, trans bool, b Vector) error {
r, c := lq.lq.Dims() r, c := lq.lq.Dims()
if _, bc := b.Dims(); bc != 1 { if _, bc := b.Dims(); bc != 1 {

4
mat/lu.go
View File

@@ -288,7 +288,7 @@ func (m *Dense) Permutation(r int, swaps []int) {
// In both cases, A is represented in LU factorized form, and the matrix x is // In both cases, A is represented in LU factorized form, and the matrix x is
// stored into m. // stored into m.
// //
// If A is singular or near-singular a Condition error is returned. Please see // If A is singular or near-singular a Condition error is returned. See
// the documentation for Condition for more information. // the documentation for Condition for more information.
func (lu *LU) Solve(m *Dense, trans bool, b Matrix) error { func (lu *LU) Solve(m *Dense, trans bool, b Matrix) error {
_, n := lu.lu.Dims() _, n := lu.lu.Dims()
@@ -331,7 +331,7 @@ func (lu *LU) Solve(m *Dense, trans bool, b Matrix) error {
// In both cases, A is represented in LU factorized form, and the matrix x is // In both cases, A is represented in LU factorized form, and the matrix x is
// stored into v. // stored into v.
// //
// If A is singular or near-singular a Condition error is returned. Please see // If A is singular or near-singular a Condition error is returned. See
// the documentation for Condition for more information. // the documentation for Condition for more information.
func (lu *LU) SolveVec(v *VecDense, trans bool, b Vector) error { func (lu *LU) SolveVec(v *VecDense, trans bool, b Vector) error {
_, n := lu.lu.Dims() _, n := lu.lu.Dims()

6
mat/qr.go
View File

@@ -138,8 +138,8 @@ func (qr *QR) QTo(dst *Dense) *Dense {
// Solve finds a minimum-norm solution to a system of linear equations defined // Solve finds a minimum-norm solution to a system of linear equations defined
// by the matrices A and b, where A is an m×n matrix represented in its QR factorized // by the matrices A and b, where A is an m×n matrix represented in its QR factorized
// form. If A is singular or near-singular a Condition error is returned. Please // form. If A is singular or near-singular a Condition error is returned.
// see the documentation for Condition for more information. // See the documentation for Condition for more information.
// //
// The minimization problem solved depends on the input parameters. // The minimization problem solved depends on the input parameters.
// If trans == false, find X such that ||A*X - b||_2 is minimized. // If trans == false, find X such that ||A*X - b||_2 is minimized.
@@ -205,7 +205,7 @@ func (qr *QR) Solve(m *Dense, trans bool, b Matrix) error {
// SolveVec finds a minimum-norm solution to a system of linear equations, // SolveVec finds a minimum-norm solution to a system of linear equations,
// Ax = b. // Ax = b.
// Please see QR.Solve for the full documentation. // See QR.Solve for the full documentation.
func (qr *QR) SolveVec(v *VecDense, trans bool, b Vector) error { func (qr *QR) SolveVec(v *VecDense, trans bool, b Vector) error {
r, c := qr.qr.Dims() r, c := qr.qr.Dims()
if _, bc := b.Dims(); bc != 1 { if _, bc := b.Dims(); bc != 1 {

4
mat/solve.go
View File

@@ -12,7 +12,7 @@ import (
// Solve finds a minimum-norm solution to a system of linear equations defined // Solve finds a minimum-norm solution to a system of linear equations defined
// by the matrices a and b. If A is singular or near-singular, a Condition error // by the matrices a and b. If A is singular or near-singular, a Condition error
// is returned. Please see the documentation for Condition for more information. // is returned. See the documentation for Condition for more information.
// //
// The minimization problem solved depends on the input parameters: // The minimization problem solved depends on the input parameters:
// - if m >= n, find X such that ||A*X - B||_2 is minimized, // - if m >= n, find X such that ||A*X - B||_2 is minimized,
@@ -105,7 +105,7 @@ func (m *Dense) Solve(a, b Matrix) error {
// SolveVec finds a minimum-norm solution to a system of linear equations defined // SolveVec finds a minimum-norm solution to a system of linear equations defined
// by the matrix a and the right-hand side column vector b. If A is singular or // by the matrix a and the right-hand side column vector b. If A is singular or
// near-singular, a Condition error is returned. Please see the documentation for // near-singular, a Condition error is returned. See the documentation for
// Dense.Solve for more information. // Dense.Solve for more information.
func (v *VecDense) SolveVec(a Matrix, b Vector) error { func (v *VecDense) SolveVec(a Matrix, b Vector) error {
if _, bc := b.Dims(); bc != 1 { if _, bc := b.Dims(); bc != 1 {

2
unit/doc.go
View File

@@ -74,7 +74,7 @@
// used, however, to create the unit of 'Slide', because in this case slide // used, however, to create the unit of 'Slide', because in this case slide
// is just a measurement of area. Instead, a constant could be defined. // is just a measurement of area. Instead, a constant could be defined.
// const Slide unit.Area = 0.001875 // m^2 // const Slide unit.Area = 0.001875 // m^2
// Please note that Unit cannot catch all errors related to dimensionality. // Note that Unit cannot catch all errors related to dimensionality.
// Different physical ideas are sometimes expressed with the same dimensions // Different physical ideas are sometimes expressed with the same dimensions
// and Unit is incapable of catching these mismatches. For example, energy and // and Unit is incapable of catching these mismatches. For example, energy and
// torque are both expressed as force times distance (Newton-meters in SI), // torque are both expressed as force times distance (Newton-meters in SI),

4
unit/unittype.go
View File

@@ -185,7 +185,7 @@ func (u unitPrinters) Swap(i, j int) {
// NewDimension will panic if the input symbol matches an existing symbol. // NewDimension will panic if the input symbol matches an existing symbol.
// //
// NewDimension should only be called for unit types that are actually orthogonal // NewDimension should only be called for unit types that are actually orthogonal
// to the base dimensions defined in this package. Please see the package-level // to the base dimensions defined in this package. See the package-level
// documentation for further explanation. // documentation for further explanation.
func NewDimension(symbol string) Dimension { func NewDimension(symbol string) Dimension {
_, ok := dimensions[symbol] _, ok := dimensions[symbol]
@@ -208,7 +208,7 @@ func SymbolExists(symbol string) bool {
// units, but can also include dimensions created with NewDimension. The Unit type // units, but can also include dimensions created with NewDimension. The Unit type
// is most useful for ensuring dimensional consistency when manipulating types // is most useful for ensuring dimensional consistency when manipulating types
// with different units, for example, by multiplying an acceleration with a // with different units, for example, by multiplying an acceleration with a
// mass to get a force. Please see the package documentation for further explanation. // mass to get a force. See the package documentation for further explanation.
type Unit struct { type Unit struct {
dimensions Dimensions dimensions Dimensions
formatted string formatted string