Merge pull request #16 from oxfordcontrol/v0.10.0

v0.10.0 update

Author: bnaras

.Rbuildignore

@@ -9,7 +9,6 @@
 ^src/rust/modified_files.csv
 ^src/rust/vendor.sh
 ^src/rust/fix_hash.R
-^src/rust/Cargo.lock
 ^src/rust/vendor$
 ^src/*.o
 ^src/*.so

.github/workflows/R-CMD-check.yaml

@@ -28,19 +28,21 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+      
+      - name: Set up R
+        uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          rtools-version: ${{ matrix.config.rtools-version }}
+          # TODO: enable RSPM when all the packages are available
+          use-public-rspm: false
 
       - uses: r-lib/actions/setup-pandoc@v2
 
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.config.rust }}
 
-      - uses: r-lib/actions/setup-r@v2
-        with:
-          r-version: ${{ matrix.config.r }}
-          rtools-version: ${{ matrix.config.rtools-version }}
-          use-public-rspm: true
-
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           cache-version: 2

DESCRIPTION

@@ -1,11 +1,15 @@
 Package: clarabel
 Type: Package
 Title: Interior Point Conic Optimization Solver
-Version: 0.9.0.1
-Authors@R: c(person("Balasubramanian", "Narasimhan", role=c("aut", "cre"),
+Version: 0.10.0
+Authors@R: c(person("Balasubramanian", "Narasimhan", role = c("aut", "cre"),
 	   	   email = "naras@stanford.edu"),
-	     person("Paul", "Goulart", role=c("aut", "cph")),
-	     person("Yuwen", "Chen", role=c("aut")),
+	     person("Paul", "Goulart", role = c("aut", "cph")),
+	     person("Yuwen", "Chen", role = c("aut")),
+             person("Hiroaki", "Yutani", role = c("ctb"),
+	            comment = "For vendoring/Makefile hints/R scripts for generating crate authors/licenses"),
+             person("David", "Zimmermann-Kollenda", role = c("ctb"),
+	             comment = "For configure scripts and tools/msvr.R lifted from rtitoken package"), 
              person("Hiroaki", "Yutani", role = c("ctb"),
 	            comment = "For vendoring/Makefile hints/R scripts for generating crate authors/licenses"),
 	     person(given = "The authors of the dependency Rust crates", role = c("ctb"),	
@@ -14,8 +18,7 @@ Description: A versatile interior point solver that solves linear programs (LPs)
 License: Apache License (== 2.0)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-Config/rextendr/version: 0.3.1
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 URL: https://oxfordcontrol.github.io/clarabel-r/
 BugReports: https://github.com/oxfordcontrol/clarabel-r/issues
 Suggests: 

NEWS.md

@@ -1,3 +1,12 @@
+# clarabel 0.10.0
+
+- Synced up to v0.10.0 of `Clarabel.rs`
+- Fixed up to use new `r-src` that detects R being used correctly (thank you, Ivan Krylov!)
+
+# clarabel 0.9.0.1
+
+- Explicit system requirements for Rust and Cargo added.
+
 # clarabel 0.9.0
 
 - Synced up to version 0.9.0 of Clarabel.rs

R/clarabel.R

@@ -176,6 +176,7 @@ clarabel <- function(A, b, q, P = NULL, cones, control = list(),
 #' @param linesearch_backtrack_step linesearch backtracking (`0.8`)			 
 #' @param min_switch_step_length minimum step size allowed for asymmetric cones with PrimalDual scaling (`1e-1`)		 
 #' @param min_terminate_step_length minimum step size allowed for symmetric cones && asymmetric cones with Dual scaling (`1e-4`)		 
+#' @param max_threads maximum solver threads for multithreaded KKT solvers, 0 lets the solver choose for itself (`0L`)
 #' @param direct_kkt_solver use a direct linear solver method (required true) (`TRUE`)		 
 #' @param direct_solve_method direct linear solver (`"qdldl"`, `"mkl"` or `"cholmod"`) (`"qdldl"`)		 
 #' @param static_regularization_enable enable KKT static regularization (`TRUE`)		 
@@ -225,6 +226,9 @@ clarabel_control <- function(
                              linesearch_backtrack_step = 0.8,
                              min_switch_step_length = 1e-1,
                              min_terminate_step_length = 1e-4,
+                             ## maximum solver threads for multithreaded KKT solvers
+                             ## choosing 0 lets the solver choose for itself
+                             max_threads = 0L,
                              ## Linear solver settings
                              direct_kkt_solver = TRUE,
                              direct_solve_method = c("qdldl", "mkl", "cholmod"),
@@ -262,7 +266,7 @@ clarabel_control <- function(
                    "chordal_decomposition_enable", "chordal_decomposition_compact",
                    "chordal_decomposition_complete_dual")
 
-  int_params <- c("max_iter", "equilibrate_max_iter", "iterative_refinement_max_iter")
+  int_params <- c("max_iter", "max_threads", "equilibrate_max_iter", "iterative_refinement_max_iter")
 
   string_params <- c("direct_solve_method", "chordal_decomposition_merge_method") # Might need to uncomment character coercion below, if length > 1
 

configure

@@ -1,5 +1,9 @@
+#!/usr/bin/env sh
+: "${R_HOME=`R RHOME`}"
+"${R_HOME}/bin/Rscript" tools/msrv.R
+
 if [ "$(uname)" = "Emscripten" ]; then
   TARGET="wasm32-unknown-emscripten"
 fi
 
-sed -e "s/@TARGET@/${TARGET}/" src/Makevars.in > src/Makevars
+sed -e "s/@TARGET@/${TARGET}/" -e "s|@R_HOME@|${R_HOME}|" src/Makevars.in > src/Makevars

configure.win

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+## Report Rust and Cargo versions
+"${R_HOME}/bin${R_ARCH_BIN}/Rscript.exe" tools/msrv.R

man/clarabel_control.Rd

@@ -1,4 +1,5 @@
 TARGET = @TARGET@
+R_HOME = @R_HOME@
 VENDORING = yes
 VENDOR_SRC = ./rust/vendor.tar.xz
 VENDOR_DIR = ./rust/vendor
@@ -13,8 +14,9 @@ PKG_LIBS = -L$(LIBDIR) -lclarabel $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS)
 
 CARGOTMP = $(CURDIR)/rust/.cargo
 CARGO_BUILD_ARGS = -j 2 --lib --manifest-path=./rust/Cargo.toml --target-dir $(TARGET_DIR)
+RUST_BACKTRACE=1
 
-all: C_clean
+all: $(SHLIB)
 
 $(SHLIB): $(STATLIB)
 
@@ -31,13 +33,15 @@ $(STATLIB):
 	      cp ./rust/cargo_vendor_config.toml $(CARGOTMP)/config.toml;  \
 	      $(TAR) --extract --xz -f $(VENDOR_SRC) -C ./rust ;  \
 	      export CARGO_HOME=$(CARGOTMP);  \
+	      export R_HOME=$(R_HOME);  \
 	      export PATH="$(PATH):$(HOME)/.cargo/bin";  \
 	      cargo build $(CARGO_BUILD_ARGS) --release --offline; \
 	    else \
 	      cargo build $(CARGO_BUILD_ARGS); \
 	    fi \
 	  else \
 	    export CC="$(CC)" && \
+	    export R_HOME="$(R_HOME)" && \
 	    export CFLAGS="$(CFLAGS)" && \
 	    export CARGO_PROFILE_DEV_PANIC="abort" && \
 	    export CARGO_PROFILE_RELEASE_PANIC="abort" && \

src/Makevars.in

@@ -27,11 +27,9 @@ $(STATLIB):
 	mkdir -p $(LIBDIR)/libgcc_mock && touch $(LIBDIR)/libgcc_mock/libgcc_eh.a
 	mkdir -p $(CARGOTMP) && cp ./rust/cargo_vendor_config.toml $(CARGOTMP)/config.toml
 	$(TAR) --extract --xz -f ./rust/vendor.tar.xz -C ./rust 
-	echo "Rust version:" `rustc --version`
-	echo "Cargo version:" `cargo --version`
-
 	export CARGO_HOME="$(CARGOTMP)" && \
 	  export CARGO_TARGET_X86_64_PC_WINDOWS_GNU_LINKER="$(CARGO_LINKER)" && \
+	  export R_HOME="$(R_HOME)" && \
 	  export LIBRARY_PATH="$${LIBRARY_PATH};$(LIBDIR)/libgcc_mock" && \
 	  cargo build -j 2 --target $(TARGET) --lib --offline --release --manifest-path ./rust/Cargo.toml --target-dir $(TARGET_DIR)
 	rm -Rf $(CARGOTMP)