LAPACK  3.5.0
LAPACK: Linear Algebra PACKage
 All Classes Files Functions Variables Typedefs Macros
README
Go to the documentation of this file.
1  ===============
2  = README File =
3  ===============
4 
5 This README File is for the LAPACK driver variants.
6 It is composed of 5 sections:
7  - Description: contents a quick description of each of the variants. For a more detailed description please refer to LAWN XXX.
8  - Build
9  - Testing
10  - Linking your program
11  - Support
12 
13 Author: Peng DU and Julie LANGOU, May 2008
14 
15 ===============
16 = DESCRIPTION =
17 ===============
18 
19 This directory contains several variants of LAPACK routines in single/double/complex/double complex precision:
20  - [sdcz]getrf with LU Crout Level 3 BLAS version algorithm [2]- Directory: SRC/VARIANTS/lu/CR
21  - [sdcz]getrf with LU Left Looking Level 3 BLAS version algorithm [2]- Directory: SRC/VARIANTS/lu/LL
22  - [sdcz]getrf with Sivan Toledo's recursive LU algorithm [1] - Directory: SRC/VARIANTS/lu/REC
23  - [sdcz]geqrf with QR Left Looking Level 3 BLAS version algorithm [2]- Directory: SRC/VARIANTS/qr/LL
24  - [sdcz]potrf with Cholesky Right Looking Level 3 BLAS version algorithm [2]- Directory: SRC/VARIANTS/cholesky/RL
25  - [sdcz]potrf with Cholesky Top Level 3 BLAS version algorithm [2]- Directory: SRC/VARIANTS/cholesky/TOP
26 
27 References:For a more detailed description please refer to
28  - [1] Toledo, S. 1997. Locality of Reference in LU Decomposition with Partial Pivoting. SIAM J. Matrix Anal. Appl. 18, 4 (Oct. 1997),
29  1065-1081. http://dx.doi.org/10.1137/S0895479896297744
30  - [2]LAWN XXX
31 
32 =========
33 = BUILD =
34 =========
35 
36 These variants are compiled by default in the build process but they are not tested by default.
37 The build process creates one new library per variants in the four arithmetics (singel/double/comple/double complex).
38 The libraries are in the SRC/VARIANTS/LIB directory.
39 
40 Corresponding libraries created in SRC/VARIANTS/LIB:
41  - LU Crout : lucr.a
42  - LU Left Looking : lull.a
43  - LU Sivan Toledo's recursive : lurec.a
44  - QR Left Looking : qrll.a
45  - Cholesky Right Looking : cholrl.a
46  - Cholesky Top : choltop.a
47 
48 
49 ===========
50 = TESTING =
51 ===========
52 
53 To test these variants you can type 'make variants-testing'
54 This will rerun the linear methods testings once per variants and append the short name of the variants to the output files.
55 You should then see the following files in the TESTING directory:
56 [scdz]test_cholrl.out
57 [scdz]test_choltop.out
58 [scdz]test_lucr.out
59 [scdz]test_lull.out
60 [scdz]test_lurec.out
61 [scdz]test_qrll.out
62 
63 ========================
64 = LINKING YOUR PROGRAM =
65 ========================
66 
67 You just need to add the variants methods library in your linking sequence before your lapack libary.
68 Here is a quick example for LU
69 
70 Default using LU Right Looking version:
71  $(FORTRAN) -c myprog.f
72  $(FORTRAN) -o myexe myprog.o $(LAPACKLIB) $(BLASLIB)
73 
74 Using LU Left Looking version:
75  $(FORTRAN) -c myprog.f
76  $(FORTRAN) -o myexe myprog.o $(PATH TO LAPACK/SRC/VARIANTS/LIB)/lull.a $(LAPACKLIB) $(BLASLIB)
77 
78 ===========
79 = SUPPORT =
80 ===========
81 
82 You can use either LAPACK forum or the LAPACK mailing list to get support.
83 LAPACK forum : http://icl.cs.utk.edu/lapack-forum
84 LAPACK mailing list : lapack@cs.utk.edu