quara.utils.number_util module

check_nonnegative_number(target, parameter_name)

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)

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_stream=None)

returns RandomState to generate random numbers.

Parameters

seed_or_stream (Union[int, np.random.RandomState], optional) – If the type is int, generates RandomState with seed seed_or_stream and returned generated RandomState. If the type is RandomState, returns RandomState. If argument is None, returns np.random. Default value is None.

Returns

RandomState to generate random numbers.

Return type

np.random.RandomState