QIO.Heap

This module contains the definition of a Type Class that represents a Heap. In the context of QIO, a Heap is the type used to represent a classical basis state. An instance of a Heap is also defined, that makes use of a Map.

Documentation

class Eq h => Heap h where

The Heap Type Class

Minimal complete definition

initial, update, (?), forget

Methods

initial :: h

define an initial (i.e. empty) Heap

update :: h -> Qbit -> Bool -> h

update the value of a Qubit within the Heap to the given Boolen value

(?) :: h -> Qbit -> Maybe Bool

Lookup the value of the given Qubit in the Heap (if it exists)

forget :: h -> Qbit -> h

remove the given Qubit from the Heap

hswap :: h -> Qbit -> Qbit -> h

Swap the values associated with two Qubits within the Heap

Instances

Heap HeapMap

A HeapMap is an instance of the Heap type class, where the Heap functions can make use of the underlying Map functions.

Methods

initial :: HeapMap

update :: HeapMap -> Qbit -> Bool -> HeapMap

(?) :: HeapMap -> Qbit -> Maybe Bool

forget :: HeapMap -> Qbit -> HeapMap

hswap :: HeapMap -> Qbit -> Qbit -> HeapMap

type HeapMap = Map Qbit Bool

HeapMap is simply a type synonym for a Map from Qubits to Boolean values