TabooSettings (Bayesia Engine Javadoc)

java.lang.Object
- com.bayesia.api.learning.settings.AbstractLearningSettings
- - com.bayesia.api.learning.settings.TabooSettings

All Implemented Interfaces:

LearningSettings, java.lang.Cloneable
```
public class TabooSettings
extends AbstractLearningSettings
```
Learning settings for the taboo learning algorithm.

Version:

4.2

Author:

Bayesia S.A.S.

Constructor Summary

Constructors
Constructor and Description

TabooSettings()

Constructors
Constructor and Description
`TabooSettings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TabooSettings`	`copy()` Make a deep copy of the learning settings.
`static TabooSettings`	`createDefault()` Create an instance of the learning settings initialized with the default parameters for this algorithm.
`APIUtils.LEARNING_ALGORITHM`	`getLearningAlgorithm()` Return a `LEARNING_ALGORITHM` indicating the learning algorithm to use
`int`	`getListLength()`
`int`	`getMaxChildNumber()`
`int`	`getMaxParentNumber()`
`java.lang.String`	`getTargetNodeName()` Return the name of the target node if the learning algorithm is supervised.
`boolean`	`isAllArcsDeleted()`
`boolean`	`isSupervised()` Indicate if the current learning algorithm is supervised (i.e. it needs a target) or not.
`boolean`	`isUnfixedArcsDeleted()`
`boolean`	`isUseMaxChildNumber()`
`boolean`	`isUseMaxParentNumber()`
`boolean`	`isValid()` Test if the current settings are valid.
`void`	`setAllArcsDeleted(boolean allArcsDeleted)`
`void`	`setListLength(int listLength)`
`void`	`setMaxChildNumber(int maxChildNumber)`
`void`	`setMaxParentNumber(int maxParentNumber)`
`void`	`setUnfixedArcsDeleted(boolean unfixedArcsDeleted)`
`java.lang.String`	`toString()`

Methods inherited from class com.bayesia.api.learning.settings.AbstractLearningSettings
getSmoothedProbabilityEstimation, getStructuralCoefficient, isVerbose, setSmoothedProbabilityEstimation, setStructuralCoefficient, setVerbose

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

- Constructor Detail
  - TabooSettings
```
public TabooSettings()
```
- Method Detail
  - copy
```
public TabooSettings copy()
```
    Description copied from interface: LearningSettings
    
    Make a deep copy of the learning settings.
    
    Returns:
    
    a deep copy of the current instance
  - getListLength
```
public int getListLength()
```
  - setListLength
```
public void setListLength(int listLength)
```
  - isUseMaxParentNumber
```
public boolean isUseMaxParentNumber()
```
  - getMaxParentNumber
```
public int getMaxParentNumber()
```
  - setMaxParentNumber
```
public void setMaxParentNumber(int maxParentNumber)
```
  - isUseMaxChildNumber
```
public boolean isUseMaxChildNumber()
```
  - getMaxChildNumber
```
public int getMaxChildNumber()
```
  - setMaxChildNumber
```
public void setMaxChildNumber(int maxChildNumber)
```
  - setAllArcsDeleted
```
public void setAllArcsDeleted(boolean allArcsDeleted)
```
  - isAllArcsDeleted
```
public boolean isAllArcsDeleted()
```
  - setUnfixedArcsDeleted
```
public void setUnfixedArcsDeleted(boolean unfixedArcsDeleted)
```
  - isUnfixedArcsDeleted
```
public boolean isUnfixedArcsDeleted()
```
  - createDefault
```
public static TabooSettings createDefault()
```
    Create an instance of the learning settings initialized with the default parameters for this algorithm.
    
    Returns:
    
    the learning settings
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface LearningSettings
    
    Overrides:
    
    toString in class AbstractLearningSettings
  - getLearningAlgorithm
```
public APIUtils.LEARNING_ALGORITHM getLearningAlgorithm()
```
    Description copied from interface: LearningSettings
    
    Return a LEARNING_ALGORITHM indicating the learning algorithm to use
    
    Returns:
    
    the learning algorithm to use
  - isSupervised
```
public boolean isSupervised()
```
    Description copied from interface: LearningSettings
    
    Indicate if the current learning algorithm is supervised (i.e. it needs a target) or not.
    
    Returns:
    
    true if the learning algorithm is supervised, false if unsupervised. APIUtils.LEARNING_ALGORITHM.isSupervised()
  - getTargetNodeName
```
public java.lang.String getTargetNodeName()
```
    Description copied from interface: LearningSettings
    
    Return the name of the target node if the learning algorithm is supervised.
    
    Returns:
    
    the target node's name
  - isValid
```
public boolean isValid()
```
    Description copied from interface: LearningSettings
    
    Test if the current settings are valid.
    
    Returns:
    
    true if the settings are valid, false otherwise

Class TabooSettings

Constructor Summary

Method Summary

Methods inherited from class com.bayesia.api.learning.settings.AbstractLearningSettings

Methods inherited from class java.lang.Object

Constructor Detail

TabooSettings

Method Detail

copy

getListLength

setListLength

isUseMaxParentNumber

getMaxParentNumber

setMaxParentNumber

isUseMaxChildNumber

getMaxChildNumber

setMaxChildNumber

setAllArcsDeleted

isAllArcsDeleted

setUnfixedArcsDeleted

isUnfixedArcsDeleted

createDefault

toString

getLearningAlgorithm

isSupervised

getTargetNodeName

isValid