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
|
\name{Hypergraph-class}
\docType{class}
\alias{Hypergraph-class}
\alias{hyperedges,Hypergraph-method}
\alias{inciMat}
\alias{inciMat,Hypergraph-method}
\alias{inciMat2HG}
\alias{inciMat2HG,matrix-method}
\alias{initialize,Hypergraph-method}
\alias{nodes,Hypergraph-method}
\alias{numNodes,Hypergraph-method}
\alias{toGraphNEL}
\alias{toGraphNEL,Hypergraph-method}
\alias{hyperedges}
\alias{hyperedges,Hypergraph-method}
\alias{hyperedgeLabels}
\alias{hyperedgeLabels,Hypergraph-method}
\title{Class Hypergraph}
\description{A hypergraph consists of a set of nodes and a set of
hyperedges. Each hyperedge is a subset of the node set. This class
provides a representation of a hypergraph that is (hopefully) useful
for computing.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("Hypergraph", nodes, hyperedges)}.
You can also use the convenience function \code{Hypergraph}. The
\code{nodes} argument should be a character vector of distinct labels
representing the nodes of the hypergraph. The \code{hyperedges}
argument must be a list of \code{\link{Hyperedge-class}} objects.
}
\section{Slots}{
\describe{
\item{\code{nodes}:}{A \code{"character"} vector specifying the nodes}
\item{\code{hyperedges}:}{A \code{"list"} of
\code{\link{Hyperedge-class}} objects}
}
}
\section{Methods}{
\describe{
\item{hyperedges}{\code{signature(.Object = "Hypergraph")}: Return
the list of \code{Hyperedge} objects }
\item{hyperedgeLabels}{\code{signature(.Object = "Hypergraph")}: Return
a character vector of labels for the \code{Hyperedge} objects in the
hypergraph.}
\item{inciMat}{\code{signature(.Object = "Hypergraph")}: Return the
incidence matrix representation of this hypergraph }
\item{inciMat2HG}{\code{signature(.Object = "matrix")}: Return the
hypergraph representation of this incidence matrix }
\item{initialize}{\code{signature(.Object = "Hypergraph")}: Create
an instance}
\item{nodes}{\code{signature(object = "Hypergraph")}: Return the
vector of nodes (character vector) }
\item{numNodes}{\code{signature(object = "Hypergraph")}: Return the
number of nodes in the hypergraph }
\item{toGraphNEL}{\code{signature(.Object = "Hypergraph")}: Return
the \code{graphNEL} representation of the hypergraph (a bipartite
graph) }
}
}
\author{Seth Falcon}
\seealso{
\code{\link{Hyperedge-class}}
\code{\link{DirectedHyperedge-class}}
\code{\link[graph]{graphNEL-class}}
}
\examples{
nodes <- LETTERS[1:4]
hEdges <- lapply(list("A", LETTERS[1:2], LETTERS[3:4]), "Hyperedge")
hg <- new("Hypergraph", nodes=nodes, hyperedges=hEdges)
}
\keyword{classes}
|
