diag-constructors: Distributed Matrix Diagonals

In wrathematics/pbdDMAT: 'pbdR' Distributed Matrix Methods

Distributed Matrix Diagonals

Description

Get the diagonal of a distributed matrix, or construct a distributed matrix which is diagonal.

Usage

## S4 method for signature 'vector'
diag(
  x,
  nrow,
  ncol,
  type = "matrix",
  ...,
  bldim = .pbd_env$BLDIM,
  ICTXT = .pbd_env$ICTXT
)

## S4 method for signature 'character'
diag(
  x,
  nrow,
  ncol,
  type = "matrix",
  ...,
  min = 0,
  max = 1,
  mean = 0,
  sd = 1,
  rate = 1,
  shape,
  scale = 1,
  bldim = .pbd_env$BLDIM,
  ICTXT = .pbd_env$ICTXT
)

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

## S4 method for signature 'matrix'
diag(x, nrow, ncol)

## S4 replacement method for signature 'ddmatrix,vector'
diag(x) <- value

Arguments

x	distributed matrix or a vector.
nrow, ncol	in the case that x is a vector, these specify the global dimension of the diagonal distributed matrix to be created.
type	character. Options are 'matrix' or 'ddmatrix', with partial matching. This specifies the return type.
...	Extra arguments
bldim	blocking dimension.
ICTXT	BLACS context number.
min, max	Min and max values for random uniform generation.
mean, sd	Mean and standard deviation for random normal generation.
rate	Rate for random exponential generation.
shape, scale	Shape and scale parameters for random weibull generation.
value	Replacement value.

Details

Gets the diagonal of a distributed matrix and stores it as a global R vector owned by all processes.

Value

If a distributed matrix is passed to diag() then it returns a global R vector.

If a vector (numeric or character) is passed to diag() and type='ddmatrix', then the return is a diagonal distributed matrix.

wrathematics/pbdDMAT documentation built on Oct. 2, 2024, 2:56 p.m.