.add_sanity_check {sanityTracker}

Adds a sanity check to the list of already performed sanity checks

Description

NOTE the also add_sanity_check calls this function, the parameters are documented in add_sanity_check because that function gets exported.

Usage

.add_sanity_check(
  fail_vec,
  description,
  counter_meas,
  data,
  data_name,
  example_size,
  param_name,
  call,
  fail_callback,
  .fail_vec_str,
  .generated_desc
)

Arguments

fail_vec

see add_sanity_check

description

see add_sanity_check

counter_meas

see add_sanity_check

data

see add_sanity_check

data_name

see add_sanity_check

example_size

see add_sanity_check

param_name

see add_sanity_check

call

see add_sanity_check

fail_callback

see add_sanity_check

.fail_vec_str

should capture what was used originally for fail_vec.

.generated_desc

for convenience functions like sc_col_elements to provide additional information about the check.

Value

see add_sanity_check