example_hype: Generate an Example Hypergraph

In hwarden162/hyper: Work with Hypergraphs in R

Generate an Example Hypergraph

Description

Quickly generate an example hypergraph. Can be used for quickly testing and trialing examples.

Usage

example_hype(
  oriented = FALSE,
  directed = FALSE,
  vertex_weighted = FALSE,
  edge_weighted = FALSE,
  real_coef = FALSE
)

Arguments

oriented	Logical value representing whether the example hypergraph should be oriented
directed	Logical value representing whether the example hypergraph should be directed
vertex_weighted	Logical value representing whether the example hypergraph should have vertex weights
edge_weighted	Logical value representing whether the example hypergraph should have hyperedge weights
real_coef	Logical value representing whether the example hypergraph should have real coefficients relating vertices to hyperedges

Value

An example hypergraph with the given properties

Examples

h1 <- example_hype()
h2 <- example_hype(oriented = TRUE)
h3 <- example_hype(oriented = TRUE, directed = TRUE)
h4 <- example_hype(oriented = TRUE, directed = TRUE, real_coef = TRUE)

hwarden162/hyper documentation built on Sept. 15, 2022, 5:21 a.m.