Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.

{{library}}

Header <{{header}}>

Contents

Introduction
Macros
{{macro name}}
Values
{{value name}}
Types
{{type name}}
Classes
Class {{class name}}
Class {{class name}} synopsis
Class {{class name}} constructors and destructor
Class {{class name}} comparison functions
Class {{class name}} modifier functions
Class {{class name}} observer functions
Class {{class name}} static functions
Functions
{{function name}}
Objects
{{object name}}
Example(s)

Introduction

{{Introductory text}}

Macros

{{Macro specifications}}

Values

{{Value specifications}}

Types

{{Type specifications}}

Classes

Class {{class name}}

{{class overview text}}

Class {{class name}} synopsis

namespace boost
{
    class {{class name}}
        {
        };
};

Class {{class name}} constructors and destructor

{{constructor}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}
{{destructor}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}

Class {{class name}} comparison functions

{{function}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}

Class {{class name}} modifier functions

{{function}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}

Class {{class name}} observer functions

{{function}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}

Class {{class name}} static functions

{{function}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}

Functions

{{function}}
Requires: {{text}}
Effects: {{text}}
Postconditions: {{text}}
Returns: {{text}}
Throws: {{text}}
Complexity: {{text}}
Note: {{text}}
Danger: {{text}}
Rationale: {{text}}

Objects

{{Object specifications}}

Example(s)

{{Example(s)}}


Valid HTML 4.01 Transitional

Revised 04 December, 2006

Copyright © 2006 {{author}}

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)