Development Setup

We work with CMake for building and testing the project. The usual things apply. We also have different CMake presets for using sanitizers and different compilers etc.

Build

Default

1. Build requirements

   Note

   We require C++20, CMake v3.25.2+, and a recent C++ and CUDA compiler.

   Ubuntu

   apt install cmake gcc ninja-build

   Cluster

   module load GCC CUDA Ninja CMake

2. Build and run tests

   Using regular CMake

   cmake -B build -G Ninja
   cmake --build build
   ./build/tests/tests

   Using Presets

   cmake --preset debug
   cmake --build --preset debug
   ctest --preset debug

   Using Workflows

   cmake --workflow --preset dev

Compiler specific

Note

Consider using the presets in CMakePresets.json for various compilers. You can query the available presets using:

cmake --list-presets

Intel-LLVM

module load intel-compilers/2024.2.0 GCCcore/14.3.0 CUDA/12.8.0 Ninja/1.13.0 CMake/4.0.3

cmake --preset linux-icpx-debug

Clang

module load GCCcore Clang CUDA Ninja CMake

cmake --preset linux-clang-debug

Tests

1. Build

   cmake --build build --target tests

2. Run

   The tests can be run using ctest

   ctest --test-dir build

   or just

   ./build/tests/tests

   Note

   The tests can be run using OpenMP (it must be installed on your system).

Tests can be written in an .itl or directly in CUDA C++.

Automatic test generation from .itl files

Most tests are generated using the test_converter.py script. Simply do:

python3 tests/test_converter.py

The tests are written in ITL. Most come from various other interval arithmetic libraries. To write new ones, add a new file into the itl folder, provide tests in the ITL format, and rerun the script. E.g.,

/*
   Multiline comment
*/
// regular comment
testcase section.test1 {
   add [10.0, 20.0] [13.0, 17.0] = [23.0, 37.0];
   sub [10.0, 20.0] [13.0, 16.0] = [-6.0, 7.0];
   neg [-infinity, infinity] = [-infinity, infinity];
   pos [10.0, 20.0] = [10.0, 20.0];
}

testcase test_outside_of_section {
   isEmpty [nai] = false; // nai stands for not-an-interval
   isEmpty [empty] = true;
   convexHull [1.0,3.0] [entire] = [entire]; // entire = [-∞, ∞]
   cbrt [0x40p0, 0x7dp0] = [4.0, 5.0]; // hexfloat supported
}

Creating new C++ tests

All handwritten tests need to be included in the tests_additional.h header and should follow a similar structure as the existing tests.

Release

When creating a new release, ensure that the version numbers in all locations are updated correctly. This can be achieved by running:

./tools/bump-version.sh <version>

Ensure that the version has v as a prefix, e.g., v1.2.3.

Once a release is created on GitHub with the corresponding tag the new documentation is automatically generated and deployed.