ogdf::ClusterPlanarityModule Class Reference

#include <ogdf/cluster/ClusterPlanarityModule.h>

Inheritance diagram for ogdf::ClusterPlanarityModule:

Public Member Functions
	ClusterPlanarityModule ()=default
virtual	~ClusterPlanarityModule ()=default
virtual bool	clusterPlanarEmbed (ClusterGraph &CG, Graph &G)
	Returns true, if CG is cluster-planar, false otherwise. If true, CG contains a cluster-planar embedding. More...
virtual bool	clusterPlanarEmbedClusterPlanarGraph (ClusterGraph &CG, Graph &G)
	Constructs a cluster-planar embedding of CG. CG has to be cluster-planar! More...
virtual bool	isClusterPlanar (const ClusterGraph &CG)
	Returns true, if CG is cluster-planar, false otherwise. More...
virtual bool	isClusterPlanarDestructive (ClusterGraph &CG, Graph &G)=0
	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::Module
	Module ()
	Initializes a module. More...
virtual	~Module ()

Protected Member Functions
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

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...

Detailed Description

Definition at line 41 of file ClusterPlanarityModule.h.

Constructor & Destructor Documentation

ClusterPlanarityModule()

ogdf::ClusterPlanarityModule::ClusterPlanarityModule ( )

default

~ClusterPlanarityModule()

virtual ogdf::ClusterPlanarityModule::~ClusterPlanarityModule ( )

virtualdefault

Member Function Documentation

clusterPlanarEmbed()

virtual bool ogdf::ClusterPlanarityModule::clusterPlanarEmbed ( ClusterGraph &  CG, Graph &  G  )

inlinevirtual

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

Reimplemented in ogdf::CconnectClusterPlanarityModule.

Definition at line 61 of file ClusterPlanarityModule.h.

clusterPlanarEmbedClusterPlanarGraph()

virtual bool ogdf::ClusterPlanarityModule::clusterPlanarEmbedClusterPlanarGraph ( ClusterGraph &  CG, Graph &  G  )

inlinevirtual

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 in ogdf::ILPClusterPlanarity, ogdf::CconnectClusterPlanarityModule, and ogdf::SyncPlanClusterPlanarityModule.

Definition at line 88 of file ClusterPlanarityModule.h.

copyBackEmbedding()

virtual void ogdf::ClusterPlanarityModule::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

inlineprotectedvirtual

Definition at line 94 of file ClusterPlanarityModule.h.

isClusterPlanar()

virtual bool ogdf::ClusterPlanarityModule::isClusterPlanar ( const ClusterGraph &  CG )

inlinevirtual

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

Reimplemented in ogdf::ILPClusterPlanarity, ogdf::CconnectClusterPlanarityModule, ogdf::HananiTutteCPlanarity, and ogdf::SyncPlanClusterPlanarityModule.

Definition at line 48 of file ClusterPlanarityModule.h.

isClusterPlanarDestructive()

virtual bool ogdf::ClusterPlanarityModule::isClusterPlanarDestructive ( ClusterGraph &  CG, Graph &  G  )

pure virtual

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

Implemented in ogdf::HananiTutteCPlanarity, ogdf::ILPClusterPlanarity, ogdf::CconnectClusterPlanarityModule, and ogdf::SyncPlanClusterPlanarityModule.

---

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

• include/ogdf/cluster/ClusterPlanarityModule.h