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
|
\name{Hyperedge-class}
\docType{class}
\alias{Hyperedge-class}
\alias{initialize,Hyperedge-method}
\alias{label}
\alias{label,Hyperedge-method}
\alias{label<-}
\alias{label<-,Hyperedge,character-method}
\alias{nodes,Hyperedge-method}
\alias{show,Hyperedge-method}
\title{Class Hyperedge}
\description{A Hyperedge object represents a hyperedge in a hypergraph,
that is, a subset of the nodes of a hypergraph.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("Hyperedge",
nodes, label)}.
You can also use the convenience function \code{Hyperedge} to create
instances. This is especially useful for creating a list of
\code{Hyperedge} instances using \code{\link{lapply}}.
}
\section{Slots}{
\describe{
\item{\code{head}:}{A vector of mode \code{"character"} containing
the node labels that are a part of the hyperedge}
\item{\code{label}:}{An arbitrary \code{"character"} string
describing this hyperedge }
}
}
\section{Methods}{
\describe{
\item{initialize}{\code{signature(.Object = "Hyperedge")}: Create an
instance}
\item{label}{\code{signature(object = "Hyperedge")}: Return the
value of the \code{label} slot }
\item{label<-}{\code{signature(object = "Hyperedge", value =
"character")}: Set the label slot.}
\item{nodes}{\code{signature(object = "Hyperedge")}: Return a
vector containing the nodes in the hyperedge }
\item{show}{\code{signature(object = "Hyperedge")}: Print a textual
summary of the hyperedge }
}
}
\author{Seth Falcon}
\seealso{
\code{\link{Hyperedge}}
\code{\link{Hypergraph-class}}
\code{\link{DirectedHyperedge-class}}
}
\examples{
nodes <- LETTERS[1:4]
label <- "Simple hyperedge"
## Use the convenience constructor
he <- Hyperedge(nodes, label)
}
\keyword{classes}
|
