README.md

`nmsac::correspondences`

Implementation for Algorithm 2 from the top-level README. For a short discussion on correspondence identification, see this blog post.

This subproject is organized in the following way:

common - common utility code and base class definitions
graph - methods for constructing and working with undirected graphs (e.g. for mc algorithm)
qap - implements an optimization-based solution to the correspondences problem.
mc - implements a graph-based solution to the correspondences problem.
insert new algorithm here! Submit a PR, if you dare!

Each new algorithm implemented should follow the organization of the qap subdirectory:

identify short, descriptive name for the implementation, i.e. {alg}
create include/{alg} and src directories to hold the implementation
create a CMakeLists.txt file to generate build environment for the algorithm implementation
add appropriate unit tests in folder rooted here
modify parent CMakeLists.txt files to make sure your implementation and tests get built

When in doubt, just follow the provided patterns!