rs-core

Core utilities

---

Project maintained by CaptainCrowbar Hosted on GitHub Pages — Theme by mattgraham

Core Utilities Library

By Ross Smith

GitHub repository

Introduction

This is a set of basic utilities that I use throughout my C++ code, collected here to avoid widespread duplication. Basically I put stuff in here when I get tired of re-implementing it in multiple projects.

Requires C++23. Not yet tested on all compilers.

Index of headers

• General utilities
  • rs-core/global.hpp – Global utilities
  • rs-core/hash.hpp – Hash functions
  • rs-core/scope.hpp – Scope guards
  • rs-core/uuid.hpp – UUID class
  • rs-core/version.hpp – Version information
• I/O utilities
  • rs-core/io.hpp – I/O utilities
  • rs-core/log.hpp – Logging
  • rs-core/terminal.hpp – Terminal control
• Mathematical utilities
  • rs-core/arithmetic.hpp – Arithmetic types and functions
  • rs-core/constants.hpp – Physical constants
  • rs-core/linear-algebra.hpp – Linear algebra
  • rs-core/mp-integer.hpp – Multiple precision integers
  • rs-core/random.hpp – Random number generators
  • rs-core/rational.hpp – Rational numbers
  • rs-core/uint128.hpp – 129-bit integers
• Text utilities
  • rs-core/character.hpp – Character functions
  • rs-core/format.hpp – Formatting helpers
  • rs-core/markup.hpp – Text markup
• Type system utilities
  • rs-core/alias.hpp – Hard type alias
  • rs-core/enum.hpp – Enumeration helpers
  • rs-core/iterator.hpp – Iterator base classes
  • rs-core/typename.hpp – Type names

Using the library

There is a CMakeLists.txt file, but this is usually only needed if you want to run the unit tests. The library is header-only and can be installed simply by copying or linking the rs-core directory into somewhere on your include path. Running

cmake --build . --config Release --target install

will do this, or you can just copy or symlink it by hand.

To use the library, just #include the headers you want. No special link-time options are needed.