User`s guide
11 Functions — Alphabetical List
11-46
codistributor2dbc
Create 2-D block-cyclic codistributor object for codistributed arrays
Syntax
codist = codistributor2dbc()
codist = codistributor2dbc(lbgrid)
codist = codistributor2dbc(lbgrid,blksize)
codist = codistributor2dbc(lbgrid,blksize,orient)
codist = codistributor2dbc(lbgrid,blksize,orient,gsize)
Description
The 2-D block-cyclic codistributor can be used only for two-dimensional arrays. It
distributes arrays along two subscripts over a rectangular computational grid of labs
(workers) in a block-cyclic manner. For a complete description of 2-D block-cyclic
distribution, default parameters, and the relationship between block size and lab grid,
see “2-Dimensional Distribution” on page 5-16. The 2-D block-cyclic codistributor is used
by the ScaLAPACK parallel matrix computation software library.
codist = codistributor2dbc() forms a 2-D block-cyclic codistributor2dbc
codistributor object using default lab grid and block size.
codist = codistributor2dbc(lbgrid) forms a 2-D block-cyclic codistributor object
using the specified lab grid and default block size. lbgrid must be a two-element vector
defining the rows and columns of the lab grid, and the rows times columns must equal
the number of workers for the codistributed array.
codist = codistributor2dbc(lbgrid,blksize) forms a 2-D block-cyclic
codistributor object using the specified lab grid and block size.
codist = codistributor2dbc(lbgrid,blksize,orient) allows an orientation
argument. Valid values for the orientation argument are 'row' for row orientation, and
'col' for column orientation of the lab grid. The default is row orientation.
The resulting codistributor of any of the above syntax is incomplete because its global
size is not specified. A codistributor constructed this way can be used as an argument to
other functions as a template codistributor when creating codistributed arrays.