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):

Two-sided profile-based optimality in the stable marriage problem
Authors: Frances Cooper and David Manlove


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

2) Directory structure:

The following zipped directories:

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

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

- Instances			- contains the randomly generated instances
- ResultsGS_notSwapped		- man-optimal stable matching results
- ResultsGS_Swapped		- woman-optimal stable matching results
- Results_stable		- Enumeration of all stable matchings and rotations
- Correctness			- correctness testing results


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

3) Instance structure:

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


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

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. "Evaluations" should be placed in the software root.

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

5) Version updates

V1.0.2:
* Updated README

V1.0.1:
* Added data for motivation section (instances sizes 2000, 3000, 4000, 5000)
* Re-added all other data as occasional zip files were corrupted


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

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