add Eina_Graph_BFS

1 files changed, 107 insertions, 0 deletions

diff --git a/src/lib/eina_graph_bfs.h b/src/lib/eina_graph_bfs.h
new file mode 100644
index 0000000..c35f13f
--- /dev/null
+++ b/src/lib/eina_graph_bfs.h
@@ -0,0 +1,107 @@
+/* EINA_GRAPH - EFL graph processing library
+ * Copyright (C) 2013 Jérémy Zurcher
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies of the Software and its Copyright notices. In addition publicly
+ * documented acknowledgment must be given that this software has been used if no
+ * source code of this software is made available publicly. This includes
+ * acknowledgments in either Copyright notices, Manuals, Publicity and Marketing
+ * documents or any documentation provided with any product containing this
+ * software. This License does not apply to any software that links to the
+ * libraries provided by this software (statically or dynamically), but only to
+ * the software provided.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef _EINA_GRAPH_BFS_H
+#define _EINA_GRAPH_BFS_H
+
+#include <eina_list.h>
+#include <eina_graph.h>
+
+/**
+ * @typedef Eina_Graph_BFS
+ * The basic Eina_Graph BFS type.
+ */
+typedef struct _Eina_Graph_BFS_Opaque Eina_Graph_BFS;
+
+/**
+ * returns a Breadth First Search of the given graph.
+ *
+ * @param g the graph to build the BFS from.
+ * @param s the source vertex of the BFS.
+ *
+ * @return a new Breadth First Search.
+ */
+EAPI Eina_Graph_BFS *
+eina_graph_bfs_new(Eina_Graph *g, unsigned int s);
+
+/**
+ * free the given graph BFS.
+ *
+ * @param bfs the graph BFS to free.
+ */
+EAPI void
+eina_graph_bfs_free(Eina_Graph_BFS *bfs);
+
+/**
+ * get the source vertex of the graph BFS.
+ *
+ * @param bfs the graph BFS to consider.
+ *
+ * @return the source vertex of the BFS.
+ */
+EAPI unsigned int
+eina_graph_bfs_source(Eina_Graph_BFS *bfs);
+
+/**
+ * is there a path from the source to the given vertex.
+ *
+ * @param bfs the graph BFS to consider.
+ * @param v the vertex to test if there is a path to.
+ *
+ * @return EINA_TRUE if the vertex is reachable from the source.
+ */
+EAPI Eina_Bool
+eina_graph_bfs_has_path_to(Eina_Graph_BFS *bfs, unsigned int v);
+
+/*
+ * return the path to reach the given vertex from the source.
+ *
+ * the Eina_list returned must be freed by the user code.
+ *
+ * @param bfs the graph BFS to consider.
+ * @param v the vertex to test if there is a path to.
+ *
+ * @return a list of vertices to follwo from source to reach v,
+ * NULL if v is not reachable.
+ */
+EAPI Eina_List *
+eina_graph_bfs_path_to(Eina_Graph_BFS *bfs, unsigned int v);
+
+/*
+ * return the distance from the source to the given vertex.
+ *
+ * @param bfs the graph BFS to consider.
+ * @param v the vertex to return the distance to.
+ *
+ * @return the distance from the source to the vertex.
+ * UINT_MAX in not reachable.
+ */
+EAPI unsigned int
+eina_graph_bfs_dist_to(Eina_Graph_BFS *bfs, unsigned int v);
+
+#endif   /* _EINA_GRAPH_BFS_H */