← Back to branch summary

~ubuntu-branches/ubuntu/karmic/scilab/karmic

« back to all changes in this revision

Viewing changes to man/linear/spchol.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/linear/spchol.man
 
1
.TH spchol G "April 1993" "Scilab Group" "Scilab Function"
 
2
.so ../sci.an
 
3
.SH NAME
 
4
spchol - sparse cholesky factorization
 
5
.SH CALLING SEQUENCE
 
6
.nf
 
7
[R,P] = spchol(X)
 
8
.fi
 
9
.SH PARAMETERS
 
10
.TP
 
11
X
 
12
: symmetric positive definite real  sparse matrix
 
13
.TP 
 
14
P
 
15
:  permutation matrix
 
16
.TP
 
17
R
 
18
:  cholesky factor
 
19
.SH DESCRIPTION
 
20
\fV[R,P] = spchol(X)\fR produces a 
 
21
lower triangular matrix \fVR\fR such that \fVP*R*R'*P' = X\fR.
 
22
.SH EXAMPLE
 
23
.nf
 
24
X=[
 
25
3.,  0.,  0.,  2.,  0.,  0.,  2.,  0.,  2.,  0.,  0. ;
 
26
0.,  5.,  4.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0. ;
 
27
0.,  4.,  5.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0. ;
 
28
2.,  0.,  0.,  3.,  0.,  0.,  2.,  0.,  2.,  0.,  0. ;
 
29
0.,  0.,  0.,  0. , 5.,  0.,  0.,  0.,  0.,  0.,  4. ;
 
30
0.,  0.,  0.,  0.,  0.,  4.,  0.,  3.,  0.,  3.,  0. ;
 
31
2.,  0.,  0.,  2.,  0.,  0.,  3.,  0.,  2.,  0.,  0. ;
 
32
0.,  0.,  0.,  0.,  0.,  3.,  0.,  4.,  0.,  3.,  0. ;
 
33
2.,  0.,  0.,  2.,  0.,  0.,  2.,  0.,  3.,  0.,  0. ;
 
34
0.,  0.,  0.,  0.,  0.,  3.,  0.,  3.,  0.,  4.,  0. ;
 
35
0.,  0.,  0.,  0.,  4.,  0.,  0.,  0.,  0.,  0.,  5.];
 
36
X=sparse(X);[R,P] = spchol(X);
 
37
max(P*R*R'*P'-X)
 
38
.fi
 
39
.SH SEE ALSO
 
40
sparse, lusolve, luget, chol