Skip to content

FrancoisCarouge/TypedLinearAlgebra

Repository files navigation

Typed Linear Algebra

This library provides a C++ statically type-safe linear algebra facade to the Eigen linear algebra library.

Installation

Example of installation commands in Shell:

git clone --depth 1 "https://github.com/FrancoisCarouge/TypedLinearAlgebra"
cmake -S "TypedLinearAlgebra" -B "build"
cmake --build "build" --parallel
sudo cmake --install "build"

Another variation for your CMake infrastructure via fetch content:

include(FetchContent)

FetchContent_Declare(
  fcarouge-typed-linear-algebra
  GIT_REPOSITORY "https://github.com/FrancoisCarouge/TypedLinearAlgebra"
  FIND_PACKAGE_ARGS NAMES fcarouge-typed-linear-algebra)
FetchContent_MakeAvailable(fcarouge-typed-linear-algebra)

target_link_libraries(your_target PRIVATE fcarouge-typed-linear-algebra::linalg)

For more, see installation instructions.

Resources

Third Party Acknowledgement

The library is designed, developed, and tested with the help of third-party tools and services acknowledged and thanked here:

  • actions-gh-pages to upload the documentation to GitHub pages.
  • Clang for compilation and code sanitizers.
  • CMake for build automation.
  • cmakelang for pretty CMake list files.
  • cppcheck for static analysis.
  • Doxygen for documentation generation.
  • Doxygen Awesome for pretty documentation.
  • Eigen for linear algebra.
  • GCC for compilation and code sanitizers.
  • Google Benchmark to implement the benchmarks.
  • lcov to process coverage information.
  • mp-units the quantities and units library for C++.
  • MSVC for compilation and code sanitizers.
  • Valgrind to check for correct memory management.

Sponsors

Become a sponsor today! Support this project with coffee and infrastructure!

Sponsor

Corporations & Institutions

Your group logo and link here!

Individuals

Your name and link here!

Thanks everyone!

Continuous Integration & Deployment Actions

Code Repository

Pipeline

Sanitizer
Format
ClangTidy
CppCheck
Doxygen
Valgrind

Public Domain
License Scan
OpenSSF Best Practices

Deploy Unit Test Code Coverage
Deploy Doxygen

Sponsor

License

TypedLinearAlgebra is public domain:

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org