File: mainpage.txt

package info (click to toggle)
superlu 7.0.1%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,292 kB
  • sloc: ansic: 59,338; makefile: 413; csh: 141; f90: 125; fortran: 77
file content (31 lines) | stat: -rw-r--r-- 1,537 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*! \mainpage SuperLU API Documentation

 SuperLU is a general purpose library for the direct solution of large,
 sparse, nonsymmetric systems of linear equations on high performance
 machines. The library is written in C and is callable from either C or
 Fortran. The library routines perform an LU decomposition with
 partial pivoting and triangular system solves through forward and back
 substitution.  The library also provides threshold-based ILU factorization
 preconditioners.

 The factorization routines can handle non-square
 matrices but the triangular solves are performed only for square
 matrices. The matrix columns may be preordered (before factorization)
 either through library or user supplied routines. This preordering for
 sparsity is completely separate from the factorization. Working
 precision iterative refinement subroutines are provided for improved
 backward stability. Routines are also provided to equilibrate the
 system, estimate the condition number, calculate the relative backward
 error, and estimate error bounds for the refined solutions.

 \section about About SuperLU API documentation

 You are reading the SuperLU API documentation. It is automatically
 generated by Doxygen from special comments in the source code.
 This type of documentation helps you to look up functions, their
 arguments, and what they mean. This is no introduction, how-to or
 similar document for beginners.

 You can start from the page \subpage modules which gives
 you access to the documentation by category.
 */