BTK::MonomerContainer< MonomerType > Class Template Reference

#include <monomer_container.h>

Inheritance diagram for BTK::MonomerContainer< MonomerType >:

[legend]Collaboration diagram for BTK::MonomerContainer< MonomerType >:

[legend]List of all members.

Public Types
typedef base_type::value_type	value_type
typedef base_type::reference	reference
typedef base_type::const_reference	const_reference
typedef base_type::pointer	pointer
typedef base_type::const_pointer	const_pointer
typedef base_type::size_type	size_type
typedef base_type::iterator	iterator
typedef base_type::const_iterator	const_iterator
typedef value_type	monomer_type
typedef iterator	monomer_iterator
typedef const_iterator	const_monomer_iterator
Public Member Functions
size_type	size () const
	Replication of std::vector function (see std::vector documentation).
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reference	operator[] (size_type i)
const_reference	operator[] (size_type i) const
reference	front ()
const_reference	front () const
reference	back ()
const_reference	back () const
	MonomerContainer (size_type s=0)
	///////////////////////////////////////////////////////////////
template<typename InputIterator>	MonomerContainer (InputIterator first, InputIterator last)
	///////////////////////////////////////////////////////////////
	MonomerContainer (const self_type &source)
	///////////////////////////////////////////////////////////////
template<typename T2>	MonomerContainer (const MonomerContainer< T2 > &source)
	///////////////////////////////////////////////////////////////
	~MonomerContainer ()
	///////////////////////////////////////////////////////////////
self_type &	operator= (const self_type &rhs)
	///////////////////////////////////////////////////////////////
template<typename T2> self_type &	operator= (const MonomerContainer< T2 > &rhs)
	///////////////////////////////////////////////////////////////
size_type	monomer_size () const
	atom versions of standard STL function names
iterator	monomer_begin ()
	atom versions of standard STL function names
const_iterator	monomer_begin () const
	atom versions of standard STL function names
iterator	monomer_end ()
	atom versions of standard STL function names
const_iterator	monomer_end () const
	atom versions of standard STL function names
reference	monomer (size_type i)
	atom versions of standard STL function names
const_reference	monomer (size_type i) const
	atom versions of standard STL function names
reference	monomer_back ()
	atom versions of standard STL function names
const_reference	monomer_back () const
	atom versions of standard STL function names
reference	monomer_front ()
	atom versions of standard STL function names
const_reference	monomer_front () const
	atom versions of standard STL function names
Protected Member Functions
void	clear ()
	Replication of std::vector function (see std::vector documentation).
void	resize (size_type s)
void	reserve (size_type s)
void	push_back (const value_type &x)
iterator	insert (iterator pos, const value_type &x)
void	insert (iterator pos, size_type s, const value_type &x)
void	insert (iterator pos, InputIterator first, InputIterator last)
iterator	erase (iterator pos)
iterator	erase (iterator first, iterator last)
void	shallow_push_back (value_type *x)
void	shallow_insert (iterator pos, const_iterator first, const_iterator last)
void	deep_copy (const SharedVectorBase< T2 > &source)
void	shallow_copy (const self_type &source)

---

Detailed Description

template<typename MonomerType>
class BTK::MonomerContainer< MonomerType >

A general purpose container of monomers

A specialization of SharedVectorBase which requires the template argument to be BTK::Monomer convertible and adds specialy named monomer versions of standard stl typedefs and functions.

---

Member Typedef Documentation

template<typename MonomerType> typedef base_type::const_iterator BTK::MonomerContainer< MonomerType >::const_iterator

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef const_iterator BTK::MonomerContainer< MonomerType >::const_monomer_iterator

Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::const_pointer BTK::MonomerContainer< MonomerType >::const_pointer

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::const_reference BTK::MonomerContainer< MonomerType >::const_reference

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::iterator BTK::MonomerContainer< MonomerType >::iterator

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef iterator BTK::MonomerContainer< MonomerType >::monomer_iterator

Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef value_type BTK::MonomerContainer< MonomerType >::monomer_type

Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::pointer BTK::MonomerContainer< MonomerType >::pointer

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::reference BTK::MonomerContainer< MonomerType >::reference

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::size_type BTK::MonomerContainer< MonomerType >::size_type

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

template<typename MonomerType> typedef base_type::value_type BTK::MonomerContainer< MonomerType >::value_type

Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

---

Constructor & Destructor Documentation

template<typename MonomerType> BTK::MonomerContainer< MonomerType >::MonomerContainer (  size_type  s = 0  )  [inline]

///////////////////////////////////////////////////////////////

template<typename MonomerType> template<typename InputIterator> BTK::MonomerContainer< MonomerType >::MonomerContainer (  InputIterator  first, InputIterator  last )  [inline]

///////////////////////////////////////////////////////////////

template<typename MonomerType> BTK::MonomerContainer< MonomerType >::MonomerContainer (  const self_type &  source  )  [inline]

///////////////////////////////////////////////////////////////

template<typename MonomerType> template<typename T2> BTK::MonomerContainer< MonomerType >::MonomerContainer (  const MonomerContainer< T2 > &  source  )  [inline]

///////////////////////////////////////////////////////////////

template<typename MonomerType> BTK::MonomerContainer< MonomerType >::~MonomerContainer (   )  [inline]

///////////////////////////////////////////////////////////////

---

Member Function Documentation

const_reference BTK::SharedVectorBase< MonomerType >::back (   )  const [inline, inherited]

Replication of std::vector function (see std::vector documentation).

reference BTK::SharedVectorBase< MonomerType >::back (   )  [inline, inherited]

Replication of std::vector function (see std::vector documentation).

const_iterator BTK::SharedVectorBase< MonomerType >::begin (   )  const [inline, inherited]

Replication of std::vector function (see std::vector documentation).

iterator BTK::SharedVectorBase< MonomerType >::begin (   )  [inline, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::clear (   )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::deep_copy (  const SharedVectorBase< T2 > &  source  )  [protected, inherited]

const_iterator BTK::SharedVectorBase< MonomerType >::end (   )  const [inline, inherited]

Replication of std::vector function (see std::vector documentation).

iterator BTK::SharedVectorBase< MonomerType >::end (   )  [inline, inherited]

Replication of std::vector function (see std::vector documentation).

iterator BTK::SharedVectorBase< MonomerType >::erase (  iterator  first, iterator  last )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

iterator BTK::SharedVectorBase< MonomerType >::erase (  iterator  pos  )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

const_reference BTK::SharedVectorBase< MonomerType >::front (   )  const [inline, inherited]

Replication of std::vector function (see std::vector documentation).

reference BTK::SharedVectorBase< MonomerType >::front (   )  [inline, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::insert (  iterator  pos, InputIterator  first, InputIterator  last )  [protected, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::insert (  iterator  pos, size_type  s, const value_type &  x )  [protected, inherited]

Replication of std::vector function (see std::vector documentation).

iterator BTK::SharedVectorBase< MonomerType >::insert (  iterator  pos, const value_type &  x )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

template<typename MonomerType> const_reference BTK::MonomerContainer< MonomerType >::monomer (  size_type  i  )  const [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> reference BTK::MonomerContainer< MonomerType >::monomer (  size_type  i  )  [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> const_reference BTK::MonomerContainer< MonomerType >::monomer_back (   )  const [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> reference BTK::MonomerContainer< MonomerType >::monomer_back (   )  [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> const_iterator BTK::MonomerContainer< MonomerType >::monomer_begin (   )  const [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> iterator BTK::MonomerContainer< MonomerType >::monomer_begin (   )  [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> const_iterator BTK::MonomerContainer< MonomerType >::monomer_end (   )  const [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> iterator BTK::MonomerContainer< MonomerType >::monomer_end (   )  [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> const_reference BTK::MonomerContainer< MonomerType >::monomer_front (   )  const [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> reference BTK::MonomerContainer< MonomerType >::monomer_front (   )  [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> size_type BTK::MonomerContainer< MonomerType >::monomer_size (   )  const [inline]

atom versions of standard STL function names

Here is the call graph for this function:

template<typename MonomerType> template<typename T2> self_type& BTK::MonomerContainer< MonomerType >::operator= (  const MonomerContainer< T2 > &  rhs  )  [inline]

///////////////////////////////////////////////////////////////

template<typename MonomerType> self_type& BTK::MonomerContainer< MonomerType >::operator= (  const self_type &  rhs  )  [inline]

/////////////////////////////////////////////////////////////// Reimplemented from BTK::SharedVectorBase< MonomerType >. Reimplemented in BTK::Polymer< MonomerType >.

const_reference BTK::SharedVectorBase< MonomerType >::operator[] (  size_type  i  )  const [inline, inherited]

Replication of std::vector function (see std::vector documentation).

reference BTK::SharedVectorBase< MonomerType >::operator[] (  size_type  i  )  [inline, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::push_back (  const value_type &  x  )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::reserve (  size_type  s  )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::resize (  size_type  s  )  [inline, protected, inherited]

Replication of std::vector function (see std::vector documentation).

void BTK::SharedVectorBase< MonomerType >::shallow_copy (  const self_type &  source  )  [protected, inherited]

void BTK::SharedVectorBase< MonomerType >::shallow_insert (  iterator  pos, const_iterator  first, const_iterator  last )  [inline, protected, inherited]

void BTK::SharedVectorBase< MonomerType >::shallow_push_back (  value_type *  x  )  [inline, protected, inherited]

size_type BTK::SharedVectorBase< MonomerType >::size (   )  const [inline, inherited]

Replication of std::vector function (see std::vector documentation).

---

The documentation for this class was generated from the following file:

• monomer_container.h

---