hex.tree

Class BranchInteractionConstraints

java.lang.Object

water.Iced<BranchInteractionConstraints>

hex.tree.BranchInteractionConstraints

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<BranchInteractionConstraints>

public class BranchInteractionConstraints
extends water.Iced<BranchInteractionConstraints>

Local branch interaction constraints class to save information about allowed interaction between columns indices

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BranchInteractionConstraints(water.util.IcedHashSet<water.util.IcedInt> allowedInteractionIndices)

Method Summary

Modifier and Type	Method and Description
water.util.IcedHashSet<water.util.IcedInt>	intersection(water.util.IcedHashSet<water.util.IcedInt> set) Important method to decide which indices are allowed for the next level of constraints.
boolean	isAllowedIndex(int i)
BranchInteractionConstraints	nextLevelInteractionConstraints(GlobalInteractionConstraints ics, int colIndex) Decide which column indices is allowed to be used for the next split in the next level of a tree.

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchInteractionConstraints

public BranchInteractionConstraints(water.util.IcedHashSet<water.util.IcedInt> allowedInteractionIndices)

Method Detail

isAllowedIndex

public boolean isAllowedIndex(int i)

intersection

public water.util.IcedHashSet<water.util.IcedInt> intersection(water.util.IcedHashSet<water.util.IcedInt> set)

Important method to decide which indices are allowed for the next level of constraints. It makes intersection between current allowed indices and input indices to make sure the local constraint satisfy the global interaction constraints setting.

Parameters:

set - input set

Returns:

intersection of branch set and input set

nextLevelInteractionConstraints

public BranchInteractionConstraints nextLevelInteractionConstraints(GlobalInteractionConstraints ics,
                                                                    int colIndex)

Decide which column indices is allowed to be used for the next split in the next level of a tree.

Parameters:

ics - global interaction constraint object generated from input interaction constraints

colIndex - column index of the split to decide allowed indices for the next level of constraint

Returns:

new branch interaction object for the next level of the tree