Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luk036/corr-solver-cpp
🖇️ Correlation Solver C++ Code via Ellipsoid Method
https://github.com/luk036/corr-solver-cpp
cmake correlation cpp17 linear-matrix-inequalities
Last synced: 26 days ago
JSON representation
🖇️ Correlation Solver C++ Code via Ellipsoid Method
- Host: GitHub
- URL: https://github.com/luk036/corr-solver-cpp
- Owner: luk036
- License: unlicense
- Created: 2021-07-19T10:57:36.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-01T03:38:08.000Z (about 1 month ago)
- Last Synced: 2024-12-01T04:27:19.561Z (about 1 month ago)
- Topics: cmake, correlation, cpp17, linear-matrix-inequalities
- Language: C++
- Homepage: https://luk036.github.io/corr-solver-cpp/
- Size: 328 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/luk036/corr-solver-cpp/actions)
[](https://github.com/luk036/corr-solver-cpp/actions)
[](https://github.com/luk036/corr-solver-cpp/actions)
[](https://github.com/luk036/corr-solver-cpp/actions)
[](https://github.com/luk036/corr-solver-cpp/actions)
[](https://codecov.io/gh/luk036/corr-solver-cpp)
# 🖇️ CorrSolverCpp
Correlation solver for modern C++
- This library requires C++17 or above.
- This library depends on GSL, LmiSolver, EllAlgo, xtensor-blas and OpenBLAS.
## ✨ Features
- Lazy evaluation of Cholesky/LDLT decomposition
- Suport semi- and strictlu positive definite.
- [Modern CMake practices](https://pabloariasal.github.io/2018/02/19/its-time-to-do-cmake-right/)
- Integrated test suite
- Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)
- Code coverage via [codecov](https://codecov.io)
- Code formatting enforced by [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [cmake-format](https://github.com/cheshirekow/cmake_format) via [Format.cmake](https://github.com/TheLartians/Format.cmake)
- Reproducible dependency management via [CPM.cmake](https://github.com/TheLartians/CPM.cmake)
- Installable target with automatic versioning information and header generation via [PackageProject.cmake](https://github.com/TheLartians/PackageProject.cmake)
- Automatic [documentation](https://thelartians.github.io/ModernCppStarter) and deployment with [Doxygen](https://www.doxygen.nl) and [GitHub Pages](https://pages.github.com)
- Support for [sanitizer tools, and more](#additional-tools)
## Usage
### Adjust the template to your needs
- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
- Replace all occurrences of "CorrSolver" in the relevant CMakeLists.txt with the name of your project
- Capitalization matters here: `CorrSolver` means the name of the project, while `corrsolver` is used in file names.
- Remember to rename the `include/corrsolver` directory to use your project's lowercase name and update all relevant `#include`s accordingly.
- Replace the source files with your own
- For header-only libraries: see the comments in [CMakeLists.txt](CMakeLists.txt)
- Add [your project's codecov token](https://docs.codecov.io/docs/quick-start) to your project's github secrets under `CODECOV_TOKEN`
- Happy coding!
Eventually, you can remove any unused files, such as the standalone directory or irrelevant github workflows for your project.
Feel free to replace the License with one suited for your project.
To cleanly separate the library and subproject code, the outer `CMakeList.txt` only defines the library itself while the tests and other subprojects are self-contained in their own directories.
During development it is usually convenient to [build all subprojects at once](#build-everything-at-once).
### Build and run the standalone target
Use the following command to build and run the executable target.
```bash
cmake -S. -B build
cmake --build build
./build/standalone/CorrSolver --help
```
### Build and run test suite
Use the following commands from the project's root directory to run the test suite.
```bash
cmake -S. -B build
cmake --build build
cd build/test
CTEST_OUTPUT_ON_FAILURE=1 ctest
# or maybe simply call the executable:
./build/test/CorrSolverTests
```
To collect code coverage information, run CMake with the `-DENABLE_TEST_COVERAGE=1` option.
### Run clang-format
Use the following commands from the project's root directory to check and fix C++ and CMake source style.
This requires _clang-format_, _cmake-format_ and _pyyaml_ to be installed on the current system.
```bash
cmake -S . -B build/test
# view changes
cmake --build build --target format
# apply changes
cmake --build build --target fix-format
```
See [Format.cmake](https://github.com/TheLartians/Format.cmake) for details.
### Build the documentation
The documentation is automatically built and [published](https://luk036.github.io/corr-solver-cpp) whenever a [GitHub Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) is created.
To manually build documentation, call the following command.
```bash
cmake -S . -B build
cmake --build build --target GenerateDocs
# view the docs
open build/documentation/doxygen/html/index.html
```
To build the documentation locally, you will need Doxygen, jinja2 and Pygments on installed your system.
### Additional tools
The test and standalone subprojects include the [tools.cmake](cmake/tools.cmake) file which is used to import additional tools on-demand through CMake configuration arguments.
The following are currently supported.
#### Sanitizers
Sanitizers can be enabled by configuring CMake with `-DUSE_SANITIZER=
`.
#### Static Analyzers
Static Analyzers can be enabled by setting `-DUSE_STATIC_ANALYZER=`, or a combination of those in quotation marks, separated by semicolons.
By default, analyzers will automatically find configuration files such as `.clang-format`.
Additional arguments can be passed to the analyzers by setting the `CLANG_TIDY_ARGS`, `IWYU_ARGS` or `CPPCHECK_ARGS` variables.
#### Ccache
Ccache can be enabled by configuring with `-DUSE_CCACHE=`.
## Related projects and alternatives
- [**ModernCppStarter & PVS-Studio Static Code Analyzer**](https://github.com/viva64/pvs-studio-cmake-examples/tree/master/modern-cpp-starter): Official instructions on how to use the ModernCppStarter with the PVS-Studio Static Code Analyzer.
- [**lefticus/cpp_starter_project**](https://github.com/lefticus/cpp_starter_project/): A popular C++ starter project, created in 2017.
- [**filipdutescu/modern-cpp-template**](https://github.com/filipdutescu/modern-cpp-template): A recent starter using a more traditional approach for CMake structure and dependency management.
- [**vector-of-bool/pitchfork**](https://github.com/vector-of-bool/pitchfork/): Pitchfork is a Set of C++ Project Conventions.