sf.engine

Warning

Unless you are a Strawberry Fields developer, you likely do not need to use these classes directly.

See the Engine class for details on creating a Strawberry Fields engine.

This module implements BaseEngine and its subclasses that are responsible for communicating quantum programs represented by Program objects to a backend that could be e.g., a simulator or a hardware quantum processor. One can think of each BaseEngine instance as a separate quantum computation.

Classes

BaseEngine(backend, *[, backend_options])

Abstract base class for quantum program executor engines.

LocalEngine(backend, *[, backend_options])

Local quantum program executor engine.

BosonicEngine(backend, *[, backend_options])

Local quantum program executor engine for programs executed on the bosonic backend.

Class Inheritance Diagram

digraph inheritance62e84fdc9b { rankdir=LR; size="8.0, 12.0"; "ABC" [color=lightskyblue1,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,tooltip="Helper class that provides a standard way to create an ABC using"]; "BaseEngine" [URL="api/strawberryfields.engine.BaseEngine.html#strawberryfields.engine.BaseEngine",color=lightskyblue1,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Abstract base class for quantum program executor engines."]; "ABC" -> "BaseEngine" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BosonicEngine" [URL="api/strawberryfields.engine.BosonicEngine.html#strawberryfields.engine.BosonicEngine",color=lightskyblue1,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Local quantum program executor engine for programs executed on the bosonic backend."]; "LocalEngine" -> "BosonicEngine" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LocalEngine" [URL="api/strawberryfields.engine.LocalEngine.html#strawberryfields.engine.LocalEngine",color=lightskyblue1,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style=filled,target="_top",tooltip="Local quantum program executor engine."]; "BaseEngine" -> "LocalEngine" [arrowsize=0.5,style="setlinewidth(0.5)"]; }