File: which_mutual.Rd

package info (click to toggle)
r-cran-igraph 1.0.1-1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 18,232 kB
  • sloc: ansic: 173,538; cpp: 19,365; fortran: 4,550; yacc: 1,164; tcl: 931; lex: 484; makefile: 149; sh: 9
file content (47 lines) | stat: -rw-r--r-- 1,252 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/structural.properties.R
\name{which_mutual}
\alias{is.mutual}
\alias{which_mutual}
\title{Find mutual edges in a directed graph}
\usage{
which_mutual(graph, es = E(graph))
}
\arguments{
\item{graph}{The input graph.}

\item{es}{Edge sequence, the edges that will be probed. By default is
includes all edges in the order of their ids.}
}
\value{
A logical vector of the same length as the number of edges supplied.
}
\description{
This function checks the reciproc pair of the supplied edges.
}
\details{
In a directed graph an (A,B) edge is mutual if the graph also includes a
(B,A) directed edge.

Note that multi-graphs are not handled properly, i.e. if the graph contains
two copies of (A,B) and one copy of (B,A), then these three edges are
considered to be mutual.

Undirected graphs contain only mutual edges by definition.
}
\examples{
g <- sample_gnm(10, 50, directed=TRUE)
reciprocity(g)
dyad_census(g)
which_mutual(g)
sum(which_mutual(g))/2 == dyad_census(g)$mut
}
\author{
Gabor Csardi \email{csardi.gabor@gmail.com}
}
\seealso{
\code{\link{reciprocity}}, \code{\link{dyad_census}} if you just
want some statistics about mutual edges.
}
\keyword{graphs}