modules.devices.qrisp_simulator.qrisp_simulator.QrispSimulator

class QrispSimulator

Bases: Device, ABC

Abstract class to use the Qrisp Simulator.

__init__()

Constructor method.

Methods

__init__()	Constructor method.
get_available_submodule_options()	Gets the list of available options.
get_available_submodules(option)	If the module has submodules depending on certain options, this method should adjust the submodule_options accordingly.
get_backend()	Returns backend.
get_backend_config()	Returns backend configurations.
get_default_submodule(option)	Returns the default submodule based on the given option.
get_depending_parameters(option, config)	If the module has parameters depending on certain options, this method should return the parameters for the given option.
get_device()	Returns device.
get_device_name()	Returns the device name.
get_parameter_options()	Returns the configurable settings for this application, not Applicable for Qrisp Simulator for now.
get_requirements()	Return requirements of this module.
get_submodule(option)	Submodule is instantiated according to the information given in self.sub_options.
postprocess(input_data, config, **kwargs)	Returns input data and adds device name to the metrics class instance.
preprocess(input_data, config, **kwargs)	Returns instance of device class (self) and time it takes to call config.
set_config(config)	Sets the device configuration.

class Config

Bases: TypedDict

Attributes of a valid config.

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

get_available_submodule_options() → list

Gets the list of available options.

Returns:

List of module options

get_available_submodules(option: list) → list

If the module has submodules depending on certain options, this method should adjust the submodule_options accordingly.

Parameters:

option -- List of chosen options

Returns:

List of available submodules

get_backend() → any

Returns backend.

Returns:

Instance of the backend class

get_backend_config()

Returns backend configurations.

Returns:

Backend config for the emulator

get_default_submodule(option: str) → Core

Returns the default submodule based on the given option.

Parameters:

option -- The submodule option to select

Returns:

Instance of the selected submodule

Raises:

NotImplemented -- If the provided option is not implemented

get_depending_parameters(option: str, config: dict) → dict

If the module has parameters depending on certain options, this method should return the parameters for the given option.

Parameters:

• option -- The chosen option

• config -- Current config dictionary

Returns:

The parameters for the given option

get_device() → any

Returns device.

Returns:

Instance of the device class

get_device_name() → str

Returns the device name.

Returns:

Name of the device

get_parameter_options() → dict

Returns the configurable settings for this application, not Applicable for Qrisp Simulator for now.

Example: "doppler": {

"values": [False, True], "description": "Simulate doppler noise? Has a large impact on performance!"

}

static get_requirements() → list[dict]

Return requirements of this module.

Returns:

List of dict with requirements of this module

get_submodule(option: str) → Core

Submodule is instantiated according to the information given in self.sub_options. If self.sub_options is None, get_default_submodule is called as a fallback.

Parameters:

option -- String with the options

Returns:

Instance of a module

postprocess(input_data: any, config: dict, **kwargs) → tuple[any, float]

Returns input data and adds device name to the metrics class instance.

Parameters:

• input_data -- Input data passed by the parent module

• config -- Solver config

• kwargs -- Optional keyword arguments

Returns:

Output and time needed

preprocess(input_data: any, config: dict, **kwargs) → tuple[any, float]

Returns instance of device class (self) and time it takes to call config.

Parameters:

• input_data -- Input data (not used)

• config -- Config for the device

• kwargs -- Optional keyword arguments

Returns:

Output and time needed

set_config(config)

Sets the device configuration.

Parameters:

config -- Configuration settings for the device