File: E.Rd

package info (click to toggle)
r-cran-igraph 1.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 14,984 kB
  • sloc: ansic: 117,319; cpp: 22,287; fortran: 4,551; yacc: 1,150; tcl: 931; lex: 478; makefile: 149; sh: 9
file content (82 lines) | stat: -rw-r--r-- 2,620 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/iterators.R
\name{E}
\alias{E}
\title{Edges of a graph}
\usage{
E(graph, P = NULL, path = NULL, directed = TRUE)
}
\arguments{
\item{graph}{The graph.}

\item{P}{A list of vertices to select edges via pairs of vertices.
The first and second vertices select the first edge, the third
and fourth the second, etc.}

\item{path}{A list of vertices, to select edges along a path.
Note that this only works reliable for simple graphs. If the graph
has multiple edges, one of them will be chosen arbitrarily to
be included in the edge sequence.}

\item{directed}{Whether to consider edge directions in the \code{P}
argument, for directed graphs.}
}
\value{
An edge sequence of the graph.
}
\description{
An edge sequence is a vector containing numeric edge ids, with a special
class attribute that allows custom operations: selecting subsets of
edges based on attributes, or graph structure, creating the
intersection, union of edges, etc.
}
\details{
Edge sequences are usually used as igraph function arguments that 
refer to edges of a graph.

An edge sequence is tied to the graph it refers to: it really denoted
the specific edges of that graph, and cannot be used together with
another graph.

An edge sequence is most often created by the \code{E()} function. The
result includes edges in increasing edge id order by default (if. none
of the \code{P} and \code{path} arguments are used). An edge
sequence can be indexed by a numeric vector, just like a regular R
vector. See links to other edge sequence operations below.
}
\section{Indexing edge sequences}{

Edge sequences mostly behave like regular vectors, but there are some
additional indexing operations that are specific for them;
e.g. selecting edges based on graph structure, or based on edge
attributes. See \code{\link{[.igraph.es}} for details.
}

\section{Querying or setting attributes}{

Edge sequences can be used to query or set attributes for the
edges in the sequence. See \code{\link{$.igraph.es}} for details.
}

\examples{
# Edges of an unnamed graph
g <- make_ring(10)
E(g)

# Edges of a named graph
g2 <- make_ring(10) \%>\%
  set_vertex_attr("name", value = letters[1:10])
E(g2)
}
\seealso{
Other vertex and edge sequences: \code{\link{V}},
  \code{\link{igraph-es-attributes}},
  \code{\link{igraph-es-indexing2}},
  \code{\link{igraph-es-indexing}},
  \code{\link{igraph-vs-attributes}},
  \code{\link{igraph-vs-indexing2}},
  \code{\link{igraph-vs-indexing}},
  \code{\link{print.igraph.es}},
  \code{\link{print.igraph.vs}}
}
\concept{vertex and edge sequences}