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[_Dim],
right: float,
label: str = '',
*,
penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default,
axis: tuple[()],
) 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[Dim2],
right: float,
label: str = '',
*,
penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default,
axis: int | tuple[int],
) ConstraintList
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[Dim3],
right: float,
label: str = '',
*,
penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default,
axis: int | tuple[int] | tuple[int, int],
) ConstraintList
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
greater_equal(
array: PolyArray[Dim4],
right: float,
label: str = '',
*,
penalty_formulation: Literal['Default', 'IntegerVariable', 'RealVariable', 'Relaxation', 'LinearRelaxation', 'QuadraticRelaxation'] | PenaltyFormulation = PenaltyFormulation.Default,
axis: int | tuple[int] | tuple[int, int] | tuple[int, int, int],
) ConstraintList

greater_equal

Overload 1.

Args:
  • poly (amplify.Poly)

  • right (float)

  • label (str): Defaults to ''.

  • penalty_formulation (typing.Literal[‘Default’, ‘IntegerVariable’, ‘RealVariable’, ‘Relaxation’, ‘LinearRelaxation’, ‘QuadraticRelaxation’] | amplify.PenaltyFormulation): Defaults to PenaltyFormulation.Default.

Returns:

amplify.Constraint:

Overload 2.

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 (typing.Literal[None]): Defaults to None.

Returns:

amplify.Constraint:

Overload 3.

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 (int | tuple[int, 
])

Returns:

amplify.Constraint | amplify.ConstraintList:

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: