qudi.util.constraints.ScalarConstraint

class qudi.util.constraints.ScalarConstraint(default: int | float, bounds: Tuple[int | float, int | float], increment: int | float | None = None, enforce_int: bool | None = False, checker: Callable[[int | float], bool] | None = None)[source]

Bases: builtins.object

__init__(default: int | float, bounds: Tuple[int | float, int | float], increment: int | float | None = None, enforce_int: bool | None = False, checker: Callable[[int | float], bool] | None = None) → None[source]

Methods

`__init__`(default, bounds[, increment, ...])
`check`(value)
`check_custom`(value)
`check_value_range`(value)
`check_value_type`(value)
`clip`(value)
`copy`()
`is_valid`(value)

Attributes

`bounds`
`default`
`enforce_int`
`increment`
`max`
`maximum`
`min`
`minimum`
`step`

__init__(default: int | float, bounds: Tuple[int | float, int | float], increment: int | float | None = None, enforce_int: bool | None = False, checker: Callable[[int | float], bool] | None = None) → None[source]

property bounds: Tuple[int | float, int | float]: !! processed by numpydoc !!

check(value: int | float) → None[source]

check_custom(value: Any) → None[source]

check_value_range(value: int | float) → None[source]

check_value_type(value: Any) → None[source]

clip(value: int | float) → int | float[source]

copy() → object[source]

property default: int | float: !! processed by numpydoc !!

property enforce_int: bool: !! processed by numpydoc !!

property increment: None | int | float: !! processed by numpydoc !!

is_valid(value: int | float) → bool[source]

property max: int | float: !! processed by numpydoc !!

property maximum: int | float: !! processed by numpydoc !!

property min: int | float: !! processed by numpydoc !!

property minimum: int | float: !! processed by numpydoc !!

property step: None | int | float: !! processed by numpydoc !!