Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK. Go to the latest version

qiskit.circuit.Parameter

class Parameter(name)

GitHub

Parameter Class for variable parameters.

Create a new named Parameter.

Parameters

name (str) – name of the Parameter, used for visual representation. This can be any unicode string, e.g. “ϕ”.

__init__

__init__(name)

Create a new named Parameter.

Parameters

name (str) – name of the Parameter, used for visual representation. This can be any unicode string, e.g. “ϕ”.


Methods

__init__(name)Create a new named Parameter.
assign(parameter, value)Assign one parameter to a value, which can either be numeric or another parameter expression.
bind(parameter_values)Binds the provided set of parameters to their corresponding values.
conjugate()Return the conjugate, which is the ParameterExpression itself, since it is real.
subs(parameter_map)Substitute self with the corresponding parameter in parameter_map.

Attributes

nameReturns the name of the Parameter.
parametersReturns a set of the unbound Parameters in the expression.

assign

assign(parameter, value)

Assign one parameter to a value, which can either be numeric or another parameter expression.

Parameters

  • parameter (Parameter) – A parameter in this expression whose value will be updated.
  • value (Union[ParameterExpression, float, int]) – The new value to bind to.

Return type

ParameterExpression

Returns

A new expression parameterized by any parameters which were not bound by assignment.

bind

bind(parameter_values)

Binds the provided set of parameters to their corresponding values.

Parameters

parameter_values (Dict) – Mapping of Parameter instances to the numeric value to which they will be bound.

Raises

  • CircuitError

    • If parameter_values contains Parameters outside those in self. - If a non-numeric value is passed in parameter_values.
  • ZeroDivisionError

    • If binding the provided values requires division by zero.

Return type

ParameterExpression

Returns

A new expression parameterized by any parameters which were not bound by parameter_values.

conjugate

conjugate()

Return the conjugate, which is the ParameterExpression itself, since it is real.

Return type

ParameterExpression

name

Returns the name of the Parameter.

parameters

Returns a set of the unbound Parameters in the expression.

Return type

Set

subs

subs(parameter_map)

Substitute self with the corresponding parameter in parameter_map.

Was this page helpful?
Report a bug or request content on GitHub.