count_vals_byname: Count the number of matrix entries that meet a criterion

In MatthewHeun/byname: An Implementation of Matrix Mathematics that Respects Row and Column Names

Count the number of matrix entries that meet a criterion

Description

Expressions can be written in a natural way such as count_vals_byname(m, "<=", 1).

Usage

count_vals_byname(
  a,
  compare_fun = c("==", "!=", "<", "<=", ">=", ">"),
  val = 0
)

Arguments

a	A matrix or list of matrices whose values are to be counted according to compare_fun.
compare_fun	The comparison function, one of "==", "!=", "<", "<=", ">", or ">=". Default is "==".
val	The value against which matrix entries are compared. Default is 0.

Details

Either a single matrix or a list of matrices can be given as the a argument. compare_fun can be specified as a string ("!=") or as a back-quoted function (`!=`).

Value

An integer indicating the number of entries in a that meet the specified criterion

Examples

m <- matrix(c(0, 1, 2, 3, 4, 0), nrow = 3, ncol = 2)
count_vals_byname(m) # uses defaults: compare_fun = "==" and val = 0
count_vals_byname(m, compare_fun = "!=")
count_vals_byname(m, compare_fun = `!=`)
# Write expressions in a natural way
count_vals_byname(m, "<=", 1)
# Also works for lists
count_vals_byname(list(m,m), "<=", 1)

MatthewHeun/byname documentation built on Feb. 17, 2024, 4:51 p.m.