as.blockmatrix: Coerces to a Blockmatrix

In ecor/blockmatrix: Tools to Solve Algebraic Systems with Partitioned Matrices

Description

Coerces to a Blockmatrix

as.blockmatrix S3 method for blockmatrix, matrix and NULL object

Usage

as.blockmatrix(M = NULL, ...)

## Default S3 method:
as.blockmatrix(M, adjust_zero = TRUE, zero_element = "0",
  ...)

## S3 method for class 'blockmatrix'
as.blockmatrix(M, adjust_zero = TRUE,
  add_zero_matrix = FALSE, zero_element = "0", ...)

## S3 method for class 'matrix'
as.blockmatrix(M, nrowe = nrow(M), ncole = ncol(M),
  nrow = NULL, ncol = NULL, adjust_zero = TRUE, zero_element = "0", ...)

## Default S3 method:
as.blockmatrix(M, adjust_zero = TRUE, zero_element = "0",
  ...)

## S3 method for class 'numeric'
as.blockmatrix(M, adjust_zero = TRUE, zero_element = "0",
  ...)

Arguments

M	a matrix or blockmatrix object
...	further arguments
adjust_zero	logical value. If TRUE (Default) it replaces the zero matrices with zero_element.
zero_element	see ncol_elements or nrow_elements
add_zero_matrix	logical value. If TRUE it adds a zero-element element matrix as an object called zero_element in the blockmatrix
nrowe	number of rows for each block (element of the blockmatrix)
ncole	number of columns for each block (element of the blockmatrix)
nrow	number of rows for block-matrix
ncol	number of columns of blockmatrix

Details

In case of coercion from a matrix, ncole and/or ncol must be a submultiple of the number of columns of M; nrowe and/or nrow must be a submultiple of the number of rows of M.

Author(s)

Emanuele Cordano

ecor/blockmatrix documentation built on May 15, 2019, 8:54 p.m.