From 6acf4d3311cbee5a78450d78c2e221c268d12847 Mon Sep 17 00:00:00 2001 From: Corentin Le Molgat Date: Thu, 13 Mar 2025 08:23:11 +0100 Subject: [PATCH] cmake: update internal doc --- cmake/docs/cmake.dot | 15 +- cmake/docs/cmake.svg | 623 ++++++++++++++++++++++--------------------- cmake/docs/deps.dot | 11 +- cmake/docs/deps.svg | 283 ++++++++++---------- 4 files changed, 477 insertions(+), 455 deletions(-) diff --git a/cmake/docs/cmake.dot b/cmake/docs/cmake.dot index 2e8cba150c..f16a364e8c 100644 --- a/cmake/docs/cmake.dot +++ b/cmake/docs/cmake.dot @@ -148,15 +148,22 @@ digraph CMake { } subgraph clusterSCIPSolver { + subgraph clusterSoplex { + SPX [label="libsoplex-pic"]; + + color=royalblue; + label = "scipopt/soplex.git"; + } + subgraph clusterSCIP { SCIP [label="SCIP::libscip"]; - SPX [label="libsoplex"]; - - SPX -> SCIP; color=royalblue; label = "scipopt/scip.git"; } + + SPX -> SCIP; + color=royalblue; label = "SCIP Solver\n(-DUSE_SCIP=ON)"; } @@ -243,7 +250,7 @@ digraph CMake { OR_SRC -> OR_WJAVA [label="swig", color=chocolate]; OR_SRC -> OR_JAVA [label="swig", color=chocolate]; OR_WJAVA -> OR_JAVA; - OR_JAVA -> PKG_JAVA [label="maven (WIP)", style="dotted", color=crimson]; + OR_JAVA -> PKG_JAVA [label="maven", color=crimson]; color=crimson; label = "Java\n(-DBUILD_JAVA=ON)"; diff --git a/cmake/docs/cmake.svg b/cmake/docs/cmake.svg index 8dbb959b9e..ae7a62782c 100644 --- a/cmake/docs/cmake.svg +++ b/cmake/docs/cmake.svg @@ -4,67 +4,67 @@ - - + + CMake - + clusterPrerequisite - -Prerequisite + +Prerequisite clusterOR - -OR-Tools (CMake) + +OR-Tools (CMake) clusterDeps - -Dependencies -(-DBUILD_DEPS=ON) + +Dependencies +(-DBUILD_DEPS=ON) clusterZLIB - -madler/zlib.git + cmake patch + +madler/zlib.git + cmake patch clusterAbsl - -abseil/abseil-cpp.git + +abseil/abseil-cpp.git clusterRe2 - -google/re2.git + +google/re2.git clusterProtobuf - -protocolbuffers/protobuf.git + +protocolbuffers/protobuf.git clusterCoinOR - -Coin-OR Solver -(-DUSE_COINOR=ON) + +Coin-OR Solver +(-DUSE_COINOR=ON) clusterCoinUtils - -Mizux/CoinUtils.git + +Mizux/CoinUtils.git clusterOsi - -Mizux/Osi.git + +Mizux/Osi.git clusterClp - -Mizux/Clp.git + +Mizux/Clp.git clusterCgl @@ -78,103 +78,108 @@ clusterGLPKSolver - -GLPK Solver -(-DUSE_GLPK=ON) + +GLPK Solver +(-DUSE_GLPK=ON) clusterGLPK - -Mizux/GLPK.git + +Mizux/GLPK.git clusterHIGHSSolver - -HIGHS Solver -(-DUSE_HIGHS=ON) + +HIGHS Solver +(-DUSE_HIGHS=ON) clusterHIGHS - -ERGO-Code/HIGHS.git + +ERGO-Code/HIGHS.git clusterSCIPSolver - -SCIP Solver -(-DUSE_SCIP=ON) + +SCIP Solver +(-DUSE_SCIP=ON) -clusterSCIP - -scipopt/scip.git +clusterSoplex + +scipopt/soplex.git -clusterCXX - -C++ -(-DBUILD_CXX=ON) +clusterSCIP + +scipopt/scip.git -clusterCXXTest - -Examples -(-DBUILD_TESTING=ON) +clusterCXX + +C++ +(-DBUILD_CXX=ON) -clusterPython - -Python -(-DBUILD_PYTHON=ON) +clusterCXXTest + +Examples +(-DBUILD_TESTING=ON) -clusterPythonTest - -Examples -(-DBUILD_TESTING=ON) +clusterPython + +Python +(-DBUILD_PYTHON=ON) -clusterJava - -Java -(-DBUILD_JAVA=ON) +clusterPythonTest + +Examples +(-DBUILD_TESTING=ON) -clusterJavaTest - -Examples -(-DBUILD_TESTING=ON) +clusterJava + +Java +(-DBUILD_JAVA=ON) -clusterNet - -.Net -(-DBUILD_DOTNET=ON) +clusterJavaTest + +Examples +(-DBUILD_TESTING=ON) +clusterNet + +.Net +(-DBUILD_DOTNET=ON) + + clusterNetTest - -Examples -(-DBUILD_TESTING=ON) + +Examples +(-DBUILD_TESTING=ON) CM - - - - -CMake + + + + +CMake SWIG - - - - -Swig -(Unix) + + + + +Swig +(Unix) @@ -183,12 +188,12 @@ PY - - - - -Python -(3.6+) + + + + +Python +(3.6+) @@ -197,12 +202,12 @@ JV - - - - -Java -(openJDK 8+) + + + + +Java +(openJDK 8+) @@ -211,12 +216,12 @@ DN - - - - -.Net Core SDK -(3.1) + + + + +.Net Core SDK +(3.1) @@ -238,135 +243,135 @@ ZLIB - -ZLIB::ZLIB + +ZLIB::ZLIB Protobuf - -protobuf::libprotobuf + +protobuf::libprotobuf ZLIB->Protobuf - - - - - -SCIP - -SCIP::libscip - - - -ZLIB->SCIP - - + + - + SPX - -libsoplex + +libsoplex-pic ZLIB->SPX - - + + + + + +SCIP + +SCIP::libscip + + + +ZLIB->SCIP + + OR_SRC - -OR-Tools src -ortools/... + +OR-Tools src +ortools/... ZLIB->OR_SRC - - + + Absl - -absl::absl_* + +absl::absl_* Re2 - -re2::re2 + +re2::re2 Absl->Re2 - - + + Absl->Protobuf - - + + Absl->OR_SRC - - + + Re2->Protobuf - - + + Re2->OR_SRC - - + + Protobuf->OR_SRC - - + + CoinUtils - -Coin::CoinUtils + +Coin::CoinUtils Osi - -Coin::Osi + +Coin::Osi CoinUtils->Osi - - + + Clp - -Coin::Clp + +Coin::Clp CoinUtils->Clp - - + + @@ -377,8 +382,8 @@ CoinUtils->OsiClp - - + + @@ -389,7 +394,7 @@ CoinUtils->Cgl - + @@ -401,7 +406,7 @@ CoinUtils->Cbc - + @@ -413,44 +418,44 @@ CoinUtils->OsiCbc - + Osi->Clp - - + + Osi->OsiClp - - + + Osi->Cgl - - + + Osi->Cbc - + Osi->OsiCbc - + Clp->OsiClp - - + + @@ -461,13 +466,13 @@ Clp->ClpSolver - - + + Clp->Cbc - + @@ -479,8 +484,8 @@ ClpSolver->OR_SRC - - + + @@ -509,301 +514,301 @@ CbcSolver->OR_SRC - - + + GLPK - -glpk::glpk + +glpk::glpk GLPK->OR_SRC - - + + HIGHS - -highs::highs - - - -SCIP->OR_SRC - - + +highs::highs SPX->SCIP - - + + + + + +SCIP->OR_SRC + + SWIG_WIN - -swigwin -(Windows) + +swigwin +(Windows) OR_CPP - -ortools::ortools + +ortools::ortools OR_SRC->OR_CPP - - + + OR_WPY - - - -C++ Python wrappers + + + +C++ Python wrappers OR_SRC->OR_WPY - - -swig + + +swig OR_PY - - - -Python files + + + +Python files OR_SRC->OR_PY - - -swig + + +swig OR_WJAVA - - - -C++ Java wrappers + + + +C++ Java wrappers OR_SRC->OR_WJAVA - - -swig + + +swig OR_JAVA - - - -Java files + + + +Java files OR_SRC->OR_JAVA - - -swig + + +swig OR_WNET - - - -C++ .Net wrappers + + + +C++ .Net wrappers OR_SRC->OR_WNET - - -swig + + +swig OR_NET - - - -.Net files + + + +.Net files OR_SRC->OR_NET - - -swig + + +swig PKG_CPP - - - - -CMake Package + + + + +CMake Package OR_CPP->PKG_CPP - - -install + + +install EX_CPP - -C++ samples + +C++ samples PKG_CPP->EX_CPP - - + + OR_WPY->OR_PY - - + + PKG_PY - - - - -Wheel package + + + + +Wheel package OR_PY->PKG_PY - - -python setup.py + + +python setup.py EX_PY - -Python samples + +Python samples PKG_PY->EX_PY - - + + OR_WJAVA->OR_JAVA - - + + PKG_JAVA - - - - -Maven package + + + + +Maven package OR_JAVA->PKG_JAVA - - -maven (WIP) + + +maven EX_JAVA - -Java samples + +Java samples PKG_JAVA->EX_JAVA - - + + OR_WNET->OR_NET - - + + PKG_NET_RT - - - - -Nuget runtime package -Google.OrTools.runtime.rid.nupkg + + + + +Nuget runtime package +Google.OrTools.runtime.rid.nupkg OR_WNET->PKG_NET_RT - - -dotnet package + + +dotnet package PKG_NET - - - - -Nuget package -Google.OrTools.nupkg + + + + +Nuget package +Google.OrTools.nupkg OR_NET->PKG_NET - - -dotnet package + + +dotnet package PKG_NET_RT->PKG_NET - - + + EX_NET - -.Net samples + +.Net samples PKG_NET->EX_NET - - + + diff --git a/cmake/docs/deps.dot b/cmake/docs/deps.dot index 2097cfe902..1761e3ea7c 100644 --- a/cmake/docs/deps.dot +++ b/cmake/docs/deps.dot @@ -135,15 +135,20 @@ digraph CMakeDeps { } subgraph clusterSCIPSolver { - subgraph clusterSCIP { - SCIP [label="SCIP::libscip"]; + subgraph clusterSoplex { SPX [label="libsoplex"]; - SPX -> SCIP; + color=royalblue; + label = "scipopt/soplex.git"; + } + subgraph clusterSCIP { + SCIP [label="SCIP::libscip"]; color=royalblue; label = "scipopt/scip.git"; } + SPX -> SCIP; + color=royalblue; label = "-DUSE_SCIP=ON AND -DBUILD_SCIP=ON"; } diff --git a/cmake/docs/deps.svg b/cmake/docs/deps.svg index f203275921..2103c140d9 100644 --- a/cmake/docs/deps.svg +++ b/cmake/docs/deps.svg @@ -4,264 +4,269 @@ - - + + CMakeDeps - + clusterZLIB - -madler/zlib.git + cmake patch + +madler/zlib.git + cmake patch clusterAbsl - -abseil/abseil-cpp.git + +abseil/abseil-cpp.git clusterProtobuf - -protocolbuffers/protobuf.git + +protocolbuffers/protobuf.git clusterRe2 - -google/re2.git + +google/re2.git clusterEigen3 - -libeigen/eigen.git + +libeigen/eigen.git clusterPybind11 - -pybind/pybind11.git + +pybind/pybind11.git clusterCoinOR - --DUSE_COINOR=ON AND -DBUILD_DEPS=ON + +-DUSE_COINOR=ON AND -DBUILD_DEPS=ON clusterCoinUtils - -Mizux/CoinUtils.git + +Mizux/CoinUtils.git clusterOsi - -Mizux/Osi.git + +Mizux/Osi.git clusterClp - -Mizux/Clp.git + +Mizux/Clp.git clusterCgl - -Mizux/Cgl.git + +Mizux/Cgl.git clusterCbc - -Mizux/Cbc.git + +Mizux/Cbc.git clusterGLPKSolver - --DUSE_GLPK=ON AND -DBUILD_GLPK=ON + +-DUSE_GLPK=ON AND -DBUILD_GLPK=ON clusterGLPK - -Mizux/GLPK.git + +Mizux/GLPK.git clusterHIGHSSolver - --DUSE_HIGHS=ON AND -DBUILD_HIGHS=ON + +-DUSE_HIGHS=ON AND -DBUILD_HIGHS=ON clusterHIGHS - -ERGO-Code/HIGHS.git + +ERGO-Code/HIGHS.git clusterSCIPSolver - --DUSE_SCIP=ON AND -DBUILD_SCIP=ON + +-DUSE_SCIP=ON AND -DBUILD_SCIP=ON +clusterSoplex + +scipopt/soplex.git + + clusterSCIP - -scipopt/scip.git + +scipopt/scip.git ZLIB - -ZLIB::ZLIB + +ZLIB::ZLIB Protobuf - -protobuf::libprotobuf + +protobuf::libprotobuf ZLIB->Protobuf - - + + Cbc - -Coin::Cbc + +Coin::Cbc ZLIB->Cbc - - - - - -SCIP - -SCIP::libscip - - - -ZLIB->SCIP - - + + - + SPX - -libsoplex + +libsoplex ZLIB->SPX - - + + + + + +SCIP + +SCIP::libscip + + + +ZLIB->SCIP + + Absl - -absl::absl_* + +absl::absl_* Absl->Protobuf - - + + Re2 - -re2::re2 + +re2::re2 Absl->Re2 - - + + Protoc - - - -protobuf::protoc + + + +protobuf::protoc Re2->Protobuf - - + + Eigen3 - -Eigen3::eigen + +Eigen3::eigen Pybind11 - -pybind11::pybind11 + +pybind11::pybind11 CoinUtils - -Coin::CoinUtils + +Coin::CoinUtils Osi - -Coin::Osi + +Coin::Osi CoinUtils->Osi - - + + Clp - -Coin::Clp + +Coin::Clp CoinUtils->Clp - - + + OsiClp - -Coin::OsiClp + +Coin::OsiClp CoinUtils->OsiClp - - + + Cgl - -Coin::Cgl + +Coin::Cgl CoinUtils->Cgl - - + + CoinUtils->Cbc - - + + @@ -272,80 +277,80 @@ CoinUtils->OsiCbc - - + + Osi->Clp - - + + Osi->OsiClp - - + + Osi->Cgl - - + + Osi->Cbc - - + + Osi->OsiCbc - - + + Clp->OsiClp - - + + ClpSolver - -Coin::ClpSolver + +Coin::ClpSolver Clp->ClpSolver - - + + Clp->Cbc - - + + OsiClp->Cgl - - + + Cgl->Cbc - - + + Cbc->OsiCbc - - + + @@ -356,26 +361,26 @@ Cbc->CbcSolver - - + + GLPK - -glpk::glpk + +glpk::glpk HIGHS - -highs::highs + +highs::highs SPX->SCIP - - + +