make_lattice: Create a lattice graph

In igraph: Network Analysis and Visualization

Create a lattice graph

Description

make_lattice() is a flexible function, it can create lattices of arbitrary dimensions, periodic or aperiodic ones. It has two forms. In the first form you only supply dimvector, but not length and dim. In the second form you omit dimvector and supply length and dim.

Usage

make_lattice(
  dimvector = NULL,
  length = NULL,
  dim = NULL,
  nei = 1,
  directed = FALSE,
  mutual = FALSE,
  periodic = FALSE,
  circular = deprecated()
)

lattice(...)

Arguments

dimvector	A vector giving the size of the lattice in each dimension.
length	Integer constant, for regular lattices, the size of the lattice in each dimension.
dim	Integer constant, the dimension of the lattice.
nei	The distance within which (inclusive) the neighbors on the lattice will be connected. This parameter is not used right now.
directed	Whether to create a directed lattice.
mutual	Logical, if TRUE directed lattices will be mutually connected.
periodic	Logical vector, Boolean vector, defines whether the generated lattice is periodic along each dimension. This parameter may also be scalar boolen value which will be extended to boolean vector with dimvector length.
circular	Deprecated, use periodic instead.
...	Passed to make_lattice().

Value

An igraph graph.

Related documentation in the C library

igraph_square_lattice().

See Also

Other deterministic constructors: graph_from_atlas(), graph_from_edgelist(), graph_from_literal(), make_(), make_chordal_ring(), make_empty_graph(), make_full_citation_graph(), make_full_graph(), make_graph(), make_ring(), make_star(), make_tree()

Examples

make_lattice(c(5, 5, 5))
make_lattice(length = 5, dim = 3)

igraph documentation built on Oct. 20, 2024, 1:06 a.m.