KraView  Changes On Branch complete

cmake_minimum_required(VERSION 3.6)

project(
  fifrgraph
  VERSION 0.1.0
  LANGUAGES CXX)

add_subdirectory(src/fifr/graph)

# Enable testing if this is toplevel.
if ( BUILD_TESTING AND (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) )
  enable_testing()
  add_subdirectory(tests)
endif ()


# package stuff

include(CMakePackageConfigHelpers)
write_basic_package_version_file(
  "${CMAKE_CURRENT_BINARY_DIR}/FifrGraph/FifrGraphConfigVersion.cmake"
  VERSION ${fifrgraph_VERSION}
  COMPATIBILITY SameMajorVersion
  )

export(
  EXPORT FifrGraphTargets
  FILE "${CMAKE_CURRENT_BINARY_DIR}/FifrGraph/FifrGraphTargets.cmake"
  NAMESPACE Fifr::
  )
configure_file(cmake/FifrGraphConfig.cmake
  "${CMAKE_CURRENT_BINARY_DIR}/FifrGraph/FifrGraphConfig.cmake"
  COPYONLY)

set(ConfigPackageLocation lib/cmake/FifrGraph)
install(EXPORT FifrGraphTargets
  FILE FifrGraphTargets.cmake
  NAMESPACE Fifr::
  DESTINATION ${ConfigPackageLocation}
  )
install(
  FILES
  cmake/FifrGraphConfig.cmake
  "${CMAKE_CURRENT_BINARY_DIR}/FifrGraph/FifrGraphConfigVersion.cmake"
  DESTINATION ${ConfigPackageLocation}
  COMPONENT
  devel
  )

include("${CMAKE_CURRENT_LIST_DIR}/FifrGraphTargets.cmake")

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef __FIFR_GRAPH_ATTRIBUTEDGRAPH_HXX__
#define __FIFR_GRAPH_ATTRIBUTEDGRAPH_HXX__

#include <iosfwd>
#include <vector>

namespace fifr {
namespace graph {
template <typename Graph, typename G, typename V, typename E>
class AttributedGraph : public Graph
{
public:
    using size_type = typename Graph::size_type;
    using node_type = typename Graph::node_type;
    using edge_type = typename Graph::edge_type;
    using id_type = typename Graph::id_type;

    class builder : protected Graph::builder
    {
        friend class AttributedGraph;

    public:
        explicit builder(size_type node_capacity = 0, size_type edge_capacity = 0)
            : Graph::builder(node_capacity, edge_capacity)
        {
            node_attrs_.reserve(node_capacity);
            edge_attrs_.reserve(edge_capacity);
        }

        explicit builder(G attrs) : attrs_(std::move(attrs)) {}

        node_type add_node(V v = {})
        {
            node_attrs_.push_back(v);
            return Graph::builder::add_node();
        }

        std::vector<node_type> add_nodes(size_type n)
        {
            node_attrs_.resize(node_attrs_.size() + n, {});
            return Graph::builder::add_nodes(n);
        }

        std::vector<node_type> add_nodes(const std::vector<V>& attrs)
        {
            auto n = attrs.size();
            for (auto&& v : attrs) {
                node_attrs_.push_back(std::move(v));
            }
            return Graph::builder::add_nodes(n);
        }

        using Graph::builder::id2node;
        using Graph::builder::node_id;

        V& node(node_type u) { return node_attrs_.at(Graph::builder::node_id(u)); }

        const V& node(node_type u) const { return node_attrs_.at(Graph::builder::node_id(u)); }

        edge_type add_edge(node_type u, node_type v, E e = {})
        {
            edge_attrs_.push_back(std::move(e));
            return Graph::builder::add_edge(u, v);
        }

        using Graph::builder::edge_id;
        using Graph::builder::id2edge;

        E& edge(edge_type e) { return edge_attrs_.at(Graph::builder::edge_id(e)); }

        const E& edge(edge_type e) const { return edge_attrs_.at(Graph::builder::edge_id(e)); }

    private:
        G attrs_;
        std::vector<V> node_attrs_;
        std::vector<E> edge_attrs_;
    };

public:
    AttributedGraph() = default;

    AttributedGraph(AttributedGraph&& g) noexcept = default;
    explicit AttributedGraph(const AttributedGraph& g) = default;
    AttributedGraph& operator=(AttributedGraph&& g) noexcept = default;
    AttributedGraph& operator=(const AttributedGraph& g) = delete;
    ~AttributedGraph() = default;

    explicit AttributedGraph(builder&& b)
        : Graph(std::move(b)),
          attrs_(std::move(b.attrs_)),
          node_attrs_(std::move(b.node_attrs_)),
          edge_attrs_(std::move(b.edge_attrs_))
    {
    }

    explicit AttributedGraph(typename Graph::builder&& b)
        : Graph(std::move(b)), attrs_{}, node_attrs_(Graph::num_nodes()), edge_attrs_(Graph::num_edges())
    {
    }

    G& attr() { return attrs_; }
    const G& attr() const { return attrs_; }

    G& operator*() { return attrs_; }
    const G& operator*() const { return attrs_; }

    G* operator->() { return &attrs_; }
    const G* operator->() const { return &attrs_; }

    V& node(node_type u) { return node_attrs_[Graph::node_id(u)]; }
    const V& node(node_type u) const { return node_attrs_[Graph::node_id(u)]; }

    V& operator[](node_type u) { return node(u); }
    const V& operator[](node_type u) const { return node(u); }

    E& edge(edge_type e) { return edge_attrs_[Graph::edge_id(e)]; }
    const E& edge(edge_type e) const { return edge_attrs_[Graph::edge_id(e)]; }

    E& operator[](edge_type e) { return edge(e); }
    const E& operator[](edge_type e) const { return edge(e); }

    template <typename Gr_, typename G_, typename V_, typename E_>
    friend std::ostream& operator<<(std::ostream& out, const AttributedGraph<Gr_, G_, V_, E_>& g);
    template <typename Gr_, typename G_, typename V_, typename E_>
    friend std::istream& operator>>(std::istream& in, AttributedGraph<Gr_, G_, V_, E_>& g);

private:
    G attrs_;
    std::vector<V> node_attrs_;
    std::vector<E> edge_attrs_;
};

}  // namespace graph
}  // namespace fifr

#endif

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "AttributedGraph.hxx"

#include <fifr/util/PrettyStruct.hxx>

namespace fifr {
namespace graph {
template <typename Graph, typename G, typename V, typename E>
std::ostream& operator<<(std::ostream& out, const AttributedGraph<Graph, G, V, E>& g)
{
    fifr::util::pretty_print_struct_multiline(out,
                                              "AttributedGraph",
                                              "graph",
                                              static_cast<const Graph&>(g),
                                              "attrs",
                                              g.attrs_,
                                              "nodes",
                                              fifr::util::multiline(g.node_attrs_),
                                              "edges",
                                              fifr::util::multiline(g.edge_attrs_));
    return out;
}

template <typename Graph, typename G, typename V, typename E>
std::istream& operator>>(std::istream& in, AttributedGraph<Graph, G, V, E>& g)
{
    fifr::util::pretty_read_struct(in,
                                   "AttributedGraph",
                                   "graph",
                                   static_cast<Graph&>(g),
                                   "attrs",
                                   g.attrs_,
                                   "nodes",
                                   g.node_attrs_,
                                   "edges",
                                   g.edge_attrs_);
    if (g.node_attrs_.size() != g.num_nodes()) {
        throw fifr::util::ReadError("Invalid number of node attributes");
    }
    if (g.edge_attrs_.size() != g.num_edges()) {
        throw fifr::util::ReadError("Invalid number of edge attributes");
    }
    return in;
}
}  // namespace graph
}  // namespace fifr

cmake_minimum_required(VERSION 3.6)

cmake_policy(SET CMP0063 NEW)

add_library(Graph STATIC
  Grav.cxx
  LinkedListGraph.cxx
  LinkedListGraphIO.cxx)
add_library(Fifr::Graph ALIAS Graph)

set_property(TARGET Graph PROPERTY OUTPUT_NAME fifrgraph)
target_compile_features(Graph PUBLIC cxx_std_20)

