The GNU C++ Library
		Next

The GNU C++ Library

Short Contents

Copyright (C) 2008-2021 FSF

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.

This is the top level of the libstdc++ documentation set. The documentation is divided into the following three sections.

Table of Contents

The GNU C++ Library Manual

I. Introduction

Implementation Status

C++ 1998/2003

Implementation Status
Implementation Specific Behavior

Implementation Specific Behavior

Implementation Specific Behavior

Filesystem TS

Implementation Specific Behavior

Parallelism 2 TS

Implementation Specific Behavior

C++ TR 24733

C++ IS 29124

Implementation Specific Behavior

The Code: GPL
The Documentation: GPL, FDL

Implementation Bugs
Standard Bugs

Prerequisites
Configure
Make

Command Options

Header Files
Mixing Headers
The C Headers and namespace std
Precompiled Headers

Troubleshooting

Available Namespaces
namespace std
Using Namespace Composition

Almost Nothing
Finding Dynamic or Shared Libraries
Experimental Library Extensions

Concurrency

Prerequisites

Thread Safety

Structure
Defaults
Future
Alternatives

Exception Safety

Exception Neutrality

Doing without

Compatibility

With C
With POSIX thread cancellation

Debugging Support

Debug Versions of Library Binary Files

Memory Leak Hunting

Non-memory leaks in Pool and MT allocators

Data Race Hunting

Tracking uncaught exceptions

Compile Time Checking

II. Standard Contents

Fundamental Types
Numeric Properties
NULL

Dynamic Memory

Additional Notes

Termination

Termination Handlers
Verbose Terminate Handler

5. Diagnostics

API Reference
Adding Data to exception

Use of errno by the library

Concept Checking

6. Utilities

Requirements

Design Issues

Implementation

Interface Design
Selecting Default Allocation Policy
Disabling Memory Caching

Using a Specific Allocator

Custom Allocators

Extension Allocators

Limitations
Use in Containers

Requirements

Design Issues

Implementation

Class Hierarchy
Thread Safety
Selecting Lock Policy
Related functions and classes

Examples
Unresolved Issues

Acknowledgments

String Classes

Simple Transformations
Case Sensitivity
Arbitrary Character Types
Tokenizing
Shrink to Fit
CString (MFC)

8. Localization

Requirements

Implementation

Interacting with "C" locales

Implementation

Specializations

Requirements

wchar_t Size
Support for Unicode
Other Issues

Implementation

Requirements

Implementation

Models
The GNU Model

9. Containers

list::size() is O(n)

Associative

Insertion Hints

Size Variable
Type String

Unordered Associative

Insertion Hints

Hash Code Caching Policy

Interacting with C

Containers vs. Arrays

10. Iterators

Iterators vs. Pointers
One Past the End

11. Algorithms

Specializations

12. Numerics

complex Processing

Generalized Operations

Interacting with C

Numerics vs. Arrays
C99

13. Input and Output

Iostream Objects

Stream Buffers

Derived streambuf Classes
Buffering

Memory Based Streams

Compatibility With strstream

File Based Streams

Copying a File
Binary Input and Output

Interacting with C

Using FILE* and file descriptors
Performance

14. Atomics

API Reference

15. Concurrency

API Reference

III. Extensions

16. Compile Time Checks

17. Debug Mode

Using the Debug Mode
Using a Specific Debug Container

The Wrapper Model

Safe Iterators
Safe Sequences (Containers)

Precondition Checking

Release- and debug-mode coexistence

Compile-time coexistence of release- and debug-mode components
Link- and run-time coexistence of release- and debug-mode components
Alternatives for Coexistence

Other Implementations

18. Parallel Mode

Prerequisite Compiler Flags
Using Parallel Mode
Using Specific Parallel Components

Interface Basics

Configuration and Tuning

Setting up the OpenMP Environment
Compile Time Switches
Run Time Settings and Defaults

Implementation Namespaces

Bibliography

19. The mt_allocator

Design Issues

Overview

Implementation

Tunable Parameters
Initialization
Deallocation Notes

Single Thread Example

Multiple Thread Example

20. The bitmap_allocator

Implementation

Free List Store

Super Block

Super Block Data Layout

Maximum Wasted Percentage

deallocate

1
2
3

