README 3.0 KB

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