blockSize: Return the Block Size of a symDMatrix Object

Description Usage Arguments Details Value Examples

View source: R/symDMatrix.R

Description

This function returns the block size of a symDMatrix object.

Usage

1
blockSize(x, last = FALSE)

Arguments

x

A symDMatrix object.

last

A boolean indicating whether to return the block size of the last (TRUE) column/row block or any of the other blocks (FALSE, default).

Details

The last block of a column/row may be smaller than the other blocks. Its size can be retrieved by setting last to TRUE.

Value

The block size of a symDMatrix object.

Examples

1
2
3
4
5
6
7
8
# Load example symDMatrix (G)
load.symDMatrix(system.file("extdata", "G.RData", package = "symDMatrix"), readonly = TRUE)

# Get the block size
blockSize(G)

# Get the block size of the trailing blocks
blockSize(G, last = TRUE)

symDMatrix documentation built on Aug. 2, 2020, 5:06 p.m.