Simulators::SimulatorsFactory Class Reference

Factory for simulators. More...

#include <Factory.h>

Collaboration diagram for Simulators::SimulatorsFactory:

Static Public Member Functions
static MAESTRO_FACTORY_EXPORT std::unique_ptr< ISimulator >	CreateImmediateSimulatorUnique (SimulatorType type, SimulationType method=SimulationType::kStatevector)
static std::shared_ptr< PathIntegralSimulator >	CreatePathIntegralSimulator ()
static MAESTRO_FACTORY_EXPORT std::shared_ptr< ISimulator >	CreateSimulator (SimulatorType t=SimulatorType::kQCSim, SimulationType method=SimulationType::kMatrixProductState)
	Create a quantum computing simulator.
static MAESTRO_FACTORY_EXPORT std::unique_ptr< ISimulator >	CreateSimulatorUnique (SimulatorType t=SimulatorType::kQCSim, SimulationType method=SimulationType::kMatrixProductState)
	Create a quantum computing simulator.
static int	GetGpuDeviceCount ()
static MAESTRO_FACTORY_EXPORT std::shared_ptr< QuestLibSim >	GetQuestLibrary ()
static bool	InitGpuLibrary ()
static MAESTRO_FACTORY_EXPORT bool	InitQuestLibrary ()
static MAESTRO_FACTORY_EXPORT bool	InitQuestLibraryWithMute ()
static bool	IsGpuLibraryAvailable (int=-1)
static MAESTRO_FACTORY_EXPORT bool	IsQuestLibraryAvailable ()
static void	SelectGpuDevice (int)

Detailed Description

Factory for simulators.

Create either a qiskit aer or qcsim simulator.

Definition at line 50 of file Simulators/Core/Factory.h.

Member Function Documentation

CreateImmediateSimulatorUnique()

std::unique_ptr< ISimulator > Simulators::SimulatorsFactory::CreateImmediateSimulatorUnique ( SimulatorType type, SimulationType method = SimulationType::kStatevector )

static

Definition at line 25 of file Factory.cpp.

References Simulators::FactoryBackends::CreateQCSimImmediate(), CreateSimulatorUnique(), Simulators::kGpuSim, Simulators::kQCSim, and Simulators::kQiskitAer.

Referenced by CreateSimulatorUnique().

CreatePathIntegralSimulator()

std::shared_ptr< PathIntegralSimulator > Simulators::SimulatorsFactory::CreatePathIntegralSimulator ( )

inlinestatic

Definition at line 213 of file Simulators/Core/Factory.h.

CreateSimulator()

std::shared_ptr< ISimulator > Simulators::SimulatorsFactory::CreateSimulator ( SimulatorType t = SimulatorType::kQCSim, SimulationType method = SimulationType::kMatrixProductState )

static

Create a quantum computing simulator.

Parameters

t	The type of simulator to create.

Returns

The simulator wrapped in a shared pointer.

Definition at line 45 of file Factory.cpp.

References CreateSimulatorUnique().

Referenced by Network::SimpleDisconnectedNetwork< Time, Controller >::ChooseBestSimulator(), Maestro::CreateSimulator(), Network::SimpleDisconnectedNetwork< Time, Controller >::CreateSimulator(), Network::ExecuteJob< Time >::DoWork(), Network::ExecuteJob< Time >::DoWorkNoLock(), and Estimators::ExecutionCost::GetSimulator().

CreateSimulatorUnique()

std::unique_ptr< ISimulator > Simulators::SimulatorsFactory::CreateSimulatorUnique ( SimulatorType t = SimulatorType::kQCSim, SimulationType method = SimulationType::kMatrixProductState )

static

Create a quantum computing simulator.

Parameters

t	The type of simulator to create.

Returns

The simulator wrapped in a unique pointer.

Definition at line 50 of file Factory.cpp.

References Simulators::FactoryBackends::CreateAerSimulator(), Simulators::FactoryBackends::CreateCompositeSimulator(), Simulators::FactoryBackends::CreateImmediateCompositeSimulator(), CreateImmediateSimulatorUnique(), Simulators::FactoryBackends::CreateQCSimSimulator(), Simulators::FactoryBackends::CreateQuestSimulator(), GetGpuDeviceCount(), IsQuestLibraryAvailable(), Simulators::kCompositeQCSim, Simulators::kCompositeQiskitAer, Simulators::kDistGpuSim, Simulators::kDistMpiGpuSim, Simulators::kGpuSim, Simulators::kQCSim, Simulators::kQiskitAer, Simulators::kQuestSim, and Simulators::kStatevector.

Referenced by CreateImmediateSimulatorUnique(), and CreateSimulator().

GetGpuDeviceCount()

int Simulators::SimulatorsFactory::GetGpuDeviceCount ( )

inlinestatic

Definition at line 203 of file Simulators/Core/Factory.h.

Referenced by CreateSimulatorUnique().

GetQuestLibrary()

std::shared_ptr< QuestLibSim > Simulators::SimulatorsFactory::GetQuestLibrary ( )

static

Definition at line 52 of file FactoryQuest.cpp.

InitGpuLibrary()

bool Simulators::SimulatorsFactory::InitGpuLibrary ( )

inlinestatic

Definition at line 194 of file Simulators/Core/Factory.h.

InitQuestLibrary()

bool Simulators::SimulatorsFactory::InitQuestLibrary ( )

static

Definition at line 24 of file FactoryQuest.cpp.

Referenced by InitializeMaestro().

InitQuestLibraryWithMute()

bool Simulators::SimulatorsFactory::InitQuestLibraryWithMute ( )

static

Definition at line 59 of file FactoryQuest.cpp.

Referenced by InitializeMaestro().

IsGpuLibraryAvailable()

bool Simulators::SimulatorsFactory::IsGpuLibraryAvailable ( int = -1 )

inlinestatic

Definition at line 189 of file Simulators/Core/Factory.h.

Referenced by Network::SimpleDisconnectedNetwork< Time, Controller >::ChooseBestSimulator().

IsQuestLibraryAvailable()

bool Simulators::SimulatorsFactory::IsQuestLibraryAvailable ( )

static

Definition at line 47 of file FactoryQuest.cpp.

Referenced by CreateSimulatorUnique().

SelectGpuDevice()

void Simulators::SimulatorsFactory::SelectGpuDevice ( int )

inlinestatic

Definition at line 199 of file Simulators/Core/Factory.h.

---

The documentation for this class was generated from the following files:

• Simulators/Core/Factory.h
• Factory.cpp
• FactoryQuest.cpp