Overview     Modules     Class Hierarchy     Classes     Members  
Classes | Typedefs | Enumerations | Functions | Variables
tlp Namespace Reference

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

This file is part of Tulip (www.tulip-software.org)

Authors: David Auber and the Tulip development Team from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest

Tulip is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Tulip is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Typedef Documentation

typedef AbstractProperty<tlp::ColorType, tlp::ColorType, tlp::ColorAlgorithm> tlp::AbstractColorProperty
typedef AbstractProperty<tlp::DoubleType, tlp::DoubleType, tlp::DoubleAlgorithm> tlp::AbstractDoubleProperty
typedef AbstractProperty<tlp::GraphType, tlp::EdgeSetType> tlp::AbstractGraphProperty
typedef AbstractProperty<tlp::IntegerType, tlp::IntegerType, tlp::IntegerAlgorithm> tlp::AbstractIntegerProperty
typedef AbstractProperty<tlp::PointType, tlp::LineType, tlp::LayoutAlgorithm> tlp::AbstractLayoutProperty
typedef AbstractProperty<tlp::SizeType, tlp::SizeType, tlp::SizeAlgorithm> tlp::AbstractSizeProperty
typedef AbstractProperty<tlp::StringType, tlp::StringType, tlp::StringAlgorithm> tlp::AbstractStringProperty
typedef SerializableVectorType<tlp::Color,true> tlp::ColorVectorType
typedef SerializableVectorType<tlp::Coord,true> tlp::CoordVectorType
typedef SerializableVectorType<double,false> tlp::DoubleVectorType
typedef SerializableVectorType<int,false> tlp::IntegerVectorType
typedef SerializableVectorType<tlp::Size,true> tlp::SizeVectorType

Enumeration Type Documentation

enum tlp::EDGE_TYPE
Enumerator:
DIRECTED 
INV_DIRECTED 
UNDIRECTED 
enum tlp::ElementType
Enumerator:
NODE 
EDGE 
enum tlp::ProgressState
Enumerator:
TLP_CONTINUE 
TLP_CANCEL 
TLP_STOP 

Function Documentation

TLP_SCOPE _DEPRECATED bool tlp::applyAlgorithm ( Graph *  graph,
std::string &  errorMsg,
DataSet *  dataSet = NULL,
const std::string &  algorithm = "any",
PluginProgress *  progress = NULL 
)

Applies an algorithm plugin, identified by its name.

Applies an algorithm plugin named alg (must be loaded) on graph . Algorithm plugins are objects implementing the tlp::Algorithm interface. Parameters can be transmit to the algorithm trough a DataSet object (refer to the plugin documentation to get its parameters list). If an error occurs, a message may have been stored by the algorithm in the errosMsg variable. Returns true if the algorithm has been successfully applied.

Deprecated:
this function should not be used anymore, please use Graph::applyAlgorithm() instead.

If an error occurs, a message describing the error should be stored in errorMessage.

Parameters:
graphA graph for which the algorithm must be applied.
errorMessageA string that will be modified to contain an error message should an error occur.
dataSetThe parameters to the algorithm. Defaults to NULL.
algorithmThe algorithm to apply. Defaults to "any".
progressA PluginProgress to report the progress of the operation, as well as final state. Defaults to NULL.
Returns:
bool Whether the algorithm was successfully applied.
bool tlp::averageCluster ( Graph *  g,
double &  result,
PluginProgress *  pp = NULL 
) [inline]
TLP_SCOPE double tlp::averageClusteringCoefficient ( const Graph *  ,
PluginProgress *  = 0 
)

Returns the clustering coefficient of a graph as the average of the local clustering coefficients (see clusteringCoefficient function) of all the nodes. see http://en.wikipedia.org/wiki/Clustering_coefficient for more details.

bool tlp::averagePathLength ( Graph *  g,
double &  result,
PluginProgress *  pp = NULL 
) [inline]
TLP_SCOPE double tlp::averagePathLength ( const Graph *  g,
PluginProgress *  = NULL 
)

Returns the average path length of a graph, that is the sum of the shortest distances for all pair of distinct nodes in that graph divided by the number of those pairs. For a pair of non connected nodes, the shorted distance is set to 0. see http://en.wikipedia.org/wiki/Average_path_length for more details

TLP_SCOPE void tlp::clusteringCoefficient ( const Graph *  g,
MutableContainer< double > &  result,
unsigned int  maxDepth = 1,
PluginProgress *  = NULL 
)

