github.com/gonum/lapack@v0.0.0-20181123203213-e4cdc5a0bff9/native/doc.go (about)

     1  // Copyright ©2015 The gonum Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // This repository is no longer maintained.
     6  // Development has moved to https://github.com/gonum/gonum.
     7  //
     8  // Package native is a pure-go implementation of the LAPACK API. The LAPACK API defines
     9  // a set of algorithms for advanced matrix operations.
    10  //
    11  // The function definitions and implementations follow that of the netlib reference
    12  // implementation. Please see http://www.netlib.org/lapack/explore-html/ for more
    13  // information, and http://www.netlib.org/lapack/explore-html/d4/de1/_l_i_c_e_n_s_e_source.html
    14  // for more license information.
    15  //
    16  // Slice function arguments frequently represent vectors and matrices. The data
    17  // layout is identical to that found in https://godoc.org/github.com/gonum/blas/native.
    18  //
    19  // Most LAPACK functions are built on top the routines defined in the BLAS API,
    20  // and as such the computation time for many LAPACK functions is
    21  // dominated by BLAS calls. Here, BLAS is accessed through the
    22  // the blas64 package (https://godoc.org/github.com/gonum/blas/blas64). In particular,
    23  // this implies that an external BLAS library will be used if it is
    24  // registered in blas64.
    25  //
    26  // The full LAPACK capability has not been implemented at present. The full
    27  // API is very large, containing approximately 200 functions for double precision
    28  // alone. Future additions will be focused on supporting the gonum matrix
    29  // package (https://godoc.org/github.com/gonum/matrix/mat64), though pull requests
    30  // with implementations and tests for LAPACK function are encouraged.
    31  package native