print_simplices: Print simplices to the console

In simplextree: Provides Tools for Working with General Simplicial Complexes

Description

Prints simplices in a formatted way

Prints a traversal, a simplex tree, or a list of simplices to the R console, with options to customize how the simplices are printed. The format must be one of "summary", "tree", "cousins", "short", "column", or "row", with the default being "short". In general, the "tree" and "cousins" format give more details on the structure of the trie, whereas the other formats just change how the given set of simplices are formatted.
The "tree" method prints the nodes grouped by the same last label and indexed by depth. The printed format is:

[vertex] (h = [subtree height]): [subtree depth]([subtree])

Where each lists the top node (vertex) and its corresponding subtree. The subtree height displays the highest order k-simplex in that subtree. Each level in the subtree tree is a set of sibling k-simplices whose order is given by the number of dots ('.') proceeding the print level.

The "cousin" format prints the simplex relations used by various algorithms to speed up finding adjacencies in the complex. The cousins are grouped by label and depth.
The format looks like:
(last=[label], depth=[depth of label]): [simplex]

This function is useful for understanding how the simplex tree is stored, and for debugging purposes.

Usage

print_simplices(
  st,
  format = c("summary", "tree", "cousins", "short", "column", "row")
)

Arguments

st	a simplex tree.
format	the choice of how to format the printing. See details.

simplextree documentation built on Sept. 13, 2020, 5:06 p.m.