votca::csg::ExclusionList Class Reference

#include <exclusionlist.h>

Collaboration diagram for votca::csg::ExclusionList:

Classes
struct	exclusion_t

Public Types
using	iterator = std::list< exclusion_t * >::iterator

Public Member Functions
	ExclusionList ()=default
	~ExclusionList ()
void	Clear (void)
template<typename iterable >
void	Remove (iterable &l)
template<typename iterable >
void	ExcludeList (iterable &l)
void	CreateExclusions (Topology *top)
exclusion_t *	GetExclusions (Bead *bead)
const exclusion_t *	GetExclusions (Bead *bead) const
iterator	begin ()
iterator	end ()
bool	IsExcluded (Bead *bead1, Bead *bead2) const
template<typename iterable >
void	InsertExclusion (Bead *bead, iterable &excluded)
void	InsertExclusion (Bead *bead1, Bead *bead2)
void	RemoveExclusion (Bead *bead1, Bead *bead2)

Private Attributes
std::list< exclusion_t * >	exclusions_
std::map< Bead *, exclusion_t * >	excl_by_bead_

Friends
std::ostream &	operator<< (std::ostream &out, ExclusionList &exl)

Detailed Description

Definition at line 38 of file exclusionlist.h.

Member Typedef Documentation

iterator

using votca::csg::ExclusionList::iterator = std::list<exclusion_t *>::iterator

Definition at line 60 of file exclusionlist.h.

Constructor & Destructor Documentation

ExclusionList()

votca::csg::ExclusionList::ExclusionList ( )

default

~ExclusionList()

votca::csg::ExclusionList::~ExclusionList ( )

inline

Definition at line 41 of file exclusionlist.h.

Member Function Documentation

begin()

iterator votca::csg::ExclusionList::begin ( )

inline

Definition at line 62 of file exclusionlist.h.

Clear()

void votca::csg::ExclusionList::Clear

(

void

)

Definition at line 30 of file exclusionlist.cc.

CreateExclusions()

void votca::csg::ExclusionList::CreateExclusions

(

Topology *

top

)

Definition at line 38 of file exclusionlist.cc.

end()

iterator votca::csg::ExclusionList::end ( )

inline

Definition at line 63 of file exclusionlist.h.

ExcludeList()

template<typename iterable >

void votca::csg::ExclusionList::ExcludeList ( iterable &  l )

inline

Definition at line 93 of file exclusionlist.h.

GetExclusions() [1/2]

ExclusionList::exclusion_t * votca::csg::ExclusionList::GetExclusions

(

Bead *

bead

)

Definition at line 64 of file exclusionlist.cc.

GetExclusions() [2/2]

const ExclusionList::exclusion_t * votca::csg::ExclusionList::GetExclusions

(

Bead *

bead

)

const

Definition at line 53 of file exclusionlist.cc.

InsertExclusion() [1/2]

template<typename iterable >

void votca::csg::ExclusionList::InsertExclusion ( Bead *  bead, iterable &  excluded  )

inline

Definition at line 104 of file exclusionlist.h.

InsertExclusion() [2/2]

void votca::csg::ExclusionList::InsertExclusion	(	Bead *	bead1,
		Bead *	bead2
	)

Definition at line 91 of file exclusionlist.cc.

IsExcluded()

bool votca::csg::ExclusionList::IsExcluded	(	Bead *	bead1,
		Bead *	bead2
	)		const

Definition at line 73 of file exclusionlist.cc.

Remove()

template<typename iterable >

void votca::csg::ExclusionList::Remove ( iterable &  l )

inline

Definition at line 82 of file exclusionlist.h.

RemoveExclusion()

void votca::csg::ExclusionList::RemoveExclusion	(	Bead *	bead1,
		Bead *	bead2
	)

Definition at line 114 of file exclusionlist.cc.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, ExclusionList &  exl  )

friend

Definition at line 152 of file exclusionlist.cc.

Member Data Documentation

excl_by_bead_

std::map<Bead *, exclusion_t *> votca::csg::ExclusionList::excl_by_bead_

private

Definition at line 76 of file exclusionlist.h.

exclusions_

std::list<exclusion_t *> votca::csg::ExclusionList::exclusions_

private

Definition at line 75 of file exclusionlist.h.

---

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

• csg/include/votca/csg/exclusionlist.h
• csg/src/libcsg/exclusionlist.cc