AutoInsightKLDivergence (bayesserver 11.0 API)

java.lang.Object
- java.lang.Enum<AutoInsightKLDivergence>
- - com.bayesserver.analysis.AutoInsightKLDivergence

All Implemented Interfaces:

Serializable, Comparable<AutoInsightKLDivergence>
```
public enum AutoInsightKLDivergence
extends Enum<AutoInsightKLDivergence>
```
Determines the type of KL divergence calculations, if any, performed during an auto insight analysis.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`NONE`	KL divergence is not calculated during the auto-insight analysis.
`SIMPLE`	When distributions are compared during the auto-insight process, marginal distributions, rather than joint distributions, are compared.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static AutoInsightKLDivergence`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static AutoInsightKLDivergence[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - NONE
```
public static final AutoInsightKLDivergence NONE
```
    KL divergence is not calculated during the auto-insight analysis.
  - SIMPLE
```
public static final AutoInsightKLDivergence SIMPLE
```
    When distributions are compared during the auto-insight process, marginal distributions, rather than joint distributions, are compared.
- Method Detail
  - values
```
public static AutoInsightKLDivergence[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (AutoInsightKLDivergence c : AutoInsightKLDivergence.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AutoInsightKLDivergence valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null