Add graph references
This commit is contained in:
Abdelrahman Said
@@ -0,0 +1,416 @@
|
||||
/*
|
||||
igraph library.
|
||||
Copyright (C) 2009-2025 The igraph development team <igraph@igraph.org>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef IGRAPH_ITERATORS_H
|
||||
#define IGRAPH_ITERATORS_H
|
||||
|
||||
#include "igraph_datatype.h"
|
||||
#include "igraph_decls.h"
|
||||
#include "igraph_constants.h"
|
||||
#include "igraph_error.h"
|
||||
#include "igraph_types.h"
|
||||
#include "igraph_vector.h"
|
||||
|
||||
IGRAPH_BEGIN_C_DECLS
|
||||
|
||||
/* -------------------------------------------------- */
|
||||
/* Vertex selectors */
|
||||
/* -------------------------------------------------- */
|
||||
|
||||
typedef enum {
|
||||
IGRAPH_VS_ALL,
|
||||
IGRAPH_VS_ADJ,
|
||||
IGRAPH_VS_NONE,
|
||||
IGRAPH_VS_1,
|
||||
IGRAPH_VS_VECTORPTR,
|
||||
IGRAPH_VS_VECTOR,
|
||||
IGRAPH_VS_RANGE,
|
||||
IGRAPH_VS_NONADJ,
|
||||
} igraph_vs_type_t;
|
||||
|
||||
typedef struct igraph_vs_t {
|
||||
igraph_vs_type_t type;
|
||||
union {
|
||||
igraph_int_t vid; /* single vertex */
|
||||
const igraph_vector_int_t *vecptr; /* vector of vertices */
|
||||
struct {
|
||||
igraph_int_t vid;
|
||||
igraph_neimode_t mode;
|
||||
igraph_loops_t loops;
|
||||
igraph_bool_t multiple;
|
||||
} adj; /* adjacent vertices */
|
||||
struct {
|
||||
igraph_int_t start; /* first index (inclusive) */
|
||||
igraph_int_t end; /* last index (exclusive) */
|
||||
} range; /* range of vertices */
|
||||
} data;
|
||||
} igraph_vs_t;
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_all(igraph_vs_t *vs);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_vs_t igraph_vss_all(void);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_adj(
|
||||
igraph_vs_t *vs, igraph_int_t vid, igraph_neimode_t mode,
|
||||
igraph_loops_t loops, igraph_bool_t multiple
|
||||
);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_nonadj(igraph_vs_t *vs, igraph_int_t vid,
|
||||
igraph_neimode_t mode);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_none(igraph_vs_t *vs);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_vs_t igraph_vss_none(void);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_1(igraph_vs_t *vs, igraph_int_t vid);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_vs_t igraph_vss_1(igraph_int_t vid);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_vector(igraph_vs_t *vs,
|
||||
const igraph_vector_int_t *v);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_PURE igraph_vs_t igraph_vss_vector(const igraph_vector_int_t *v);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_vector_small(igraph_vs_t *vs, ...);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_vector_copy(igraph_vs_t *vs,
|
||||
const igraph_vector_int_t *v);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_range(igraph_vs_t *vs, igraph_int_t start, igraph_int_t end);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_vs_t igraph_vss_range(igraph_int_t start, igraph_int_t end);
|
||||
|
||||
IGRAPH_EXPORT void igraph_vs_destroy(igraph_vs_t *vs);
|
||||
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_PURE igraph_bool_t igraph_vs_is_all(const igraph_vs_t *vs);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_copy(igraph_vs_t* dest, const igraph_vs_t* src);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_as_vector(const igraph_t *graph, igraph_vs_t vs,
|
||||
igraph_vector_int_t *v);
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vs_size(const igraph_t *graph, const igraph_vs_t *vs,
|
||||
igraph_int_t *result);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_PURE igraph_vs_type_t igraph_vs_type(const igraph_vs_t *vs);
|
||||
|
||||
/* -------------------------------------------------- */
|
||||
/* Vertex iterators */
|
||||
/* -------------------------------------------------- */
|
||||
|
||||
typedef enum {
|
||||
IGRAPH_VIT_RANGE,
|
||||
IGRAPH_VIT_VECTOR,
|
||||
IGRAPH_VIT_VECTORPTR,
|
||||
} igraph_vit_type_t;
|
||||
|
||||
typedef struct igraph_vit_t {
|
||||
igraph_vit_type_t type;
|
||||
igraph_int_t pos;
|
||||
igraph_int_t start; /* first index */
|
||||
igraph_int_t end; /* one past last index */
|
||||
const igraph_vector_int_t *vec;
|
||||
} igraph_vit_t;
|
||||
|
||||
/**
|
||||
* \section IGRAPH_VIT Stepping over the vertices
|
||||
*
|
||||
* <para>After creating an iterator with \ref igraph_vit_create(), it
|
||||
* points to the first vertex in the vertex determined by the vertex
|
||||
* selector (if there is any). The \ref IGRAPH_VIT_NEXT() macro steps
|
||||
* to the next vertex, \ref IGRAPH_VIT_END() checks whether there are
|
||||
* more vertices to visit, \ref IGRAPH_VIT_SIZE() gives the total size
|
||||
* of the vertices visited so far and to be visited. \ref
|
||||
* IGRAPH_VIT_RESET() resets the iterator, it will point to the first
|
||||
* vertex again. Finally \ref IGRAPH_VIT_GET() gives the current vertex
|
||||
* pointed to by the iterator (call this only if \ref IGRAPH_VIT_END()
|
||||
* is false).
|
||||
* </para>
|
||||
* <para>
|
||||
* Here is an example on how to step over the neighbors of vertex 0:
|
||||
* <informalexample><programlisting>
|
||||
* igraph_vs_t vs;
|
||||
* igraph_vit_t vit;
|
||||
* ...
|
||||
* igraph_vs_adj(&vs, 0, IGRAPH_ALL);
|
||||
* igraph_vit_create(&graph, vs, &vit);
|
||||
* while (!IGRAPH_VIT_END(vit)) {
|
||||
* printf(" %" IGRAPH_PRId, IGRAPH_VIT_GET(vit));
|
||||
* IGRAPH_VIT_NEXT(vit);
|
||||
* }
|
||||
* printf("\n");
|
||||
* ...
|
||||
* igraph_vit_destroy(&vit);
|
||||
* igraph_vs_destroy(&vs);
|
||||
* </programlisting></informalexample>
|
||||
* </para>
|
||||
*/
|
||||
|
||||
/**
|
||||
* \define IGRAPH_VIT_NEXT
|
||||
* \brief Next vertex.
|
||||
*
|
||||
* Steps the iterator to the next vertex. Only call this function if
|
||||
* \ref IGRAPH_VIT_END() returns false.
|
||||
* \param vit The vertex iterator to step.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_VIT_NEXT(vit) (++((vit).pos))
|
||||
/**
|
||||
* \define IGRAPH_VIT_END
|
||||
* \brief Are we at the end?
|
||||
*
|
||||
* Checks whether there are more vertices to step to.
|
||||
* \param vit The vertex iterator to check.
|
||||
* \return Logical value, if true there are no more vertices to step
|
||||
* to.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_VIT_END(vit) ((vit).pos >= (vit).end)
|
||||
/**
|
||||
* \define IGRAPH_VIT_SIZE
|
||||
* \brief Size of a vertex iterator.
|
||||
*
|
||||
* Gives the number of vertices in a vertex iterator.
|
||||
* \param vit The vertex iterator.
|
||||
* \return The number of vertices.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_VIT_SIZE(vit) ((vit).end - (vit).start)
|
||||
/**
|
||||
* \define IGRAPH_VIT_RESET
|
||||
* \brief Reset a vertex iterator.
|
||||
*
|
||||
* Resets a vertex iterator. After calling this macro the iterator
|
||||
* will point to the first vertex.
|
||||
* \param vit The vertex iterator.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_VIT_RESET(vit) ((vit).pos = (vit).start)
|
||||
/**
|
||||
* \define IGRAPH_VIT_GET
|
||||
* \brief Query the current position.
|
||||
*
|
||||
* Gives the vertex ID of the current vertex pointed to by the
|
||||
* iterator.
|
||||
* \param vit The vertex iterator.
|
||||
* \return The vertex ID of the current vertex.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_VIT_GET(vit) \
|
||||
((igraph_int_t)(((vit).type == IGRAPH_VIT_RANGE) ? (vit).pos : \
|
||||
VECTOR(*(vit).vec)[(vit).pos]))
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vit_create(const igraph_t *graph,
|
||||
igraph_vs_t vs, igraph_vit_t *vit);
|
||||
IGRAPH_EXPORT void igraph_vit_destroy(const igraph_vit_t *vit);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_vit_as_vector(const igraph_vit_t *vit, igraph_vector_int_t *v);
|
||||
|
||||
/* -------------------------------------------------- */
|
||||
/* Edge Selectors */
|
||||
/* -------------------------------------------------- */
|
||||
|
||||
typedef enum {
|
||||
IGRAPH_ES_ALL,
|
||||
IGRAPH_ES_ALLFROM,
|
||||
IGRAPH_ES_ALLTO,
|
||||
IGRAPH_ES_INCIDENT,
|
||||
IGRAPH_ES_NONE,
|
||||
IGRAPH_ES_1,
|
||||
IGRAPH_ES_VECTORPTR,
|
||||
IGRAPH_ES_VECTOR,
|
||||
IGRAPH_ES_RANGE,
|
||||
IGRAPH_ES_PAIRS,
|
||||
IGRAPH_ES_PATH,
|
||||
IGRAPH_ES_ALL_BETWEEN,
|
||||
} igraph_es_type_t;
|
||||
|
||||
typedef struct igraph_es_t {
|
||||
igraph_es_type_t type;
|
||||
union {
|
||||
igraph_int_t vid;
|
||||
igraph_int_t eid;
|
||||
const igraph_vector_int_t *vecptr;
|
||||
struct {
|
||||
igraph_int_t vid;
|
||||
igraph_neimode_t mode;
|
||||
igraph_loops_t loops;
|
||||
} incident;
|
||||
struct {
|
||||
igraph_int_t start; /* first index (inclusive) */
|
||||
igraph_int_t end; /* last index (exclusive) */
|
||||
} range;
|
||||
struct {
|
||||
const igraph_vector_int_t *ptr;
|
||||
igraph_bool_t mode;
|
||||
} path;
|
||||
struct {
|
||||
igraph_int_t from;
|
||||
igraph_int_t to;
|
||||
igraph_bool_t directed;
|
||||
} between;
|
||||
} data;
|
||||
} igraph_es_t;
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_all(igraph_es_t *es,
|
||||
igraph_edgeorder_type_t order);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_es_t igraph_ess_all(igraph_edgeorder_type_t order);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_incident(
|
||||
igraph_es_t *es, igraph_int_t vid, igraph_neimode_t mode,
|
||||
igraph_loops_t loops
|
||||
);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_none(igraph_es_t *es);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_es_t igraph_ess_none(void);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_1(igraph_es_t *es, igraph_int_t eid);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_es_t igraph_ess_1(igraph_int_t eid);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_vector(igraph_es_t *es,
|
||||
const igraph_vector_int_t *v);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_PURE igraph_es_t igraph_ess_vector(const igraph_vector_int_t *v);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_range(igraph_es_t *es, igraph_int_t from, igraph_int_t to);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_CONST igraph_es_t igraph_ess_range(igraph_int_t from, igraph_int_t to);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_vector_copy(igraph_es_t *es, const igraph_vector_int_t *v);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_pairs(igraph_es_t *es, const igraph_vector_int_t *v,
|
||||
igraph_bool_t directed);
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_pairs_small(igraph_es_t *es, igraph_bool_t directed, int first, ...);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_path(igraph_es_t *es, const igraph_vector_int_t *v,
|
||||
igraph_bool_t directed);
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_path_small(igraph_es_t *es, igraph_bool_t directed, int first, ...);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_all_between(
|
||||
igraph_es_t *es, igraph_int_t from, igraph_int_t to,
|
||||
igraph_bool_t directed
|
||||
);
|
||||
|
||||
IGRAPH_EXPORT void igraph_es_destroy(igraph_es_t *es);
|
||||
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_PURE igraph_bool_t igraph_es_is_all(const igraph_es_t *es);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_copy(igraph_es_t* dest, const igraph_es_t* src);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_as_vector(const igraph_t *graph, igraph_es_t es,
|
||||
igraph_vector_int_t *v);
|
||||
IGRAPH_EXPORT igraph_error_t igraph_es_size(const igraph_t *graph, const igraph_es_t *es,
|
||||
igraph_int_t *result);
|
||||
IGRAPH_EXPORT IGRAPH_FUNCATTR_PURE igraph_es_type_t igraph_es_type(const igraph_es_t *es);
|
||||
|
||||
|
||||
/* -------------------------------------------------- */
|
||||
/* Edge Iterators */
|
||||
/* -------------------------------------------------- */
|
||||
|
||||
typedef enum {
|
||||
IGRAPH_EIT_RANGE,
|
||||
IGRAPH_EIT_VECTOR,
|
||||
IGRAPH_EIT_VECTORPTR,
|
||||
} igraph_eit_type_t;
|
||||
|
||||
typedef struct igraph_eit_t {
|
||||
igraph_eit_type_t type;
|
||||
igraph_int_t pos;
|
||||
igraph_int_t start; /* first index */
|
||||
igraph_int_t end; /* one past last index */
|
||||
const igraph_vector_int_t *vec;
|
||||
} igraph_eit_t;
|
||||
|
||||
/**
|
||||
* \section IGRAPH_EIT Stepping over the edges
|
||||
*
|
||||
* <para>Just like for vertex iterators, macros are provided for
|
||||
* stepping over a sequence of edges: \ref IGRAPH_EIT_NEXT() goes to
|
||||
* the next edge, \ref IGRAPH_EIT_END() checks whether there are more
|
||||
* edges to visit, \ref IGRAPH_EIT_SIZE() gives the number of edges in
|
||||
* the edge sequence, \ref IGRAPH_EIT_RESET() resets the iterator to
|
||||
* the first edge and \ref IGRAPH_EIT_GET() returns the id of the
|
||||
* current edge.</para>
|
||||
*/
|
||||
|
||||
/**
|
||||
* \define IGRAPH_EIT_NEXT
|
||||
* \brief Next edge.
|
||||
*
|
||||
* Steps the iterator to the next edge. Call this function only if
|
||||
* \ref IGRAPH_EIT_END() returns false.
|
||||
* \param eit The edge iterator to step.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_EIT_NEXT(eit) (++((eit).pos))
|
||||
/**
|
||||
* \define IGRAPH_EIT_END
|
||||
* \brief Are we at the end?
|
||||
*
|
||||
* Checks whether there are more edges to step to.
|
||||
* \param wit The edge iterator to check.
|
||||
* \return Logical value, if true there are no more edges
|
||||
* to step to.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_EIT_END(eit) ((eit).pos >= (eit).end)
|
||||
/**
|
||||
* \define IGRAPH_EIT_SIZE
|
||||
* \brief Number of edges in the iterator.
|
||||
*
|
||||
* Gives the number of edges in an edge iterator.
|
||||
* \param eit The edge iterator.
|
||||
* \return The number of edges.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_EIT_SIZE(eit) ((eit).end - (eit).start)
|
||||
/**
|
||||
* \define IGRAPH_EIT_RESET
|
||||
* \brief Reset an edge iterator.
|
||||
*
|
||||
* Resets an edge iterator. After calling this macro the iterator will
|
||||
* point to the first edge.
|
||||
* \param eit The edge iterator.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_EIT_RESET(eit) ((eit).pos = (eit).start)
|
||||
/**
|
||||
* \define IGRAPH_EIT_GET
|
||||
* \brief Query an edge iterator.
|
||||
*
|
||||
* Gives the edge ID of the current edge pointed to by an iterator.
|
||||
* \param eit The edge iterator.
|
||||
* \return The id of the current edge.
|
||||
*
|
||||
* Time complexity: O(1).
|
||||
*/
|
||||
#define IGRAPH_EIT_GET(eit) \
|
||||
(igraph_int_t)((((eit).type == IGRAPH_EIT_RANGE) ? (eit).pos : \
|
||||
VECTOR(*(eit).vec)[(eit).pos]))
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_eit_create(const igraph_t *graph,
|
||||
igraph_es_t es, igraph_eit_t *eit);
|
||||
IGRAPH_EXPORT void igraph_eit_destroy(const igraph_eit_t *eit);
|
||||
|
||||
IGRAPH_EXPORT igraph_error_t igraph_eit_as_vector(const igraph_eit_t *eit, igraph_vector_int_t *v);
|
||||
|
||||
IGRAPH_END_C_DECLS
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user