Copyright | (c) Eben Cowley 2018 |
---|---|

License | BSD 3 Clause |

Maintainer | eben.cowley42@gmail.com |

Stability | experimental |

Safe Haskell | None |

Language | Haskell2010 |

This module provides functions for constructing neighborhood graphs, clique complexes, Vietoris-Rips complexes, as well as the computation of Betti numbers.

An important thing to know about this module is the difference between "fast" and "light" functions. Fast functions encode the metric in a 2D vector, so that distances don't need to be computed over and over again and can instead be accessed in constant time. Unfortunately, this takes O(n^2) memory so I would strongly recomend against using it for larger data sets; this is why "light" functions exist.

A neighborhood graph is a graph where an edge exists between two vertices if and only if the vertices fall within a given distance of each other. Graphs here are more of a helper data type for constructing filtrations, which is why they have a somewhat odd representation. Not to worry though, I've supplied a way of encoding graphs of a more generic representation.

The clique complex of a graph is a simplicial complex whose simplices are the complete subgraphs of the given graph. The Vietoris-Rips complex is the clique complex of the neighborhood graph.

Betti numbers measure the number of n-dimensional holes in a given simplicial complex. The 0th Betti number is the number of connected components, or clusters; the 1st Betti number is the number of loops or tunnels; the 2nd Betti number measures voids or hollow volumes; and if you have high-dimensional data, you might have higher Betti numbers representing the number of high-dimensional holes.

## Synopsis

- type SimplicialComplex = (Int, Vector (Vector (Vector Int, Vector Int)))
- type Graph a = Vector (Vector (a, Bool))
- sc2String :: SimplicialComplex -> String
- getDim :: SimplicialComplex -> Int
- encodeWeightedGraph :: Int -> (Int -> Int -> (a, Bool)) -> Graph a
- makeNbrhdGraph :: (Ord a, Eq b) => a -> (b -> b -> a) -> [b] -> Graph a
- makeCliqueComplex :: Graph a -> SimplicialComplex
- makeVRComplexFast :: (Ord a, Eq b) => a -> (b -> b -> a) -> [b] -> (SimplicialComplex, Graph a)
- makeVRComplexLight :: (Ord a, Eq b) => a -> (b -> b -> a) -> [b] -> SimplicialComplex
- bettiNumbers :: SimplicialComplex -> [Int]
- bettiNumbersPar :: SimplicialComplex -> [Int]

# Documentation

type SimplicialComplex = (Int, Vector (Vector (Vector Int, Vector Int))) Source #

The first component of the pair is the number of vertices. The second component is a vector whose entries are vectors of simplices of the same dimension. Index 0 of the vecor corresponds to dimension 1 because there is no need to store individual vertices. A simplex is represented as a pair: the vector of its vertices (represent by their index in the original data set), and the vector of the indices of the faces in the next lowest dimension. Edges are the exception to the last part - they do not store reference to their faces because it would be redundant with their vertices.

type Graph a = Vector (Vector (a, Bool)) Source #

This represents the (symmetric) adjacency matrix of some weighted undirected graph. The type `a`

is whatever distance is in your data analysis regime.
The reason graphs are represented like this is because their main function is too speed up the construction of simplicial complexes and filtrations.
If the clique complex of this graph were to be constructed, only the adjacencies would matter. But if a filtration is constructed all the distances
will be required over and over again - this allows them to be accessed in constant time.

sc2String :: SimplicialComplex -> String Source #

Show all the information in a simplicial complex.

getDim :: SimplicialComplex -> Int Source #

Get the dimension of the highest dimensional simplex (constant time).

encodeWeightedGraph :: Int -> (Int -> Int -> (a, Bool)) -> Graph a Source #

Takes the number of vertices and each edge paired with its weight to output the graph encoded as a 2D vector.
If only you have an unweighted graph, you can still encode your graph by simply letting the type `a`

be `()`.
If you have a weighted graph but there isn't a distance between every vertex, you can use the `Extended`

type (essentially the same as Maybe)
from the Persistence module which is already an instance of Ord.

makeNbrhdGraph :: (Ord a, Eq b) => a -> (b -> b -> a) -> [b] -> Graph a Source #

The first argument is a scale, the second is a metric, and the third is the data. This function records the distance between every element of the data and whether or not it is smaller than the given scale.

makeCliqueComplex :: Graph a -> SimplicialComplex Source #

Makes a simplicial complex where the simplices are the complete subgraphs (cliques) of the given graph. Mainly a helper function for makeVRComplexFast, but it might be useful if you happen to have a graph you want to analyze. This utilizes any available processors in parallel because the construction is quite expensive.

makeVRComplexFast :: (Ord a, Eq b) => a -> (b -> b -> a) -> [b] -> (SimplicialComplex, Graph a) Source #

Constructs the Vietoris-Rips complex given a scale, metric, and data set. Also uses O(n^2) memory (where n is the number of data points) for a graph storing all the distances between data points. This utilizes any available processors in parallel because the construction is quite expensive.

makeVRComplexLight :: (Ord a, Eq b) => a -> (b -> b -> a) -> [b] -> SimplicialComplex Source #

Constructs the Vietoris-Rips complex given a scale, metric, and data set. This utilizes any available processors in parallel because the construction is quite expensive.

bettiNumbers :: SimplicialComplex -> [Int] Source #

The nth index of the output corresponds to the nth Betti number. The zeroth Betti number is the number of connected components, the 1st is the number of tunnels/punctures, the 2nd is the number of hollow volumes, and so on for higher-dimensional holes.

bettiNumbersPar :: SimplicialComplex -> [Int] Source #

Calculates all of the Betti numbers in parallel.