accessors: Accessor Functions for Distributed Matrix Slots

In RBigData/pbdDMAT: 'pbdR' Distributed Matrix Methods

Description

Functions to get dimension information, local storage, or current BLACS context from a distributed matrix.

Usage

nrow(x)

## S4 method for signature 'ddmatrix'
nrow(x)

NROW(x)

## S4 method for signature 'ddmatrix'
NROW(x)

ncol(x)

## S4 method for signature 'ddmatrix'
ncol(x)

NCOL(x)

## S4 method for signature 'ddmatrix'
NCOL(x)

submatrix(x, ...)

## S4 method for signature 'ddmatrix'
submatrix(x)

## S4 method for signature 'Linalg'
submatrix(x)

ldim(x, ...)

## S4 method for signature 'ddmatrix'
ldim(x)

bldim(x, ...)

## S4 method for signature 'ddmatrix'
bldim(x)

ICTXT(x, ...)

## S4 method for signature 'ddmatrix'
ICTXT(x)

## S4 method for signature 'ddmatrix'
dim(x)

## S4 method for signature 'ddmatrix'
length(x)

Arguments

x	numeric distributed matrix
...	Extra arguments.
dim	global dimension.
bldim	blocking dimension.
ICTXT	BLACS context.

Details

The functions nrow(), ncol(), length() and dim() are the natural extensions of their ordinary matrix counterparts.

ldim() will give the dimension of the matrix stored locally on the process which runs the function. This is a local value, so its return is process-dependent. For example, if the 3x3 global matrix x is distributed as the ddmatrix dx across two processors with process 0 owning the first two rows and process 1 owning the third, then ldim(dx) will return 2 3 on process 0 and 1 3 on process 1.

bldim() will give the blocking dimension that was used to block-cyclically distribute the distributed matrix.

submatrix() will give the local storage for the requested object.

ICTXT() will give the current BLACS context (slot ICTXT) for the requested object.

ownany() is intended mostly for developers. It answers the question "do I own any of the data?". The user can either pass a distributed matrix object or the dim, bldim, and ICTXT of one.

Value

Each of dim(), ldim(), bldim() return a length 2 vector.

Each of nrow(), ncol(), and length() return a length 1 vector. Likewise, so does ICTXT().

submatrix() returns a matrix; namely, submatrix(x) returns a matrix of dimensions ldim(x).

Methods

list("signature(x = \"ddmatrix\")")

RBigData/pbdDMAT documentation built on Oct. 29, 2021, 6:20 p.m.