dwww Home | Show directory contents | Find package

AMD, Copyright (c) 2009-2013 by Timothy A. Davis (http://www.suitesparse.com),
Patrick R. Amestoy, and Iain S. Duff.  All Rights Reserved.  AMD is available
under alternate licences; contact T. Davis for details.

AMD:  a set of routines for permuting sparse matrices prior to
    factorization.  Includes a version in C, a version in Fortran, and a MATLAB
    mexFunction.

Requires SuiteSparse_config, in the ../SuiteSparse_config directory relative to
this directory.

Quick start (Unix, or Windows with Cygwin):

    To compile, test, and install AMD, you may wish to first configure the
    installation by editting the ../SuiteSparse_config/SuiteSparse_config.mk
    file.  Next, cd to this directory (AMD) and type "make" (or "make lib" if
    you do not have MATLAB).  To compile and run a demo program for the Fortran
    version, type "make fortran".  When done, type "make clean" to remove
    unused *.o files (keeps the compiled libraries and demo programs).  See the
    User Guide (Doc/AMD_UserGuide.pdf), or
    ../SuiteSparse_config/SuiteSparse_config.mk for more details.
    To install do "make install"

Quick start (for MATLAB users);

    To compile, test, and install the AMD mexFunction, cd to the
    AMD/MATLAB directory and type amd_make at the MATLAB prompt.

-------------------------------------------------------------------------------

AMD License:  refer to the AMD/Doc/License.txt file for the license.

Availability:

    http://www.suitesparse.com

-------------------------------------------------------------------------------

This is the AMD README file.  It is a terse overview of AMD.
Refer to the User Guide (Doc/AMD_UserGuide.pdf) for how to install
and use AMD.

Description:

    AMD is a set of routines for pre-ordering sparse matrices prior to Cholesky
    or LU factorization, using the approximate minimum degree ordering
    algorithm.  Written in ANSI/ISO C with a MATLAB interface, and in
    Fortran 77.

Authors:

    Timothy A. Davis (DrTimothyAldenDavis@gmail.com)
    Patrick R. Amestory, ENSEEIHT, Toulouse, France.
    Iain S. Duff, Rutherford Appleton Laboratory, UK.

Acknowledgements:

    This work was supported by the National Science Foundation, under
    grants DMS-9504974, DMS-9803599, and CCR-0203270.

    Portions of this work were done while on sabbatical at Stanford University
    and Lawrence Berkeley National Laboratory (with funding from the SciDAC
    program).  I would like to thank Gene Golub, Esmond Ng, and Horst Simon
    for making this sabbatical possible.

-------------------------------------------------------------------------------
Files and directories in the AMD distribution:
-------------------------------------------------------------------------------

    ---------------------------------------------------------------------------
    Subdirectories of the AMD directory:
    ---------------------------------------------------------------------------

    Doc         documentation
    Source      primary source code
    Include     include file for use in your code that calls AMD
    Demo        demo programs.  also serves as test of the AMD installation.
    MATLAB      AMD mexFunction for MATLAB, and supporting m-files
    Lib         where the compiled C-callable and Fortran-callable
                AMD libraries placed.

    ---------------------------------------------------------------------------
    Files in the AMD directory:
    ---------------------------------------------------------------------------

    Makefile    top-level Makefile
                Windows users would require Cygwin to use "make"

    README.txt  this file

    ---------------------------------------------------------------------------
    Doc directory: documentation
    ---------------------------------------------------------------------------

    ChangeLog                   change log
    License.txt                 the AMD License
    Makefile                    for creating the documentation
    AMD_UserGuide.bib           AMD User Guide (references)
    AMD_UserGuide.tex           AMD User Guide (LaTeX)
    AMD_UserGuide.pdf           AMD User Guide (PDF)

    ---------------------------------------------------------------------------
    Source directory:
    ---------------------------------------------------------------------------

    amd_order.c                 user-callable, primary AMD ordering routine
    amd_control.c               user-callable, prints the control parameters
    amd_defaults.c              user-callable, sets default control parameters
    amd_info.c                  user-callable, prints the statistics from AMD

    amd_1.c                     non-user-callable, construct A+A'
    amd_2.c                     user-callable, primary ordering kernel
                                (a C version of amd.f and amdbar.f, with
                                post-ordering added)
    amd_aat.c                   non-user-callable, computes nnz (A+A')
    amd_dump.c                  non-user-callable, debugging routines
    amd_postorder.c             non-user-callable, postorder
    amd_post_tree.c             non-user-callable, postorder just one tree
    amd_valid.c                 non-user-callable, verifies a matrix
    amd_preprocess.c            non-user-callable, computes A', removes duplic

    amd.f                       user-callable Fortran 77 version
    amdbar.f                    user-callable Fortran 77 version

    ---------------------------------------------------------------------------
    Include directory:
    ---------------------------------------------------------------------------

    amd.h                       include file for C programs that use AMD
    amd_internal.h              non-user-callable, include file for AMD

    ---------------------------------------------------------------------------
    Demo directory:
    ---------------------------------------------------------------------------

    Makefile                    to compile the demos
    amd_demo.c                  C demo program for AMD
    amd_demo.out                output of amd_demo.c

    amd_demo2.c                 C demo program for AMD, jumbled matrix
    amd_demo2.out               output of amd_demo2.c

    amd_l_demo.c                C demo program for AMD (long integer version)
    amd_l_demo.out              output of amd_l_demo.c

    amd_simple.c                simple C demo program for AMD
    amd_simple.out              output of amd_simple.c

    amd_f77demo.f               Fortran 77 demo program for AMD
    amd_f77demo.out             output of amd_f77demo.f

    amd_f77simple.c             simple Fortran 77 demo program for AMD
    amd_f77simple.out           output of amd_f77simple.f

    amd_f77cross.f              Fortran 77 demo, calls the C version of AMD
    amd_f77cross.out            output of amd_f77cross.f
    amd_f77wrapper.c            Fortran-callable wrapper for C version of AMD

    ---------------------------------------------------------------------------
    MATLAB directory:
    ---------------------------------------------------------------------------

    Contents.m                  for "help amd2" listing of toolbox contents

    amd2.m                      MATLAB help file for AMD
    amd_make.m                  MATLAB m-file for compiling AMD mexFunction
    amd_install.m               compile and install the AMD mexFunction

    amd_mex.c                   AMD mexFunction for MATLAB

    amd_demo.m                  MATLAB demo for AMD
    amd_demo.m.out              diary output of amd_demo.m
    can_24.mat                  input file for AMD demo

    ---------------------------------------------------------------------------
    Lib directory:  libamd.a and libamd.so library placed here
    ---------------------------------------------------------------------------

    Makefile                    Makefile for both shared and static libraries

Generated by dwww version 1.14 on Sat Sep 6 03:06:53 CEST 2025.