File: README
Author: Suvrit Sra

This is the readme file for the metric nearness code.

The directory includes the following _main_ files:

| File           | Description                                                |
|----------------+------------------------------------------------------------|
| driver.cc      | driver for the entire software package                     |
| main.cc        | formal main() function for the code                        |
| gencplex.pl    | perl script for generating CPLEX LPs                       |
| genmtx.pl      | create a random diss. matrix                               |
| metric.h       | common base class for various nearness measures            |
| metricL1*      | metric nearness for L1 norm; the 'V' version is vectorized |
| metricL2*      | metric nearness for L2 norm; FW orders triangles using FW  |
| metricKL.h,.cc | metric nearness with KL divergence                         |
|----------------+------------------------------------------------------------|
| Utility files  | mkcplex.cc randDmatrix.cc util.cc util.h                   |
|----------------+------------------------------------------------------------|

Example usage:

./metric -a 0 -f matrix.3 -m 10

*LICENSE*

The code is distributed under the Lesser Gnu Public License, and details
on the license are available here:

http://www.gnu.org/copyleft/lesser.html
