OptionsProvider

class OptionsProvider

The OptionsProvider interface enables derived subclasses to provide a description of any and all command line options that they can take to drive and control their execution and behavior.

Subclassed by xacc::Accelerator, xacc::Compiler, xacc::quantum::CircuitOptimizer, xacc::quantum::DefaultParameterSetter

Public Functions

virtual OptionPairs getOptions()

Return a Boost options_description instance that describes the options available for this derived subclass.

virtual bool handleOptions(const std::map<std::string, std::string> &arg_map)

Given user-input command line options, perform some operation. Returns true if runtime should exit, false otherwise.

Return

exit True if exit, false otherwise

Parameters
  • map: The mapping of options to values

virtual ~OptionsProvider()

The destructor