circkit.param¶

class circkit.param.Param¶

Bases: object

Describes a type of a parameter of an operation,: mainly its validation/conversion.

Default (this type): no validation/conversion

exception InvalidConstraint¶: Bases: Exception

exception InvalidValue¶: Bases: Exception

Bool¶: alias of BoolParam

Const¶: alias of ConstParam

InputName¶: alias of InputNameParam

Int¶: alias of IntParam

Str¶: alias of StrParam

Tuple¶: alias of TupleParam

class circkit.param.ConstParam¶: Bases: Param

class circkit.param.IntParam(*, min_value=None, max_value=None)¶

Bases: Param

Parameters

min_value (int) –
max_value (int) –

__init__(*, min_value=None, max_value=None)¶

Parameters

min_value (Optional[int]) –
max_value (Optional[int]) –

class circkit.param.BoolParam¶: Bases: Param

class circkit.param.StrParam¶: Bases: Param

class circkit.param.TupleParam¶: Bases: Param

class circkit.param.InputNameParam¶

Bases: Param

Accepts any subclass of str,int or arbitrarily nested tuple of those