View Template Library


concatenation_view<container, const_tag, iter_tag, base>

Category: adaptors

Component type: type

Description

The concatenation_view template represents individual objects that come from a flattening of a container of containers.

The properties of the order of elements are the same as those provided by the underlying container, as is the validity of more than one active iterators at any one time.

concatenation_views are mutable if and only if the const_tag template parameter is mutable_view_tag. Note that changing elements of the container may result in invalidated iterators and may change the size of the view. Thus, use mutable views only if you really know what you are doing.

A concatenation_view owns its referenced container, if its base template parameter is aggregated_ownership, it merely references its container, if the base template parameter is referenced_ownership.

This view is used as a last step to extract the elements for set_union_view, set_difference_view, set_intersection_view, and set_symmetrical_difference_view, where it flattens the output of equal_range_view.

Template parameters

Parameter

Description

Default

container

The view's container type: the type of container referenced by this view


const_tag

The view's const tag: either const_view_tag or mutable_view_tag

const_view_tag

iterator_tag

The view's directional iterator category

One of container::value_type::iterator::category, container::iterator::category and bidirectional_iterator_tag, whichever is the lessest.

base

The view's ownership type: the base class that determines if the view references or owns the container

referenced_ownership

Definition

Defined in the header concatenation_view.hpp.

Model of

Single Container View

Type requirements

Container satisfies

View satisfies

Container

Container [1]

Forward Container

Forward Container [1]

Members

Member

Where defined

Description

value_type

Container

The type T of the elements accessed through the view.

domain_type

Single View

The type of the referenced container.

pointer

Container

Pointer to T.

reference

Container

Reference to T.

const_reference

Container

Const reference to T.

size_type

Container

An unsigned integral type.

difference_type

Container

A signed integral type.

iterator

Container

Iterator used to iterate through the view.

const_iterator

Container

Const iterator used to iterate through the view.

reverse_iterator

Reversible Container

Iterator used to iterate backwards through the view.

const_reverse_iterator

Reversible Container

Const iterator used to iterate backwards through the view.

iterator begin()

Container

Returns an iterator pointing to the begin of the view.

iterator end()

Container

Returns an iterator pointing to the end of the view.

const_iterator begin() const

Container

Returns a const_iterator pointing to the begin of the view.

const_iterator end() const

Container

Returns a const_iterator pointing to the end of the view.

reverse_iterator rbegin()

Reversible Container

Valid for reversible container's only. Returns a reverse_iterator pointing to the beginning of the reversed view.

reverse_iterator rend()

Reversible Container

Valid for reversible container's only. Returns a reverse_iterator pointing to the end of the reversed view.

const_reverse_iterator rbegin() const

Reversible Container

Valid for reversible container's only. Returns a const_reverse_iterator pointing to the beginning of the reversed view.

const_reverse_iterator rend() const

Reversible Container

Valid for reversible container's only. Returns a const_reverse_iterator pointing to the end of the reversed view.

size_type size() const

Container

Returns the size of the view. [1]

size_type max_size() const

Container

Returns the largest possible size of the view.

bool empty() const

Container

true if the view's size is 0.

concatenation_view()

Default Constructible

Creates an empty view.

concatenation_view(container_t&)

Assignable

Creates a view of given container.

void swap(concatenation_view&)

Container

Swaps the two views. Iterators are invalidated by this operation. For referencing views, the containers themselves are not swapped.

bool operator==(const concatenation_view&, const concatenation_view&)

Forward Container

Tests two views for equality. This is a global function, not a member function. Views may be equal even if their referenced containers are not.

bool operator<(const concatenation_view&, const concatenation_view&)

Forward Container

Lexicographical comparison. This is a global function, not a member function.

Notes

[1] A concatenation_view satisfies all the requirements of container, except for size() and iterator increment/decrement not guaranteeing constant complexity.



VTL Home
Copyright © 1999 Konrad-Zuse-Zentrum für Informationstechnik Berlin & Gary Powell All Rights Reserved.