Package edu.cmu.tetrad.algcomparison

Class TimeoutComparison

java.lang.Object

edu.cmu.tetrad.algcomparison.TimeoutComparison

public class TimeoutComparison
extends Object

Nov 14, 2017 12:00:31 PM

Version:

$Id: $Id

Author:

Kevin V. Bui (kvb2@pitt.edu)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TimeoutComparison.ComparisonGraph	An enum of graph types to compare.

Constructor Summary

Constructors

Constructor	Description
TimeoutComparison()	Represents a comparison of two time values for timeout purposes.

Method Summary

Modifier and Type	Method	Description
void	compareFromFiles(String filePath, Algorithms algorithms, Statistics statistics, Parameters parameters, long timeout, TimeUnit unit)	compareFromFiles.
void	compareFromFiles(String dataPath, String resultsPath, Algorithms algorithms, Statistics statistics, Parameters parameters, long timeout, TimeUnit unit)	Compares algorithms.
void	compareFromSimulations(String resultsPath, Simulations simulations, Algorithms algorithms, Statistics statistics, Parameters parameters, long timeout, TimeUnit unit)	compareFromSimulations.
void	compareFromSimulations(String resultsPath, Simulations simulations, String outputFileName, Algorithms algorithms, Statistics statistics, Parameters parameters, long timeout, TimeUnit unit)	Compares algorithms.
void	configuration(String path)	configuration.
void	generateReportFromExternalAlgorithms(String dataPath, String resultsPath, Algorithms algorithms, Statistics statistics, Parameters parameters, long timeout, TimeUnit unit)	generateReportFromExternalAlgorithms.
void	generateReportFromExternalAlgorithms(String dataPath, String resultsPath, String outputFileName, Algorithms algorithms, Statistics statistics, Parameters parameters, long timeout, TimeUnit unit)	generateReportFromExternalAlgorithms.
TimeoutComparison.ComparisonGraph	getComparisonGraph()	The type of graph the results are compared to.
boolean	isCopyData()	isCopyData.
boolean	isParallelized()	isParallelized.
boolean	isSaveCPDAGs()	isSaveCPDAGs.
boolean	isSaveGraphs()	isSaveGraphs.
boolean	isSavePags()	isSavePags.
boolean	isShowUtilities()	isShowUtilities.
boolean	isSortByUtility()	isSortByUtility.
boolean	isTabDelimitedTables()	isTabDelimitedTables.
void	saveToFiles(String dataPath, Simulation simulation, Parameters parameters)	Saves simulationWrapper data.
void	setComparisonGraph(TimeoutComparison.ComparisonGraph comparisonGraph)	The type of graph the results are compared to.
void	setCopyData(boolean copyData)	Setter for the field copyData.
void	setParallelized(boolean parallelized)	Setter for the field parallelized.
void	setSaveCPDAGs(boolean saveCPDAGs)	Setter for the field saveCPDAGs.
void	setSaveGraphs(boolean saveGraphs)	Setter for the field saveGraphs.
void	setSavePags(boolean savePags)	Setter for the field savePags.
void	setShowUtilities(boolean showUtilities)	Setter for the field showUtilities.
void	setSortByUtility(boolean sortByUtility)	Setter for the field sortByUtility.
void	setTabDelimitedTables(boolean tabDelimitedTables)	Setter for the field tabDelimitedTables.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TimeoutComparison

public TimeoutComparison()

Represents a comparison of two time values for timeout purposes.

The TimeoutComparison class can be used to compare two time values and determine if they have exceeded a specified timeout period.

Method Details

compareFromFiles

public void compareFromFiles(String filePath,
 Algorithms algorithms,
 Statistics statistics,
 Parameters parameters,
 long timeout,
 TimeUnit unit)

compareFromFiles.

Parameters:

filePath - a String object

algorithms - a Algorithms object

statistics - a Statistics object

parameters - a Parameters object

timeout - a long

unit - a TimeUnit object

compareFromFiles

public void compareFromFiles(String dataPath,
 String resultsPath,
 Algorithms algorithms,
 Statistics statistics,
 Parameters parameters,
 long timeout,
 TimeUnit unit)

Compares algorithms.

Parameters:

dataPath - Path to the directory where data and graph files have been saved.

resultsPath - Path to the file where the results should be stored.

algorithms - The list of algorithms to be compared.

statistics - The list of statistics on which to compare the algorithm, and their utility weights.

parameters - The list of parameters and their values.

timeout - a long

unit - a TimeUnit object

generateReportFromExternalAlgorithms

public void generateReportFromExternalAlgorithms(String dataPath,
 String resultsPath,
 Algorithms algorithms,
 Statistics statistics,
 Parameters parameters,
 long timeout,
 TimeUnit unit)

generateReportFromExternalAlgorithms.

Parameters:

dataPath - a String object

resultsPath - a String object

algorithms - a Algorithms object

statistics - a Statistics object

parameters - a Parameters object

timeout - a long

unit - a TimeUnit object

generateReportFromExternalAlgorithms

public void generateReportFromExternalAlgorithms(String dataPath,
 String resultsPath,
 String outputFileName,
 Algorithms algorithms,
 Statistics statistics,
 Parameters parameters,
 long timeout,
 TimeUnit unit)

generateReportFromExternalAlgorithms.

Parameters:

dataPath - a String object

resultsPath - a String object

outputFileName - a String object

algorithms - a Algorithms object

statistics - a Statistics object

parameters - a Parameters object

timeout - a long

unit - a TimeUnit object

compareFromSimulations

public void compareFromSimulations(String resultsPath,
 Simulations simulations,
 Algorithms algorithms,
 Statistics statistics,
 Parameters parameters,
 long timeout,
 TimeUnit unit)

compareFromSimulations.

Parameters:

resultsPath - a String object

simulations - a Simulations object

algorithms - a Algorithms object

statistics - a Statistics object

parameters - a Parameters object

timeout - a long

unit - a TimeUnit object

compareFromSimulations

public void compareFromSimulations(String resultsPath,
 Simulations simulations,
 String outputFileName,
 Algorithms algorithms,
 Statistics statistics,
 Parameters parameters,
 long timeout,
 TimeUnit unit)

Compares algorithms.

Parameters:

resultsPath - Path to the file where the output should be printed.

simulations - The list of simulationWrapper that is used to generate graphs and data for the comparison.

outputFileName - a String object

algorithms - The list of algorithms to be compared.

statistics - The list of statistics on which to compare the algorithm, and their utility weights.

parameters - a Parameters object

timeout - a long

unit - a TimeUnit object

saveToFiles

public void saveToFiles(String dataPath,
 Simulation simulation,
 Parameters parameters)

Saves simulationWrapper data.

Parameters:

dataPath - The path to the directory where the simulationWrapper data should be saved.

simulation - The simulate used to generate the graphs and data.

parameters - The parameters to be used in the simulationWrapper.

configuration

public void configuration(String path)

configuration.

Parameters:

path - a String object

isShowUtilities

public boolean isShowUtilities()

isShowUtilities.

Returns:

True iff a column of utilities marked "W" should be shown in the output.

setShowUtilities

public void setShowUtilities(boolean showUtilities)

Setter for the field showUtilities.

Parameters:

showUtilities - True iff a column of utilities marked "W" should be shown in the output.

isSortByUtility

public boolean isSortByUtility()

isSortByUtility.

Returns:

True iff the output should be sorted by utility.

setSortByUtility

public void setSortByUtility(boolean sortByUtility)

Setter for the field sortByUtility.

Parameters:

sortByUtility - true iff the output should be sorted by utility.

isParallelized

public boolean isParallelized()

isParallelized.

Returns:

a boolean

setParallelized

public void setParallelized(boolean parallelized)

Setter for the field parallelized.

Parameters:

parallelized - a boolean

isSaveCPDAGs

public boolean isSaveCPDAGs()

isSaveCPDAGs.

Returns:

True if CPDAGs should be saved out.

setSaveCPDAGs

public void setSaveCPDAGs(boolean saveCPDAGs)

Setter for the field saveCPDAGs.

Parameters:

saveCPDAGs - True if CPDAGs should be saved out.

isSavePags

public boolean isSavePags()

isSavePags.

Returns:

True if patterns should be saved out.

setSavePags

public void setSavePags(boolean savePags)

Setter for the field savePags.

Parameters:

savePags - True if patterns should be saved out.

isTabDelimitedTables

public boolean isTabDelimitedTables()

isTabDelimitedTables.

Returns:

True iff tables should be tab delimited (e.g. for easy pasting into Excel).

setTabDelimitedTables

public void setTabDelimitedTables(boolean tabDelimitedTables)

Setter for the field tabDelimitedTables.

Parameters:

tabDelimitedTables - True iff tables should be tab delimited (e.g. for easy pasting into Excel).

isSaveGraphs

public boolean isSaveGraphs()

isSaveGraphs.

Returns:

True if all graphs should be saved to files.

setSaveGraphs

public void setSaveGraphs(boolean saveGraphs)

Setter for the field saveGraphs.

Parameters:

saveGraphs - True if all graphs should be saved to files.

isCopyData

public boolean isCopyData()

isCopyData.

Returns:

True if data should be copied before analyzing it.

setCopyData

public void setCopyData(boolean copyData)

Setter for the field copyData.

Parameters:

copyData - True if data should be copied before analyzing it.

getComparisonGraph

public TimeoutComparison.ComparisonGraph getComparisonGraph()

The type of graph the results are compared to.

Returns:

a TimeoutComparison.ComparisonGraph object

setComparisonGraph

public void setComparisonGraph(TimeoutComparison.ComparisonGraph comparisonGraph)

The type of graph the results are compared to.

Parameters:

comparisonGraph - a TimeoutComparison.ComparisonGraph object