Mercurial > octave-nkf

comparison liboctave/UMFPACK/AMD/README.txt @ 5164:57077d0ddc8e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2005-02-25 19:55:24 by jwe]
author jwe
date Fri, 25 Feb 2005 19:55:28 +0000
parents
children
comparison
equal deleted inserted replaced
5163:9f3299378193 5164:57077d0ddc8e
1 AMD version 1.1: a set of routines for permuting sparse matrices prior to
2 factorization. Includes a version in C, a version in Fortran, and a MATLAB
3 mexFunction.
4
5 Quick start (Unix, or Windows with Cygwin):
6
7 To compile, test, and install AMD, you may wish to first configure the
8 installation by editting the AMD/Make/Make.include file. Next, cd to this
9 directory (AMD) and type "make" (or "make lib" if you do not have MATLAB).
10 To compile and run a demo program for the Fortran version, type
11 "make fortran". When done, type "make clean" to remove unused *.o files
12 (keeps the compiled libraries and demo programs). See the User Guide
13 (Doc/AMD_UserGuide.pdf), or AMD/Make/Make.include, for more details.
14
15 Quick start (for MATLAB users);
16
17 To compile, test, and install the AMD mexFunction, cd to the
18 AMD/MATLAB directory and type amd_make at the MATLAB prompt.
19 This works on any system supported by MATLAB.
20
21 -------------------------------------------------------------------------------
22
23 AMD Version 1.1 (Jan. 21, 2004), Copyright (c) 2004 by Timothy A.
24 Davis, Patrick R. Amestoy, and Iain S. Duff. All Rights Reserved.
25
26 AMD License:
27
28 Your use or distribution of AMD or any modified version of
29 AMD implies that you agree to this License.
30
31 THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY
32 EXPRESSED OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
33
34 Permission is hereby granted to use or copy this program, provided
35 that the Copyright, this License, and the Availability of the original
36 version is retained on all copies. User documentation of any code that
37 uses AMD or any modified version of AMD code must cite the
38 Copyright, this License, the Availability note, and "Used by permission."
39 Permission to modify the code and to distribute modified code is granted,
40 provided the Copyright, this License, and the Availability note are
41 retained, and a notice that the code was modified is included. This
42 software was developed with support from the National Science Foundation,
43 and is provided to you free of charge.
44
45 Availability:
46
47 http://www.cise.ufl.edu/research/sparse/amd
48
49 -------------------------------------------------------------------------------
50
51 This is the AMD Version 1.1 README file. It is a terse overview of AMD.
52 Refer to the User Guide (Doc/AMD_UserGuide.pdf) for how to install and use AMD.
53
54 Description:
55
56 AMD is a set of routines for pre-ordering sparse matrices prior to Cholesky
57 or LU factorization, using the approximate minimum degree ordering
58 algorithm. Written in ANSI/ISO C with a MATLAB interface, and in
59 Fortran 77.
60
61 Authors:
62
63 Timothy A. Davis (davis@cise.ufl.edu), University of Florida.
64 Patrick R. Amestory, ENSEEIHT, Toulouse, France.
65 Iain S. Duff, Rutherford Appleton Laboratory, UK.
66
67 Acknowledgements:
68
69 This work was supported by the National Science Foundation, under
70 grants DMS-9504974, DMS-9803599, and CCR-0203270.
71
72 Portions of this work were done while on sabbatical at Stanford University
73 and Lawrence Berkeley National Laboratory (with funding from the SciDAC
74 program). I would like to thank Gene Golub, Esmond Ng, and Horst Simon
75 for making this sabbatical possible.
76
77 -------------------------------------------------------------------------------
78 Files and directories in the AMD v1.0 distribution:
79 -------------------------------------------------------------------------------
80
81 ---------------------------------------------------------------------------
82 Subdirectories of the AMD directory:
83 ---------------------------------------------------------------------------
84
85 Doc documentation
86 Make for compiling AMD
87 Source primary source code
88 Include include file for use in your code that calls AMD
89 Demo demo programs. also serves as test of the AMD installation.
90 MATLAB AMD mexFunction for MATLAB, and supporting m-files
91 Lib where the compiled C-callable and Fortran-callable
92 AMD libraries placed.
93
94 ---------------------------------------------------------------------------
95 Files in the AMD directory:
96 ---------------------------------------------------------------------------
97
98 Makefile top-level Makefile for GNU make or original make.
99 Windows users would require Cygwin to use "make"
100
101 README this file
102
103 ---------------------------------------------------------------------------
104 Doc directory: documentation
105 ---------------------------------------------------------------------------
106
107 ChangeLog change log
108 License the AMD License
109 Makefile for creating the documentation
110 AMD_UserGuide.bib AMD User Guide (references)
111 AMD_UserGuide.tex AMD User Guide (LaTeX)
112 AMD_UserGuide.pdf AmD User Guide (PDF)
113
114 ---------------------------------------------------------------------------
115 Make directory: for compiling AMD (Lib/libamd.a and Lib/libamdf77.a)
116 ---------------------------------------------------------------------------
117
118 Make.include overall configurations. Can use one of:
119 Make.alpha Makefile additions for Compaq Alpha
120 Make.linux Makefile additions for Linux
121 Make.rs6000 Makefile additions for RS 6000
122 Make.sgi Makefile additions for SGI
123 Make.solaris Makefile additions for Solaris
124
125 ---------------------------------------------------------------------------
126 Source directory:
127 ---------------------------------------------------------------------------
128
129 GNUmakefile a nice Makefile, for GNU make
130 Makefile an ugly Unix Makefile (for older make's)
131
132 amd_order.c user-callable, primary AMD ordering routine
133 amd_control.c user-callable, prints the control parameters
134 amd_defaults.c user-callable, sets default control parameters
135 amd_info.c user-callable, prints the statistics from AMD
136
137 amd_1.c non-user-callable, construct A+A'
138 amd_2.c non-user-callable, primary ordering kernel
139 (a C version of amd.f and amdbar.f, with
140 post-ordering added)
141 amd_aat.c non-user-callable, computes nnz (A+A')
142 amd_dump.c non-user-callable, debugging routines
143 amd_internal.h non-user-callable, include file for AMD
144 amd_mex.c non-user-callable, MATLAB mexFunction
145 amd_postorder.c non-user-callable, postorder
146 amd_post_tree.c non-user-callable, postorder just one tree
147 amd_valid.c non-user-callable, verifies a matrix
148
149 amd.f user-callable Fortran 77 version
150 amdbar.f user-callable Fortran 77 version
151
152 ---------------------------------------------------------------------------
153 Include directory:
154 ---------------------------------------------------------------------------
155
156 amd.h include file for C programs that use AMD
157
158 ---------------------------------------------------------------------------
159 Demo directory:
160 ---------------------------------------------------------------------------
161
162 Makefile for GNU make or original make
163
164 amd_demo.c C demo program for AMD
165 amd_demo.out output of amd_demo.c
166
167 amd_simple.c simple C demo program for AMD
168 amd_simple.out output of amd_simple.c
169
170 amd_f77demo.f Fortran 77 demo program for AMD
171 amd_f77demo.out output of amd_f77demo.f
172
173 amd_f77simple.c simple Fortran 77 demo program for AMD
174 amd_f77simple.out output of amd_f77simple.f
175
176 amd_f77cross.f Fortran 77 demo, calls the C version of AMD
177 amd_f77cross.out output of amd_f77cross.f
178 amd_f77wrapper.c Fortran-callable wrapper for C version of AMD
179
180 ---------------------------------------------------------------------------
181 MATLAB directory:
182 ---------------------------------------------------------------------------
183
184 GNUmakefile a nice Makefile, for GNU make
185 Makefile an ugly Unix Makefile (for older make's)
186
187 Contents.m for "help amd" listing of toolbox contents
188
189 amd.m MATLAB help file for AMD
190 amd_make.m MATLAB m-file for compiling AMD mexFunction
191
192 amd_mex.c AMD mexFunction for MATLAB
193
194 amd_demo.m MATLAB demo for AMD
195 amd_demo.m.out diary output of amd_demo.m
196 can_24.mat input file for AMD demo
197
198 ---------------------------------------------------------------------------
199 Lib directory: libamd.a and libamdf77.a libraries placed here
200 ---------------------------------------------------------------------------
201
202 libamd.def AMD definitions for Windows