#include <node_exclusion_filter.h>

Inheritance diagram for NodeExclusionFilter< GraphType >:

Collaboration diagram for NodeExclusionFilter< GraphType >:

Public Types
typedef GraphType::node_value_type	V_type

typedef GraphType::edge_value_type	E_type

typedef GraphType::index_type_t	index_type_t

typedef GraphType::comparator	V_CompareFunctor

typedef std::set< V_type, V_CompareFunctor >	ExcludedNodeSet

typedef ExcludedNodeSet::iterator	iterator

typedef ExcludedNodeSet::const_iterator	const_iterator

Public Types inherited from GraphFilter< GraphType >
typedef GraphType::node_value_type	V_type

typedef GraphType::edge_value_type	E_type

Public Member Functions
	NodeExclusionFilter (std::string filter_name="node_exclusion_filter")

	NodeExclusionFilter (std::set< V_type, V_CompareFunctor > &nodes, std::string filter_name="node_exclusion_filter")

virtual GraphFilter< GraphType > *	clone ()
	Clone the filter.

void	add_exclusion (V_type excluded)
	Adds a node to the exclusion list.

ExcludedNodeSet &	excluded_nodes ()
	Retrieve the current set of excluded nodes.

iterator	begin ()
	Returns an iterator to the beginning of the excluded nodes set.

iterator	end ()
	Returns an iterator to the end of the excluded nodes set.

void	remove_exclusion (V_type excluded)
	Removes a node from the exclusion list.

void	clear_filter ()
	clears the set of filtered nodes

virtual bool	operator() (E_type edge)
	No action taken on edges.

virtual bool	operator() (V_type m)
	Returns false if the node is in the list of nodes to exclude, true otherwise.

template<typename P1 , typename P2 >
bool	operator() (std::pair< P1, P2 > &m)
	Operator used for STL.

Public Member Functions inherited from GraphFilter< GraphType >
	GraphFilter (std::string filter_name="", std::string filter_type="", bool inverted=false, bool enabled=true, bool nodes=true, bool edges=true)

void	set_inverted (bool status)
	Sets the inverted status.

void	set_enabled (bool enabled)
	Sets enabled.

std::string	name () const

std::string	type () const

bool	inverted () const

virtual bool	enabled () const

virtual bool	nodes () const
	The nodes property tells us whether this filter operates on nodes.

virtual bool	edges () const
	The edgesproperty tells us whether this filter operates on nodes.

template<typename P1 , typename P2 >
bool	operator() (std::pair< P1, P2 > &m)

Additional Inherited Members
Protected Attributes inherited from GraphFilter< GraphType >
bool	inverted_

bool	enabled_

bool	nodes_

bool	edges_

Detailed Description

template<typename GraphType>
class NodeExclusionFilter< GraphType >

This is a filter which returns false if the any of the nodes added to the filter appear. This allows for removing of all nodes matching the filter.

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

src/node_exclusion_filter.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename GraphType> class NodeExclusionFilter< GraphType >

template<typename GraphType>
class NodeExclusionFilter< GraphType >