root / man / man3 / HPL_infog2l.3
Historique | Voir | Annoter | Télécharger (3,69 ko)
1 |
.TH HPL_infog2l 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
---|---|
2 |
.SH NAME |
3 |
HPL_infog2l \- global to local index translation. |
4 |
.SH SYNOPSIS |
5 |
\fB\&#include "hpl.h"\fR |
6 |
|
7 |
\fB\&void\fR |
8 |
\fB\&HPL_infog2l(\fR |
9 |
\fB\&int\fR |
10 |
\fI\&I\fR, |
11 |
\fB\&int\fR |
12 |
\fI\&J\fR, |
13 |
\fB\&const int\fR |
14 |
\fI\&IMB\fR, |
15 |
\fB\&const int\fR |
16 |
\fI\&MB\fR, |
17 |
\fB\&const int\fR |
18 |
\fI\&INB\fR, |
19 |
\fB\&const int\fR |
20 |
\fI\&NB\fR, |
21 |
\fB\&const int\fR |
22 |
\fI\&RSRC\fR, |
23 |
\fB\&const int\fR |
24 |
\fI\&CSRC\fR, |
25 |
\fB\&const int\fR |
26 |
\fI\&MYROW\fR, |
27 |
\fB\&const int\fR |
28 |
\fI\&MYCOL\fR, |
29 |
\fB\&const int\fR |
30 |
\fI\&NPROW\fR, |
31 |
\fB\&const int\fR |
32 |
\fI\&NPCOL\fR, |
33 |
\fB\&int *\fR |
34 |
\fI\&II\fR, |
35 |
\fB\&int *\fR |
36 |
\fI\&JJ\fR, |
37 |
\fB\&int *\fR |
38 |
\fI\&PROW\fR, |
39 |
\fB\&int *\fR |
40 |
\fI\&PCOL\fR |
41 |
\fB\&);\fR |
42 |
.SH DESCRIPTION |
43 |
\fB\&HPL_infog2l\fR |
44 |
computes the starting local index II, JJ corresponding to |
45 |
the submatrix starting globally at the entry pointed by I, J. This |
46 |
routine returns the coordinates in the grid of the process owning the |
47 |
matrix entry of global indexes I, J, namely PROW and PCOL. |
48 |
.SH ARGUMENTS |
49 |
.TP 8 |
50 |
I (global input) int |
51 |
On entry, I specifies the global row index of the matrix |
52 |
entry. I must be at least zero. |
53 |
.TP 8 |
54 |
J (global input) int |
55 |
On entry, J specifies the global column index of the matrix |
56 |
entry. J must be at least zero. |
57 |
.TP 8 |
58 |
IMB (global input) const int |
59 |
On entry, IMB specifies the size of the first row block of |
60 |
the global matrix. IMB must be at least one. |
61 |
.TP 8 |
62 |
MB (global input) const int |
63 |
On entry, MB specifies the blocking factor used to partition |
64 |
and distribute the rows of the matrix A. MB must be larger |
65 |
than one. |
66 |
.TP 8 |
67 |
INB (global input) const int |
68 |
On entry, INB specifies the size of the first column block of |
69 |
the global matrix. INB must be at least one. |
70 |
.TP 8 |
71 |
NB (global input) const int |
72 |
On entry, NB specifies the blocking factor used to partition |
73 |
and distribute the columns of the matrix A. NB must be larger |
74 |
than one. |
75 |
.TP 8 |
76 |
RSRC (global input) const int |
77 |
On entry, RSRC specifies the row coordinate of the process |
78 |
that possesses the row I. RSRC must be at least zero and |
79 |
strictly less than NPROW. |
80 |
.TP 8 |
81 |
CSRC (global input) const int |
82 |
On entry, CSRC specifies the column coordinate of the process |
83 |
that possesses the column J. CSRC must be at least zero and |
84 |
strictly less than NPCOL. |
85 |
.TP 8 |
86 |
MYROW (local input) const int |
87 |
On entry, MYROW specifies my row process coordinate in the |
88 |
grid. MYROW is greater than or equal to zero and less than |
89 |
NPROW. |
90 |
.TP 8 |
91 |
MYCOL (local input) const int |
92 |
On entry, MYCOL specifies my column process coordinate in the |
93 |
grid. MYCOL is greater than or equal to zero and less than |
94 |
NPCOL. |
95 |
.TP 8 |
96 |
NPROW (global input) const int |
97 |
On entry, NPROW specifies the number of process rows in the |
98 |
grid. NPROW is at least one. |
99 |
.TP 8 |
100 |
NPCOL (global input) const int |
101 |
On entry, NPCOL specifies the number of process columns in |
102 |
the grid. NPCOL is at least one. |
103 |
.TP 8 |
104 |
II (local output) int * |
105 |
On exit, II specifies the local starting row index of the |
106 |
submatrix. On exit, II is at least 0. |
107 |
.TP 8 |
108 |
JJ (local output) int * |
109 |
On exit, JJ specifies the local starting column index of the |
110 |
submatrix. On exit, JJ is at least 0. |
111 |
.TP 8 |
112 |
PROW (global output) int * |
113 |
On exit, PROW is the row coordinate of the process owning the |
114 |
entry specified by the global index I. PROW is at least zero |
115 |
and less than NPROW. |
116 |
.TP 8 |
117 |
PCOL (global output) int * |
118 |
On exit, PCOL is the column coordinate of the process owning |
119 |
the entry specified by the global index J. PCOL is at least |
120 |
zero and less than NPCOL. |
121 |
.SH SEE ALSO |
122 |
.BR HPL_indxg2l \ (3), |
123 |
.BR HPL_indxg2p \ (3), |
124 |
.BR HPL_indxl2g \ (3), |
125 |
.BR HPL_numroc \ (3), |
126 |
.BR HPL_numrocI \ (3). |