Package edu.cmu.tetrad.study.gene.tetrad.gene.algorithm.urchin

Class RevealOutputGraph

java.lang.Object

edu.cmu.tetrad.study.gene.tetrad.gene.algorithm.urchin.RevealOutputGraph

All Implemented Interfaces:

OutputGraph

public class RevealOutputGraph
extends Object
implements OutputGraph

RevealOutputGraph class.

Version:

$Id: $Id

Author:

josephramsey

Constructor Summary

Constructors

Constructor	Description
RevealOutputGraph(int ngenes, int[][] parents, int[][] lags, String[] names, String graphName)	Constructor for RevealOutputGraph.

Method Summary

Modifier and Type	Method	Description
String	getGraphName()	Getter for the field graphName.
int[]	getLags(int index)	Returns the lags of the parent variables for the given variable, provided parents have associated time lags; otherwise, returns null.
String	getNodeName(int index)	Returns the name of the variable at the given index.
int[]	getParents(int index)	Returns the indices of the parent variables for the given variable.
int	getSize()	getSize.

Methods inherited from class java.lang.Object

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

Constructor Details

RevealOutputGraph

public RevealOutputGraph(int ngenes,
 int[][] parents,
 int[][] lags,
 String[] names,
 String graphName)

Constructor for RevealOutputGraph.

Parameters:

ngenes - a int

parents - an array of objects

lags - an array of objects

names - an array of String objects

graphName - a String object

Method Details

getSize

public int getSize()

getSize.

Specified by:

getSize in interface OutputGraph

Returns:

a int

getParents

public int[] getParents(int index)

Returns the indices of the parent variables for the given variable.

Specified by:

getParents in interface OutputGraph

Parameters:

index - the index of the variable whose parents are requested.

Returns:

the indices of the parent variables for the given variable.

getLags

public int[] getLags(int index)

Returns the lags of the parent variables for the given variable, provided parents have associated time lags; otherwise, returns null. A lag is a number >= 0, where 0 indicates the getModel time step and integers > 0 indicate that many time steps back into the past. If getLags(index) is non-null, the length of getLags(index) should be the same as the length of getParents(index), and getLags(i) should be the lag for the corresponding position in getParents(i), for i = 0,..., getParents(i).length.

Specified by:

getLags in interface OutputGraph

Parameters:

index - the lags of the variable whose parents are requested.

Returns:

the lags of the parent variables for the given variable, provided parents have associated time lags; otherwise, returns null.

getNodeName

public String getNodeName(int index)

Returns the name of the variable at the given index.

Specified by:

getNodeName in interface OutputGraph

Parameters:

index - the index of the variable whose name is requested.

Returns:

the name of the variable at the given index.

getGraphName

public String getGraphName()

Getter for the field graphName.

Specified by:

getGraphName in interface OutputGraph

Returns:

a String object