amplify.client.FixstarsClient

class FixstarsClient

A class for using Fixstars Amplify Annealing Engine client.

__init__(self: amplify.client.FixstarsClient, token: str = '', url: str = '', proxy: str = '') → None

Methods

`__init__`(self[, token, url, proxy])
`solve`(args, *kwargs)	Solves a given polynomial or matrix model.

Attributes

`compression`	Specifies whether to compress the transmitted data.
`num_bits`	The maximum number of available variables.
`parameters`	Obtains the parameter class of `FixstarsClient`.
`proxy`	Set or get the address of proxy server.
`token`	Set or get the API token.
`url`	Set or get the API URL for Fixstars Amplify Annealing Engine client.
`version`	Get the version string of the Amplify Annealing Engine.
`write_request_data`	Set or get the file path to save request data.
`write_response_data`	Set or get the file path to save request data.

property compression

Specifies whether to compress the transmitted data. Assumed True if no value is set.

Type:: bool

property num_bits

The maximum number of available variables.

Type:: int

property parameters

Obtains the parameter class of FixstarsClient.

Type:: FixstarsClientParameters

property proxy

Set or get the address of proxy server.

Type:: str

solve(*args, **kwargs)

Solves a given polynomial or matrix model.

Overloads:

solve(poly)
solve(matrix, constant)

Parameters:

poly (BinaryPoly, BinaryIntPoly, IsingPoly or IsingIntPoly) –
- Input polynomial model
matrix (BinaryMatrix, BinaryIntMatrix, IsingMatrix or IsingIntMatrix) –
- Input matrix model
constant (int or float, optional) –
- A constant value to be added to the above matrix. The type is set in accordance with the coefficients of the matrix.

Returns:

A result class that provides information about execution.

Return type:

FixstarClientResult

Example

from amplify import BinarySymbolGenerator
from amplify.client import FixstarsClient

gen = BinarySymbolGenerator()
q = gen.array(3)
f = 2 * q[0] * q[1] - q[0] - q[2] + 1  # BinaryPoly type input model

client = FixstarsClient()
client.token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client.parameters.timeout = 1000  # timeout 1 second

result = client.solve(f)

>>> f
2 q_0 q_1 - q_0 - q_2 + 1
>>> [f"energy = {s.energy}, q = {q.decode(s.values)}" for s in result]
['energy = -1.0, q = [1. 0. 1.]']

property token

Set or get the API token.

Type:: str

property url

Set or get the API URL for Fixstars Amplify Annealing Engine client. Set to https://optigan.fixstars.com by default.

Type:: str

property version

Get the version string of the Amplify Annealing Engine.

Type:: str

property write_request_data

Set or get the file path to save request data. The default value is an empty string, so saving is disabled.

Type:: str

property write_response_data

Set or get the file path to save request data. The default value is an empty string, so saving is disabled.

Type:: str