import CommandModifier from 'projectq/src/cengines/cmdmodifier.js'

public class | source

CommandModifier

BasicEngine → CommandModifier

CommandModifier is a compiler engine which applies a function to all incoming commands, sending on the resulting command instead of the original one.

Constructor Summary

Public Constructor
public	constructor(cmdModFunc: function)

Private Members
private	_cmdModFunc: *

Public Methods
public	receive(cmdList: Command[]) Receive a list of commands from the previous engine, modify all commands, and send them on to the next engine.

From class BasicEngine
public	isLastEngine: boolean
public	allocateQubit(dirty: boolean): Qureg Return a new qubit as a list containing 1 qubit object (quantum register of size 1).
public	allocateQureg(n: number): Qureg Allocate n qubits and return them as a quantum register, which is a list of qubit objects.
public	deallocateQubit(qubit: BasicQubit) Deallocate a qubit (and sends the deallocation command down the pipeline).
public	isAvailable(cmd: Command): boolean Default implementation of isAvailable: Ask the next engine whether a command is available, i.e., whether it can be executed by the next engine(s).
public	isMetaTagSupported(metaTag: function): boolean Check if there is a compiler engine handling the meta tag
public	receive()
public	send(commandList: Command[]) Forward the list of commands to the next engine in the pipeline.

Name	Type	Attribute	Description
cmdModFunc	function		Function which, given a command cmd, returns the command it should send instead.


function cmd_mod_fun(cmd)
cmd.tags += [new MyOwnTag()]
compiler_engine = new CommandModifier(cmd_mod_fun)

Receive a list of commands from the previous engine, modify all commands, and send them on to the next engine.

Name	Type	Attribute	Description
cmdList	Command[]		List of commands to receive and then (after modification) send on.