<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <meta name="generator" content="HTML Tidy, see www.w3.org">
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <link rel="stylesheet" type="text/css" href="../boost.css">

    <title>Boost.Python - &lt;{{header}}&gt;</title>

    <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
    "header">
      <tr>
        <td valign="top" width="300">
          <h3><a href="../../../../index.htm"><img height="86" width="277" alt=
          "C++ Boost" src="../../../../boost.png" border="0"></a></h3>

        <td valign="top">
          <h1 align="center"><a href="../index.html">Boost.Python</a></h1>

          <h2 align="center">Header &lt;{{header}}&gt;</h2>
    </table>
    <hr>

    <h2>Contents</h2>

    <dl class="page-index">
      <dt><a href="#introduction">Introduction</a>

      <dt><a href="#macros">Macros</a>

      <dd>
        <dl class="page-index">
          <dt><a href="#macro-spec">{{macro name}}</a>
        </dl>

      <dt><a href="#values">Values</a>

      <dd>
        <dl class="page-index">
          <dt><a href="#value-spec">{{value name}}</a>
        </dl>

      <dt><a href="#types">Types</a>

      <dd>
        <dl class="page-index">
          <dt><a href="#type-spec">{{type name}}</a>
        </dl>

      <dt><a href="#classes">Classes</a>

      <dd>
        <dl class="page-index">
          <dt><a href="#class-spec">Class <code>{{name}}</code></a>

          <dd>
            <dl class="page-index">
              <dt><a href="#class-spec-synopsis">Class <code>{{name}}</code> synopsis</a>

              <dt><a href="#class-spec-ctors">Class <code>{{name}}</code>
              constructors and destructor</a>

              <dt><a href="#class-spec-comparisons">Class <code>{{name}}</code> comparison functions</a>

              <dt><a href="#class-spec-modifiers">Class <code>{{name}}</code> modifier functions</a>

              <dt><a href="#class-spec-observers">Class <code>{{name}}</code> observer functions</a>

              <dt><a href="#class-spec-statics">Class <code>{{name}}</code> static functions</a>
            </dl>
        </dl>

      <dt><a href="#functions">Functions</a>

      <dd>
        <dl class="page-index">
          <dt><a href="#function-spec">{{function name}}</a>
        </dl>

      <dt><a href="#objects">Objects</a>

      <dd>
        <dl class="page-index">
          <dt><a href="#object-spec">{{object name}}</a>
        </dl>

      <dt><a href="#examples">Example(s)</a>
    </dl>
    <hr>

    <h2><a name="introduction"></a>Introduction</h2>

    <p>{{Introductory text}}

    <h2><a name="macros"></a>Macros</h2>

    <p><a name="macro-spec"></a>{{Macro specifications}}

    <h2><a name="values"></a>Values</h2>

    <p><a name="value-spec"></a>{{Value specifications}}

    <h2><a name="types"></a>Types</h2>

    <p><a name="type-spec"></a>{{Type specifications}}

    <h2><a name="classes"></a>Classes</h2>

    <h3><a name="class-spec"></a>Class <code>{{name}}</code></h3>

    <p>{{class overview text}}

    <h4><a name="class-spec-synopsis"></a>Class <code>{{name}}</code> synopsis</h4>
<pre>
namespace boost
{
    class {{name}}
  {
  };
};
</pre>

    <h4><a name="class-spec-ctors"></a>Class <code>{{name}}</code> constructors and
    destructor</h4>
<pre>
{{constructor}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>
<pre>
{{destructor}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>

    <h4><a name="class-spec-comparisons"></a>Class <code>{{name}}</code> comparison
    functions</h4>
<pre>
{{function}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>

    <h4><a name="class-spec-modifiers"></a>Class <code>{{name}}</code> modifier
    functions</h4>
<pre>
{{function}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>

    <h4><a name="class-spec-observers"></a>Class <code>{{name}}</code> observer
    functions</h4>
<pre>
{{function}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>

    <h4><a name="class-spec-statics"></a>Class <code>{{name}}</code> static functions</h4>
<pre>
{{function}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>

    <h2><a name="functions"></a>Functions</h2>
<pre>


<a name="function-spec"></a>{{function}}
</pre>

    <dl class="function-semantics">
      <dt><b>Requires:</b> {{text}}

      <dt><b>Effects:</b> {{text}}

      <dt><b>Postconditions:</b> {{text}}

      <dt><b>Returns:</b> {{text}}

      <dt><b>Throws:</b> {{text}}

      <dt><b>Complexity:</b> {{text}}

      <dt><b>Rationale:</b> {{text}}
    </dl>

    <h2><a name="objects"></a>Objects</h2>

    <p><a name="object-spec"></a>{{Object specifications}}

    <h2><a name="examples"></a>Example(s)</h2>

    <p>{{Example(s)}}

    <p>Revised 
    <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
  13 November, 2002
  <!--webbot bot="Timestamp" endspan i-checksum="39359" -->


    <p><i>&copy; Copyright <a href="../../../../people/dave_abrahams.htm">Dave
    Abrahams</a> 2002. </i>

