Summarize IkNN Graph Object

Prints a summary of an IkNN graph object, including the number of vertices, edges, and pruning statistics.

Usage

# S3 method for class 'IkNN'
summary(object, ...)

Arguments

object

An object of class "IkNN", typically output from create.single.iknn.graph()

...

Additional arguments passed to summary().

Value

Invisibly returns NULL while printing summary information to the console

Examples

graph <- create.single.iknn.graph(matrix(c(0, 1, 3, 6), ncol = 1),
                                   k = 1, verbose = FALSE)
summary(graph)
#> Graph Summary:
#> Number of vertices: 4 
#> Number of edges: 3 
#> Number of edges after pruning: 1 
#> Number of edges in final graph: 3 
#> Number of removed edges: 1 
#> Proportion of edges removed: 0.25