Wiselib
Public Member Functions | Public Attributes
concepts::Container_concept Class Reference

This is the base concept that every kind of container should implement. More...

Inherited by concepts::AssociativeContainer_concept, concepts::RandomAccessContainer_concept, and concepts::Sequence_concept.

List of all members.

Public Member Functions

iterator begin ()
 Return an iterator that points at the first element.
iterator end ()
 Return an iterator that points "after" the last element.
size_type size ()
 Return number of elements in the container.
size_type max_size ()
 Return maximum number of elements in the container.
bool empty ()
 Return true if the container is empty.

Public Attributes

typedef value_type
 Type of elements of the container.
typedef iterator
 Type of the iterators returned by begin() and end().
typedef size_type
 Type of the element-counts returned by size() and maxsize().

Detailed Description

This is the base concept that every kind of container should implement.

A container by itself is defined to be something that holds a number of elements of the same type. Thus, a container supports querying the number of these elements (size()) and provides a mechanism to iterate through all of the elements (begin() and end()).

Note that this base concept does not provide any methods for inserting elements. That is because inserting elements can work very different on different kinds of containers and in some cases the user of the container shouldn't be allowed to insert elements himself at all.


Member Function Documentation

iterator concepts::Container_concept::begin ( )

Return an iterator that points at the first element.

bool concepts::Container_concept::empty ( ) [inline]

Return true if the container is empty.

iterator concepts::Container_concept::end ( )

Return an iterator that points "after" the last element.

I.e. dereferencing this iterator does not need to work, but (equality) comparison to any iterator that has finished iterating over all elements of the container should yield true

size_type concepts::Container_concept::max_size ( )

Return maximum number of elements in the container.

If the container is not limited in size, return 0.

size_type concepts::Container_concept::size ( )

Return number of elements in the container.


Member Data Documentation

Type of the iterators returned by begin() and end().

This type is expected to implement the iterator concept.

Type of the element-counts returned by size() and maxsize().

Usually an (unsigned) integer type.

Type of elements of the container.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines