java.lang.Object
- com.bayesserver.learning.structure.ClusteringStructuralLearningOptions

All Implemented Interfaces:

StructuralLearningOptions
```
public final class ClusteringStructuralLearningOptions
extends Object
implements StructuralLearningOptions
```
Options for structural learning with the com.bayesserver.learning.structure.clustering.ClusteringStructuralLearning class.

Constructor Summary

Constructors
Constructor Description

ClusteringStructuralLearningOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Cancellation`	`getCancellation()`	Gets of sets the instance implementing `Cancellation`, used for cancellation.
`String`	`getClusterVariableName()`	Gets the name of the cluster/latent node/variable created when more than 1 hidden state is detected.
`InferenceFactory`	`getInferenceFactory()`	Gets the inference factory used during scoring.
`LinkConstraintCollection`	`getLinkConstraints()`	Gets any link constraints to use during structural learning.
`Integer`	`getMaximumClusterCount()`	Gets the maximum number of clusters generated.
`Integer`	`getMaximumIterations()`	Gets the maximum number of iterations used by parameter learning to score each configuration.
`Integer`	`getPartitions()`	Gets the number of cross validation partitions to use when scoring each cluster count.
`StructuralLearningProgress`	`getProgress()`	Gets of sets the instance implementing `StructuralLearningProgress`, used for progress notifications.
`Integer`	`getRunsPerConfiguration()`	Gets the number of times training is re-run for each network structure tested.
`Stop`	`getStopping()`	Gets the instance implementing `Stop` used for early stopping.
`boolean`	`getTestSingleCluster()`	Gets a value which determines whether a test is performed for a single cluster (i.e.
`void`	`setCancellation(Cancellation value)`	Gets of sets the instance implementing `Cancellation`, used for cancellation.
`void`	`setClusterVariableName(String value)`	Sets the name of the cluster/latent node/variable created when more than 1 hidden state is detected.
`void`	`setInferenceFactory(InferenceFactory value)`	Sets the inference factory used during scoring.
`void`	`setMaximumClusterCount(Integer value)`	Sets the maximum number of clusters generated.
`void`	`setMaximumIterations(Integer value)`	Sets the maximum number of iterations used by parameter learning to score each configuration.
`void`	`setPartitions(Integer value)`	Sets the number of cross validation partitions to use when scoring each cluster count.
`void`	`setProgress(StructuralLearningProgress value)`	Gets of sets the instance implementing `StructuralLearningProgress`, used for progress notifications.
`void`	`setRunsPerConfiguration(Integer value)`	Sets the number of times training is re-run for each network structure tested.
`void`	`setStopping(Stop value)`	Sets the instance implementing `Stop` used for early stopping.
`void`	`setTestSingleCluster(boolean value)`	Sets a value which determines whether a test is performed for a single cluster (i.e.

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

- Constructor Detail
  - ClusteringStructuralLearningOptions
```
public ClusteringStructuralLearningOptions()
```
- Method Detail
  - getInferenceFactory
```
public InferenceFactory getInferenceFactory()
```
    Gets the inference factory used during scoring.
  - setInferenceFactory
```
public void setInferenceFactory(InferenceFactory value)
```
    Sets the inference factory used during scoring.
  - getRunsPerConfiguration
```
public Integer getRunsPerConfiguration()
```
    Gets the number of times training is re-run for each network structure tested. The higher the number, the longer the tests will take, but the more accurate the tests will be.
  - setRunsPerConfiguration
```
public void setRunsPerConfiguration(Integer value)
```
    Sets the number of times training is re-run for each network structure tested. The higher the number, the longer the tests will take, but the more accurate the tests will be.
  - getClusterVariableName
```
public String getClusterVariableName()
```
    Gets the name of the cluster/latent node/variable created when more than 1 hidden state is detected.
  - setClusterVariableName
```
public void setClusterVariableName(String value)
```
    Sets the name of the cluster/latent node/variable created when more than 1 hidden state is detected.
  - getPartitions
```
public Integer getPartitions()
```
    Gets the number of cross validation partitions to use when scoring each cluster count. The higher the number, the longer the tests will take.
  - setPartitions
```
public void setPartitions(Integer value)
```
    Sets the number of cross validation partitions to use when scoring each cluster count. The higher the number, the longer the tests will take.
  - getMaximumIterations
```
public Integer getMaximumIterations()
```
    Gets the maximum number of iterations used by parameter learning to score each configuration. The higher the number, the longer the tests will take.
  - setMaximumIterations
```
public void setMaximumIterations(Integer value)
```
    Sets the maximum number of iterations used by parameter learning to score each configuration. The higher the number, the longer the tests will take.
  - getProgress
```
public StructuralLearningProgress getProgress()
```
    Gets of sets the instance implementing StructuralLearningProgress, used for progress notifications.
    
    Specified by:
    
    getProgress in interface StructuralLearningOptions
  - setProgress
```
public void setProgress(StructuralLearningProgress value)
```
    Gets of sets the instance implementing StructuralLearningProgress, used for progress notifications.
    
    Specified by:
    
    setProgress in interface StructuralLearningOptions
  - getStopping
```
public Stop getStopping()
```
    Gets the instance implementing Stop used for early stopping. Stopping is different to cancellation, as stopping will still complete the learning process, albeit having not run to completion.
    
    Specified by:
    
    getStopping in interface StructuralLearningOptions
    
    Returns:
    
    The instance used for stopping.
  - setStopping
```
public void setStopping(Stop value)
```
    Sets the instance implementing Stop used for early stopping. Stopping is different to cancellation, as stopping will still complete the learning process, albeit having not run to completion.
    
    Specified by:
    
    setStopping in interface StructuralLearningOptions
    
    Parameters:
    
    value - The instance used for stopping.
  - getCancellation
```
public Cancellation getCancellation()
```
    Gets of sets the instance implementing Cancellation, used for cancellation.
    
    Specified by:
    
    getCancellation in interface StructuralLearningOptions
    
    See Also:
    
    Cancellation
  - setCancellation
```
public void setCancellation(Cancellation value)
```
    Gets of sets the instance implementing Cancellation, used for cancellation.
    
    Specified by:
    
    setCancellation in interface StructuralLearningOptions
    
    See Also:
    
    Cancellation
  - getLinkConstraints
```
public LinkConstraintCollection getLinkConstraints()
```
    Gets any link constraints to use during structural learning.
    
    Specified by:
    
    getLinkConstraints in interface StructuralLearningOptions
  - getMaximumClusterCount
```
public Integer getMaximumClusterCount()
```
    Gets the maximum number of clusters generated.
  - setMaximumClusterCount
```
public void setMaximumClusterCount(Integer value)
```
    Sets the maximum number of clusters generated.
  - getTestSingleCluster
```
public boolean getTestSingleCluster()
```
    Gets a value which determines whether a test is performed for a single cluster (i.e. no significant clusters found).
  - setTestSingleCluster
```
public void setTestSingleCluster(boolean value)
```
    Sets a value which determines whether a test is performed for a single cluster (i.e. no significant clusters found).

Class ClusteringStructuralLearningOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusteringStructuralLearningOptions

Method Detail

getInferenceFactory

setInferenceFactory

getRunsPerConfiguration

setRunsPerConfiguration

getClusterVariableName

setClusterVariableName

getPartitions

setPartitions

getMaximumIterations

setMaximumIterations

getProgress

setProgress

getStopping

setStopping

getCancellation

setCancellation

getLinkConstraints

getMaximumClusterCount

setMaximumClusterCount

getTestSingleCluster

setTestSingleCluster