QulacsClient

class QulacsClient

Bases: QuantumBaseClient[AlgoType, QulacsJobMeta, QulacsCircuit]

Client that executes quantum circuits using the Qulacs simulator.

Runs circuits locally using Qulacs state-vector simulation. Accepts any algorithm conforming to QuantumAlgoProtocol via the algo parameter.

Methods

__init__

Initialize a QuantumBaseClient.

solve

Call the solver service to solve the given optimization problem.

version

Return the Qulacs package version.

Attributes

acceptable_degrees

Polynomial degrees accepted by the algorithm for the objective and constraints.

algo

The algorithm class used by this client.

parameters

Algorithm parameters instance.

__init__(algo: type[AlgoType]) None

Initialize a QuantumBaseClient.

Parameters:

algo (type[AlgoType]) – The algorithm class to use. Must conform to the QuantumAlgoProtocol protocol.

solve(objective: Poly | Matrix, constraints: ConstraintList | None, dry_run: bool = False) CustomClientResultProtocol | None

Call the solver service to solve the given optimization problem.

Parameters:
  • objective (Poly | Matrix) – The objective function to minimize.

  • constraints (ConstraintList | None) – Constraints for the problem. If None, no constraints are applied.

  • dry_run (bool) – If True, validate inputs without executing circuits and return None.

Returns:

The algorithm result, or None if dry_run is True.

Return type:

CustomClientResultProtocol | None

version() str

Return the Qulacs package version.

property acceptable_degrees: AcceptableDegrees

Polynomial degrees accepted by the algorithm for the objective and constraints.

property algo: type[AlgoType]

The algorithm class used by this client.

parameters

Algorithm parameters instance. The concrete type depends on the algorithm; for QAOA this is QAOA.Parameters. Modify this to configure the algorithm before calling solve().