Package edu.cmu.tetrad.study.performance

Class ComparisonParameters

java.lang.Object

edu.cmu.tetrad.study.performance.ComparisonParameters

public class ComparisonParameters
extends Object

Created by jdramsey on 3/24/16. Edited by dmalinsky 5/20/16.

Version:

$Id: $Id

Author:

josephramsey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ComparisonParameters.Algorithm	An enumeration of the algorithms that can be used for structure learning.
static enum	ComparisonParameters.DataType	An enumeration of the data types that can be used for structure learning.
static enum	ComparisonParameters.IndependenceTestType	An enumeration of the independence test types that can be used for structure learning.
static enum	ComparisonParameters.ResultType	An enumeration of the result types that can be used for structure learning.

Constructor Summary

Constructors

Constructor	Description
ComparisonParameters()	Constructor for ComparisonParameters.
ComparisonParameters(ComparisonParameters params)	Constructor for ComparisonParameters.

Method Summary

Modifier and Type	Method	Description
ComparisonParameters.Algorithm	getAlgorithm()	Getter for the field algorithm.
double	getAlpha()	Getter for the field alpha.
String	getDataFile()	Getter for the field dataFile.
ComparisonParameters.DataType	getDataType()	Getter for the field dataType.
String	getGraphFile()	Getter for the field graphFile.
int	getGraphNum()	Getter for the field graphNum.
ComparisonParameters.IndependenceTestType	getIndependenceTest()	Getter for the field independenceTest.
int	getNumEdges()	Getter for the field numEdges.
int	getNumVars()	Getter for the field numVars.
double	getPenaltyDiscount()	Getter for the field penaltyDiscount.
ComparisonParameters.ResultType	getResultType()	Getter for the field resultType.
double	getSamplePrior()	Getter for the field samplePrior.
int	getSampleSize()	Getter for the field sampleSize.
ScoreType	getScore()	Getter for the field score.
double	getStructurePrior()	Getter for the field structurePrior.
int	getTrial()	Getter for the field trial.
boolean	isDataFromFile()	isDataFromFile.
boolean	isNoData()	isNoData.
boolean	isOneEdgeFaithfulnessAssumed()	isOneEdgeFaithfulnessAssumed.
void	setAlgorithm(ComparisonParameters.Algorithm algorithm)	Setter for the field algorithm.
void	setAlpha(double alpha)	Setter for the field alpha.
void	setDataFile(String dataFile)	Setter for the field dataFile.
void	setDataFromFile(boolean dataFromFile)	Setter for the field dataFromFile.
void	setDataType(ComparisonParameters.DataType dataType)	Setter for the field dataType.
void	setGraphFile(String graphFile)	Setter for the field graphFile.
void	setGraphNum(int graphNum)	Setter for the field graphNum.
void	setIndependenceTest(ComparisonParameters.IndependenceTestType independenceTest)	Setter for the field independenceTest.
void	setNoData(boolean noData)	Setter for the field noData.
void	setNumEdges(int numEdges)	Setter for the field numEdges.
void	setNumVars(int numVars)	Setter for the field numVars.
void	setOneEdgeFaithfulnessAssumed(boolean oneEdgeFaithfulnessAssumed)	Setter for the field oneEdgeFaithfulnessAssumed.
void	setPenaltyDiscount(double penaltyDiscount)	Setter for the field penaltyDiscount.
void	setResultType(ComparisonParameters.ResultType resultType)	Setter for the field resultType.
void	setSamplePrior(double samplePrior)	Setter for the field samplePrior.
void	setSampleSize(int sampleSize)	Setter for the field sampleSize.
void	setScore(ScoreType score)	Setter for the field score.
void	setStructurePrior(double structurePrior)	Setter for the field structurePrior.
void	setTrial(int trial)	Setter for the field trial.
String	toString()	toString.

Methods inherited from class java.lang.Object

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

Constructor Details

ComparisonParameters

public ComparisonParameters()

Constructor for ComparisonParameters.

ComparisonParameters

public ComparisonParameters(ComparisonParameters params)

Constructor for ComparisonParameters.

Parameters:

params - a ComparisonParameters object

Method Details

getDataType

public ComparisonParameters.DataType getDataType()

Getter for the field dataType.

Returns:

a ComparisonParameters.DataType object

setDataType

public void setDataType(ComparisonParameters.DataType dataType)

Setter for the field dataType.

Parameters:

dataType - a ComparisonParameters.DataType object

getResultType

public ComparisonParameters.ResultType getResultType()

Getter for the field resultType.

Returns:

a ComparisonParameters.ResultType object

setResultType

public void setResultType(ComparisonParameters.ResultType resultType)

Setter for the field resultType.

Parameters:

resultType - a ComparisonParameters.ResultType object

getNumVars

public int getNumVars()

Getter for the field numVars.

Returns:

a int

setNumVars

public void setNumVars(int numVars)

Setter for the field numVars.

Parameters:

numVars - a int

getNumEdges

public int getNumEdges()

Getter for the field numEdges.

Returns:

a int

setNumEdges

public void setNumEdges(int numEdges)

Setter for the field numEdges.

Parameters:

numEdges - a int

getSampleSize

public int getSampleSize()

Getter for the field sampleSize.

Returns:

a int

setSampleSize

public void setSampleSize(int sampleSize)

Setter for the field sampleSize.

Parameters:

sampleSize - a int

getIndependenceTest

public ComparisonParameters.IndependenceTestType getIndependenceTest()

Getter for the field independenceTest.

Returns:

a ComparisonParameters.IndependenceTestType object

setIndependenceTest

public void setIndependenceTest(ComparisonParameters.IndependenceTestType independenceTest)

Setter for the field independenceTest.

Parameters:

independenceTest - a ComparisonParameters.IndependenceTestType object

getPenaltyDiscount

public double getPenaltyDiscount()

Getter for the field penaltyDiscount.

Returns:

a double

setPenaltyDiscount

public void setPenaltyDiscount(double penaltyDiscount)

Setter for the field penaltyDiscount.

Parameters:

penaltyDiscount - a double

getAlpha

public double getAlpha()

Getter for the field alpha.

Returns:

a double

setAlpha

public void setAlpha(double alpha)

Setter for the field alpha.

Parameters:

alpha - a double

getScore

public ScoreType getScore()

Getter for the field score.

Returns:

a ScoreType object

setScore

public void setScore(ScoreType score)

Setter for the field score.

Parameters:

score - a ScoreType object

getAlgorithm

public ComparisonParameters.Algorithm getAlgorithm()

Getter for the field algorithm.

Returns:

a ComparisonParameters.Algorithm object

setAlgorithm

public void setAlgorithm(ComparisonParameters.Algorithm algorithm)

Setter for the field algorithm.

Parameters:

algorithm - a ComparisonParameters.Algorithm object

getDataFile

public String getDataFile()

Getter for the field dataFile.

Returns:

a String object

setDataFile

public void setDataFile(String dataFile)

Setter for the field dataFile.

Parameters:

dataFile - a String object

getGraphFile

public String getGraphFile()

Getter for the field graphFile.

Returns:

a String object

setGraphFile

public void setGraphFile(String graphFile)

Setter for the field graphFile.

Parameters:

graphFile - a String object

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object

getSamplePrior

public double getSamplePrior()

Getter for the field samplePrior.

Returns:

a double

setSamplePrior

public void setSamplePrior(double samplePrior)

Setter for the field samplePrior.

Parameters:

samplePrior - a double

getStructurePrior

public double getStructurePrior()

Getter for the field structurePrior.

Returns:

a double

setStructurePrior

public void setStructurePrior(double structurePrior)

Setter for the field structurePrior.

Parameters:

structurePrior - a double

isOneEdgeFaithfulnessAssumed

public boolean isOneEdgeFaithfulnessAssumed()

isOneEdgeFaithfulnessAssumed.

Returns:

a boolean

setOneEdgeFaithfulnessAssumed

public void setOneEdgeFaithfulnessAssumed(boolean oneEdgeFaithfulnessAssumed)

Setter for the field oneEdgeFaithfulnessAssumed.

Parameters:

oneEdgeFaithfulnessAssumed - a boolean

isNoData

public boolean isNoData()

isNoData.

Returns:

a boolean

setNoData

public void setNoData(boolean noData)

Setter for the field noData.

Parameters:

noData - a boolean

isDataFromFile

public boolean isDataFromFile()

isDataFromFile.

Returns:

a boolean

setDataFromFile

public void setDataFromFile(boolean dataFromFile)

Setter for the field dataFromFile.

Parameters:

dataFromFile - a boolean

getGraphNum

public int getGraphNum()

Getter for the field graphNum.

Returns:

a int

setGraphNum

public void setGraphNum(int graphNum)

Setter for the field graphNum.

Parameters:

graphNum - a int

getTrial

public int getTrial()

Getter for the field trial.

Returns:

a int

setTrial

public void setTrial(int trial)

Setter for the field trial.

Parameters:

trial - a int