Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.btMeasures
Class BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet

    java.lang.Object
      de.jstacs.parameters.ParameterSet
          de.jstacs.parameters.InstanceParameterSet
              de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.btMeasures.BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet

All Implemented Interfaces:
  RangeIterator, Storable, Cloneable

Enclosing class:
  BTExplainingAwayResidual

    public static class BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet

extends InstanceParameterSet

Class for the parameters of a `BTExplainingAwayResidual` structure `Measure`.

Author:
  Jan Grau

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet
`ParameterSet.ParameterList`

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet
`errorMessage, parameters, parent, ranged`

Constructor Summary
`BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet()` Creates a new `BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet` with empty parameter values.
`BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet(double[] ess)` Creates a new `BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet` with the parameter for the equivalent sample sizes set to `ess`.
`BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet(StringBuffer representation)` The standard constructor for the interface `Storable` .

Method Summary
`double[]` | `getEss()` Returns the equivalent sample sizes (ess) defined by this set of parameters.
`String` | `getInstanceComment()` Returns a comment (a textual description) of the class that can be constructed using this `ParameterSet`.
`String` | `getInstanceName()` Returns the name of an instance of the class that can be constructed using this `ParameterSet`.
`protected void` | `loadParameters()` Loads the parameters for this `ParameterSet`.

Methods inherited from class de.jstacs.parameters.InstanceParameterSet
`fromXML, getInstance, getInstanceClass, toXML`

Methods inherited from class de.jstacs.parameters.ParameterSet
`clone, getErrorMessage, getId, getIndex, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setParent, simplify, valuesToString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet

    public BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet()

  Creates a new `BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet` with empty parameter values.

### BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet

    public BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet(double[] ess)
                                                                  throws Exception

  Creates a new `BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet` with the parameter for the equivalent sample sizes set to `ess`.

  Parameters:
    `ess` - the equivalent sample sizes for the foreground class and the background, i.e. the background class or (in case of more than two classes) all non-foreground classes
  Throws:
    `Exception` - if the parameters could not be created or set

### BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet

    public BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet(StringBuffer representation)
                                                                  throws NonParsableException

  The standard constructor for the interface `Storable` . Creates a new `BTExplainingAwayResidual.BTExplainingAwayResidualParameterSet` from its XML representation as defined by the `Storable` interface.

  Parameters:
    `representation` - the XML code as `StringBuffer`
  Throws:
    `NonParsableException` - if the XML representation could not be parsed

Method Detail

### getEss

    public double[] getEss()

  Returns the equivalent sample sizes (ess) defined by this set of parameters.

  Returns:
    the equivalent sample sizes (ess)

### getInstanceComment

    public String getInstanceComment()

  Description copied from class: `InstanceParameterSet`
  Returns a comment (a textual description) of the class that can be constructed using this `ParameterSet`.

  Specified by:
    `getInstanceComment` in class `InstanceParameterSet`
  Returns:
    the comment of the class

### getInstanceName

    public String getInstanceName()

  Description copied from class: `InstanceParameterSet`
  Returns the name of an instance of the class that can be constructed using this `ParameterSet`.

  Specified by:
    `getInstanceName` in class `InstanceParameterSet`
  Returns:
    the name of the class

### loadParameters

    protected void loadParameters()
                           throws Exception

  Description copied from class: `ParameterSet`
  Loads the parameters for this `ParameterSet`. This is in most cases done by calling `ParameterSet.initParameterList()` or `ParameterSet.initParameterList(int)` to initialize `ParameterSet.parameters` and afterwards filling `ParameterSet.parameters` with instances of subclasses of `Parameter`.

  Specified by:
    `loadParameters` in class `ParameterSet`
  Throws:
    `Exception` - if the parameters could not be loaded
  See Also:
    `Parameter`, `ParameterSet.parameters`, `ParameterSet.initParameterList()`, `ParameterSet.initParameterList(int)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD