Check parameters

Functions to verify the validity of parameters.

biogeme.check_parameters module

Functions to verify the validity of parameters

author:

Michel Bierlaire

date:

Thu Dec 1 16:22:34 2022

biogeme.check_parameters.check_algo_name(x)

Return true if x is a valid algorithm name

Parameters:

x (str) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]

biogeme.check_parameters.is_boolean(x)

Return true if x is a boolean

Parameters:

x (float) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]

biogeme.check_parameters.is_integer(x)

Return true if x is integer

Parameters:

x (Any) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]

biogeme.check_parameters.is_non_negative(x)

Return true if x is non_negative

Parameters:

x (float) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]

biogeme.check_parameters.is_number(x)

Return true if x is a number

Parameters:

x (Any) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]

biogeme.check_parameters.is_positive(x)

Return true if x is positive

Parameters:

x (float) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]

biogeme.check_parameters.zero_one(x)

Return true if x is between zero and one

Parameters:

x (float) – value of the parameter to check

Return type:

tuple[bool, Optional[str]]