if (CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
  target_compile_options(Graph PRIVATE -W -Wall -pedantic)
endif ()

# Packages

if (NOT TARGET Fifr::Util)
  find_package(FifrUtil REQUIRED)
endif()
target_link_libraries(Graph Fifr::Util)

# Install stuff

target_include_directories(Graph INTERFACE
  $<INSTALL_INTERFACE:include>
  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../..>)

install(
  TARGETS Graph
  EXPORT FifrGraphTargets
  ARCHIVE DESTINATION lib
  LIBRARY DESTINATION lib
  INCLUDES DESTINATION include
  )

install(
  DIRECTORY .
  DESTINATION include/fifr/graph
  COMPONENT headers
  FILES_MATCHING PATTERN "*.hxx"
  )

/*
 * Copyright (c) 2024 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef __FIFR_GRAPH_CLASSES_HXX__
#define __FIFR_GRAPH_CLASSES_HXX__

#include <cstddef>
#include <memory>

namespace fifr {
namespace graph {
/// Return a cycle.
///
/// If the graph is directed the cycle will be a directed cycle.
template <typename G>
G cycle(std::size_t n)
{
    typename G::builder builder(n, n);
    auto nodes = builder.add_nodes(n);
    for (std::size_t i = 0; i < nodes.size(); ++i) {
        builder.add_edge(nodes[i], nodes[(i + 1) % nodes.size()]);
    }
    return G(std::move(builder));
}

/// Return a complete bipartite graph.
///
/// The edges are directed from the `n` to the `m` nodes.
template <typename G>
G complete_bipartite(std::size_t n, std::size_t m)
{
    typename G::builder builder(n + m, n * m);
    auto a_nodes = builder.add_nodes(n);
    auto b_nodes = builder.add_nodes(m);
    for (auto u : a_nodes) {
        for (auto v : b_nodes) {
            builder.add_edge(u, v);
        }
    }
    return G(std::move(builder));
}

/// Return a Peterson graph.
template <typename G>
G peterson()
{
    typename G::builder builder(10, 15);
    auto nodes = builder.add_nodes(10);
    for (std::size_t i = 0; i < 5; i++) {
        builder.add_edge(nodes[i], nodes[(i + 1) % 5]);
        builder.add_edge(nodes[i + 5], nodes[((i + 1) % 5) + 5]);
        builder.add_edge(nodes[i], nodes[i + 5]);
    }
    return G(std::move(builder));
}

/// Return a hypercube of dimension `d`.
template <typename G>
G hypercube(std::size_t d)
{
    // TODO: check size of d
    std::size_t n = 1 << d;
    typename G::builder builder(n, n * d);
    auto nodes = builder.add_nodes(n);
    for (std::size_t i = 0; i < n; i++) {
        for (std::size_t bit = 0; bit < d; bit++) {
            if ((i & (1 << bit)) == 0) {
                builder.add_edge(nodes[i], nodes[i | (1 << bit)]);
            }
        }
    }
    return G(std::move(builder));
}

}  // namespace graph
}  // namespace fifr

#endif

/*
 * Copyright (c) 2017 Frank Fischer
 *
 * This file is part of KraView.
 *
 * KraView is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * KraView is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with KraView.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "Grav.hxx"

#include <fifr/util/Convert.hxx>

#include <algorithm>
#include <charconv>
#include <istream>
#include <optional>
#include <sstream>
#include <unordered_map>
#include <utility>
#include <vector>

using namespace fifr::util;

namespace {
template <typename T>
auto str2num(const std::string& str, std::string::size_type beg, std::string::size_type& endpos) -> std::optional<T>
{
    T n;
    // Skip whitespace at the beginning
    while (beg < str.size() && isspace(str[beg]) != 0) {
        beg++;
    }
    auto result = std::from_chars(&str[beg], &str[str.size()], n);
    if (result.ec == std::errc()) {
        endpos = static_cast<std::string::size_type>(result.ptr - str.c_str());
        return {n};
    }
    endpos = beg;
    return std::nullopt;
}

std::optional<unsigned long> str2ul(const std::string& str, std::string::size_type beg, std::string::size_type& endpos)
{
    return str2num<unsigned long>(str, beg, endpos);
}

std::optional<unsigned> str2u(const std::string& str, std::string::size_type beg, std::string::size_type& endpos)
{
    return str2num<unsigned>(str, beg, endpos);
}

std::optional<double> str2d(const std::string& str, std::string::size_type beg, std::string::size_type& endpos)
{
    char* end = nullptr;
    auto n = std::strtod(str.c_str() + beg, &end);  // NOLINT
    if (end != nullptr && end >= str.c_str()) {
        endpos = static_cast<std::string::size_type>(end - str.c_str());
        return {n};
    }
    endpos = beg;
    return {};
}
}  // namespace

namespace fifr {
namespace graph {
namespace grav {
std::string Attributes::operator[](const std::string& attr) const
{
    for (auto&& it : *this) {
        if (it.first == attr) {
            return it.second;
        }
    }
    return {};
}

Attributes::const_iterator& Attributes::const_iterator::operator++()
{
    auto pos = data_.find('\0', pos_);
    if (pos != std::string::npos) {
        pos = data_.find('\0', pos + 1);
        if (pos != std::string::npos) {
            pos_ = pos + 1;
        } else {
            pos_ = data_.size();
        }
    } else {
        pos_ = data_.size();
    }
    return *this;
}

Attributes::const_iterator::value_type Attributes::const_iterator::operator*() const
{
    auto keyend = data_.find('\0', pos_);
    if (keyend == std::string::npos) {
        return {data_.substr(pos_), {}};
    }
    auto valend = data_.find('\0', keyend + 1);
    return {data_.substr(pos_, keyend - pos_), data_.substr(keyend + 1, valend - keyend - 1)};
}

static Net::Node add_node(Net::builder& net,
                          std::unordered_map<unsigned, Net::Node>& nodes_by_number,
                          size_type nodenumber,
                          NodeInfo nodedata)
{
    auto ret = nodes_by_number.insert({nodenumber, Net::nonode});

    if (ret.second) {
        ret.first->second = net.add_node(std::move(nodedata));
    } else {
        net.node(ret.first->second) = std::move(nodedata);
    }

    return ret.first->second;
}

static std::string::size_type parse_uint(const std::string& line, std::string::size_type pos, unsigned& n)
{
    std::string::size_type end;
    auto nn = str2u(line, pos, end);
    if (nn && (end == line.size() || isspace(line[end]) != 0)) {
        n = *nn;
        return end;
    }
    throw ReadError(std::string("Expected number, got '") + line.substr(pos) + "'");
}

static std::string::size_type parse_double(const std::string& line, std::string::size_type pos, double& n)
{
    std::string::size_type end;
    auto nn = str2d(line, pos, end);
    if (nn && (end == line.size() || isspace(line[end]) != 0)) {
        n = *nn;
        return end;
    }
    throw ReadError("Expected number, got '" + line.substr(pos) + "'");
}

static std::string::size_type parse_color(const std::string& line, std::string::size_type pos, Color& c)
{
    std::string::size_type end;

    auto r = str2ul(line, pos, end);
    if (!r || end >= line.size() || line[end] != ',') {
        throw ReadError("Invalid RGB color: " + line.substr(pos));
    }
    if (*r >= 256) {
        throw ReadError("Invalid red value in RGB color: " + line.substr(pos, end - pos));
    }

    pos = end + 1;
    auto g = str2ul(line, pos, end);
    if (!g || end >= line.size() || line[end] != ',') {
        throw ReadError("Invalid RGB color: " + line.substr(pos));
    }
    if (*g >= 256) {
        throw ReadError("Invalid green RGB color: " + line.substr(pos, end - pos));
    }

    pos = end + 1;
    auto b = str2ul(line, pos, end);
    if (!b || (end < line.size() && line[end] != ',' && isspace(line[end]) == 0)) {
        throw ReadError("Invalid RGB color: " + line.substr(pos));
    }
    if (end < line.size() && line[end] == ',') {
        // alpha value following
        pos = end + 1;
        auto a = str2d(line, pos, end);
        if (!a || (end < line.size() && isspace(line[end]) == 0)) {
            throw ReadError("Invalid RGB color: " + line.substr(pos));
        }
        if (a < -1e-6 || a > 1 + 1e-6) {
            throw ReadError("Invalid alpha value for color: " + line.substr(pos, end - pos));
        }
        c.alpha = *a;
    } else if (*b >= 256) {
        throw ReadError("Invalid blue RGB color: " + line.substr(pos, end - pos));
    }

    c.r = static_cast<uint8_t>(*r);
    c.g = static_cast<uint8_t>(*g);
    c.b = static_cast<uint8_t>(*b);

    return end;
}

static void parse_node_options(NodeInfo& node, const std::string& line, std::string::size_type pos, unsigned& desclen)
{
    desclen = 0;
    for (;;) {
        pos = line.find_first_not_of(" \t\r\n", pos);
        if (pos == std::string::npos) {
            break;
        }
        auto end = line.find_first_of(": \t\r\n", pos);
        if (end != std::string::npos && line[end] == ':') {
            if (line.compare(pos, end - pos, "x") == 0) {
                end = parse_double(line, end + 1, node.x);
            } else if (line.compare(pos, end - pos, "y") == 0) {
                end = parse_double(line, end + 1, node.y);
            } else if (line.compare(pos, end - pos, "weight") == 0) {
                end = parse_double(line, end + 1, node.weight);
            } else if (line.compare(pos, end - pos, "color") == 0) {
                end = parse_color(line, end + 1, node.color);
            } else if (line.compare(pos, end - pos, "desc") == 0) {
                end = parse_uint(line, end + 1, desclen);
            } else {
                throw ReadError("Unknown node option: " + line.substr(pos, end));
            }
        } else {
            if (end == std::string::npos) {
                end = line.size();
            }
            if (line.compare(pos, end - pos, "circ") == 0) {
                node.type = NodeType::Circle;
            } else if (line.compare(pos, end - pos, "disc") == 0) {
                node.type = NodeType::Disc;
            } else {
                throw ReadError("Unknown node option: " + line.substr(pos, end));
            }
        }
        pos = end;
    }
}

static Net::Node parse_node(Net::builder& net,
                            std::unordered_map<unsigned, Net::Node>& nodes_by_number,
                            const std::string& line,
                            std::string::size_type pos,
                            NodeInfo& defaultnode,
                            unsigned& desc)
{
    assert(line.size() < std::numeric_limits<std::string::size_type>::max());
    assert(line.size() < std::numeric_limits<unsigned>::max());

    desc = 0;

    std::string::size_type end;
    auto nodenr = str2ul(line, pos, end);

    if (end == line.size() || (isspace(line[end]) != 0)) {
        auto nodeid = add_node(net, nodes_by_number, *nodenr, defaultnode);
        auto& ndata = net.node(nodeid);
        if (end != line.size()) {
            parse_node_options(ndata, line, end, desc);
        }
        return nodeid;
    }
    parse_node_options(defaultnode, line, end, desc);
    if (desc > 0) {
        throw ReadError("Description not allowed for default options");
    }
    return Net::nonode;
}

static void parse_arc_options(EdgeInfo& edge, const std::string& line, std::string::size_type pos, unsigned& desclen)
{
    for (;;) {
        pos = line.find_first_not_of(" \t\r\n", pos);
        if (pos == std::string::npos) {
            break;
        }
        auto end = line.find(':', pos);
        if (end == std::string::npos) {
            throw ReadError("Unknown arc option: " + line.substr(pos, end));
        }
        if (line.compare(pos, end - pos, "flow") == 0) {
            end = parse_double(line, end + 1, edge.flow);
        } else if (line.compare(pos, end - pos, "cost") == 0) {
            end = parse_double(line, end + 1, edge.cost);
        } else if (line.compare(pos, end - pos, "color") == 0) {
            end = parse_color(line, end + 1, edge.color);
        } else if (line.compare(pos, end - pos, "desc") == 0) {
            end = parse_uint(line, end + 1, desclen);
        } else {
            throw ReadError("Unknown arc option: " + line.substr(pos, end));
        }
        pos = end;
    }
}

static Net::Edge parse_arc(Net::builder& net,
                           const std::unordered_map<unsigned, Net::Node>& nodes_by_number,
                           const std::string& line,
                           std::string::size_type pos,
                           EdgeInfo& defaultedge,
                           unsigned& desc)
{
    std::string::size_type end;
    auto srcnr = str2u(line, pos, end);
    if (srcnr && (end == line.size() || (isspace(line[end]) != 0))) {
        auto snknr = str2u(line, end, end);
        if (!snknr || (end < line.size() && (isspace(line[end]) == 0))) {
            throw ReadError("Invalid arc line: " + line);
        }

        auto srcit = nodes_by_number.find(*srcnr);
        if (srcit == nodes_by_number.end()) {
            throw ReadError("Unknown source node: " + std::to_string(*srcnr));
        }
        auto src = srcit->second;

        auto snkit = nodes_by_number.find(*snknr);
        if (snkit == nodes_by_number.end()) {
            throw ReadError("Unknown sink node: " + std::to_string(*snknr));
        }
        auto snk = snkit->second;

        auto arcid = net.add_edge(src, snk, defaultedge);
        parse_arc_options(net.edge(arcid), line, end, desc);
        return arcid;
    }
    parse_arc_options(defaultedge, line, end, desc);
    if (desc > 0) {
        throw ReadError("Description not allowed for default options");
    }

    return Net::noedge;
}

static Net read_net_from_lines(const NetSequence::getline_function& getline, size_type& lineno)
{
    NodeInfo defaultnode;
    defaultnode.x = 0;
    defaultnode.y = 0;
    defaultnode.color = Color{0, 0, 0, 1.0};
    defaultnode.type = NodeType::Circle;
    defaultnode.weight = 0;

    EdgeInfo defaultedge;
    defaultedge.color = Color{0, 0, 0, 1.0};
    defaultedge.flow = 0;
    defaultedge.cost = 0;

    Net::builder net;
    std::unordered_map<unsigned, Net::Node> nodes_by_number;

    std::string line;
    std::string desc;
    char* locale = setlocale(LC_NUMERIC, "C");
    try {
        bool found_end = false;
        while (getline(line, 0)) {
            lineno += 1;

            std::string::size_type pos = line.find('#');
            pos = line.find_last_not_of(" \t\r", pos);
            if (pos == std::string::npos) {
                continue;  // empty line
            }
            line.erase(pos + 1, std::string::npos);
            pos = line.find_first_not_of(" \t\r");

            auto end = line.find_first_of(" \t\r\n", pos);
            if (end == std::string::npos) {
                end = line.size();
            }
            if (line.compare(pos, end - pos, "node") == 0) {
                unsigned desclen = 0;
                Net::Node nodeid = parse_node(net, nodes_by_number, line, end + 1, defaultnode, desclen);
                if (desclen > 0) {
                    NodeInfo& n = net.node(nodeid);
                    if (!getline(desc, desclen)) {
                        throw ReadError("Too few bytes for description data.");
                    }
                    for (auto& it : desc) {
                        if (it == '\n') {
                            it = '\0';
                            lineno += 1;
                        }
                    }
                    n.attributes = Attributes(std::move(desc));
                }
            } else if (line.compare(pos, end - pos, "arc") == 0 || line.compare(pos, end - pos, "edge") == 0) {
                unsigned desclen = 0;
                Net::Edge arcid = parse_arc(net, nodes_by_number, line, end + 1, defaultedge, desclen);
                if (arcid != Net::noedge && line.compare(pos, end - pos, "edge") == 0) {
                    net.edge(arcid).directed = false;
                }
                if (desclen > 0) {
                    EdgeInfo& a = net.edge(arcid);
                    if (!getline(desc, desclen)) {
                        throw ReadError("Too few bytes for description data.");
                    }

                    for (auto& it : desc) {
                        if (it == '\n') {
                            it = '\0';
                            lineno += 1;
                        }
                    }
                    a.attributes = Attributes(std::move(desc));
                }
            } else if (line.compare(pos, end - pos, "end") == 0) {
                found_end = true;
                break;
            } else {
                throw ReadError(std::string("Unknown command: ") + line.substr(pos, end - pos) +
                                " (expected 'arc', 'edge' or 'node')");
            }
        }
        if (!found_end) {
            throw ReadError("Unexpected end of file (missing 'end' line?)");
        }
    } catch (ReadError& e) {
        e.set_line(lineno);
        setlocale(LC_NUMERIC, locale);
        throw;
    } catch (...) {
        setlocale(LC_NUMERIC, locale);
        throw;
    }
    setlocale(LC_NUMERIC, locale);

    return Net(std::move(net));
}

struct NetSequence::Data {
    std::string name;
    std::vector<Net> steps;
};

NetSequence::NetSequence(const std::string& name) : d(new Data{name, {}}) {}

NetSequence::NetSequence(NetSequence&& net) noexcept : d(std::move(net.d)) {}

NetSequence& NetSequence::operator=(NetSequence&& net) noexcept
{
    d = std::move(net.d);
    return *this;
}

NetSequence::~NetSequence() = default;

std::size_t NetSequence::size() const
{
    return d->steps.size();
}

const std::string& NetSequence::name() const
{
    return d->name;
}

const Net& NetSequence::operator[](std::size_t i) const
{
    return d->steps.at(i);
}

void NetSequence::add(Net net)
{
    d->steps.push_back(std::move(net));
}

NetSequence::Series NetSequence::from_stream(std::istream& in, const readgraph_function& readgraph, Series&& series)
{
    size_type lineno = 0;
    return NetSequence::from_stream(in, readgraph, lineno, std::move(series));
}

NetSequence::Series NetSequence::from_stream(std::istream& in,
                                             const readgraph_function& readgraph,
                                             size_type& lineno,
                                             Series&& series)
{
    return from_lines(
        [&](std::string& line, std::size_t len) {
            if (in.good()) {
                if (len == 0) {
                    std::getline(in, line);
                } else {
                    line.resize(len);
                    in.read(&(line[0]), static_cast<std::streamsize>(len));
                    return in.gcount() == (int)len;
                }
                return true;
            }
            return false;
        },
        readgraph,
        lineno,
        std::move(series));
}

NetSequence::Series NetSequence::from_lines(const getline_function& getline,
                                            const readgraph_function& readgraph,
                                            Series&& series)
{
    size_type lineno = 0;
    return from_lines(getline, readgraph, lineno, std::move(series));
}

NetSequence::Series NetSequence::from_lines(const getline_function& getline,
                                            const readgraph_function& readgraph,
                                            size_type& lineno,
                                            Series&& series)
{
    std::string line;
    while (getline(line, 0)) {
        lineno++;

        // remove comments, skip whitespace
        auto cmdbeg = line.find_first_not_of(" \t\r\n");
        auto nameend = line.find_last_not_of(" \t\r\n", line.find('#'));

        if (nameend != std::string::npos) {
            nameend += 1;  // position after the found character
        }

        // skip empty lines
        if (cmdbeg == std::string::npos) {
            continue;
        }

        // find command
        auto cmdend = line.find_first_of(" \t\r\n", cmdbeg);

        if (line.compare(cmdbeg, cmdend - cmdbeg, "newgraph") == 0 ||
            line.compare(cmdbeg, cmdend - cmdbeg, "addgraph") == 0)
        {
            auto namebeg = line.find_first_not_of(" \t\r\n", cmdend);
            if (namebeg == std::string::npos || namebeg >= nameend) {
                throw ReadError("Expected network name after " + line.substr(cmdbeg, cmdend - cmdbeg));
            }

            Net net;
            auto seqname = line.substr(namebeg, nameend - namebeg);
            auto it = series.find(seqname);
            if (it != series.end() && line[namebeg] == 'a') {
                auto& seq = it->second;
                net = Net((*seq)[seq->size() - 1]);
            }

            if (it == series.end()) {
                std::shared_ptr<NetSequence> newseq(new NetSequence(seqname));
                it = series.insert({seqname, std::move(newseq)}).first;
            }

            readgraph(seqname, it->second->size());

            try {
                net = read_net_from_lines(getline, lineno);
            } catch (...) {
                throw;
            }

            it->second->add(std::move(net));
        } else {
            throw ReadError("Unexpected command: " + line.substr(cmdbeg, cmdend - cmdbeg), lineno);
        }
    }
    return std::move(series);
}
}  // namespace grav
}  // namespace graph
}  // namespace fifr

/*
 * Copyright (c) 2017, 2018 Frank Fischer
 *
 * This file is part of KraView.
 *
 * KraView is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * KraView is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with KraView.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __FIFR_GRAPH_GRAV_HXX__
#define __FIFR_GRAPH_GRAV_HXX__

#include "AttributedGraph.hxx"
#include "LinkedListGraph.hxx"

#include <functional>
#include <iosfwd>
#include <limits>
#include <map>
#include <memory>
#include <stdexcept>
#include <string>

namespace fifr {
namespace graph {
namespace grav {
using size_type = std::size_t;

/**
 * An error occurred when reading a grav file.
 */
class ReadError : public std::runtime_error
{
public:
    explicit ReadError(const std::string& msg) : ReadError(msg, 0) {}

    ReadError(const std::string& msg, size_type lineno) : std::runtime_error(msg), _lineno(lineno) {}

    ReadError(const ReadError&) = delete;

    ReadError(ReadError&&) noexcept = default;

    ReadError& operator=(const ReadError&) = delete;

    ReadError& operator=(ReadError&&) noexcept = default;

    ~ReadError() noexcept override = default;

    void set_line(size_type lineno) { _lineno = lineno; }

    [[nodiscard]] size_type lineno() const { return _lineno; }

private:
    size_type _lineno;
};

/**
 * Attributes for a node or edge.
 */
class Attributes
{
public:
    class const_iterator
    {
    public:
        using difference_type = std::ptrdiff_t;
        using value_type = std::pair<const std::string, const std::string>;
        using reference = std::pair<const std::string, const std::string>&;
        using pointer = std::pair<const std::string, const std::string>*;
        using iterator_category = std::forward_iterator_tag;

    public:
        const_iterator(const std::string& data, std::string::size_type pos) : data_(data), pos_(pos) {}

        value_type operator*() const;

        const_iterator& operator++();

        const_iterator operator++(int)
        {
            auto copy = *this;
            ++*this;
            return copy;
        }

        bool operator==(const const_iterator& it) const { return pos_ == it.pos_; }

        bool operator!=(const const_iterator& it) const { return !(*this == it); }

    private:
        const std::string& data_;
        std::string::size_type pos_;
    };

public:
    Attributes() = default;

    explicit Attributes(std::string&& data) : data_(std::move(data)) {}

    std::string operator[](const std::string& attr) const;

    [[nodiscard]] const_iterator begin() const { return {data_, 0}; }

    [[nodiscard]] const_iterator end() const { return {data_, data_.size()}; }

private:
    std::string data_;
};

struct Color {
    uint8_t r;
    uint8_t g;
    uint8_t b;
    double alpha;
};

enum class NodeType { None = -1, Circle, Disc };

struct NodeInfo {
    double x = 0;
    double y = 0;
    Color color = {};
    NodeType type = NodeType::None;
    double weight = 0;

    Attributes attributes;
};

struct EdgeInfo {
    Color color = {};
    double flow = 0;
    double cost = 0;
    bool directed = true;

    Attributes attributes;
};

using Empty = std::tuple<>;

class Net : public fifr::graph::AttributedGraph<Digraph, Empty, NodeInfo, EdgeInfo>
{
public:
    using Super = fifr::graph::AttributedGraph<Digraph, Empty, NodeInfo, EdgeInfo>;

    using Edge = Super::edge_type;
    using Node = Super::node_type;
    using builder = Super::builder;

    static constexpr Node nonode = Digraph::nonode;
    static constexpr Edge noedge = Digraph::noedge;

public:
    Net() = default;

    Net(Net&&) noexcept = default;

    explicit Net(const Net&) = default;

    explicit Net(Net::builder&& builder) : Super(Super(std::move(builder))) {}

    Net& operator=(Net&&) noexcept = default;

    Net& operator=(const Net&) = delete;

    ~Net() = default;
};

class NetSequence
{
public:
    using Series = std::map<std::string, std::shared_ptr<NetSequence>>;

    /**
     * Function read input data.
     *
     * The read data must be returned in the first argument.
     * The second argument is the number of bytes to read. If it is 0 a whole
     * line is read. The function must return true if the desired number of
     * bytes or a whole line could be read, otherwise it must return false.
     */
    using getline_function = std::function<bool(std::string&, std::size_t)>;

    using readgraph_function = std::function<void(const std::string&, std::size_t)>;

public:
    explicit NetSequence(const std::string& name);

    NetSequence(NetSequence&& net) noexcept;

    NetSequence(const NetSequence& net) = delete;

    NetSequence& operator=(NetSequence&& net) noexcept;

    NetSequence& operator=(const NetSequence& net) = delete;

    ~NetSequence();

    /// Return the number of networks in this sequence.
    [[nodiscard]] std::size_t size() const;

    /// Return the i-th network.
    const Net& operator[](std::size_t i) const;

    /// Return the name of this sequence.
    [[nodiscard]] const std::string& name() const;

    /// Append another network to the sequence.
    void add(Net net);

    /// Read a series of gravs from an input stream.
    static Series from_stream(std::istream& in,
                              const readgraph_function& readgraph,
                              size_type& lineno,
                              Series&& series = {});

    /// @overload
    static Series from_stream(std::istream& in, const readgraph_function& readgraph, Series&& series = {});

    /// Read a series of gravs from an input stream.
    static Series from_lines(const getline_function& getline,
                             const readgraph_function& readgraph,
                             size_type& lineno,
                             Series&& series = {});

    /// @overload
    static Series from_lines(const getline_function& getline, const readgraph_function& readgraph, Series&& series = {});

private:
    struct Data;
    std::unique_ptr<Data> d;
};
}  // namespace grav
}  // namespace graph
}  // namespace fifr

