\HeaderA{RBGL.overview}{RBGL.overview}{RBGL.overview}
\keyword{models}{RBGL.overview}
\begin{Description}\relax
The RBGL package consists of a number of interfaces to the Boost
C++ library for graph algorithms.  This page follows, approximately,
the chapter structure of the monograph on the Boost Graph Library
by Siek et al., and gives hyperlinks to documentation on
R functions currently available, along with the names
of formal parameters to these functions.
\end{Description}
\begin{Section}{basicAlgs}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{bandwidth}{bandwidth}} & \code{g}\\
\code{\LinkA{bfs}{bfs}} & \code{object,node,checkConn}\\
\code{\LinkA{dfs}{dfs}} & \code{object,node,checkConn}\\
\code{\LinkA{edgeConnectivity}{edgeConnectivity}} & \code{g}\\
\code{\LinkA{gprofile}{gprofile}} & \code{g}\\
\code{\LinkA{isomorphism}{isomorphism}} & \code{g1,g2}\\
\code{\LinkA{minCut}{minCut}} & \code{g}\\
\code{\LinkA{transitive.closure}{transitive.closure}} & \code{g}\\
\code{\LinkA{tsort}{tsort}} & \code{x}\\
}
\end{Section}
\begin{Section}{ShortestPaths}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{bellman.ford.sp}{bellman.ford.sp}} & \code{g,start}\\
\code{\LinkA{dag.sp}{dag.sp}} & \code{g,start}\\
\code{\LinkA{dijkstra.sp}{dijkstra.sp}} & \code{g,start}\\
\code{\LinkA{extractPath}{extractPath}} & \code{s,f,pens}\\
\code{\LinkA{johnson.all.pairs.sp}{johnson.all.pairs.sp}} & \code{g}\\
\code{\LinkA{sp.between}{sp.between}} & \code{g,start,finish}\\
\code{\LinkA{sp.between.old}{sp.between.old}} & \code{g,start,finish}\\
\code{\LinkA{sp.between.scalar}{sp.between.scalar}} & \code{g,start,finish}\\
}
\end{Section}
\begin{Section}{MinimumSpanningTree}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{mstree.kruskal}{mstree.kruskal}} & \code{x}\\
\code{\LinkA{prim.minST}{prim.minST}} & \code{g}\\
}
\end{Section}
\begin{Section}{ConnectedComponents}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{connectedComp}{connectedComp}} & \code{g}\\
\code{\LinkA{highlyConnSG}{highlyConnSG}} & \code{g,sat,ldv}\\
\code{\LinkA{incremental.components}{incremental.components}} & \code{g}\\
\code{\LinkA{init.incremental.components}{init.incremental.components}} & \code{g}\\
\code{\LinkA{same.component}{same.component}} & \code{g,node1,node2}\\
\code{\LinkA{strongComp}{strongComp}} & \code{g}\\
}
\end{Section}
\begin{Section}{MaximumFlow}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{edmunds.karp.max.flow}{edmunds.karp.max.flow}} & \code{g,source,sink}\\
\code{\LinkA{push.relabel.max.flow}{push.relabel.max.flow}} & \code{g,source,sink}\\
}
\end{Section}
\begin{Section}{SparseMatrixOrdering}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{cuthill.mckee.ordering}{cuthill.mckee.ordering}} & \code{g}\\
\code{\LinkA{minDegreeOrdering}{minDegreeOrdering}} & \code{g,delta}\\
\code{\LinkA{sloan.ordering}{sloan.ordering}} & \code{g,w1,w2}\\
}
\end{Section}
\begin{Section}{LayoutAlgorithms}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{circle.layout}{circle.layout}} & \code{g,radius}\\
\code{\LinkA{kamada.kawai.spring.layout}{kamada.kawai.spring.layout}} & \code{g,edge\_or\_side,es\_length}\\
}
\end{Section}
\begin{Section}{GraphClustering}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{betweenness.centrality.clustering}{betweenness.centrality.clustering}} & \code{g,threshold,normalize}\\
}
\end{Section}
\begin{Section}{Betweenness}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{brandes.betweenness.centrality}{brandes.betweenness.centrality}} & \code{g}\\
}
\end{Section}
\begin{Section}{Wavefront}
\Tabular{ll}{
Functions & parameters \\ 
\code{\LinkA{aver.wavefront}{aver.wavefront}} & \code{g}\\
\code{\LinkA{ith.wavefront}{ith.wavefront}} & \code{g,start}\\
\code{\LinkA{maxWavefront}{maxWavefront}} & \code{g}\\
\code{\LinkA{rms.wavefront}{rms.wavefront}} & \code{g}\\
}
\end{Section}

