Module QuantumPathQSOAPySDK.circuit.annealing.components

Classes

class AuxData (name: str, value)

Create Circuit Auxiliary Data.

Prerequisites

• Created circuit.

Parameters

name : str

Circuit Auxiliary Data name.

value : int | float | list

Auxiliary Data value or list of values.

Methods

def getName(self)

Get Circuit Auxiliary Data name.

Prerequisites

• Created auxiliary data.

Output

str

def getUiID(self)

Get Circuit Auxiliary Data uiID.

Prerequisites

• Created auxiliary data.

Output

str

def getValue(self)

Get Circuit Auxiliary Data value.

Prerequisites

• Created auxiliary data.

Output

str

class Class (name: str, numberOfVars, description: str = '')

Create Circuit Class.

Prerequisites

• Created circuit.

Parameters

name : str

Circuit Class name.

numberOfVars : int | Parameter obj

Number of Class variables.

description : str

Optional argument. Class description.

Methods

def addProperty(self, name: str, value: list)

Add Class Property.

Prerequisites

• Created class.

Parameters

name : str

Class Property name.

value : list

List of property values. It may be the same that Class number of variables.

def getDescription(self)

Get Circuit Class description.

Prerequisites

• Created class.

Output

str

def getName(self)

Get Circuit Class name.

Prerequisites

• Created class.

Output

str

def getNumberOfVars(self)

Get Circuit Class number of variables.

Prerequisites

• Created class.

Output

str

def getProperties(self)

Get Circuit Class properties.

Prerequisites

• Created class.

Output

list

def getUiID(self)

Get Circuit Class uiID.

Prerequisites

• Created class.

Output

str

class LinearExp (variable: tuple, coefficient='')

Create Linear expression.

Prerequisites

• Created rule.

Parameters

variable : tuple

Circuit variable and values. First element: Variable obj. Second element: value or list of values (One per class in variable).

coefficient : int | float | str | Parameter

Optional argument. Coefficient value.

Ancestors

• QuantumPathQSOAPySDK.circuit.annealing.components.__Expression

class OffsetExp (offset)

Create Offset expression.

Prerequisites

• Created rule.

Parameters

offset : int | float | str | Parameter

Offset value.

Ancestors

• QuantumPathQSOAPySDK.circuit.annealing.components.__Expression

class Parameter (name: str, value)

Create Circuit Parameter.

Prerequisites

• Created circuit.

Parameters

name : str

Circuit Parameter name.

value : int | float | str

Parameter value.

Methods

def getName(self)

Get Circuit Parameter name.

Prerequisites

• Created parameter.

Output

str

def getUiID(self)

Get Circuit Parameter uiID.

Prerequisites

• Created parameter.

Output

str

def getValue(self)

Get Circuit Parameter value.

Prerequisites

• Created parameter.

Output

str

class QuadraticExp (variable1: tuple, variable2: tuple, coefficient='')

Add Quadratic expression.

Prerequisites

• Created rule.

Parameters

variable1 : tuple

Circuit variable and values. First element: Variable obj. Second element: value or list of values (One per class in variable).

variable2 : tuple

Circuit variable and values. First element: Variable obj. Second element: value or list of values (One per class in variable).

coefficient : int | float | str | Parameter

Optional argument. Coefficient value.

Ancestors

• QuantumPathQSOAPySDK.circuit.annealing.components.__Expression

class Rule (name: str, lambdaValue, description='', disabled=False)

Create Circuit Rule.

Prerequisites

• Created circuit.

Parameters

name : str

Circuit Rule name.

lambdaValue : int | float | str

Parameter value.

description : str

Optional argument. Rule description.

disabled : bool

Optional argument. Enable / disable rule.

Methods

def addExpression(self, expression)

Add Rule Expression.

Prerequisites

• Created rule.

Parameters

expression : SummationExp obj | SquaredExp obj | LinearExp obj | QuadraticExp obj | OffsetExp obj | list

Expression to add. It could be an object or a list of following objects: SummationExp, SquaredExp, LinearExp, QuadraticExp or OffsetExp.

Output

Rule obj

def getDescription(self)

Get Circuit Rule description.

Prerequisites

• Created rule.

Output

str

def getDisabled(self)

Get Circuit Rule disable status.

Prerequisites

• Created rule.

Output

str

def getExpressions(self)

Get Circuit Rule expressions.

Prerequisites

• Created rule.

Output

list

def getLambda(self)

Get Circuit Rule lambda.

Prerequisites

• Created rule.

Output

str

def getName(self)

Get Circuit Rule name.

Prerequisites

• Created rule.

Output

str

def getUiID(self)

Get Circuit Rule uiID.

Prerequisites

• Created rule.

Output

str

class SquaredExp (expression)

Create Squared expression.

Prerequisites

• Created rule.

Parameters

expression : SummationExp obj | LinearExp obj | OffsetExp obj | list

Expression or list of expressions to be squared. It could be a Summation, Linear, or Offset expression.

Ancestors

• QuantumPathQSOAPySDK.circuit.annealing.components.__Expression

class SummationExp (fromValue, toValue, expression, iterator: str = 'i')

Create Summation expression.

Prerequisites

• Created rule.

Parameters

fromValue : int | float | str | Parameter

Start value of the summation iteration.

toValue : int | float | str | Parameter

End value of the summation iteration.

expression : SummationExp obj | SquaredExp obj | LinearExp obj | QuadraticExp obj | OffsetExp obj | list

Expression or list of expressions to be inside of the summation. It could be a Summation, Squared, Linear, Quadratic or Offset expression.

iterator : str

Iterator name.

Ancestors

• QuantumPathQSOAPySDK.circuit.annealing.components.__Expression

class Variable (name: str, classes, description: str = '')

Create Circuit Variable.

Prerequisites

• Created circuit.

Parameters

name : str

Circuit Variable name.

classes : Class obj | list

Class object or list of Class objects.

description : str

Optional argument. Variable description.

Methods

def getClasses(self)

Get Circuit Variable Classes uiID.

Prerequisites

• Created variable.

Output

list

def getDescription(self)

Get Circuit Variable description.

Prerequisites

• Created variable.

Output

str

def getName(self)

Get Circuit Variable name.

Prerequisites

• Created variable.

Output

str

def getUiID(self)

Get Circuit Variable uiID.

Prerequisites

• Created variable.

Output

str