ceph/src/boost/libs/fusion/doc/preface.qbk

   1 [/==============================================================================
   2     Copyright (C) 2001-2011 Joel de Guzman
   3     Copyright (C) 2006 Dan Marsden
   4
   5     Use, modification and distribution is subject to the Boost Software
   6     License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
   7     http://www.boost.org/LICENSE_1_0.txt)
   8 ===============================================================================/]
   9 [section Preface]
  10
  11 [:['["Algorithms + Data Structures = Programs.]]]
  12 [:*--Niklaus Wirth*]
  13
  14 [heading Description]
  15
  16 Fusion is a library for working with heterogeneous collections of data,
  17 commonly referred to as tuples. A set of containers (vector, list, set and map)
  18 is provided, along with views that provide a transformed presentation
  19 of their underlying data. Collectively the containers and views are referred to
  20 as sequences, and Fusion has a suite of algorithms that operate upon the
  21 various sequence types, using an iterator concept that binds everything
  22 together.
  23
  24 The architecture is modeled after __mpl__ which in turn is modeled after
  25 __stl__. It is named "fusion" because the library is a "fusion" of compile
  26 time metaprogramming with runtime programming.
  27
  28 [heading Motivation]
  29
  30 Tuples are powerful beasts. After having developed two significant projects
  31 (__spirit__ and __phoenix__) that relied heavily metaprogramming, it
  32 became apparent that tuples are a powerful means to simplify otherwise tricky
  33 tasks; especially those that require a combination of metaprogramming and
  34 manipulation of heterogeneous data types with values. While __mpl__ is an
  35 extremely powerful metaprogramming tool, __mpl__ focuses on type
  36 manipulation only. Ultimately, you'll have to map these types to real
  37 values to make them useful in the runtime world where all the real action
  38 takes place.
  39
  40 As __spirit__ and __phoenix__ evolved, patterns and idioms related to tuple
  41 manipulation emerged. Soon, it became clear that those patterns and idioms
  42 were best assembled in a tuples algorithms library. __david_abrahams__
  43 outlined such a scheme in 2002. At that time, it just so happened that
  44 __spirit__ and __phoenix__ had an adhoc collection of tuple manipulation
  45 and traversal routines. It was an instant /AHA!/ moment.
  46
  47 [heading How to use this manual]
  48
  49 Some icons are used to mark certain topics indicative of their relevance.
  50 These icons precede some text to indicate:
  51
  52 [note Information provided is auxiliary but will give the reader a deeper
  53 insight into a specific topic. May be skipped.]
  54 [important Information provided is of utmost importance.]
  55 [caution A mild warning.]
  56 [tip A potentially useful and helpful piece of information.]
  57
  58 This documentation is automatically generated by Boost QuickBook documentation
  59 tool. QuickBook can be found in the __boost_tools__.
  60
  61 [heading Support]
  62
  63 Please direct all questions to Spirit's mailing list. You can subscribe to the
  64 __spirit_list__. The mailing list has a searchable archive. A search link to
  65 this archive is provided in __spirit__'s home page. You may also read and post
  66 messages to the mailing list through __spirit_general__ (thanks to __gmane__).
  67 The news group mirrors the mailing list. Here is a link to the archives:
  68 __mlist_archive__.
  69
  70 [endsect]
  71