#endif

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef __FIFR_GRAPH_KRUSKAL_HXX__
#define __FIFR_GRAPH_KRUSKAL_HXX__

#include <algorithm>
#include <numeric>
#include <vector>

namespace fifr {
namespace graph {
/// Solve the Minimum Spanning Tree problem using Kruskal's algorithm.
///
/// - `graph` is the graph
/// - `weights` is a vector of edges weights
///
/// This implementation is sub-optimal because it does not use clever Union-Find
/// data structures.
template <typename G, typename W>
std::vector<typename G::Edge> kruskal(const G& graph, const W& weights)
{
    using E = typename G::Edge;
    std::vector<E> edges;
    edges.reserve(graph.num_edges());
    for (auto e : graph.edges()) {
        edges.push_back(e);
    }

    // sort edges by weight
    std::sort(edges.begin(), edges.end(), [&](E e, E f) { return weights(e) < weights(f); });

    typename G::template node_map<std::size_t> components(graph, 0);

    // fill `components` with {0, 1, 2, ..., g.num_nodes() - 1}.
    std::iota(components.begin(), components.end(), 0);

    std::vector<E> tree;
    tree.reserve(graph.num_nodes() - 1);

    for (auto e : edges) {
        auto uv = graph.enodes(e);
        auto u = uv.first;
        auto v = uv.second;
        auto comp_u = components[u];
        auto comp_v = components[v];

        if (comp_u != comp_v) {
            tree.push_back(e);
            for (auto& c : components) {
                if (c == comp_v) {
                    c = comp_u;
                }
            }
        }

        if (components.size() + 1 == graph.num_nodes()) {
            break;
        }
    }

    return tree;
}

}  // namespace graph
}  // namespace fifr

#endif

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "LinkedListGraph.hxx"

namespace fifr {
namespace graph {
template class LinkedListGraph<uint16_t>;
template class LinkedListDigraph<uint16_t>;
template class LinkedListNetwork<uint16_t>;

template class LinkedListGraph<uint32_t>;
template class LinkedListDigraph<uint32_t>;
template class LinkedListNetwork<uint32_t>;

template class LinkedListGraph<uint64_t>;
template class LinkedListDigraph<uint64_t>;
template class LinkedListNetwork<uint64_t>;

}  // namespace graph
}  // namespace fifr

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef __FIFR_GRAPH_LINKEDLISTGRAPH_HXX__
#define __FIFR_GRAPH_LINKEDLISTGRAPH_HXX__

#include <cassert>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <iosfwd>
#include <limits>
#include <tuple>
#include <vector>

namespace fifr {
namespace graph {
/// Enumeration for the graph type.
enum class GraphType { Undirected, Directed };

/// A tag for undirected graphs.
struct undirected {
    static const GraphType id = GraphType::Undirected;
};

/// A tag for directed graphs.
struct directed {
    static const GraphType id = GraphType::Directed;
};

template <typename ID = uint32_t>
class LinkedListDigraph;

template <typename ID = uint32_t>
class LinkedListNetwork;

template <typename ID = uint32_t>
class LinkedListGraph;

namespace linkedlistgraph {
template <typename ID>
constexpr ID NO_ID = std::numeric_limits<ID>::max();

/// A node.
template <typename ID>
class Node
{
    friend class LinkedListGraph<ID>;
    friend class LinkedListDigraph<ID>;
    friend class LinkedListNetwork<ID>;
    friend struct std::hash<Node<ID>>;

public:
    Node() = default;
    explicit Node(ID id) : id(id) {}

    Node(const Node&) = default;
    Node(Node&&) noexcept = default;
    Node& operator=(const Node&) = default;
    Node& operator=(Node&&) noexcept = default;

    ~Node() = default;

    bool operator==(const Node& u) const { return id == u.id; }
    bool operator!=(const Node& u) const { return !(*this == u); }

    template <typename ID_>
    friend std::ostream& operator<<(std::ostream& out, const Node<ID_>& u);
    template <typename ID_>
    friend std::istream& operator>>(std::istream& in, Node<ID_>& u);

private:
    ID id = NO_ID<ID>;
};

/// An edge.
template <typename ID>
class Edge
{
    friend class LinkedListGraph<ID>;
    friend class LinkedListDigraph<ID>;
    friend class LinkedListNetwork<ID>;
    friend struct std::hash<Edge<ID>>;

public:
    Edge() = default;
    explicit Edge(ID id) : id(id) {}

    Edge(const Edge&) = default;
    Edge(Edge&&) noexcept = default;
    Edge& operator=(const Edge&) = default;
    Edge& operator=(Edge&&) noexcept = default;

    ~Edge() = default;

    bool operator==(const Edge& e) const { return id >> 1u == e.id >> 1u; }
    bool operator!=(const Edge& e) const { return !(*this == e); }

    template <typename ID_>
    friend std::ostream& operator<<(std::ostream& out, const Edge<ID_>& e);
    template <typename ID_>
    friend std::istream& operator>>(std::istream& in, Edge<ID_>& e);

private:
    ID id = NO_ID<ID>;
};

}  // namespace linkedlistgraph

template <typename ID>
class LinkedListGraph
{
protected:
    static constexpr ID no_id = linkedlistgraph::NO_ID<ID>;

    struct NodeData {
        /// The first adjacent edge.
        ID first = no_id;
    };

    struct EdgeData {
        /// The sink node.
        ID snk = no_id;
        /// The next arc adjacent to the source node.
        ID next = no_id;
    };

public:
    /// This graph is undirected.
    using graph_type = undirected;

    using size_type = std::size_t;
    using id_type = ID;

    /// Type of nodes.
    using Node = linkedlistgraph::Node<ID>;
    /// Type of nodes.
    using node_type = Node;

    /// Type of edges.
    using Edge = linkedlistgraph::Edge<ID>;
    /// Type of edges.
    using edge_type = Edge;

    /// Iterator over a consecutive range of valid IDs.
    template <typename T, ID offset>
    class id_iterator
    {
        friend class LinkedListGraph;

    public:
        using value_type = T;
        using pointer = const T*;
        using reference = T;
        using iterator_category = std::bidirectional_iterator_tag;

    public:
        id_iterator() = default;

        reference operator*() const { return T(id_); }

        id_iterator& operator++()
        {
            id_ += offset;
            return *this;
        }

        id_iterator operator++(int)
        {
            auto it = *this;
            ++(*this);
            return it;
        }

        id_iterator& operator--()
        {
            id_ -= offset;
            return *this;
        }

        id_iterator operator--(int)
        {
            auto it = *this;
            --(*this);
            return it;
        }

        bool operator==(const id_iterator& it) const { return id_ == it.id_; }
        bool operator!=(const id_iterator& it) const { return !(*this == it); }

    private:
        explicit id_iterator(ID id) : id_(id) {}

    private:
        ID id_ = no_id;
    };

    template <typename It>
    class range_proxy
    {
        friend class LinkedListGraph;

    public:
        using iterator = It;

    private:
        range_proxy(It&& begin, It&& end) : begin_(begin), end_(end) {}

    public:
        template <typename It_>
        explicit range_proxy(range_proxy<It_>&& rng) : begin_(It(rng.begin_)), end_(It(rng.end_))
        {
        }

        iterator begin() const { return begin_; }
        iterator end() const { return end_; }

    private:
        It begin_;
        It end_;
    };

    class neigh_iterator
    {
        friend class LinkedListDigraph<ID>::in_iterator;
        friend class LinkedListDigraph<ID>::out_iterator;

    public:
        using value_type = std::pair<Edge, Node>;
        using reference = std::pair<Edge, Node>;
        using iterator_category = std::forward_iterator_tag;

    public:
        neigh_iterator(ID edge, const std::vector<EdgeData>& edges) : edge_(edge), edges_(edges) {}

        reference operator*() const { return {edge(), node()}; }

        /// Return the current edge.
        [[nodiscard]] Edge edge() const
        {
            assert(edge_ != no_id);
            return Edge(edge_);
        }

        /// Return the other adjacent node of the current edge.
        [[nodiscard]] Node node() const
        {
            assert(edge_ != no_id);
            return Node(edges_[edge_].snk);
        }

        neigh_iterator& operator++()
        {
            assert(edge_ != no_id);
            edge_ = edges_[edge_].next;
            return *this;
        }

