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

README: update old repo READMEs

Browse Source
This commit is contained in:
kortschak
2017-07-07 14:43:52 +09:30
committed by Dan Kortschak
parent 0b28ad86d2
commit 0f349255d4
11 changed files with 38 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
blas/README.md
View File

@@ -1,11 +1,11 @@
# Gonum BLAS [![Build Status](https://travis-ci.org/gonum/blas.svg?branch=master)](https://travis-ci.org/gonum/blas) [![Coverage Status](https://coveralls.io/repos/gonum/blas/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/blas?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/blas?status.svg)](https://godoc.org/github.com/gonum/blas) # Gonum BLAS [![GoDoc](https://godoc.org/gonum.org/v1/gonum/blas?status.svg)](https://godoc.org/gonum.org/v1/gonum/blas)
A collection of packages to provide BLAS functionality for the [Go programming A collection of packages to provide BLAS functionality for the [Go programming
language](http://golang.org) language](http://golang.org)
## Installation ## Installation
```sh ```sh
go get github.com/gonum/blas go get gonum.org/v1/gonum/blas/...
``` ```
### BLAS C-bindings ### BLAS C-bindings
@@ -23,7 +23,7 @@ environment variable to point to the blas installation. More information can be
Then install the blas/cgo package: Then install the blas/cgo package:
```sh ```sh
CGO_LDFLAGS="-L/path/to/OpenBLAS -lopenblas" go install github.com/gonum/blas/cgo CGO_LDFLAGS="-L/path/to/OpenBLAS -lopenblas" go install gonum.org/v1/netlib/blas
``` ```
For Windows you can download binary packages for OpenBLAS at For Windows you can download binary packages for OpenBLAS at
@@ -32,12 +32,12 @@ For Windows you can download binary packages for OpenBLAS at
If you want to use a different BLAS package such as the Intel MKL you can If you want to use a different BLAS package such as the Intel MKL you can
adjust the `CGO_LDFLAGS` variable: adjust the `CGO_LDFLAGS` variable:
```sh ```sh
CGO_LDFLAGS="-lmkl_rt" go install github.com/gonum/blas/cgo CGO_LDFLAGS="-lmkl_rt" go install gonum.org/v1/netlib/blas
``` ```
On OS X the easiest solution is to use the libraries provided by the system: On OS X the easiest solution is to use the libraries provided by the system:
```sh ```sh
CGO_LDFLAGS="-framework Accelerate" go install github.com/gonum/blas/cgo CGO_LDFLAGS="-framework Accelerate" go install gonum.org/v1/netlib/blas
``` ```
## Packages ## Packages
@@ -47,20 +47,14 @@ On OS X the easiest solution is to use the libraries provided by the system:
Defines [BLAS API](http://www.netlib.org/blas/blast-forum/cinterface.pdf) split in several Defines [BLAS API](http://www.netlib.org/blas/blast-forum/cinterface.pdf) split in several
interfaces. interfaces.
### blas/native ### blas/gonum
Go implementation of the BLAS API (incomplete, implements the `float32` and `float64` API) Go implementation of the BLAS API (incomplete, implements the `float32` and `float64` API).
### blas/cgo
Binding to a C implementation of the cblas interface (e.g. ATLAS, OpenBLAS, Intel MKL)
The recommended (free) option for good performance on both Linux and Darwin is OpenBLAS.
### blas/blas64 and blas/blas32 ### blas/blas64 and blas/blas32
Wrappers for an implementation of the double (i.e., `float64`) and single (`float32`) Wrappers for an implementation of the double (i.e., `float64`) and single (`float32`)
precision real parts of the blas API precision real parts of the BLAS API.
```Go ```Go
package main package main
@@ -68,7 +62,7 @@ package main
import ( import (
"fmt" "fmt"
"github.com/gonum/blas/blas64" "gonum.org/v1/gonum/blas/blas64"
) )
func main() { func main() {
@@ -80,17 +74,6 @@ func main() {
### blas/cblas128 and blas/cblas64 ### blas/cblas128 and blas/cblas64
Wrappers for an implementation of the double (i.e., `complex128`) and single (`complex64`) Wrappers for an implementation of the double (i.e., `complex128`) and single (`complex64`)
precision complex parts of the blas API precision complex parts of the blas API.
Currently blas/cblas64 and blas/cblas128 require blas/cgo. Currently blas/cblas64 and blas/cblas128 require gonum.org/v1/netlib/blas.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker.
Discussions on API changes, added features, code review, or similar requests
are preferred on the [gonum-dev Google Group](https://groups.google.com/forum/#!forum/gonum-dev).
## License
Please see [github.com/gonum/license](https://github.com/gonum/license) for general
license information, contributors, authors, etc on the Gonum suite of packages.

14
diff/README.md
View File

@@ -1,13 +1,3 @@
# Gonum diff [![Build Status](https://travis-ci.org/gonum/diff.svg)](https://travis-ci.org/gonum/diff) [![Coverage Status](https://coveralls.io/repos/gonum/diff/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/diff?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/diff?status.svg)](https://godoc.org/github.com/gonum/diff) # Gonum diff [![GoDoc](https://godoc.org/gonum.org/v1/gonum/diff?status.svg)](https://godoc.org/gonum.org/v1/gonum/diff)
This is a package for computing derivatives of functions for the Go language. Package diff is a package for computing derivatives of functions for the Go language.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

15
floats/README.md
View File

@@ -1,13 +1,4 @@
# Gonum floats [![travis-build-status](https://travis-ci.org/gonum/floats.svg?branch=master)](https://travis-ci.org/gonum/floats) [![Coverage Status](https://coveralls.io/repos/gonum/floats/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/floats?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/floats?status.svg)](https://godoc.org/github.com/gonum/floats) # Gonum floats [![GoDoc](https://godoc.org/gonum.org/v1/gonum/floats?status.svg)](https://godoc.org/gonum.org/v1/gonum/floats)
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. 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.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

16
graph/README.md
View File

@@ -1,15 +1,3 @@
# Gonum Graph [![Build Status](https://travis-ci.org/gonum/graph.svg?branch=master)](https://travis-ci.org/gonum/graph) [![Coverage Status](https://coveralls.io/repos/gonum/graph/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/graph?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/graph?status.svg)](https://godoc.org/github.com/gonum/graph) # Gonum graph [![GoDoc](https://godoc.org/gonum.org/v1/gonum/graph?status.svg)](https://godoc.org/gonum.org/v1/gonum/graph)
This is a generalized graph package for the Go language. It aims to provide a clean, transparent API for common algorithms on arbitrary graphs such as finding the graph's strongly connected components, dominators, or searces. This is a generalized graph package for the Go language.
The package is currently in testing, and the API is "semi-stable". The signatures of any functions like AStar are unlikely to change much, but the Graph, Node, and Edge interfaces may change a bit.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the Gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

12
integrate/README.md
View File

@@ -1,13 +1,3 @@
# Gonum integrate [![Build Status](https://travis-ci.org/gonum/integrate.svg?branch=master)](https://travis-ci.org/gonum/integrate) [![Coverage Status](https://coveralls.io/repos/gonum/integrate/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/integrate?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/integrate?status.svg)](https://godoc.org/github.com/gonum/integrate) # Gonum integrate [![GoDoc](https://godoc.org/gonum.org/v1/gonum/integrate?status.svg)](https://godoc.org/gonum.org/v1/gonum/integrate)
Package integrate provides numerical evaluation of definite integrals of single-variable functions for the Go programming language. Package integrate provides numerical evaluation of definite integrals of single-variable functions for the Go programming language.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see https://github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

12
internal/README.md
View File

@@ -1,13 +1,3 @@
# Gonum Internal [![Build Status](https://travis-ci.org/gonum/internal.svg?branch=master)](https://travis-ci.org/gonum/internal) [![Coverage Status](https://coveralls.io/repos/gonum/internal/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/internal?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/internal?status.svg)](https://godoc.org/github.com/gonum/internal) # Gonum internal [![GoDoc](https://godoc.org/gonum.org/v1/gonum/internal?status.svg)](https://godoc.org/gonum.org/v1/gonum/internal)
This is the set of internal packages for the Gonum project. This is the set of internal packages for the Gonum project.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see [github.com/gonum/license](https://github.com/gonum/license) for general license information, contributors, authors, etc on the Gonum suite of packages.

26
lapack/README.md
View File

@@ -1,4 +1,4 @@
Gonum LAPACK [![Build Status](https://travis-ci.org/gonum/lapack.svg?branch=master)](https://travis-ci.org/gonum/lapack) [![Coverage Status](https://coveralls.io/repos/gonum/lapack/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/lapack?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/lapack?status.svg)](https://godoc.org/github.com/gonum/lapack) Gonum LAPACK [![GoDoc](https://godoc.org/gonum.org/v1/gonum/lapack?status.svg)](https://godoc.org/gonum.org/v1/gonum/lapack)
====== ======
A collection of packages to provide LAPACK functionality for the Go programming A collection of packages to provide LAPACK functionality for the Go programming
@@ -8,7 +8,7 @@ and a wrapper using cgo to a c-based implementation.
## Installation ## Installation
``` ```
go get github.com/gonum/lapack go get gonum.org/v1/gonum/lapack/...
``` ```
@@ -21,7 +21,7 @@ Install OpenBLAS:
Then install the lapack/cgo package: Then install the lapack/cgo package:
```sh ```sh
CGO_LDFLAGS="-L/path/to/OpenBLAS -lopenblas" go install github.com/gonum/lapack/cgo CGO_LDFLAGS="-L/path/to/OpenBLAS -lopenblas" go install gonum.org/v1/netlib/lapack
``` ```
For Windows you can download binary packages for OpenBLAS at For Windows you can download binary packages for OpenBLAS at
@@ -30,7 +30,7 @@ http://sourceforge.net/projects/openblas/files/
If you want to use a different BLAS package such as the Intel MKL you can If you want to use a different BLAS package such as the Intel MKL you can
adjust the `CGO_LDFLAGS` variable: adjust the `CGO_LDFLAGS` variable:
```sh ```sh
CGO_LDFLAGS="-lmkl_rt" go install github.com/gonum/lapack/cgo CGO_LDFLAGS="-lmkl_rt" go install gonum.org/v1/netlib/lapack
``` ```
## Packages ## Packages
@@ -39,20 +39,12 @@ adjust the `CGO_LDFLAGS` variable:
Defines the LAPACK API based on http://www.netlib.org/lapack/lapacke.html Defines the LAPACK API based on http://www.netlib.org/lapack/lapacke.html
### lapack/lapacke ### lapack/gonum
Binding to a C implementation of the lapacke interface (e.g. OpenBLAS or intel MKL) Go implementation of the LAPACK API (incomplete, implements the `float64` API).
The linker flags (i.e. path to the BLAS library and library name) might have to be adapted. ### lapack/lapack64
The recommended (free) option for good performance on both linux and darwin is OpenBLAS. Wrappers for an implementation of the double (i.e., `float64`) precision real parts of
the LAPACK API.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

14
mat/README.md
View File

@@ -1,13 +1,3 @@
# Gonum Matrix [![Build Status](https://travis-ci.org/gonum/matrix.svg?branch=master)](https://travis-ci.org/gonum/matrix) [![Coverage Status](https://coveralls.io/repos/gonum/matrix/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/matrix?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/matrix?status.svg)](https://godoc.org/github.com/gonum/matrix) # Gonum matrix [![GoDoc](https://godoc.org/gonum.org/v1/gonum/matrix?status.svg)](https://godoc.org/gonum.org/v1/gonum/matrix)
This is a matrix package for the Go language. Package matrix is a matrix package for the Go language.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

5
mathext/README.md
View File

@@ -1,2 +1,3 @@
# mathext [![Build Status](https://travis-ci.org/gonum/mathext.svg?branch=master)](https://travis-ci.org/gonum/mathext) [![Coverage Status](https://coveralls.io/repos/github/gonum/mathext/badge.svg?branch=master)](https://coveralls.io/github/gonum/mathext?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/mathext?status.svg)](https://godoc.org/github.com/gonum/mathext) # mathext [![GoDoc](https://godoc.org/gonum.org/v1/gonum/mathext?status.svg)](https://godoc.org/gonum.org/v1/gonum/mathext)
mathext implements basic elementary functions not included in the Go standard library
Package mathext implements basic elementary functions not included in the Go standard library.

14
optimize/README.md
View File

@@ -1,13 +1,3 @@
# Gonum Optimize [![Build Status](https://travis-ci.org/gonum/optimize.svg?branch=master)](https://travis-ci.org/gonum/optimize) [![Coverage Status](https://coveralls.io/repos/gonum/optimize/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/optimize?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/optimize?status.svg)](https://godoc.org/github.com/gonum/optimize) # Gonum optimize [![GoDoc](https://godoc.org/gonum.org/v1/gonum/optimize?status.svg)](https://godoc.org/gonum.org/v1/gonum/optimize)
This is an optimization package for the Go language. More documentation can be seen at godoc.org/github.com/gonum/optimize Package optimize is an optimization package for the Go language.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.

14
stat/README.md
View File

@@ -1,13 +1,3 @@
# Gonum Stat [![Build Status](https://travis-ci.org/gonum/stat.svg?branch=master)](https://travis-ci.org/gonum/stat) [![Coverage Status](https://coveralls.io/repos/gonum/stat/badge.svg?branch=master&service=github)](https://coveralls.io/github/gonum/stat?branch=master) [![GoDoc](https://godoc.org/github.com/gonum/stat?status.svg)](https://godoc.org/github.com/gonum/stat) # Gonum stat [![GoDoc](https://godoc.org/gonum.org/v1/gonum/stat?status.svg)](https://godoc.org/gonum.org/v1/gonum/stat)
This is a statistics package for the Go language. Package stat is a statistics package for the Go language.
## Issues
If you find any bugs, feel free to file an issue on the github issue tracker. Discussions on API changes, added features, code review, or similar requests are preferred on the gonum-dev Google Group.
https://groups.google.com/forum/#!forum/gonum-dev
## License
Please see github.com/gonum/license for general license information, contributors, authors, etc on the Gonum suite of packages.