qgd_N_Qubit_Decomposition_Tabu_Search.py

Go to the documentation of this file.

"""
Created on Tue Jun 30 15:44:26 2020
Copyright 2020 Peter Rakyta, Ph.D.

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.

You should have received a copy of the GNU General Public License
along with this program.  If not, see http://www.gnu.org/licenses/.

@author: Peter Rakyta, Ph.D.
"""




import numpy as np
from os import path
from squander.decomposition.qgd_N_Qubit_Decomposition_Tabu_Search_Wrapper import qgd_N_Qubit_Decomposition_Tabu_Search_Wrapper
from squander.gates.qgd_Circuit import qgd_Circuit




class qgd_N_Qubit_Decomposition_Tabu_Search(qgd_N_Qubit_Decomposition_Tabu_Search_Wrapper):
    
    

    def __init__( self, Umtx, level_limit_max=8, topology=None, config={}, accelerator_num=0 ):

        
        self.qbit_num = int(round( np.log2( len(Umtx) ) ))

        # validate input parameters

        topology_validated = list()
        if isinstance(topology, list) or isinstance(topology, tuple):
            for item in topology:
                if isinstance(item, tuple) and len(item) == 2:
                    item_validated = (np.intc(item[0]), np.intc(item[1]))
                    topology_validated.append(item_validated)
                else:
                    print("Elements of topology should be two-component tuples (int, int)")
                    return
        elif topology == None:
            pass
        else:
            print("Input parameter topology should be a list of (int, int) describing the connected qubits in the topology")
            return
        

        # config
        if not( type(config) is dict):
            print("Input parameter config should be a dictionary describing the following hyperparameters:") #TODO
            return

        # call the constructor of the wrapper class
        super().__init__(Umtx, self.qbit_num, level_limit_max, topology=topology_validated, config=config, accelerator_num=accelerator_num)

        

    def Start_Decomposition(self):

     # call the C wrapper function
        super().Start_Decomposition()
        
    

    def Reorder_Qubits( self, qbit_list ):

     # call the C wrapper function
        super().Reorder_Qubits(qbit_list)



    def List_Gates(self):

     # call the C wrapper function
        super().List_Gates()


    def get_Qiskit_Circuit( self ):

        from squander import Qiskit_IO
        
        squander_circuit = self.get_Circuit()
        parameters       = self.get_Optimized_Parameters()
        
        return Qiskit_IO.get_Qiskit_Circuit( squander_circuit, parameters )


 

    def set_Unitary( self, Umtx_arr ):  

        return super().set_Unitary( Umtx_arr )



    def set_Optimization_Tolerance( self, tolerance ):  

        return super().set_Optimization_Tolerance( tolerance )
        

    def get_Unitary( self ):

        return super().get_Unitary()
        

    def export_Unitary( self, filename ):

        return super().export_Unitary(filename)



    def get_Parameter_Num( self ):

        return super().get_Parameter_Num()


    def get_Global_Phase( self ):
     
        return super().get_Global_Phase()


    def set_Global_Phase( self, new_global_phase ):
     
        return super().set_Global_Phase(new_global_phase)

    def get_Project_Name( self ):
     
        return super().get_Project_Name()


    def set_Project_Name( self, project_name_new ):
     
        return super().set_Project_Name(project_name_new)

    def apply_Global_Phase_Factor( self ):
     
        return super().apply_Global_Phase_Factor()



    def set_Optimizer( self, optimizer="BFGS" ):

        # Set the optimizer
        super().set_Optimizer(optimizer)  



    def get_Matrix( self, parameters = None ):

  
        if parameters is None:
            print( "get_Matrix: arary of input parameters is None")
            return None

        return super().get_Matrix( parameters )
        

    def set_Cost_Function_Variant( self, costfnc=0 ):

        # Set the optimizer
        super().set_Cost_Function_Variant(costfnc=costfnc)  




    def set_Trace_Offset( self, trace_offset=0 ):

        # Set the trace offset
        super().set_Trace_Offset(trace_offset=trace_offset)  



    def get_Trace_Offset( self ):

        # Set the optimizer
        return super().get_Trace_Offset()  



    def get_Optimized_Parameters(self):
    
        return super().get_Optimized_Parameters()



    def set_Optimized_Parameters(self, new_params):
        
        super().set_Optimized_Parameters(new_params)



    def Optimization_Problem( self, parameters=None ):

        if parameters is None:
            print( "Optimization_Problem: array of input parameters is None")
            return None

        # evaluate the cost function and gradients
        cost_function = super().Optimization_Problem(parameters)  


        return cost_function



    def Optimization_Problem_Grad( self, parameters=None ):

        if parameters is None:
            print( "Optimization_Problem: array of input parameters is None")
            return None

        # evaluate the cost function and gradients
        grad = super().Optimization_Problem_Grad(parameters)  

        grad = grad.reshape( (-1,))

        return grad



    def Optimization_Problem_Combined( self, parameters=None ):

        if parameters is None:
            print( "Optimization_Problem_Combined: array of input parameters is None")
            return None

        # evaluate the cost function and gradients
        cost_function, grad = super().Optimization_Problem_Combined(parameters)  

        grad = grad.reshape( (-1,))

        return cost_function, grad


    def get_Num_of_Iters(self):
    
        return super().get_Num_of_Iters()
    

    def set_Max_Iterations(self, max_iters):
        
        super().set_Max_Iterations(max_iters)
    

    def set_Cost_Function_Variant(self, cost_func):
    
        super().set_Cost_Function_Variant(cost_func)



    def get_Decomposition_Error(self):
    
        return super().get_Decomposition_Error()




    def get_Second_Renyi_Entropy(self, parameters=None, input_state=None, qubit_list=None ):

        qbit_num = self.get_Qbit_Num()

        qubit_list_validated = list()
        if isinstance(qubit_list, list) or isinstance(qubit_list, tuple):
            for item in qubit_list:
                if isinstance(item, int):
                    qubit_list_validated.append(item)
                    qubit_list_validated = list(set(qubit_list_validated))
                else:
                    print("Elements of qbit_list should be integers")
                    return
        elif qubit_list == None:
            qubit_list_validated = [ x for x in range(qbit_num) ]

        else:
            print("Elements of qbit_list should be integers")
            return
        

        if parameters is None:
            print( "get_Second_Renyi_entropy: array of input parameters is None")
            return None


        if input_state is None:
            matrix_size = 1 << qbit_num
            input_state = np.zeros( (matrix_size,1) )
            input_state[0] = 1

        # evaluate the entropy
        entropy = super().get_Second_Renyi_Entropy( parameters, input_state, qubit_list_validated)  


        return entropy




    def get_Qbit_Num(self):
    
        return super().get_Qbit_Num()