BALL::RingFinder Class Reference

Helper class for all predicates that need ring information. More...


Public Member Functions
	RingFinder ()
	Default constructor.
	RingFinder (Size n)
	Detailed constructor.
virtual	~RingFinder ()
	Destructor.
bool	operator() (const Atom &atom)
	Return true, if atom is in a ring.
bool	dfs (const Atom &atom, const Size limit)
	Depth first search for finding rings.
void	setRingSize (Size n)
	Set the ring size we want to find.
const HashSet< const Bond * > &	getVisitedBonds () const
	Return the hashset containing all visited bonds.
const std::vector< const Atom * > &	getRingAtoms () const
	Return the vector of ring atoms.

Detailed Description

Helper class for all predicates that need ring information.

BALL::RingFinder::RingFinder ( Size n )

Detailed constructor.

Initialize this instance with the size of the ring we want to find. Default setting is 0 which means that any ring size will match.

void BALL::RingFinder::setRingSize ( Size n )

Set the ring size we want to find.

Ring sizes below 3 will always return false, except if the size is set to 0, then any ring size will match.