ParameterizedGateInstruction.hpp 3.56 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/***********************************************************************************
 * Copyright (c) 2017, UT-Battelle
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of the xacc nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributors:
 *   Initial API and implementation - Alex McCaskey
 *
 **********************************************************************************/
Mccaskey, Alex's avatar
Mccaskey, Alex committed
31
32
#ifndef QUANTUM_GATE_GATEQIR_PARAMETERIZEDGATEINSTRUCTION_HPP_
#define QUANTUM_GATE_GATEQIR_PARAMETERIZEDGATEINSTRUCTION_HPP_
33
34
35

#include "GateInstruction.hpp"
#include "XACCError.hpp"
Mccaskey, Alex's avatar
Mccaskey, Alex committed
36
#include "XaccUtils.hpp"
37
38
39

namespace xacc {
namespace quantum {
40
41
42
43
44
45
46
47

/**
 * The ParamaterizedGateInstruction is a GateInstruction that is
 * templated on a list of variadic parameters that model the
 * instructions gate parameters. For example, this class could be
 * subclassed to provide a rotation gate with an angle theta
 * (ParamaterizedGateInstruction<double>).
 */
48
49
template<typename ... InstructionParameter>
class ParameterizedGateInstruction: public virtual GateInstruction {
50

51
protected:
52
53
54
55

	/**
	 * The paramaters that this gate instruction requires.
	 */
56
57
58
	std::tuple<InstructionParameter...> params;

public:
59
60
61
62
63

	/**
	 * The constructor, takes the parameters
	 * @param pars
	 */
Mccaskey, Alex's avatar
Mccaskey, Alex committed
64
65
	ParameterizedGateInstruction(InstructionParameter ... pars) :
			params(std::make_tuple(pars...)) {
66
67
	}

68
69
70
71
72
73
	/**
	 * Return the gate parameter at the given index.
	 *
	 * @param idx
	 * @return
	 */
74
	auto getParameter(const std::size_t idx) {
Mccaskey, Alex's avatar
Mccaskey, Alex committed
75
		if (idx + 1 > sizeof...(InstructionParameter)) {
76
77
			XACCError("Invalid Parameter requested from Parameterized Gate Instruction.");
		}
Mccaskey, Alex's avatar
Mccaskey, Alex committed
78
		return xacc::tuple_runtime_get(params, idx);
79
80
	}

81
82
83
84
85
86
87
	/**
	 * Return an assembly-like string representation for this
	 * instruction.
	 *
	 * @param bufferVarName
	 * @return
	 */
88
89
90
	virtual const std::string toString(const std::string bufferVarName) {
		auto str = gateName;
		str += "(";
Mccaskey, Alex's avatar
Mccaskey, Alex committed
91
		xacc::tuple_for_each(params, [&](auto element) {
92
93
			str += std::to_string(element) + ",";
		});
Mccaskey, Alex's avatar
Mccaskey, Alex committed
94
		str = str.substr(0, str.length() - 1) + ") ";
95
96
97
98
99
100
101
102
103
104
105
106

		for (auto q : qubits()) {
			str += bufferVarName + std::to_string(q) + ",";
		}

		// Remove trailing comma
		str = str.substr(0, str.length() - 1);

		return str;
	}

};
Mccaskey, Alex's avatar
Mccaskey, Alex committed
107
}}
108

Mccaskey, Alex's avatar
Mccaskey, Alex committed
109
#endif