From 7f19d641647ac4ef313ed88d6b5c140983ce5436 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 15 Jul 2020 08:20:18 +0100 Subject: Squashed 'third_party/immer/' content from commit ad3e3556d git-subtree-dir: third_party/immer git-subtree-split: ad3e3556d38bb75966dd24c61a774970a7c7957e --- doc/algorithms.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 doc/algorithms.rst (limited to 'doc/algorithms.rst') diff --git a/doc/algorithms.rst b/doc/algorithms.rst new file mode 100644 index 000000000000..f7de519c05d9 --- /dev/null +++ b/doc/algorithms.rst @@ -0,0 +1,28 @@ + +Algorithms +========== + +This module provides overloads of standard algorithms that leverage +the internal structure of the immutable containers to provide faster +iteration. These are drop-in replacements of the respective STL +algorithms that can be a few times faster when applied on immutable +sequences. + +For further convenience they can be passed in just a container where +the standard library algorithms require being passed in two iterators. + +.. note:: + + They are a similar idea to `structure-aware iterators`_ + but implemented using higher order functions in order to support + structures of any depth. The downside is that this sometimes + causes the compiler to generate bigger executable files. + +.. _structure-aware iterators: https://www.youtube.com/watch?v=T3oA3zAMH9M + + +----- + +.. doxygengroup:: algorithm + :project: immer + :content-only: -- cgit 1.4.1