de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.pmmMeasures
Class PMMExplainingAwayResidual

java.lang.Object
  extended by de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.Measure
      extended by de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.pmmMeasures.PMMExplainingAwayResidual
All Implemented Interfaces:
Storable, Cloneable

public class PMMExplainingAwayResidual
extends Measure

Class for the network structure of a BayesianNetworkScoringFunction that is a permuted Markov model based on the explaining away residual.

Author:
Jan Grau

Constructor Summary
PMMExplainingAwayResidual(byte order, double[] ess)
          Creates a new PMMExplainingAwayResidual of order order.
PMMExplainingAwayResidual(StringBuffer buf)
          Re-creates a PMMExplainingAwayResidual from its XML-representation as returned by toXML().
 
Method Summary
 PMMExplainingAwayResidual clone()
           
 String getInstanceName()
          Returns the name of the Measure and possibly some additional information about the current instance.
 int[][] getParents(Sample fg, Sample bg, double[] weightsFg, double[] weightsBg, int length)
          Returns the optimal parents for the given data and weights.
 StringBuffer toXML()
          This method returns an XML-representation of an instance of the implementing class.
 
Methods inherited from class de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.Measure
fillTensor, fillTensor, getCMI, getCMI, getEAR, getEAR, getMI, getMI, getStatistics, getStatisticsOrderTwo, isShiftable, sum, toParents, union
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PMMExplainingAwayResidual

public PMMExplainingAwayResidual(StringBuffer buf)
                          throws NonParsableException
Re-creates a PMMExplainingAwayResidual from its XML-representation as returned by toXML().

Parameters:
buf - the XML-representation
Throws:
NonParsableException - is thrown if the XML-code could not be parsed

PMMExplainingAwayResidual

public PMMExplainingAwayResidual(byte order,
                                 double[] ess)
                          throws Exception
Creates a new PMMExplainingAwayResidual of order order.

Parameters:
order - the order, may be 1 or 2
ess - the equivalent sample sizes of both classes
Throws:
Exception
Method Detail

clone

public PMMExplainingAwayResidual clone()
                                throws CloneNotSupportedException
Overrides:
clone in class Measure
Throws:
CloneNotSupportedException

getInstanceName

public String getInstanceName()
Description copied from class: Measure
Returns the name of the Measure and possibly some additional information about the current instance.

Specified by:
getInstanceName in class Measure
Returns:
the name

getParents

public int[][] getParents(Sample fg,
                          Sample bg,
                          double[] weightsFg,
                          double[] weightsBg,
                          int length)
                   throws Exception
Description copied from class: Measure
Returns the optimal parents for the given data and weights. The array of parents p at each position i is build as follows:

Specified by:
getParents in class Measure
Parameters:
fg - the data of the current (foreground) class
bg - the data of the negative (background) class
weightsFg - the weights for the sequences of fg
weightsBg - the weights for the sequences of bg
length - the length of the model, must be equal to the length of the sequences
Returns:
the parents
Throws:
Exception - thrown if the lengths do not match or other problems concerning the data occur

toXML

public StringBuffer toXML()
Description copied from interface: Storable
This method returns an XML-representation of an instance of the implementing class.

Returns:
the XML-representation