Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ptomulik/tml

Template Metaprogramming Library
https://github.com/ptomulik/tml

Last synced: 3 months ago
JSON representation

Template Metaprogramming Library

Awesome Lists containing this project

README 

        
TML

===



.. image:: https://travis-ci.org/ptomulik/tml.svg?branch=master

    :target: https://travis-ci.org/ptomulik/tml



Template Metaprogramming Library



Overview

--------



The TML library is a general-purpose C++ template metaprogramming library with

compile-time algorithms, sequences and metafunctions. It's my few-week

excercize to better understand the C++ templates and metaprogramming. It's

inspired by `Boost.MPL`_ and `tinympl`_. It tries to preserve the

`Boost.MPL`_'s concepts and interfaces while adding few new concepts and

features. The implementation of TML makes use of the C++11 features, resulting

in smaller code base.



Status

------



It's just the beginning. Many things are missing or incomplete.



Features

--------



Sequences

^^^^^^^^^



The TML introduces new sequence class called ``sequence``. It models what I

call a *Variadic Template Sequence*. The concept of *Template Sequence* makes

an explicit assumption, that sequence is an instantiation ``X``

of some template class ``X`` with type parameters, and ``a0,...,a{n-1}`` are

then the elements of the sequence. A *Variadic Template Sequence* is a

refinement of *Template Sequence* with ``X`` being a variadic template.



At the moment I'm focussed on these *Template Sequences*, so sequence

metafunctions are implemented only for *Template Sequences*. There is no

support for MPL sequences such as ``vector`` or ``list`` and probably will

never be (it's not decided yet, but it seems to be no point to reimplement

already existing features).



Classes

```````



- [ ] vector

- [ ] list

- [ ] deque

- [ ] set

- [ ] map

- [ ] range_c

- [ ] vector_c

- [ ] list_c

- [ ] set_c

- [ ] string

- [x] sequence (new)



Views

`````



- [ ] empty_sequence

- [ ] filter_view

- [ ] iterator_range

- [ ] joint_view

- [ ] single_view

- [ ] transform_view

- [ ] zip_view



Intrinsic Metafunctions

```````````````````````



There are two new intrinsic metafunctions: ``apply_sequence`` and

``sequence_generator``. The ``apply_sequence`` is used to pass elements of

a sequence as arguments to a *Lambda Expression*. The ``sequence_generator``

metafunction is used to obtain a *Sequence Generator* ``G`` for a particular

sequence, such that one can generate concept-identical sequences by just

applying new elements to ``G``.



+--------------------+--------+------+-------+-----+-----+--------+----------+

|                    | vector | list | deque | set | map | string | sequence |

+====================+========+======+=======+=====+=====+========+==========+

| apply_sequence     |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| at                 |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| at_c               |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| back               |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| begin              |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| clear              |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| empty              |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| end                |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| erase              |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| erase_key          |        |      |       |     |     |        |    N/A   |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| front              |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| has_key            |        |      |       |     |     |        |    N/A   |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| insert             |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| insert_range       |        |      |       |     |     |        |          |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| is_sequence        |        |      |       |     |     |        |    N/A   |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| key_type           |        |      |       |     |     |        |    N/A   |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| order              |        |      |       |     |     |        |    N/A   |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| pop_back           |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| pop_front          |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| push_back          |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| push_front         |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| sequence_generator |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| sequence_tag       |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| size               |        |      |       |     |     |        |     Y    |

+--------------------+--------+------+-------+-----+-----+--------+----------+

| value_type         |        |      |       |     |     |        |    N/A   |

+--------------------+--------+------+-------+-----+-----+--------+----------+



Iterators

^^^^^^^^^



*Template Sequences* are accompanied with *Template Sequence Iterators*. All

the iterator metafunctions are implemented for these iterators, that is:



- [x] advance,

- [x] distance,

- [x] next,

- [x] prior,

- [x] deref,

- [x] iterator_category.



Note that there is no support for other iterators, especially no default

implementation of the above metafunctions.



Algorithms

^^^^^^^^^^



Algorithms currently are missing. They will be added systematically.



Inserters

`````````



- [ ] back_inserter,

- [ ] front_inserter,

- [ ] inserter.



Iteration Algorighmts

