root / man / man3 / HPL_numroc.3 @ 1
Historique | Voir | Annoter | Télécharger (1,75 ko)
| 1 |
.TH HPL_numroc 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_numroc \- Compute the local number of row/columns. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&int\fR |
| 8 |
\fB\&HPL_numroc(\fR |
| 9 |
\fB\&const int\fR |
| 10 |
\fI\&N\fR, |
| 11 |
\fB\&const int\fR |
| 12 |
\fI\&INB\fR, |
| 13 |
\fB\&const int\fR |
| 14 |
\fI\&NB\fR, |
| 15 |
\fB\&const int\fR |
| 16 |
\fI\&PROC\fR, |
| 17 |
\fB\&const int\fR |
| 18 |
\fI\&SRCPROC\fR, |
| 19 |
\fB\&const int\fR |
| 20 |
\fI\&NPROCS\fR |
| 21 |
\fB\&);\fR |
| 22 |
.SH DESCRIPTION |
| 23 |
\fB\&HPL_numroc\fR |
| 24 |
returns the local number of matrix rows/columns process |
| 25 |
PROC will get if we give out N rows/columns starting from global |
| 26 |
index 0. |
| 27 |
.SH ARGUMENTS |
| 28 |
.TP 8 |
| 29 |
N (input) const int |
| 30 |
On entry, N specifies the number of rows/columns being dealt |
| 31 |
out. N must be at least zero. |
| 32 |
.TP 8 |
| 33 |
INB (input) const int |
| 34 |
On entry, INB specifies the size of the first block of the |
| 35 |
global matrix. INB must be at least one. |
| 36 |
.TP 8 |
| 37 |
NB (input) const int |
| 38 |
On entry, NB specifies the blocking factor used to partition |
| 39 |
and distribute the matrix A. NB must be larger than one. |
| 40 |
.TP 8 |
| 41 |
PROC (input) const int |
| 42 |
On entry, PROC specifies the coordinate of the process whose |
| 43 |
local portion is determined. PROC must be at least zero and |
| 44 |
strictly less than NPROCS. |
| 45 |
.TP 8 |
| 46 |
SRCPROC (input) const int |
| 47 |
On entry, SRCPROC specifies the coordinate of the process |
| 48 |
that possesses the first row or column of the matrix. SRCPROC |
| 49 |
must be at least zero and strictly less than NPROCS. |
| 50 |
.TP 8 |
| 51 |
NPROCS (input) const int |
| 52 |
On entry, NPROCS specifies the total number of process rows |
| 53 |
or columns over which the matrix is distributed. NPROCS must |
| 54 |
be at least one. |
| 55 |
.SH SEE ALSO |
| 56 |
.BR HPL_indxg2l \ (3), |
| 57 |
.BR HPL_indxg2lp \ (3), |
| 58 |
.BR HPL_indxg2p \ (3), |
| 59 |
.BR HPL_indxl2g \ (3), |
| 60 |
.BR HPL_numrocI \ (3). |