lapack-netlib/README.md

   1 # LAPACK
   2
   3 [![Build Status](https://travis-ci.org/Reference-LAPACK/lapack.svg?branch=master)](https://travis-ci.org/Reference-LAPACK/lapack)
   4
   5 * VERSION 1.0   :  February 29, 1992
   6 * VERSION 1.0a  :  June 30, 1992
   7 * VERSION 1.0b  :  October 31, 1992
   8 * VERSION 1.1   :  March 31, 1993
   9 * VERSION 2.0   :  September 30, 1994
  10 * VERSION 3.0   :  June 30, 1999
  11 * VERSION 3.0 + update :  October 31, 1999
  12 * VERSION 3.0 + update :  May 31, 2000
  13 * VERSION 3.1   : November 2006
  14 * VERSION 3.1.1 : February 2007
  15 * VERSION 3.2   : November 2008
  16 * VERSION 3.2.1 : April 2009
  17 * VERSION 3.2.2 : June 2010
  18 * VERSION 3.3.0 : November 2010
  19 * VERSION 3.3.1 : April 2011
  20 * VERSION 3.4.0 : November 2011
  21 * VERSION 3.4.1 : April 2012
  22 * VERSION 3.4.2 : September 2012
  23 * VERSION 3.5.0 : November 2013
  24 * VERSION 3.6.0 : November 2015
  25 * VERSION 3.6.1 : June 2016
  26 * VERSION 3.7.0 : December 2016
  27
  28 LAPACK is a library of Fortran 90 with subroutines for solving
  29 the most commonly occurring problems in numerical linear algebra.
  30 It is freely-available software, and is copyrighted.
  31
  32 LAPACK is available on netlib and can be obtained via the World Wide
  33 Web and anonymous ftp.
  34
  35    http://www.netlib.org/lapack/
  36
  37 The distribution tar file contains the Fortran source for LAPACK and the
  38 testing programs.  It also contains the Fortran77
  39 reference implementation of the Basic Linear Algebra Subprograms
  40 (the Level 1, 2, and 3 BLAS) needed by LAPACK.  However this code is
  41 intended for use only if there is no other implementation of the BLAS
  42 already available on your machine; the efficiency of LAPACK depends
  43 very much on the efficiency of the BLAS.
  44
  45 ## Installation
  46
  47  - LAPACK can be installed with `make`. Configuration have to be set in the
  48    `make.inc` file. A `make.inc.example` for a Linux machine running GNU compilers
  49    is given in the main directory. Some specific `make.inc` are also available in
  50    the `INSTALL` directory.
  51  - LAPACK includes also the CMake build. You will need to have CMake installed
  52    on your machine (CMake is available at http://www.cmake.org/). CMake will
  53    allow an easy installation on a Windows Machine.
  54  - Specific information to run LAPACK under Windows are available at
  55    http://icl.cs.utk.edu/lapack-for-windows/lapack/.
  56
  57  For further information on LAPACK please read our FAQ at
  58  http://www.netlib.org/lapack/#_faq
  59  A User forum is also available to help you with the LAPACK library at
  60  http://icl.cs.utk.edu/lapack-forum/
  61
  62
  63 ## User Support
  64
  65 LAPACK has been thoroughly tested, on many different
  66 types of computers.  The LAPACK project supports the package in the
  67 sense that reports of errors or poor performance will gain immediate
  68 attention from the developers. Such reports, descriptions
  69 of interesting applications, and other comments should be sent by
  70 electronic mail to lapack@cs.utk.edu.
  71
  72 A list of known problems, bugs, and compiler errors for LAPACK is
  73 maintained on netlib.
  74  * http://www.netlib.org/lapack/release_notes.html
  75
  76 A User forum is also available to help you with the LAPACK library at
  77  http://icl.cs.utk.edu/lapack-forum/.
  78 You can also contact directly the LAPACK team at lapack@cs.utk.edu.
  79
  80
  81 ## Testing
  82
  83 The complete package, including test code in four
  84 different Fortran data types (real, complex, double precision, double
  85 complex), contains some 805,000 lines of Fortran source and comments.
  86 You will need approximately 33 Mbytes to read the complete tape.
  87 We recommend that you run the testing.  The total
  88 space requirements for the testing for all four data
  89 types, including the object files, is approximately 80 Mbytes.
  90
  91 A README file containing the information in this letter is located
  92 in the LAPACK directory. Postscript and LaTeX versions of the Quick
  93 Installation Guide are in the `LAPACK/INSTALL` directory, in the files
  94 `lawn81.tex`, `psfig.tex`, `lawn81.ps`, and `org2.ps`.  Consult the Installation
  95 Guide for further details on installing the package and on what is contained
  96 in each subdirectory.  For complete information on the LAPACK Testing
  97 please consult LAPACK Working Note 41 "Installation
  98 Guide for LAPACK".
  99
 100
 101 ## User Guide
 102
 103 It is highly recommended that you obtain a copy of the Third Edition of
 104 the LAPACK Users' Guide published by SIAM in Winter, 1999.  This Users'
 105 Guide gives a detailed description of the philosophy behind LAPACK as well
 106 as an explanation of its usage.  The LAPACK Users' Guide can be purchased from:
 107 SIAM; Customer Service; P. O. Box 7260; Philadelphia, PA 19104;
 108 215-382-9800, FAX 215-386-7999.  It will also be available from booksellers.
 109
 110 To order by email, send email to service@siam.org.  The book is also
 111 available via SIAM's World Wide Web URL at http://www.siam.org.  The
 112 ISBN number is 0-89871-447-8, and SIAM order code is SE09.  The list
 113 price for SIAM members is $31.20; the cost for nonmembers is $39.00.
 114
 115 To view an HTML version of the Users' Guide please refer to the URL
 116
 117   http://www.netlib.org/lapack/lug/lapack_lug.html.
 118
 119 ## LAPACKE
 120 LAPACK now includes the LAPACKE package
 121 LAPACKE is a Standard C language APIs for LAPACK
 122 http://www.netlib.org/lapack/#_standard_c_language_apis_for_lapack
 123 collaboration LAPACK and INTEL Math Kernel Library
 124
 125 Documentation available in the DOCS folder
 126
 127 ## Related Projects
 128
 129 The Fortran95 interface to LAPACK is available, as well as an f2c'ed
 130 version of LAPACK, and a C++ version of a subset of LAPACK routines.
 131 Refer to the following URLs on netlib for further information:
 132
 133  * http://www.netlib.org/lapack95/
 134  * http://www.netlib.org/clapack/
 135  * http://www.netlib.org/lapack++/
 136  * http://www.cs.utk.edu/java/f2j/
 137
 138 Or, for more information on the distributed-memory version of LAPACK,
 139 consult the ScaLAPACK index on netlib:
 140
 141   http://www.netlib.org/scalapack/
 142
 143
 144 ## Working Notes
 145
 146 A number of technical reports were written during the development of
 147 LAPACK and published as LAPACK Working Notes, initially by Argonne
 148 National Laboratory and later by the University of Tennessee.  Many of
 149 these reports later appeared as journal articles.  Most of these working
 150 notes are available in pdf and postscript form from netlib.
 151   * http://www.netlib.org/lapack/lawns/
 152   * http://www.netlib.org/lapack/lawnspdf/
 153 Otherwise, requests for copies of these working notes can be sent to
 154 the following address.
 155
 156 LAPACK Project, c/o J.J. Dongarra, Computer Science Department, University of Tennessee, Knoxville, Tennessee 37996-1301, USA, Email: lapack@cs.utk.edu.