Constraint

class Constraint

Methods

__init__	__init__
is_satisfied	is_satisfied

Attributes

conditional	conditional property
label	label property
penalty	penalty property
weight	weight property

__add__(self, arg: Constraint, /) → ConstraintList

__add__

Parameters:

arg (Constraint) –

Return type:

ConstraintList

__eq__(self, arg: Constraint, /) → bool

__eq__

Parameters:

arg (Constraint) –

Return type:

bool

__imul__(self, arg: float, /) → Constraint

__imul__

Parameters:

arg (float) –

Return type:

Constraint

__init__(

self,

left: Poly,

bounds: tuple[float | None, float | None],

penalty: Poly,

label: str = '',

) → None

__init__(self, left: Poly, eq: float, penalty: Poly, label: str = '') → None

__init__(self, left: Poly, le: float, penalty: Poly, label: str = '') → None

__init__(self, left: Poly, ge: float, penalty: Poly, label: str = '') → None

__init__

Overloading:

1. __init__(self, left: amplify.Poly, bounds: tuple[Optional[float], Optional[float]], penalty: amplify.Poly, label: str = ‘’) -> None

Args:

• left (amplify.Poly):

• bounds (tuple[Optional[float], Optional[float]]):

• penalty (amplify.Poly):

• label (str): Defaults to ''.

2. __init__(self, left: amplify.Poly, eq: float, penalty: amplify.Poly, label: str = ‘’) -> None

Args:

• left (amplify.Poly):

• eq (float):

• penalty (amplify.Poly):

• label (str): Defaults to ''.

3. __init__(self, left: amplify.Poly, le: float, penalty: amplify.Poly, label: str = ‘’) -> None

Args:

• left (amplify.Poly):

• le (float):

• penalty (amplify.Poly):

• label (str): Defaults to ''.

4. __init__(self, left: amplify.Poly, ge: float, penalty: amplify.Poly, label: str = ‘’) -> None

Args:

• left (amplify.Poly):

• ge (float):

• penalty (amplify.Poly):

• label (str): Defaults to ''.

__itruediv__(self, arg: float, /) → Constraint

__itruediv__

Parameters:

arg (float) –

Return type:

Constraint

__mul__(self, arg: float, /) → Constraint

__mul__

Parameters:

arg (float) –

Return type:

Constraint

__ne__(self, arg: Constraint, /) → bool

__ne__

Parameters:

arg (Constraint) –

Return type:

bool

__radd__(self, arg: int, /) → Constraint

__radd__

Parameters:

arg (int) –

Return type:

Constraint

__repr__(self) → str

__repr__

Return type:

str

__rmul__(self, arg: float, /) → Constraint

__rmul__

Parameters:

arg (float) –

Return type:

Constraint

__str__(self) → str

__str__

Return type:

str

__truediv__(self, arg: float, /) → Constraint

__truediv__

Parameters:

arg (float) –

Return type:

Constraint

is_satisfied(self, values: Values) → bool

is_satisfied(self, mapping: dict[Poly, float | int]) → bool

is_satisfied

Overloading:

1. is_satisfied(self, values: amplify.Values) -> bool

Args:

• values (amplify.Values):

Returns:

bool:

2. is_satisfied(self, mapping: dict[amplify.Poly, Union[float, int]]) -> bool

Args:

• mapping (dict[amplify.Poly, Union[float, int]]):

Returns:

bool:

property conditional

conditional property

Return type:

tuple[Poly, str, Union[float, tuple[float, float]]]

property label

label property

Return type:

str

property penalty

penalty property

Return type:

Poly

property weight

weight property

Return type:

float