=== modified file 'include/igraph_iterators.h' --- include/igraph_iterators.h 2010-10-04 15:57:08 +0000 +++ include/igraph_iterators.h 2011-02-02 07:48:28 +0000 @@ -134,7 +134,7 @@ * 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 by the iterator (call this only if \ref IGRAPH_VIT_END() + * pointed to by the iterator (call this only if \ref IGRAPH_VIT_END() * is false). * * @@ -206,7 +206,7 @@ * \define IGRAPH_VIT_GET * \brief Query the current position. * - * Gives the vertex id of the current vertex poited to by the + * 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. @@ -348,7 +348,7 @@ * \ref IGRAPH_EIT_END() returns false. * \param eit The edge iterator to step. * - * Time complecity: O(1). + * Time complexity: O(1). */ #define IGRAPH_EIT_NEXT(eit) (++((eit).pos)) /** @@ -378,7 +378,7 @@ * \define IGRAPH_EIT_RESET * \brief Reset an edge iterator. * - * Resets an ege iterator. After calling this macro the iterator will + * Resets an edge iterator. After calling this macro the iterator will * point to the first edge. * \param eit The edge iterator. * === modified file 'src/iterators.c' --- src/iterators.c 2010-10-14 11:56:27 +0000 +++ src/iterators.c 2011-02-02 09:20:53 +0000 @@ -36,12 +36,12 @@ * Everything about vertices and vertex selectors also applies * to edges and edge selectors unless explicitly noted otherwise. * - * The vertex (and edge) selector notion was introduced in igraph 0.2, - * and it is a way to reference to sequence of vertices or edges + * The vertex (and edge) selector notion was introduced in igraph 0.2. + * It is a way to reference a sequence of vertices or edges * independently of the graph. * * While this might sound quite mysterious, it is actually very - * simple. For example all vertex of graph can be selected by + * simple. For example all vertices of a graph can be selected by * \ref igraph_vs_all(), and the graph independence means that * \ref igraph_vs_all() is not parametrized by a graph object. Ie. * \ref igraph_vs_all() is the \em concept of selecting all vertices @@ -143,10 +143,10 @@ /** * \function igraph_vs_nonadj - * \brief Non-adjacent vertices of a vertex + * \brief Non-adjacent vertices of a vertex. * * All non-neighboring vertices of a given vertex. The \p mode - * argument controls the type of neighboring vertics \em not to + * argument controls the type of neighboring vertices \em not to * select. * \param vs Pointer to an uninitialized vertex selector object. * \param vid Vertex id, the \quote center \endquote of the @@ -157,7 +157,7 @@ * which there is a directed edge from \p vid. * \c IGRAPH_IN, all vertices will be selected except those * from which there is a directed edge to \p vid. - * \c IGRAPH_ALL, all vertices will be selected exvept those + * \c IGRAPH_ALL, all vertices will be selected except those * from or to which there is a directed edge to or from \p * vid. * \return Error code. @@ -231,7 +231,7 @@ /** * \function igraph_vss_1 - * \brief Vertex set with a single vertex (immediate version) + * \brief Vertex set with a single vertex (immediate version). * * The immediate version of the single-vertex selector. * @@ -303,7 +303,7 @@ * * This function can be used to create a vertex selector with a couple * of vertices. Do not forget to include a -1 after the - * last vertex id, the behavior of the function is undefined if you + * last vertex id. The behavior of the function is undefined if you * don't use a -1 properly. * * @@ -446,7 +446,7 @@ * * \param vs Pointer to a vertex selector object. * - * Time complecity: operating system dependent, usually O(1). + * Time complexity: operating system dependent, usually O(1). */ void igraph_vs_destroy(igraph_vs_t *vs) { @@ -473,14 +473,14 @@ * \brief Check whether all vertices are included. * * This function checks whether the vertex selector object was created - * by \ref igraph_vs_all() of \ref igraph_vss_all(). Note that the + * by \ref igraph_vs_all() or \ref igraph_vss_all(). Note that the * vertex selector might contain all vertices in a given graph but if * it wasn't created by the two constructors mentioned here the return * value will be FALSE. * * \param vs Pointer to a vertex selector object. * \return TRUE (1) if the vertex selector contains all vertices and - * FALSE (1) otherwise. + * FALSE (0) otherwise. * * Time complexity: O(1). */ @@ -504,9 +504,9 @@ /** * \function igraph_vs_copy - * \brief Creates a copy of a vertex iterator - * \param src the iterator being copied - * \param dest an uninitialized iterator that will contain the copy + * \brief Creates a copy of a vertex iterator. + * \param src The iterator being copied. + * \param dest An uninitialized iterator that will contain the copy. */ int igraph_vs_copy(igraph_vs_t* dest, const igraph_vs_t* src) { memcpy(dest, src, sizeof(igraph_vs_t)); @@ -524,19 +524,19 @@ /** * \function igraph_vs_type - * \brief Returns the type of the vertex selector + * \brief Returns the type of the vertex selector. */ int igraph_vs_type(const igraph_vs_t *vs) { return vs->type; } /** * \function igraph_vs_size - * \brief Returns the size of the vertex selector + * \brief Returns the size of the vertex selector. * * The size of the vertex selector is the number of vertices it will * yield when it is iterated over. * - * \param graph the graph over which we will iterate - * \param result the result will be returned here + * \param graph The graph over which we will iterate. + * \param result The result will be returned here. */ int igraph_vs_size(const igraph_t *graph, const igraph_vs_t *vs, igraph_integer_t *result) { @@ -878,9 +878,9 @@ * selected. * \param mode Constant giving the type of the incident edges to * select. This is ignored for undirected graphs. Possible values: - * \c IGRAPH_OUT, outgoing edges - * \c IGRAPH_IN, incoming edges - * \c IGRAPH_ALL, all edges + * \c IGRAPH_OUT, outgoing edges; + * \c IGRAPH_IN, incoming edges; + * \c IGRAPH_ALL, all edges. * \return Error code. * * Time complexity: O(1). @@ -1114,7 +1114,7 @@ /** * \function igraph_es_pairs - * \brief Edge selector, multiple edges defined by their endpoints in a vector + * \brief Edge selector, multiple edges defined by their endpoints in a vector. * * The edges between the given pairs of vertices will be included in the * edge selection. The vertex pairs must be defined in the vector v, @@ -1150,7 +1150,7 @@ /** * \function igraph_es_pairs_small - * \brief Edge selector, multiple edges defined by their endpoints as arguments + * \brief Edge selector, multiple edges defined by their endpoints as arguments. * * The edges between the given pairs of vertices will be included in the * edge selection. The vertex pairs must be given as the arguments of the @@ -1206,7 +1206,7 @@ es->data.path.mode=directed; es->data.path.ptr=igraph_Calloc(1, igraph_vector_t); if (es->data.path.ptr==0) { - IGRAPH_ERROR("Cannor create edge selector", IGRAPH_ENOMEM); + IGRAPH_ERROR("Cannot create edge selector", IGRAPH_ENOMEM); } IGRAPH_FINALLY(igraph_free, (igraph_vector_t*) es->data.path.ptr); @@ -1322,9 +1322,9 @@ /** * \function igraph_es_copy - * \brief Creates a copy of an edge iterator - * \param src the iterator being copied - * \param dest an uninitialized iterator that will contain the copy + * \brief Creates a copy of an edge iterator. + * \param src The iterator being copied. + * \param dest An uninitialized iterator that will contain the copy. */ int igraph_es_copy(igraph_es_t* dest, const igraph_es_t* src) { memcpy(dest, src, sizeof(igraph_es_t)); @@ -1363,7 +1363,7 @@ /** * \function igraph_es_type - * \brief Returns the type of the edge selector + * \brief Returns the type of the edge selector. */ int igraph_es_type(const igraph_es_t *es) { return es->type; } @@ -1376,13 +1376,13 @@ /** * \function igraph_es_size - * \brief Returns the size of the edge selector + * \brief Returns the size of the edge selector. * * The size of the edge selector is the number of vertices it will * yield when it is iterated over. * - * \param graph the graph over which we will iterate - * \param result the result will be returned here + * \param graph The graph over which we will iterate. + * \param result The result will be returned here. */ int igraph_es_size(const igraph_t *graph, const igraph_es_t *es, igraph_integer_t *result) { @@ -1782,7 +1782,7 @@ /** * \function igraph_eit_destroy - * \brief Destroys an edge iterator + * \brief Destroys an edge iterator. * * \param eit Pointer to an edge iterator to destroy. * \sa \ref igraph_eit_create() === modified file 'src/structure_generators.c' --- src/structure_generators.c 2011-02-01 00:36:03 +0000 +++ src/structure_generators.c 2011-02-02 10:17:02 +0000 @@ -766,6 +766,9 @@ * \function igraph_ring * \brief Creates a \em ring graph, a one dimensional lattice. * + * An undirected (circular) ring on n vertices is commonly known in graph + * theory as the cycle graph C_n. + * * \param graph Pointer to an uninitialized graph object. * \param n The number of vertices in the ring. * \param directed Logical, whether to create a directed ring. === modified file 'src/type_indexededgelist.c' --- src/type_indexededgelist.c 2011-01-30 15:42:27 +0000 +++ src/type_indexededgelist.c 2011-02-02 05:04:12 +0000 @@ -686,9 +686,9 @@ * be initialized beforehand and will be resized. Starting from igraph * version 0.4 this vector is always sorted, the vertex ids are * in increasing order. - * \param pnode The id of the node of which the adjacent vertices are - * searched. - * \param mode Defines the way adjacent vertices are searched for + * \param pnode The id of the node for which the adjacent vertices are + * to be searched. + * \param mode Defines the way adjacent vertices are searched in * directed graphs. It can have the following values: * \c IGRAPH_OUT, vertices reachable by an * edge from the specified vertex are searched;