The sequence of sympy Symbols that specify the parameters
of the CircuitFunction. If None, defaults to all symbols in circuit,
sorted alphabetically by name.
Raises
TypeError
If name is not a str, circuit is not an AbstractCircuit,
or any item in function_params is not a sympy.Symbol.
ValueError
If name is empty or if duplicate parameters are provided.
Attributes
circuit
Returns the unsubstituted circuit returned by the function.
function_params
Returns a tuple of the symbols representing the function parameters.
Call the circuit function with the given parameter values.
Args
args
The values of some/all function parameters to use.
kwargs
The values of some/all function parameters provided as keywords.
Returns
The circuit body with the function parameters substituted by the arg values.
Raises
TypeError
If the CircuitFunction is called with duplicate values for a single
parameter, the incorrect number of parameters is provided, or an unrecognized
keyword argument is provided.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-11-03 UTC."],[],[]]