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

All Implemented Interfaces:

StructuralLearningOptions
```
public final class PCStructuralLearningOptions
extends Object
implements StructuralLearningOptions
```
Options for structural learning with the com.bayesserver.learning.structure.pc.PCStructuralLearning class.

Constructor Summary

Constructors
Constructor Description

PCStructuralLearningOptions()
Initializes a new instance of the com.bayesserver.learning.structure.pc.PCStructuralLearningOptions class.

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.
`IndependenceOptions`	`getIndependence()`	Gets options controlling how the independence tests are carried out.
`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.
`int`	`getMaximumConditional()`	Gets the maximum number of conditional variables to consider during independence testing.
`int`	`getMaximumTemporalOrder()`	Gets the maximum order of temporal links that are considered during learning.
`StructuralLearningProgress`	`getProgress()`	Gets of sets the instance implementing `StructuralLearningProgress`, used for progress notifications.
`Stop`	`getStopping()`	Gets the instance implementing `Stop` used for early stopping.
`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`	`setMaximumConditional(int value)`	Sets the maximum number of conditional variables to consider during independence testing.
`void`	`setMaximumTemporalOrder(int value)`	Sets the maximum order of temporal links that are considered during learning.
`void`	`setProgress(StructuralLearningProgress value)`	Gets of sets the instance implementing `StructuralLearningProgress`, used for progress notifications.
`void`	`setStopping(Stop value)`	Sets the instance implementing `Stop` used for early stopping.

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

- Constructor Detail
  - PCStructuralLearningOptions
```
public PCStructuralLearningOptions()
```
    Initializes a new instance of the com.bayesserver.learning.structure.pc.PCStructuralLearningOptions class.
- Method Detail
  - getLinkConstraints
```
public LinkConstraintCollection getLinkConstraints()
```
    Gets any link constraints to use during structural learning.
    
    Specified by:
    
    getLinkConstraints in interface StructuralLearningOptions
  - 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
  - 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.
  - getMaximumTemporalOrder
```
public int getMaximumTemporalOrder()
```
    Gets the maximum order of temporal links that are considered during learning. When learning Bayesian networks with temporal nodes (time series or sequence nodes) this value tells the algorithm the maximum order or links (sometimes referred to as the lag).
  - setMaximumTemporalOrder
```
public void setMaximumTemporalOrder(int value)
```
    Sets the maximum order of temporal links that are considered during learning. When learning Bayesian networks with temporal nodes (time series or sequence nodes) this value tells the algorithm the maximum order or links (sometimes referred to as the lag).
  - getIndependence
```
public IndependenceOptions getIndependence()
```
    Gets options controlling how the independence tests are carried out.
  - getMaximumConditional
```
public int getMaximumConditional()
```
    Gets the maximum number of conditional variables to consider during independence testing.
    
    Returns:
    
    The maximum number of conditional variables considered.
    Typically a value of 3 is used.
    
    A value of 0 means that only marginal independence tests will be performed.
  - setMaximumConditional
```
public void setMaximumConditional(int value)
```
    Sets the maximum number of conditional variables to consider during independence testing.
    
    Parameters:
    
    value - The maximum number of conditional variables considered.
    Typically a value of 3 is used.
    
    A value of 0 means that only marginal independence tests will be performed.

Class PCStructuralLearningOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PCStructuralLearningOptions

Method Detail

getLinkConstraints

getProgress

setProgress

getStopping

setStopping

getCancellation

setCancellation

getMaximumBatchSize

setMaximumBatchSize

getMaximumTemporalOrder

setMaximumTemporalOrder

getIndependence

getMaximumConditional

setMaximumConditional