get_girth: Get the graph girth

In DiagrammeR: Graph/Network Visualization

Get the graph girth

Description

Get the girth of a graph, which is the length of the shortest circle in the graph. Loop edges and multiple edges are not considered. If the graph contains no cycles then zero is returned.

Usage

get_girth(graph)

Arguments

graph

A graph object of class dgr_graph.

Value

A single numeric value representing the length of the shortest circle in the graph.

Examples

# Create a cycle graph
graph <-
  create_graph() %>%
  add_cycle(n = 5)

# Determine the graph's girth
graph %>% get_girth()

# Create a full graph and then
# get the girth for that
create_graph() %>%
  add_full_graph(n = 10) %>%
  get_girth()

DiagrammeR documentation built on June 22, 2024, 11:21 a.m.