← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/suitesparse/oneiric

« back to all changes in this revision

Viewing changes to KLU/README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Nick Ellery
  • Date: 2009-06-14 19:15:52 UTC
  • mfrom: (7.2.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090614191552-2hliya5q8n1quseu
Tags: 1:3.4.0-1ubuntu1
https://launchpad.net/bugs/387137
* Merge from debian unstable, remaining changes (LP: #387137):
  - debian/control:
    - demote libatlas-doc from recommends to suggests as it is not in main
    - drop recommends on doc-central as it is not in main

Show diffs side-by-side

added added

removed removed

Lines of Context:
KLU/README.txt
1
 
KLU Version 1.0, May 31, 2007, by Timothy A. Davis and Ekanathan Palamadai.
2
 
Copyright (C) 2004-2007, University of Florida
 
1
KLU Version 1.1, March 24, 2009, by Timothy A. Davis and Ekanathan Palamadai.
 
2
Copyright (C) 2004-2009, University of Florida
3
3
KLU is also available under other licenses; contact authors for details.
4
4
http://www.cise.ufl.edu/research/sparse
5
5
 
6
6
Requires the AMD, COLAMD, and BTF libraries, in ../AMD, ../COLAMD, and ../BTF,
7
7
respectively.  Requires the ../UFconfig/UFconfig.mk configuration file.
8
8
Optionally uses CHOLMOD (KLU/User example ordering).  The Tcov tests and
9
 
the Demo both require CHOLMOD.
 
9
the one of the programs in the Demo require CHOLMOD.
10
10
 
11
11
To compile the libklu.a library, type "make".  The compiled library is located
12
12
in KLU/Lib/libklu.a.  Compile code that uses KLU with -IKLU/Include.
 
13
To compile a simple demo (without CHOLMOD), cd to the Demo directory and
 
14
type "make klu_simple".
13
15
 
14
16
Type "make clean" to remove all but the compiled library, and "make distclean"
15
17
to remove all files not in the original distribution.
36
38
 
37
39
Files in this distribution:
38
40
 
39
 
    Demo                example programs that use KLU (requires CHOLMOD)
40
 
    Doc                 documentation
41
 
    Include             include files
42
 
    Lib                 compiled library
43
 
    Makefile            top-level Makefile
44
 
    MATLAB              MATLAB interface
45
 
    Matrix              test matrices
46
 
    README.txt          this file
47
 
    Source              source code
48
 
    Tcov                exhaustive test of KLU and BTF
49
 
    User                example user ordering function (interface to CHOLMOD)
 
41
    Demo                example programs that use KLU (requires CHOLMOD)
 
42
    Doc                 documentation
 
43
    Include             include files
 
44
    Lib                 compiled library
 
45
    Makefile            top-level Makefile
 
46
    MATLAB              MATLAB interface
 
47
    Matrix              test matrices
 
48
    README.txt          this file
 
49
    Source              source code
 
50
    Tcov                exhaustive test of KLU and BTF
 
51
    User                example user ordering function (interface to CHOLMOD)
50
52
 
51
53
./Demo:
52
 
    kludemo.c           KLU demo (int version)
53
 
    kludemo.out         output of "make" in this directory
54
 
    kluldemo.c          KLU demo (UF_long version)
55
 
    Makefile            Makefile for compiling the demo
 
54
    klu_simple.c        a simple demo (does not require CHOLMOD)
 
55
                        compile with "make klu_simple"
 
56
    klu_simple.out      output of klu_simple
 
57
    kludemo.c           KLU demo (int version)
 
58
    kludemo.out         output of "make" in this directory
 
59
    kluldemo.c          KLU demo (UF_long version)
 
60
    Makefile            Makefile for compiling the demo
56
61
 
57
62
./Doc:
58
63
    ChangeLog
59
 
    KLU_UserGuide.bib   Bibiography
60
 
    KLU_UserGuide.pdf   PDF version of KLU User Guide
61
 
    KLU_UserGuide.tex   TEX source of KLU User Guide
62
 
    lesser.txt          license (LGPL)
63
 
    Makefile            Makefile for creating the User Guide
64
 
    palamadai_e.pdf     Eka Palamadai's MS thesis
 
64
    KLU_UserGuide.bib   Bibiography
 
65
    KLU_UserGuide.pdf   PDF version of KLU User Guide
 
66
    KLU_UserGuide.tex   TEX source of KLU User Guide
 
67
    lesser.txt          license (LGPL)
 
68
    Makefile            Makefile for creating the User Guide
 
69
    palamadai_e.pdf     Eka Palamadai's MS thesis
65
70
 
66
71
./Include:
67
 
    klu.h               user include file
68
 
    klu_internal.h      internal include file, not needed by the user
69
 
    klu_version.h       internal include file, not needed by the user
 
72
    klu.h               user include file
 
73
    klu_internal.h      internal include file, not needed by the user
 
74
    klu_version.h       internal include file, not needed by the user
70
75
 
71
76
./Lib:
72
 
    Makefile            Makefile for compiling the KLU C-callable library
 
77
    Makefile            Makefile for compiling the KLU C-callable library
 
78
                        (with or without CHOLMOD)
73
79
 
74
80
./MATLAB:
75
 
    Contents.m          list of MATLAB functions in KLU
76
 
    klu_demo.m          MATLAB demo
77
 
    klu_demo.m.out      output of MATLAB demo
78
 
    klu_install.m       compiles and installs KLU for use in MATLAB, runs demo
79
 
    klu.m               MATLAB help for KLU
80
 
    klu_make.m          compiles KLU for use in MATLAB
81
 
    klu_mex.c           MATLAB mexFunction interface for KLU
82
 
    Makefile            Makefile for KLU mexFunction, with CHOLMOD
83
 
    Makefile_no_CHOLMOD Makefile for KLU mexFunction, without CHOLMOD
84
 
    Test                MATLAB tests
 
81
    Contents.m          list of MATLAB functions in KLU
 
82
    klu_demo.m          MATLAB demo
 
83
    klu_demo.m.out      output of MATLAB demo (with CHOLMOD)
 
84
    klu_install.m       compiles and installs KLU for use in MATLAB, runs demo
 
85
    klu.m               MATLAB help for KLU
 
86
    klu_make.m          compiles KLU for use in MATLAB
 
87
    klu_mex.c           MATLAB mexFunction interface for KLU
 
88
    Makefile            Makefile for KLU mexFunction, with CHOLMOD
 
89
    Makefile_no_CHOLMOD Makefile for KLU mexFunction, without CHOLMOD
 
90
    Test                MATLAB tests
85
91
 
86
 
./MATLAB/Test:          KLU tests, requires UFget
87
 
    test1.m             
 
92
./MATLAB/Test:          KLU tests, requires UFget
 
93
    test1.m             
88
94
    test2.m
89
95
    test3.m
90
96
    test4.m
91
97
    test5.m
92
98
 
93
 
./Matrix:               test matrices for programs in ./Demo and ./Tcov
 
99
./Matrix:               test matrices for programs in ./Demo and ./Tcov
94
100
    1c.mtx
95
101
    arrowc.mtx
96
102
    arrow.mtx
103
109
    w156.mtx
104
110
 
105
111
./Source:
106
 
    klu_analyze.c       klu_analyze and supporting functions
107
 
    klu_analyze_given.c klu_analyze_given and supporting functions
108
 
    klu.c               kernel factor/solve functions, not user-callable
109
 
    klu_defaults.c      klu_defaults function
110
 
    klu_diagnostics.c   klu_rcond, klu_condest, klu_rgrowth, kluflops
111
 
    klu_dump.c          debugging functions
112
 
    klu_extract.c       klu_extract
113
 
    klu_factor.c        klu_factor and supporting functions
114
 
    klu_free_numeric.c  klu_free_numeric function
115
 
    klu_free_symbolic.c klu_free_symbolic function
116
 
    klu_kernel.c        kernel factor functions, not user-callable
117
 
    klu_memory.c        klu_malloc, klu_free, klu_realloc, and supporing func.
118
 
    klu_refactor.c      klu_refactor function
119
 
    klu_scale.c         klu_scale function
120
 
    klu_solve.c         klu_solve function
121
 
    klu_sort.c          klu_sort and supporting functions
122
 
    klu_tsolve.c        klu_tsovle function
 
112
    klu_analyze.c       klu_analyze and supporting functions
 
113
    klu_analyze_given.c klu_analyze_given and supporting functions
 
114
    klu.c               kernel factor/solve functions, not user-callable
 
115
    klu_defaults.c      klu_defaults function
 
116
    klu_diagnostics.c   klu_rcond, klu_condest, klu_rgrowth, kluflops
 
117
    klu_dump.c          debugging functions
 
118
    klu_extract.c       klu_extract
 
119
    klu_factor.c        klu_factor and supporting functions
 
120
    klu_free_numeric.c  klu_free_numeric function
 
121
    klu_free_symbolic.c klu_free_symbolic function
 
122
    klu_kernel.c        kernel factor functions, not user-callable
 
123
    klu_memory.c        klu_malloc, klu_free, klu_realloc, and supporing func.
 
124
    klu_refactor.c      klu_refactor function
 
125
    klu_scale.c         klu_scale function
 
126
    klu_solve.c         klu_solve function
 
127
    klu_sort.c          klu_sort and supporting functions
 
128
    klu_tsolve.c        klu_tsovle function
123
129
 
124
 
./Tcov:                 exhaustive test suite; requires Linux/Unix
125
 
    coverage            determine statement coverage
126
 
    klultests           KLU UF_long tests
127
 
    klutest.c           KLU test program
128
 
    klutests            KLU int tests
129
 
    Makefile            Makefile for compiling and running the tests
130
 
    README.txt          README file for Tcov
131
 
    vklutests           KLU int tests, using valgrind
132
 
    vklultests          KLU UF_long tests, using valgrind
 
130
./Tcov:                 exhaustive test suite; requires Linux/Unix
 
131
    coverage            determine statement coverage
 
132
    klultests           KLU UF_long tests
 
133
    klutest.c           KLU test program
 
134
    klutests            KLU int tests
 
135
    Makefile            Makefile for compiling and running the tests
 
136
    README.txt          README file for Tcov
 
137
    vklutests           KLU int tests, using valgrind
 
138
    vklultests          KLU UF_long tests, using valgrind
133
139
 
134
140
./User:
135
 
    klu_cholmod.c       sample KLU user ordering function (int version)
136
 
    klu_cholmod.h       include file for klu_cholmod and klu_l_cholmod
137
 
    klu_l_cholmod.c     sample KLU user ordering function (UF_long version) 
138
 
    Makefile            Makefile for compiling the user ordering functions
139
 
    README.txt          README for User directory
 
141
    klu_cholmod.c       sample KLU user ordering function (int version)
 
142
    klu_cholmod.h       include file for klu_cholmod and klu_l_cholmod
 
143
    klu_l_cholmod.c     sample KLU user ordering function (UF_long version) 
 
144
    Makefile            Makefile for compiling the user ordering functions
 
145
    README.txt          README for User directory