root / man / man3 / HPL_pdpanel_new.3 @ 1
Historique | Voir | Annoter | Télécharger (2,1 ko)
| 1 |
.TH HPL_pdpanel_new 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_pdpanel_new \- Create a panel data structure. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&void\fR |
| 8 |
\fB\&HPL_pdpanel_new(\fR |
| 9 |
\fB\&HPL_T_grid *\fR |
| 10 |
\fI\&GRID\fR, |
| 11 |
\fB\&HPL_T_palg *\fR |
| 12 |
\fI\&ALGO\fR, |
| 13 |
\fB\&const int\fR |
| 14 |
\fI\&M\fR, |
| 15 |
\fB\&const int\fR |
| 16 |
\fI\&N\fR, |
| 17 |
\fB\&const int\fR |
| 18 |
\fI\&JB\fR, |
| 19 |
\fB\&HPL_T_pmat *\fR |
| 20 |
\fI\&A\fR, |
| 21 |
\fB\&const int\fR |
| 22 |
\fI\&IA\fR, |
| 23 |
\fB\&const int\fR |
| 24 |
\fI\&JA\fR, |
| 25 |
\fB\&const int\fR |
| 26 |
\fI\&TAG\fR, |
| 27 |
\fB\&HPL_T_panel * *\fR |
| 28 |
\fI\&PANEL\fR |
| 29 |
\fB\&);\fR |
| 30 |
.SH DESCRIPTION |
| 31 |
\fB\&HPL_pdpanel_new\fR |
| 32 |
creates and initializes a panel data structure. |
| 33 |
.SH ARGUMENTS |
| 34 |
.TP 8 |
| 35 |
GRID (local input) HPL_T_grid * |
| 36 |
On entry, GRID points to the data structure containing the |
| 37 |
process grid information. |
| 38 |
.TP 8 |
| 39 |
ALGO (global input) HPL_T_palg * |
| 40 |
On entry, ALGO points to the data structure containing the |
| 41 |
algorithmic parameters. |
| 42 |
.TP 8 |
| 43 |
M (local input) const int |
| 44 |
On entry, M specifies the global number of rows of the panel. |
| 45 |
M must be at least zero. |
| 46 |
.TP 8 |
| 47 |
N (local input) const int |
| 48 |
On entry, N specifies the global number of columns of the |
| 49 |
panel and trailing submatrix. N must be at least zero. |
| 50 |
.TP 8 |
| 51 |
JB (global input) const int |
| 52 |
On entry, JB specifies is the number of columns of the panel. |
| 53 |
JB must be at least zero. |
| 54 |
.TP 8 |
| 55 |
A (local input/output) HPL_T_pmat * |
| 56 |
On entry, A points to the data structure containing the local |
| 57 |
array information. |
| 58 |
.TP 8 |
| 59 |
IA (global input) const int |
| 60 |
On entry, IA is the global row index identifying the panel |
| 61 |
and trailing submatrix. IA must be at least zero. |
| 62 |
.TP 8 |
| 63 |
JA (global input) const int |
| 64 |
On entry, JA is the global column index identifying the panel |
| 65 |
and trailing submatrix. JA must be at least zero. |
| 66 |
.TP 8 |
| 67 |
TAG (global input) const int |
| 68 |
On entry, TAG is the row broadcast message id. |
| 69 |
.TP 8 |
| 70 |
PANEL (local input/output) HPL_T_panel * * |
| 71 |
On entry, PANEL points to the address of the panel data |
| 72 |
structure to create and initialize. |
| 73 |
.SH SEE ALSO |
| 74 |
.BR HPL_pdpanel_new \ (3), |
| 75 |
.BR HPL_pdpanel_init \ (3), |
| 76 |
.BR HPL_pdpanel_disp \ (3). |