Assigns to each node its local clustering coefficient that is the proportion of edges between the nodes within its neighbourhood divided by the number of edges that could possibly exist between them. This quantifies how close its neighbors are to being a clique. see http://en.wikipedia.org/wiki/Clustering_coefficient for more details

TLP_SCOPE BoundingBox tlp::computeBoundingBox ( const Graph *  graph,
const LayoutProperty *  layout,
const SizeProperty *  size,
const DoubleProperty *  rotation,
const BooleanProperty *  selection = NULL 
)

Computes the bounding box of a graph according to nodes positions, edges bends, nodes z-rotations and sizes of elements.

TLP_SCOPE BoundingBox tlp::computeBoundingBox ( Iterator< node > *  itN,
Iterator< edge > *  itE,
const LayoutProperty *  layout,
const SizeProperty *  size,
const DoubleProperty *  rotation,
const BooleanProperty *  selection = NULL 
)

Compute the bounding box of graph elements according to node positions, edges bends, nodes z-rotations and sizes of elements.

Iterator itN and itE will be deleted after the computations (i.e. no need to delete them yourself).

TLP_SCOPE std::pair<Coord, Coord> tlp::computeBoundingRadius ( const Graph *  graph,
const LayoutProperty *  layout,
const SizeProperty *  size,
const DoubleProperty *  rotation,
const BooleanProperty *  selection = NULL 
)

Computes a bounding sphere (or a bounding circle if the graph has a 2D layout) of a graph according to nodes positions, edges bends, nodes z-rotations and sizes of elements.

Returns a pair of tlp::Coord whose first member is the center of the bounding sphere (circle for 2D layout) and second member is the farthest point from the center (computed from graph elements positions). To get the bounding radius, you have to compute the distance between the two members of the pair (use the dist method from tlp::Coord).

TLP_SCOPE std::vector<std::vector<node> > tlp::computeCanonicalOrdering ( PlanarConMap *  ,
std::vector< edge > *  dummyEdges = NULL,
PluginProgress *  pluginProgress = NULL 
)

This ordering was first introduced by C. Gutwenger and P. Mutzel in
"Grid embeddings of biconnected planar graphs",
"Extended Abstract, Max-Planck-Institut für Informatik,"
"Saarbrücken, Germany, 1997"
Let n be the number of nodes, the original algorithm complexity is in O(n).
But the implementation of the canonical ordering has not been made in O(n).

TLP_SCOPE std::vector<Coord> tlp::computeConvexHull ( const Graph *  graph,
const LayoutProperty *  layout,
const SizeProperty *  size,
const DoubleProperty *  rotation,
const BooleanProperty *  selection = NULL 
)

Computes a convex hull of a graph according to nodes positions, edges bends, nodes z-rotations, and sizes of elements. Only works with 2D layouts.

Returns a vector of tlp::Coord containing the vertices of the graph convex hull correctly ordered.

TLP_SCOPE std::vector<Coord> tlp::computeConvexHull ( const std::vector< tlp::Coord > &  points)

Computes a convex hull of a set of points, Only works with 2D layouts.

Returns a vector of tlp::Coord containing the vertices of the points convex hull correctly ordered.

TLP_SCOPE bool tlp::computeEqualValueClustering ( Graph *  graph,
PropertyInterface *  property,
bool  onNodes = true,
bool  connected = false,
PluginProgress *  pluginProgress = NULL 
)

Compute the subgraphs whose elements have the same value for property

TLP_SCOPE std::vector<node> tlp::computeGraphCenters ( Graph *  graph)

Find all the graph centers, that version does not manage edge weight. complexity O(n * m). Only works on connected graphs.

TLP_SCOPE bool tlp::computeLinesIntersection ( const std::pair< tlp::Coord, tlp::Coord > &  line1,
const std::pair< tlp::Coord, tlp::Coord > &  line2,
tlp::Coord &  intersectionPoint 
)

Computes the intersection point (if any) of two 3d lines. Returns true if the line intersects, false otherwise (parallel or skew lines).

TLP_SCOPE tlp::Coord tlp::computePolygonCentroid ( const std::vector< tlp::Coord > &  points)

Computes the centroid of a polygon. Polygon vertices must be provided correctly ordered in the points vector.

TLP_SCOPE void tlp::copyToGraph ( Graph *  outG,
const Graph *  inG,
BooleanProperty *  inSelection = NULL,
BooleanProperty *  outSelection = NULL 
)

Appends the selected part of the graph inG (properties, nodes and edges) into the graph outG. If no selection is done (inSel=NULL), the whole inG graph is appended. The output selection is used to select the appended nodes & edges

Warning:
The input selection is extended to all selected edge ends.
node tlp::createMetaNode ( Graph *  graph,
const std::set< node > &  nodeSet 
) [inline]

Function to close a subgraph into a metanode. Edges from nodes in the subgraph to nodes outside the subgraph are replaced with edges from the metanode to the nodes outside the subgraph.

TLP_SCOPE void tlp::dagLevel ( const Graph *  graph,
MutableContainer< unsigned int > &  level,
PluginProgress *  = NULL 
)

Assigns to each node of a Directed Acyclic Graph a level such that if the edge e(u,v) exists level(u) < level(v). The algorithm ensures that the number of level used is minimal.

Warning : the graph must be acyclic (no self loops).

TLP_SCOPE std::string tlp::demangleTlpClassName ( const char *  className)

Demangles the name of a C++ class defined in the tlp namespace. Simply removes the 'tlp::' prefix from the class name.

Returns:
string The demangled name of a Tulip C++ class.
TLP_SCOPE bool tlp::exportGraph ( Graph *  graph,
std::ostream &  outputStream,
const std::string &  format,
DataSet &  dataSet,
PluginProgress *  progress = NULL 
)

Exports a graph using the specified export plugin with parameters stored in the DataSet.

You determine the destination, whether by using a fstream, or by saving the contents of the stream to the destination of your choice.

Parameters:
graphThe graph to export.
outputStreamThe stream to export to. Can be a standard ostream, an ofstream, or even a gzipped ostream.
formatThe format to use to export the Graph.
dataSetThe parameters to pass to the export plugin (e.g. additional data, options for the format)
progressA PluginProgress to report the progress of the operation, as well as final state. Defaults to NULL.
Returns:
bool Whether the export was successfull or not.
TLP_SCOPE const std::string& tlp::getCurrentPluginFileName ( )

Gets the plugin library currently loading Returns the absolute file name of the plugin library currently loading.

TLP_SCOPE std::istream* tlp::getIgzstream ( const char *  name,
int  open_mode = std::ios::in 
)

Returns an istream to read from a gzipped file (uses gzstream lib). The stream has to be deleted after use.

Parameters:
nameThe name of the file to read from.
open_modeThe mode to open the file with. Defaults to std::ios::in.
Returns:
istream gzipped input stream from a file.
TLP_SCOPE std::string tlp::getMajor ( const std::string &  release)

Splits the string and returns everything before the first dot ('.'). This is used to return major version number, as version numbers are formatted as X.Y.Z, X being the major, Y the minor, and Z the patch version.

Returns:
string The part of the string before the first dot.
TLP_SCOPE std::string tlp::getMinor ( const std::string &  release)

Splits the string and return the minor version. If the string does not contain any dot, then 0 is returned. If the string contains only one dot (X.Y), then everything after the first dot is returned (Y). If the string is a full version with two dots (X.Y.Z), everything between the first and last dots is returned (Y). If there are more than two dots, everything between the first and last dots is returned.

TLP_SCOPE std::ostream* tlp::getOgzstream ( const char *  name,
int  open_mode = std::ios::out 
)

Returns an ostream to write to a gzipped file (uses gzstream lib). The stream has to be deleted after use.

Warning:
Don't forget to check the stream with ios::bad()!
Parameters:
nameThe name of the file to write to.
open_modeThe mode to open the file with. Defaults to std::ios::out.
Returns:
ostream gzipped output stream to a file.
TLP_SCOPE _DEPRECATED bool tlp::getSource ( const Graph *  ,
node &  n 
)

Finds the first node whose input degree equals 0.

Deprecated:
this function should not be used anymore, please use Graph::getSource() instead.
Returns:
tlp::node The first encountered node with input degree of 0, or an invalid node if none was found.
TLP_SCOPE node tlp::graphCenterHeuristic ( Graph *  graph,
PluginProgress *  pluginProgress = NULL 
)

return a node that can be considered as the graph center. It is an heuristic, thus it is not absolutely sure that this node is a graph center. Only works on connected graphs.

TLP_SCOPE Graph* tlp::importGraph ( const std::string &  format,
DataSet &  dataSet,
PluginProgress *  progress = NULL,
Graph *  newGraph = NULL 
)

Imports a graph using the specified import plugin with the parameters stored in the DataSet.

If no graph is passed, then a new graph will be created. You can pass a graph in order to import data into it. Returns the graph with imported data, or NULL if the import failed. In this case, the Pluginprogress should have an error that can be displayed.

Parameters:
formatThe format to use to import the graph.
dataSetThe parameters to pass to the import plugin (file to read, ...)
progressA PluginProgress to report the progress of the operation, as well as final state. Defaults to NULL.
newGraphThe graph to import the data into. This can be usefull to import data into a subgraph. Defaults to NULL.
Returns:
:Graph* The graph containing the imported data, or NULL in case of failure.
Graph* tlp::inducedSubGraph ( Graph *  graph,
const std::set< node > &  nodeSet 
) [inline]

Return the subgraph induced by a set of nodes

TLP_SCOPE void tlp::initTulipLib ( const char *  appDirPath = 0)

Initializes the Tulip library. Looks for the Tulip plugins directory and fills the Tulip path variables : tlp::TulipLibDir, tlp::TulipPluginsPath, ... The plug-ins directory can be defined in different ways, given by order of prevalence : 1. the TLP_DIR environment variable, if it has a value 2. the appDirPath parameter, if it is not NULL 3. at that point, the Tulip paths will be retrieved from the path of the loaded Tulip shared library (you must dispose of a standard Tulip installation for that feature to work). 4. a fallback value of 'C:/Tulip/lib/' on windows, or '/usr/local/lib/' on unix.

TLP_SCOPE void tlp::initTypeSerializers ( )
TLP_SCOPE Graph* tlp::loadGraph ( const std::string &  filename)

Loads a graph in the tlp format from a file (extension can be .tlp or .tlp.gz). This function uses the "tlp" import plugin, and will fail if it is not loaded (By default this plugin is linked into the library and should be loaded).

If the import fails (no such file, parse error, ...) NULL is returned.

Parameters:
filenameThe file in tlp format to parse.
Returns:
:Graph* The imported Graph, NULL if the import failed.
TLP_SCOPE bool tlp::loadPlugin ( const std::string &  filename,
PluginLoader *  plug = NULL 
)

Loads a plugin from a specific shared library.

Parameters:
filenamethe path to the shared library containing the Tulip plugin (file extension : .so on linux, .dylib on mac, .dll on windows)
plugA PluginLoader to output what is going on. Defaults to 0.
Returns:
bool true if the plugin was correctly loaded
TLP_SCOPE void tlp::loadPlugins ( PluginLoader *  plug = NULL)

Calls loadPluginsFromDir for each directory in TulipPluginsPath.

Loads plugins installed in the directories listed in the tlp::TulipPluginsPath variable (in the form "<path1>;<path2>" on windows and "<path1>:<path2>" on unix)

Parameters:
plugA PluginLoader to output what is going on. Defaults to 0.
TLP_SCOPE void tlp::loadPluginsCheckDependencies ( PluginLoader *  loader = NULL)

Checks the dependencies of all plugins loaded so far. If a plugin does not have all its dependencies fulfilled, it is unloaded and removed from the current plugins database.

Parameters:
loaderA PluginLoader to output what is going on. Defaults to 0.
TLP_SCOPE void tlp::loadPluginsFromDir ( std::string  dir,
std::string  type,
PluginLoader *  loader = NULL 
)

Loads plugins located in a specific directory

Parameters:
dirthe path to the directory containing the Tulip plugins
typea string used by the plugin loader (if any) to output the type of plugin being loaded
loaderA PluginLoader to output what is going on. Defaults to 0.
TLP_SCOPE void tlp::makeProperDag ( Graph *  graph,
std::list< node > &  addedNodes,
TLP_HASH_MAP< edge, edge > &  replacedEdges,
IntegerProperty *  edgeLength = NULL 
)
TLP_SCOPE node tlp::makeSimpleSource ( Graph *  graph)

return a new node connected to all previously existing nodes which had a null indegree

TLP_SCOPE unsigned int tlp::maxDegree ( const Graph *  )

Returns the maximum value of the degree of the graph's nodes.

TLP_SCOPE unsigned int tlp::maxDistance ( const Graph *  graph,
const node  n,
MutableContainer< unsigned int > &  distance,
EDGE_TYPE  direction = UNDIRECTED 
)

Computes the maximum distance from n to all the other nodes of the graph and store it into distance (stored value is UINT_MAX for non connected nodes). If direction is set to 2 use undirected graph, 0 use directed graph and 1 use reverse directed graph (ie. all edges are reversed). All the edge's weight is set to 1. (it uses a bfs thus the complexity is o(m), m = |E|).

TLP_SCOPE unsigned int tlp::minDegree ( const Graph *  )

Returns the minimum value of the degree of the graph's nodes.

TLP_SCOPE _DEPRECATED Graph* tlp::newCloneSubGraph ( Graph *  root,
std::string  name = "unnamed" 
)

Creates and returns a subgraph of the graph that is equal to root (a clone subgraph).

Deprecated:
this function should not be used anymore, please use Graph::addCloneSubGraph() instead.
Parameters:
graphThe Graph on which to create a clone subgraph.
nameThe name of the newly created subgraph. Defaults to "unnamed".
Returns:
:Graph* The newly created clone subgraph.
TLP_SCOPE Graph* tlp::newGraph ( )

Creates and returns a new empty graph.

This is a simple method factory to create a Graph implementation (remember, Graph is only an interface).

This is the recommended way to create a new Graph.

Returns:
:Graph* A new, empty graph.
Examples:
PrintObserver.
TLP_SCOPE _DEPRECATED Graph* tlp::newSubGraph ( Graph *  root,
std::string  name = "unnamed" 
)

Creates and returns an empty subgraph of the given graph.

Deprecated:
this function should not be used anymore, please use Graph::addSubGraph() instead.
Parameters:
graphThe graph to add an empty subgraph to.
nameThe name of the new subgraph. Defaults to "unnamed".
Returns:
:Graph* The newly created subgraph.
void tlp::openMetaNode ( Graph *  graph,
node  n 
) [inline]

Function to open a metanode and replace all edges between that meta node and other nodes in the graph.

TLP_SCOPE std::ostream& tlp::operator<< ( std::ostream &  os,
const tlp::Color &   
)
TLP_SCOPE std::istream& tlp::operator>> ( std::istream &  is,
tlp::Color &   
)
TLP_SCOPE void tlp::reachableNodes ( const Graph *  graph,
const node  startNode,
std::set< node > &  result,
unsigned int  maxDistance,
EDGE_TYPE  direction = UNDIRECTED 
)

Adds to a result set, all the nodes, according to direction, at distance less or equal to maxDistance of startNode.

TLP_SCOPE void tlp::removeFromGraph ( Graph *  ioG,
BooleanProperty *  inSelection = NULL 
)

Removes the selected part of the graph ioG (properties values, nodes and edges). If no selection is done (inSel=NULL), the whole graph is reseted to default value.

Warning:
The selection is extended to all selected edge ends.
TLP_SCOPE bool tlp::saveGraph ( Graph *  g,
const std::string &  filename 
)

Saves the corresponding root graph and all its subgraphs to a file using the tlp format. Extension of the file can be either .tlp (human-readable text file) or .tlp.gz (gzipped text file).

This function checks the file name for the '.gz' extension and uses a compressed output if found.

This function uses the "tlp" export plugin, and will fail if it is not loaded (by default this plugin is linked into the library and should be loaded).

Parameters:
gThe graph to save.
filenameThe file to save the graph to.
Returns:
bool Whether the export was successfull or not.
TLP_SCOPE void tlp::selectMinimumSpanningTree ( Graph *  graph,
BooleanProperty *  selectionProperty,
DoubleProperty *  weight = NULL,
PluginProgress *  pluginProgress = NULL 
)

Select the minimum spanning tree (Kruskal algorithm) of a weighted graph, i.e for all graph elements (nodes or edges) belonging to that tree the selectionProperty associated value is true. The value is false for the other elements

TLP_SCOPE void tlp::selectSpanningForest ( Graph *  graph,
BooleanProperty *  selectionProperty,
PluginProgress *  pluginProgress = NULL 
)

Select a spanning forest of the graph, i.e for all graph elements (nodes or edges) belonging to that forest the selectionProperty associated value is true. The value is false for the other elements

TLP_SCOPE void tlp::selectSpanningTree ( Graph *  graph,
BooleanProperty *  selection,
PluginProgress *  pluginProgress = NULL 
)

Select a spanning tree of a graph assuming it is connected; i.e for all graph elements (nodes or edges) belonging to that tree the selectionProperty associated value is true. The value is false for the other elements

Variable Documentation

TLP_SCOPE const char tlp::PATH_DELIMITER
TLP_SCOPE std::string tlp::TulipBitmapDir
TLP_SCOPE std::string tlp::TulipDocProfile
TLP_SCOPE std::string tlp::TulipLibDir
TLP_SCOPE std::string tlp::TulipPluginsPath
TLP_SCOPE std::string tlp::TulipShareDir
TLP_SCOPE std::string tlp::TulipUserHandBookIndex


Tulip Software by LaBRI Visualization Team    2001 - 2012