README

1) Introduction
2) Directory structure
3) Instance structure
3) How the data was created
4) How the data can be used
5) Version updates


*****************************

1) Introduction:

This data corresponds to the data and experiments described in the 
following paper (more details in intro of DOI):

Algorithms for new types of fair stable matchings
Authors: Frances Cooper and David Manlove


*****************************

2) Directory structure:

The following zipped directories are contained in this repository:

- S6, S8, S10, S20,..., S100, S200,..., S1000

Each of these sub-directories itself contains the following 5 sub-directories.

- Instances			- contains the randomly generated instances
- ReDegreeIterationAlgorithm	- Algorithm REDI results
- ReStablePairAlgorithm		- Algorithm RESP results
- EnumerationAlgorithm		- Algorithm ENUM results
- Correctness			- correctness testing results


*****************************

3) Instance structure:

<num_men>
<man1>: <man1_womanchoice1> <man1_womanchoice2> ... <man1_womanchoicen>
...
<woman1>: <woman1_manchoice1> <woman1_manchoice2> ... <woman1_manchoicen>
...


*****************************

3) How the data was created:

Data creation is discussed in the associated paper.


*****************************

4) How the data can be used:

This data can be used with the corresponding software implementations (details in intro of DOI). Create a directory with name "Evaluations" and add all data directories. Details of where to place the "Evaluations" directory can be found in the readme to the software.

*****************************

5) Version updates

V1.0.0:
* Initial version


*****************************

This readme is based on a readme for a previous project found here: https://doi.org/10.5281/zenodo.1186823