1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/* 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 <stdio.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.
* @param directed graph or not.
*
* @return a pointer to the Eina_Graph.
*/
EAPI Eina_Graph *
eina_graph_new(unsigned int v, unsigned int step, Eina_Bool directed);
/**
* free the given graph.
*
* @param g the graph to free.
*/
EAPI void
eina_graph_free(Eina_Graph *g);
/**
* returns true if it is a directed graph.
*
* @param g the graph to consider.
*
* @retur true if this is a directed graph.
*/
EAPI Eina_Bool
eina_graph_directed(const 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);
/**
* generate dot file from the graph.
*
* @param g the graph to add to edje to.
* @param f the output stream to write to.
*/
EAPI void
eina_graph_dot_write(Eina_Graph *g, FILE *f);
#endif /* _EINA_GRAPH_H */
|
