Interface edge match constraint. More...

#include <MC_Edge.hh>

Inheritance diagram for sgm::MC_Edge:

Public Member Functions
virtual MC_Edge *	clone (void) const =0

virtual bool	isConstrainedLabel (const std::string &label) const =0

virtual bool	isConstraining (const size_t nodeID) const

virtual bool	isValidMatch (const Pattern_Interface &pattern, const Graph_Interface &target, const Match &match) const =0

	MC_Edge (const size_t constrainedFromID, const size_t constrainedToID)

	MC_Edge (const MC_Edge &toCopy)

virtual bool	operator== (const Match_Constraint &toCompare) const

virtual bool	operator== (const Match_Constraint &toCompare) const =0

virtual MC_Edge *	remap (const Match &old2newIndexMapping, const size_t unmatchedIndex=UINT_MAX)=0

virtual	~MC_Edge ()
	destruction More...

Data Fields
size_t	constrainedFromID
	the source ID of the edge to be constrained More...

size_t	constrainedToID
	the target ID of the edge to be constrained More...

Detailed Description

   A match node constraint describes additional properties that have to be
   fulfilled by a given matched edge on a given target.

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

Definition at line 28 of file MC_Edge.hh.

Constructor & Destructor Documentation

sgm::MC_Edge::MC_Edge	(	const size_t	constrainedFromID,
		const size_t	constrainedToID
	)

inline

construction

Parameters

constrainedFromID	source ID of the edge to be constrained
constrainedToID	target ID of the edge to be constrained

Definition at line 41 of file MC_Edge.hh.

sgm::MC_Edge::MC_Edge ( const MC_Edge & toCopy )

inline

copy construction

Parameters

toCopy the MC_Edge object to copy

Definition at line 49 of file MC_Edge.hh.

virtual sgm::MC_Edge::~MC_Edge ( )

inlinevirtual

Definition at line 56 of file MC_Edge.hh.

Member Function Documentation

virtual MC_Edge* sgm::MC_Edge::clone ( void ) const

pure virtual

Creates a new MC_Edge heap object that equals the current object. NOTE: YOU have to delete it later on! There is no garbage collection!

Returns: a new allocated MC_Edge object that equals this

Implements sgm::Pattern_Interface::Match_Constraint.

Implemented in sgm::MC_EdgeLabel, and sgm::MC_NoEdge.

virtual bool sgm::Pattern_Interface::Match_Constraint::isConstrainedLabel ( const std::string & label ) const

pure virtualinherited

Checks whether or not a given label is part of the constraint information. This check is needed by some parsers to verify the wildcard definition.

Parameters

label the label of interest

Returns: true if the label is part of the constraint; false otherwise

Implemented in sgm::MC_NodeLabel, sgm::MC_EdgeLabel, sgm::MC_NodeAdjacency, ggl::chem::MoleculeDecomposition::MC_MC_RingNode, and sgm::MC_NoEdge.

virtual bool sgm::MC_Edge::isConstraining ( const size_t nodeID ) const

inlinevirtual

Checks whether or not this constraint covers the node with the given ID.

Parameters

nodeID the ID of the node of interest

Returns: true if the node is covered by the constraint; false otherwise

Implements sgm::Pattern_Interface::Match_Constraint.

Definition at line 69 of file MC_Edge.hh.

virtual bool sgm::Pattern_Interface::Match_Constraint::isValidMatch	(	const Pattern_Interface &	pattern,
		const Graph_Interface &	target,
		const Match &	match
	)		const

pure virtualinherited

Checks whether or not a match on a given target fullfills the additional matching constraint.

Parameters

pattern	the pattern graph that was matched
target	the target graph the pattern was matched on
match	the match information for the pattern on the target graph

Returns: true if the match is valid; false if the constraint is violated

Implemented in sgm::MC_EdgeLabel, sgm::MC_NoEdge, and sgm::MC_Node.

virtual bool sgm::MC_Edge::operator== ( const Match_Constraint & toCompare ) const

inlinevirtual

Equality comparison to another match constraint.

Parameters

toCompare the constraint to compare to

Returns: true if the constraints are equal; false otherwise

Reimplemented in sgm::MC_EdgeLabel, and sgm::MC_NoEdge.

Definition at line 112 of file MC_Edge.hh.

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

pure virtualinherited

Equality comparison to another match constraint.

Parameters

toCompare the constraint to compare to

Returns: true if the constraints are equal; false otherwise

Implemented in sgm::MC_Node.

virtual MC_Edge* sgm::MC_Edge::remap	(	const Match &	old2newIndexMapping,
		const size_t	unmatchedIndex = `UINT_MAX`
	)

pure virtual

Creates a new MC_Edge heap object that equals the current object but uses the new indices given by old2newIndexMapping. NOTE: YOU have to delete it later on! There is no garbage collection!

Parameters

old2newIndexMapping	the index mapping to be used for the remapping
unmatchedIndex	an optional specific index that marks unmatched nodes within old2newIndexMapping. if this constrains one of these nodes, no remapping is done and NULL is returned

Returns: a new allocated MC_Edge object

Implements sgm::Pattern_Interface::Match_Constraint.

Implemented in sgm::MC_EdgeLabel, and sgm::MC_NoEdge.

Field Documentation

size_t sgm::MC_Edge::constrainedFromID

Definition at line 33 of file MC_Edge.hh.

size_t sgm::MC_Edge::constrainedToID

Definition at line 36 of file MC_Edge.hh.

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

src/sgm/MC_Edge.hh

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation