2.1. czekitout.check

Contains functions that facilitate validation with useful error messages when exceptions are thrown.

Functions

if_bool	Check whether input object is boolean.
if_bool_array_3d	Check whether input object is a 3D boolean array.
if_bool_matrix	Check whether input object is a 2D boolean array.
if_bool_seq	Check whether input object is a sequence of booleans.
if_callable	Check whether input object is callable.
if_complex_numpy_array	Check whether input object is a complex-valued numpy array.
if_complex_numpy_matrix	Check whether input object is a complex-valued 2D numpy array.
if_dict_like	Check whether input object is dictionary-like.
if_float	Check whether input object is a real number.
if_float_seq	Check whether input object is a sequence of real numbers.
if_instance_of_any_accepted_types	Check whether input object is one of any given accepted types.
if_int	Check whether input object is an integer.
if_int_seq	Check whether input object is a sequence of integers.
if_multi_dim_slice_like	Check whether input object is a multi-dimensional slice-like object.
if_nonnegative_float	Check whether input object is a nonnegative real number.
if_nonnegative_float_seq	Check whether input object is a sequence of nonnegative real numbers.
if_nonnegative_int	Check whether input object is a nonnegative integer.
if_nonnegative_int_seq	Check whether input object is a sequence of nonnegative integers.
if_nonnegative_numpy_array	Check whether input object is a nonnegative numpy array.
if_nonnegative_numpy_matrix	Check whether input object is a nonnegative numpy matrix.
if_one_of_any_accepted_strings	Check whether input object is one of any given accepted strings.
if_pair_of_floats	Check whether input object is a pair of real numbers.
if_pair_of_ints	Check whether input object is a pair of integers.
if_pair_of_nonnegative_floats	Check whether input object is a pair of nonnegative real numbers.
if_pair_of_nonnegative_ints	Check whether input object is a pair of nonnegative integers.
if_pair_of_positive_floats	Check whether input object is a pair of positive real numbers.
if_pair_of_positive_ints	Check whether input object is a pair of positive integers.
if_pairs_of_floats	Check whether input object is a sequence of pairs of real numbers.
if_pairs_of_ints	Check whether input object is a sequence of pairs of integers.
if_pairs_of_nonnegative_ints	Check whether input object is a sequence of pairs of nonnegative integers.
if_positive_float	Check whether input object is a positive real number.
if_positive_float_seq	Check whether input object is a sequence of positive real numbers.
if_positive_int	Check whether input object is a positive integer.
if_positive_int_seq	Check whether input object is a sequence of positive integers.
if_quadruplet_of_nonnegative_ints	Check whether input object is a quadruplet of nonnegative integers.
if_quadruplet_of_positive_floats	Check whether input object is a quadruplet of positive real numbers.
if_real_numpy_array	Check whether input object is a real-valued numpy array.
if_real_numpy_array_1d	Check whether input object is a real-valued 1D numpy array.
if_real_numpy_array_3d	Check whether input object is a real-valued 3D numpy array.
if_real_numpy_matrix	Check whether input object is a real-valued 2D numpy array.
if_real_two_column_numpy_matrix	Check whether input object is a real-valued 2D two-column numpy array.
if_scalar	Check whether input object is a scalar.
if_single_dim_slice_like	Check whether input object is a one-dimensional slice-like object.
if_str_like	Check whether input object is string-like.
if_str_like_seq	Check whether input object is a sequence of string-like objects.