testMatrixvariate: assert/check/test/Matrixvariate

In RaphaelS1/distr6: The Complete R6 Probability Distributions Interface

assert/check/test/Matrixvariate

Description

Validation checks to test if Distribution is matrixvariate.

Usage

testMatrixvariate(
  object,
  errormsg = paste(object$short_name, "is not matrixvariate")
)

checkMatrixvariate(
  object,
  errormsg = paste(object$short_name, "is not matrixvariate")
)

assertMatrixvariate(
  object,
  errormsg = paste(object$short_name, "is not matrixvariate")
)

Arguments

object	Distribution
errormsg	custom error message to return if assert/check fails

Value

If check passes then assert returns invisibly and test/check return TRUE. If check fails, assert stops code with error, check returns an error message as string, test returns FALSE.

Examples

testMatrixvariate(Binomial$new()) # FALSE

RaphaelS1/distr6 documentation built on Feb. 24, 2024, 9:14 p.m.