`````````````````````



- [ ] fold,

- [ ] iter_fold,

- [ ] reverse_fold,

- [ ] reverse_iter_fold,

- [ ] accumulate.



Querying Algorithms

```````````````````



- [ ] find,

- [ ] find_if,

- [ ] contains,

- [ ] count,

- [ ] count_if,

- [ ] lower_bound,

- [ ] upper_bound,

- [ ] min_element,

- [ ] max_element,

- [x] equal.



Transformation Algorithms

`````````````````````````



- [ ] copy,

- [ ] copy_if,

- [ ] transform,

- [ ] replace,

- [ ] replace_if,

- [ ] remove,

- [ ] remove_if,

- [ ] unique,

- [ ] partition,

- [ ] stable_partition,

- [ ] sort,

- [ ] reverse,

- [ ] reverse_copy,

- [ ] reverse_copy_if,

- [ ] reverse_transform,

- [ ] reverse_replace,

- [ ] reverse_replace_if,

- [ ] reverse_remove,

- [ ] reverse_remove_if,

- [ ] reverse_unique,

- [ ] reverse_partition,

- [ ] reverse_stable_partition.



Runtime Algorithms

``````````````````



- [ ] for_each.



Metafunctions

^^^^^^^^^^^^^



Note, TML does not define numbered metafunctions (for example ``apply1``). Only

the unnumbered ones are available.



Type Selection

``````````````



- [x] if\_

- [x] if_c

- [ ] eval_if

- [ ] eval_if_c



Invocation

``````````



- [x] apply,

- [x] apply_sequence (new),

- [x] apply_wrap,

- [x] unpack_args.



Composing and Argument Binding

``````````````````````````````



- [x] Placeholders (except the unnamed placeholder),

- [x] lambda,

- [x] bind,

- [x] quote,

- [x] arg,

- [x] protect



Arithmetic Operations

`````````````````````



- [x] plus,

- [x] minus,

- [x] times,

- [x] divides,

- [x] modulus,

- [x] negate.



Comparisons

```````````



- [x] less,

- [x] less_equal,

- [x] greater,

- [x] greater_equal,

- [x] equal_to,

- [x] not_equal_to.



Logical Operations

``````````````````



- [x] and\_,

- [x] or\_,

- [x] not\_.



Bitwise Operations

``````````````````



- [x] bitand\_,

- [x] bitor\_,

- [x] bitxor\_,

- [x] shift_left,

- [x] shift_right.



Trivial

```````



- [ ] first,

- [ ] second,

- [ ] base.



String Operations

`````````````````



- [x] c_str,

- [x] num_to_string (new, also variants {short,int,long,size_t)_to_string).



SFINAE support

``````````````



This is new content w.r.t MPL.



- [x] enable_if,

- [x] enable_if_c,

- [x] enable_if_type.



Miscellaneous

`````````````



- [x] identity,

- [x] always,

- [ ] inherit,

- [ ] inherit_linearly,

- [x] numeric_cast,

- [x] min,

- [x] max,

- [x] sizeof\_.



Data Types

^^^^^^^^^^



Numeric

```````



- [x] bool\_,

- [x] int\_,

- [x] long\_,

- [x] size_t\_,

- [x] integral_c,

- [x] char\_.



Miscellaneous

`````````````



- [ ] pair,

- [x] empty_base,

- [x] void\_.



Supported compilers

-------------------



Currently supported compilers:



- gcc >= 4.7

- clang >= 3.4



I haven't tested with other compilers. Feedback is welcome.



Documentation

-------------



- `reference manual`_



Generating reference manual

---------------------------



.. code-block:: shell



    (cd doc/ && doxygen)



The generated documentation is written to ``doc/refman/html``.



Running tests

-------------



.. code-block:: shell



    bjam -a test example



Using specific compiler (e.g. clang):



.. code-block:: shell



    bjam toolset=clang -a test example



License

-------



Copyright (C) 2014, Pawel Tomulik 



Distributed under the Boost Software License, Version 1.0.

(See accompanying file LICENSE_1_0.txt or copy at

`http://www.boost.org/LICENSE_1_0.txt `_)



.. _Boost.MPL: http://www.boost.org/libs/mpl/doc/

.. _tinympl: https://github.com/sbabbi/tinympl

.. _reference manual: http://ptomulik.github.io/tml/refman/html/