amplify.client.ToshibaClient

class ToshibaClient

A class for using the Toshiba client in Fixstars Amplify SDK.

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

Methods

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

Attributes

`num_bits`	The maximum number of available variables.
`parameters`	The parameters of the Toshiba SBM client in Fixstars Amplify SDK.
`proxy`	Set or get the address of proxy server.
`solver`	Specifies the type of SBM solver.
`token`	Set or get the API token of the SBM instance.
`url`	URL address of the SBM instance.
`version`	Get the API version string of the Toshiba SBM/SQBM+.
`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 num_bits

The maximum number of available variables.

Type:: int

property parameters

The parameters of the Toshiba SBM client in Fixstars Amplify SDK.

Type:: ToshibaClientParameters

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:

ToshibaClientResult

Example

from amplify import BinarySymbolGenerator
from amplify.client import ToshibaClient

gen = BinarySymbolGenerator()
q = gen.array(3)
f = 2 * q[0] * q[1] - q[0] - q[2] + 1

client = ToshibaClient()
client.url = "http://xx.xxx.xxx.xx:xxxx/"
client.parameters.timeout = 1  # 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 solver

Specifies the type of SBM solver. Can be selected from "ising", "autoising", "tsp", "qap", and "shift". Set to "ising" by default.

Type:: str

property token

Set or get the API token of the SBM instance.

Type:: str

property url

URL address of the SBM instance.

Type:: str

property version

Get the API version string of the Toshiba SBM/SQBM+.

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