A header-only library of C++ vector, matrix, and quaternion math expression templates and related functions

The Configurable Math Library (CML) is released under the Boost Software License, Version 1.0..

As it is header-only, it is simple enough to copy the cml header directory into your project and setup your build to reference it. Users of CMake 3.15+ can also use cmake --install ... and find_package(cml CONFIG) to integrate CML into a CMake project.

The CML requires a compiler with C++17 support.

To run the test suite from a command prompt using a Makefile-like generator, start in your build directory and execute:

cmake -S <path to cml-root> -G{generator name} -DBUILD_TESTING=On -DCMAKE_BUILD_TYPE=Release

Note that this will download a compatible Catch2 version used by the test suite. To build the tests (again from your build directory):

cmake --build . --config Release

You can run the full test suite from your build directory by executing:

ctest -C Release

If you have multiple CPUs, you can speed things up a bit; e.g.:

cmake --build . --config Release -- -j4
ctest -C Release -j4

See CMakePresets.json for the default configure, build, test, and workflow presets. Additional inheritable presets can be found in cmake/presets/*.json for customization in CMakeUserPresets.json. Note that all of the predefined configure presets create a build directory under <cml-root>/.build, and those ending in -vcpkg require vcpkg to be cloned under <cml-root>/vcpkg.

To see the available presets by type, execute cmake --list-presets=<type>, where type can be configure, build, test, workflow, or all; e.g. to see the list of invocable presets when calling cmake on Windows:

> cmake --list-presets=all
Available configure presets:

  "windows-ninja-clangcl-mt-s-vcpkg"
  "windows-msbuild-msvc-17-mt-s-vcpkg"
  "windows-msbuild-clangcl-17-mt-s-vcpkg"

Available build presets:

  "windows-ninja-clangcl-mt-s-vcpkg-release"
  "windows-msbuild-msvc-17-mt-s-vcpkg-release"

Available test presets:

  "windows-ninja-clangcl-mt-s-vcpkg-test"
  "windows-msbuild-msvc-17-mt-s-vcpkg-test"

Available workflow presets:

  "windows-ninja-clangcl-mt-s-vcpkg"
  "windows-msbuild-msvc-17-mt-s-vcpkg"
  "linux-ninja-clang-s-vcpkg"
  "linux-ninja-gcc-s-vcpkg"

Note that all workflow presets will be shown even if not applicable to the running system (https://gitlab.kitware.com/cmake/cmake/-/issues/26236, https://discourse.cmake.org/t/condition-field-for-workflow-presets/6934).