oeli (version 0.5.2)

check_transition_probability_matrix: Check if an argument is a transition probability matrix

Description

This function checks whether the input is a quadratic, real matrix with elements between 0 and 1 and row sums equal to 1.

Usage

check_transition_probability_matrix(
  x,
  dim = NULL,
  tolerance = sqrt(.Machine$double.eps)
)
assert_transition_probability_matrix(
  x,
  dim = NULL,
  tolerance = sqrt(.Machine$double.eps),
  .var.name = checkmate::vname(x),
  add = NULL
)
test_transition_probability_matrix(
  x,
  dim = NULL,
  tolerance = sqrt(.Machine$double.eps)
)

Value

Compare to check_matrix.

Arguments

x

Object to check.

dim

An integer, the matrix dimension.

tolerance

A non-negative numeric tolerance value.

.var.name

[character(1)]
Name of the checked object to print in assertions. Defaults to the heuristic implemented in vname.

add

[AssertCollection]
Collection to store assertion messages. See AssertCollection.