Merge pull request #23 from oxfordcontrol/conespec_fix

Robustify solver, add warm-start API, and update docs (v0.11.2)

Author: bnaras

.Rbuildignore

@@ -17,3 +17,7 @@
 ^src/rust/.cargo$
 ^src/Makevars$
 ^cran-comments\.md$
+
+^src/rust/\.cargo$
+^\.claude$
+^CLAUDE\.md$

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: clarabel
 Type: Package
 Title: Interior Point Conic Optimization Solver
-Version: 0.11.1
+Version: 0.11.2
 Authors@R: c(person("Balasubramanian", "Narasimhan", role = c("aut", "cre"),
 	   	   email = "naras@stanford.edu"),
 	     person("Paul", "Goulart", role = c("aut", "cph")),
@@ -26,5 +26,6 @@ Suggests:
     tinytest
 VignetteBuilder: knitr
 SystemRequirements: Cargo (Rust's package manager), rustc (>= 1.70.0), and GNU Make
-Imports: 
+Imports:
+    cli,
     methods

NAMESPACE

@@ -1,8 +1,15 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method("$<-",savvy_clarabel__sealed)
+S3method("[[<-",savvy_clarabel__sealed)
+S3method(print,"clarabel::ClarabelSolver__bundle")
 export(clarabel)
 export(clarabel_control)
+export(clarabel_solver)
+export(solver_is_update_allowed)
+export(solver_solve)
 export(solver_status_descriptions)
+export(solver_update)
 importFrom(methods,as)
 useDynLib(clarabel)
 useDynLib(clarabel, .registration = TRUE)

NEWS.md

@@ -1,3 +1,15 @@
+# clarabel 0.11.2
+
+- Added persistent solver API for warm starts: `clarabel_solver()`,
+  `solver_solve()`, `solver_update()`, `solver_is_update_allowed()`
+- Robustified Rust interface: type coercion, error handling,
+  CscMatrix validation, and regex ordering fixes
+- Switched all R-side error messaging to `cli::cli_abort()` with
+  markup
+- Upgraded `savvy` crate from 0.8.13 to 0.9.2
+- Added examples to `clarabel_control()` and solver functions
+- Added vignette section on updating problem data (warm starts)
+
 # clarabel 0.11.1
 
 - Synced up to v0.11.1 of `Clarabel.rs`

R/000-wrappers.R

@@ -23,9 +23,71 @@ NULL
   }
 }
 
+# Prohibit modifying environments
 
-clarabel_solve <- function(m, n, Ai, Ap, Ax, b, q, Pi, Pp, Px, cone_spec, r_settings) {
-  .Call(savvy_clarabel_solve__impl, m, n, Ai, Ap, Ax, b, q, Pi, Pp, Px, cone_spec, r_settings)
+#' @export
+`$<-.savvy_clarabel__sealed` <- function(x, name, value) {
+  class <- gsub("__bundle$", "", class(x)[1])
+  stop(class, " cannot be modified", call. = FALSE)
 }
 
+#' @export
+`[[<-.savvy_clarabel__sealed` <- function(x, i, value) {
+  class <- gsub("__bundle$", "", class(x)[1])
+  stop(class, " cannot be modified", call. = FALSE)
+}
+
+
+`clarabel_solve` <- function(`m`, `n`, `Ai`, `Ap`, `Ax`, `b`, `q`, `Pi`, `Pp`, `Px`, `cone_spec`, `r_settings`) {
+  .Call(savvy_clarabel_solve__impl, `m`, `n`, `Ai`, `Ap`, `Ax`, `b`, `q`, `Pi`, `Pp`, `Px`, `cone_spec`, `r_settings`)
+}
+
+### wrapper functions for ClarabelSolver
+
+`ClarabelSolver_is_update_allowed` <- function(self) {
+  function() {
+    .Call(savvy_ClarabelSolver_is_update_allowed__impl, `self`)
+  }
+}
+
+`ClarabelSolver_solve` <- function(self) {
+  function() {
+    .Call(savvy_ClarabelSolver_solve__impl, `self`)
+  }
+}
+
+`ClarabelSolver_update_data` <- function(self) {
+  function(`Px`, `Ax`, `q`, `b`) {
+    invisible(.Call(savvy_ClarabelSolver_update_data__impl, `self`, `Px`, `Ax`, `q`, `b`))
+  }
+}
+
+`.savvy_wrap_ClarabelSolver` <- function(ptr) {
+  e <- new.env(parent = emptyenv())
+  e$.ptr <- ptr
+  e$`is_update_allowed` <- `ClarabelSolver_is_update_allowed`(ptr)
+  e$`solve` <- `ClarabelSolver_solve`(ptr)
+  e$`update_data` <- `ClarabelSolver_update_data`(ptr)
+
+  class(e) <- c("clarabel::ClarabelSolver", "ClarabelSolver", "savvy_clarabel__sealed")
+  e
+}
+
+
+#' A persistent Clarabel solver that can be reused across R calls.
+`ClarabelSolver` <- new.env(parent = emptyenv())
+
+### associated functions for ClarabelSolver
+
+`ClarabelSolver`$`new` <- function(`m`, `n`, `Ai`, `Ap`, `Ax`, `b`, `q`, `Pi`, `Pp`, `Px`, `cone_spec`, `r_settings`) {
+  .savvy_wrap_ClarabelSolver(.Call(savvy_ClarabelSolver_new__impl, `m`, `n`, `Ai`, `Ap`, `Ax`, `b`, `q`, `Pi`, `Pp`, `Px`, `cone_spec`, `r_settings`))
+}
+
+
+class(`ClarabelSolver`) <- c("clarabel::ClarabelSolver__bundle", "savvy_clarabel__sealed")
+
+#' @export
+`print.clarabel::ClarabelSolver__bundle` <- function(x, ...) {
+  cat('clarabel::ClarabelSolver\n')
+}