Merge pull request #1 from danclaudino/deprecate_annealing

Turned annealing deprecated

Author: danclaudino

CMakeLists.txt

@@ -20,6 +20,12 @@ option(XACC_BUILD_TESTS "Build test programs" OFF)
 option(XACC_BUILD_EXAMPLES "Build example programs" OFF)
 option(XACC_ENSMALLEN_INCLUDE_DIR "Path to ensmallen.hpp for mlpack optimizer" "")
 option(XACC_ARMADILLO_INCLUDE_DIR "Path to armadillo header for mlpack optimizer" "")
+option(XACC_BUILD_ANNEALING "Build annealing libraries" OFF)
+if(XACC_BUILD_ANNEALING)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DANNEALING_ENABLED")
+else()
+  message(STATUS "${BoldYellow}Skipping Annealing libraries by default. You can turn it on with -DXACC_BUILD_ANNEALING=ON${ColorReset}")
+endif()
 
 if(FROM_SETUP_PY AND NOT APPLE)
   message(STATUS "Running build from setup.py, linking to static libstdc++")

python/compiler/CMakeLists.txt

@@ -42,7 +42,11 @@ usFunctionEmbedResources(TARGET ${LIBRARY_NAME}
 
 target_include_directories(${LIBRARY_NAME} PRIVATE . generated
                                   ${CMAKE_SOURCE_DIR}/tpls/antlr/runtime/src)
-target_link_libraries(${LIBRARY_NAME} PUBLIC xacc xacc-quantum-gate xacc-quantum-annealing ${ANTLR_LIB})
+if(XACC_BUILD_ANNEALING)
+  target_link_libraries(${LIBRARY_NAME} PUBLIC xacc xacc-quantum-gate xacc-quantum-annealing ${ANTLR_LIB})
+else()
+  target_link_libraries(${LIBRARY_NAME} PUBLIC xacc xacc-quantum-gate ${ANTLR_LIB})
+endif()
 
 if(APPLE)
    set_target_properties(${LIBRARY_NAME} PROPERTIES INSTALL_RPATH "@loader_path/../lib")

python/compiler/pyxasm_listener.cpp

@@ -18,7 +18,9 @@
 
 #include "pyxasm_listener.hpp"
 #include "Circuit.hpp"
-#include "AnnealingProgram.hpp"
+#ifdef ANNEALING_ENABLED
+ #include "AnnealingProgram.hpp"
+#endif
 #include <memory>
 #include <regex>
 
@@ -49,12 +51,15 @@ void PyXASMListener::enterInstruction(pyxasmParser::InstructionContext *ctx) {
     instructionName = "CNOT";
   } else if (instructionName == "MEASURE") {
     instructionName = "Measure";
-  } else if (instructionName == "dwqmi") {
+  }
+#ifdef ANNEALING_ENABLED
+  else if (instructionName == "dwqmi") {
       auto isCircuit = std::dynamic_pointer_cast<quantum::Circuit>(function);
       if (isCircuit) {
           function = irProvider->createComposite(function->name(), function->getVariables(), "anneal");
       }
   }
+#endif
 
   auto nRequiredBits = irProvider->getNRequiredBits(instructionName);
   std::vector<std::size_t> bits;
@@ -122,9 +127,11 @@ void PyXASMListener::enterInstruction(pyxasmParser::InstructionContext *ctx) {
         }
     }
 
+#ifdef ANNEALING_ENABLED
     if (std::dynamic_pointer_cast<quantum::AnnealingProgram>(tmpInst) && std::dynamic_pointer_cast<quantum::Circuit>(function)) {
         function = irProvider->createComposite(function->name(), function->getVariables(), "anneal");
     }
+#endif
   }
   function->addInstruction(tmpInst);
   function->expand(options);

quantum/CMakeLists.txt

@@ -11,7 +11,9 @@
 #   Alexander J. McCaskey - initial API and implementation
 # *******************************************************************************/
 add_subdirectory(gate)
