CMGEdge Class Reference

Class for the edges of an IXCondensedMolecularGraph. More...

#include <indigox/graph/condensed.hpp>

Public Member Functions
	CMGEdge ()=default
	CMGEdge (const CMGEdge &)=default
	CMGEdge (CMGEdge &&)=default
	~ CMGEdge ()=default
const CondensedMolecularGraph &	GetGraph () const
	Get the graph this edge is part of. More...
const EdgeIsoMask &	GetIsomorphismMask () const
	Get the isomorphism testing mask. More...
const MGEdge &	GetSource () const
	Get the MGEdge associated with this vertex. More...
	operator bool () const
bool	operator!= (const CMGEdge &e) const
bool	operator< (const CMGEdge &e) const
bool	operator<= (const CMGEdge &e) const
CMGEdge &	operator= (const CMGEdge &)=default
CMGEdge &	operator= (CMGEdge &&)=default
bool	operator== (const CMGEdge &e) const
bool	operator> (const CMGEdge &e) const
bool	operator>= (const CMGEdge &e) const

Friends
class	cereal::access
	Friendship allows for serialisation. More...
class	CondensedMolecularGraph
	Friendship allows IXCondensedMolecularGraph to add edges. More...
std::ostream &	operator<< (std::ostream &os, const CMGEdge &e)

Detailed Description

Class for the edges of an IXCondensedMolecularGraph.

Constructor & Destructor Documentation

CMGEdge() [1/3]

CMGEdge ( )

default

CMGEdge() [2/3]

CMGEdge ( const CMGEdge &  )

default

CMGEdge() [3/3]

CMGEdge ( CMGEdge &&  )

default

~ CMGEdge()

~ CMGEdge ( )

default

Member Function Documentation

GetGraph()

const CondensedMolecularGraph& GetGraph

(

)

const

Get the graph this edge is part of.

Returns

the owning graph.

GetIsomorphismMask()

const EdgeIsoMask& GetIsomorphismMask

(

)

const

Get the isomorphism testing mask.

Returns

the isomorphism testing mask.

GetSource()

const MGEdge& GetSource

(

)

const

Get the MGEdge associated with this vertex.

Returns

the associated MGEdge, if it is atill alive.

operator bool()

operator bool ( ) const

inline

operator!=()

bool operator!= ( const CMGEdge &  e ) const

inline

operator<()

bool operator<

(

const CMGEdge &

e

)

const

operator<=()

bool operator<= ( const CMGEdge &  e ) const

inline

operator=() [1/2]

CMGEdge& operator= ( CMGEdge &&  )

default

operator=() [2/2]

CMGEdge& operator= ( const CMGEdge &  )

default

operator==()

bool operator==

(

const CMGEdge &

e

)

const

operator>()

bool operator>

(

const CMGEdge &

e

)

const

operator>=()

bool operator>= ( const CMGEdge &  e ) const

inline

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Friendship allows for serialisation.

CondensedMolecularGraph

friend class CondensedMolecularGraph

friend

Friendship allows IXCondensedMolecularGraph to add edges.

operator<<

std::ostream& operator<< ( std::ostream &  os, const CMGEdge &  e  )

friend

---

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

• include/indigox/graph/condensed.hpp