AcceptableDegrees

class AcceptableDegrees

Container of acceptable polynomial degrees by variable type for objective and constraints.

Methods

__init__

Construct acceptable degree settings.

Attributes

equality_constraints	Acceptable degrees for equality constraints.
inequality_constraints	Acceptable degrees for inequality constraints.
objective	Acceptable degrees for objective terms.

__init__(

self,

objective: dict[VariableType | Literal['Binary', 'Ising', 'Integer', 'Real'], Degree | Literal['Zero', 'Linear', 'Quadratic', 'Cubic', 'Quartic', 'HighOrder'] | int] = {VariableType.Binary: Degree.Zero, VariableType.Ising: Degree.Zero, VariableType.Integer: Degree.Zero, VariableType.Real: Degree.Zero},

equality_constraints: dict[VariableType | Literal['Binary', 'Ising', 'Integer', 'Real'], Degree | Literal['Zero', 'Linear', 'Quadratic', 'Cubic', 'Quartic', 'HighOrder'] | int] = {VariableType.Binary: Degree.Zero, VariableType.Ising: Degree.Zero, VariableType.Integer: Degree.Zero, VariableType.Real: Degree.Zero},

inequality_constraints: dict[VariableType | Literal['Binary', 'Ising', 'Integer', 'Real'], Degree | Literal['Zero', 'Linear', 'Quadratic', 'Cubic', 'Quartic', 'HighOrder'] | int] = {VariableType.Binary: Degree.Zero, VariableType.Ising: Degree.Zero, VariableType.Integer: Degree.Zero, VariableType.Real: Degree.Zero},

) → None

Construct acceptable degree settings.

Parameters:

• objective (dict[VariableType | Literal['Binary', 'Ising', 'Integer', 'Real'], amplify.Degree | typing.Literal['Zero', 'Linear', 'Quadratic', 'Cubic', 'Quartic', 'HighOrder'] | int]) – Acceptable degrees for objective terms by variable type. Defaults to {VariableType.Binary: Degree.Zero, VariableType.Ising: Degree.Zero, VariableType.Integer: Degree.Zero, VariableType.Real: Degree.Zero}.

• equality_constraints (dict[VariableType | Literal['Binary', 'Ising', 'Integer', 'Real'], amplify.Degree | typing.Literal['Zero', 'Linear', 'Quadratic', 'Cubic', 'Quartic', 'HighOrder'] | int]) – Acceptable degrees for equality constraints by variable type. Defaults to {VariableType.Binary: Degree.Zero, VariableType.Ising: Degree.Zero, VariableType.Integer: Degree.Zero, VariableType.Real: Degree.Zero}.

• inequality_constraints (dict[VariableType | Literal['Binary', 'Ising', 'Integer', 'Real'], amplify.Degree | typing.Literal['Zero', 'Linear', 'Quadratic', 'Cubic', 'Quartic', 'HighOrder'] | int]) – Acceptable degrees for inequality constraints by variable type. Defaults to {VariableType.Binary: Degree.Zero, VariableType.Ising: Degree.Zero, VariableType.Integer: Degree.Zero, VariableType.Real: Degree.Zero}.

property equality_constraints

Acceptable degrees for equality constraints.

Return type:

dict[VariableType, Degree]

property inequality_constraints

Acceptable degrees for inequality constraints.

Return type:

dict[VariableType, Degree]

property objective

Acceptable degrees for objective terms.

Return type:

dict[VariableType, Degree]