diff options
Diffstat (limited to 'src/lib/eina_graph.h')
-rw-r--r-- | src/lib/eina_graph.h | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/src/lib/eina_graph.h b/src/lib/eina_graph.h new file mode 100644 index 0000000..c748ede --- /dev/null +++ b/src/lib/eina_graph.h @@ -0,0 +1,133 @@ +/* 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_H +#define _EINA_GRAPH_H + +#include <eina_types.h> + +/** + * @typedef Eina_Graph + * The basic Eina_Graph type. + */ +typedef struct _Eina_Graph_Opaque Eina_Graph; + +/** + * returns a graph with v vertices. + * + * This function returns an unweighted undirected graph + * with self loops and parallel edges allowed. + * + * @param v the number of vertices. + * @param step grow step for the adjacent lists. + * + * @return a pointer to the Eina_Graph. + */ +EAPI Eina_Graph * +eina_graph_new(unsigned int v, unsigned int step); + +/** + * free the given graph. + * + * @param g the graph to free. + */ +EAPI void +eina_graph_free(Eina_Graph *g); + +/** + * returns the number of vertices of the graph. + * + * @param g the graph to consider. + * + * @return the number of vertices of the graph. + */ +EAPI unsigned int +eina_graph_vertices_count(const Eina_Graph *g); + +/** + * returns the number of edges of the graph. + * + * @param g the graph to consider. + * + * @return the number of edges of the graph. + */ +EAPI unsigned int +eina_graph_edges_count(const Eina_Graph *g); + +/** + * returns the degree of vertex v. + * + * @param g the graph to consider. + * @param v the vertex to get the degree of. + * + * @return the degree of vertex v + */ +EAPI unsigned int +eina_graph_degree(const Eina_Graph *g, unsigned int v); + +/** + * returns the max degree of the graph. + * + * @param g the graph to consider. + * + * @return the max degree of the graph. + */ +EAPI unsigned int +eina_graph_degree_max(const Eina_Graph *g); + +/** + * returns the average degree of the graph. + * + * @param g the graph to consider. + * + * @return the average degree of the graph. + */ +EAPI float +eina_graph_degree_avg(const Eina_Graph *g); + +/** + * returns the number of self loops in the graph. + * + * @param g the graph to consider. + * + * @return the number of self loops in the graph. + */ +EAPI unsigned int +eina_graph_self_loops(const Eina_Graph *g); + +/** + * add an edge to the graph. + * + * @param g the graph to add to edje to. + * @param v a vertex of the edge. + * @param w another vertex of the edge. + */ +EAPI Eina_Bool +eina_graph_edge_add(Eina_Graph *g, unsigned int v, unsigned int w); + +#endif /* _EINA_GRAPH_H */ |