bug3484 PairingListTemplate Javadoc added

This commit is contained in:
Kuck committed 2017-11-20 08:58:04 +01:00
1 parent 393151bd3a
commit b2b69b73e0
2 files changed
+12 -6

No files matched your search

@@ -1,6 +1,6 @@
package com.sap.see.pairinglist.test;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNotNull;
import java.util.ArrayList;
import java.util.stream.IntStream;
@@ -18,13 +18,19 @@ public interface PairingListTemplate {
CompetitionFormat<Flight, Group, Competitor> competitionFormat);
/**
* Returns the quality of a pairing list template.
* The value corresponds to the quality of a pairing list template. The quality is calculated by the
* standard deviation of values in association matrix.
*
* @return quality of pairing list template, stated as the standard deviation,
* which is calculated by team association.
* @return double, stated as the standard deviation.
*/
double getQuality();
//TODO: Javadoc
int[][] getPairingListTemplate();
/**
* Every row of this array represents a single group of a flight with competitors per group (competitors/groups)
* in their columns. Competitors starts counting at zero. When calling this method the pairing list template is
* already generated.
*
* @return two dimensional int array with flights*groups rows and competitors/groups columns
*/
int[][] getPairingListTemplate();
}