CLUE++

C++ Lightweight Utility Extensions

This library requires C++11-compliant compiler. Particularly, it is tested on the following platforms:

• Clang (Apple LLVM version 7.0.0) @ Mac OS X 10.10.5 (Locally)
• GCC 4.8.1 @ Ubuntu 12.04 (Travis CI)
• Clang 3.4 @ Ubuntu 12.04 (Travis CI)

Overview

CLUE++ is a collection of utilities to support modern C++ development. We strictly follow the C++11 standard and the conventions in C++ standard library in implementing all components in the library.

Below is a list of components available in the library.

Basic Utilites

• Generic function make_unique: for creating unique_ptr. (backport from C++14)
• Class template optional: for representing nullable values. (backport from CELF)
• Timing tools: stop_watch class and timing functions.
• Class template value_range: so you can write for (auto x: vrange(1, 10)) { ... }.
• Class template array_view: wrap a memory block into an STL-like view.
• Class template fast_vector: an optimized implementation of vector, especially fast for large number of small vectors or vectors with relocatable elements.
• Class template reindexed_view: STL-like view of a subset of elements.
• Class template ordered_dict: associative container that preserves input order.
• Class template keyed_vector: sequential container that allows key-based indexing.
• type_name for getting demangled type names with supported compilers.
• A collection of predicate-generating functions to express conditions.

String and text processing

• Class template string_view: light-weight wrapper of sub-strings. (backport from CELF)
• Extensions of string functionalities (e.g. trimming, value parsing, tokenizers).
• Class template mparser: a light-weight generic parser combinator to facilitate string parsing.
• A light-weight string template engine.
• In-memory string formatting and extensible formatter systems.
• Text I/O functionalities (e.g. read file into a string and wrap string into a stream of lines).

Meta programming tools

• Extensions of type traits (e.g add_cv_t, remove_cv_t, enable_if_t etc) (backport from C++14)
• Meta-types (e.g. type_<T>, int_<V>, bool_<V>, etc) and meta-functions (e.g meta::plus, meta::and, meta::all, meta::select, etc)
• Meta-sequence: static list of types, and algorithms.

Concurrency programming support

• Classes shared_mutex, shared_timed_mutex, and shared_lock: to support read/write lock. (backport from C++14/C++17).
• Class concurrent_counter: a counter that allow threads to wait on certain conditions of its value.
• Class concurrent_queue: thread-safe queues, which can be used as a task queue.
• Class thread_pool: thread pool (map tasks to a fixed number of threads).

Note: Certain components are marked with backport. Such components are introduced in the C++14 Standard or the C++ Extensions for Library Fundamentals (CELF), ISO/IEC TS 19568:xxxx. While they were not introduced to C++11, they can be implemented within the capacity of C++11 standard. We provide an implementation (using libc++ as a reference implementation) here (within the namespace clue) that works with C++11.

Dependencies

• The library itself requires a C++11-compliant compiler to work. Other than that, there's no other dependencies.
• This is a header-only library. You don't have to build anything. Just include the relevant header files in your code.
• This project uses Google Test for testing. If you want to build the test suite, you may need to configure Google Test properly such that cmake can find it (e.g. you can set the environment variable GTEST_ROOT).

Unlike massive library such as Boost, this is a very small library (all headers together have around 5000 - 6000 lines of codes). Actually, that we don't want to depend on Boost in certain projects is an important reason that motivates this library. We find that this library is already sufficient to satisfy the basic requirement of our other projects.

Documentation

Here is the Detailed Documentation.