feat(solver): significantly improve solver performance

README.md

@@ -34,15 +34,25 @@ Future versions of Argon will hopefully support:
 To use Argon, you will need:
 - [Rust (tested on 1.90.0)](https://www.rust-lang.org/tools/install)
 - One of [Neovim (version 0.11.0 or above)](https://github.com/neovim/neovim/blob/master/INSTALL.md) or [VS Code (version 1.100.0 or above)](https://code.visualstudio.com/download)
+- [SuiteSparse](https://github.com/DrTimothyAldenDavis/SuiteSparse)
 
+### SuiteSparse Installation
+#### macOS
+If you use Homebrew, all you need is 
+```bash 
+brew install suitesparse
+```
+#### Windows/Linux
+In this case, you will need to download SuiteSparse manually; you can use something like ``` conda ``` or ```vcpkg```. Then, locate the folder that contains the ```.h``` files, such as ```cholmod.h```, and the folder containing the ```.lib``` files (```.so``` or ```.a``` on Linux). Set the environment variables ```SUITESPARSE_INCLUDE_DIR``` and ```SUITESPARSE_LIB_DIR``` to the two paths you obtained from before, respectively.
+
+### Argon Installation
 Begin by cloning and compiling the Argon source code:
 
 ```bash
 git clone https://github.com/ucb-substrate/argon.git
 cd argon
 cargo b --release
 ```
-
 ### Neovim
 
 Add the following to your Neovim Lua configuration:

core/compiler/.gitignore

@@ -1 +1,2 @@
-build/
+build/
+

core/compiler/Cargo.toml

@@ -5,8 +5,12 @@ edition = "2024"
 
 [dependencies]
 derive-where = { version = "1", features = ["serde"] }
-nalgebra = "0.34"
+nalgebra = { version = "0.34", features = ["rayon"] }
+nalgebra-sparse = "0.11"
 klayout-lyp = "0.1.1"
+rayon = "1.10"
+libc = "0.2"
+rand = "0.8.5"
 gds21 = "0.2"
 
 anyhow = { workspace = true }
@@ -32,6 +36,7 @@ const_format = "0.2"
 
 [build-dependencies]
 lrpar = { version = "0.13", features = ["serde"] }
+bindgen = "0.72.1"
 
 cfgrammar = { workspace = true }
 lrlex = { workspace = true }

core/compiler/build.rs

@@ -1,3 +1,4 @@
+use std::env;
 use std::path::PathBuf;
 
 use cfgrammar::yacc::YaccKind;
@@ -30,4 +31,51 @@ fn main() {
         .mod_name("cell_l")
         .build()
         .unwrap();
+
+    println!("cargo:rerun-if-changed=wrapper.h");
+    println!("cargo:rerun-if-changed=build.rs");
+
+    println!("cargo:rerun-if-env-changed=SUITESPARSE_INCLUDE_DIR");
+    println!("cargo:rerun-if-env-changed=SUITESPARSE_LIB_DIR");
+
+    let include_dir =
+        env::var("SUITESPARSE_INCLUDE_DIR").unwrap_or_else(|_| "/opt/homebrew/include".to_string());
+    let lib_dir =
+        env::var("SUITESPARSE_LIB_DIR").unwrap_or_else(|_| "/opt/homebrew/lib".to_string());
+
+    println!("cargo:rustc-link-search=native={}", lib_dir);
+    println!("cargo:rustc-link-lib=spqr");
+    println!("cargo:rustc-link-lib=cholmod");
+    println!("cargo:rustc-link-lib=suitesparseconfig");
+    println!("cargo:rustc-link-lib=amd");
+    println!("cargo:rustc-link-lib=colamd");
+    println!("cargo:rustc-link-lib=ccolamd");
+    println!("cargo:rustc-link-lib=camd");
+
+    let bindings = bindgen::Builder::default()
+        .header("wrapper.h")
+        .clang_arg(format!("-I{}", include_dir))
+        .clang_arg(format!("-I{}/suitesparse", include_dir))
+        .wrap_unsafe_ops(true)
+        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
+        .allowlist_function("SuiteSparseQR_C_QR")
+        .allowlist_function("cholmod_l_start")
+        .allowlist_function("cholmod_l_finish")
+        .allowlist_function("cholmod_l_free")
+        .allowlist_function("cholmod_l_free_sparse")
+        .allowlist_function("cholmod_l_free_dense")
+        .allowlist_function("cholmod_l_sparse_to_dense")
+        .allowlist_function("cholmod_l_allocate_triplet")
+        .allowlist_function("cholmod_l_free_triplet")
+        .allowlist_function("cholmod_l_triplet_to_sparse")
+        .allowlist_var("SPQR_ORDERING_DEFAULT")
+        .allowlist_var("SPQR_DEFAULT_TOL")
+        .allowlist_var("CHOLMOD_REAL")
+        .generate()
+        .expect("Unable to generate bindings");
+
+    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+    bindings
+        .write_to_file(out_path.join("spqr_bindings.rs"))
+        .expect("Couldn't write bindings");
 }