        neigh_iterator operator++(int)
        {
            auto it = *this;
            ++(*this);
            return it;
        }

        bool operator==(const neigh_iterator& it) const { return edge_ == it.edge_; }
        bool operator!=(const neigh_iterator& it) const { return !(*this == it); }

    private:
        ID edge_;
        const std::vector<EdgeData>& edges_;
    };

    using node_iterator = id_iterator<Node, 1>;
    using edge_iterator = id_iterator<Edge, 2>;

    using node_range = range_proxy<node_iterator>;
    using edge_range = range_proxy<edge_iterator>;
    using neigh_range = range_proxy<neigh_iterator>;

    class builder
    {
        friend class LinkedListGraph;

    public:
        explicit builder(std::size_t node_capacity = 0, std::size_t edge_capacity = 0)
        {
            nodes_.reserve(node_capacity);
            edges_.reserve(edge_capacity);
        }

        /// Return the number of nodes.
        [[nodiscard]] size_type num_nodes() const { return nodes_.size(); }

        /// Return the number of edges.
        [[nodiscard]] size_type num_edges() const { return edges_.size() / 2; }

        /// Add a new node to the graph.
        Node add_node()
        {
            assert(nodes_.size() + 1 < no_id);
            nodes_.push_back(NodeData{});
            return Node(static_cast<ID>(nodes_.size() - 1));
        }

        /// Add several nodes to the graph.
        std::vector<Node> add_nodes(size_type nnew)
        {
            std::vector<Node> newnodes;
            newnodes.reserve(nnew);
            for (size_type i = 0; i < nnew; ++i) {
                newnodes.push_back(add_node());
            }
            return newnodes;
        }

        /// Return the id of a node.
        [[nodiscard]] ID node_id(Node u) const { return u.id; }

        /// Return the node with a certain id.
        [[nodiscard]] Node id2node(ID id) const
        {
            assert(id >= 0 && id < static_cast<ID>(nodes_.size()));
            return Node(id);
        }

        /// Add an edge between u and v to the graph.
        Edge add_edge(Node u, Node v)
        {
            assert(edges_.size() + 2 < no_id);
            auto eid = static_cast<ID>(edges_.size());
            auto uid = u.id;
            auto vid = v.id;
            edges_.push_back(EdgeData{vid, nodes_[uid].first});
            edges_.push_back(EdgeData{uid, nodes_[vid].first});
            nodes_[uid].first = eid;
            nodes_[vid].first = eid + 1;
            return Edge(eid);
        }

        /// Return the id of an edge.
        [[nodiscard]] ID edge_id(Edge e) const { return e.id >> 1; }

        /// Return the edge with a certain id.
        [[nodiscard]] Edge id2edge(ID id) const
        {
            assert(id >= 0 && id < static_cast<ID>(edges_.size()));
            return Edge(id);
        }

    private:
        std::vector<NodeData> nodes_;
        std::vector<EdgeData> edges_;
    };

    /// A vector assigning some value to each node.
    template <typename T>
    class node_map : public std::vector<T>
    {
    public:
        explicit node_map(const LinkedListGraph& g) : std::vector<T>(g.num_nodes()) {}

        node_map(const LinkedListGraph& g, const T& value) : std::vector<T>(g.num_nodes(), value) {}

        node_map(const LinkedListGraph& g, std::vector<T> values) : std::vector<T>(std::move(values))
        {
            assert(std::vector<T>::size() == g.num_nodes());
        }

        T& operator[](Node u) { return std::vector<T>::operator[](u.id); }
        const T& operator[](Node u) const { return std::vector<T>::operator[](u.id); }
    };

    /// A vector assigning some value to each edge.
    template <typename T>
    class edge_map : public std::vector<T>
    {
    public:
        explicit edge_map(const LinkedListGraph& g) : std::vector<T>(g.num_edges()) {}

        edge_map(const LinkedListGraph& g, const T& value) : std::vector<T>(g.num_edges(), value) {}

        edge_map(const LinkedListGraph& g, std::vector<T> values) : std::vector<T>(std::move(values))
        {
            assert(std::vector<T>::size() == g.num_edges());
        }

        T& operator[](Edge e) { return std::vector<T>::operator[](e.id >> 1); }
        const T& operator[](Edge e) const { return std::vector<T>::operator[](e.id >> 1); }
    };

public:
    /// A non-existing node.
    static constexpr Node nonode = Node();
    /// A non-existing edge.
    static constexpr Edge noedge = Edge();

public:
    LinkedListGraph() = default;

    LinkedListGraph(LinkedListGraph&&) noexcept = default;

    explicit LinkedListGraph(const LinkedListGraph&) = default;

    explicit LinkedListGraph(builder&& b) : nodes_(std::move(b.nodes_)), edges_(std::move(b.edges_)) {}

    LinkedListGraph& operator=(LinkedListGraph&&) noexcept = default;

    LinkedListGraph& operator=(const LinkedListGraph&) = default;

    ~LinkedListGraph() = default;

public:
    /// Return the number of nodes.
    [[nodiscard]] size_type num_nodes() const { return nodes_.size(); }

    /// Return the number of edges.
    [[nodiscard]] size_type num_edges() const { return edges_.size() / 2; }

    /// Return the end nodes of an edge.
    ///
    /// Note that the order of the nodes is undefined. In fact, each time the
    /// method is called the order of the returned nodes may be different.
    [[nodiscard]] std::pair<Node, Node> enodes(Edge e) const
    {
        assert(e.id != no_id);
        return {Node{edges_[e.id | 1u].snk}, Node{edges_[e.id & ~static_cast<ID>(1)].snk}};
    }

    /// Return a node range.
    [[nodiscard]] node_range nodes() const
    {
        return {node_iterator(0), node_iterator(static_cast<ID>(nodes_.size()))};
    };

    /// Return the id associated with a node.
    [[nodiscard]] ID node_id(Node u) const
    {
        assert(u.id != no_id);
        return u.id;
    }

    /// Return the node with the given id.
    [[nodiscard]] Node id2node(ID id) const
    {
        assert(id >= 0 && id < static_cast<ID>(nodes_.size()));
        return Node(id);
    }

    /// Return an edge range.
    [[nodiscard]] edge_range edges() const
    {
        return {edge_iterator(0), edge_iterator(static_cast<ID>(edges_.size()))};
    };

    /// Return the id associated with a edge.
    [[nodiscard]] ID edge_id(Edge e) const
    {
        assert(e.id != no_id);
        return e.id >> 1u;
    }

    /// Return the edge with the given id.
    [[nodiscard]] Edge id2edge(ID id) const
    {
        assert(id >= 0 && (id * 2) < static_cast<ID>(edges_.size()));
        return Edge(id * 2);
    }

    /// Return a range over all edges adjacent to the given node `u`.
    [[nodiscard]] neigh_range neighs(Node u) const
    {
        assert(u.id != no_id);
        return {neigh_iterator(nodes_[u.id].first, edges_), neigh_iterator(no_id, edges_)};
    }

    template <typename ID_>
    friend std::ostream& operator<<(std::ostream& out, const LinkedListGraph<ID_>& g);
    template <typename ID_>
    friend std::istream& operator>>(std::istream& in, LinkedListGraph<ID_>& g);

protected:
    std::vector<NodeData> nodes_;
    std::vector<EdgeData> edges_;
};

template <typename ID>
class LinkedListDigraph : public LinkedListGraph<ID>
{
public:
    /// This graph is undirected.
    using graph_type = directed;

    using super_type = LinkedListGraph<ID>;
    using typename super_type::Edge;
    using typename super_type::Node;

    using typename super_type::neigh_iterator;

public:
    class in_iterator
    {
    public:
        using value_type = std::pair<Edge, Node>;
        using reference = std::pair<Edge, Node>;
        using iterator_category = std::forward_iterator_tag;

    public:
        explicit in_iterator(neigh_iterator it) : it_(it)
        {
            while ((it_.edge_ & 1u) == 0 && it_.edge_ != super_type::no_id) {
                ++it_;
            }
        }

        reference operator*() const { return *it_; }

        /// Return the current edge.
        [[nodiscard]] Edge edge() const { return it_.edge(); }

        /// Return the other adjacent node of the current edge.
        [[nodiscard]] Node node() const { return it_.node(); }

        in_iterator& operator++()
        {
            do {
                ++it_;
            } while ((it_.edge_ & 1u) == 0 && it_.edge_ != super_type::no_id);
            return *this;
        }

        in_iterator operator++(int)
        {
            auto it = *this;
            ++(*this);
            return it;
        }

        bool operator==(const in_iterator& it) const { return it_ == it.it_; }
        bool operator!=(const in_iterator& it) const { return !(*this == it); }

    private:
        neigh_iterator it_;
    };

    class out_iterator
    {
    public:
        using value_type = std::pair<Edge, Node>;
        using reference = std::pair<Edge, Node>;
        using iterator_category = std::forward_iterator_tag;

    public:
        explicit out_iterator(neigh_iterator it) : it_(it)
        {
            while ((it_.edge_ & 1u) != 0 && it_.edge_ != super_type::no_id) {
                ++it_;
            }
        }

        reference operator*() const { return *it_; }

        /// Return the current edge.
        [[nodiscard]] Edge edge() const { return it_.edge(); }

        /// Return the other adjacent node of the current edge.
        [[nodiscard]] Node node() const { return it_.node(); }

        out_iterator& operator++()
        {
            do {
                ++it_;
            } while ((it_.edge_ & 1u) != 0 && it_.edge_ != super_type::no_id);
            return *this;
        }

        out_iterator operator++(int)
        {
            auto it = *this;
            ++(*this);
            return it;
        }

        bool operator==(const out_iterator& it) const { return it_ == it.it_; }
        bool operator!=(const out_iterator& it) const { return !(*this == it); }

    private:
        neigh_iterator it_;
    };

    using in_range = typename super_type::template range_proxy<in_iterator>;
    using out_range = typename super_type::template range_proxy<out_iterator>;

    using typename super_type::builder;

public:
    LinkedListDigraph() = default;

    LinkedListDigraph(LinkedListDigraph&&) noexcept = default;

    explicit LinkedListDigraph(const LinkedListDigraph&) = default;

    LinkedListDigraph& operator=(LinkedListDigraph&&) noexcept = default;

    LinkedListDigraph& operator=(const LinkedListDigraph&) noexcept = delete;

    explicit LinkedListDigraph(builder&& b) : super_type(std::move(b)) {}

    ~LinkedListDigraph() = default;

    /// Return the source node of edge e.
    [[nodiscard]] Node src(Edge e) const
    {
        assert(e.id != super_type::no_id);
        return Node(super_type::edges_[e.id | 1u].snk);
    }

    /// Return the sink node of edge e.
    [[nodiscard]] Node snk(Edge e) const
    {
        assert(e.id != super_type::no_id);
        return Node(super_type::edges_[e.id & ~static_cast<ID>(1)].snk);
    }

    /// Return a range over all edges with destination node `u`.
    [[nodiscard]] in_range inedges(Node u) const
    {
        assert(u.id != super_type::no_id);
        return in_range(super_type::neighs(u));
    }

    /// Return a range over all edges with source node `u`.
    [[nodiscard]] out_range outedges(Node u) const
    {
        assert(u.id != super_type::no_id);
        return out_range(super_type::neighs(u));
    }
};

template <typename ID>
class LinkedListNetwork : public LinkedListDigraph<ID>
{
public:
    using super_type = LinkedListDigraph<ID>;
    using typename super_type::builder;
    using typename super_type::Edge;
    using typename super_type::Node;

    /// A vector assigning some value to each edge.
    template <typename T>
    class biedge_map : public std::vector<T>
    {
    public:
        explicit biedge_map(const LinkedListNetwork& g) : std::vector<T>(g.num_edges() * 2) {}

        biedge_map(const LinkedListNetwork& g, const T& value) : std::vector<T>(g.num_edges() * 2, value) {}

        T& operator[](Edge e) { return std::vector<T>::operator[](e.id); }
        const T& operator[](Edge e) const { return std::vector<T>::operator[](e.id); }
    };

public:
    LinkedListNetwork() = default;

    LinkedListNetwork(LinkedListNetwork&&) noexcept = default;

    explicit LinkedListNetwork(const LinkedListNetwork&) = default;

    LinkedListNetwork& operator=(LinkedListNetwork&&) noexcept = default;

    LinkedListNetwork& operator=(const LinkedListNetwork&) = delete;

    explicit LinkedListNetwork(builder&& b) : super_type(std::move(b)) {}

    ~LinkedListNetwork() = default;

    /// Return true if `e` is the reverse edge of `f`.
    [[nodiscard]] bool is_reverse(Edge e, Edge f) const
    {
        assert(e.id != super_type::no_id);
        assert(f.id != super_type::no_id);
        return (e.id ^ f.id) == 1;
    }

    /// Return the reverse edge of `e`.
    [[nodiscard]] Edge reverse(Edge e) const
    {
        assert(e.id != super_type::no_id);
        return Edge(e.id ^ 1u);
    }

    /// Return true if `e` is a forward edge.
    [[nodiscard]] bool is_forward(Edge e) const
    {
        assert(e.id != super_type::no_id);
        return (e.id & 1u) == 0;
    }

    /// Return the forward edge of `e`.
    ///
    /// If `e` is itself a forward edge, the edge `e` is returned, otherwise its
    /// reverse edge is returned.
    [[nodiscard]] Edge forward(Edge e) const { return is_forward(e) ? e : reverse(e); }

    /// Return true if `e` is a backward edge.
    [[nodiscard]] bool is_backward(Edge e) const { return !is_forward(e); }

    /// Return the backward edge of `e`.
    ///
    /// If `e` is itself a backward edge, the edge `e` is returned, otherwise its
    /// reverse edge is returned.
    [[nodiscard]] Edge backward(Edge e) const { return is_backward(e) ? e : reverse(e); }

    /// Return the source of the directed edge `e`.
    ///
    /// If `e` is a forward edge, this is the same as `src` otherwise it is
    /// `snk`.
    [[nodiscard]] Node bisrc(Edge e) const { return is_forward(e) ? super_type::src(e) : super_type::snk(e); }

