Constraint¶
- class Constraint¶
Methods
__init__
is_satisfied
Attributes
conditional property
label property
penalty property
weight property
- __add__(self, arg: Constraint, /) ConstraintList ¶
__add__
- Parameters:
arg (Constraint) –
- Return type:
- __eq__(self, arg: Constraint, /) bool ¶
__eq__
- Parameters:
arg (Constraint) –
- Return type:
- __imul__(self, arg: float, /) Constraint ¶
__imul__
- Parameters:
arg (float) –
- Return type:
- __init__( ) 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:
- __mul__(self, arg: float, /) Constraint ¶
__mul__
- Parameters:
arg (float) –
- Return type:
- __ne__(self, arg: Constraint, /) bool ¶
__ne__
- Parameters:
arg (Constraint) –
- Return type:
- __radd__(self, arg: int, /) Constraint ¶
__radd__
- Parameters:
arg (int) –
- Return type:
- __rmul__(self, arg: float, /) Constraint ¶
__rmul__
- Parameters:
arg (float) –
- Return type:
- __truediv__(self, arg: float, /) Constraint ¶
__truediv__
- Parameters:
arg (float) –
- Return type:
- 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