Algebra

Algebraic classes and numerics

Class

amplify.Poly

The polynomial class used for representing objective functions and constraints.

amplify.PolyArray

A NumPy-like multidimensional array of polynomials.

amplify.Matrix

This class represents a quadratic objective in coefficient-matrix form, expressed as \(x^\top Q x + p^\top x + c\).

amplify.Variable

Class for variable information.

amplify.VariableGenerator

Provides functionality to generate a decision variable or an array of decision variables.

Function

amplify.sum

Sum elements of a polynomial array, sequence, or iterator.

amplify.einsum

Einstein summation for polynomial arrays and NumPy arrays.

amplify.dot

Compute dot product for polynomial arrays and NumPy arrays.

amplify.matmul

Matrix multiplication for polynomial arrays and NumPy arrays.

Attribute

Enum

amplify.VariableType

Enum of decision variable types: Binary, Ising, Integer, and Real.

Misc

amplify.Dim

Base class for PolyArray dimension types.

amplify.Dim0

A 0D PolyArray.

amplify.Dim1

A 1D PolyArray.

amplify.Dim2

A 2D PolyArray.

amplify.Dim3

A 3D PolyArray.

amplify.Dim4

A 4D PolyArray.