blob: 90a1400faec69b1d0b0140881f9ebdfb8b8640b4 [file] [log] [blame]
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Commons Graph</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
<section name="The Graph Component">
<p>A <a href="http://en.wikipedia.org/wiki/Graph_(data_structure)">graph</a>
is an abstract structure in which objects can be linked together to represent relationships between them.
Graphs and graph-based data structures are at the core of many real-world domains and applications:
typical examples include communication networks, databases, chemical structures, social networks and so on.
Graphs can be implemented in different ways, based on the specific domain and usage patterns.</p>
<p>Commons Graph provides simple <a href="http://en.wikipedia.org/wiki/Fluent_interface">fluent APIs</a>
to manage graph-based data structures and execute standard operations and algorithms on them. </p>
<p>Some of the features of Commons Graph are listed below:</p>
<ul>
<li>A highly abstract domain for graph components and types, together with related base implementations.</li>
<li>Standard algorithms such as shortest path, maximum flow, spanning tree and so on.</li>
<li>Customizable properties of graphs and graph components such as labels and weights.</li>
<li>An I/O utility that allows to export graphs to well-known file formats.</li>
</ul>
<subsection name="Status">
<ul>
<li>This code is in the commons <i>sandbox</i></li>
<li>The code is unreleased</li>
<li>Methods and classes can and will appear and disappear without warning</li>
<li>If you like the code and want to push it towards a release, join the <a href="./mail-lists.html">mailing list</a>!</li>
</ul>
</subsection>
</section>
<section name="Releases">
<p>None. This is a <i>sandbox</i> component.</p>
</section>
</body>
</document>