matrix_parameters: Matrix parameters

In prioritizr/ppr: Optimal Project Prioritization

Matrix parameters

Description

Create a parameter that represents a matrix object.

Usage

numeric_matrix_parameter(
  name,
  value,
  lower_limit = .Machine$double.xmin,
  upper_limit = .Machine$double.xmax,
  symmetric = FALSE
)

binary_matrix_parameter(name, value, symmetric = FALSE)

Arguments

name	character name of parameter.
value	matrix object.
lower_limit	numeric values denoting the minimum acceptable value in the matrix. Defaults to the smallest possible number on the system.
upper_limit	numeric values denoting the maximum acceptable value in the matrix. Defaults to the smallest possible number on the system.
symmetric	logical must the must be matrix be symmetric? Defaults to FALSE.

Value

MiscParameter object.

Examples

# create matrix
m <- matrix(runif(9), ncol = 3)
colnames(m) <- letters[1:3]
rownames(m) <- letters[1:3]

# create a numeric matrix parameter
p1 <- numeric_matrix_parameter("m", m)
print(p1) # print it
p1$get() # get value
p1$id # get id
p1$validate(m[, -1]) # check if parameter can be updated
p1$set(m + 1) # set parameter to new values
p1$print() # print it again

# create a binary matrix parameter
m <- matrix(round(runif(9)), ncol = 3)
colnames(m) <- letters[1:3]
rownames(m) <- letters[1:3]

# create a binary matrix parameter
p2 <- binary_matrix_parameter("m", m)
print(p2) # print it
p2$get() # get value
p2$id # get id
p2$validate(m[, -1]) # check if parameter can be updated
p2$set(m + 1) # set parameter to new values
p2$print() # print it again

prioritizr/ppr documentation built on Sept. 10, 2022, 1:18 p.m.