GiulioRomualdi / scs-eigen

Simple Eigen-C++ wrapper for scs library
https://giulioromualdi.github.io/scs-eigen
MIT License
6 stars 1 forks source link
conic-optimization convex-optimization scs

scs-eigen Size

Dependencies

The project depends only on scs and Eigen3. Please install scs using the cmake-build system provide in this repository.

Documentation

The documentation is available online at the accompanying website.

Usage

  1. Clone the repository

    git clone https://github.com/GiulioRomualdi/scs-eigen
  2. Build it

    cd scs-eigen
    mkdir build
    cd build
    cmake -DCMAKE_INSTALL_PREFIX:PATH=<custom-folder> ../
    make
    make install
  3. Add the following environmental variable
    ScsEigen_DIR=/path/where/you/installed/

How to use the library

scs-eigen provides native CMake support which allows the library to be easily used in CMake projects. scs-eigen exports a CMake target called ScsEigen::ScsEigen which can be imported using the find_package CMake command and used by calling target_link_libraries as in the following example:

cmake_minimum_required(VERSION 3.0)
project(myproject)
find_package(ScsEigen REQUIRED)
add_executable(example example.cpp)
target_link_libraries(example ScsEigen::ScsEigen)

License

Materials in this repository are distributed under the following license:

All software is licensed under the MIT License. See LICENSE file for details.