votca 2024-dev
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
votca::csg::BeadMotifConnector Class Reference

Simple class for storing the connections between motifs and the underlying beads that are part of the connection. More...

#include <beadmotifconnector.h>

Public Member Functions

void AddMotifAndBeadEdge (const tools::Edge &motif_edge, const tools::Edge &bead_edge)
 
std::vector< tools::EdgegetBeadEdges (const tools::Edge &motif_edge) const
 Returns the bead edges connecting the motifs specified by motif_edge.
 
std::vector< tools::EdgegetBeadEdges () const noexcept
 Returns all the bead edges connecting the motifs.
 
tools::Edge getMotifEdge (const tools::Edge &bead_edge) const
 Returns the motifs involved between two beads given by bead_edge.
 
std::unordered_set< tools::EdgegetMotifEdges () const noexcept
 Returns all the motif edges.
 

Private Attributes

reduced_edge_to_edges_map motif_and_bead_edges_
 

Detailed Description

Simple class for storing the connections between motifs and the underlying beads that are part of the connection.

A graph like this

1 - 2 - 3 - 4 | | 5 - 6

Will be broken up into two motifs a line motif and a loop motif the BeadMotifConnector tracks the connections between the now independ motifs

Motif 0 Motif 1

1 - 2 3 - 4 | | 5 - 6

The motif connection is stored as edge: 0 - 1 The corresbonding bead connection as edge: 2 - 3

Definition at line 84 of file beadmotifconnector.h.

Member Function Documentation

◆ AddMotifAndBeadEdge()

void votca::csg::BeadMotifConnector::AddMotifAndBeadEdge ( const tools::Edge motif_edge,
const tools::Edge bead_edge 
)

Definition at line 29 of file beadmotifconnector.cc.

◆ getBeadEdges() [1/2]

vector< Edge > votca::csg::BeadMotifConnector::getBeadEdges ( ) const
noexcept

Returns all the bead edges connecting the motifs.

Definition at line 44 of file beadmotifconnector.cc.

◆ getBeadEdges() [2/2]

vector< Edge > votca::csg::BeadMotifConnector::getBeadEdges ( const tools::Edge motif_edge) const

Returns the bead edges connecting the motifs specified by motif_edge.

Definition at line 34 of file beadmotifconnector.cc.

◆ getMotifEdge()

Edge votca::csg::BeadMotifConnector::getMotifEdge ( const tools::Edge bead_edge) const

Returns the motifs involved between two beads given by bead_edge.

Definition at line 53 of file beadmotifconnector.cc.

◆ getMotifEdges()

unordered_set< Edge > votca::csg::BeadMotifConnector::getMotifEdges ( ) const
noexcept

Returns all the motif edges.

Definition at line 59 of file beadmotifconnector.cc.

Member Data Documentation

◆ motif_and_bead_edges_

reduced_edge_to_edges_map votca::csg::BeadMotifConnector::motif_and_bead_edges_
private

Definition at line 99 of file beadmotifconnector.h.


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