Sweeper.error_check_sweep_input#

Sweeper.error_check_sweep_input(qcomp_name: str, option_name: str, option_sweep: list) → Tuple[list, Dict, int][source]#

Implement error checking of data for sweeping.

Parameters:

  • qcomp_name (str) – Component that contains the option to be swept.

  • option_name (str) – The option within qcomp_name to sweep.

  • option_sweep (list) – Each entry in the list is a value for option_name.

Returns:

The list has traversed the option Dict. addict.addict.Dict has the value from the dictionary of the searched key. The int is the observation of searching for data from arguments.

  • 0 Error not detected in the input-data.

  • 1 qcomp_name not registered in design.

  • 2 option_name is empty.

  • 3 option_name is not found as key in Dict.

  • 4 option_sweep is empty, need at least one entry.

Return type:

Tuple[list, Dict, int]