Z-register Operations

Add(N[, constant=0.0])

Sum several z-register variables (and optionally a constant) and assign the result to the first z-register variable given. The first target is the destination; the remaining N-1 targets are the inputs.

To accumulate into the destination instead of overwriting it, alias the destination as one of the inputs (z-variable aliasing is allowed for Add), e.g. push!(c, Add(3), 1, 1, 2) evaluates z[1] = z[1] + z[2].

Examples

julia> Add(3)
z[?1] = z[?2] + z[?3]

julia> Add(4)
z[?1] = z[?2] + z[?3] + z[?4]

julia> Add(4, 2.0)
z[?1] = 2.0 + z[?2] + z[?3] + z[?4]

julia> c = push!(Circuit(), Add(3), 1,2,3)
3-vars circuit with 1 instruction:
└── z[1] = z[2] + z[3]

julia> push!(c, Add(5), 1,2,3,4,5)
5-vars circuit with 2 instructions:
├── z[1] = z[2] + z[3]
└── z[1] = z[2] + z[3] + z[4] + z[5]

julia> push!(c, Add(5, 2.0), 1,2,3,4,5)
5-vars circuit with 3 instructions:
├── z[1] = z[2] + z[3]
├── z[1] = z[2] + z[3] + z[4] + z[5]
└── z[1] = 2.0 + z[2] + z[3] + z[4] + z[5]

julia> push!(Circuit(), Add(3), 1, 1, 2)  # accumulate via aliasing
2-vars circuit with 1 instruction:
└── z[1] = z[1] + z[2]

Multiply(N[, constant=1.0])

Multiply several z-register variables (and optionally a constant) and assign the result to the first z-register variable given. The first target is the destination; the remaining N-1 targets are the inputs.

To accumulate into the destination instead of overwriting it, alias the destination as one of the inputs (z-variable aliasing is allowed for Multiply), e.g. push!(c, Multiply(3), 1, 1, 2) evaluates z[1] = z[1] * z[2].

Examples

julia> Multiply(3)
z[?1] = z[?2] * z[?3]

julia> Multiply(4)
z[?1] = z[?2] * z[?3] * z[?4]

julia> Multiply(4, 2.0)
z[?1] = 2.0 * z[?2] * z[?3] * z[?4]

julia> c = push!(Circuit(), Multiply(4), 1,2,3,4)
4-vars circuit with 1 instruction:
└── z[1] = z[2] * z[3] * z[4]

julia> push!(c, Multiply(5, 2.0), 1,2,3,4,5)
5-vars circuit with 2 instructions:
├── z[1] = z[2] * z[3] * z[4]
└── z[1] = 2.0 * z[2] * z[3] * z[4] * z[5]

julia> push!(Circuit(), Multiply(3), 1, 1, 2)  # accumulate via aliasing
2-vars circuit with 1 instruction:
└── z[1] = z[1] * z[2]

Pow(exp)

Exponentiate a Z-register variable.

Examples

julia> Pow(2.0)
z[?] = z[?]^2.0

julia> Pow(-2.0)
z[?] = z[?]^(-2.0)

julia> c = push!(Circuit(), Pow(2.0), 1)
1-vars circuit with 1 instruction:
└── z[1] = z[1]^2.0

julia> push!(c, Pow(-2.0), 1)
1-vars circuit with 2 instructions:
├── z[1] = z[1]^2.0
└── z[1] = z[1]^(-2.0)