Navigation: Up, Table of Contents, Bibliography, Index, Title Page

# Chapter 3
STL Extensions for CGAL

Michael Hoffmann, Lutz Kettner, and Sylvain Pion

## Introduction

CGAL is designed in the spirit of the generic programming paradigm to work together with the Standard Template Library (STL) [C`++`98, Aus98]. This chapter documents non-geometric STL-like components that are not provided in the STL standard but in CGAL: a doubly-connected list managing items in place (where inserted items are not copied), a compact container, generic algorithms, iterators, functor adaptors for binding and swapping arguments and for composition, functors for projection and creation and adaptor classes around iterators and circulators. See also circulators in Chapter .

### Doubly-Connected List Managing Items in Place.

The class In_place_list<T,bool> manages a sequence of items in place in a doubly-connected list. Its goals are the flexible handling of memory management and performance optimization. The item type has to provide the two necessary pointers &T::next_link and &T::prev_link. One possibility to obtain these pointers is to inherit them from the base class In_place_list_base<T>.

The class In_place_list<T,bool> is a container quite similar to STL containers, with the advantage that it is able to handle the stored elements by reference instead of copying them. It is possible to delete an element only knowing its address and no iterator to it. This used to simplify mutually pointered data structures like a halfedge data structure for planar maps or polyhedral surfaces (the current design does not need this anymore). The usual iterators are also available.

CGAL::In_place_list<T,bool>
CGAL::In_place_list_base<T>

### Compact container.

The class Compact_container<T, Allocator> is an STL like container which provides a very compact storage for its elements. It achieves this goal by requiring T to provide access to a pointer in it, which is going to be used by Compact_container<T, Allocator> for its internal management. The traits class Compact_container_traits<T> specifies the way to access that pointer. The class Compact_container_base can be used as a base class to provide the pointer, although in this case you do not get the most compact representation. The values that this pointer can have during valid use of the object are valid pointer values to 4 bytes aligned objects (i.e., the two least significant bits of the pointer need to be zero when the object is constructed). Another interesting property of this container is that iterators are not invalidated during insert or erase operations.

The main deviation from the STL container concept is that the ++ and -- operators of the iterator do not have a constant time complexity in all cases. The actual complexity is related to the maximum size that the container has had during its life time compared to its current size, because the iterator has to go over the "erased" elements as well, so the bad case is when the container used to contain lots of elements, but now has far less. In this case, we suggest to do a copy of the container in order to "defragment" the internal representation.

This container has been developed in order to efficiently handle large data structures like the triangulation and halfedge data structures. It can probably be useful for other kinds of graphs as well.

CGAL::Compact_container<T, Allocator>
CGAL::Compact_container_traits<T>
CGAL::Compact_container_base

### Generic Algorithms.

CGAL::copy_n
CGAL::min_max_element
CGAL::min_element_if
CGAL::max_element_if
CGAL::predecessor
CGAL::successor

### Iterators and Iterator/Circulator Adaptors.

CGAL::Emptyset_iterator
CGAL::Oneset_iterator<T>
CGAL::Insert_iterator<Container>
CGAL::Counting_iterator<Iterator, Value>
CGAL::N_step_adaptor<I,int N>
CGAL::Filter_iterator<Iterator, Predicate>
CGAL::Join_input_iterator_1<Iterator, Creator>
CGAL::Inverse_index<IC>
CGAL::Random_access_adaptor<IC>
CGAL::Random_access_value_adaptor<IC,T>

### Functor Adaptors.

The standard library contains some adaptors for binding functors, that is fixing one argument of a functor to a specific value thereby creating a new functor that takes one argument less than the original functor. Also, though non-standard, some STL implementations (such as SGI) provide adaptors to compose function objects. Unfortunately, these bind and compose adaptors are limited to unary and binary functors only, and these functors must not be overloaded.

Since there are a number of functors in CGAL that take more than two arguments, and since functors may also be overloaded, i.e., accept several different sets of arguments, we have to define our own adaptors to be used with CGAL functors.

CGAL::swap_1
CGAL::swap_2
CGAL::swap_3
CGAL::swap_4
CGAL::bind_1
CGAL::bind_2
CGAL::bind_3
CGAL::bind_4
CGAL::bind_5
CGAL::compose
CGAL::compose_shared
CGAL::Swap<F,i>
CGAL::Bind<F,A,i>
CGAL::Compose<F0,F1,F2,F3>
CGAL::Compose_shared<F0,F1,F2,F3>
AdaptableFunctor
CGAL::Arity_tag<int>
CGAL::Arity_traits<F>
CGAL::Set_arity<F,a>
CGAL::set_arity_0
CGAL::set_arity_1
CGAL::set_arity_2
CGAL::set_arity_3
CGAL::set_arity_4
CGAL::set_arity_5