Overhead and Grow Policy

21. Policy-Based Data Structures

Performance Issues

Associative
Priority Que

Associative

Policy Choices
Underlying Data Structures
Iterators
Functional

Priority Queues

Policy Choices
Underlying Data Structures
Binary Heaps

Prerequisites

Organization

Basic Use
Configuring via Template Parameters
Querying Container Attributes
Point and Range Iteration

Intermediate Use

Querying with container_traits

By Container Method

Hash-Based
Branch-Based
Priority Queues

Null Policy Classes

Map and Set Semantics

Distinguishing Between Maps and Sets
Alternatives to std::multiset and std::multimap

Iterator Semantics

Point and Range Iterators
Distinguishing Point and Range Iterators
Invalidation Guarantees

Tag
Traits

By Container

Interface
Details

Interface
Details

Interface
Details

Interface
Details

Priority Queue

Interface
Details

Performance

Text find
Integer find
Integer Subscript find
Integer Subscript insert
Integer find with Skewed-Distribution
Erase Memory Use

Branch-Based

Text insert
Text find
Text find with Locality-of-Reference
split and join
Order-Statistics

Text find with Small Secondary-to-Primary Key Ratios
Text find with Large Secondary-to-Primary Key Ratios
Text insert with Small Secondary-to-Primary Key Ratios
Text insert with Small Secondary-to-Primary Key Ratios
Text insert with Small Secondary-to-Primary Key Ratios Memory Use
Text insert with Small Secondary-to-Primary Key Ratios Memory Use

Priority Queue

Text push
Text push and pop
Integer push
Integer push
Text pop Memory Use
Text join
Text modify Up
Text modify Down

Observations

Associative
Priority_Queue

Acknowledgments

Bibliography

22. HP/SGI Extensions

Backwards Compatibility
Deprecated

23. Utilities

24. Algorithms

25. Numerics

26. Iterators

27. Input and Output

Derived filebufs

28. Demangling

29. Concurrency

Interface to Locks and Mutexes
Interface to Atomic Functions

Implementation

Using Built-in Atomic Functions
Thread Abstraction

IV. Appendices

A. Contributing

Contributor Checklist

Reading
Assignment
Getting Sources
Submitting Patches

Directory Layout and Source Conventions

Coding Style

Bad Identifiers
By Example

Design Notes

B. Porting and Maintenance

Configure and Build Hacking

Prerequisites

General Process
What Comes from Where

Storing Information in non-AC files (like configure.host)
Coding and Commenting Conventions
The acinclude.m4 layout
GLIBCXX_ENABLE, the --enable maker
Shared Library Versioning

Writing and Generating Documentation

Introduction

Generating Documentation

Prerequisites
Generating the Doxygen Files
Debugging Generation
Markup

Prerequisites
Generating the DocBook Files
Debugging Generation
Editing and Validation
File Organization and Basics
Markup By Example

Porting to New Hardware or Operating Systems

Operating System
CPU
Character Types
Thread Safety
Numeric Limits
Libtool

Test Organization

Directory Layout
Naming Conventions

Running the Testsuite

Basic
Variations
Permutations

Writing a new test case

Examples of Test Directives
Directives Specific to Libstdc++ Tests

Test Harness and Utilities

DejaGnu Harness Details
Utilities

Special Topics

Qualifying Exception Safety Guarantees

Overview
Existing tests
C++11 Requirements Test Sequence Descriptions

ABI Policy and Guidelines

The C++ Interface

Goals
History
Prerequisites
Configuring
Checking Active

Allowed Changes

Prohibited Changes

Implementation

Single ABI Testing
Multiple ABI Testing

Outstanding Issues

API Evolution and Deprecation History

5.3

7.2
7.3

Backwards Compatibility

Pre-ISO headers removed
Extension headers hash_map, hash_set moved to ext or backwards
No ios::nocreate/ios::noreplace.
No stream::attach(int fd)
Support for C++98 dialect.
Support for C++TR1 dialect.
Support for C++11 dialect.
Container::iterator_type is not necessarily Container::value_type*

C. Free Software Needs Free Documentation

D. GNU General Public License version 3

E. GNU Free Documentation License

The GNU C++ Library API Reference

Frequently Asked Questions

		Next
		The GNU C++ Library Manual