    /// Return the sink of the directed edge `e`.
    ///
    /// If `e` is a forward edge, this is the same as `snk` otherwise it is
    /// `src`.
    [[nodiscard]] Node bisnk(Edge e) const { return is_forward(e) ? super_type::snk(e) : super_type::src(e); }
};

/// Default undirected graph with 32bit indices.
using Graph = LinkedListGraph<>;
/// Default directed graph with 32bit indices.
using Digraph = LinkedListDigraph<>;
/// Default network with 32bit indices.
using Net = LinkedListNetwork<>;

extern template class LinkedListGraph<uint16_t>;
extern template class LinkedListDigraph<uint16_t>;
extern template class LinkedListNetwork<uint16_t>;

extern template class LinkedListGraph<uint32_t>;
extern template class LinkedListDigraph<uint32_t>;
extern template class LinkedListNetwork<uint32_t>;

extern template class LinkedListGraph<uint64_t>;
extern template class LinkedListDigraph<uint64_t>;
extern template class LinkedListNetwork<uint64_t>;

}  // namespace graph
}  // namespace fifr

namespace std {
template <typename ID>
struct hash<fifr::graph::linkedlistgraph::Node<ID>> {
    std::size_t operator()(fifr::graph::linkedlistgraph::Node<ID> node) const noexcept
    {
        return std::hash<ID>{}(node.id);
    }
};

template <typename ID>
struct hash<fifr::graph::linkedlistgraph::Edge<ID>> {
    std::size_t operator()(fifr::graph::linkedlistgraph::Edge<ID> edge) const noexcept
    {
        return std::hash<ID>{}(edge.id >> 1);
    }
};
}  // namespace std

#endif

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "LinkedListGraphIO.hxx"

namespace fifr {
namespace graph {
namespace linkedlistgraph {
template std::ostream& operator<<(std::ostream& out, const Node<uint16_t>& u);
template std::ostream& operator<<(std::ostream& out, const Node<uint32_t>& u);
template std::ostream& operator<<(std::ostream& out, const Node<uint64_t>& u);
template std::istream& operator>>(std::istream& in, Node<uint16_t>& u);
template std::istream& operator>>(std::istream& in, Node<uint32_t>& u);
template std::istream& operator>>(std::istream& in, Node<uint64_t>& u);

template std::ostream& operator<<(std::ostream& out, const Edge<uint16_t>& e);
template std::ostream& operator<<(std::ostream& out, const Edge<uint32_t>& e);
template std::ostream& operator<<(std::ostream& out, const Edge<uint64_t>& e);
template std::istream& operator>>(std::istream& in, Edge<uint16_t>& e);
template std::istream& operator>>(std::istream& in, Edge<uint32_t>& e);
template std::istream& operator>>(std::istream& in, Edge<uint64_t>& e);
}  // namespace linkedlistgraph

template std::ostream& operator<<(std::ostream& out, const LinkedListGraph<uint16_t>& g);
template std::ostream& operator<<(std::ostream& out, const LinkedListGraph<uint32_t>& g);
template std::ostream& operator<<(std::ostream& out, const LinkedListGraph<uint64_t>& g);
template std::istream& operator>>(std::istream& in, LinkedListGraph<uint16_t>& g);
template std::istream& operator>>(std::istream& in, LinkedListGraph<uint32_t>& g);
template std::istream& operator>>(std::istream& in, LinkedListGraph<uint64_t>& g);
}  // namespace graph
}  // namespace fifr

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef __FIFR_GRAPH_LINKEDLISTGRAPHIO_HXX__
#define __FIFR_GRAPH_LINKEDLISTGRAPHIO_HXX__

#include "LinkedListGraph.hxx"

#include <fifr/util/PrettyStruct.hxx>

namespace fifr {
namespace graph {
namespace linkedlistgraph {
template <typename ID>
std::ostream& operator<<(std::ostream& out, const Node<ID>& u)
{
    fifr::util::pretty_print_struct(out, "Node", "id", u.id);
    return out;
}

template <typename ID>
std::istream& operator>>(std::istream& in, Node<ID>& u)
{
    fifr::util::pretty_read_struct(in, "Node", "id", u.id);
    return in;
}

template <typename ID>
std::ostream& operator<<(std::ostream& out, const Edge<ID>& e)
{
    fifr::util::pretty_print_struct(out, "Edge", "id", e.id >> 1u);
    return out;
}

template <typename ID>
std::istream& operator>>(std::istream& in, Edge<ID>& e)
{
    ID id;
    fifr::util::pretty_read_struct(in, "Edge", "id", id);
    e.id = id * 2;
    return in;
}

extern template std::ostream& operator<<(std::ostream& out, const Node<uint16_t>& u);
extern template std::ostream& operator<<(std::ostream& out, const Node<uint32_t>& u);
extern template std::ostream& operator<<(std::ostream& out, const Node<uint64_t>& u);
extern template std::istream& operator>>(std::istream& in, Node<uint16_t>& u);
extern template std::istream& operator>>(std::istream& in, Node<uint32_t>& u);
extern template std::istream& operator>>(std::istream& in, Node<uint64_t>& u);

extern template std::ostream& operator<<(std::ostream& out, const Edge<uint16_t>& e);
extern template std::ostream& operator<<(std::ostream& out, const Edge<uint32_t>& e);
extern template std::ostream& operator<<(std::ostream& out, const Edge<uint64_t>& e);
extern template std::istream& operator>>(std::istream& in, Edge<uint16_t>& e);
extern template std::istream& operator>>(std::istream& in, Edge<uint32_t>& e);
extern template std::istream& operator>>(std::istream& in, Edge<uint64_t>& e);
}  // namespace linkedlistgraph

template <typename ID>
std::ostream& operator<<(std::ostream& out, const LinkedListGraph<ID>& g)
{
    std::vector<std::pair<ID, ID>> edges;
    edges.reserve(g.num_edges());
    for (auto e : g.edges()) {
        auto uv = g.enodes(e);
        edges.push_back({g.node_id(uv.first), g.node_id(uv.second)});
    }
    fifr::util::pretty_print_struct(out, "Graph", "n", g.num_nodes(), "edges", edges);
    return out;
}

template <typename ID>
std::istream& operator>>(std::istream& in, LinkedListGraph<ID>& g)
{
    std::size_t n = 0;
    std::vector<std::pair<ID, ID>> edges;
    fifr::util::pretty_read_struct(in, "Graph", "n", n, "edges", edges);

    if (n >= static_cast<std::size_t>(LinkedListGraph<ID>::no_id)) {
        throw fifr::util::ReadError("Number of graph nodes is too large");
    }

    typename LinkedListGraph<ID>::builder b(n, edges.size());
    auto nodes = b.add_nodes(n);
    for (auto e : edges) {
        if (e.first < 0 || e.first >= static_cast<ID>(n)) {
            throw fifr::util::ReadError("Invalid node id " + std::to_string(e.first));
        }
        if (e.second < 0 || e.second >= static_cast<ID>(n)) {
            throw fifr::util::ReadError("Invalid node id " + std::to_string(e.second));
        }
        b.add_edge(nodes[e.first], nodes[e.second]);
    }
    g = LinkedListGraph<ID>(std::move(b));

    return in;
}

extern template std::ostream& operator<<(std::ostream& out, const LinkedListGraph<uint16_t>& g);
extern template std::ostream& operator<<(std::ostream& out, const LinkedListGraph<uint32_t>& g);
extern template std::ostream& operator<<(std::ostream& out, const LinkedListGraph<uint64_t>& g);
extern template std::istream& operator>>(std::istream& in, LinkedListGraph<uint16_t>& g);
extern template std::istream& operator>>(std::istream& in, LinkedListGraph<uint32_t>& g);
extern template std::istream& operator>>(std::istream& in, LinkedListGraph<uint64_t>& g);

}  // namespace graph
}  // namespace fifr

#endif

/*
 * Copyright (c) 2016, 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef __FIFR_GRAPH_TIKZ_HXX__
#define __FIFR_GRAPH_TIKZ_HXX__

#include "AttributedGraph.hxx"
#include "LinkedListGraph.hxx"

#include <iomanip>
#include <iostream>
#include <map>
#include <ostream>
#include <utility>

namespace fifr {
namespace graph {
enum class Shape {
    Circle,
    Disc,
};

struct Color {
    uint8_t red = 0;
    uint8_t green = 0;
    uint8_t blue = 0;
    double opacity = 1.0;

    bool is_black() const { return red == 0 && green == 0 && blue == 0; }
};

/**
 * Simple class to draw graphs in Tikz format.
 *
 * This class takes a reference to the graph to be drawn. Therefore
 * the graph must exist as long as the TikzDrawer is used.
 *
 * TikzDrawer can be used with directed and undirected graphs.
 */
template <class Graph>
class TikzDrawer
{
private:
public:
    /// Type of nodes.
    using Node = typename Graph::node_type;
    /// Type of edges.
    using Edge = typename Graph::edge_type;

    /// Coordinates of a node to be drawn.
    using Point = std::pair<double, double>;

    /// Bend configuration of an edge/edge.
    enum class Bend { None, Left, Right };

    /// Information associated with a node.
    struct NodeInfo {
        Point point = {0, 0};  ///< node coordinates
        Shape shape = Shape::Circle;
        Color color;
    };

    /// Information associated with a edge.
    struct EdgeInfo {
        Bend bend = Bend::None;  ///< bend attribute
        double width = 0.5;      ///< line width
        Color color;
    };

public:
    TikzDrawer(const Graph& graph) : graph_(graph), node_infos_(graph_), edge_infos_(graph_), indent_(0), doc_(false) {}

    /// Set whether document boiler plate should be drawn.
    void set_document(bool doc) { doc_ = doc; }

    /// Return the node information.
    NodeInfo& node(Node u) { return node_infos_[u]; }

    /// Return the node information.
    const NodeInfo& node(Node u) const { return node_infos_[u]; }

    /// Return the node information.
    EdgeInfo& edge(Edge e) { return edge_infos_[e]; }

    /// Return the node information.
    const EdgeInfo& edge(Edge e) const { return edge_infos_[e]; }

    /// Sets the point associated with a node.
    void set_point(Node u, Point x) { node_infos_[u].point = std::move(x); }

    /// Sets the bend attribute associated with an edge.
    void set_bend(Edge e, Bend bend) { edge_infos_[e].bend = bend; }

    /// Sets the line width of an edge.
    void set_width(Edge e, double width)
    {
        assert(width >= 0);
        edge_infos_[e].width = width;
    }

    /// Write TeX document preamble.
    static void write_begin(std::ostream& out)
    {
        out << "\\documentclass{article}\n";
        out << "\\usepackage[utf8]{inputenc}\n";
        out << "\\usepackage[T1]{fontenc}\n";
        out << "\\usepackage{tikz}\n";
        out << "\\begin{document}\n";
    }

    /// Write TeX document closing.
    static void write_end(std::ostream& out) { out << "\\end{document}\n"; }

    /// Write Tikz graph to output stream.
    std::ostream& write_tikz(std::ostream& out) const
    {
        if (doc_) {
            write_begin(out);
        }

        write_indent(out);

        out << "\\begin{tikzpicture}[>=stealth,inner sep=5pt]\n";
        out << std::setprecision(2);

        for (auto u : graph_.nodes()) {
            auto info = node_infos_[u];

            if (!info.color.is_black()) {
                write_indent(out, 1);
                out << "\\definecolor{currentcolor}{RGB}{" << (int)info.color.red << "," << (int)info.color.green << ","
                    << (int)info.color.blue << "}\n";
            }
            write_indent(out, 1);
            out << "\\node[circle,";
            switch (info.shape) {
                case Shape::Circle: out << "draw"; break;
                case Shape::Disc: out << "fill"; break;
            }
            if (!info.color.is_black()) {
                out << "=currentcolor";
            }
            if (info.color.opacity != 1) {
                out << ",opacity=" << std::fixed << info.color.opacity;
            }
            out << "] (" << graph_.node_id(u) << ") "
                << "at (" << std::fixed << info.point.first << "," << std::fixed << info.point.second << ") "
                << "{};\n";
            //<< "{" << (unsigned)(u+1) << "};\n";
        }

        for (auto e : graph_.edges()) {
            Node u, v;
            std::tie(u, v) = graph_.enodes(e);
            auto info = edge_infos_[e];

            if (!info.color.is_black()) {
                write_indent(out, 1);
                out << "\\definecolor{currentcolor}{RGB}{" << (int)info.color.red << "," << (int)info.color.green << ","
                    << (int)info.color.blue << "}\n";
            }
            write_indent(out, 1);
            out << "\\draw[";
            out << "line width=" << info.width << "pt";
            if (Graph::graph_type::id == GraphType::Directed) {
                out << ",->";
            }
            if (!info.color.is_black()) {
                out << ",color=currentcolor";
            }
            if (info.color.opacity != 1) {
                out << ",opacity=" << info.color.opacity;
            }
            out << "]";
            out << " (" << graph_.node_id(u) << ") ";
            out << "to";
            switch (info.bend) {
                case Bend::Left: out << "[bend left]"; break;
                case Bend::Right: out << "[bend right]"; break;
                case Bend::None: break;
            }
            out << " (" << graph_.node_id(v) << ");"
                << "\n";
        }

        write_indent(out);
        out << "\\end{tikzpicture}\n";

        if (doc_) {
            write_end(out);
        }

        return out;
    }

    inline void write_indent(std::ostream& out, unsigned offset = 0) const
    {
        for (auto i = 0u; i < 2 * (indent_ + offset); i++) {
            out << " ";
        }
    }

private:
    const Graph& graph_;

    typename Graph::template node_map<NodeInfo> node_infos_;
    typename Graph::template edge_map<EdgeInfo> edge_infos_;

    unsigned indent_;
    bool doc_;
};
}  // namespace graph
}  // namespace fifr

#endif

