Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::CconnectClusterPlanarityModule Class Reference

#include <ogdf/cluster/CconnectClusterPlanar.h>

+ Inheritance diagram for ogdf::CconnectClusterPlanarityModule:

Public Member Functions

bool clusterPlanarEmbed (ClusterGraph &CG, Graph &G) override
 Returns true, if CG is cluster-planar, false otherwise. If true, CG contains a cluster-planar embedding. More...
 
bool clusterPlanarEmbedClusterPlanarGraph (ClusterGraph &CG, Graph &G) override
 Constructs a cluster-planar embedding of CG. CG has to be cluster-planar! More...
 
bool isClusterPlanar (const ClusterGraph &CG) override
 Returns true, if CG is cluster-planar, false otherwise. More...
 
bool isClusterPlanarDestructive (ClusterGraph &CG, Graph &G) override
 Returns true, if CG is cluster-planar, false otherwise. In it is non-cluster-planar, the (Cluster)Graph may be arbitrarily changed after the call. More...
 
- Public Member Functions inherited from ogdf::ClusterPlanarityModule
 ClusterPlanarityModule ()=default
 
virtual ~ClusterPlanarityModule ()=default
 
- Public Member Functions inherited from ogdf::Module
 Module ()
 Initializes a module. More...
 
virtual ~Module ()
 

Additional Inherited Members

- Public Types inherited from ogdf::Module
enum  ReturnType { ReturnType::Feasible, ReturnType::Optimal, ReturnType::NoFeasibleSolution, ReturnType::TimeoutFeasible, ReturnType::TimeoutInfeasible, ReturnType::Error }
 The return type of a module. More...
 
- Static Public Member Functions inherited from ogdf::Module
static bool isSolution (ReturnType ret)
 Returns true iff ret indicates that the module returned a feasible solution. More...
 
- Protected Member Functions inherited from ogdf::ClusterPlanarityModule
virtual void copyBackEmbedding (ClusterGraph &CG, Graph &G, const ClusterGraph &CGcopy, const Graph &Gcopy, const ClusterArray< cluster > &copyC, const NodeArray< node > &copyN, const EdgeArray< edge > &copyE, const EdgeArray< edge > &origE) const
 

Detailed Description

Definition at line 100 of file CconnectClusterPlanar.h.

Member Function Documentation

◆ clusterPlanarEmbed()

bool ogdf::CconnectClusterPlanarityModule::clusterPlanarEmbed ( ClusterGraph CG,
Graph G 
)
overridevirtual

Returns true, if CG is cluster-planar, false otherwise. If true, CG contains a cluster-planar embedding.

Reimplemented from ogdf::ClusterPlanarityModule.

◆ clusterPlanarEmbedClusterPlanarGraph()

bool ogdf::CconnectClusterPlanarityModule::clusterPlanarEmbedClusterPlanarGraph ( ClusterGraph CG,
Graph G 
)
overridevirtual

Constructs a cluster-planar embedding of CG. CG has to be cluster-planar!

Returns true if the embedding was successful. Returns false if the given graph was non-cluster-planar (and leaves the (Cluster)Graph in an at least partially invalidated state).

This routine may be slightly faster than clusterPlanarEmbed, but requires CG to be cluster-planar. If CG is not cluster-planar, the (Cluster)Graph will be (partially) destroyed while trying to embed it!

Reimplemented from ogdf::ClusterPlanarityModule.

◆ isClusterPlanar()

bool ogdf::CconnectClusterPlanarityModule::isClusterPlanar ( const ClusterGraph CG)
overridevirtual

Returns true, if CG is cluster-planar, false otherwise.

Reimplemented from ogdf::ClusterPlanarityModule.

◆ isClusterPlanarDestructive()

bool ogdf::CconnectClusterPlanarityModule::isClusterPlanarDestructive ( ClusterGraph CG,
Graph G 
)
overridevirtual

Returns true, if CG is cluster-planar, false otherwise. In it is non-cluster-planar, the (Cluster)Graph may be arbitrarily changed after the call.

This variant may be slightly faster than the default isClusterPlanar

Implements ogdf::ClusterPlanarityModule.


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