Showing preview only (393K chars total). Download the full file or copy to clipboard to get everything.
Repository: goldsborough/lru-cache
Branch: master
Commit: 13f30ad33a22
Files: 52
Total size: 374.6 KB
Directory structure:
gitextract_khl86cyt/
├── .clang-format
├── .gitignore
├── .gitmodules
├── .travis.yml
├── CMakeLists.txt
├── LICENSE
├── README.md
├── cpplint.cfg
├── docs/
│ └── Doxyfile
├── examples/
│ ├── CMakeLists.txt
│ ├── callbacks.cpp
│ ├── fibonacci-basic.cpp
│ ├── fibonacci-timed.cpp
│ ├── lowercase.cpp
│ ├── statistics.cpp
│ └── wrap.cpp
├── include/
│ └── lru/
│ ├── cache-tags.hpp
│ ├── cache.hpp
│ ├── entry.hpp
│ ├── error.hpp
│ ├── insertion-result.hpp
│ ├── internal/
│ │ ├── base-cache.hpp
│ │ ├── base-iterator.hpp
│ │ ├── base-ordered-iterator.hpp
│ │ ├── base-unordered-iterator.hpp
│ │ ├── callback-manager.hpp
│ │ ├── definitions.hpp
│ │ ├── hash.hpp
│ │ ├── information.hpp
│ │ ├── last-accessed.hpp
│ │ ├── optional.hpp
│ │ ├── statistics-mutator.hpp
│ │ ├── timed-information.hpp
│ │ └── utility.hpp
│ ├── iterator-tags.hpp
│ ├── key-statistics.hpp
│ ├── lowercase.hpp
│ ├── lru.hpp
│ ├── statistics.hpp
│ ├── timed-cache.hpp
│ └── wrap.hpp
└── tests/
├── CMakeLists.txt
├── cache-test.cpp
├── callback-test.cpp
├── iterator-test.cpp
├── last-accessed-test.cpp
├── logbt.sh
├── move-aware-dummies.hpp
├── move-awareness-test.cpp
├── statistics-test.cpp
├── timed-cache-test.cpp
└── wrap-test.cpp
================================================
FILE CONTENTS
================================================
================================================
FILE: .clang-format
================================================
Language: Cpp
Standard: Cpp11
BasedOnStyle: Google
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortBlocksOnASingleLine: false
AllowShortCaseLabelsOnASingleLine: true
AllowShortFunctionsOnASingleLine: false
AllowShortIfStatementsOnASingleLine: true
AllowShortLoopsOnASingleLine: true
AlignOperands: true
AlignConsecutiveAssignments: false
BinPackArguments: false
BinPackParameters: false
BreakConstructorInitializersBeforeComma: true
ConstructorInitializerAllOnOneLineOrOnePerLine: true
ConstructorInitializerIndentWidth: 0
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DerivePointerAlignment: false
IndentCaseLabels: true
IndentWidth: 2
MaxEmptyLinesToKeep: 2
NamespaceIndentation: None
PointerAlignment: Left
SpacesBeforeTrailingComments: 2
TabWidth: 2
UseTab: Never
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 10
PenaltyBreakBeforeFirstCallParameter: 10
================================================
FILE: .gitignore
================================================
# Created by https://www.gitignore.io/api/c++,cmake
### C++ ###
# Prerequisites
*.d
# Compiled Object files
*.slo
*.lo
*.o
*.obj
# Precompiled Headers
*.gch
*.pch
# Compiled Dynamic libraries
*.so
*.dylib
*.dll
# Fortran module files
*.mod
*.smod
# Compiled Static libraries
*.lai
*.la
*.a
*.lib
# Executables
*.exe
*.out
*.app
### CMake ###
CMakeCache.txt
CMakeFiles
CMakeScripts
Makefile
cmake_install.cmake
install_manifest.txt
CTestTestfile.cmake
### Other ###
build/
*.dSYM/
docs/html/
docs/latex/
================================================
FILE: .gitmodules
================================================
[submodule "tests/googletest"]
path = tests/googletest
url = https://github.com/google/googletest
================================================
FILE: .travis.yml
================================================
# http://genbattle.bitbucket.org/blog/2016/01/17/c++-travis-ci/
# https://github.com/whoshuu/cpr/blob/master/.travis.yml
language: cpp
sudo: required
dist: trusty
matrix:
include:
- compiler: gcc
addons:
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-5
- gdb
env: COMPILER=g++-5
- compiler: clang
addons:
apt:
sources:
- ubuntu-toolchain-r-test
- llvm-toolchain-precise-3.7
packages:
- clang-3.7
- gdb
env: COMPILER=clang++-3.7
before_install:
# What is the current file size max for core files?
# It is usually 0, which means no core file will be dumped if there is a crash
- ulimit -c
- ulimit -a -S
- ulimit -a -H
- cat /proc/sys/kernel/core_pattern
install:
- CMAKE_VERSION_MM=3.2
- CMAKE_VERSION_FULL=$CMAKE_VERSION_MM.2
- if [ "$TRAVIS_OS_NAME" == "linux" ]; then
sudo apt-get update -qq
&& sudo apt-get install -qq qt5-qmake qtbase5-dev qtdeclarative5-dev
&& wget --no-check-certificate http://www.cmake.org/files/v${CMAKE_VERSION_MM}/cmake-${CMAKE_VERSION_FULL}-Linux-x86_64.sh
&& sudo sh cmake-${CMAKE_VERSION_FULL}-Linux-x86_64.sh --prefix=/usr/local --exclude-subdir;
fi
- if [ "$TRAVIS_OS_NAME" = "osx" ]; then
brew update
&& ((brew list -1 | grep -q "^$cmake\$") || brew install cmake)
&& (brew outdated cmake || brew upgrade cmake)
&& cmake --version;
fi
before_script:
- export CXX=$COMPILER
- cmake --version
- mkdir build
- cd build
- cmake -DCMAKE_CXX_COMPILER=$COMPILER ..
- cp ../tests/logbt.sh .
- sudo chmod a+x logbt.sh
- sudo bash -c "echo '/tmp/logbt-coredumps/core.%p.%E' > /proc/sys/kernel/core_pattern"
script:
- make VERBOSE=1 -j4
- ./logbt.sh bin/lru-cache-test
notifications:
email: false
================================================
FILE: CMakeLists.txt
================================================
###########################################################
## CMAKE SETUP
###########################################################
cmake_minimum_required(VERSION 3.2)
project(lru-cache)
add_compile_options(-g)
########################################
# C++ VERSIONING
########################################
include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-std=c++14" COMPILER_SUPPORTS_CXX_14)
check_cxx_compiler_flag("-std=c++1z" COMPILER_SUPPORTS_CXX_1z)
check_cxx_compiler_flag("-std=c++17" COMPILER_SUPPORTS_CXX_17)
if (COMPILER_SUPPORTS_CXX_1z)
message(STATUS "Compiling with C++1z")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++1z")
elseif (COMPILER_SUPPORTS_CXX_14)
message(STATUS "Compiling with C++14")
set(CMAKE_CXX_STANDARD 14)
else()
message(FATAL_ERROR "Please install a modern C++ compiler, they are not expensive.")
endif()
###########################################################
## DEPENDENCIES
###########################################################
set(CMAKE_MODULE_PATH
${CMAKE_MODULE_PATH}
"${CMAKE_SOURCE_DIR}/cmake/Modules/"
)
###########################################################
## INCLUDES
###########################################################
# Need this top-level include for "tests/"
include_directories(${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
###########################################################
## EXAMPLES
###########################################################
add_subdirectory(examples)
########################################
# TESTS
########################################
option(BUILD_LRU_CACHE_TESTS "Enable tests" ON)
if(BUILD_LRU_CACHE_TESTS)
message(STATUS "Enabling tests ...")
enable_testing()
add_subdirectory(tests)
else()
message(STATUS "Disabling tests ...")
endif()
================================================
FILE: LICENSE
================================================
The MIT License (MIT)
Copyright (c) 2016 Peter Goldsborough
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: README.md
================================================
# lru-cache
[](http://goldsborough.mit-license.org) [](https://travis-ci.org/goldsborough/lru-cache)
A feature complete LRU cache implementation in C++.
## Description
A *least recently used* (LRU) cache is a fixed size cache that behaves just like a regular lookup table, but remembers the order in which elements are accessed. Once its (user-defined) capacity is reached, it uses this information to replace the least recently used element with a newly inserted one. This is ideal for caching function return values, where fast lookup of complex computations is favorable, but a memory blowup from caching all `(input, output)` pairs is to be avoided.
We provide two implementations of an LRU cache: one has only the basic functionality described above, and another can be additionally supplied with a *time to live*. This is useful, for example, when caching resources on a server, where cache entries should be invalidated automatically after a certain amount of time, because they are no longer "fresh".
Additionally, all our caches can be connected to *statistics* objects, that keep track of cache hits and misses for all keys and, upon request, individual keys (similar to `functools.lru_cache` in Python). You can also register arbitrary callbacks for hits, misses or accesses in general.
## Basic Usage
The two main classes we provide are `LRU::Cache` and `LRU::TimedCache`. A basic usage example of these may look like so:
__`LRU::Cache`__
```C++
#include <iostream>
#include "lru/lru.hpp"
using Cache = LRU::Cache<int, int>;
int fibonacci(int n, Cache& cache) {
if (n < 2) return 1;
// We internally keep track of the last accessed key, meaning a
// `contains(key)` + `lookup(key)` sequence will involve only a single hash
// table lookup.
if (cache.contains(n)) return cache.lookup(n);
auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache);
// Caches are 100% move-aware and we have implemented
// `unordered_map` style emplacement and insertion.
cache.emplace(n, value);
return value;
}
int fibonacci(int n) {
// Use a capacity of 100 (after 100 insertions, the next insertion will evict
// the least-recently accessed element). The default capacity is 128.
Cache cache(100);
return fibonacci(n, cache);
}
```
__`LRU::TimedCache`__
```C++
#include <chrono>
#include <iostream>
#include "lru/lru.hpp"
using namespace std::chrono_literals;
using Cache = LRU::TimedCache<int, int>;
int fibonacci(int n, Cache& cache) {
if (n < 2) return 1;
if (cache.contains(n)) return cache[n];
auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache);
cache.emplace(n, value);
return value;
}
int fibonacci(int n) {
// Use a time to live of 100ms. This means that 100ms after insertion, a key
// will be said to have "expired" and `contains(key)` will return false.
Cache cache(100ms);
return fibonacci(n, cache);
}
auto main() -> int {
std::cout << fibonacci(32) << std::endl;
}
```
## Extended Usage
Our caches bring along many exciting features including statistics monitoring, function wrapping, arbitrary callbacks as well as ordered and unordered iteration.
### Ordered and Unordered Iteration
Both the `LRU::Cache` and `LRU::TimedCache` can be iterated over in two ways: ordered or unordered fashion (where the "order" refers to the order of insertion). The default iterators returned by `begin()`, `cbegin()`, `end()` etc. are *unordered* and mostly similar to `unordered_map` iterators (with some nice non-standard sugar):
```C++
LRU::Cache<int, int> cache = {{1, 2}, {2, 3}, {3, 4}};
int sum = 0;
for (const auto& pair : cache) {
sum += pair.first; // Standards compliant (good for templates)
sum += pair.value(); // But sugar on top (also key())
}
auto iterator = cache.begin(); // These two lines
auto iterator = cache.unordered_begin(); // are the same
auto iterator = cache.ordered_end(); // This is something different
```
Unordered iterators are implemented directly over internal map iterators and thus have access to the key and value of a pointed-to entry.
Ordered iterators respect the order of insertion. They differ in a few ways from unordered iterators:
1. They are bidirectional, while unordered iterators are forward iterators.
2. They provide fast access only to the `key()`. Accessing the value requires a hash table lookup the first time an iterator is dereferenced.
3. They can be constructed from unordered iterators! This means writing something like `typename LRU::Cache<int, int>::OrderedIterator i(unordered_iterator)` will work and is fast.
Dreferencing an iterator will not change the order of elements in the cache.
### Statistics
Our caches can be associated with statistics objects, that monitor hits and misses. There are a few ways to create and use them. First of all, let's say you only wanted to record hits and misses for all keys and didn't care about any particular key. The simplest way to do this is to simply call:
```cpp
cache.monitor();
```
This allows you to call `cache.stats()`, which returns an `LRU::Statistics` object. It's interface is quite clear, allowing you to write stuff like:
```cpp
cache.stats().total_hits(); // Hits for any key
cache.stats().total_misses(); // Misses for any key
cache.stats().hit_rate(); // Hit rate in [0, 1]
```
Note that a hit or miss only refers to lookup (i.e. methods `contains()`, `find()`, `lookup()` and `operator[]`) but not insertion via `emplace()` or `insert()`.
#### Sharing Statistics
Already here, one idea might be that we have two functions, each with their own cache, but we'd like them to share statistics. This is easy to do. Simply create the `Statistics` object as a `std::shared_ptr` and plug it into `cache.monitor()` for as many caches as you like:
```cpp
auto stats = std::make_shared<LRU::Statistics<std::string>>();
cache1.monitor(stats);
cache2.monitor(stats);
// Both affect the same statistics object
cache1.lookup("key");
cache2.lookup("foo");
assert(&cache1.stats() == &cache2.stats()); // Ok
std::shared_ptr<Statistics<std::string>> stats2 = cache1.shared_stats();
```
#### Monitoring specific keys
One of the more interesting features of our statistics API is the ability to monitor hits and misses for a specific set of keys. Say we were writing a web server accepting HTTP requests and wanted to cache resources (I assume that's something people would do). Because our website changes in some way every hour, we'll use a timed cache with a time-to-live of one hour. We're also particularly interested in how many cache hits we get for `index.html`. For this, it's good to know that the empty `monitor()` call we made further up is actually a method accepting variadic arguments to forward to the constructor of an internal statistics object (the empty `monitor()` calls the default constructor). One constructor of `Statistics` takes a number of keys to monitor in particular. So calling `monitor(key1, key2, ...)` will set up monitoring for those keys. We could then something like this:
```cpp
#include <string>
#include <chrono>
#include "lru/lru.hpp"
using namespace std::chrono_literals;
struct MyWebServer {
// We pass 1h to let the cache know that resources are to be invalidated after one hour.
MyWebServer() : cache(1h) {
cache.monitor("index.html");
}
std::string get(const std::string& resource_name) {
std::string resource;
if (cache.contains(resource_name)) {
resource = cache.lookup(resource_name);
} else {
resource = fetch_expensively(resource_name);
cache.insert(resource_name, resource);
}
return resource;
}
LRU::TimedCache<std::string, std::string> cache;
};
```
Later on, we can use methods like `hits_for("index.html")`, `misses_for("index.html")` or `stats_for("index.html")` on `cache.stats()` to find out how many hits or misses we got for our monitored resource. Note that `stats_for(key)` returns a lightweight `struct` holding hit and miss information about a particular key.
### Callbacks
Next to registering statistics, we also allow hook in arbitrary callbacks. The three kinds of callbacks that may be registered are:
1. Hit callbacks, taking a key and value after a cache hit (registered with `hit_callback()`).
2. Miss callbacks, taking only a key, that was not found in a cache (registered with `miss_callback()`).
3. Access callbacks, taking a key and a boolean indicating a hit or a miss (registered with `access_callback()`).
Usage could look something like this:
```cpp
LRU::Cache<int, int> cache;
cache.hit_callback([](const auto& key, const auto& value) {
std::clog << "Hit for entry ("
<< key << ", " << value << ")"
<< std::endl;
});
cache.miss_callback([](const auto& key) {
std::clog << "Miss for " << key<< std::endl;
});
// Roll your own statistics
std::size_t miss_count = 0;
cache.miss_callback([&miss_count](auto&) {
miss_count += 1;
});
cache.access_callback([](const auto& key, bool was_hit) {
std::clog << "Access for " << key
<< " was a " << (was_hit ? "hit" : "miss")
<< std::endl;
});
```
Note that just like with statistics, these callbacks will only get invoked for lookup and not insertion.
### Wrapping
We provide utility functions `LRU::wrap` and `LRU::timed_wrap` that take a function and return a new function, with a (timed) cache attached to it. Feels like Python. Just faster.
```cpp
#include "lru/lru.hpp"
int my_expensive_function(int, char, double) {
// ...
}
auto my_cached_expensive_function = LRU::wrap(my_expensive_function);
my_cached_expensive_function(1, 'a', 3.14);
```
Next to the function to wrap, `LRU::wrap` and `LRU::timed_wrap` take any number of arguments to forward to the constructor of the internal cache:
```cpp
// Use a capacity of 100
auto new_function = LRU::wrap(old_function, 1000);
// Use a time-to-live of 100 milliseconds
auto new_function = LRU::timed_wrap(old_function, 100ms);
```
Note that this will *not* cache recursive calls, since we cannot override the actual function symobl. As such we refer to this as "shallow memoization".
### Lowercase Names
Not everyone has the same taste. We get that. For this reason, for every public `CamelCase` type name, we've defined a `lower_case` (C++ standard style) alias. You can make these visible by including `lru/lowercase.hpp` instead of `lru/lru.hpp`:
```cpp
#include <chrono>
#include <iostream>
#include "lru/lowercase.hpp"
void print(lru::tag::basic_cache) {
std::cout << "basic cache" << '\n';
}
void print(lru::tag::timed_cache) {
std::cout << "timed cache" << '\n';
}
auto main() -> int {
using namespace std::chrono_literals;
lru::cache<int, int> cache;
lru::timed_cache<int, int> timed_cache(100ms);
print(cache.tag());
print(timed_cache.tag());
lru::cache<int, int>::ordered_const_iterator iterator(cache.begin());
lru::statistics<int> stats;
}
```
## Documentation
We have 100% public and private documentation coverage with a decent effort behind it. As such we ask you to RTFM to see the full interface we provide (it is a superset of `std::unordered_map`, minus the new node interface). Documentation can be generated with [Doxygen](http://www.stack.nl/~dimitri/doxygen/) by running the `doxygen` command inside the `docs/` folder.
Also do check out all the examples in the `examples/` folder!
## LICENSE
This project is released under the [MIT License](http://goldsborough.mit-license.org). For more information, see the LICENSE file.
## Authors
[Peter Goldsborough](http://goldsborough.me) + [cat](https://goo.gl/IpUmJn) :heart:
Thanks to [@engelmarkus](https://github.com/engelmarkus) for technical and emotional support.
================================================
FILE: cpplint.cfg
================================================
# cpplint configuration
filter=-build/c++11,-whitespace/parens,-runtime/references,-whitespace/operators
================================================
FILE: docs/Doxyfile
================================================
# Doxyfile 1.8.6
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "LRU Cache"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 0.1
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = A feature-complete LRU cache implementation.
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY =
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF =
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = YES
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
# new page for each member. If set to NO, the documentation of a member will be
# part of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 2
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES = "complexity=\par Complexity\n"
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by by putting a % sign in front of the word
# or globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = YES
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = YES
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = YES
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO these classes will be included in the various overviews. This option has
# no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO these declarations will be
# included in the documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = YES
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
# todo list. This list is created by putting \todo commands in the
# documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
# test list. This list is created by putting \test commands in the
# documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES the list
# will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. Do not use file names with spaces, bibtex cannot handle them. See
# also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO doxygen will only warn about wrong or incomplete parameter
# documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT = ../include ../README.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank the
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS =
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER ) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
# defined cascading style sheet that is included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefor more robust against future updates.
# Doxygen will copy the style sheet file to the output directory. For an example
# see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the stylesheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler ( hhc.exe). If non-empty
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated (
# YES) or that it should be included in the master .chm file ( NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated (
# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = YES
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.d
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = pdflatex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = tableofcontents
# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = YES
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. To get the times font for
# instance you can specify
# EXTRA_PACKAGES=times
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
# replace them by respectively the title of the page, the current date and time,
# only the current date, the version number of doxygen, the project name (see
# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
# file, i.e. a series of assignments. You only have to provide replacements,
# missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
# Definitions (see http://autogen.sf.net) file that captures the structure of
# the code including all documentation. Note that this feature is still
# experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
# in the source code. If set to NO only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES the includes files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
# class index. If set to NO only the inherited external classes will be listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
# the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES, the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font n the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot.
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif and svg.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
================================================
FILE: examples/CMakeLists.txt
================================================
###########################################################
## BINARIES
###########################################################
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin/examples)
########################################
# TARGETS
########################################
add_executable(fibonacci-basic fibonacci-basic.cpp)
add_executable(fibonacci-timed fibonacci-timed.cpp)
add_executable(statistics statistics.cpp)
add_executable(callbacks callbacks.cpp)
add_executable(lowercase lowercase.cpp)
add_executable(wrap wrap.cpp)
================================================
FILE: examples/callbacks.cpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#include <iostream>
#include "lru/lru.hpp"
using Cache = LRU::Cache<std::uint64_t, std::uint64_t>;
std::uint64_t fibonacci(std::uint64_t n, Cache& cache) {
if (n < 2) return 1;
// We std::uint64_ternally keep track of the last accessed key, meaning a
// `contains(key)` + `lookup(key)` sequence will involve only a single hash
// table lookup.
if (cache.contains(n)) return cache[n];
auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache);
// Caches are 100% move-aware and we have implemented
// `unordered_map` style emplacement and insertion.
cache.emplace(n, value);
return value;
}
std::uint64_t fibonacci(std::uint64_t n) {
// Use a capacity of 100 (after 100 insertions, the next insertion will evict
// the least-recently inserted element). The default capacity is 128. Note
// that for fibonacci, a capacity of 2 is sufficient (and ideal).
Cache cache(100);
// clang-format off
cache.hit_callback([](auto& key, auto& value) {
std::clog << "Hit for entry ("
<< key << ", " << value << ")"
<< std::endl;
});
cache.miss_callback([](auto& key) {
std::clog << "Miss for " << key<< std::endl;
});
cache.access_callback([](auto& key, bool was_hit) {
std::clog << "Access for " << key
<< " was a " << (was_hit ? "hit" : "miss")
<< std::endl;
});
// clang-format on
auto value = fibonacci(n, cache);
return value;
}
auto main() -> int {
std::cout << fibonacci(10) << std::endl;
}
================================================
FILE: examples/fibonacci-basic.cpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#include <iostream>
#include "lru/lru.hpp"
using Cache = LRU::Cache<int, int>;
int fibonacci(int n, Cache& cache) {
if (n < 2) return 1;
// We internally keep track of the last accessed key, meaning a
// `contains(key)` + `lookup(key)` sequence will involve only a single hash
// table lookup.
if (cache.contains(n)) return cache[n];
auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache);
// Caches are 100% move-aware and we have implemented
// `unordered_map` style emplacement and insertion.
cache.emplace(n, value);
return value;
}
int fibonacci(int n) {
// Use a capacity of 100 (after 100 insertions, the next insertion will evict
// the least-recently accessed element). The default capacity is 128. Note
// that for fibonacci, a capacity of 2 is sufficient (and ideal).
Cache cache(100);
return fibonacci(n, cache);
}
auto main() -> int {
std::cout << fibonacci(32) << std::endl;
}
================================================
FILE: examples/fibonacci-timed.cpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#include <chrono>
#include <iostream>
#include "lru/lru.hpp"
using namespace std::chrono_literals;
using Cache = LRU::TimedCache<int, int>;
int fibonacci(int n, Cache& cache) {
if (n < 2) return 1;
// We internally keep track of the last accessed key, meaning a
// `contains(key)` + `lookup(key)` sequence will involve only a single hash
// table lookup.
if (cache.contains(n)) return cache[n];
auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache);
// Caches are 100% move-aware and we have implemented
// `unordered_map` style emplacement and insertion.
cache.emplace(n, value);
return value;
}
int fibonacci(int n) {
// Use a time to live of 100ms. This means that 100ms after insertion, a key
// will be said to have "expired" and `contains(key)` will return false.
Cache cache(100ms);
return fibonacci(n, cache);
}
auto main() -> int {
std::cout << fibonacci(32) << std::endl;
}
================================================
FILE: examples/lowercase.cpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#include <chrono>
#include <iostream>
#include "lru/lowercase.hpp"
void print(lru::tag::basic_cache) {
std::cout << "basic cache" << '\n';
}
void print(lru::tag::timed_cache) {
std::cout << "timed cache" << '\n';
}
auto main() -> int {
using namespace std::chrono_literals;
lru::cache<int, int> cache;
lru::timed_cache<int, int> timed_cache(100ms);
print(cache.tag());
print(timed_cache.tag());
lru::cache<int, int>::ordered_const_iterator iterator(cache.begin());
lru::statistics<int> stats;
}
================================================
FILE: examples/statistics.cpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#include <iostream>
#include "lru/lru.hpp"
using Cache = LRU::Cache<std::uint64_t, std::uint64_t>;
std::uint64_t fibonacci(std::uint64_t n, Cache& cache) {
if (n < 2) return 1;
// We std::uint64_ternally keep track of the last accessed key, meaning a
// `contains(key)` + `lookup(key)` sequence will involve only a single hash
// table lookup.
if (cache.contains(n)) return cache[n];
auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache);
// Caches are 100% move-aware and we have implemented
// `unordered_map` style emplacement and insertion.
cache.emplace(n, value);
return value;
}
std::uint64_t fibonacci(std::uint64_t n) {
// Use a capacity of 100 (after 100 insertions, the next insertion will evict
// the least-recently inserted element). The default capacity is 128. Note
// that for fibonacci, a capacity of 2 is sufficient (and ideal).
Cache cache(100);
cache.monitor(2, 3, 4, 5);
auto value = fibonacci(n, cache);
for (auto i : {2, 3, 4, 5}) {
auto stats = cache.stats().stats_for(i);
// clang-format off
std::cout << "Statistics for " << i << ": "
<< stats.hits << " hit(s), "
<< stats.misses << " miss(es)."
<< std::endl;
}
// You'll notice we'll always have n - 1 misses, for each time we access
// one of the numbers in [0, n] for the first time.
std::cout << "Overall: "
<< cache.stats().total_hits() << " hit(s), "
<< cache.stats().total_misses() << " miss(es)."
<< std::endl;
// clang-format on
return value;
}
auto main() -> int {
// The last number that fits into a 64 bit unsigned number
std::cout << fibonacci(92) << std::endl;
}
================================================
FILE: examples/wrap.cpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#include <chrono>
#include <iostream>
#include <thread>
#include "lru/lru.hpp"
using namespace std::chrono_literals;
int f(int x) {
std::this_thread::sleep_for(1s);
return x;
}
auto main() -> int {
// Use a time-to-live of 2 minutes and a
// capacity of 128 for an LRU::TimedCache
auto wrapped = LRU::timed_wrap(f, 2min, 128);
std::cout << "Slow the first time ..." << '\n';
wrapped(42);
std::cout << "Fast the second time!" << '\n';
wrapped(42);
}
================================================
FILE: include/lru/cache-tags.hpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#ifndef LRU_CACHE_TAGS_HPP
#define LRU_CACHE_TAGS_HPP
namespace LRU {
namespace Tag {
struct BasicCache {};
struct TimedCache {};
} // namespace Tag
namespace Lowercase {
namespace tag {
using basic_cache = ::LRU::Tag::BasicCache;
using timed_cache = ::LRU::Tag::TimedCache;
} // namespace tag
} // namespace Lowercase
} // namespace LRU
#endif // LRU_CACHE_TAGS_HPP
================================================
FILE: include/lru/cache.hpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#ifndef LRU_CACHE_HPP
#define LRU_CACHE_HPP
#include <cassert>
#include <chrono>
#include <cstddef>
#include <functional>
#include <iterator>
#include <list>
#include <stdexcept>
#include <unordered_map>
#include <lru/cache-tags.hpp>
#include <lru/error.hpp>
#include <lru/internal/base-cache.hpp>
#include <lru/internal/information.hpp>
#include <lru/internal/last-accessed.hpp>
namespace LRU {
namespace Internal {
template <typename Key,
typename Value,
typename HashFunction,
typename KeyEqual>
using UntimedCacheBase = Internal::BaseCache<Key,
Value,
Internal::Information,
HashFunction,
KeyEqual,
Tag::BasicCache>;
} // namespace Internal
/// A basic LRU cache implementation.
///
/// An LRU cache is a fixed-size cache that remembers the order in which
/// elements were inserted into it. When the size of the cache exceeds its
/// capacity, the "least-recently-used" (LRU) element is erased. In our
/// implementation, usage is defined as insertion, but not lookup. That is,
/// looking up an element does not move it to the "front" of the cache (making
/// the operation faster). Only insertions (and erasures) can change the order
/// of elements. The capacity of the cache can be modified at any time.
///
/// \see LRU::TimedCache
template <typename Key,
typename Value,
typename HashFunction = std::hash<Key>,
typename KeyEqual = std::equal_to<Key>>
class Cache
: public Internal::UntimedCacheBase<Key, Value, HashFunction, KeyEqual> {
private:
using super = Internal::UntimedCacheBase<Key, Value, HashFunction, KeyEqual>;
using PRIVATE_BASE_CACHE_MEMBERS;
public:
using PUBLIC_BASE_CACHE_MEMBERS;
using typename super::size_t;
/// \copydoc BaseCache::BaseCache(size_t,const HashFunction&,const KeyEqual&)
/// \detailss The capacity defaults to an internal constant, currently 128.
explicit Cache(size_t capacity = Internal::DEFAULT_CAPACITY,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual())
: super(capacity, hash, equal) {
}
/// \copydoc BaseCache(size_t,Iterator,Iterator,const HashFunction&,const
/// KeyEqual&)
template <typename Iterator>
Cache(size_t capacity,
Iterator begin,
Iterator end,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual())
: super(capacity, begin, end, hash, equal) {
}
/// \copydoc BaseCache(Iterator,Iterator,const HashFunction&,const
/// KeyEqual&)
template <typename Iterator>
Cache(Iterator begin,
Iterator end,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual())
: super(begin, end, hash, equal) {
}
/// Constructor.
///
/// \param capacity The capacity of the cache.
/// \param range A range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Range, typename = Internal::enable_if_range<Range>>
Cache(size_t capacity,
Range&& range,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual())
: super(capacity, std::forward<Range>(range), hash, equal) {
}
/// Constructor.
///
/// \param range A range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Range, typename = Internal::enable_if_range<Range>>
explicit Cache(Range&& range,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual())
: super(std::forward<Range>(range), hash, equal) {
}
/// \copydoc BaseCache(InitializerList,const HashFunction&,const
/// KeyEqual&)
Cache(InitializerList list,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual()) // NOLINT(runtime/explicit)
: super(list, hash, equal) {
}
/// \copydoc BaseCache(size_t,InitializerList,const HashFunction&,const
/// KeyEqual&)
Cache(size_t capacity,
InitializerList list,
const HashFunction& hash = HashFunction(),
const KeyEqual& equal = KeyEqual()) // NOLINT(runtime/explicit)
: super(capacity, list, hash, equal) {
}
/// \copydoc BaseCache::find(const Key&)
UnorderedIterator find(const Key& key) override {
auto iterator = _map.find(key);
if (iterator != _map.end()) {
_register_hit(key, iterator->second.value);
_move_to_front(iterator->second.order);
_last_accessed = iterator;
} else {
_register_miss(key);
}
return {*this, iterator};
}
/// \copydoc BaseCache::find(const Key&) const
UnorderedConstIterator find(const Key& key) const override {
auto iterator = _map.find(key);
if (iterator != _map.end()) {
_register_hit(key, iterator->second.value);
_move_to_front(iterator->second.order);
_last_accessed = iterator;
} else {
_register_miss(key);
}
return {*this, iterator};
}
/// \returns The most-recently inserted element.
const Key& front() const noexcept {
if (is_empty()) {
throw LRU::Error::EmptyCache("front");
} else {
// The queue is reversed for natural order of iteration.
return _order.back();
}
}
/// \returns The least-recently inserted element.
const Key& back() const noexcept {
if (is_empty()) {
throw LRU::Error::EmptyCache("back");
} else {
// The queue is reversed for natural order of iteration.
return _order.front();
}
}
};
namespace Lowercase {
template <typename... Ts>
using cache = Cache<Ts...>;
} // namespace Lowercase
} // namespace LRU
#endif // LRU_CACHE_HPP
================================================
FILE: include/lru/entry.hpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#ifndef LRU_PAIR_HPP
#define LRU_PAIR_HPP
#include <algorithm>
#include <type_traits>
#include <utility>
namespace LRU {
/// A entry of references to the key and value of an entry in a cache.
///
/// Instances of this class are usually the result of dereferencing an iterator.
///
/// \tparam Key The key type of the pair.
/// \tparam Value The value type of the pair.
template <typename Key, typename Value>
struct Entry final {
using KeyType = Key;
using ValueType = Value;
using first_type = Key;
using second_type = Value;
/// Constructor.
///
/// \param key The key of the entry.
/// \param value The value of the entry.
Entry(const Key& key, Value& value) : first(key), second(value) {
}
/// Generalized copy constructor.
///
/// Mainly for conversion from non-const values to const values.
///
/// \param other The entry to construct from.
template <typename AnyKey,
typename AnyValue,
typename =
std::enable_if_t<(std::is_convertible<AnyKey, Key>::value &&
std::is_convertible<AnyValue, Value>::value)>>
Entry(const Entry<AnyKey, AnyValue>& other)
: first(other.first), second(other.second) {
}
/// Compares two entrys for equality.
///
/// \param first The first entry to compare.
/// \param second The second entry to compare.
/// \returns True if the firest entry equals the second, else false.
template <typename Pair, typename = typename Pair::first_type>
friend bool operator==(const Entry& first, const Pair& second) noexcept {
return first.first == second.first && first.second == second.second;
}
/// Compares two entrys for equality.
///
/// \param first The first entry to compare.
/// \param second The second entry to compare.
/// \returns True if the first entry equals the second, else false.
template <typename Pair, typename = typename Pair::first_type>
friend bool operator==(const Pair& first, const Entry& second) noexcept {
return second == first;
}
/// Compares two entrys for inequality.
///
/// \param first The first entry to compare.
/// \param second The second entry to compare.
/// \returns True if the first entry does not equal the second, else false.
template <typename Pair, typename = typename Pair::first_type>
friend bool operator!=(const Entry& first, const Pair& second) noexcept {
return !(first == second);
}
/// Compares two entrys for inequality.
///
/// \param first The first entry to compare.
/// \param second The second entry to compare.fdas
/// \returns True if the first entry does not equal the second, else false.
template <typename Pair, typename = typename Pair::first_type>
friend bool operator!=(const Pair& first, const Entry& second) noexcept {
return second != first;
}
/// \returns A `std::pair` instance with the key and value of this entry.
operator std::pair<const Key&, Value&>() noexcept {
return {first, second};
}
/// \returns The key of the entry (`first`).
const Key& key() const noexcept {
return first;
}
/// \returns The value of the entry (`second`).
Value& value() noexcept {
return second;
}
/// \returns The value of the entry (`second`).
const Value& value() const noexcept {
return second;
}
/// The key of the entry.
const Key& first;
/// The value of the entry.
Value& second;
};
} // namespace LRU
#endif // LRU_PAIR_HPP
================================================
FILE: include/lru/error.hpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#ifndef LRU_INTERNAL_ERRORS_HPP
#define LRU_INTERNAL_ERRORS_HPP
#include <stdexcept>
#include <string>
namespace LRU {
namespace Error {
/// Exception thrown when the value of an invalid key was requested.
struct KeyNotFound : public std::runtime_error {
using super = std::runtime_error;
KeyNotFound() : super("Failed to find key") {
}
explicit KeyNotFound(const std::string& key)
: super("Failed to find key: " + key) {
}
};
/// Exception thrown when the value of an expired key was requested.
struct KeyExpired : public std::runtime_error {
using super = std::runtime_error;
explicit KeyExpired(const std::string& key)
: super("Key found, but expired: " + key) {
}
KeyExpired() : super("Key found, but expired") {
}
};
/// Exception thrown when requesting the front or end key of an empty cache.
struct EmptyCache : public std::runtime_error {
using super = std::runtime_error;
explicit EmptyCache(const std::string& what_was_expected)
: super("Requested " + what_was_expected + " of empty cache") {
}
};
/// Exception thrown when attempting to convert an invalid unordered iterator to
/// an ordered iterator.
struct InvalidIteratorConversion : public std::runtime_error {
using super = std::runtime_error;
InvalidIteratorConversion()
: super("Cannot convert past-the-end unordered to ordered iterator") {
}
};
/// Exception thrown when attempting to erase the past-the-end iterator.
struct InvalidIterator : public std::runtime_error {
using super = std::runtime_error;
InvalidIterator() : super("Past-the-end iterator is invalid here") {
}
};
/// Exception thrown when requesting statistics about an unmonitored key.
struct UnmonitoredKey : public std::runtime_error {
using super = std::runtime_error;
UnmonitoredKey() : super("Requested statistics for unmonitored key") {
}
};
/// Exception thrown when requesting the statistics object of a cache when none
/// was registered.
struct NotMonitoring : public std::runtime_error {
using super = std::runtime_error;
NotMonitoring() : super("Statistics monitoring not enabled for this cache") {
}
};
namespace Lowercase {
using key_not_found = KeyNotFound;
using key_expired = KeyExpired;
using empty_cache = EmptyCache;
using invalid_iterator_conversion = InvalidIteratorConversion;
using invalid_iterator = InvalidIterator;
using unmonitored_key = UnmonitoredKey;
using not_monitoring = NotMonitoring;
} // namespace Lowercase
} // namespace Error
} // namespace LRU
#endif // LRU_INTERNAL_ERRORS_HPP
================================================
FILE: include/lru/insertion-result.hpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#ifndef LRU_INSERTION_RESULT_HPP
#define LRU_INSERTION_RESULT_HPP
#include <algorithm>
#include <type_traits>
#include <utility>
namespace LRU {
/// The result of an insertion into a cache.
///
/// This is a semantically nicer alternative to a generic `std::pair`, as is
/// returned by `std::unordered_map` or so. It still has the same static
/// interface as the `std::pair` (with `first` and `second` members), but adds
/// nicer `was_inserted()` and `iterator()` accessors.
///
/// \tparam Iterator The class of the iterator contained in the result.
template <typename Iterator>
struct InsertionResult final {
using IteratorType = Iterator;
/// Constructor.
///
/// \param result Whether the result was successful.
/// \param iterator The iterator pointing to the inserted or updated key.
InsertionResult(bool result, Iterator iterator)
: first(result), second(iterator) {
}
/// \returns True if the key was newly inserted, false if it was only updated.
bool was_inserted() const noexcept {
return first;
}
/// \returns The iterator pointing to the inserted or updated key.
Iterator iterator() const noexcept {
return second;
}
/// \copydoc was_inserted
explicit operator bool() const noexcept {
return was_inserted();
}
/// Whether the result was successful.
bool first;
/// The iterator pointing to the inserted or updated key.
Iterator second;
};
} // namespace LRU
#endif // LRU_INSERTION_RESULT_HPP
================================================
FILE: include/lru/internal/base-cache.hpp
================================================
/// The MIT License (MIT)
/// Copyright (c) 2016 Peter Goldsborough
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to
/// deal in the Software without restriction, including without limitation the
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
/// sell copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
/// IN THE SOFTWARE.
#ifndef LRU_INTERNAL_BASE_CACHE_HPP
#define LRU_INTERNAL_BASE_CACHE_HPP
#include <algorithm>
#include <cmath>
#include <cstddef>
#include <initializer_list>
#include <iterator>
#include <list>
#include <memory>
#include <tuple>
#include <unordered_map>
#include <utility>
#include <lru/insertion-result.hpp>
#include <lru/internal/base-ordered-iterator.hpp>
#include <lru/internal/base-unordered-iterator.hpp>
#include <lru/internal/callback-manager.hpp>
#include <lru/internal/definitions.hpp>
#include <lru/internal/last-accessed.hpp>
#include <lru/internal/optional.hpp>
#include <lru/internal/statistics-mutator.hpp>
#include <lru/internal/utility.hpp>
#include <lru/statistics.hpp>
namespace LRU {
namespace Internal {
// Macros are bad, but also more readable sometimes:
// Without this macro, it becomes a pain to have a `using` directive for every
// new member we add to the `BaseCache` and rename or remove every such
// directive when we make a change to the `BaseCache`.
// With this macro, you can simply do:
// using super = BaseCache<Key, Value, Information>;
// using BASE_CACHE_MEMBERS;
#define PUBLIC_BASE_CACHE_MEMBERS \
super::is_full; \
using super::is_empty; \
using super::clear; \
using super::end; \
using super::cend; \
using super::operator=; \
using typename super::Information; \
using typename super::UnorderedIterator; \
using typename super::UnorderedConstIterator; \
using typename super::OrderedIterator; \
using typename super::OrderedConstIterator; \
using typename super::InitializerList;
#define PRIVATE_BASE_CACHE_MEMBERS \
super::_map; \
using typename super::Map; \
using typename super::MapIterator; \
using typename super::MapConstIterator; \
using typename super::Queue; \
using typename super::QueueIterator; \
using super::_order; \
using super::_last_accessed; \
using super::_capacity; \
using super::_erase; \
using super::_erase_lru; \
using super::_move_to_front; \
using super::_value_from_result; \
using super::_last_accessed_is_ok; \
using super::_register_miss; \
using super::_register_hit;
/// The base class for the LRU::Cache and LRU::TimedCache.
///
/// This base class (base as opposed to abstract, because it is not intended to
/// be used polymorphically) provides the great bulk of the implementation of
/// both the LRU::Cache and the timed version. For example, it builds the
/// `contains()`, `lookup()` and `operator[]()` functions on top of the pure
/// virtual `find()` methods, making the final implementation of the LRU::Cache
/// much less strenuous.
///
/// This class also defines all concrete iterator classes and provides the main
/// iterator interface of all caches via ordered and unordered iterators and
/// appropriate `begin()`, `end()` and similar methods.
///
/// Lastly, the `BaseCache` provides a statistics interface to register and
/// access shared or owned statistics.
///
/// \tparam Key The key type of the cache.
/// \tparam Value The value type of the cache.
/// \tparam InformationType The internal information class to be used.
/// \tparam HashFunction The hash function type for the internal map.
/// \tparam KeyEqual The type of the key equality function for the internal map.
/// \tparam TagType The cache tag type of the concrete derived class.
template <typename Key,
typename Value,
template <typename, typename> class InformationType,
typename HashFunction,
typename KeyEqual,
typename TagType>
class BaseCache {
protected:
using Information = InformationType<Key, Value>;
using Queue = Internal::Queue<const Key>;
using QueueIterator = typename Queue::const_iterator;
using Map = Internal::Map<Key, Information, HashFunction, KeyEqual>;
using MapIterator = typename Map::iterator;
using MapConstIterator = typename Map::const_iterator;
using CallbackManagerType = CallbackManager<Key, Value>;
using HitCallback = typename CallbackManagerType::HitCallback;
using MissCallback = typename CallbackManagerType::MissCallback;
using AccessCallback = typename CallbackManagerType::AccessCallback;
using HitCallbackContainer =
typename CallbackManagerType::HitCallbackContainer;
using MissCallbackContainer =
typename CallbackManagerType::MissCallbackContainer;
using AccessCallbackContainer =
typename CallbackManagerType::AccessCallbackContainer;
public:
using Tag = TagType;
using InitializerList = std::initializer_list<std::pair<Key, Value>>;
using StatisticsPointer = std::shared_ptr<Statistics<Key>>;
using size_t = std::size_t;
static constexpr Tag tag() noexcept {
return {};
}
/////////////////////////////////////////////////////////////////////////////
// ITERATORS CLASSES
/////////////////////////////////////////////////////////////////////////////
/// A non-const unordered iterator.
///
/// Unordered iterators provide faster lookup than ordered iterators because
/// they have direct access to the underlying map. Also, they can convert to
/// ordered iterators cheaply.
struct UnorderedIterator
: public BaseUnorderedIterator<BaseCache, MapIterator> {
using super = BaseUnorderedIterator<BaseCache, MapIterator>;
friend BaseCache;
/// Default constructor.
UnorderedIterator() = default;
/// Constructs a new UnorderedIterator from an unordered base iterator.
///
/// \param iterator The iterator to initialize this one from.
UnorderedIterator(BaseUnorderedIterator<BaseCache, MapIterator>
iterator) // NOLINT(runtime/explicit)
: super(std::move(iterator)) {
// Note that this only works because these derived iterator
// classes dont' have any members of their own.
// It is necessary because the increment operators return base iterators.
}
/// Constructs a new UnorderedIterator.
///
/// \param cache The cache this iterator references.
/// \param iterator The underlying map iterator.
UnorderedIterator(BaseCache& cache,
MapIterator iterator) // NOLINT(runtime/explicit)
: super(cache, iterator) {
}
};
/// A const unordered iterator.
///
/// Unordered iterators provide faster lookup than ordered iterators because
/// they have direct access to the underlying map. Also, they can convert to
/// ordered iterators cheaply.
struct UnorderedConstIterator
: public BaseUnorderedIterator<const BaseCache, MapConstIterator> {
using super = BaseUnorderedIterator<const BaseCache, MapConstIterator>;
friend BaseCache;
/// Default constructor.
UnorderedConstIterator() = default;
/// Constructs a new UnorderedConstIterator from any unordered base
/// iterator.
///
/// \param iterator The iterator to initialize this one from.
template <typename AnyCache, typename AnyUnderlyingIterator>
UnorderedConstIterator(
BaseUnorderedIterator<AnyCache, AnyUnderlyingIterator> iterator)
: super(std::move(iterator)) {
// Note that this only works because these derived iterator
// classes dont' have any members of their own.
}
/// Constructs a new UnorderedConstIterator from a non-const iterator.
///
/// \param iterator The non-const iterator to initialize this one from.
UnorderedConstIterator(
UnorderedIterator iterator) // NOLINT(runtime/explicit)
: super(std::move(iterator)) {
}
/// Constructs a new UnorderedConstIterator.
///
/// \param cache The cache this iterator references.
/// \param iterator The underlying map iterator.
UnorderedConstIterator(
const BaseCache& cache,
MapConstIterator iterator) // NOLINT(runtime/explicit)
: super(cache, iterator) {
}
};
/// An ordered iterator.
///
/// Ordered iterators have a performance disadvantage compared to unordered
/// iterators the first time they are dereferenced. However, they may be
/// constructed or assigned from unordered iterators (of compatible
/// qualifiers).
struct OrderedIterator
: public BaseOrderedIterator<const Key, Value, BaseCache> {
using super = BaseOrderedIterator<const Key, Value, BaseCache>;
using UnderlyingIterator = typename super::UnderlyingIterator;
friend BaseCache;
/// Default constructor.
OrderedIterator() = default;
/// Constructs an ordered iterator from an unordered iterator.
///
/// \param unordered_iterator The unordered iterator to construct from.
explicit OrderedIterator(UnorderedIterator unordered_iterator)
: super(std::move(unordered_iterator)) {
}
/// Constructs a new OrderedIterator from an unordered base iterator.
///
/// \param iterator The iterator to initialize this one from.
OrderedIterator(BaseOrderedIterator<Key, Value, BaseCache>
iterator) // NOLINT(runtime/explicit)
: super(std::move(iterator)) {
// Note that this only works because these derived iterator
// classes dont' have any members of their own.
// It is necessary because the increment operators return base iterators.
}
/// Constructs a new ordered iterator.
///
/// \param cache The cache this iterator references.
/// \param iterator The underlying iterator.
OrderedIterator(BaseCache& cache, UnderlyingIterator iterator)
: super(cache, iterator) {
}
};
/// A const ordered iterator.
///
/// Ordered iterators have a performance disadvantage compared to unordered
/// iterators the first time they are dereferenced. However, they may be
/// constructed or assigned from unordered iterators (of compatible
/// qualifiers).
struct OrderedConstIterator
: public BaseOrderedIterator<const Key, const Value, const BaseCache> {
using super = BaseOrderedIterator<const Key, const Value, const BaseCache>;
using UnderlyingIterator = typename super::UnderlyingIterator;
friend BaseCache;
/// Default constructor.
OrderedConstIterator() = default;
/// Constructs a new OrderedConstIterator from a compatible ordered
/// iterator.
///
/// \param iterator The iterator to initialize this one from.
template <typename AnyKey, typename AnyValue, typename AnyCache>
OrderedConstIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCache>
iterator) // NOLINT(runtime/explicit)
: super(iterator) {
// Note that this only works because these derived iterator
// classes dont' have any members of their own.
}
/// Constructs a new const ordered iterator from a non-const one.
///
/// \param iterator The non-const ordered iterator to construct from.
OrderedConstIterator(OrderedIterator iterator) // NOLINT(runtime/explicit)
: super(std::move(iterator)) {
}
/// Constructs a new const ordered iterator from an unordered iterator.
///
/// \param unordered_iterator The unordered iterator to construct from.
explicit OrderedConstIterator(UnorderedIterator unordered_iterator)
: super(std::move(unordered_iterator)) {
}
/// Constructs a new const ordered iterator from a const unordered iterator.
///
/// \param unordered_iterator The unordered iterator to construct from.
explicit OrderedConstIterator(
UnorderedConstIterator unordered_iterator) // NOLINT(runtime/explicit)
: super(std::move(unordered_iterator)) {
}
/// Constructs a new const ordered iterator.
///
/// \param cache The cache this iterator references.
/// \param iterator The underlying iterator.
OrderedConstIterator(const BaseCache& cache, UnderlyingIterator iterator)
: super(cache, iterator) {
}
};
using InsertionResultType = InsertionResult<UnorderedIterator>;
// Can't put these in LRU::Lowercase because they are nested, unfortunately
using ordered_iterator = OrderedIterator;
using ordered_const_iterator = OrderedConstIterator;
using unordered_iterator = UnorderedIterator;
using unordered_const_iterator = UnorderedConstIterator;
/////////////////////////////////////////////////////////////////////////////
// SPECIAL MEMBER FUNCTIONS
/////////////////////////////////////////////////////////////////////////////
/// Constructor.
///
/// \param capacity The capacity of the cache.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
BaseCache(size_t capacity,
const HashFunction& hash,
const KeyEqual& key_equal)
: _map(0, hash, key_equal), _capacity(capacity), _last_accessed(key_equal) {
}
/// Constructor.
///
/// \param capacity The capacity of the cache.
/// \param begin The start of a range to construct the cache with.
/// \param end The end of a range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Iterator>
BaseCache(size_t capacity,
Iterator begin,
Iterator end,
const HashFunction& hash,
const KeyEqual& key_equal)
: BaseCache(capacity, hash, key_equal) {
insert(begin, end);
}
/// Constructor.
///
/// The capacity is inferred from the distance between the two iterators and
/// lower-bounded by an internal constant $c_0$, usually 128 (i.e. the actual
/// capacity will be $\max(\text{distance}, c_0)$).
/// This may be expensive for iterators that are not random-access.
///
/// \param begin The start of a range to construct the cache with.
/// \param end The end of a range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Iterator>
BaseCache(Iterator begin,
Iterator end,
const HashFunction& hash,
const KeyEqual& key_equal)
// This may be expensive
: BaseCache(std::max<size_t>(std::distance(begin, end),
Internal::DEFAULT_CAPACITY),
begin,
end,
hash,
key_equal) {
}
/// Constructor.
///
/// \param capacity The capacity of the cache.
/// \param range A range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Range, typename = Internal::enable_if_range<Range>>
BaseCache(size_t capacity,
Range& range,
const HashFunction& hash,
const KeyEqual& key_equal)
: BaseCache(capacity, hash, key_equal) {
insert(range);
}
/// Constructor.
///
/// The capacity is inferred from the distance between the beginning and end
/// of the range. This may be expensive for iterators that are not
/// random-access.
///
/// \param range A range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Range, typename = Internal::enable_if_range<Range>>
explicit BaseCache(Range& range,
const HashFunction& hash,
const KeyEqual& key_equal)
: BaseCache(std::begin(range), std::end(range), hash, key_equal) {
}
/// Constructor.
///
/// Elements of the range will be moved into the cache.
///
/// \param capacity The capacity of the cache.
/// \param range A range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Range, typename = Internal::enable_if_range<Range>>
BaseCache(size_t capacity,
Range&& range,
const HashFunction& hash,
const KeyEqual& key_equal)
: BaseCache(capacity, hash, key_equal) {
insert(std::move(range));
}
/// Constructor.
///
/// The capacity is inferred from the distance between the beginning and end
/// of the range. This may be expensive for iterators that are not
/// random-access.
///
/// Elements of the range will be moved into the cache.
///
/// \param range A range to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
template <typename Range, typename = Internal::enable_if_range<Range>>
explicit BaseCache(Range&& range,
const HashFunction& hash,
const KeyEqual& key_equal)
: BaseCache(std::distance(std::begin(range), std::end(range)),
std::move(range),
hash,
key_equal) {
}
/// Constructor.
///
/// \param capacity The capacity of the cache.
/// \param list The initializer list to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
BaseCache(size_t capacity,
InitializerList list,
const HashFunction& hash,
const KeyEqual& key_equal)
: BaseCache(capacity, list.begin(), list.end(), hash, key_equal) {
}
/// Constructor.
///
/// \param list The initializer list to construct the cache with.
/// \param hash The hash function to use for the internal map.
/// \param key_equal The key equality function to use for the internal map.
BaseCache(InitializerList list,
const HashFunction& hash,
const KeyEqual& key_equal) // NOLINT(runtime/explicit)
: BaseCache(list.size(), list.begin(), list.end(), hash, key_equal) {
}
/// Copy constructor.
BaseCache(const BaseCache& other)
: _map(other._map)
, _order(other._order)
, _stats(other._stats)
, _last_accessed(other._last_accessed)
, _callback_manager(other._callback_manager)
, _capacity(other._capacity) {
_reassign_references();
}
/// Move constructor.
BaseCache(BaseCache&& other) {
// Following the copy-swap idiom.
swap(other);
}
/// Copy assignment operator.
BaseCache& operator=(const BaseCache& other) noexcept {
if (this != &other) {
_map = other._map;
_order = other._order;
_stats = other._stats;
_last_accessed = other._last_accessed;
_callback_manager = other._callback_manager;
_capacity = other._capacity;
_reassign_references();
}
return *this;
}
/// Move assignment operator.
BaseCache& operator=(BaseCache&& other) noexcept {
// Following the copy-swap idiom.
swap(other);
return *this;
}
/// Destructor.
virtual ~BaseCache() = default;
/// Sets the contents of the cache to a range.
///
/// If the size of the range is greater than the current capacity,
/// the capacity is increased to match the range's size. If the size of
/// the range is less than the current capacity, the cache's capacity is *not*
/// changed.
///
/// \param range A range of pairs to assign to the cache.
/// \returns The cache instance.
template <typename Range, typename = Internal::enable_if_range<Range>>
BaseCache& operator=(const Range& range) {
_clear_and_increase_capacity(range);
insert(range);
return *this;
}
/// Sets the contents of the cache to an rvalue range.
///
/// Pairs of the range are moved into the cache.
///
/// \param range A range of pairs to assign to the cache.
/// \returns The cache instance.
template <typename Range, typename = Internal::enable_if_range<Range>>
BaseCache& operator=(Range&& range) {
_clear_and_increase_capacity(range);
insert(std::move(range));
return *this;
}
/// Sets the contents of the cache to pairs from a list.
///
/// \param list The list to assign to the cache.
/// \returns The cache instance.
BaseCache& operator=(InitializerList list) {
return operator=<InitializerList>(list);
}
/// Swaps the contents of the cache with another cache.
///
/// \param other The other cache to swap with.
virtual void swap(BaseCache& other) noexcept {
using std::swap;
swap(_order, other._order);
swap(_map, other._map);
swap(_last_accessed, other._last_accessed);
swap(_capacity, other._capacity);
}
/// Swaps the contents of one cache with another cache.
///
/// \param first The first cache to swap.
/// \param second The second cache to swap.
friend void swap(BaseCache& first, BaseCache& second) noexcept {
first.swap(second);
}
/// Compares the cache for equality with another cache.
///
/// \complexity O(N)
/// \param other The other cache to compare with.
/// \returns True if the keys __and values__ of the cache are identical to the
/// other, else false.
bool operator==(const BaseCache& other) const noexcept {
if (this == &other) return true;
if (this->_map != other._map) return false;
// clang-format off
return std::equal(
this->_order.begin(),
this->_order.end(),
other._order.begin(),
other._order.end(),
[](const auto& first, const auto& second) {
return first.get() == second.get();
});
// clang-format on
}
/// Compares the cache for inequality with another cache.
///
/// \complexity O(N)
/// \param other The other cache to compare with.
/// \returns True if there is any mismatch in keys __or their values__
/// betweent
/// the two caches, else false.
bool operator!=(const BaseCache& other) const noexcept {
return !(*this == other);
}
/////////////////////////////////////////////////////////////////////////////
// ITERATOR INTERFACE
/////////////////////////////////////////////////////////////////////////////
/// \returns An unordered iterator to the beginning of the cache (this need
/// not be the first key inserted).
UnorderedIterator unordered_begin() noexcept {
return {*this, _map.begin()};
}
/// \returns A const unordered iterator to the beginning of the cache (this
/// need not be the key least recently inserted).
UnorderedConstIterator unordered_begin() const noexcept {
return unordered_cbegin();
}
/// \returns A const unordered iterator to the beginning of the cache (this
/// need not be the key least recently inserted).
UnorderedConstIterator unordered_cbegin() const noexcept {
return {*this, _map.cbegin()};
}
/// \returns An unordered iterator to the end of the cache (this
/// need not be one past the key most recently inserted).
UnorderedIterator unordered_end() noexcept {
return {*this, _map.end()};
}
/// \returns A const unordered iterator to the end of the cache (this
/// need not be one past the key most recently inserted).
UnorderedConstIterator unordered_end() const noexcept {
return unordered_cend();
}
/// \returns A const unordered iterator to the end of the cache (this
/// need not be one past the key most recently inserted).
UnorderedConstIterator unordered_cend() const noexcept {
return {*this, _map.cend()};
}
/// \returns An ordered iterator to the beginning of the cache (the key least
/// recently inserted).
OrderedIterator ordered_begin() noexcept {
return {*this, _order.begin()};
}
/// \returns A const ordered iterator to the beginning of the cache (the key
/// least recently inserted).
OrderedConstIterator ordered_begin() const noexcept {
return ordered_cbegin();
}
/// \returns A const ordered iterator to the beginning of the cache (the key
/// least recently inserted).
OrderedConstIterator ordered_cbegin() const noexcept {
return {*this, _order.cbegin()};
}
/// \returns An ordered iterator to the end of the cache (one past the key
/// most recently inserted).
OrderedIterator ordered_end() noexcept {
return {*this, _order.end()};
}
/// \returns A const ordered iterator to the end of the cache (one past the
/// key least recently inserted).
OrderedConstIterator ordered_end() const noexcept {
return ordered_cend();
}
/// \returns A const ordered iterator to the end of the cache (one past the
/// key least recently inserted).
OrderedConstIterator ordered_cend() const noexcept {
return {*this, _order.cend()};
}
/// \copydoc unordered_begin()
UnorderedIterator begin() noexcept {
return unordered_begin();
}
/// \copydoc unordered_cbegin()
UnorderedConstIterator begin() const noexcept {
return cbegin();
}
/// \copydoc unordered_cbegin()
UnorderedConstIterator cbegin() const noexcept {
return unordered_begin();
}
/// \copydoc unordered_end() const
UnorderedIterator end() noexcept {
return unordered_end();
}
/// \copydoc unordered_cend() const
UnorderedConstIterator end() const noexcept {
return cend();
}
/// \copydoc unordered_cend() const
UnorderedConstIterator cend() const noexcept {
return unordered_cend();
}
/// \returns True if the given iterator may be safely dereferenced, else
/// false.
/// \details Behavior is undefined if the iterator does not point into this
/// cache.
/// \param unordered_iterator The iterator to check.
virtual bool is_valid(UnorderedConstIterator unordered_iterator) const
noexcept {
return unordered_iterator != unordered_end();
}
/// \returns True if the given iterator may be safely dereferenced, else
/// false.
/// \details Behavior is undefined if the iterator does not point into this
/// cache.
/// \param ordered_iterator The iterator to check.
virtual bool is_valid(OrderedConstIterator ordered_iterator) const noexcept {
return ordered_iterator != ordered_end();
}
/// Checks if the given iterator may be dereferencend and throws an exception
/// if not.
///
/// The exception thrown, if any, depends on the state of the iterator.
///
/// \param unordered_iterator The iterator to check.
/// \throws LRU::Error::InvalidIterator if the iterator is the end iterator.
virtual void
throw_if_invalid(UnorderedConstIterator unordered_iterator) const {
if (unordered_iterator == unordered_end()) {
throw LRU::Error::InvalidIterator();
}
}
/// Checks if the given iterator may be dereferencend and throws an exception
/// if not.
///
/// The exception thrown, if any, depends on the state of the iterator.
///
/// \param ordered_iterator The iterator to check.
/// \throws LRU::Error::InvalidIterator if the iterator is the end iterator.
virtual void throw_if_invalid(OrderedConstIterator ordered_iterator) const {
if (ordered_iterator == ordered_end()) {
throw LRU::Error::InvalidIterator();
}
}
/////////////////////////////////////////////////////////////////////////////
// CACHE INTERFACE
/////////////////////////////////////////////////////////////////////////////
/// Tests if the given key is contained in the cache.
///
/// This function may return false even if the key is actually currently
/// stored in the cache, but the concrete cache class places some additional
/// constraint as to when a key may be accessed (such as a time limit).
///
/// \complexity O(1) expected and amortized.
/// \param key The key to check for.
/// \returns True if the key's value may be accessed via `lookup()` without an
/// error, else false.
virtual bool contains(const Key& key) const {
if (key == _last_accessed) {
if (_last_accessed_is_ok(key)) {
_register_hit(key, _last_accessed.value());
// If this is the last accessed key, it's at the front anyway
return true;
} else {
return false;
}
}
return find(key) != end();
}
/// Looks up the value for the given key.
///
/// If the key is found in the cache, it is moved to the front. Any iterators
/// pointing to that key are still valid, but the subsequent order of
/// iteration may be different from what it was before.
///
/// \complexity O(1) expected and amortized.
/// \param key The key whose value to look for.
/// \throws LRU::Error::KeyNotFound if the key's value may not be accessed.
/// \returns The value stored in the cache for the given key.
/// \see contains()
virtual const Value& lookup(const Key& key) const {
if (key == _last_accessed) {
auto& value = _value_for_last_accessed();
_register_hit(key, value);
// If this is the last accessed key, it's at the front anyway
return value;
}
auto iterator = find(key);
if (iterator == end()) {
throw LRU::Error::KeyNotFound();
} else {
return iterator.value();
}
}
/// Looks up the value for the given key.
///
/// If the key is found in the cache, it is moved to the front. Any iterators
/// pointing to that key are still valid, but the subsequent order of
/// iteration may be different from what it was before.
///
/// \complexity O(1) expected and amortized.
/// \param key The key whose value to look for.
/// \throws LRU::Error::KeyNotFound if the key's value may not be accessed.
/// \returns The value stored in the cache for the given key.
/// \see contains()
virtual Value& lookup(const Key& key) {
if (key == _last_accessed) {
auto& value = _value_for_last_accessed();
_register_hit(key, value);
// If this is the last accessed key, it's at the front anyway
return value;
}
auto iterator = find(key);
if (iterator == end()) {
throw LRU::Error::KeyNotFound();
} else {
return iterator.value();
}
}
/// Attempts to return an iterator to the given key in the cache.
///
/// If the key is found in the cache, it is moved to the front. Any iterators
/// pointing to that key are still valid, but the subsequent order of
/// iteration may be different from what it was before.
///
/// \complexity O(1) expected and amortized.
/// \param key The key whose value to look for.
/// \returns An iterator pointing to the entry with the given key, if one
/// exists, else the end iterator.
virtual UnorderedIterator find(const Key& key) = 0;
/// Attempts to return a const iterator to the given key in the cache.
///
/// If the key is found in the cache, it is moved to the front. Any iterators
/// pointing to that key are still valid, but the subsequent order of
/// iteration may be different from what it was before.
///
/// \complexity O(1) expected and amortized.
/// \param key The key whose value to look for.
/// \returns A const iterator pointing to the entry with the given key, if one
/// exists, else the end iterator.
virtual UnorderedConstIterator find(const Key& key) const = 0;
/// \copydoc lookup(const Key&)
virtual Value& operator[](const Key& key) {
return lookup(key);
}
/// \copydoc lookup(const Key&) const
virtual const Value& operator[](const Key& key) const {
return lookup(key);
}
/// Inserts the given `(key, value)` pair into the cache.
///
/// If the cache's capacity is reached, the most recently used element will be
/// evicted. Any iterators pointing to that element will be invalidated.
/// Iterators pointing to other elements are not affected.
///
/// \complexity O(1) expected and amortized.
/// \param key The key to insert.
/// \param value The value to insert with the key.
/// \returns An `InsertionResult`, holding a boolean indicating whether the
/// key was newly inserted (true) or only updated (false) as well as an
/// iterator pointing to the entry for the key.
virtual InsertionResultType insert(const Key& key, const Value& value) {
if (_capacity == 0) return {false, end()};
auto iterator = _map.find(key);
// To insert, we first check if the key is already present in the cache
// and if so, update its value and move its order iterator to the front
// of the queue. Else, we insert the key at the end of the queue and
// possibly pop the front if the cache has reached its capacity.
if (iterator == _map.end()) {
auto result = _map.emplace(key, Information(value));
assert(result.second);
auto order = _insert_new_key(result.first->first);
result.first->second.order = order;
_last_accessed = result.first;
return {true, {*this, result.first}};
} else {
_move_to_front(iterator, value);
_last_accessed = iterator;
return {false, {*this, iterator}};
}
}
/// Inserts a range of `(key, value)` pairs.
///
/// If, at any point, the cache's capacity is reached, the most recently used
/// element will be evicted. Any iterators pointing to that element will
/// be invalidated. Iterators pointing to other elements are not affected.
///
/// Note: This operation has no performance benefits over
/// element-wise insertion via `insert()`.
///
/// \param begin An iterator for the start of the range to insert.
/// \param end An iterator for the end of the range to insert.
/// \returns The number of elements newly inserted (as opposed to only
/// updated).
template <typename Iterator,
typename = Internal::enable_if_iterator_over_pair<Iterator>>
size_t insert(Iterator begin, Iterator end) {
size_t newly_inserted = 0;
for (; begin != end; ++begin) {
const auto result = insert(begin->first, begin->second);
newly_inserted += result.was_inserted();
}
return newly_inserted;
}
/// Inserts a range of `(key, value)` pairs.
///
/// If, at any point, the cache's capacity is reached, the most recently used
/// element will be evicted. Any iterators pointing to that element will
/// be invalidated. Iterators pointing to other elements are not affected.
///
/// This operation has no performance benefits over
/// element-wise insertion via `insert()`.
///
/// \param range The range of `(key, value)` pairs to insert.
/// \returns The number of elements newly inserted (as opposed to only
/// updated).
template <typename Range, typename = Internal::enable_if_range<Range>>
size_t insert(Range& range) {
using std::begin;
using std::end;
return insert(begin(range), end(range));
}
/// Moves the elements of the range into the cache.
///
/// If, at any point, the cache's capacity is reached, the most recently used
/// element will be evicted. Any iterators pointing to that element will
/// be invalidated. Iterators pointing to other elements are not affected.
///
/// \param range The range of `(key, value)` pairs to move into the cache.
/// \returns The number of elements newly inserted (as opposed to only
/// updated).
template <typename Range, typename = Internal::enable_if_range<Range>>
size_t insert(Range&& range) {
size_t newly_inserted = 0;
for (auto& pair : range) {
const auto result =
emplace(std::move(pair.first), std::move(pair.second));
newly_inserted += result.was_inserted();
}
return newly_inserted;
}
/// Inserts a list `(key, value)` pairs.
///
/// If the cache's capacity is reached, the most recently used element will be
/// evicted (one or more times). Any iterators pointing to that element will
/// be invalidated. Iterators pointing to other elements are not affected.
///
/// This operation has no performance benefits over
/// element-wise insertion via `insert()`.
///
/// \param list The list of `(key, value)` pairs to insert.
/// \returns The number of elements newly inserted (as opposed to only
/// updated).
virtual size_t insert(InitializerList list) {
return insert(list.begin(), list.end());
}
/// Emplaces a new `(key, value)` pair into the cache.
///
/// This emplacement function allows perfectly forwarding an arbitrary number
/// of arguments to the constructor of both the key and value type, via
/// appropriate tuples. The intended usage is with `std::forward_as_tuple`,
/// for example:
/// \code{.cpp}
/// struct A { A(int, const std::string&) { } };
/// struct B { B(double) {} };
///
/// LRU::Cache<A> cache;
///
/// cache.emplace(
/// std::piecewise_construct,
/// std::forward_as_tuple(1, "hello"),
/// std::forward_as_tuple(5.0),
/// );
/// \endcode
///
/// There is a convenience overload that requires much less overhead, if both
/// constructors expect only a single argument.
///
/// If the cache's capacity is reached, the most recently used element will be
/// evicted. Any iterators pointing to that element will be invalidated.
/// Iterators pointing to other elements are not affected.
///
/// \complexity O(1) expected and amortized.
/// \param _ A dummy parameter to work around overload resolution.
/// \param key_arguments A tuple of arguments to construct a key object with.
/// \param value_arguments A tuple of arguments to construct a value object
/// with.
/// \returns An `InsertionResult`, holding a boolean indicating whether the
/// key was newly inserted (true) or only updated (false) as well as an
/// iterator pointing to the entry for the key.
template <typename... Ks, typename... Vs>
InsertionResultType emplace(std::piecewise_construct_t _,
const std::tuple<Ks...>& key_arguments,
const std::tuple<Vs...>& value_arguments) {
if (_capacity == 0) return {false, end()};
auto key = Internal::construct_from_tuple<Key>(key_arguments);
auto iterator = _map.find(key);
if (iterator == _map.end()) {
auto result = _map.emplace(std::move(key), Information(value_arguments));
auto order = _insert_new_key(result.first->first);
result.first->second.order = order;
assert(result.second);
_last_accessed = result.first;
return {true, {*this, result.first}};
} else {
auto value = Internal::construct_from_tuple<Value>(value_arguments);
_move_to_front(iterator, value);
_last_accessed = iterator;
return {false, {*this, iterator}};
}
}
/// Emplaces a `(key, value)` pair.
///
/// This is a convenience overload removing the necessity for
/// `std::piecewise_construct` and `std::forward_as_tuple` that may be used in
/// the case that both the key and value have constructors expecting only a
/// single argument.
///
/// If the cache's capacity is reached, the most recently used element will be
/// evicted. Any iterators pointing to that element will be invalidated.
/// Iterators pointing to other elements are not affected.
///
/// \param key_argument The argument to construct a key object with.
/// \param value_argument The argument to construct a value object with.
/// \returns An `InsertionResult`, holding a boolean indicating whether the
/// key was newly inserted (true) or only updated (false) as well as an
/// iterator pointing to the entry for the key.
template <typename K, typename V>
InsertionResultType emplace(K&& key_argument, V&& value_argument) {
auto key_tuple = std::forward_as_tuple(std::forward<K>(key_argument));
auto value_tuple = std::forward_as_tuple(std::forward<V>(value_argument));
return emplace(std::piecewise_construct, key_tuple, value_tuple);
}
/// Erases the given key from the cache, if it is present.
///
/// If the key is not present in the cache, this is a no-op.
/// All iterators pointing to the given key are invalidated.
/// Other iterators are not affected.
///
/// \param key The key to erase.
/// \returns True if the key was erased, else false.
virtual bool erase(const Key& key) {
// No need to use _last_accessed_is_ok here, because even
// if it has expired, it's no problem to erase it anyway
if (_last_accessed == key) {
_erase(_last_accessed.key(), _last_accessed.information());
return true;
}
auto iterator = _map.find(key);
if (iterator != _map.end()) {
_erase(iterator);
return true;
}
return false;
}
/// Erases the key pointed to by the given iterator.
///
/// \param iterator The iterator whose key to erase.
/// \throws LRU::Error::InvalidIterator if the iterator is the end iterator.
virtual void erase(UnorderedConstIterator iterator) {
/// We have this overload to avoid the extra conversion-construction from
/// unordered to ordered iterator (and renewed hash lookup)
if (iterator == unordered_cend()) {
throw LRU::Error::InvalidIterator();
} else {
_erase(iterator._iterator);
}
}
/// Erases the key pointed to by the given iterator.
///
/// \param iterator The iterator whose key to erase.
/// \throws LRU::Error::InvalidIterator if the iterator is the end iterator.
virtual void erase(OrderedConstIterator iterator) {
if (iterator == ordered_cend()) {
throw LRU::Error::InvalidIterator();
} else {
_erase(_map.find(iterator.key()));
}
}
/// Clears the cache entirely.
virtual void clear() {
_map.clear();
_order.clear();
_last_accessed.invalidate();
}
/// Requests shrinkage of the cache to the given size.
///
/// If the passed size is 0, this operation is equivalent to `clear()`. If the
/// size is greater than the current size, it is a no-op. Otherwise, the size
/// of the cache is reduzed to the given size by repeatedly removing the least
/// recent element.
///
/// \param new_size The size to (maybe) shrink to.
virtual void shrink(size_t new_size) {
if (new_size >= size()) return;
if (new_size == 0) {
clear();
return;
}
while (size() > new_size) {
_erase_lru();
}
}
/////////////////////////////////////////////////////////////////////////////
// SIZE AND CAPACITY INTERFACE
/////////////////////////////////////////////////////////////////////////////
/// \returns The number of keys present in the cache.
virtual size_t size() const noexcept {
return _map.size();
}
/// Sets the capacity of the cache to the given value.
///
/// If the given capacity is less than the current capacity of the cache,
/// the least-recently inserted element is removed repeatedly until the
/// capacity is equal to the given value.
///
/// \param new_capacity The capacity to shrink or grow to.
virtual void capacity(size_t new_capacity) {
// Pop the front of the cache if we have to resize
while (size() > new_capacity) {
_erase_lru();
}
_capacity = new_capacity;
}
/// Returns the current capacity of the cache.
virtual size_t capacity() const noexcept {
return _capacity;
}
/// \returns the number of slots left in the cache.
///
/// \details After this number of elements have been inserted, the next one
/// insertion is preceded by an erasure of the
gitextract_khl86cyt/
├── .clang-format
├── .gitignore
├── .gitmodules
├── .travis.yml
├── CMakeLists.txt
├── LICENSE
├── README.md
├── cpplint.cfg
├── docs/
│ └── Doxyfile
├── examples/
│ ├── CMakeLists.txt
│ ├── callbacks.cpp
│ ├── fibonacci-basic.cpp
│ ├── fibonacci-timed.cpp
│ ├── lowercase.cpp
│ ├── statistics.cpp
│ └── wrap.cpp
├── include/
│ └── lru/
│ ├── cache-tags.hpp
│ ├── cache.hpp
│ ├── entry.hpp
│ ├── error.hpp
│ ├── insertion-result.hpp
│ ├── internal/
│ │ ├── base-cache.hpp
│ │ ├── base-iterator.hpp
│ │ ├── base-ordered-iterator.hpp
│ │ ├── base-unordered-iterator.hpp
│ │ ├── callback-manager.hpp
│ │ ├── definitions.hpp
│ │ ├── hash.hpp
│ │ ├── information.hpp
│ │ ├── last-accessed.hpp
│ │ ├── optional.hpp
│ │ ├── statistics-mutator.hpp
│ │ ├── timed-information.hpp
│ │ └── utility.hpp
│ ├── iterator-tags.hpp
│ ├── key-statistics.hpp
│ ├── lowercase.hpp
│ ├── lru.hpp
│ ├── statistics.hpp
│ ├── timed-cache.hpp
│ └── wrap.hpp
└── tests/
├── CMakeLists.txt
├── cache-test.cpp
├── callback-test.cpp
├── iterator-test.cpp
├── last-accessed-test.cpp
├── logbt.sh
├── move-aware-dummies.hpp
├── move-awareness-test.cpp
├── statistics-test.cpp
├── timed-cache-test.cpp
└── wrap-test.cpp
SYMBOL INDEX (558 symbols across 39 files)
FILE: examples/callbacks.cpp
function fibonacci (line 28) | std::uint64_t fibonacci(std::uint64_t n, Cache& cache) {
function fibonacci (line 45) | std::uint64_t fibonacci(std::uint64_t n) {
function main (line 74) | auto main() -> int {
FILE: examples/fibonacci-basic.cpp
function fibonacci (line 28) | int fibonacci(int n, Cache& cache) {
function fibonacci (line 45) | int fibonacci(int n) {
function main (line 53) | auto main() -> int {
FILE: examples/fibonacci-timed.cpp
function fibonacci (line 31) | int fibonacci(int n, Cache& cache) {
function fibonacci (line 48) | int fibonacci(int n) {
function main (line 55) | auto main() -> int {
FILE: examples/lowercase.cpp
function print (line 27) | void print(lru::tag::basic_cache) {
function print (line 31) | void print(lru::tag::timed_cache) {
function main (line 35) | auto main() -> int {
FILE: examples/statistics.cpp
function fibonacci (line 28) | std::uint64_t fibonacci(std::uint64_t n, Cache& cache) {
function fibonacci (line 45) | std::uint64_t fibonacci(std::uint64_t n) {
function main (line 73) | auto main() -> int {
FILE: examples/wrap.cpp
function f (line 30) | int f(int x) {
function main (line 35) | auto main() -> int {
FILE: include/lru/cache-tags.hpp
type LRU (line 25) | namespace LRU {
type Tag (line 26) | namespace Tag {
type BasicCache (line 27) | struct BasicCache {}
type TimedCache (line 28) | struct TimedCache {}
type Lowercase (line 31) | namespace Lowercase {
type tag (line 32) | namespace tag {
FILE: include/lru/cache.hpp
type LRU (line 40) | namespace LRU {
type Internal (line 41) | namespace Internal {
class Cache (line 69) | class Cache
method Cache (line 81) | explicit Cache(size_t capacity = Internal::DEFAULT_CAPACITY,
method Cache (line 90) | Cache(size_t capacity,
method Cache (line 101) | Cache(Iterator begin,
method Cache (line 115) | Cache(size_t capacity,
method Cache (line 128) | explicit Cache(Range&& range,
method Cache (line 136) | Cache(InitializerList list,
method Cache (line 144) | Cache(size_t capacity,
method UnorderedIterator (line 152) | UnorderedIterator find(const Key& key) override {
method UnorderedConstIterator (line 166) | UnorderedConstIterator find(const Key& key) const override {
method Key (line 180) | const Key& front() const noexcept {
method Key (line 190) | const Key& back() const noexcept {
type Lowercase (line 200) | namespace Lowercase {
FILE: include/lru/entry.hpp
type LRU (line 29) | namespace LRU {
type Entry (line 38) | struct Entry final {
method Entry (line 48) | Entry(const Key& key, Value& value) : first(key), second(value) {
method Entry (line 61) | Entry(const Entry<AnyKey, AnyValue>& other)
method Key (line 111) | const Key& key() const noexcept {
method Value (line 116) | Value& value() noexcept {
method Value (line 121) | const Value& value() const noexcept {
FILE: include/lru/error.hpp
type LRU (line 28) | namespace LRU {
type Error (line 29) | namespace Error {
type KeyNotFound (line 32) | struct KeyNotFound : public std::runtime_error {
method KeyNotFound (line 35) | KeyNotFound() : super("Failed to find key") {
method KeyNotFound (line 38) | explicit KeyNotFound(const std::string& key)
type KeyExpired (line 44) | struct KeyExpired : public std::runtime_error {
method KeyExpired (line 47) | explicit KeyExpired(const std::string& key)
method KeyExpired (line 51) | KeyExpired() : super("Key found, but expired") {
type EmptyCache (line 56) | struct EmptyCache : public std::runtime_error {
method EmptyCache (line 58) | explicit EmptyCache(const std::string& what_was_expected)
type InvalidIteratorConversion (line 65) | struct InvalidIteratorConversion : public std::runtime_error {
method InvalidIteratorConversion (line 67) | InvalidIteratorConversion()
type InvalidIterator (line 73) | struct InvalidIterator : public std::runtime_error {
method InvalidIterator (line 75) | InvalidIterator() : super("Past-the-end iterator is invalid here") {
type UnmonitoredKey (line 80) | struct UnmonitoredKey : public std::runtime_error {
method UnmonitoredKey (line 82) | UnmonitoredKey() : super("Requested statistics for unmonitored key...
type NotMonitoring (line 88) | struct NotMonitoring : public std::runtime_error {
method NotMonitoring (line 90) | NotMonitoring() : super("Statistics monitoring not enabled for thi...
type Lowercase (line 94) | namespace Lowercase {
FILE: include/lru/insertion-result.hpp
type LRU (line 29) | namespace LRU {
type InsertionResult (line 40) | struct InsertionResult final {
method InsertionResult (line 47) | InsertionResult(bool result, Iterator iterator)
method was_inserted (line 52) | bool was_inserted() const noexcept {
method Iterator (line 57) | Iterator iterator() const noexcept {
FILE: include/lru/internal/base-cache.hpp
type LRU (line 47) | namespace LRU {
type Internal (line 48) | namespace Internal {
class BaseCache (line 117) | class BaseCache {
method Tag (line 144) | static constexpr Tag tag() noexcept {
type UnorderedIterator (line 157) | struct UnorderedIterator
method UnorderedIterator (line 163) | UnorderedIterator() = default;
method UnorderedIterator (line 168) | UnorderedIterator(BaseUnorderedIterator<BaseCache, MapIterator>
method UnorderedIterator (line 180) | UnorderedIterator(BaseCache& cache,
type UnorderedConstIterator (line 191) | struct UnorderedConstIterator
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
type OrderedIterator (line 236) | struct OrderedIterator
method OrderedIterator (line 243) | OrderedIterator() = default;
method OrderedIterator (line 248) | explicit OrderedIterator(UnorderedIterator unordered_iterator)
method OrderedIterator (line 255) | OrderedIterator(BaseOrderedIterator<Key, Value, BaseCache>
method OrderedIterator (line 267) | OrderedIterator(BaseCache& cache, UnderlyingIterator iterator)
type OrderedConstIterator (line 278) | struct OrderedConstIterator
method OrderedConstIterator (line 286) | OrderedConstIterator() = default;
method OrderedConstIterator (line 293) | OrderedConstIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCa...
method OrderedConstIterator (line 303) | OrderedConstIterator(OrderedIterator iterator) // NOLINT(runtim...
method OrderedConstIterator (line 310) | explicit OrderedConstIterator(UnorderedIterator unordered_iterator)
method OrderedConstIterator (line 317) | explicit OrderedConstIterator(
method OrderedConstIterator (line 326) | OrderedConstIterator(const BaseCache& cache, UnderlyingIterator ...
method BaseCache (line 348) | BaseCache(size_t capacity,
method BaseCache (line 362) | BaseCache(size_t capacity,
method BaseCache (line 383) | BaseCache(Iterator begin,
method BaseCache (line 403) | BaseCache(size_t capacity,
method BaseCache (line 421) | explicit BaseCache(Range& range,
method BaseCache (line 436) | BaseCache(size_t capacity,
method BaseCache (line 456) | explicit BaseCache(Range&& range,
method BaseCache (line 471) | BaseCache(size_t capacity,
method BaseCache (line 483) | BaseCache(InitializerList list,
method BaseCache (line 490) | BaseCache(const BaseCache& other)
method BaseCache (line 501) | BaseCache(BaseCache&& other) {
method BaseCache (line 507) | BaseCache& operator=(const BaseCache& other) noexcept {
method BaseCache (line 522) | BaseCache& operator=(BaseCache&& other) noexcept {
method BaseCache (line 541) | BaseCache& operator=(const Range& range) {
method BaseCache (line 554) | BaseCache& operator=(Range&& range) {
method BaseCache (line 564) | BaseCache& operator=(InitializerList list) {
method swap (line 571) | virtual void swap(BaseCache& other) noexcept {
method swap (line 584) | void swap(BaseCache& first, BaseCache& second) noexcept {
method UnorderedIterator (line 626) | UnorderedIterator unordered_begin() noexcept {
method UnorderedIterator (line 163) | UnorderedIterator() = default;
method UnorderedIterator (line 168) | UnorderedIterator(BaseUnorderedIterator<BaseCache, MapIterator>
method UnorderedIterator (line 180) | UnorderedIterator(BaseCache& cache,
method UnorderedConstIterator (line 632) | UnorderedConstIterator unordered_begin() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method UnorderedConstIterator (line 638) | UnorderedConstIterator unordered_cbegin() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method UnorderedIterator (line 644) | UnorderedIterator unordered_end() noexcept {
method UnorderedIterator (line 163) | UnorderedIterator() = default;
method UnorderedIterator (line 168) | UnorderedIterator(BaseUnorderedIterator<BaseCache, MapIterator>
method UnorderedIterator (line 180) | UnorderedIterator(BaseCache& cache,
method UnorderedConstIterator (line 650) | UnorderedConstIterator unordered_end() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method UnorderedConstIterator (line 656) | UnorderedConstIterator unordered_cend() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method OrderedIterator (line 662) | OrderedIterator ordered_begin() noexcept {
method OrderedIterator (line 243) | OrderedIterator() = default;
method OrderedIterator (line 248) | explicit OrderedIterator(UnorderedIterator unordered_iterator)
method OrderedIterator (line 255) | OrderedIterator(BaseOrderedIterator<Key, Value, BaseCache>
method OrderedIterator (line 267) | OrderedIterator(BaseCache& cache, UnderlyingIterator iterator)
method OrderedConstIterator (line 668) | OrderedConstIterator ordered_begin() const noexcept {
method OrderedConstIterator (line 286) | OrderedConstIterator() = default;
method OrderedConstIterator (line 293) | OrderedConstIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCa...
method OrderedConstIterator (line 303) | OrderedConstIterator(OrderedIterator iterator) // NOLINT(runtim...
method OrderedConstIterator (line 310) | explicit OrderedConstIterator(UnorderedIterator unordered_iterator)
method OrderedConstIterator (line 317) | explicit OrderedConstIterator(
method OrderedConstIterator (line 326) | OrderedConstIterator(const BaseCache& cache, UnderlyingIterator ...
method OrderedConstIterator (line 674) | OrderedConstIterator ordered_cbegin() const noexcept {
method OrderedConstIterator (line 286) | OrderedConstIterator() = default;
method OrderedConstIterator (line 293) | OrderedConstIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCa...
method OrderedConstIterator (line 303) | OrderedConstIterator(OrderedIterator iterator) // NOLINT(runtim...
method OrderedConstIterator (line 310) | explicit OrderedConstIterator(UnorderedIterator unordered_iterator)
method OrderedConstIterator (line 317) | explicit OrderedConstIterator(
method OrderedConstIterator (line 326) | OrderedConstIterator(const BaseCache& cache, UnderlyingIterator ...
method OrderedIterator (line 680) | OrderedIterator ordered_end() noexcept {
method OrderedIterator (line 243) | OrderedIterator() = default;
method OrderedIterator (line 248) | explicit OrderedIterator(UnorderedIterator unordered_iterator)
method OrderedIterator (line 255) | OrderedIterator(BaseOrderedIterator<Key, Value, BaseCache>
method OrderedIterator (line 267) | OrderedIterator(BaseCache& cache, UnderlyingIterator iterator)
method OrderedConstIterator (line 686) | OrderedConstIterator ordered_end() const noexcept {
method OrderedConstIterator (line 286) | OrderedConstIterator() = default;
method OrderedConstIterator (line 293) | OrderedConstIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCa...
method OrderedConstIterator (line 303) | OrderedConstIterator(OrderedIterator iterator) // NOLINT(runtim...
method OrderedConstIterator (line 310) | explicit OrderedConstIterator(UnorderedIterator unordered_iterator)
method OrderedConstIterator (line 317) | explicit OrderedConstIterator(
method OrderedConstIterator (line 326) | OrderedConstIterator(const BaseCache& cache, UnderlyingIterator ...
method OrderedConstIterator (line 692) | OrderedConstIterator ordered_cend() const noexcept {
method OrderedConstIterator (line 286) | OrderedConstIterator() = default;
method OrderedConstIterator (line 293) | OrderedConstIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCa...
method OrderedConstIterator (line 303) | OrderedConstIterator(OrderedIterator iterator) // NOLINT(runtim...
method OrderedConstIterator (line 310) | explicit OrderedConstIterator(UnorderedIterator unordered_iterator)
method OrderedConstIterator (line 317) | explicit OrderedConstIterator(
method OrderedConstIterator (line 326) | OrderedConstIterator(const BaseCache& cache, UnderlyingIterator ...
method UnorderedIterator (line 697) | UnorderedIterator begin() noexcept {
method UnorderedIterator (line 163) | UnorderedIterator() = default;
method UnorderedIterator (line 168) | UnorderedIterator(BaseUnorderedIterator<BaseCache, MapIterator>
method UnorderedIterator (line 180) | UnorderedIterator(BaseCache& cache,
method UnorderedConstIterator (line 702) | UnorderedConstIterator begin() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method UnorderedConstIterator (line 707) | UnorderedConstIterator cbegin() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method UnorderedIterator (line 712) | UnorderedIterator end() noexcept {
method UnorderedIterator (line 163) | UnorderedIterator() = default;
method UnorderedIterator (line 168) | UnorderedIterator(BaseUnorderedIterator<BaseCache, MapIterator>
method UnorderedIterator (line 180) | UnorderedIterator(BaseCache& cache,
method UnorderedConstIterator (line 717) | UnorderedConstIterator end() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method UnorderedConstIterator (line 722) | UnorderedConstIterator cend() const noexcept {
method UnorderedConstIterator (line 197) | UnorderedConstIterator() = default;
method UnorderedConstIterator (line 204) | UnorderedConstIterator(
method UnorderedConstIterator (line 214) | UnorderedConstIterator(
method UnorderedConstIterator (line 223) | UnorderedConstIterator(
method is_valid (line 731) | virtual bool is_valid(UnorderedConstIterator unordered_iterator) c...
method is_valid (line 741) | virtual bool is_valid(OrderedConstIterator ordered_iterator) const...
method throw_if_invalid (line 752) | virtual void
method throw_if_invalid (line 766) | virtual void throw_if_invalid(OrderedConstIterator ordered_iterato...
method contains (line 786) | virtual bool contains(const Key& key) const {
method Value (line 811) | virtual const Value& lookup(const Key& key) const {
method Value (line 838) | virtual Value& lookup(const Key& key) {
method Value (line 879) | virtual Value& operator[](const Key& key) {
method Value (line 884) | virtual const Value& operator[](const Key& key) const {
method InsertionResultType (line 900) | virtual InsertionResultType insert(const Key& key, const Value& va...
method insert (line 940) | size_t insert(Iterator begin, Iterator end) {
method insert (line 963) | size_t insert(Range& range) {
method insert (line 980) | size_t insert(Range&& range) {
method insert (line 1003) | virtual size_t insert(InitializerList list) {
method InsertionResultType (line 1042) | InsertionResultType emplace(std::piecewise_construct_t _,
method InsertionResultType (line 1083) | InsertionResultType emplace(K&& key_argument, V&& value_argument) {
method erase (line 1097) | virtual bool erase(const Key& key) {
method erase (line 1118) | virtual void erase(UnorderedConstIterator iterator) {
method erase (line 1133) | virtual void erase(OrderedConstIterator iterator) {
method clear (line 1142) | virtual void clear() {
method shrink (line 1156) | virtual void shrink(size_t new_size) {
method size (line 1173) | virtual size_t size() const noexcept {
method capacity (line 1184) | virtual void capacity(size_t new_capacity) {
method capacity (line 1193) | virtual size_t capacity() const noexcept {
method space_left (line 1202) | virtual size_t space_left() const noexcept {
method is_empty (line 1207) | virtual bool is_empty() const noexcept {
method is_full (line 1215) | virtual bool is_full() const noexcept {
method HashFunction (line 1220) | virtual HashFunction hash_function() const {
method KeyEqual (line 1225) | virtual KeyEqual key_equal() const {
method monitor (line 1243) | virtual void monitor(const StatisticsPointer& statistics) {
method monitor (line 1252) | virtual void monitor(StatisticsPointer&& statistics) {
method monitor (line 1266) | void monitor(Args&&... args) {
method stop_monitoring (line 1273) | virtual void stop_monitoring() {
method is_monitoring (line 1279) | bool is_monitoring() const noexcept {
method StatisticsPointer (line 1304) | virtual StatisticsPointer& shared_stats() {
method StatisticsPointer (line 1309) | virtual const StatisticsPointer& shared_stats() const {
method hit_callback (line 1322) | void hit_callback(Callback&& hit_callback) {
method miss_callback (line 1332) | void miss_callback(Callback&& miss_callback) {
method access_callback (line 1342) | void access_callback(Callback&& access_callback) {
method clear_hit_callbacks (line 1347) | void clear_hit_callbacks() {
method clear_miss_callbacks (line 1352) | void clear_miss_callbacks() {
method clear_access_callbacks (line 1357) | void clear_access_callbacks() {
method clear_all_callbacks (line 1362) | void clear_all_callbacks() {
method HitCallbackContainer (line 1367) | const HitCallbackContainer& hit_callbacks() const noexcept {
method MissCallbackContainer (line 1372) | const MissCallbackContainer& miss_callbacks() const noexcept {
method AccessCallbackContainer (line 1377) | const AccessCallbackContainer& access_callbacks() const noexcept {
method _move_to_front (line 1394) | virtual void _move_to_front(QueueIterator iterator) const {
method _move_to_front (line 1407) | virtual void _move_to_front(MapIterator iterator, const Value& new...
method _erase_lru (line 1416) | virtual void _erase_lru() {
method _erase (line 1423) | virtual void _erase(MapConstIterator iterator) {
method _erase (line 1440) | virtual void _erase(const Key& key, const Information& information) {
method Value (line 1455) | virtual Value& _value_from_result(MapInsertionResult& result) noex...
method _last_accessed_is_ok (line 1469) | virtual bool _last_accessed_is_ok(const Key& key) const noexcept {
method Value (line 1474) | virtual Value& _value_for_last_accessed() {
method Value (line 1484) | virtual const Value& _value_for_last_accessed() const {
method _register_hit (line 1491) | virtual void _register_hit(const Key& key, const Value& value) con...
method _register_miss (line 1501) | virtual void _register_miss(const Key& key) const {
method _clear_and_increase_capacity (line 1513) | void _clear_and_increase_capacity(const Range& range) {
method _reassign_references (line 1530) | void _reassign_references() noexcept {
method QueueIterator (line 1542) | QueueIterator _insert_new_key(const Key& key) {
method _evict_lru_for (line 1555) | void _evict_lru_for(const Key& key) {
method _is_too_full (line 1563) | bool _is_too_full() const noexcept {
FILE: include/lru/internal/base-iterator.hpp
type LRU (line 42) | namespace LRU {
type Internal (line 43) | namespace Internal {
class BaseIterator (line 63) | class BaseIterator : public std::iterator<IteratorTag, LRU::Entry<Ke...
method BaseIterator (line 71) | BaseIterator() noexcept : _cache(nullptr) {
method BaseIterator (line 78) | BaseIterator(Cache& cache, const UnderlyingIterator& iterator) noe...
method BaseIterator (line 88) | BaseIterator(const BaseIterator& other) noexcept
method BaseIterator (line 102) | BaseIterator& operator=(const BaseIterator& other) noexcept {
method BaseIterator (line 112) | BaseIterator(BaseIterator&& other) noexcept = default;
method BaseIterator (line 115) | BaseIterator& operator=(BaseIterator&& other) noexcept = default;
method BaseIterator (line 127) | BaseIterator(const BaseIterator<AnyIteratorTag,
method BaseIterator (line 145) | BaseIterator(BaseIterator<AnyIteratorTag,
method swap (line 161) | void swap(BaseIterator& other) noexcept {
method swap (line 174) | void swap(BaseIterator& first, BaseIterator& second) noexcept {
method Entry (line 182) | Entry* operator->() noexcept {
FILE: include/lru/internal/base-ordered-iterator.hpp
type LRU (line 38) | namespace LRU {
type Internal (line 39) | namespace Internal {
class BaseOrderedIterator (line 63) | class BaseOrderedIterator
method BaseOrderedIterator (line 75) | BaseOrderedIterator() noexcept = default;
method BaseOrderedIterator (line 78) | BaseOrderedIterator(Cache& cache, UnderlyingIterator iterator)
method BaseOrderedIterator (line 86) | BaseOrderedIterator(
method BaseOrderedIterator (line 95) | BaseOrderedIterator(BaseOrderedIterator<AnyKey, AnyValue, AnyCache...
method BaseOrderedIterator (line 107) | BaseOrderedIterator(const BaseUnorderedIterator<AnyCache, Underlyi...
method BaseOrderedIterator (line 123) | BaseOrderedIterator(BaseUnorderedIterator<AnyCache, UnderlyingIter...
method BaseOrderedIterator (line 133) | BaseOrderedIterator(const BaseOrderedIterator& other) = default;
method BaseOrderedIterator (line 136) | BaseOrderedIterator(BaseOrderedIterator&& other) = default;
method BaseOrderedIterator (line 139) | BaseOrderedIterator& operator=(const BaseOrderedIterator& other) =...
method BaseOrderedIterator (line 142) | BaseOrderedIterator& operator=(BaseOrderedIterator&& other) = defa...
method BaseOrderedIterator (line 236) | BaseOrderedIterator& operator++() {
method BaseOrderedIterator (line 248) | BaseOrderedIterator operator++(int) {
method BaseOrderedIterator (line 257) | BaseOrderedIterator& operator--() {
method BaseOrderedIterator (line 266) | BaseOrderedIterator operator--(int) {
method Entry (line 272) | Entry& operator*() noexcept override {
method Entry (line 278) | Entry& entry() override {
method Value (line 285) | Value& value() override {
method Key (line 291) | const Key& key() override {
method Entry (line 304) | Entry& _maybe_lookup() {
method _lookup (line 313) | void _lookup() {
method _throw_if_at_invalid (line 324) | void _throw_if_at_invalid(const UnorderedIterator& unordered_itera...
FILE: include/lru/internal/base-unordered-iterator.hpp
type LRU (line 36) | namespace LRU {
class TimedCache (line 40) | class TimedCache
type Internal (line 42) | namespace Internal {
class BaseUnorderedIterator (line 64) | class BaseUnorderedIterator
method BaseUnorderedIterator (line 78) | BaseUnorderedIterator() noexcept = default;
method BaseUnorderedIterator (line 81) | explicit BaseUnorderedIterator(Cache& cache,
method BaseUnorderedIterator (line 92) | BaseUnorderedIterator(
method BaseUnorderedIterator (line 99) | BaseUnorderedIterator(const BaseUnorderedIterator& other) noexcept...
method BaseUnorderedIterator (line 102) | BaseUnorderedIterator(BaseUnorderedIterator&& other) noexcept = de...
method BaseUnorderedIterator (line 105) | BaseUnorderedIterator&
method BaseUnorderedIterator (line 110) | BaseUnorderedIterator&
method BaseUnorderedIterator (line 148) | BaseUnorderedIterator& operator++() {
method BaseUnorderedIterator (line 160) | BaseUnorderedIterator operator++(int) {
method Entry (line 169) | Entry& operator*() noexcept override {
method Entry (line 181) | Entry& entry() override {
method Key (line 194) | const Key& key() override {
method Value (line 202) | Value& value() override {
FILE: include/lru/internal/callback-manager.hpp
type LRU (line 31) | namespace LRU {
type Internal (line 32) | namespace Internal {
class CallbackManager (line 44) | class CallbackManager {
method hit (line 58) | void hit(const Key& key, const Value& value) {
method miss (line 66) | void miss(const Key& key) {
method hit_callback (line 76) | void hit_callback(Callback&& hit_callback) {
method miss_callback (line 85) | void miss_callback(Callback&& miss_callback) {
method access_callback (line 94) | void access_callback(Callback&& access_callback) {
method clear_hit_callbacks (line 99) | void clear_hit_callbacks() {
method clear_miss_callbacks (line 104) | void clear_miss_callbacks() {
method clear_access_callbacks (line 109) | void clear_access_callbacks() {
method clear (line 114) | void clear() {
method HitCallbackContainer (line 121) | const HitCallbackContainer& hit_callbacks() const noexcept {
method MissCallbackContainer (line 126) | const MissCallbackContainer& miss_callbacks() const noexcept {
method AccessCallbackContainer (line 131) | const AccessCallbackContainer& access_callbacks() const noexcept {
method _call_each (line 141) | void _call_each(const CallbackContainer& callbacks, Args&&... args) {
FILE: include/lru/internal/definitions.hpp
type LRU (line 32) | namespace LRU {
type Internal (line 33) | namespace Internal {
FILE: include/lru/internal/hash.hpp
type std (line 34) | namespace std {
type hash<std::tuple<Ts...>> (line 36) | struct hash<std::tuple<Ts...>> {
method result_type (line 40) | result_type operator()(const argument_type& argument) const {
method result_type (line 46) | result_type
method result_type (line 56) | result_type hash_tuple(const argument_type&, std::index_sequence<>) co...
FILE: include/lru/internal/information.hpp
type LRU (line 32) | namespace LRU {
type Internal (line 33) | namespace Internal {
type Information (line 44) | struct Information {
method Information (line 53) | explicit Information(const Value& value_,
method Information (line 75) | explicit Information(const std::tuple<ValueArguments...>& value_ar...
method Information (line 82) | Information(const Information& other) = default;
method Information (line 85) | Information(Information&& other) = default;
method Information (line 88) | Information& operator=(const Information& other) = default;
method Information (line 91) | Information& operator=(Information&& other) = default;
method Information (line 135) | Information(const QueueIterator& order_,
FILE: include/lru/internal/last-accessed.hpp
type LRU (line 31) | namespace LRU {
type Internal (line 32) | namespace Internal {
class LastAccessed (line 65) | class LastAccessed {
method LastAccessed (line 70) | explicit LastAccessed(const KeyEqual& key_equal = KeyEqual())
method LastAccessed (line 82) | LastAccessed(const Key& key,
method LastAccessed (line 97) | explicit LastAccessed(Iterator iterator,
method LastAccessed (line 108) | LastAccessed& operator=(Iterator iterator) {
method Key (line 174) | Key& key() noexcept {
method Key (line 180) | const Key& key() const noexcept {
method InformationType (line 186) | InformationType& information() noexcept {
method InformationType (line 192) | const InformationType& information() const noexcept {
method is_valid (line 217) | bool is_valid() const noexcept {
method invalidate (line 227) | void invalidate() noexcept {
method KeyEqual (line 234) | const KeyEqual& key_equal() const noexcept {
FILE: include/lru/internal/optional.hpp
type LRU (line 31) | namespace LRU {
type Internal (line 32) | namespace Internal {
class Optional (line 55) | class Optional {
method Optional (line 58) | Optional() = default;
method Optional (line 63) | Optional(const Optional& other) {
method Optional (line 72) | Optional(const Optional<U>& other) {
method Optional (line 79) | Optional(Optional&& other) noexcept {
method Optional (line 88) | Optional(Optional<U>&& other) noexcept {
method Optional (line 98) | Optional& operator=(Optional other) noexcept {
method swap (line 106) | void swap(Optional& other) {
method swap (line 114) | void swap(Optional& first, Optional& second) /* NOLINT */ {
method has_value (line 119) | bool has_value() const noexcept {
method T (line 130) | T* operator->() {
method T (line 136) | const T* operator->() const {
method T (line 142) | const T& operator*() const {
method T (line 148) | T& operator*() {
method T (line 154) | T& value() {
method T (line 165) | const T& value() const {
method T (line 178) | T value_or(U&& default_value) const {
method reset (line 183) | void reset() noexcept {
method emplace (line 191) | void emplace(Args&&... args) {
type Internal (line 47) | namespace Internal {
class Optional (line 55) | class Optional {
method Optional (line 58) | Optional() = default;
method Optional (line 63) | Optional(const Optional& other) {
method Optional (line 72) | Optional(const Optional<U>& other) {
method Optional (line 79) | Optional(Optional&& other) noexcept {
method Optional (line 88) | Optional(Optional<U>&& other) noexcept {
method Optional (line 98) | Optional& operator=(Optional other) noexcept {
method swap (line 106) | void swap(Optional& other) {
method swap (line 114) | void swap(Optional& first, Optional& second) /* NOLINT */ {
method has_value (line 119) | bool has_value() const noexcept {
method T (line 130) | T* operator->() {
method T (line 136) | const T* operator->() const {
method T (line 142) | const T& operator*() const {
method T (line 148) | T& operator*() {
method T (line 154) | T& value() {
method T (line 165) | const T& value() const {
method T (line 178) | T value_or(U&& default_value) const {
method reset (line 183) | void reset() noexcept {
method emplace (line 191) | void emplace(Args&&... args) {
type LRU (line 46) | namespace LRU {
type Internal (line 32) | namespace Internal {
class Optional (line 55) | class Optional {
method Optional (line 58) | Optional() = default;
method Optional (line 63) | Optional(const Optional& other) {
method Optional (line 72) | Optional(const Optional<U>& other) {
method Optional (line 79) | Optional(Optional&& other) noexcept {
method Optional (line 88) | Optional(Optional<U>&& other) noexcept {
method Optional (line 98) | Optional& operator=(Optional other) noexcept {
method swap (line 106) | void swap(Optional& other) {
method swap (line 114) | void swap(Optional& first, Optional& second) /* NOLINT */ {
method has_value (line 119) | bool has_value() const noexcept {
method T (line 130) | T* operator->() {
method T (line 136) | const T* operator->() const {
method T (line 142) | const T& operator*() const {
method T (line 148) | T& operator*() {
method T (line 154) | T& value() {
method T (line 165) | const T& value() const {
method T (line 178) | T value_or(U&& default_value) const {
method reset (line 183) | void reset() noexcept {
method emplace (line 191) | void emplace(Args&&... args) {
type Internal (line 47) | namespace Internal {
class Optional (line 55) | class Optional {
method Optional (line 58) | Optional() = default;
method Optional (line 63) | Optional(const Optional& other) {
method Optional (line 72) | Optional(const Optional<U>& other) {
method Optional (line 79) | Optional(Optional&& other) noexcept {
method Optional (line 88) | Optional(Optional<U>&& other) noexcept {
method Optional (line 98) | Optional& operator=(Optional other) noexcept {
method swap (line 106) | void swap(Optional& other) {
method swap (line 114) | void swap(Optional& first, Optional& second) /* NOLINT */ {
method has_value (line 119) | bool has_value() const noexcept {
method T (line 130) | T* operator->() {
method T (line 136) | const T* operator->() const {
method T (line 142) | const T& operator*() const {
method T (line 148) | T& operator*() {
method T (line 154) | T& value() {
method T (line 165) | const T& value() const {
method T (line 178) | T value_or(U&& default_value) const {
method reset (line 183) | void reset() noexcept {
method emplace (line 191) | void emplace(Args&&... args) {
FILE: include/lru/internal/statistics-mutator.hpp
type LRU (line 33) | namespace LRU {
type Internal (line 34) | namespace Internal {
class StatisticsMutator (line 54) | class StatisticsMutator {
method StatisticsMutator (line 59) | StatisticsMutator() noexcept = default;
method StatisticsMutator (line 64) | StatisticsMutator(const StatisticsPointer& stats) // NOLINT(runti...
method StatisticsMutator (line 72) | StatisticsMutator(StatisticsPointer&& stats) // NOLINT(runtime/ex...
method register_hit (line 79) | void register_hit(const Key& key) {
method register_miss (line 94) | void register_miss(const Key& key) {
method StatisticsPointer (line 118) | StatisticsPointer& shared() noexcept {
method StatisticsPointer (line 123) | const StatisticsPointer& shared() const noexcept {
method has_stats (line 128) | bool has_stats() const noexcept {
method reset (line 138) | void reset() {
FILE: include/lru/internal/timed-information.hpp
type LRU (line 33) | namespace LRU {
type Internal (line 34) | namespace Internal {
type TimedInformation (line 44) | struct TimedInformation : public Information<Key, Value> {
method TimedInformation (line 54) | TimedInformation(const Value& value_,
method TimedInformation (line 66) | explicit TimedInformation(const Value& value_,
method TimedInformation (line 73) | TimedInformation(QueueIterator order_, ValueArguments&&... value_a...
method TimedInformation (line 81) | explicit TimedInformation(
FILE: include/lru/internal/utility.hpp
type LRU (line 30) | namespace LRU {
type Internal (line 31) | namespace Internal {
function tuple_indices (line 37) | constexpr auto tuple_indices(const std::tuple<Ts...>&) {
function T (line 48) | constexpr T construct_from_tuple(const std::tuple<Args...>& arguments,
function T (line 58) | constexpr T construct_from_tuple(const std::tuple<Args...>& args) {
function T (line 67) | constexpr T construct_from_tuple(std::tuple<Args...>&& args) {
function static_all_of (line 103) | constexpr bool static_all_of() noexcept {
function static_all_of (line 112) | constexpr bool static_all_of(Head&& head, Tail&&... tail) {
function static_any_of (line 118) | constexpr bool static_any_of() noexcept {
function static_any_of (line 128) | constexpr bool static_any_of(Head&& head, Tail&&... tail) {
function static_none_of (line 138) | constexpr bool static_none_of(Ts&&... ts) {
function for_each (line 161) | void for_each(Function) noexcept {
function for_each (line 170) | void for_each(Function function, Head&& head, Tail&&... tail) {
FILE: include/lru/iterator-tags.hpp
type LRU (line 25) | namespace LRU {
type Tag (line 26) | namespace Tag {
type OrderedIterator (line 27) | struct OrderedIterator {}
type UnorderedIterator (line 28) | struct UnorderedIterator {}
type Lowercase (line 31) | namespace Lowercase {
type tag (line 32) | namespace tag {
FILE: include/lru/key-statistics.hpp
type LRU (line 28) | namespace LRU {
type KeyStatistics (line 35) | struct KeyStatistics {
method KeyStatistics (line 42) | explicit KeyStatistics(size_t hits_ = 0, size_t misses_ = 0)
method accesses (line 48) | size_t accesses() const noexcept {
method reset (line 53) | void reset() {
FILE: include/lru/lowercase.hpp
type LRU (line 27) | namespace LRU {
FILE: include/lru/statistics.hpp
type LRU (line 37) | namespace LRU {
type Internal (line 38) | namespace Internal {
class StatisticsMutator (line 40) | class StatisticsMutator
class Statistics (line 54) | class Statistics {
method Statistics (line 60) | Statistics() noexcept : _total_accesses(0), _total_hits(0) {
method Statistics (line 68) | explicit Statistics(Keys&&... keys) : Statistics() {
method Statistics (line 80) | explicit Statistics(const Range& range)
method Statistics (line 90) | Statistics(Iterator begin, Iterator end) : Statistics() {
method Statistics (line 99) | Statistics(InitializerList list) // NOLINT(runtime/explicit)
method total_accesses (line 104) | size_t total_accesses() const noexcept {
method total_hits (line 109) | size_t total_hits() const noexcept {
method total_misses (line 114) | size_t total_misses() const noexcept {
method hit_rate (line 119) | double hit_rate() const noexcept {
method miss_rate (line 124) | double miss_rate() const noexcept {
method hits_for (line 131) | size_t hits_for(const Key& key) const {
method misses_for (line 138) | size_t misses_for(const Key& key) const {
method accesses_for (line 145) | size_t accesses_for(const Key& key) const {
method KeyStatistics (line 152) | const KeyStatistics& stats_for(const Key& key) const {
method KeyStatistics (line 162) | const KeyStatistics& operator[](const Key& key) const {
method monitor (line 172) | void monitor(const Key& key) {
method unmonitor (line 182) | void unmonitor(const Key& key) {
method unmonitor_all (line 192) | void unmonitor_all() {
method reset_key (line 199) | void reset_key(const Key& key) {
method reset_all (line 209) | void reset_all() {
method is_monitoring (line 218) | bool is_monitoring(const Key& key) const noexcept {
method number_of_monitored_keys (line 223) | size_t number_of_monitored_keys() const noexcept {
method is_monitoring_keys (line 229) | bool is_monitoring_keys() const noexcept {
type Lowercase (line 249) | namespace Lowercase {
FILE: include/lru/timed-cache.hpp
type LRU (line 41) | namespace LRU {
type Internal (line 42) | namespace Internal {
class TimedCache (line 73) | class TimedCache
method TimedCache (line 89) | explicit TimedCache(const AnyDurationType& time_to_live,
method TimedCache (line 102) | TimedCache(const AnyDurationType& time_to_live,
method TimedCache (line 116) | TimedCache(const AnyDurationType& time_to_live,
method TimedCache (line 131) | TimedCache(const AnyDurationType& time_to_live,
method TimedCache (line 146) | explicit TimedCache(const AnyDurationType& time_to_live,
method TimedCache (line 158) | TimedCache(const AnyDurationType& time_to_live,
method TimedCache (line 171) | TimedCache(const AnyDurationType& time_to_live,
method swap (line 181) | void swap(TimedCache& other) noexcept {
method swap (line 192) | void swap(TimedCache& first, TimedCache& second) noexcept {
method UnorderedIterator (line 197) | UnorderedIterator find(const Key& key) override {
method UnorderedConstIterator (line 214) | UnorderedConstIterator find(const Key& key) const override {
method all_expired (line 234) | bool all_expired() const {
method clear_expired (line 247) | size_t clear_expired() {
method has_expired (line 276) | bool has_expired(const Key& key) const noexcept {
method has_expired (line 284) | bool has_expired(OrderedConstIterator ordered_iterator) const noexce...
method has_expired (line 295) | bool has_expired(UnorderedConstIterator unordered_iterator) const no...
method is_valid (line 303) | bool is_valid(UnorderedConstIterator unordered_iterator) const
method is_valid (line 311) | bool is_valid(OrderedConstIterator ordered_iterator) const noexcept ...
method throw_if_invalid (line 320) | void
method throw_if_invalid (line 331) | void throw_if_invalid(OrderedConstIterator ordered_iterator) const o...
method _last_accessed_is_ok (line 344) | bool _last_accessed_is_ok(const Key& key) const noexcept override {
method Value (line 350) | Value& _value_for_last_accessed() override {
method Value (line 362) | const Value& _value_for_last_accessed() const override {
method _has_expired (line 375) | bool _has_expired(const Information& information) const noexcept {
type Lowercase (line 384) | namespace Lowercase {
FILE: include/lru/wrap.hpp
type LRU (line 34) | namespace LRU {
function wrap (line 50) | auto wrap(Function original_function, Args&&... args) {
function timed_wrap (line 92) | auto timed_wrap(Function original_function, Duration duration, Args&&....
FILE: tests/cache-test.cpp
type CacheTest (line 34) | struct CacheTest : public ::testing::Test {
method is_equal_to_range (line 38) | bool is_equal_to_range(const Cache& cache, const Range& range) {
function TEST (line 46) | TEST(CacheConstructionTest, IsConstructibleFromInitializerList) {
function TEST (line 58) | TEST(CacheConstructionTest, IsConstructibleFromInitializerListWithCapaci...
function TEST (line 72) | TEST(CacheConstructionTest, IsConstructibleFromRange) {
function TEST (line 85) | TEST(CacheConstructionTest, IsConstructibleFromIterators) {
function TEST (line 98) | TEST(CacheConstructionTest, CapacityIsMaxOfInternalDefaultAndIteratorDis...
function TEST (line 117) | TEST(CacheConstructionTest, UsesCustomHashFunction) {
function TEST (line 134) | TEST(CacheConstructionTest, UsesCustomKeyEqual) {
function TEST_F (line 153) | TEST_F(CacheTest, ContainsAfterInsertion) {
function TEST_F (line 166) | TEST_F(CacheTest, ContainsAfteEmplacement) {
function TEST_F (line 179) | TEST_F(CacheTest, RemovesLRUElementWhenFull) {
function TEST_F (line 197) | TEST_F(CacheTest, LookupReturnsTheRightValue) {
function TEST_F (line 207) | TEST_F(CacheTest, LookupOnlyThrowsWhenKeyNotFound) {
function TEST_F (line 220) | TEST_F(CacheTest, SizeIsUpdatedProperly) {
function TEST_F (line 238) | TEST_F(CacheTest, SpaceLeftWorks) {
function TEST_F (line 250) | TEST_F(CacheTest, IsEmptyWorks) {
function TEST_F (line 258) | TEST_F(CacheTest, IsFullWorks) {
function TEST_F (line 273) | TEST_F(CacheTest, CapacityCanBeAdjusted) {
function TEST_F (line 306) | TEST_F(CacheTest, EraseErasesAndReturnsTrueWhenElementContained) {
function TEST_F (line 314) | TEST_F(CacheTest, EraseReturnsFalseWhenElementNotContained) {
function TEST_F (line 319) | TEST_F(CacheTest, ClearRemovesAllElements) {
function TEST_F (line 329) | TEST_F(CacheTest, ShrinkAdjustsSizeWell) {
function TEST_F (line 353) | TEST_F(CacheTest, ShrinkDoesNothingWhenRequestedSizeIsGreaterThanCurrent) {
function TEST_F (line 364) | TEST_F(CacheTest, ShrinkRemovesLRUElements) {
function TEST_F (line 386) | TEST_F(CacheTest, CanInsertIterators) {
function TEST_F (line 403) | TEST_F(CacheTest, CanInsertRange) {
function TEST_F (line 411) | TEST_F(CacheTest, CanInsertList) {
function TEST_F (line 421) | TEST_F(CacheTest, ResultIsCorrectForInsert) {
function TEST_F (line 437) | TEST_F(CacheTest, ResultIsCorrectForEmplace) {
function TEST_F (line 453) | TEST_F(CacheTest, CapacityIsSameAfterCopy) {
function TEST_F (line 460) | TEST_F(CacheTest, CapacityIsSameAfterMove) {
function TEST_F (line 467) | TEST_F(CacheTest, ComparisonOperatorWorks) {
function TEST_F (line 485) | TEST_F(CacheTest, SwapWorks) {
function TEST_F (line 502) | TEST_F(CacheTest, SizeStaysZeroWhenCapacityZero) {
function TEST_F (line 523) | TEST_F(CacheTest, LookupsMoveElementsToFront) {
FILE: tests/callback-test.cpp
type CallbackTest (line 30) | struct CallbackTest : public ::testing::Test {
function TEST_F (line 34) | TEST_F(CallbackTest, HitCallbacksGetCalled) {
function TEST_F (line 69) | TEST_F(CallbackTest, MissCallbacksGetCalled) {
function TEST_F (line 97) | TEST_F(CallbackTest, AccessCallbacksGetCalled) {
function TEST_F (line 131) | TEST_F(CallbackTest, CallbacksAreNotCalledAfterBeingCleared) {
FILE: tests/iterator-test.cpp
type IteratorTest (line 32) | struct IteratorTest : public ::testing::Test {
function TEST_F (line 42) | TEST_F(IteratorTest, UnorderedIteratorsAreCompatibleAsExpected) {
function TEST_F (line 66) | TEST_F(IteratorTest, OrderedIteratorsAreCompatibleAsExpected) {
function TEST_F (line 90) | TEST_F(IteratorTest, OrderedAndUnorderedAreComparable) {
function TEST_F (line 121) | TEST_F(IteratorTest, TestConversionFromUnorderedToOrdered) {
function TEST_F (line 157) | TEST_F(IteratorTest, OrdereredIteratorsAreOrdered) {
function TEST_F (line 168) | TEST_F(IteratorTest, OrderedIteratorsDoNotChangeTheOrderOfElements) {
function TEST_F (line 188) | TEST_F(IteratorTest, UnorderedIteratorsDoNotChangeTheOrderOfElements) {
function TEST_F (line 208) | TEST_F(IteratorTest, OrderedIteratorsThrowWhenAccessingExpiredElements) {
function TEST_F (line 218) | TEST_F(IteratorTest, UnorderedIteratorsThrowWhenAccessingExpiredElements) {
function TEST_F (line 228) | TEST_F(IteratorTest, IsValidReturnsTrueForValidIterators) {
function TEST_F (line 241) | TEST_F(IteratorTest, IsValidReturnsFalseForInvalidIterators) {
function TEST_F (line 255) | TEST_F(IteratorTest, ThrowIfInvalidThrowsAsExpected) {
function TEST_F (line 275) | TEST_F(IteratorTest, DereferencingNeverThrows) {
function TEST_F (line 293) | TEST_F(IteratorTest, CallingAccessThrowsForInvalidIterators) {
FILE: tests/last-accessed-test.cpp
type LastAccessedTest (line 32) | struct LastAccessedTest : public ::testing::Test {
function TEST_F (line 45) | TEST_F(LastAccessedTest, IsAssignableFromConstAndNonConst) {
function TEST_F (line 64) | TEST_F(LastAccessedTest, IsComparableWithConstAndNonConstIterators) {
function TEST_F (line 87) | TEST_F(LastAccessedTest, IsComparableToConstAndNonConstKeys) {
FILE: tests/move-aware-dummies.hpp
type MoveAwareBase (line 27) | struct MoveAwareBase {
method reset (line 33) | static void reset() {
method MoveAwareBase (line 40) | MoveAwareBase(const MoveAwareBase& other) : s(other.s) {
method MoveAwareBase (line 44) | MoveAwareBase(MoveAwareBase&& other) : s(std::move(other.s)) {
method MoveAwareBase (line 49) | MoveAwareBase(std::string&& s_) : s(std::move(s_)) {
method MoveAwareBase (line 53) | MoveAwareBase(std::string& s_) : s(s_) {
method MoveAwareBase (line 57) | MoveAwareBase(const char* s_) : s(s_) {
method MoveAwareBase (line 61) | MoveAwareBase(const int& x, const double& y)
method MoveAwareBase (line 66) | MoveAwareBase(int&& x, double&& y)
method MoveAwareBase (line 73) | MoveAwareBase& operator=(const MoveAwareBase& other) {
method MoveAwareBase (line 79) | MoveAwareBase& operator=(MoveAwareBase&& other) {
type MoveAwareKey (line 107) | struct MoveAwareKey : public MoveAwareBase<MoveAwareKey> {
method MoveAwareKey (line 111) | MoveAwareKey() = default;
method MoveAwareKey (line 112) | MoveAwareKey(const MoveAwareKey& other) : super(other) {}
method MoveAwareKey (line 113) | MoveAwareKey(MoveAwareKey&& other) : super(std::move(other)) {}
method MoveAwareKey (line 114) | MoveAwareKey(std::string&& s_) : super(std::move(s_)) {}
method MoveAwareKey (line 115) | MoveAwareKey(std::string& s_) : super(s_) {}
method MoveAwareKey (line 116) | MoveAwareKey(const char* s_) : super(s_) {}
method MoveAwareKey (line 117) | MoveAwareKey(const int& x, const double& y) : super(x, y) {}
method MoveAwareKey (line 118) | MoveAwareKey(int&& x, double&& y) : super(std::move(x), std::move(y)) {}
method MoveAwareKey (line 121) | MoveAwareKey& operator=(const MoveAwareKey& other) {
method MoveAwareKey (line 126) | MoveAwareKey& operator=(MoveAwareKey&& other) {
type MoveAwareValue (line 132) | struct MoveAwareValue : public MoveAwareBase<MoveAwareValue> {
method MoveAwareValue (line 136) | MoveAwareValue() = default;
method MoveAwareValue (line 137) | MoveAwareValue(const MoveAwareValue& other) : super(other) {}
method MoveAwareValue (line 138) | MoveAwareValue(MoveAwareValue&& other) : super(std::move(other)) {}
method MoveAwareValue (line 139) | MoveAwareValue(std::string&& s_) : super(std::move(s_)) {}
method MoveAwareValue (line 140) | MoveAwareValue(std::string& s_) : super(s_) {}
method MoveAwareValue (line 141) | MoveAwareValue(const char* s_) : super(s_) {}
method MoveAwareValue (line 142) | MoveAwareValue(const int& x, const double& y) : super(x, y) {}
method MoveAwareValue (line 143) | MoveAwareValue(int&& x, double&& y) : super(std::move(x), std::move(y)...
method MoveAwareValue (line 146) | MoveAwareValue& operator=(const MoveAwareValue& other) {
method MoveAwareValue (line 151) | MoveAwareValue& operator=(MoveAwareValue&& other) {
type std (line 157) | namespace std {
type hash<MoveAwareKey> (line 159) | struct hash<MoveAwareKey> {
type hash<MoveAwareValue> (line 166) | struct hash<MoveAwareValue> {
FILE: tests/move-awareness-test.cpp
type MoveAwarenessTest (line 30) | struct MoveAwarenessTest : public ::testing::Test {
method MoveAwarenessTest (line 31) | MoveAwarenessTest() {
function TEST_F (line 39) | TEST_F(MoveAwarenessTest, DoesNotMoveForInsert) {
function TEST_F (line 55) | TEST_F(MoveAwarenessTest, ForwardsValuesWell) {
function TEST_F (line 68) | TEST_F(MoveAwarenessTest, MovesSingleRValues) {
function TEST_F (line 84) | TEST_F(MoveAwarenessTest, CopiesSingleLValues) {
function TEST_F (line 102) | TEST_F(MoveAwarenessTest, MovesRValueTuples) {
function TEST_F (line 119) | TEST_F(MoveAwarenessTest, MovesLValueTuples) {
function TEST_F (line 139) | TEST_F(MoveAwarenessTest, MovesElementsOutOfRValueRanges) {
FILE: tests/statistics-test.cpp
function TEST (line 33) | TEST(StatisticsTest, ConstructsWellFromRange) {
function TEST (line 42) | TEST(StatisticsTest, ConstructsWellFromIterator) {
function TEST (line 51) | TEST(StatisticsTest, ConstructsWellFromInitializerList) {
function TEST (line 60) | TEST(StatisticsTest, ConstructsWellFromVariadicArguments) {
function TEST (line 69) | TEST(StatisticsTest, EmptyPreconditions) {
function TEST (line 81) | TEST(StatisticsTest, StatisticsMutatorCanRegisterHits) {
function TEST (line 111) | TEST(StatisticsTest, StatisticsMutatorCanRegisterMisses) {
function TEST (line 141) | TEST(StatisticsTest, CanDynamicallyMonitorAndUnmonitorKeys) {
function TEST (line 171) | TEST(StatisticsTest, ThrowsForUnmonitoredKey) {
function TEST (line 180) | TEST(StatisticsTest, RatesAreCalculatedCorrectly) {
function TEST (line 196) | TEST(StatisticsTest, CanShareStatistics) {
type CacheWithStatisticsTest (line 228) | struct CacheWithStatisticsTest : public ::testing::Test {
method assert_total_stats (line 229) | void assert_total_stats(int accesses, int hits, int misses) {
method expect_total_stats (line 235) | void expect_total_stats(int accesses, int hits, int misses) {
function TEST_F (line 244) | TEST_F(CacheWithStatisticsTest,
function TEST_F (line 249) | TEST_F(CacheWithStatisticsTest, CanRegisterLValueStatistics) {
function TEST_F (line 270) | TEST_F(CacheWithStatisticsTest, CanRegisterRValueStatistics) {
function TEST_F (line 288) | TEST_F(CacheWithStatisticsTest, CanConstructItsOwnStatistics) {
function TEST_F (line 308) | TEST_F(CacheWithStatisticsTest, KnowsWhenItIsMonitoring) {
function TEST_F (line 320) | TEST_F(CacheWithStatisticsTest, StatisticsWorkWithCache) {
function TEST_F (line 363) | TEST_F(CacheWithStatisticsTest, StopsMonitoringWhenAsked) {
FILE: tests/timed-cache-test.cpp
function TEST (line 34) | TEST(TimedCacheTest, ContainsRespectsExpiration) {
function TEST (line 51) | TEST(TimedCacheTest, KnowsWhenAllKeysHaveExpired) {
function TEST (line 80) | TEST(TimedCacheTest, CleanExpiredRemovesExpiredElements) {
function TEST (line 111) | TEST(TimedCacheTest, LookupThrowsWhenKeyExpired) {
function TEST (line 121) | TEST(TimedCacheTest, HasExpiredReturnsFalseForNonContainedKeys) {
function TEST (line 128) | TEST(TimedCacheTest, HasExpiredReturnsFalseForContainedButNotExpiredKeys) {
function TEST (line 138) | TEST(TimedCacheTest, HasExpiredReturnsTrueForContainedAndExpiredKeys) {
function TEST (line 160) | TEST(TimedCacheTest, LookupsMoveElementsToFront) {
FILE: tests/wrap-test.cpp
function TEST (line 28) | TEST(WrapTest, CanWrapMutableAndNonMutableLambdas) {
function TEST (line 34) | TEST(WrapTest, WrappingWorks) {
function TEST (line 47) | TEST(WrapTest, CanPassCapacityArgumentToWrap) {
function TEST (line 69) | TEST(WrapTest, CanPassTimeArgumentToTimedCacheWrap) {
Condensed preview — 52 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (399K chars).
[
{
"path": ".clang-format",
"chars": 897,
"preview": "Language: Cpp\nStandard: Cpp11\nBasedOnStyle: Google\n\nAllowAllParametersOfDeclarationOnNextLine: true\nAllowShortBlocksOnAS"
},
{
"path": ".gitignore",
"chars": 514,
"preview": "\n# Created by https://www.gitignore.io/api/c++,cmake\n\n### C++ ###\n# Prerequisites\n*.d\n\n# Compiled Object files\n*.slo\n*.l"
},
{
"path": ".gitmodules",
"chars": 100,
"preview": "[submodule \"tests/googletest\"]\n\tpath = tests/googletest\n\turl = https://github.com/google/googletest\n"
},
{
"path": ".travis.yml",
"chars": 1900,
"preview": "# http://genbattle.bitbucket.org/blog/2016/01/17/c++-travis-ci/\n# https://github.com/whoshuu/cpr/blob/master/.travis.yml"
},
{
"path": "CMakeLists.txt",
"chars": 1850,
"preview": "###########################################################\n## CMAKE SETUP\n#############################################"
},
{
"path": "LICENSE",
"chars": 1084,
"preview": "The MIT License (MIT)\nCopyright (c) 2016 Peter Goldsborough\n\nPermission is hereby granted, free of charge, to any person"
},
{
"path": "README.md",
"chars": 11894,
"preview": "# lru-cache\n\n[](http://g"
},
{
"path": "cpplint.cfg",
"chars": 106,
"preview": "# cpplint configuration\n\nfilter=-build/c++11,-whitespace/parens,-runtime/references,-whitespace/operators\n"
},
{
"path": "docs/Doxyfile",
"chars": 100799,
"preview": "# Doxyfile 1.8.6\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) "
},
{
"path": "examples/CMakeLists.txt",
"chars": 552,
"preview": "###########################################################\n## BINARIES\n################################################"
},
{
"path": "examples/callbacks.cpp",
"chars": 2682,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "examples/fibonacci-basic.cpp",
"chars": 2102,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "examples/fibonacci-timed.cpp",
"chars": 2095,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "examples/lowercase.cpp",
"chars": 1683,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "examples/statistics.cpp",
"chars": 2877,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "examples/wrap.cpp",
"chars": 1635,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/cache-tags.hpp",
"chars": 1538,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/cache.hpp",
"chars": 7242,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/entry.hpp",
"chars": 4630,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/error.hpp",
"chars": 3696,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/insertion-result.hpp",
"chars": 2638,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/base-cache.hpp",
"chars": 57507,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/base-iterator.hpp",
"chars": 7457,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/base-ordered-iterator.hpp",
"chars": 12257,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/base-unordered-iterator.hpp",
"chars": 7601,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/callback-manager.hpp",
"chars": 5491,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/definitions.hpp",
"chars": 3119,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/hash.hpp",
"chars": 2381,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/information.hpp",
"chars": 5615,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/last-accessed.hpp",
"chars": 8862,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/optional.hpp",
"chars": 5989,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/statistics-mutator.hpp",
"chars": 5049,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/timed-information.hpp",
"chars": 4478,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/internal/utility.hpp",
"chars": 6686,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/iterator-tags.hpp",
"chars": 1583,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/key-statistics.hpp",
"chars": 2256,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/lowercase.hpp",
"chars": 1384,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/lru.hpp",
"chars": 1413,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/statistics.hpp",
"chars": 8091,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/timed-cache.hpp",
"chars": 14448,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "include/lru/wrap.hpp",
"chars": 3800,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/CMakeLists.txt",
"chars": 1309,
"preview": "########################################\n# CONFIG\n########################################\n\nadd_compile_options(-g -Werr"
},
{
"path": "tests/cache-test.cpp",
"chars": 13917,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/callback-test.cpp",
"chars": 3997,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/iterator-test.cpp",
"chars": 10036,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/last-accessed-test.cpp",
"chars": 3413,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/logbt.sh",
"chars": 5019,
"preview": "#!/bin/bash\n\n# Taken from:\n# https://github.com/mapbox/logbt\n\nset -eu\nset -o pipefail\nshopt -s nullglob\n\nexport CORE_DIR"
},
{
"path": "tests/move-aware-dummies.hpp",
"chars": 5048,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/move-awareness-test.cpp",
"chars": 4827,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/statistics-test.cpp",
"chars": 10774,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/timed-cache-test.cpp",
"chars": 4672,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
},
{
"path": "tests/wrap-test.cpp",
"chars": 2570,
"preview": "/// The MIT License (MIT)\n/// Copyright (c) 2016 Peter Goldsborough\n///\n/// Permission is hereby granted, free of charge"
}
]
About this extraction
This page contains the full source code of the goldsborough/lru-cache GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 52 files (374.6 KB), approximately 91.6k tokens, and a symbol index with 558 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.