Quantum Forge API Reference

Welcome to the Quantum Forge API Reference. There are two levels at which the user can interact with the Quantum Forge API:

  1. The Quantum Forge Core API: This is a C# wrapper for the underlying Quantum Forge c-api, and provides a code interface for interacting with the underlying quantum state simulator.
  2. The Quantum Forge Runtime API: This is a set of Monobehaviour wrappers that can be used to interact with the Quantum Forge Core API from within he Unity Editor.

Quantum Forge Core API

The Quantum Forge Core API is designed around the idea of the NativeQuantumProperty, which is a hook into the underlying quantum state simulator. The QuantumForge static class provides a set of methods for creating and manipulating NativeQuantumProperties. A QuantumForge.Predicate can be used in many of the Quantum Forge Core API methods to specify the conditions under which NativeQuantumProperties should be affected by the operation. Note, this creates a controlled operation and can be used to generate entanglement.

Quantum Forge Runtime API

The Quantum Forge Runtime API provides QuantumProperty, a Monobehaviour wrapper for the native quantum property. The Basis can be created from the Unity Assets/Create/Quantum menu.The runtume api also provides a set of Actions that can be applied to a quantum property to manipulate its state, and a set of Trackers that can be used to gather certain information about the quantum state.

Actions

Actions are used to manipulate the state of a quantum property. There are several types of actions that can be applied to a quantum property:

  • Hadamard: This creates superposition from a classical state.
  • Clock: Details about the Clock action.
  • Cycle: Information on the Cycle action.
  • InverseHadamard: Details about the InverseHadamard action.
  • Swap: Explore the Swap action.
  • PhaseRotate: Understand the PhaseRotate action.
  • MeasurePredicates: Learn about the MeasurePredicates action.
  • MeasureProperties: Explore the MeasureProperties action.
  • NCycle: Details about the NCycle action.
  • Shift: Understand the Shift action.
  • ISwap: Learn about the ISwap action.

Trackers

Trackers are used to gather information about the quantum state.