sgm::Pattern Class Reference

#include <Pattern.hh>

Inheritance diagram for sgm::Pattern:

Public Types
typedef std::vector < Match_Constraint * >	ConstraintVec
	container of matching constraints More...

Public Member Functions
virtual const ConstraintVec &	getConstraints (void) const
virtual const Graph_Interface &	getPatternGraph (void) const
virtual const std::string *	getUsedWildcard (void) const
virtual bool	operator!= (const Pattern_Interface &toCompare) const
sgm::Pattern &	operator= (const sgm::Pattern &toCopy)
virtual bool	operator== (const Pattern_Interface &toCompare) const
	Pattern (const Graph_Interface &graph)
	Pattern (const Graph_Interface &graph, const std::string &wildcardToUse)
	Pattern (const Graph_Interface &graph, const ConstraintVec &matchConstraints)
	Pattern (const Graph_Interface &graph, const ConstraintVec &matchConstraints, const std::string &wildcardToUse)
	Pattern (const Pattern &toCopy)
virtual	~Pattern ()
	destruction More...

Static Public Member Functions
static ConstraintVec	copyConstraintVec (const ConstraintVec &toCopy)

Protected Attributes
const Graph_Interface *	graph
	the graph to be represented as a pattern More...
ConstraintVec	matchConstraints
	the additional match constraints to be fulfilled by each match More...
const std::string *	usedWildcard
	the wildcard string to be used for matching More...

Detailed Description

A wrapper class around a given Graph_interface that can serve as a pattern.

Author

Martin Mann - 2010 - http://www.bioinf.uni-freiburg.de/~mmann/

Definition at line 188 of file Pattern.hh.

Member Typedef Documentation

typedef std::vector< Match_Constraint* > sgm::Pattern_Interface::ConstraintVec

inherited

Definition at line 129 of file Pattern.hh.

Constructor & Destructor Documentation

sgm::Pattern::Pattern

(

const Graph_Interface &

graph

)

constructs a pattern without additional constraints

Parameters

graph

the graph to represent

sgm::Pattern::Pattern	(	const Graph_Interface &	graph,
		const std::string &	wildcardToUse
	)

constructs a pattern without additional constraints

Parameters

graph	the graph to represent
wildcardToUse	the wildcard to use for matching

sgm::Pattern::Pattern	(	const Graph_Interface &	graph,
		const ConstraintVec &	matchConstraints
	)

constructs a pattern with additional constraints

Parameters

graph	the graph to represent
matchConstraints	the additional constraints to be fulfilled

sgm::Pattern::Pattern	(	const Graph_Interface &	graph,
		const ConstraintVec &	matchConstraints,
		const std::string &	wildcardToUse
	)

constructs a pattern with additional constraints

Parameters

graph	the graph to represent
matchConstraints	the additional constraints to be fulfilled
wildcardToUse	the wildcard to use for matching

sgm::Pattern::Pattern

(

const Pattern &

toCopy

)

copy construction

Parameters

toCopy

the pattern to make this object a copy of

virtual sgm::Pattern::~Pattern ( )

virtual

Member Function Documentation

static ConstraintVec sgm::Pattern::copyConstraintVec ( const ConstraintVec &  toCopy )

static

Does a deep copy of the given constraint vector

Parameters

toCopy

the ConstraintVec instance to copy

Returns

the deep copy of the given vector of MatchConstraints

virtual const ConstraintVec& sgm::Pattern::getConstraints ( void  ) const

virtual

Access to the matching constraints that have to be fulfilled by a match of this pattern graph

Returns

the matching constraints to validate

Implements sgm::Pattern_Interface.

virtual const Graph_Interface& sgm::Pattern::getPatternGraph ( void  ) const

virtual

Access to the pattern graph to be matched

Returns

the pattern graph

Implements sgm::Pattern_Interface.

virtual const std::string* sgm::Pattern::getUsedWildcard ( void  ) const

virtual

Access to the wildcard to be used when matching this pattern onto some other graph.

Returns

the wildcard string to be used for edge and node labels, or NULL if no wildcard should be applied

Implements sgm::Pattern_Interface.

virtual bool sgm::Pattern_Interface::operator!= ( const Pattern_Interface &  toCompare ) const

virtualinherited

Inequality comparison

Parameters

toCompare

the Pattern to compare to

Returns

true if both describe the different patterns

sgm::Pattern& sgm::Pattern::operator=

(

const sgm::Pattern &

toCopy

)

assignment operator

Parameters

toCopy

the instance to make this a copy of

Returns

the altered object (*this)

virtual bool sgm::Pattern_Interface::operator== ( const Pattern_Interface &  toCompare ) const

virtualinherited

Equality comparison

Parameters

toCompare

the Pattern to compare to

Returns

true if both describe the same pattern

Field Documentation

const Graph_Interface* sgm::Pattern::graph

protected

Definition at line 193 of file Pattern.hh.

ConstraintVec sgm::Pattern::matchConstraints

protected

Definition at line 196 of file Pattern.hh.

const std::string* sgm::Pattern::usedWildcard

protected

Definition at line 199 of file Pattern.hh.

---

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

• src/sgm/Pattern.hh