OperatorBase.assign_parameters

abstract OperatorBase.assign_parameters(param_dict)[source]

Binds scalar values to any Terra Parameters in the coefficients or primitives of the Operator, or substitutes one Parameter for another. This method differs from Terra’s assign_parameters in that it also supports lists of values to assign for a give Parameter, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an OpList. If lists of parameterizations are used, every Parameter in the param_dict must have the same length list of parameterizations.

Parameters

param_dict (Dict[ParameterExpression, Union[Number, ParameterExpression, List[Union[Number, ParameterExpression]]]]) – The dictionary of Parameters to replace, and values or lists of values by which to replace them.

Return type

OperatorBase

Returns

The OperatorBase with the Parameters in self replaced by the values or Parameters in param_dict. If param_dict contains parameterization lists, this OperatorBase is an OpList.