Files
boost_fusion/doc/html/fusion/organization.html
Joel de Guzman 6ca462baa0 doc updates
[SVN r35784]
2006-10-30 01:20:23 +00:00

199 lines
7.4 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Organization</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../index.html" title="Chapter 1. Fusion 2.0">
<link rel="prev" href="quick_start.html" title="Quick Start">
<link rel="next" href="support.html" title="Support">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="quick_start.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="support.html"><img src="../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="fusion.organization"></a><a href="organization.html" title="Organization">Organization</a></h2></div></div></div>
<p>
The library is organized into layers of modules, with each module addressing
a particular area of responsibility. A module may not depend on modules in
higher layers.
</p>
<p>
The library is organized in three layers:
</p>
<a name="fusion.organization.layers"></a><h3>
<a name="id449970"></a>
<a href="organization.html#fusion.organization.layers">Layers</a>
</h3>
<div class="blockquote"><blockquote class="blockquote"><p>
<span class="inlinemediaobject"><img src="../images/fusion_org.png" alt="fusion_org"></span>
</p></blockquote></div>
<p>
The entire library is found in the "boost/fusion" directory. Modules
are organized in directories. Each module has its own header file placed in
the same directory with the actual module-directory. For example, there exists
"boost/fusion/support.hpp" in the same directory as "boost/fusion/support".
Everything, except those found inside "detail" directories, is public.
The library is header-only. There is no need to build object files to link
against.
</p>
<a name="fusion.organization.directory"></a><h3>
<a name="id450024"></a>
<a href="organization.html#fusion.organization.directory">Directory</a>
</h3>
<div class="itemizedlist"><ul type="disc">
<li>
tuple
</li>
<li>
algorithm
<div class="itemizedlist"><ul type="circle">
<li>
iteration
</li>
<li>
query
</li>
<li>
transformation
</li>
</ul></div>
</li>
<li>
sequence
<div class="itemizedlist"><ul type="circle">
<li>
adapted
<div class="itemizedlist"><ul type="disc">
<li>
array
</li>
<li>
mpl
</li>
<li>
std_pair
</li>
</ul></div>
</li>
<li>
comparison
</li>
<li>
container
<div class="itemizedlist"><ul type="disc">
<li>
list
</li>
<li>
map
</li>
<li>
set
</li>
<li>
vector
</li>
</ul></div>
</li>
<li>
conversion
</li>
<li>
generation
</li>
<li>
intrinsic
</li>
<li>
io
</li>
<li>
utility
</li>
<li>
view
<div class="itemizedlist"><ul type="disc">
<li>
filter_view
</li>
<li>
iterator_range
</li>
<li>
joint_view
</li>
<li>
reverse_view
</li>
<li>
single_view
</li>
<li>
transform_view
</li>
<li>
zip_view
</li>
</ul></div>
</li>
</ul></div>
</li>
<li>
iterator
</li>
<li>
support
</li>
</ul></div>
<a name="fusion.organization.example"></a><h3>
<a name="id450196"></a>
<a href="organization.html#fusion.organization.example">Example</a>
</h3>
<p>
If, for example, you want to use <tt class="computeroutput"><span class="identifier">list</span></tt>,
depending on the granularity that you desire, you may do so by including one
of
</p>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">list</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<p>
The first includes all sequences. The second includes all of sequence containers.
The third includes only <tt class="computeroutput"><span class="identifier">list</span></tt> 
<sup>[<a name="id450436" href="#ftn.id450436">3</a>]</sup>
.
</p>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id450436" href="#id450436">3</a>] </sup>
Modules may contain smaller components. Header file information for each
component will be provided as part of the component's documentation.
</p></div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="quick_start.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="support.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>