equal_to

equal_to(poly: Poly, right: float, label: str = '') → Constraint
equal_to(array: PolyArray[_Dim], right: float, label: str = '', *, axis: Literal[None] = None) → Constraint
equal_to(
array: PolyArray[Dim],
right: float,
label: str = '',
*,
axis: int | tuple[int, ...],
) → Constraint | ConstraintList
equal_to(array: PolyArray[_Dim], right: float, label: str = '', *, axis: tuple[()]) → ConstraintList
equal_to(array: PolyArray[Dim1], right: float, label: str = '', *, axis: int | tuple[int]) → Constraint
equal_to(array: PolyArray[Dim2], right: float, label: str = '', *, axis: tuple[int, int]) → Constraint
equal_to(array: PolyArray[Dim2], right: float, label: str = '', *, axis: int | tuple[int]) → ConstraintList
equal_to(array: PolyArray[Dim3], right: float, label: str = '', *, axis: tuple[int, int, int]) → Constraint
equal_to(
array: PolyArray[Dim3],
right: float,
label: str = '',
*,
axis: int | tuple[int] | tuple[int, int],
) → ConstraintList
equal_to(array: PolyArray[Dim4], right: float, label: str = '', *, axis: tuple[int, int, int, int]) → Constraint
equal_to(
array: PolyArray[Dim4],
right: float,
label: str = '',
*,
axis: int | tuple[int] | tuple[int, int] | tuple[int, int, int],
) → ConstraintList

Create an equality constraint. equal_to equal_to equal_to equal_to equal_to equal_to equal_to equal_to equal_to equal_to

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 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 ''.

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 ''.

  • 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 ''.

  • 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 ''.

  • axis (tuple[()])

Returns:

amplify.ConstraintList:

Overload 5.

Args:

  • array (amplify.PolyArray[Dim1])

  • right (float)

  • label (str): Defaults to ''.

  • axis (int | tuple[int])

Returns:

amplify.Constraint:

Overload 6.

Args:

  • array (amplify.PolyArray[Dim2])

  • right (float)

  • label (str): Defaults to ''.

  • axis (tuple[int, int])

Returns:

amplify.Constraint:

Overload 7.

Args:

  • array (amplify.PolyArray[Dim2])

  • right (float)

  • label (str): Defaults to ''.

  • axis (int | tuple[int])

Returns:

amplify.ConstraintList:

Overload 8.

Args:

  • array (amplify.PolyArray[Dim3])

  • right (float)

  • label (str): Defaults to ''.

  • axis (tuple[int, int, int])

Returns:

amplify.Constraint:

Overload 9.

Args:

  • array (amplify.PolyArray[Dim3])

  • right (float)

  • label (str): Defaults to ''.

  • axis (int | tuple[int] | tuple[int, int])

Returns:

amplify.ConstraintList:

Overload 10.

Args:

  • array (amplify.PolyArray[Dim4])

  • right (float)

  • label (str): Defaults to ''.

  • axis (tuple[int, int, int, int])

Returns:

amplify.Constraint:

Overload 11.

Args:

  • array (amplify.PolyArray[Dim4])

  • right (float)

  • label (str): Defaults to ''.

  • axis (int | tuple[int] | tuple[int, int] | tuple[int, int, int])

Returns:

amplify.ConstraintList: