CCMath - A C++17 Compile Time CMath Library

CCMath is a C++17 library that provides a re-implementation of the standard <cmath> library with all features made constexpr. This enables compile-time evaluation of mathematical functions, improving performance and allows for more efficient code in scenarios where constant expressions are required.

Features

Full constexpr Compatibility: All functions provided by CCMath are implemented as constexpr along with an active effort made to ensure all functions work within static_assert. The primary goal is to ensure every function can be evaluated at compile time.
Drop-in Replacement for the Standard Math Library: CCMath provides a comprehensive set of mathematical functions that are 1:1 compatible with the C++ standard library <cmath>. The goal of CCMath is to effectively be a drop-in replacement for <cmath> with little to no discernible difference between the two. This includes trigonometric, exponential, logarithmic, and other common mathematical operations. If <cmath> has it then it is likely CCMath has implemented it.
Performance Optimization: Besides all the functions being able to be evaluated at compile time, CCMath was also built with speed in mind. We strive to have speeds nearly as fast as the standard implementation.
Optimized Runtime Evaluation: In all instances where a function cannot be evaluated at compile time, CCMath has been optimized to provide the fastest runtime evaluation possible and aims to be as fast as the standard library.
Cross-Platform Compatibility: CCMath is designed to work on all major platforms and compilers. It has been tested on Windows, macOS, and Linux with compilers such as GCC, Clang, and MSVC.
No External Dependencies: CCMath has no external dependencies and only requires a modern C++17-compliant compiler.
Header-Only Library: CCMath is a header-only library, making it easy to integrate into your projects.

Usage

To use CCMath in your projects, include the <ccmath/ccmath.hpp> header file and start using the provided functions. Here's a basic example:


#include <ccmath/ccmath.hpp> // Monolithic header file that includes all functions. Similar to including <cmath>
// #include <ccmath/power/sqrt.hpp> // You can also directly include the functions you require without bringing in extra functions!


#include <iostream> // For std::cout

int main() {
    constexpr double x = ccm::sqrt(25.0);  // Compile-time evaluation of square root
    std::cout << "Square root of 25: " << x << std::endl;
    return 0;
}

Adding CCMath to your project

CCMath has a comprehensive cmake setup and can be easily included in your project using fetchcontent like so:

cmake_minimum_required(VERSION 3.18)

include(FetchContent)
FetchContent_Declare(
        ccmath
        GIT_REPOSITORY https://github.com/Rinzii/ccmath.git
        GIT_TAG v0.2.0 # Replace with the version you want to use
)
FetchContent_MakeAvailable(ccmath)

target_link_libraries(main PRIVATE ccmath::ccmath)

CCMath is also designed with functions being freestanding and header only so you can also just drop the headers directly into your project!

Compiler Support

GCC 11.1+
Clang 9.0.0+
AppleClang 14.0.3+ (Lowest tested version)
MSVC 19.26+
Intel DPC++ 2022.0.0+
Nvidia HPC SDK 22.7+ (Lowest tested version)

[!NOTE] Currently working on finding manners to lower these requirements.

Join Our Discord!

If you have any questions, suggestions, or just want to chat, feel free to join our Discord server!

Contributing

CCmath is an open-source project, and it needs your help to go on growing and improving. If you want to get involved and suggest some additional features, file a bug report or submit a patch, please have a look at the contribution guidelines!

Implementation Progress (Modules)

| Module | % done | In Progress? | Notes? | Planned Completion Version | |--------------------------|--------|--------------|--------|----------------------------| | Basic | 100 | | | v0.1.0 (Released) | | Compare | 100 | | | v0.2.0 (Released) | | Exponential | 57 | | | maybe v0.3.0 or v0.4.0 |
| Float Manipulation | 25 | | | | | Hyperbolic | 0 | | | | | Nearest | 33 | | | | | Power | 5 | ✓ | | maybe v0.3.0 or v0.4.0 | | Special Functions | 0 | | | | | Trigonometric | 0 | | | | | Misc Functions | 30 | | | | | Total Library Completion | 37 | | | |

Last Updated: Aug 31, 2024

Implementation Progress (Functions)

| Feature |----------------|---- | abs | 100 | | fdim | 100 | | fma | (f)max | 100 | | (f)min | 100 | | remainder | 100 | | remquo | 100 | | nan | fpclassify | 100 | | isfinite | 100 | | isgreater | 100 | | isgreaterequal | 100 | | isinf | 100 | | isless | 100 | | islessequal | 100 | | islessgreater | 100 | | isnan | 100 | | isnormal | 100 | | isunordered | 100 | | signbit | exp | exp2 | expm1 | 0 | log | log1p | 0 | % done | TODO | ----|-------------------------------------------------------------------------------------------------------------| | | | 100 | Functional. Need to add proper runtime specific speed up. | | | | | | 100 | The nan function is still quite brittle, but it has reached a point of functionality. | | | | | | | | | | | | | 100 | Desire to find a manner of implementing signbit on lower versions of MSVC. | | 100 | Needs to be modernized to current CCMath standards | | 100 | Needs to be modernized to current CCMath standards | | Implement function | | 100 | Needs to be modernized to current CCMath standards | | Implement function

Ccmath

Install / Use

README