"""Functions to verify the validity of parameters
:author: Michel Bierlaire
:date: Thu Dec 1 16:22:34 2022
"""
from typing import Any, Optional
import numbers
import biogeme.optimization as opt
[docs]
def zero_one(x: float) -> tuple[bool, Optional[str]]:
"""Return true if x is between zero and one
:param x: value of the parameter to check
"""
if 0 <= x <= 1:
return (True, None)
return False, 'Value must be between zero and one'
[docs]
def is_number(x: Any) -> tuple[bool, Optional[str]]:
"""Return true if x is a number
:param x: value of the parameter to check
"""
if isinstance(x, numbers.Number):
return (True, None)
return False, 'Value must be a number'
[docs]
def is_positive(x: float) -> tuple[bool, Optional[str]]:
"""Return true if x is positive
:param x: value of the parameter to check
"""
if x > 0:
return (True, None)
return False, 'Value must be positive'
[docs]
def is_non_negative(x: float) -> tuple[bool, Optional[str]]:
"""Return true if x is non_negative
:param x: value of the parameter to check
"""
if x >= 0:
return (True, None)
return False, 'Value must be non negative'
[docs]
def is_integer(x: Any) -> tuple[bool, Optional[str]]:
"""Return true if x is integer
:param x: value of the parameter to check
"""
if isinstance(x, numbers.Integral):
return (True, None)
return False, 'Value must be an integer'
[docs]
def check_algo_name(x: str) -> tuple[bool, Optional[str]]:
"""Return true if x is a valid algorithm name
:param x: value of the parameter to check
"""
possibilities = list(opt.algorithms.keys())
if x in possibilities:
return True, None
return False, f'Value must be in: {possibilities}'
[docs]
def is_boolean(x: Any) -> tuple[bool, Optional[str]]:
"""Return true if x is a boolean
:param x: value of the parameter to check
:type x: float
"""
if isinstance(x, bool):
return True, None
return False, 'Value must be boolean'