API Reference

hierarqcal.core	This module contains the core classes for the hierarqcal package.
hierarqcal.utils	Utility functions for the hierarqcal package.
hierarqcal.qiskit.qiskit_helper	Helper functions for qiskit

• HierarQcal Core
  • CircuitInstruction
    • CircuitInstruction.gate_name
    • CircuitInstruction.sub_bits
    • CircuitInstruction.symbol_info
  • Default_Mappings
    • Default_Mappings.BASE_MOTIF
    • Default_Mappings.CYCLE
    • Default_Mappings.MASK
    • Default_Mappings.PERMUTE
    • Default_Mappings.PIVOT
    • Default_Mappings.SPLIT
  • Primitive_Types
    • Primitive_Types.BASE_MOTIF
    • Primitive_Types.CYCLE
    • Primitive_Types.INIT
    • Primitive_Types.MASK
    • Primitive_Types.PERMUTE
    • Primitive_Types.PIVOT
    • Primitive_Types.SPLIT
  • Qcycle
    • Qcycle.__call__()
  • Qhierarchy
    • Qhierarchy.__add__()
    • Qhierarchy.__call__()
    • Qhierarchy.__mul__()
    • Qhierarchy.append()
    • Qhierarchy.copy()
    • Qhierarchy.extend()
    • Qhierarchy.extmerge()
    • Qhierarchy.get_symbols()
    • Qhierarchy.get_unitary_function()
    • Qhierarchy.merge()
    • Qhierarchy.set_symbols()
    • Qhierarchy.update_Q()
  • Qinit
    • Qinit.__add__()
    • Qinit.__call__()
  • Qmask
    • Qmask.__call__()
  • Qmotif
    • Qmotif.__add__()
    • Qmotif.__call__()
    • Qmotif.__mul__()
    • Qmotif.append()
    • Qmotif.cycle()
    • Qmotif.get_symbols()
    • Qmotif.set_E()
    • Qmotif.set_Q()
    • Qmotif.set_Qavail()
    • Qmotif.set_arity()
    • Qmotif.set_edge_mapping()
    • Qmotif.set_edge_order()
    • Qmotif.set_is_operation()
    • Qmotif.set_mapping()
    • Qmotif.set_next()
    • Qmotif.set_prev()
    • Qmotif.set_share_weights()
    • Qmotif.set_symbols()
  • Qmotifs
    • Qmotifs.__add__()
    • Qmotifs.__mul__()
  • Qpermute
    • Qpermute.__call__()
  • Qpivot
    • Qpivot.__call__()
    • Qpivot.cycle_between_splits()
  • Qsplit
    • Qsplit.__call__()
    • Qsplit.cycle_between_splits()
    • Qsplit.get_pattern_fn()
    • Qsplit.get_predefined_pattern_fn()
    • Qsplit.merge_within_splits()
    • Qsplit.wildcard_populate()
  • Qunitary
    • Qunitary.__call__()
    • Qunitary.get_circ_info_from_string()
    • Qunitary.get_symbols()
    • Qunitary.set_edge()
    • Qunitary.set_symbols()
  • Qunmask
    • Qunmask.__call__()
• HierarQcal Utils
  • contract()
  • get_tensor_as_f()
  • plot_circuit()
  • plot_motif()
  • tensor_to_matrix_colmajor()
  • tensor_to_matrix_rowmajor()
• Cirq Helper
• Qiskit Helper
  • get_circuit_qiskit()
  • get_qiskit_circuit_from_instructions()
  • get_qiskit_default_unitary()
• Pennylane Helper