File: make_ring.Rd

package info (click to toggle)
r-cran-igraph 2.1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 27,044 kB
  • sloc: ansic: 204,981; cpp: 21,711; fortran: 4,090; yacc: 1,229; lex: 519; sh: 52; makefile: 8
file content (52 lines) | stat: -rw-r--r-- 1,351 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/make.R
\name{make_ring}
\alias{make_ring}
\alias{ring}
\title{Create a ring graph}
\usage{
make_ring(n, directed = FALSE, mutual = FALSE, circular = TRUE)

ring(...)
}
\arguments{
\item{n}{Number of vertices.}

\item{directed}{Whether the graph is directed.}

\item{mutual}{Whether directed edges are mutual. It is ignored in
undirected graphs.}

\item{circular}{Whether to create a circular ring. A non-circular
ring is essentially a \dQuote{line}: a tree where every non-leaf
vertex has one child.}

\item{...}{Passed to \code{make_ring()}.}
}
\value{
An igraph graph.
}
\description{
A ring is a one-dimensional lattice and this function is a special case
of \code{\link[=make_lattice]{make_lattice()}}.
}
\examples{
print_all(make_ring(10))
print_all(make_ring(10, directed = TRUE, mutual = TRUE))
}
\seealso{
Other deterministic constructors: 
\code{\link{graph_from_atlas}()},
\code{\link{graph_from_edgelist}()},
\code{\link{graph_from_literal}()},
\code{\link{make_}()},
\code{\link{make_chordal_ring}()},
\code{\link{make_empty_graph}()},
\code{\link{make_full_citation_graph}()},
\code{\link{make_full_graph}()},
\code{\link{make_graph}()},
\code{\link{make_lattice}()},
\code{\link{make_star}()},
\code{\link{make_tree}()}
}
\concept{deterministic constructors}