greater_equal¶

greater_equal( poly: Poly, right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, ) → Constraint¶

greater_equal( array: PolyArray[_Dim], right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, axis: Literal[None] = None, ) → Constraint

greater_equal( array: PolyArray[Dim], right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, axis: int | tuple[int, ...], ) → Constraint | ConstraintList

greater_equal( array: PolyArray[Dim1], right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, axis: int | tuple[int], ) → Constraint

greater_equal( array: PolyArray[Dim2], right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, axis: tuple[int, int], ) → Constraint

greater_equal( array: PolyArray[Dim3], right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, axis: tuple[int, int, int], ) → Constraint

greater_equal( array: PolyArray[Dim4], right: float, label: str = '', *, penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default, axis: tuple[int, int, int, int], ) → Constraint

Create a greater-than-or-equal constraint. greater_equal greater_equal greater_equal greater_equal greater_equal greater_equal greater_equal greater_equal greater_equal greater_equal

For a single polynomial poly, constrain poly >= right. For an array with axis=None (default), constrain the sum of all elements of array to be greater than or equal to right, returning a single Constraint. For an array with axis specified, reduce along the given axis or axes. Return a Constraint if all axes are reduced, or a ConstraintList with one constraint per remaining slice otherwise.

Overload 1.

Args:

poly (amplify.Poly): poly
right (float): Right-hand side value.
label (str): Constraint label. Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Penalty formulation method. Defaults to PenaltyFormulation.Default.

Returns:

amplify.Constraint: Constraint object.

Overload 2.

Args:

array (amplify.PolyArray[_Dim]): array
right (float): Right-hand side value.
label (str): Constraint label. Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Penalty formulation method. Defaults to PenaltyFormulation.Default.
axis (typing.Literal[None]): Axis or axes to reduce. Defaults to None.

Returns:

amplify.Constraint: Single constraint when all axes are reduced; otherwise one constraint per remaining slice.

Overload 3.

Args:

array (amplify.PolyArray[Dim]): array
right (float): Right-hand side value.
label (str): Constraint label. Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Penalty formulation method. Defaults to PenaltyFormulation.Default.
axis (int | tuple[int, …]): Axis or axes to reduce.

Returns:

amplify.Constraint | amplify.ConstraintList: Single constraint when all axes are reduced; otherwise one constraint per remaining slice.

Overload 4.

Args:

array (amplify.PolyArray[_Dim])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (tuple[()])

Returns:

amplify.ConstraintList:

Overload 5.

Args:

array (amplify.PolyArray[Dim1])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (int | tuple[int])

Returns:

amplify.Constraint:

Overload 6.

Args:

array (amplify.PolyArray[Dim2])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (tuple[int, int])

Returns:

amplify.Constraint:

Overload 7.

Args:

array (amplify.PolyArray[Dim2])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (int | tuple[int])

Returns:

amplify.ConstraintList:

Overload 8.

Args:

array (amplify.PolyArray[Dim3])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (tuple[int, int, int])

Returns:

amplify.Constraint:

Overload 9.

Args:

array (amplify.PolyArray[Dim3])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (int | tuple[int] | tuple[int, int])

Returns:

amplify.ConstraintList:

Overload 10.

Args:

array (amplify.PolyArray[Dim4])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (tuple[int, int, int, int])

Returns:

amplify.Constraint:

Overload 11.

Args:

array (amplify.PolyArray[Dim4])
right (float)
label (str): Defaults to ''.
penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.
axis (int | tuple[int] | tuple[int, int] | tuple[int, int, int])

Returns:

amplify.ConstraintList: