Boost logo

Boost-Commit :

Date view Thread view Subject view Author view

Subject: [Boost-commit] svn:boost r76778 - trunk/libs/graph/doc
From: jewillco_at_[hidden]
Date: 2012-01-29 14:04:47

Author: jewillco
Date: 2012-01-29 14:04:46 EST (Sun, 29 Jan 2012)
New Revision: 76778
URL: http://svn.boost.org/trac/boost/changeset/76778

Log:
Added directed_graph stub documentation from David Doria
Added:
   trunk/libs/graph/doc/directed_graph.html (contents, props changed)

Added: trunk/libs/graph/doc/directed_graph.html
==============================================================================
--- (empty file)
+++ trunk/libs/graph/doc/directed_graph.html 2012-01-29 14:04:46 EST (Sun, 29 Jan 2012)
@@ -0,0 +1,95 @@
+<HTML>
+<!--
+ Copyright (c) Jeremy Siek 2000
+
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt)
+ -->
+<Head>
+<Title>Boost Graph Library: Directed Graph</Title>
+<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
+ ALINK="#ff0000">
+<IMG SRC="../../../boost.png"
+ ALT="C++ Boost" width="277" height="86">
+
+<BR Clear>
+
+<H1><A NAME="sec:directed-graph-class"></A>
+<pre>
+directed_graph&lt;VertexProp, EdgeProp, GraphProp&gt;
+</pre>
+</H1>
+
+
+<P>
+The <tt>directed_graph</tt> class template is is a simplified version
+of the BGL adjacency list. This class is provided for ease of use, but
+may not perform as well as custom-defined adjacency list classes. Instances
+of this template model the BidirectionalGraph, VertexIndexGraph, and
+EdgeIndexGraph concepts.
+
+<H3>Example</H3>
+
+<P>
+
+
+<PRE>
+ typedef boost::directed_graph<> Graph;
+ Graph g;
+ Graph::vertex_descriptor v0 = g.add_vertex();
+ Graph::vertex_descriptor v1 = g.add_vertex();
+
+ g.add_edge(v0, v1);
+</PRE>
+
+<H3>Template Parameters</H3>
+
+<P>
+<TABLE border>
+<TR>
+<th>Parameter</th><th>Description</th><th>Default</th>
+</tr>
+
+<TR><TD><TT>VertexProp</TT></TD>
+<TD>A property map for the graph vertices.</TD>
+<TD>&nbsp;</TD>
+</TR>
+
+<TR>
+<TD><TT>EdgeProp</TT></TD>
+<TD>A property map for the graph edges.</TD>
+<TD>&nbsp;</TD>
+</TR>
+
+<TR>
+<TD><TT>GraphProp</TT></TD>
+<TD>A property map for the graph itself.</TD>
+</TR>
+
+</TABLE>
+<P>
+
+<H3>Where Defined</H3>
+
+<P>
+boost/graph/directed_graph.hpp
+
+<P>
+
+<br>
+<HR>
+<TABLE>
+<TR valign=top>
+<TD nowrap>Copyright &copy; 2000-2001</TD><TD>
+Jeremy Siek,
+Indiana University (<A
+HREF="mailto:jsiek_at_[hidden]">jsiek_at_[hidden]</A>)<br>
+<A HREF="http://www.boost.org/people/liequan_lee.htm">Lie-Quan Lee</A>, Indiana University (<A HREF="mailto:llee_at_[hidden]">llee_at_[hidden]</A>)<br>
+Andrew Lumsdaine,
+Indiana University (<A
+HREF="mailto:lums_at_[hidden]">lums_at_[hidden]</A>)
+</TD></TR></TABLE>
+
+</BODY>
+</HTML>

Date view Thread view Subject view Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk