Skip to content

Commit

Permalink
update READMEs before 0.4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jwdinius committed Feb 20, 2021
1 parent e52ad53 commit 5ff006e
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Within each subproject, you will find a separate `README` describing that subpro

The code in each subproject follows a common standard and is well-commented. [Unit tests](./tests) are provided for key functionality but some things may remain unclear. If this is the case, please create an [issue](https://github.com/jwdinius/nmsac/issues).

For desired formatting, please see the script [linter.sh](scripts/linter.sh) and the [`cpplint` docs](https://github.com/cpplint/cpplint). I will eventually add Travis integration to check each PR, but until then I use the linter script.
For desired formatting, please see the script [linter.sh](scripts/linter.sh) and the [`cpplint` docs](https://github.com/cpplint/cpplint).

## Quick Start

Expand Down
4 changes: 2 additions & 2 deletions bindings/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `nmsac::bindings`
Build bindings to call `nmsac` functions from different languages. Currently supported languages:
Build bindings to call `nmsac::main` from different languages. Currently supported languages:

* [`python3`](./python)

_Note: Currently, only `nmsac::main` function (and type definition dependencies) have been wrapped._
Only `nmsac::main` is exposed, by design. However, if you want to bind other functions, go right ahead.
6 changes: 4 additions & 2 deletions correspondences/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ Implementation for Algorithm 2 from the [top-level README](../README.md). For a

This subproject is organized in the following way:

* [`common`](./common) - common utility code and type definitions (including `CorrespondencesBase` definition, which is used to wrap all algorithm implementations for computing correspondences)
* [`common`](./common) - common utility code and base class definitions
* [`graph`](./graph) - methods for constructing and working with undirected graphs (e.g. for [`mc`](./mc) algorithm)
* [`qap`](./qap) - implements an optimization-based solution to the correspondences problem.
* [`mc`](./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](./qap) subdirectory:
Expand All @@ -15,4 +17,4 @@ Each new algorithm implemented should follow the organization of the [qap](./qap
* add appropriate unit tests in folder rooted [here](../tests)
* modify parent `CMakeLists.txt` files to make sure your implementation and tests get built

When in doubt, just follow the `qap` pattern!
When in doubt, just follow the provided patterns!
9 changes: 4 additions & 5 deletions correspondences/mc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# `nmsac::correspondences::qap`
This subproject implements a convex relaxation of the binary optimization problem discussed in this [paper](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.140.910&rep=rep1&type=pdf), Section 5.4. For more details, check out some of these resources:
# `nmsac::correspondences::mc`
This subproject implements a correspondences solver based on computation of the maximum clique of an undirected graph representing candidate correspondences. Candidate correspondences are those that are pairwise consistent between source and target point clouds. For more details, check out these resources:

* Mathematical details: [Part 1](https://jwdinius.github.io/blog/2019/point-match/) and [Part 2](https://jwdinius.github.io/blog/2019/point-match-cont/)
* [Code design notes](https://jwdinius.github.io/blog/2019/point-match-sol/)
* [Paper](https://arxiv.org/abs/1902.01534)
* [Sample Demo](https://jwdinius.github.io/blog/2021/max-clique)

_Note: this algorithm is pretty slow, but is provided as a reference implementation for benchmarking and to demonstrate desired project structure._

0 comments on commit 5ff006e

Please sign in to comment.