/*
 * Copyright (c) 2024 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#ifndef FIFR_GRAPH_VECGRAPH_HXX
#define FIFR_GRAPH_VECGRAPH_HXX

#include <cassert>
#include <cstdint>
#include <iterator>
#include <ranges>
#include <vector>

namespace fifr::graph {

template <typename ID = uint32_t>
class VecGraph
{
private:
    struct NodeData {
        ID firstout;
        ID firstin;
    };

    std::vector<NodeData> nodes_;
    /// The sink node for each (directed) edge.
    std::vector<ID> sinks_;
    // The list of adjacencies. This list contains the edge numbers in
    // a specific order, so that for each node the incident outgoing
    // and incoming edges are in successive positions.
    std::vector<ID> adj_;

public:
    class NeighIter
    {
    public:
        using iterator_category = std::forward_iterator_tag;
        using difference_type = std::ptrdiff_t;

    private:
        const std::vector<ID>* sinks_ = nullptr;
        std::vector<ID>::const_iterator it_;

    public:
        NeighIter() = default;
        NeighIter(const std::vector<ID>& sinks, std::vector<ID>::const_iterator it) : sinks_(&sinks), it_(it) {}
        NeighIter(NeighIter&&) = default;
        NeighIter(const NeighIter&) = default;
        auto operator=(NeighIter&&) -> NeighIter& = default;
        auto operator=(const NeighIter&) -> NeighIter& = default;
        ~NeighIter() = default;

        auto operator*() const -> std::pair<ID, ID> { return std::pair(*it_ / 2, (*sinks_)[*it_]); }

        auto operator++() -> NeighIter&
        {
            ++it_;
            return *this;
        }

        auto operator++(int) -> NeighIter
        {
            auto tmp = NeighIter(it_, sinks_);
            ++it_;
            return tmp;
        }

        auto operator==(const NeighIter& other) const { return it_ == other.it_; }
    };

    class builder
    {
        friend class VecGraph;

    private:
        std::size_t nnodes_ = 0;
        std::vector<std::pair<ID, ID>> edges_ = {};

    public:
        builder() = default;

        explicit builder(const builder&) = default;
        builder(builder&&) = default;
        auto operator=(const builder&) -> builder& = delete;
        auto operator=(builder&&) -> builder& = default;
        ~builder() = default;

        builder(std::size_t node_capacity, std::size_t edge_capacity)
        {
            (void)node_capacity;
            edges_.reserve(edge_capacity);
        }

        auto add_node() { return (ID)(nnodes_++); }

        auto add_nodes(std::size_t nnew)
        {
            std::vector<ID> newnodes;
            newnodes.reserve(nnew);
            for (ID i = 0; i < (ID)nnew; ++i) {
                newnodes.push_back(nnodes_++);
            }
            return newnodes;
        }

        auto add_edge(ID u, ID v)
        {
            assert(u >= 0 and u < nnodes_);
            assert(v >= 0 and v < nnodes_);
            edges_.push_back({u, v});
            return edges_.size() - 1;
        }
    };

public:
    VecGraph() = default;

    explicit VecGraph(const VecGraph&) = default;

    explicit VecGraph(builder&& b) : VecGraph(b.nnodes_, b.edges_) {}

    template <std::ranges::input_range T>
        requires std::is_same_v<typename T::value_type, std::pair<ID, ID>>
    VecGraph(std::size_t nnodes, T& edges) : nodes_(nnodes, {0, 0})
    {
        sinks_.reserve(edges.size() * 2);

        // first count the incident edges for each node
        for (auto [u, v] : edges) {
            assert(u >= 0 and u < nnodes);
            assert(v >= 0 and v < nnodes);
            nodes_[u].firstout += 1;
            nodes_[v].firstin += 1;
            sinks_.push_back(v);
            sinks_.push_back(u);
        }

        // now set the indices to the correct starts
        std::size_t nedges = 0;
        for (auto& node : nodes_) {
            auto nout = node.firstout;
            auto nin = node.firstin;
            node.firstout = nedges;
            node.firstin = nedges + nout;
            nedges += nout + nin;
        }

        assert(nedges == 2 * edges.size());

        // add the edges to the list of each node
        adj_.assign(2 * edges.size(), 0);
        for (auto e : std::ranges::iota_view{(std::size_t)0, edges.size()}) {
            auto [u, v] = edges[e];
            adj_[nodes_[u].firstout] = e << 1;
            adj_[nodes_[v].firstin] = (e << 1) | 1;
            nodes_[u].firstout += 1;
            nodes_[v].firstin += 1;
        }

        // finally set the indices to the correct starts again
        ID beg = 0;
        for (auto& node : nodes_) {
            auto next_beg = node.firstin;
            node.firstin = node.firstout;
            node.firstout = beg;
            beg = next_beg;
        }
    }

    VecGraph(VecGraph&&) = default;

    auto operator=(VecGraph&&) -> VecGraph& = default;

    auto operator=(const VecGraph&) -> VecGraph& = delete;

    ~VecGraph() = default;

    /// Return the number of nodes.
    auto num_nodes() const { return nodes_.size(); }

    /// Return the number of edges.
    auto num_edges() const { return sinks_.size() / 2; }

    /// Return an iterator over all nodes.
    auto nodes() const { return std::ranges::iota_view{(ID)0, (ID)num_nodes()}; }

    /// Return an iterator over all edges.
    auto edges() const { return std::ranges::iota_view{(ID)0, (ID)num_edges()}; }

    /// Return the end-nodes of an edge.
    ///
    /// If the edge is considered directed, the first node is the
    /// source and the second the sink of the edge.
    auto end_nodes(ID e) const
    {
        assert(e >= 0 and e < num_edges());
        return std::pair(sinks_[(e << 1) | 1], sinks_[e << 1]);
    }

    /// Return a range over all incident (edge, node) pairs.
    auto neighs(ID u) const
    {
        assert(u >= 0 and u < num_nodes());

        auto beg = adj_.begin() + nodes_[u].firstout;
        auto end = u + 1 < nodes_.size() ? adj_.begin() + nodes_[u + 1].firstout : adj_.end();

        return std::ranges::subrange(NeighIter(sinks_, beg), NeighIter(sinks_, end));
    }

    /// Return the source node of an edge.
    auto src(ID e) const
    {
        assert(e >= 0 and e < num_edges());
        return sinks_[(e << 1) | 1];
    }

    /// Return the sink node of an edge.
    auto snk(ID e) const
    {
        assert(e >= 0 and e < num_edges());
        return sinks_[e << 1];
    }

    /// Return a range over all outgoing (edge, node) pairs.
    auto out_edges(ID u) const
    {
        assert(u >= 0 and u < num_nodes());

        auto beg = adj_.begin() + nodes_[u].firstout;
        auto end = adj_.begin() + nodes_[u].firstin;

        return std::ranges::subrange(NeighIter(sinks_, beg), NeighIter(sinks_, end));
    }

    /// Return a range over all incoming (edge, node) pairs.
    auto in_edges(ID u) const
    {
        assert(u >= 0 and u < num_nodes());

        auto beg = adj_.begin() + nodes_[u].firstin;
        auto end = u + 1 < nodes_.size() ? adj_.begin() + nodes_[u + 1].firstout : adj_.end();

        return std::ranges::subrange(NeighIter(sinks_, beg), NeighIter(sinks_, end));
    }
};

}  // namespace fifr::graph

#endif

add_test(NAME all COMMAND test_fifrgraph)

set(TEST_SOURCES
  test_main.cxx
  test_graph.cxx
  test_digraph.cxx
  test_linkedlistgraph.cxx
  test_kruskal.cxx
  test_vecgraph.cxx)

add_executable(test_fifrgraph ${TEST_SOURCES})
target_link_libraries(test_fifrgraph Graph)

if (CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
  target_compile_options(test_fifrgraph PRIVATE -W -Wall -pedantic)
endif ()

/*
 * Copyright (c) 2016 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "catch.hpp"

#include <fifr/graph/AttributedGraph.hxx>
#include <fifr/graph/LinkedListGraph.hxx>
#include <fifr/util/Range.hxx>

using namespace fifr::util;
using namespace fifr::graph;

SCENARIO("An directed graph")
{
    GIVEN("A K3,3")
    {
        struct NodeAttr {
            double balance;
        };

        struct EdgeAttr {
            double flow;
        };

        using G = AttributedGraph<LinkedListDigraph<int16_t>, std::tuple<>, NodeAttr, EdgeAttr>;
        G::builder b;

        for (auto u : range(6)) {
            b.add_node({static_cast<double>(u)});
        }

        for (auto u : range(3)) {
            for (auto v : range(3, 6)) {
                b.add_edge(b.id2node(u), b.id2node(v), {static_cast<double>(u * v)});
            }
        }

        G g(std::move(b));

        THEN("should contain 6 nodes") { REQUIRE(g.num_nodes() == 6); }

        THEN("should iterate over all nodes")
        {
            double sum = 0;
            for (auto u : g.nodes()) {
                REQUIRE(g.node(u).balance == g.node_id(u));
                sum += g.node_id(u);
            }
            REQUIRE(sum == 15);
        }

        THEN("should contain 9 edges") { REQUIRE(g.num_edges() == 9); }

        THEN("should iterator over all edges")
        {
            auto cnt = 0;
            for (auto a : g.edges()) {
                auto u = g.node_id(g.src(a));
                auto v = g.node_id(g.snk(a));
                REQUIRE(g.edge(a).flow == u * v);
                ++cnt;
            }
            REQUIRE(cnt == 9);
        }

        THEN("should iterator over all outgoing edges")
        {
            auto cnt = 0;
            for (auto u : range(3)) {
                for (auto a : g.outedges(g.id2node(u))) {
                    auto x = g.node_id(g.src(a.first));
                    auto y = g.node_id(g.snk(a.first));
                    REQUIRE(u == x);
                    REQUIRE(y >= 3);
                    REQUIRE(g.edge(a.first).flow == x * y);
                    ++cnt;
                }
            }
            REQUIRE(cnt == 9);
        }

        THEN("should iterator over all incoming edges")
        {
            auto cnt = 0;
            for (auto v : range(3, 6)) {
                for (auto a : g.inedges(g.id2node(v))) {
                    auto x = g.node_id(g.src(a.first));
                    auto y = g.node_id(g.snk(a.first));
                    REQUIRE(x < 3);
                    REQUIRE(y == v);
                    REQUIRE(g.edge(a.first).flow == x * y);
                    ++cnt;
                }
            }
            REQUIRE(cnt == 9);
        }
    }
}

/*
 * Copyright (c) 2016 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "catch.hpp"

#include <fifr/graph/AttributedGraph.hxx>
#include <fifr/graph/LinkedListGraph.hxx>
#include <fifr/graph/LinkedListGraphIO.hxx>
#include <fifr/util/Range.hxx>

using namespace fifr::util;
using namespace fifr::graph;

SCENARIO("An undirected graph")
{
    GIVEN("A K3,3")
    {
        struct NodeAttr {
            double balance;
        };

        struct EdgeAttr {
            double flow;
        };

        using G = AttributedGraph<LinkedListGraph<int16_t>, std::tuple<>, NodeAttr, EdgeAttr>;
        G::builder b;

        for (auto u : range(6)) {
            b.add_node({static_cast<double>(u)});
        }

        for (auto u : range(3)) {
            for (auto v : range(3, 6)) {
                b.add_edge(b.id2node(u), b.id2node(v), {static_cast<double>(u * v)});
            }
        }

        G g(std::move(b));

        THEN("should contain 6 nodes") { REQUIRE(g.num_nodes() == 6); }

        THEN("should iterate over all nodes")
        {
            double sum = 0;
            for (auto u : g.nodes()) {
                REQUIRE(g.node(u).balance == g.node_id(u));
                sum += g.node_id(u);
            }
            REQUIRE(sum == 15);
        }

        THEN("should contain 9 edges") { REQUIRE(g.num_edges() == 9); }

        THEN("should iterator over all edges")
        {
            auto cnt = 0;
            for (auto e : g.edges()) {
                auto uv = g.enodes(e);
                REQUIRE(g.edge(e).flow == g.node_id(uv.first) * g.node_id(uv.second));
                ++cnt;
            }
            REQUIRE(cnt == 9);
        }

        THEN("should iterator over all outgoing edges")
        {
            auto cnt = 0;
            for (auto u : range(3)) {
                for (auto e : g.neighs(g.id2node(u))) {
                    auto uv = g.enodes(e.first);
                    REQUIRE(uv.first == g.id2node(u));
                    REQUIRE(g.node_id(uv.second) >= 3);
                    REQUIRE(g.edge(e.first).flow == g.node_id(uv.first) * g.node_id(uv.second));
                    ++cnt;
                }
            }
            REQUIRE(cnt == 9);
        }

        THEN("should iterator over all incoming edges")
        {
            auto cnt = 0;
            for (auto v : range(3, 6)) {
                for (auto e : g.neighs(g.id2node(v))) {
                    auto uv = g.enodes(e.first);
                    REQUIRE(g.node_id(uv.first) < 3);
                    REQUIRE(uv.second == g.id2node(v));
                    REQUIRE(g.edge(e.first).flow == g.node_id(uv.first) * g.node_id(uv.second));
                    ++cnt;
                }
            }
            REQUIRE(cnt == 9);
        }
    }
}

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "catch.hpp"

#include <fifr/graph/Kruskal.hxx>
#include <fifr/graph/LinkedListGraph.hxx>

using namespace fifr::graph;

SCENARIO("Minimum Spanning Tree")
{
    GIVEN("An undirected graph")
    {
        Graph::builder builder;
        auto nodes = builder.add_nodes(6);
        std::vector<int> weights;
        std::vector<std::tuple<int, int, int>> edges = {{0, 1, 1},
                                                        {0, 2, 3},
                                                        {1, 2, 2},
                                                        {1, 3, 4},
                                                        {2, 3, 5},
                                                        {2, 4, 6},
                                                        {3, 4, 7},
                                                        {3, 5, 8},
                                                        {4, 5, 9}};

        for (auto e : edges) {
            builder.add_edge(nodes[std::get<0>(e)], nodes[std::get<1>(e)]);
            weights.push_back(std::get<2>(e));
        }

        Graph graph(std::move(builder));

        WHEN("solving the MST")
        {
            auto tree = kruskal(graph, [&graph, &weights] (auto e) { return weights[graph.edge_id(e)]; });

            THEN("the resulting true should be correct")
            {
                std::set<std::pair<int, int>> tree_edges;
                for (auto e : tree) {
                    auto uv = graph.enodes(e);
                    tree_edges.insert({graph.node_id(uv.first), graph.node_id(uv.second)});
                }

                REQUIRE((tree_edges ==
                         std::set<std::pair<int, int>>{{0, 1}, {1, 2}, {1, 3}, {2, 4}, {3, 5}}));
            }
        }
    }
}

/*
 * Copyright (c) 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "catch.hpp"

#include <fifr/graph/AttributedGraph.hxx>
#include <fifr/graph/AttributedGraphIO.hxx>
#include <fifr/graph/Classes.hxx>
#include <fifr/graph/LinkedListGraph.hxx>
#include <fifr/graph/LinkedListGraphIO.hxx>
#include <fifr/util/Pretty.hxx>
#include <fifr/util/Range.hxx>

#include <iostream>

using namespace fifr::util;
using namespace fifr::graph;

SCENARIO("LinkedListGraph")
{
    GIVEN("An empty graph")
    {
        LinkedListGraph<> g;

        THEN("it should contain no nodes")
        {
            REQUIRE(g.num_nodes() == 0);
            for (auto u : g.nodes()) {
                REQUIRE(false);
            }
        }

        THEN("it should contain no edges")
        {
            REQUIRE(g.num_edges() == 0);
            for (auto u : g.edges()) {
                REQUIRE(false);
            }
        }

        THEN("it should iterator over incident edges")
        {
            for (auto u : g.nodes()) {
                for (auto e : g.neighs(u)) {
                    (void)e;
                    REQUIRE(false);
                }
            }
        }
    }
}

SCENARIO("LinkedListDigraph")
{
    GIVEN("An empty graph")
    {
        LinkedListDigraph<> g;

        THEN("it should contain no nodes")
        {
            REQUIRE(g.num_nodes() == 0);
            for (auto u : g.nodes()) {
                (void)u;
                REQUIRE(false);
            }
        }

        THEN("it should contain no edges")
        {
            REQUIRE(g.num_edges() == 0);
            for (auto u : g.edges()) {
                (void)u;
                REQUIRE(false);
            }
        }

        THEN("it should iterate over incoming edges")
        {
            for (auto u : g.nodes()) {
                for (auto e : g.inedges(u)) {
                    (void)e;
                    REQUIRE(false);
                }
            }
        }

        THEN("it should iterate over outgoing edges")
        {
            for (auto u : g.nodes()) {
                for (auto e : g.outedges(u)) {
                    (void)e;
                    REQUIRE(false);
                }
            }
        }
    }

    GIVEN("some graph")
    {
        for (auto& g : {cycle<Digraph>(7),
                        complete_bipartite<Digraph>(5, 6),
                        peterson<Digraph>(),
                        hypercube<Digraph>(5)}) {
            for (auto u : g.nodes()) {
                for (auto ev : g.outedges(u)) {
                    REQUIRE(u == g.src(ev.first));
                    REQUIRE(ev.second == g.snk(ev.first));
                }
                for (auto ev : g.inedges(u)) {
                    REQUIRE(u == g.snk(ev.first));
                    REQUIRE(ev.second == g.src(ev.first));
                }
            }
        }
    }
}

SCENARIO("LinkedListNetwork")
{
    for (auto& g : {cycle<Net>(7), peterson<Net>(), hypercube<Net>(5)}) {
        for (auto u : g.nodes()) {
            for (auto ev : g.outedges(u)) {
                REQUIRE(g.is_forward(ev.first));
            }
            for (auto ev : g.inedges(u)) {
                REQUIRE(g.is_backward(ev.first));
            }
            for (auto ev : g.neighs(u)) {
                REQUIRE(g.is_forward(ev.first) == (u == g.src(ev.first)));
            }
        }

        for (auto e : g.edges()) {
            REQUIRE(g.is_forward(e));
            REQUIRE(e == e);
            REQUIRE(e == g.reverse(e));
            REQUIRE(g.is_reverse(e, g.reverse(e)));
            REQUIRE(g.is_reverse(g.reverse(e), e));
            REQUIRE(!g.is_reverse(e, e));
            REQUIRE(g.is_forward(g.forward(e)));
            REQUIRE(g.is_backward(g.backward(e)));
        }
    }
}

SCENARIO("Graph builder")
{
    GIVEN("a builder")
    {
        Graph::builder builder;

        THEN("it should contain no nodes") { REQUIRE(builder.num_nodes() == 0); }
        THEN("it should contain no edges") { REQUIRE(builder.num_edges() == 0); }

        WHEN("adding 5 nodes")
        {
            std::vector<Graph::Node> nodes;
            for (auto i : range(5)) {
                nodes.push_back(builder.add_node());
            }

            THEN("it should contain 5 nodes") { REQUIRE(builder.num_nodes() == 5); }

            THEN("it should contain no edges") { REQUIRE(builder.num_edges() == 0); }
        }

        WHEN("adding 5 nodes and 4 edges")
        {
            std::vector<Graph::Node> nodes;
            for (auto i : range(5)) {
                nodes.push_back(builder.add_node());
            }

            for (auto i : range(1ul, builder.num_nodes())) {
                builder.add_edge(nodes[i - 1], nodes[i]);
            }

            THEN("it should contain 5 nodes") { REQUIRE(builder.num_nodes() == 5); }

            THEN("it should contain 4 edges") { REQUIRE(builder.num_edges() == 4); }
        }
    }
}

SCENARIO("graph classes")
{
    GIVEN("a cycle")
    {
        auto g = cycle<Net>(5);
        THEN("it should have 5 nodes") { REQUIRE(g.num_nodes() == 5); }
        THEN("it should have 5 edges") { REQUIRE(g.num_edges() == 5); }

        THEN("the edges should connect the nodes in a cycle")
        {
            for (auto e : g.edges()) {
                auto u = g.src(e);
                auto v = g.snk(e);
                REQUIRE((g.node_id(u) + 1) % g.num_nodes() == g.node_id(v));
            }
        }

        for (auto u : g.nodes()) {
            for (auto ev : g.neighs(u)) {
                Net::Edge e = ev.first;
                Net::Node v = ev.second;
                Net::Node a, b;
                std::tie(a, b) = g.enodes(e);
                REQUIRE((a == u || a == v));
                REQUIRE((b == u || b == v));
            }
        }
    }

    GIVEN("a complete bipartite graph")
    {
        auto g = complete_bipartite<Net>(3, 4);
        REQUIRE(g.num_nodes() == 7);
        REQUIRE(g.num_edges() == 3 * 4);
        for (auto e : g.edges()) {
            REQUIRE(g.node_id(g.src(e)) < 3);
            REQUIRE(g.node_id(g.snk(e)) >= 3);
        }
    }
}

SCENARIO("attributed graph")
{
    struct Gattr {
        int x = {};
    };

    struct Vattr {
        double balance = {};
    };

    struct Eattr {
        double cost = {};
    };

    using Gr = AttributedGraph<Digraph, Gattr, Vattr, Eattr>;

    auto g = peterson<Gr>();
    g->x = 23;
    for (auto u : g.nodes()) {
        g.node(u).balance = +1;
    }
    for (auto e : g.edges()) {
        g.edge(e).cost = 42.0;
    }
}

SCENARIO("biedge_map")
{
    auto net = peterson<Net>();
    Net::biedge_map<int> values(net);

    int i = 0;
    for (auto e : net.edges()) {
        values[net.forward(e)] = i++;
        values[net.backward(e)] = i++;
    }

    for (auto e : net.edges()) {
        REQUIRE(values[net.forward(e)] != values[net.backward(e)]);
    }
}

struct GraphInfo {
    std::string name;
};

std::ostream& operator<<(std::ostream& out, const GraphInfo& info)
{
    fifr::util::pretty_print_struct(out, "G", "name", info.name);
    return out;
}

std::istream& operator>>(std::istream& in, GraphInfo& info)
{
    fifr::util::pretty_read_struct(in, "G", "name", info.name);
    return in;
}

struct NodeInfo {
    double balance;
};

std::ostream& operator<<(std::ostream& out, const NodeInfo& info)
{
    fifr::util::pretty_print_struct(out, "N", "balance", info.balance);
    return out;
}

std::istream& operator>>(std::istream& in, NodeInfo& info)
{
    fifr::util::pretty_read_struct(in, "N", "balance", info.balance);
    return in;
}

struct EdgeInfo {
    double flow;
    double weight;
};

std::ostream& operator<<(std::ostream& out, const EdgeInfo& info)
{
    fifr::util::pretty_print_struct(out, "E", "flow", info.flow, "weight", info.weight);
    return out;
}

std::istream& operator>>(std::istream& in, EdgeInfo& info)
{
    fifr::util::pretty_read_struct(in, "E", "flow", info.flow, "weight", info.weight);
    return in;
}

SCENARIO("pretty-print graph")
{
    GIVEN("some graph")
    {
        auto g = peterson<Net>();

        WHEN("writing and reading the nodes")
        {
            for (auto u : g.nodes()) {
                std::ostringstream out;
                out << u;
                std::istringstream in(out.str());
                Digraph::Node v;
                in >> v;
                REQUIRE(u == v);
            }

            for (auto e : g.edges()) {
                std::ostringstream out;
                out << g.backward(e) << " " << g.forward(e);
                std::istringstream in(out.str());
                Digraph::Edge f1, f2;
                in >> f1 >> f2;
                REQUIRE(e == f1);
                REQUIRE(e == f2);
            }
        }

        WHEN("writing and reading the graph")
        {
            std::ostringstream out;
            out << g;
            std::istringstream in(out.str());
            Digraph h;
            in >> h;

            THEN("the two graphs should be identical")
            {
                REQUIRE(g.num_nodes() == h.num_nodes());
                REQUIRE(g.num_edges() == h.num_edges());

                for (auto e : g.edges()) {
                    auto f = h.id2edge(g.edge_id(e));
                    REQUIRE(g.node_id(g.src(e)) == h.node_id(h.src(e)));
                    REQUIRE(g.node_id(g.snk(e)) == h.node_id(h.snk(e)));
                }
            }
        }
    }

    GIVEN("an attributed graph")
    {
        using G = AttributedGraph<Net, GraphInfo, NodeInfo, EdgeInfo>;
        auto g = peterson<G>();

        g->name = "peterson";

        for (auto u : g.nodes()) {
            g[u].balance = g.node_id(u);
        }
        for (auto e : g.edges()) {
            g[e].weight = g.edge_id(e);
            g[e].flow = -static_cast<double>(g.edge_id(e));
        }

        WHEN("writing and reading the graph")
        {
            std::ostringstream out;
            out << g;
            std::istringstream in(out.str());
            G h;
            in >> h;

            for (auto u : h.nodes()) {
                REQUIRE(h[u].balance == h.node_id(u));
            }

            for (auto e : h.edges()) {
                REQUIRE(h[e].weight == h.edge_id(e));
                REQUIRE(h[e].flow == -static_cast<double>(h.edge_id(e)));
            }
        }
    }
}

/*
 * Copyright (c) 2016 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#define CATCH_CONFIG_MAIN
#include "catch.hpp"

/*
 * Copyright (c) 2024 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

#include "catch.hpp"

#include <fifr/graph/Classes.hxx>
#include <fifr/graph/VecGraph.hxx>

using namespace fifr::graph;

SCENARIO("VecGraph")
{
    GIVEN("An empty graph")
    {
        VecGraph<> g;

        THEN("it should contain no nodes")
        {
            REQUIRE(g.num_nodes() == 0);
            for (auto u : g.nodes()) {
                REQUIRE(false);
            }
        }

        THEN("it should contain no edges")
        {
            REQUIRE(g.num_edges() == 0);
            for (auto u : g.edges()) {
                REQUIRE(false);
            }
        }

        THEN("it should iterator over incident edges")
        {
            for (auto u : g.nodes()) {
                for (auto [e, v] : g.neighs(u)) {
                    (void)e;
                    REQUIRE(false);
                }
            }
        }

        THEN("it should iterate over incoming edges")
        {
            for (auto u : g.nodes()) {
                for (auto [e, v] : g.in_edges(u)) {
                    (void)e;
                    REQUIRE(false);
                }
            }
        }

        THEN("it should iterate over outgoing edges")
        {
            for (auto u : g.nodes()) {
                for (auto [e, v] : g.out_edges(u)) {
                    (void)e;
                    REQUIRE(false);
                }
            }
        }
    }

    GIVEN("some graph")
    {
        for (auto& g : {cycle<VecGraph<>>(7)}) {
            for (auto u : g.nodes()) {
                for (auto [e, v] : g.out_edges(u)) {
                    REQUIRE(u == g.src(e));
                    REQUIRE(v == g.snk(e));
                }
                for (auto [e, v] : g.in_edges(u)) {
                    REQUIRE(u == g.snk(e));
                    REQUIRE(v == g.src(e));
                }
            }
        }
    }
}

cmake_minimum_required(VERSION 3.12)

project(
  fifrutil
  VERSION 0.1.0
  LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 17)

add_subdirectory(src/fifr/util)

# Enable testing if this is toplevel.
if ( BUILD_TESTING AND (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) )
  enable_testing()
  add_subdirectory(tests)
endif ()


# package stuff

set(SUPPORTED_COMPONENTS)
if (ZLIB_FOUND)
  set (SUPPORTED_COMPONENTS GZip)
endif ()
if (BZIP2_FOUND)
  set (SUPPORTED_COMPONENTS "${SUPPORTED_COMPONENTS} BZip2")
endif ()

include(CMakePackageConfigHelpers)
write_basic_package_version_file(
  "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilConfigVersion.cmake"
  VERSION ${fifrutil_VERSION}
  COMPATIBILITY SameMajorVersion
  )

configure_file(cmake/FifrUtilConfig.cmake
  "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilConfig.cmake"
  @ONLY)

set(ConfigPackageLocation lib/cmake/FifrUtil)
export(
  EXPORT FifrUtilTargets
  FILE "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilTargets.cmake"
  NAMESPACE Fifr::
  )
install(EXPORT FifrUtilTargets
  FILE FifrUtilTargets.cmake
  NAMESPACE Fifr::
  DESTINATION ${ConfigPackageLocation}
  )
install(
  FILES
  "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilConfig.cmake"
  "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilConfigVersion.cmake"
  DESTINATION ${ConfigPackageLocation}
  COMPONENT
  devel
  )

get_directory_property(hasParent PARENT_DIRECTORY)
if (ZLIB_FOUND)
  export(
    EXPORT FifrUtilGZipTargets
    FILE "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilGZipTargets.cmake"
    NAMESPACE Fifr::Util::
    )
  install(EXPORT FifrUtilGZipTargets
    FILE FifrUtilGZipTargets.cmake
    NAMESPACE Fifr::Util::
    DESTINATION ${ConfigPackageLocation}
    )
  if (hasParent)
    set(FifrUtil_GZip_FOUND TRUE PARENT_SCOPE)
  endif ()
endif ()

if (BZIP2_FOUND)
  export(
    EXPORT FifrUtilBZip2Targets
    FILE "${CMAKE_CURRENT_BINARY_DIR}/FifrUtil/FifrUtilBZip2Targets.cmake"
    NAMESPACE Fifr::Util::
    )
  install(EXPORT FifrUtilBZip2Targets
    FILE FifrUtilBZip2Targets.cmake
    NAMESPACE Fifr::Util::
    DESTINATION ${ConfigPackageLocation}
    )
  if (hasParent)
    set(FifrUtil_BZip2_FOUND TRUE PARENT_SCOPE)
  endif ()
endif ()

# Doxyfile 1.8.9.1

# 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           = "fifr::util"

# 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         =

# 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          =

# With the PROJECT_LOGO tag one can specify a logo or an 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       = doc

# 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  = NO

# 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            = YES

# 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           = YES

# 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               = 4

# 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                =

# 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  = YES

# 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 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   = NO

# 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        = NO

# 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        = NO

# 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. If 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   = NO

# 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     = YES

# 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       = YES

# 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 HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.

HIDE_COMPOUND_REFERENCE= 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   = NO

# 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. See also \cite for info how to create references.

CITE_BIB_FILES         = doc/refs.bib

#---------------------------------------------------------------------------
# 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                  = README.md src/fifr src/fifr/util

# 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              = NO

# 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             = doc

# 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 additional user-defined
# cascading style sheets that are 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 therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). 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 style sheet 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 style sheets (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

# If 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 pre-rendered 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            = NO

# 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://www.mathjax.org/mathjax

# 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.

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         = latex

# 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     = makeindex

# 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          = NO

# 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         = amsmath \
                         dsfont

# 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,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
# string, for the replacement values of the other commands the user is referred
# to HTML_HEADER.
# 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. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the 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_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
# will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list).
# This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_EXTRA_STYLESHEET =

# 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 USE_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    =

# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
# with syntax highlighting in the RTF 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_RTF is set to YES.

RTF_SOURCE_CODE        = NO

#---------------------------------------------------------------------------
# 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

# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
# program listings (including syntax highlighting and cross-referencing
# information) to the DOCBOOK output. Note that enabling this will significantly
# increase the size of the DOCBOOK output.
# The default value is: NO.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.

DOCBOOK_PROGRAMLISTING = NO

#---------------------------------------------------------------------------
# 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 include 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 in 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           =

# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file. If left blank, it is assumed
# PlantUML is not used or called during a preprocessing step. Doxygen will
# generate a warning when it encounters a \startuml command in this case and
# will not generate output for the diagram.

PLANTUML_JAR_PATH      =

# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.

PLANTUML_INCLUDE_PATH  =

# 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 to 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      = YES

# 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

fifr::util C++ utility library
================================

Introduction
------------

This is small library of useful C++ functions.

Documentation
-------------

The (very sparse) API documentation can found [here][API].

   [API]: doc/html/index.html
   
Download
--------

Latest development version: [util-trunk.tar.gz][TRUNK]

The project lives in a [fossil](http://fossil-scm.org) repository. In
order to clone the repository, execute the following commands:

    fossil clone http://fifr.spdns.de/cpp-util path/to/cpp-util.fossil
	mkdir path/to/util-sources
	cd path/to/util-sources
	fossil open path/to/cpp-util.fossil
	
   [TRUNK]: http://fifr.spdns.de/fossils/cpp-util/tarball/util-trunk.tar.gz?name=util
   
Installation
------------

**fifr::util** is designed to be copied into your project. Just copy
all files from the `src/` directory to your project. Note that
**fifr::util** requires C++14.

cmake_policy(SET CMP0054 NEW)

include(CMakeFindDependencyMacro)

include("${CMAKE_CURRENT_LIST_DIR}/FifrUtilTargets.cmake")

set(_supported_components @SUPPORTED_COMPONENTS@)

foreach(_comp ${FifrUtil_FIND_COMPONENTS})
  if (NOT ";${_supported_components};" MATCHES ${_comp})
    if (FifrUtil_FIND_REQUIRED_${_comp})
      set(FifrUtil_FOUND False)
      set(FifrUtil_NOT_FOUND_MESSAGE "Unsupported component: ${_comp}")
    endif ()
  else ()
    if ("${_comp}" STREQUAL "GZip")
      #find_dependency(ZLIB)
    else ()
      find_dependency(${_comp})
    endif ()
    set(FifrUtil_${_comp}_FOUND True)
    include("${CMAKE_CURRENT_LIST_DIR}/FifrUtil${_comp}Targets.cmake")
  endif ()
endforeach()

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::all_range Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00001.html">all_range</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">fifr::util::all_range Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Range covering all elements.  
 <a href="a00001.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00032_source.html">Range.hxx</a>&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Range covering all elements. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00032_source.html">Range.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:02 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::AutoTuple&lt; Args &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00002.html">AutoTuple</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::AutoTuple&lt; Args &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Trait for returning tuple, pair or value depending on the number of type arguments.  
 <a href="a00002.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00029_source.html">AutoTuple.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a128ec7c89c8a49b8c20634781cad1843"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a128ec7c89c8a49b8c20634781cad1843"></a>
typedef std::tuple&lt; Args...&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr class="separator:a128ec7c89c8a49b8c20634781cad1843"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename... Args&gt;<br />
struct fifr::util::AutoTuple&lt; Args &gt;</h3>

<p>Trait for returning tuple, pair or value depending on the number of type arguments. </p>
<p>If the number of type arguments is 1, the returned type is the type itself. If the number of type arguments is 2, the returned type is a pair of these types. Otherwise the returned type is a tuple of these types. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00029_source.html">AutoTuple.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:02 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; To, From, Enable &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00003.html">Convert</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; To, From, Enable &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Trait for converting two types.  
 <a href="a00003.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename To, typename From, typename Enable = void&gt;<br />
struct fifr::util::Convert&lt; To, From, Enable &gt;</h3>

<p>Trait for converting two types. </p>
<p>A specialization is expected to implement a single static function <code>convert</code> </p><pre class="fragment">static To convert(From x);</pre> </div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:02 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; double, const char * &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00004.html">Convert&lt; double, const char * &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; double, const char * &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>double</code>.  
 <a href="a00004.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a84b0457c9a6275a59b8258f966a2309b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84b0457c9a6275a59b8258f966a2309b"></a>
static double&#160;</td><td class="memItemRight" valign="bottom"><b>convert</b> (const char *str)</td></tr>
<tr class="separator:a84b0457c9a6275a59b8258f966a2309b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br />
struct fifr::util::Convert&lt; double, const char * &gt;</h3>

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>double</code>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:03 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; float, const char * &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00005.html">Convert&lt; float, const char * &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; float, const char * &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>float</code>.  
 <a href="a00005.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a67428888f29bda7a3d8120fb3ab4e405"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67428888f29bda7a3d8120fb3ab4e405"></a>
static float&#160;</td><td class="memItemRight" valign="bottom"><b>convert</b> (const char *str)</td></tr>
<tr class="separator:a67428888f29bda7a3d8120fb3ab4e405"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br />
struct fifr::util::Convert&lt; float, const char * &gt;</h3>

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>float</code>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:03 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; int, const char * &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00006.html">Convert&lt; int, const char * &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; int, const char * &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>int</code>.  
 <a href="a00006.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7e45fc14d7639d8b72daa9b1c809f956"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e45fc14d7639d8b72daa9b1c809f956"></a>
static int&#160;</td><td class="memItemRight" valign="bottom"><b>convert</b> (const char *str)</td></tr>
<tr class="separator:a7e45fc14d7639d8b72daa9b1c809f956"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br />
struct fifr::util::Convert&lt; int, const char * &gt;</h3>

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>int</code>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:03 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; long double, const char * &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00007.html">Convert&lt; long double, const char * &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; long double, const char * &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>long double</code>.  
 <a href="a00007.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:acf4b07435a54af6310a5f77ff24d9ec3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf4b07435a54af6310a5f77ff24d9ec3"></a>
static long double&#160;</td><td class="memItemRight" valign="bottom"><b>convert</b> (const char *str)</td></tr>
<tr class="separator:acf4b07435a54af6310a5f77ff24d9ec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br />
struct fifr::util::Convert&lt; long double, const char * &gt;</h3>

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>long double</code>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:03 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; long long, const char * &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00008.html">Convert&lt; long long, const char * &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; long long, const char * &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>long long</code>.  
 <a href="a00008.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af19ce4e9c5a5db1867c120fcff35ee63"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af19ce4e9c5a5db1867c120fcff35ee63"></a>
static long long&#160;</td><td class="memItemRight" valign="bottom"><b>convert</b> (const char *str)</td></tr>
<tr class="separator:af19ce4e9c5a5db1867c120fcff35ee63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br />
struct fifr::util::Convert&lt; long long, const char * &gt;</h3>

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>long long</code>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:03 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fifr::util: src/fifr/util/AutoTuple.hxx Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_410dc4a63588d435a0c08a3db8b9f0cd.html">fifr</a></li><li class="navelem"><a class="el" href="dir_2a722471f978b7073f859d2d7c3aa2b4.html">util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">AutoTuple.hxx</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2017 Frank Fischer &lt;frank-fischer@shadow-soft.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * modify it under the terms of the GNU General Public License as</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * published by the Free Software Foundation, either version 3 of the</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * License, or (at your option) any later version.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful, but</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * General Public License for more details.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * along with this program.  If not, see  &lt;http://www.gnu.org/licenses/&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#ifndef __FIFR_UTIL_AUTOTUPLE_HXX__</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#define __FIFR_UTIL_AUTOTUPLE_HXX__</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;tuple&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00078.html">fifr</a></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;{</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="a00079.html">   25</a></span>&#160;<span class="keyword">namespace </span>util</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="a00631.html">   34</a></span>&#160;<span class="keyword">struct </span><a class="code" href="a00631.html">AutoTuple</a> {</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keyword">typedef</span> std::tuple&lt;Args...&gt; type;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;};</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Arg&gt;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="keyword">struct </span><a class="code" href="a00631.html">AutoTuple</a>&lt;Arg&gt; {</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keyword">typedef</span> Arg type;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;};</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Arg1, <span class="keyword">typename</span> Arg2&gt;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">struct </span>AutoTuple&lt;Arg1, Arg2&gt; {</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keyword">typedef</span> std::pair&lt;Arg1, Arg2&gt; type;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;};</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="a00079.html#a2bdff2715e924516df9cc786e65d248e">   56</a></span>&#160;<span class="keyword">typename</span> <a class="code" href="a00631.html">AutoTuple</a>&lt;Args...&gt;::type <a class="code" href="a00079.html#a2bdff2715e924516df9cc786e65d248e">make_auto_tuple</a>(Args&amp;&amp;... args)</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;{</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keywordflow">return</span> <span class="keyword">typename</span> <a class="code" href="a00631.html">AutoTuple</a>&lt;Args...&gt;::type{std::forward&lt;Args&gt;(args)...};</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;}</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;}  <span class="comment">// namespace util</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;}  <span class="comment">// namespace fifr</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="a00079_html_a2bdff2715e924516df9cc786e65d248e"><div class="ttname"><a href="a00079.html#a2bdff2715e924516df9cc786e65d248e">fifr::util::make_auto_tuple</a></div><div class="ttdeci">AutoTuple&lt; Args... &gt;::type make_auto_tuple(Args &amp;&amp;... args)</div><div class="ttdoc">Return the arguments as value, pair or tuple. </div><div class="ttdef"><b>Definition:</b> AutoTuple.hxx:56</div></div>
<div class="ttc" id="a00078_html"><div class="ttname"><a href="a00078.html">fifr</a></div><div class="ttdef"><b>Definition:</b> AutoTuple.hxx:23</div></div>
<div class="ttc" id="a00631_html"><div class="ttname"><a href="a00631.html">fifr::util::AutoTuple</a></div><div class="ttdoc">Trait for returning tuple, pair or value depending on the number of type arguments. </div><div class="ttdef"><b>Definition:</b> AutoTuple.hxx:34</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 6 2018 13:22:44 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>fifr::util: fifr::util::Convert&lt; long, const char * &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">fifr::util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>fifr</b></li><li class="navelem"><a class="el" href="a00042.html">util</a></li><li class="navelem"><a class="el" href="a00009.html">Convert&lt; long, const char * &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">fifr::util::Convert&lt; long, const char * &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>long</code>.  
 <a href="a00009.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00030_source.html">Convert.hxx</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abec419a160e63a41314a13e82e1b5a25"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abec419a160e63a41314a13e82e1b5a25"></a>
static long&#160;</td><td class="memItemRight" valign="bottom"><b>convert</b> (const char *str)</td></tr>
<tr class="separator:abec419a160e63a41314a13e82e1b5a25"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;&gt;<br />
struct fifr::util::Convert&lt; long, const char * &gt;</h3>

<p><a class="el" href="a00003.html" title="Trait for converting two types. ">Convert</a> <code>const char*</code> to <code>long</code>. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/fifr/util/<a class="el" href="a00030_source.html">Convert.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 21 2017 22:46:03 for fifr::util by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>