[
https://issues.apache.org/jira/browse/FLINK-5311?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15741441#comment-15741441
]
ASF GitHub Bot commented on FLINK-5311:
---------------------------------------
Github user vasia commented on a diff in the pull request:
https://github.com/apache/flink/pull/2984#discussion_r91908218
--- Diff: docs/dev/libs/gelly/bipartite_graph.md ---
@@ -0,0 +1,148 @@
+---
+title: Graph Generators
+nav-parent_id: graphs
+nav-pos: 6
+---
+<!--
+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.
+-->
+
+* This will be replaced by the TOC
+{:toc}
+
+Bipartite Graph
+---------------
+
+A bipartite graph (also called a two-mode graph) is a type of graph where
vertices are separated into two disjoint sets. These sets are usually called
top and bottom vertices. A single edge in this graph can only connect vertices
from opposite sets (i.e. bottom vertex to top vertex) and cannot connect to
vertices in the same set.
+
+Theses graphs have wide application in practice and can be a more natural
choice for particular domains. For example to represent authorship of
scientific papers top vertices can represent scientific papers while bottom
nodes will represent authors. Naturally a node between a top and a bottom nodes
would represent an authorship of a particular scientific paper. Another common
example for applications of bipartite graphs is a relationships between actors
and movies. In this case an edge represents that a particular actor played in a
movie.
+
+Bipartite graph are used instead of regular graphs (one-mode) for the
following practical
[reasons](http://www.complexnetworks.fr/wp-content/uploads/2011/01/socnet07.pdf):
+ * They preserve more information about a connection between vertices. For
example instead of a single link between two researchers in a graph that
represents that they authored a paper together a bipartite graph preserve the
information about what papers they authored
+ * Bipartite graph can encode the same information more compactly than
one-mode graphs
+
+
+
+Graph Representation
+--------------------
+
+A `BipartiteGraph` is represented by:
+ * `DataSet` of top nodes
+ * `DataSet` of bottom nodes
+ * `DataSet` of edges between top and bottom nodes
+
+As in the `Graph` class nodes are represented by the `Vertex` type and the
same rules applies to its types and values.
--- End diff --
*apply
> Write user documentation for BipartiteGraph
> -------------------------------------------
>
> Key: FLINK-5311
> URL: https://issues.apache.org/jira/browse/FLINK-5311
> Project: Flink
> Issue Type: Bug
> Components: Gelly
> Reporter: Ivan Mushketyk
> Assignee: Ivan Mushketyk
>
> We need to add user documentation. The progress on BipartiteGraph can be
> tracked in the following JIRA:
> https://issues.apache.org/jira/browse/FLINK-2254
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
