Statistiques
| Révision :

root / man / man3 / HPL_dtrsv.3

Historique | Voir | Annoter | Télécharger (3,71 ko)

1 1 equemene
.TH HPL_dtrsv 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions"
2 1 equemene
.SH NAME
3 1 equemene
HPL_dtrsv \- x := A^{-1} x.
4 1 equemene
.SH SYNOPSIS
5 1 equemene
\fB\&#include "hpl.h"\fR
6 1 equemene
7 1 equemene
\fB\&void\fR
8 1 equemene
\fB\&HPL_dtrsv(\fR
9 1 equemene
\fB\&const enum HPL_ORDER\fR
10 1 equemene
\fI\&ORDER\fR,
11 1 equemene
\fB\&const enum HPL_UPLO\fR
12 1 equemene
\fI\&UPLO\fR,
13 1 equemene
\fB\&const enum HPL_TRANS\fR
14 1 equemene
\fI\&TRANS\fR,
15 1 equemene
\fB\&const enum HPL_DIAG\fR
16 1 equemene
\fI\&DIAG\fR,
17 1 equemene
\fB\&const int\fR
18 1 equemene
\fI\&N\fR,
19 1 equemene
\fB\&const double *\fR
20 1 equemene
\fI\&A\fR,
21 1 equemene
\fB\&const int\fR
22 1 equemene
\fI\&LDA\fR,
23 1 equemene
\fB\&double *\fR
24 1 equemene
\fI\&X\fR,
25 1 equemene
\fB\&const int\fR
26 1 equemene
\fI\&INCX\fR
27 1 equemene
\fB\&);\fR
28 1 equemene
.SH DESCRIPTION
29 1 equemene
\fB\&HPL_dtrsv\fR
30 1 equemene
solves one of the systems of equations
31 1 equemene
32 1 equemene
    A * x = b,   or   A^T * x = b,
33 1 equemene
34 1 equemene
where b and x are n-element vectors and  A  is an n by n non-unit, or
35 1 equemene
unit, upper or lower triangular matrix.
36 1 equemene
37 1 equemene
No test for  singularity  or  near-singularity  is included  in  this
38 1 equemene
routine. Such tests must be performed before calling this routine.
39 1 equemene
.SH ARGUMENTS
40 1 equemene
.TP 8
41 1 equemene
ORDER   (local input)           const enum HPL_ORDER
42 1 equemene
On entry, ORDER  specifies the storage format of the operands
43 1 equemene
as follows:
44 1 equemene
   ORDER = HplRowMajor,
45 1 equemene
   ORDER = HplColumnMajor.
46 1 equemene
.TP 8
47 1 equemene
UPLO    (local input)           const enum HPL_UPLO
48 1 equemene
On  entry,   UPLO   specifies  whether  the  upper  or  lower
49 1 equemene
triangular  part  of the array  A  is to be referenced.  When
50 1 equemene
UPLO==HplUpper, only  the upper triangular part of A is to be
51 1 equemene
referenced, otherwise only the lower triangular part of A is
52 1 equemene
to be referenced.
53 1 equemene
.TP 8
54 1 equemene
TRANS   (local input)           const enum HPL_TRANS
55 1 equemene
On entry,  TRANS  specifies  the equations  to  be  solved as
56 1 equemene
follows:
57 1 equemene
   TRANS==HplNoTrans     A   * x = b,
58 1 equemene
   TRANS==HplTrans       A^T * x = b.
59 1 equemene
.TP 8
60 1 equemene
DIAG    (local input)           const enum HPL_DIAG
61 1 equemene
On entry,  DIAG  specifies  whether  A  is unit triangular or
62 1 equemene
not. When DIAG==HplUnit,  A is assumed to be unit triangular,
63 1 equemene
and otherwise, A is not assumed to be unit triangular.
64 1 equemene
.TP 8
65 1 equemene
N       (local input)           const int
66 1 equemene
On entry, N specifies the order of the matrix A. N must be at
67 1 equemene
least zero.
68 1 equemene
.TP 8
69 1 equemene
A       (local input)           const double *
70 1 equemene
On entry,  A  points  to an array of size equal to or greater
71 1 equemene
than LDA * n. Before entry with  UPLO==HplUpper,  the leading
72 1 equemene
n by n upper triangular  part of the array A must contain the
73 1 equemene
upper triangular  matrix and the  strictly  lower  triangular
74 1 equemene
part of A is not referenced.  When  UPLO==HplLower  on entry,
75 1 equemene
the  leading n by n lower triangular part of the array A must
76 1 equemene
contain the lower triangular matrix  and  the  strictly upper
77 1 equemene
triangular part of A is not referenced.
78 1 equemene
79 1 equemene
Note  that  when  DIAG==HplUnit,  the diagonal elements of  A
80 1 equemene
not referenced  either,  but are assumed to be unity.
81 1 equemene
.TP 8
82 1 equemene
LDA     (local input)           const int
83 1 equemene
On entry,  LDA  specifies  the  leading  dimension  of  A  as
84 1 equemene
declared  in  the  calling  (sub) program.  LDA  must  be  at
85 1 equemene
least MAX(1,n).
86 1 equemene
.TP 8
87 1 equemene
X       (local input/output)    double *
88 1 equemene
On entry,  X  is an incremented array of dimension  at  least
89 1 equemene
( 1 + ( n - 1 ) * abs( INCX ) )  that  contains the vector x.
90 1 equemene
Before entry,  the  incremented array  X  must contain  the n
91 1 equemene
element right-hand side vector b. On exit,  X  is overwritten
92 1 equemene
with the solution vector x.
93 1 equemene
.TP 8
94 1 equemene
INCX    (local input)           const int
95 1 equemene
On entry, INCX specifies the increment for the elements of X.
96 1 equemene
INCX must not be zero.
97 1 equemene
.SH EXAMPLE
98 1 equemene
\fI\&#include "hpl.h"\fR
99 1 equemene
100 1 equemene
int main(int argc, char *argv[])
101 1 equemene
.br
102 1 equemene
{
103 1 equemene
.br
104 1 equemene
   double a[2*2], x[2];
105 1 equemene
.br
106 1 equemene
   a[0] = 4.0; a[1] = 1.0; a[2] = 2.0; a[3] = 5.0;
107 1 equemene
.br
108 1 equemene
   x[0] = 2.0; x[1] = 1.0;
109 1 equemene
.br
110 1 equemene
   HPL_dtrsv( HplColumnMajor, HplLower, HplNoTrans,
111 1 equemene
.br
112 1 equemene
              HplNoUnit, a, 2, x, 1 );
113 1 equemene
.br
114 1 equemene
   printf("x=[%f,%f]\en", x[0], x[1]);
115 1 equemene
.br
116 1 equemene
   exit(0); return(0);
117 1 equemene
.br
118 1 equemene
}
119 1 equemene
.SH SEE ALSO
120 1 equemene
.BR HPL_dger \ (3),
121 1 equemene
.BR HPL_dgemv \ (3).