pyanno4rt.input_check.check_functions._check_value

Value checking.

Overview

Function

check_value(label, data, reference, sign, is_vector)

Check if the data has an invalid value range.

Functions

pyanno4rt.input_check.check_functions._check_value.check_value(label, data, reference, sign, is_vector=False)[source]

Check if the data has an invalid value range.

Parameters:

  • label (str) – Label for the item to be checked.

  • data (int, float, None, list or tuple) – Scalar or vector input to be checked.

  • reference (int or float) – Reference for the value comparison.

  • sign ({'==', '>', '>=', '<', '<='}) – Sign for the value comparison.

  • is_vector (bool, default=False) – Indicator for the vector property of the data.

Raises:

ValueError – If the data has an invalid value range.