-add_subdirectory(annealing)
+if (XACC_BUILD_ANNEALING)
+  add_subdirectory(annealing)
+endif()
 add_subdirectory(provider)
 add_subdirectory(observable)
 add_subdirectory(plugins)

quantum/plugins/CMakeLists.txt

@@ -13,7 +13,6 @@
 add_subdirectory(ibm)
 add_subdirectory(rigetti)
 #add_subdirectory(cmr)
-add_subdirectory(dwave)
 add_subdirectory(algorithms)
 add_subdirectory(decorators)
 add_subdirectory(circuits)
@@ -37,6 +36,10 @@ else()
     message("-- Could NOT find Qrack library (missing: find_library(QRACK_LIBRARY NAMES qrack))")
 endif()
 
+if(XACC_BUILD_ANNEALING)
+    add_subdirectory(dwave)
+endif()
+
 add_subdirectory(optimal_control)
 add_subdirectory(qsim)
 add_subdirectory(atos_qlm)

quantum/plugins/placement/CMakeLists.txt

@@ -1,4 +1,6 @@
-add_subdirectory(minor_graph_embedding)
+if(XACC_BUILD_ANNEALING)
+    add_subdirectory(minor_graph_embedding)
+endif()
 
 # Note: TriQ depends on Z3 library. 
 # Users need to install Z3, e.g.

quantum/provider/CMakeLists.txt

@@ -50,7 +50,11 @@ usFunctionEmbedResources(TARGET
                          FILES
                          manifest.json)
 
-target_link_libraries(${LIBRARY_NAME} PUBLIC xacc PRIVATE xacc-quantum-gate xacc-quantum-annealing)
+if(XACC_BUILD_ANNEALING)
+  target_link_libraries(${LIBRARY_NAME} PUBLIC xacc PRIVATE xacc-quantum-gate xacc-quantum-annealing)
+else()
+  target_link_libraries(${LIBRARY_NAME} PUBLIC xacc PRIVATE xacc-quantum-gate)
+endif()
 target_compile_features(${LIBRARY_NAME}
                         PUBLIC
                         cxx_std_14

quantum/provider/QuantumIRProvider.cpp

@@ -15,8 +15,10 @@
 #include "GateIR.hpp"
 #include "Circuit.hpp"
 
-#include "DWIR.hpp"
-#include "AnnealingProgram.hpp"
+#ifdef ANNEALING_ENABLED
+  #include "DWIR.hpp"
+  #include "AnnealingProgram.hpp"
+#endif
 
 #include "CompositeInstruction.hpp"
 #include "xacc_service.hpp"
@@ -131,9 +133,13 @@ std::shared_ptr<Instruction> QuantumIRProvider::createInstruction(
   // FIXME, update to handle D-Wave...
   if (type == "circuit") {
   return std::make_shared<xacc::quantum::Circuit>(name,variables);
-  } else if (type == "anneal") {
+  } 
+#ifdef ANNEALING_ENABLED
+  else if (type == "anneal") {
     return std::make_shared<xacc::quantum::AnnealingProgram>(name,variables);
-  } else {
+  } 
+#endif  
+  else {
       xacc::error("Invalid Composite type, can be circuit or anneal");
       return nullptr;
   }
@@ -142,9 +148,15 @@ std::shared_ptr<Instruction> QuantumIRProvider::createInstruction(
 std::shared_ptr<IR> QuantumIRProvider::createIR(const std::string type) {
 if (type == "circuit") {
   return std::make_shared<GateIR>();
-} else if (type == "anneal") {
+} 
+
+#ifdef ANNEALING_ENABLED
+else if (type == "anneal") {
     return std::make_shared<DWIR>();
-} else {
+}
+#endif
+
+else {
     xacc::error("Invalid IR type, can be circuit or anneal");
     return nullptr;
 }