### Projection Function Objects.

CGAL::Identity<Value>
CGAL::Dereference<Value>
CGAL::Get_address<Value>
CGAL::Cast_function_object<Arg, Result>
CGAL::Project_vertex<Node>
CGAL::Project_facet<Node>
CGAL::Project_point<Node>
CGAL::Project_normal<Node>
CGAL::Project_plane<Node>
CGAL::Project_next<Node>
CGAL::Project_prev<Node>
CGAL::Project_next_opposite<Node>
CGAL::Project_opposite_prev<Node>

### Creator Function Objects.

CGAL::Creator_1<Arg, Result>
CGAL::Creator_2<Arg1, Arg2, Result>
CGAL::Creator_3<Arg1, Arg2, Arg3, Result>
CGAL::Creator_4<Arg1, Arg2, Arg3, Arg4, Result>
CGAL::Creator_5<Arg1, Arg2, Arg3, Arg4, Arg5, Result>
CGAL::Creator_uniform_2<Arg, Result>
CGAL::Creator_uniform_3<Arg, Result>
CGAL::Creator_uniform_4<Arg, Result>
CGAL::Creator_uniform_5<Arg, Result>
CGAL::Creator_uniform_6<Arg, Result>
CGAL::Creator_uniform_7<Arg, Result>
CGAL::Creator_uniform_8<Arg, Result>
CGAL::Creator_uniform_9<Arg, Result>
CGAL::Creator_uniform_d<Arg, Result>

### Utilities.

CGAL::Triple<T1, T2, T3>
CGAL::Quadruple<T1, T2, T3, T4>

- In_place_list_base<T>

- In_place_list<T,bool>

- Compact_container_base

- Compact_container_traits<T>

- Compact_container<T, Allocator>

- predecessor

- successor

- copy_n

- min_max_element

- min_element_if

- max_element_if

- Emptyset_iterator

- Oneset_iterator<T>

- Counting_iterator<Iterator, Value>

- Insert_iterator<Container>

- N_step_adaptor<I,int N>

- Filter_iterator<Iterator, Predicate>

- Join_input_iterator_1<Iterator, Creator>

- Inverse_index<IC>

- Random_access_adaptor<IC>

- Random_access_value_adaptor<IC,T>

- swap_1

- swap_2

- swap_3

- swap_4

- bind_1

- bind_2

- bind_3

- bind_4

- bind_5

- compare_to_less

- compose

- compose_shared

- negate

- Swap<F,i>

- Bind<F,A,i>

- Compose<F0,F1,F2,F3>

- Compare_to_less<F>

- Compose_shared<F0,F1,F2,F3>

- AdaptableFunctor

- Arity_tag<int>

- Arity_traits<F>

- Set_arity<F,a>

- set_arity_0

- set_arity_1

- set_arity_2

- set_arity_3

- set_arity_4

- set_arity_5

- Projection_object

- Identity<Value>

- Dereference<Value>

- Get_address<Value>

- Cast_function_object<Arg, Result>

- Project_vertex<Node>

- Project_facet<Node>

- Project_point<Node>

- Project_normal<Node>

- Project_plane<Node>

- Project_next<Node>

- Project_prev<Node>

- Project_next_opposite<Node>

- Project_opposite_prev<Node>

- Creator_1<Arg, Result>

- Creator_2<Arg1, Arg2, Result>

- Creator_3<Arg1, Arg2, Arg3, Result>

- Creator_4<Arg1, Arg2, Arg3, Arg4, Result>

- Creator_5<Arg1, Arg2, Arg3, Arg4, Arg5, Result>

- Creator_uniform_2<Arg, Result>

- Creator_uniform_3<Arg, Result>

- Creator_uniform_4<Arg, Result>

- Creator_uniform_5<Arg, Result>

- Creator_uniform_6<Arg, Result>

- Creator_uniform_7<Arg, Result>

- Creator_uniform_8<Arg, Result>

- Creator_uniform_9<Arg, Result>

- Creator_uniform_d<Arg, Result>

- Triple<T1, T2, T3>

- Quadruple<T1, T2, T3, T4>

Next chapter: Handles and Circulators

Navigation: Table of Contents, Bibliography, Index, Title Page

The CGAL Project . Tue, December 21, 2004 .