quara.utils.number_util module

check_nonnegative_number(target, parameter_name)[source]

check if target is nonnegative number.

Parameters

target (int) – the number to check.
parameter_name (str) – the parameter name of the number. this is used for error message.

Raises

ValueError – target is not nonnegative number.

Return type

None

check_positive_number(target, parameter_name)[source]

check if target is positive number.

Parameters

target (int) – the number to check.
parameter_name (str) – the parameter name of the number. this is used for error message.

Raises

ValueError – target is not positive number.

Return type

None

to_stream(seed_or_generator=None)[source]

returns np.random.Generator to generate random numbers.

Parameters: seed_or_generator (Union[int, np.random.Generator], optional) – If the type is int, generates Generator with seed seed_or_generator and returned generated Generator. If the type is Generator, returns Generator. If argument is None, returns np.random. Default value is None.
Returns: Generator for random numbers.
Return type: np.random.Generator