Package com.bayesserver.learning.structure

Class TANStructuralLearningOptions

java.lang.Object

com.bayesserver.learning.structure.TANStructuralLearningOptions

All Implemented Interfaces:

StructuralLearningOptions

public final class TANStructuralLearningOptions
extends Object
implements StructuralLearningOptions

Options for structural learning with the com.bayesserver.learning.structure.tan.TANStructuralLearning class.

Constructor Summary

Constructors

Constructor	Description
TANStructuralLearningOptions()

Method Summary

Modifier and Type	Method	Description
Cancellation	getCancellation()	Gets of sets the instance implementing Cancellation, used for cancellation.
LinkConstraintCollection	getLinkConstraints()	Gets any link constraints to use during structural learning.
long	getMaximumBatchSize()	Gets the maximum number of tests that are buffered in memory for processing in a single iteration of the data.
StructuralLearningProgress	getProgress()	Gets of sets the instance implementing StructuralLearningProgress, used for progress notifications.
Node	getRoot()	Gets the root of the TAN tree.
Stop	getStopping()	Gets the instance implementing Stop used for early stopping.
Node	getTarget()	Gets the target of the TAN tree.
void	setCancellation(Cancellation value)	Gets of sets the instance implementing Cancellation, used for cancellation.
void	setMaximumBatchSize(long value)	Sets the maximum number of tests that are buffered in memory for processing in a single iteration of the data.
void	setProgress(StructuralLearningProgress value)	Gets of sets the instance implementing StructuralLearningProgress, used for progress notifications.
void	setRoot(Node value)	Sets the root of the TAN tree.
void	setStopping(Stop value)	Sets the instance implementing Stop used for early stopping.
void	setTarget(Node value)	Sets the target of the TAN tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

TANStructuralLearningOptions

public TANStructuralLearningOptions()

Method Detail

getLinkConstraints

public LinkConstraintCollection getLinkConstraints()

Gets any link constraints to use during structural learning.

Specified by:

getLinkConstraints in interface StructuralLearningOptions

getTarget

public Node getTarget()

Gets the target of the TAN tree.

setTarget

public void setTarget(Node value)

Sets the target of the TAN tree.

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

getRoot

public Node getRoot()

Gets the root of the TAN tree. During construction links are directed away from this root. If no root is specified, a root is chosen arbitrarily.

setRoot

public void setRoot(Node value)

Sets the root of the TAN tree. During construction links are directed away from this root. If no root is specified, a root is chosen arbitrarily.

getMaximumBatchSize

public long getMaximumBatchSize()

Gets the maximum number of tests that are buffered in memory for processing in a single iteration of the data. When large numbers of tests are required, instead of exhausting available memory, the tests are performed in batches. This value limits the number of tests that need to be stored in memory.

setMaximumBatchSize

public void setMaximumBatchSize(long value)

Sets the maximum number of tests that are buffered in memory for processing in a single iteration of the data. When large numbers of tests are required, instead of exhausting available memory, the tests are performed in batches. This value limits the number of tests that need to be stored in memory.

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