Skip to content

cmake options cleanup #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goulart-paul merged 3 commits into from
Jun 11, 2025
Merged

cmake options cleanup #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0214321
cmake config cleanup
goulart-paul Jun 11, 2025
02a1654
cmake config cleanup
goulart-paul Jun 11, 2025
0f42d28
Merge branch 'pg/cmake2' of https://github.com/oxfordcontrol/Clarabel…
goulart-paul Jun 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ option(CLARABEL_FEATURE_FAER_SPARSE "Enable `faer-sparse` option" OFF)
option(CLARABEL_FEATURE_PARDISO_MKL "Enable `pardiso-mkl` option" OFF)
option(CLARABEL_FEATURE_PARDISO_PANUA "Enable `pardiso-panua` option" OFF)

# option for direct cargo feature specification
set(CLARABEL_CARGO_FEATURES "" CACHE STRING "Comma-separated list of clarabel features for cargo")

#----------------------------------------------
#----------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ where `VCPKG_TOOLCHAIN_PATH` is the path to the vcpkg toolchain file.

## Optional solver features

Clarabel.rs supports a variety of build options for semidefinite program (SDP) support, JSON file read/write, 3rd party linear solvers etc. Feature options can be passed to cargo via CMake using `-DCLARABEL_RUST_FEATURES = "feature1,feature2,..."`.
Clarabel.rs supports a variety of build options for semidefinite program (SDP) support, JSON file read/write, 3rd party linear solvers etc. Feature options can be passed to cargo via CMake using `-DCLARABEL_CARGO_FEATURES = "feature1,feature2,..."`.

| Feature | Description |
|---------|-------------|
Expand Down
34 changes: 17 additions & 17 deletions rust_wrapper/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ endif()

set(CLARABEL_C_OUTPUT_DIR ${clarabel_c_output_directory} PARENT_SCOPE)

if(NOT DEFINED CLARABEL_RUST_FEATURES)
set(CLARABEL_RUST_FEATURES "")
if(NOT DEFINED CLARABEL_CARGO_FEATURES)
set(CLARABEL_CARGO_FEATURES "")
endif()

# -------------------------------------
# Cargo feature configuration helper functions
#--------------------------------------

# Check if CLARABEL_RUST_FEATURES contains a specific feature
# Check if CLARABEL_CARGO_FEATURES contains a specific feature
function(rust_feature_is_enabled PATTERN RESULT_VAR)
string(REPLACE "," ";" FEATURE_LIST "${CLARABEL_RUST_FEATURES}")
string(REPLACE "," ";" FEATURE_LIST "${CLARABEL_CARGO_FEATURES}")
set(${RESULT_VAR} FALSE PARENT_SCOPE)
foreach(FEATURE ${FEATURE_LIST})
if(FEATURE MATCHES "${PATTERN}")
Expand All @@ -38,9 +38,9 @@ function(rust_feature_is_enabled PATTERN RESULT_VAR)
endforeach()
endfunction()

# Check if CLARABEL_RUST_FEATURES contains any of the "sdp" options
# Check if CLARABEL_CARGO_FEATURES contains any of the "sdp" options
function(rust_features_has_sdp RESULT_VAR)
if(CLARABEL_RUST_FEATURES MATCHES ".*sdp.*")
if(CLARABEL_CARGO_FEATURES MATCHES ".*sdp.*")
set(${RESULT_VAR} TRUE PARENT_SCOPE)
else()
set(${RESULT_VAR} FALSE PARENT_SCOPE)
Expand Down Expand Up @@ -80,20 +80,20 @@ endfunction()


if(NOT CLARABEL_FEATURE_SDP STREQUAL "none")
append_feature(CLARABEL_RUST_FEATURES "${CLARABEL_FEATURE_SDP}")
append_feature(CLARABEL_CARGO_FEATURES "${CLARABEL_FEATURE_SDP}")
endif()

if(CLARABEL_FEATURE_FAER_SPARSE)
append_feature(CLARABEL_RUST_FEATURES "faer-sparse")
append_feature(CLARABEL_CARGO_FEATURES "faer-sparse")
endif()

if(CLARABEL_FEATURE_PARDISO_MKL)
append_feature(CLARABEL_RUST_FEATURES "pardiso-mkl")
append_feature(CLARABEL_CARGO_FEATURES "pardiso-mkl")
endif()

# SERDE feature flag
if(CLARABEL_FEATURE_SERDE)
append_feature(CLARABEL_RUST_FEATURES "serde")
append_feature(CLARABEL_CARGO_FEATURES "serde")
endif()


Expand All @@ -102,7 +102,7 @@ endif()
#--------------------------------------

# ----
# Rust features should be passed via the CLARABEL_RUST_FEATURES variable.
# Cargo features can be passed directly via the CLARABEL_CARGO_FEATURES variable.
# For some features, we requires some additional CMake configuration.
# ---

Expand Down Expand Up @@ -144,22 +144,22 @@ endif()

# replace each rust <feature> with clarabel/<feature> so that they pass through
# this wrapper to the clarabel crate underneath
format_clarabel_rust_features("${CLARABEL_RUST_FEATURES}" CLARABEL_RUST_FEATURES)
format_clarabel_rust_features("${CLARABEL_CARGO_FEATURES}" CLARABEL_CARGO_FEATURES)

# some features must also be specified at the wrapper level
# add them again, but after prepending clarabel/ to everything
if(CONFIG_SDP)
append_feature(CLARABEL_RUST_FEATURES "sdp")
append_feature(CLARABEL_CARGO_FEATURES "sdp")
endif()
if(CONFIG_SERDE)
append_feature(CLARABEL_RUST_FEATURES "serde")
append_feature(CLARABEL_CARGO_FEATURES "serde")
endif()

if(NOT CLARABEL_RUST_FEATURES STREQUAL "")
set(clarabel_c_build_flags "${clarabel_c_build_flags};--features=${CLARABEL_RUST_FEATURES}")
if(NOT CLARABEL_CARGO_FEATURES STREQUAL "")
set(clarabel_c_build_flags "${clarabel_c_build_flags};--features=${CLARABEL_CARGO_FEATURES}")
endif()

message("-- Rust feature list: " ${CLARABEL_RUST_FEATURES})
message("-- Cargo feature list: " ${CLARABEL_CARGO_FEATURES})
message("-- Cargo options: " "${clarabel_c_build_flags}")

# -------------------------------------
Expand Down