Source code for mimiqcircuits.operations.amplitude

#
# Copyright © 2022-2023 University of Strasbourg. All Rights Reserved.
# Copyright © 2032-2024 QPerfect. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#


from mimiqcircuits import Operation, BitString




class Amplitude(Operation):
    """Amplitude operation

    multi qubit Amplitude operation in the computational basis

    The operation projects the quantum states complex variables and stores in a z-register.

    Examples:
        >>> from mimiqcircuits import *
        >>> c = Circuit()
        >>> c.push(Amplitude(BitString(2)),0)
        0-qubit circuit with 1 instructions:
        └── Amplitude(bs"00") @ z[0]
        <BLANKLINE>
    """

    _name = "Amplitude"
    _num_zvars = 1
    _num_bits = 0
    _num_zregs = 1
    _num_cregs = 0
    _num_qregs = 0
    _num_qubits = 0

    def __init__(self, bs: BitString):
        self.bs = bs

        super().__init__()
        self._zregsizes = [1]

    @property
    def zregsizes(self):
        return self._zregsizes



    def iswrapper(self):
        return False


    def _decompose(self, circ, qubits, bits, zvars):
        return circ.push(self, *qubits, *bits, *zvars)



    def inverse(self):
        raise NotImplementedError("Cannot inverse an Amplitude operation.")


    def _power(self, _):
        raise NotImplementedError("Cannot elevate an Amplitude operation to any power.")

    def __str__(self):
        return f'{self._name}(bs"{self.bs.to01()}")'



__all__ = ["Amplitude"]