/usr/include/Bpp/Graph/AssociationGraphObserver.h is in libbpp-core-dev 2.4.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | //
// File AssociationGraphObserver.h
// Created by: Thomas Bigot
// Last modification : vendredi 4 novembre 2016, à 10h 21
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
This software is a computer program whose purpose is to provide utilitary
classes. This file belongs to the Bio++ Project.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _ASSOCIATIONGRAPHOBSERVER_HPP_
#define _ASSOCIATIONGRAPHOBSERVER_HPP_
#include "GraphObserver.h"
#include "../Exceptions.h"
#include "../Clonable.h"
#include <vector>
#include <map>
#include <iostream>
#include <ostream>
#include <memory>
#include <type_traits>
namespace bpp
{
/**
* @brief Defines a Graph Associator. It is a template which follows
* (subscribed to) a Graph.
*
* @author Thomas Bigot, Laurent Guéguen
*/
template<class N, class E>
class AssociationGraphObserver :
public virtual GraphObserver
{
private:
typedef Graph::NodeId NodeGraphid;
typedef Graph::EdgeId EdgeGraphid;
public:
typedef unsigned int NodeIndex;
typedef unsigned int EdgeIndex;
/**
* Specific copy of A and B objects, if clonable or not.
*
*/
template<class A, class B>
static B* copy(const A& a, typename std::enable_if< !std::is_base_of<B, A>::value&& !std::is_abstract<B>::value>::type* = 0)
{
return new B(a);
}
template<class A, class B>
static B* copy(const A& a, typename std::enable_if< std::is_base_of<B, A>::value&& !std::is_abstract<A>::value>::type* = 0)
{
return dynamic_cast<B*>(new A(a));
}
template<class A, class B>
static B* copy(const A& a, typename std::enable_if< std::is_base_of<B, A>::value&& std::is_abstract<A>::value&& std::is_base_of<Clonable, A>::value>::type* = 0)
{
return dynamic_cast<B*>(a.clone());
}
/** @name Graph Relations Management
* Modificating the structure of the graph.
*/
// /@{
/**
* Creates an orphaned node from a NodeClass object.
* @param newNodeObject the N object associated to the node in the graph.
*
*/
virtual void createNode(std::shared_ptr<N> newNodeObject) = 0;
/**
* Creates an node linked to an existing node. Order of parameters match
* the link method.
* @param newNodeObject the N object associated to the node in the graph.
* @param objectOriginNode existing node. In a directed graph:
* origin -> newNode.
* @param newEdgeObject optional edge between nodes (default = 00)
*/
virtual void createNode(std::shared_ptr<N> objectOriginNode, std::shared_ptr<N> newNodeObject, std::shared_ptr<E> newEdgeObject = 00) = 0;
/**
* Creates a link between two existing nodes.
* If directed graph: nodeA -> nodeB.
* @param nodeObjectA source node (or first node if undirected)
* @param nodeObjectB target node (or second node if undirected)
* @param edgeObject the optional edge between the nodes (default
* = 00)
*/
virtual void link(std::shared_ptr<N> nodeObjectA, std::shared_ptr<N> nodeObjectB, std::shared_ptr<E> edgeObject = 00) = 0;
/**
* Detroys a link between two existing nodes in the graph.
* If directed graph: nodeA -> nodeB.
* @param nodeObjectA source node (or first node if undirected)
* @param nodeObjectB target node (or second node if undirected)
*/
virtual void unlink(std::shared_ptr<N> nodeObjectA, std::shared_ptr<N> nodeObjectB) = 0;
/**
* Deletes a node
* @param nodeObject node to be deleted
*/
virtual void deleteNode(std::shared_ptr<N> nodeObject) = 0;
// /@}
/** @name Object Association
* Associate or dissociate N and E objects to pre-existing Graph Nodes and Graph Edges
*/
// /@{
/**
* Associate a N object to a node in the graph.
* @param nodeObject object to associate
* @param node existing node to be associated
*/
virtual void associateNode(std::shared_ptr<N> nodeObject, NodeGraphid node) = 0;
/**
* Associate a E object to an edge in the graph.
* @param edgeObject object to associate
* @param edge existing edge to be associated
*/
virtual void associateEdge(std::shared_ptr<E> edgeObject, EdgeGraphid edge) = 0;
/**
* Dissociate a N or E object to a node or an edge in the graph.
* Graph is not changed.
*
* @param nodeObject object to dissociate
*/
virtual void dissociateNode(std::shared_ptr<N> nodeObject) = 0;
virtual void dissociateEdge(std::shared_ptr<E> edgeObject) = 0;
/**
* Return the associated Node ID
* @param nodeObject object which to return the node ID
* @return a node ID
*/
virtual NodeGraphid getNodeGraphid(const std::shared_ptr<N> nodeObject) const = 0;
/**
* Return the associated Node ID
* @param edgeObject object which to return the node ID
* @return a node ID
*/
virtual EdgeGraphid getEdgeGraphid(const std::shared_ptr<E> edgeObject) const = 0;
/**
* Transforms an (a list of) id(s) into an (a list of) object(s)
*/
virtual const std::shared_ptr<N> getNodeFromGraphid(NodeGraphid) const = 0;
virtual std::shared_ptr<N> getNodeFromGraphid(NodeGraphid) = 0;
virtual std::vector<std::shared_ptr<N> > getNodesFromGraphid(std::vector<NodeGraphid> ) const = 0;
virtual std::shared_ptr<E> getEdgeFromGraphid(EdgeGraphid) = 0;
virtual const std::shared_ptr<E> getEdgeFromGraphid(EdgeGraphid) const = 0;
virtual std::vector<std::shared_ptr<E> > getEdgesFromGraphid(std::vector<EdgeGraphid> ) const = 0;
/**
* @return the root
*/
virtual std::shared_ptr<N> getRoot() const = 0;
virtual NodeIndex getRootIndex() const = 0;
// /@}
/** @name Object Indexation
* Get or set indexes to nodes and edges
*/
// /@{
/**
* @brief return if the object has an index.
*/
virtual bool hasIndex(const std::shared_ptr<N> nodeObject) const = 0;
virtual bool hasIndex(const std::shared_ptr<E> edgeObject) const = 0;
/**
* Return the associated Node index
* @param nodeObject object which to return the node index
* @return a node index
*/
virtual NodeIndex getNodeIndex(const std::shared_ptr<N> nodeObject) const = 0;
virtual std::vector<NodeIndex> getNodeIndexes(std::vector<std::shared_ptr<N> > nodeObjects) const = 0;
/**
* Return the associated Node index
* @param edgeObject object which to return the node index
* @return a node index
*/
virtual EdgeIndex getEdgeIndex(const std::shared_ptr<E> edgeObject) const = 0;
virtual std::vector<EdgeIndex> getEdgeIndexes(std::vector<std::shared_ptr<E> > edgeObjects) const = 0;
/**
* Set an index associated to a node
* @param nodeObject object to which one want to set the index
* @param index intex to be given, 0 to get the first free index
* @return the given index
*/
virtual NodeIndex setNodeIndex(const std::shared_ptr<N> nodeObject, NodeIndex index) = 0;
/**
* Set an index associated to an edge
* @param edgeObject object to which one want to set the index
* @param index intex to be given, 0 to get the first free index
* @return the given index
*/
virtual EdgeIndex setEdgeIndex(const std::shared_ptr<E> edgeObject, EdgeIndex index) = 0;
/**
* Return the associated Node, querying with an index
* @param nodeIndex the index of the wanted node
* @return N, a node object
*/
virtual std::shared_ptr<N> getNode(NodeIndex nodeIndex) const = 0;
/**
* Return the associated Node index
* @param edgeIndex the index of the wanted edge
* @return E, an edge object
*/
virtual std::shared_ptr<E> getEdge(EdgeIndex edgeIndex) const = 0;
// /@}
/** @name Topology exploration
* These methodes of the graph concern the topology exploration.
*/
// /@{
/**
* @name Iterator interface on Nodes
*
*/
class NodeIterator
{
public:
virtual ~NodeIterator() {}
virtual void next() = 0;
virtual bool end() const = 0;
virtual void start() = 0;
virtual std::shared_ptr<N> operator*() = 0;
};
/*
* @brief builds iterator on all Nodes of the graph
*
*/
virtual std::unique_ptr<NodeIterator> allNodesIterator() = 0;
virtual std::unique_ptr<NodeIterator> allNodesIterator() const = 0;
/*
* @brief builds iterator on the outgoing neighbor nodes of a Node
*
*/
virtual std::unique_ptr<NodeIterator> outgoingNeighborNodesIterator(std::shared_ptr<N> node) = 0;
virtual std::unique_ptr<NodeIterator> outgoingNeighborNodesIterator(std::shared_ptr<N> node) const = 0;
/*
* @brief builds iterator on the incoming neighbor nodes of a Node
*
*/
virtual std::unique_ptr<NodeIterator> incomingNeighborNodesIterator(std::shared_ptr<N> node) = 0;
virtual std::unique_ptr<NodeIterator> incomingNeighborNodesIterator(std::shared_ptr<N> node) const = 0;
/**
* Get all the neighbors of a node in the graph.
* @param node the node one wants to get its neighbors
* @return a vector containing the neighbors
*/
virtual std::vector<std::shared_ptr<N> > getNeighbors(const std::shared_ptr<N> node) const = 0;
virtual std::vector<NodeIndex> getNeighbors(NodeIndex node) const = 0;
/**
* Get all the edges from/to a node in the graph.
* @param node the node one wants to get its neighbor edges
* @return a vector containing the edges
*/
virtual std::vector<std::shared_ptr<E> > getEdges(const std::shared_ptr<N> node) const = 0;
virtual std::vector<EdgeIndex> getEdges(NodeIndex node) const = 0;
/**
* In an directed graph, get all the neighbors which
* are leaving a node in the graph.
* @param node the node one wants to get its neighbors
* @return a vector containing the outgoing neighbors
*/
virtual std::vector<std::shared_ptr<N> > getOutgoingNeighbors(const std::shared_ptr<N> node) const = 0;
virtual std::vector<NodeIndex> getOutgoingNeighbors(NodeIndex node) const = 0;
/**
* In an directed graph, get all the edges which
* are leaving a node in the graph.
* @param node the node one wants to get its edges
* @return a vector containing the outgoing edges
*/
virtual std::vector<std::shared_ptr<E> > getOutgoingEdges(const std::shared_ptr<N> node) const = 0;
virtual std::vector<EdgeIndex> getOutgoingEdges(NodeIndex node) const = 0;
/**
* In an directed graph, get all the neighbors which
* are coming to a node in the graph.
* @param node the node one wants to get its neighbors
* @return a vector containing the incoming neighbors
*/
virtual std::vector<std::shared_ptr<N> > getIncomingNeighbors(const std::shared_ptr<N> node) const = 0;
virtual std::vector<NodeIndex> getIncomingNeighbors(NodeIndex node) const = 0;
/**
* In an directed graph, get all the edges which
* are coming to a node in the graph.
* @param node the node one wants to get its edges
* @return a vector containing the incoming edges
*/
virtual std::vector<std::shared_ptr<E> > getIncomingEdges(const std::shared_ptr<N> node) const = 0;
virtual std::vector<EdgeIndex> getIncomingEdges(NodeIndex node) const = 0;
/**
* Get the leaves of a graph, ie, nodes with only one neighbor,
* starting from a peculiar node, up to a specific depth.
* @param node the starting node
* @param maxDepth the max recursion depth
* @return a vector containing the leaves
*/
virtual std::vector<std::shared_ptr<N> > getLeavesFromNode(std::shared_ptr<N> node, unsigned int maxDepth) const = 0;
/**
* Get all the leaves objects of a graph, ie, nodes with only one neighbor,
* @return a vector containing the leaves
*/
virtual std::vector<std::shared_ptr<N> > getAllLeaves() const = 0;
virtual std::vector<NodeIndex> getAllLeavesIndexes() const = 0;
/**
* Get all the inner nodes of a graph, ie, nodes with degree >= 2.
* @return a vector containing the inner nodes.
*/
virtual std::vector<std::shared_ptr<N> > getAllInnerNodes() const = 0;
/**
* Get all the defined nodes of a graphO,
* @return a vector containing the nodesObjects
*/
virtual std::vector<std::shared_ptr<N> > getAllNodes() const = 0;
virtual std::vector<NodeIndex> getAllNodesIndexes() const = 0;
/**
* @name Iterator interface on Edges
*
*/
class EdgeIterator
{
public:
virtual ~EdgeIterator() {}
virtual void next() = 0;
virtual bool end() const = 0;
virtual void start() = 0;
virtual std::shared_ptr<E> operator*() = 0;
};
/*
* @brief builds iterator on all Nodes of the graph
*
*/
virtual std::unique_ptr<EdgeIterator> allEdgesIterator() = 0;
/*
* @brief builds iterator on the outgoing neighbor nodes of a Node
*
*/
virtual std::unique_ptr<EdgeIterator> outgoingEdgesIterator(std::shared_ptr<N> node) = 0;
/*
* @brief builds iterator on the incoming neighbor nodes of a Node
*
*/
virtual std::unique_ptr<EdgeIterator> incomingEdgesIterator(std::shared_ptr<N> node) = 0;
/**
* Get all the defined edges of a graphO,
* @return a vector containing the branchesObjects
*/
virtual std::vector<std::shared_ptr<E> > getAllEdges() const = 0;
virtual std::vector<EdgeIndex> getAllEdgesIndexes() const = 0;
/**
* Returns the Edge between two nodes nodeA -> nodeB
* @param nodeA source node (if directed)
* @param nodeB destination node (if directed)
* @return the edge between these two nodes
*/
virtual std::shared_ptr<E> getEdgeLinking(std::shared_ptr<N> nodeA, std::shared_ptr<N> nodeB) const = 0;
/**
* Sets the Edge between two nodes nodeA -> nodeB
* @param nodeA source node (if directed)
* @param nodeB destination node (if directed)
* @param edge the edge between these two nodes
*/
virtual void setEdgeLinking(std::shared_ptr<N> nodeA, std::shared_ptr<N> nodeB, std::shared_ptr<E> edge) = 0;
// /@}
};
}
#endif
|