hex

Class Model.InteractionPair

java.lang.Object

water.Iced<Model.InteractionPair>

hex.Model.InteractionPair

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<Model.InteractionPair>

Enclosing class:

Model<M extends Model<M,P,O>,P extends Model.Parameters,O extends Model.Output>

public static class Model.InteractionPair
extends Iced<Model.InteractionPair>

This class represents a pair of interacting columns plus some additional data about specific enums to be interacted when the vecs are categorical. The question naturally arises why not just use something like an ArrayList of int[2] (as is done, for example, in the Interaction/CreateInteraction classes) and the answer essentially boils down a desire to specify these specific levels. Another difference with the CreateInteractions class: 1. do not interact on NA (someLvl_NA and NA_somLvl are actual NAs) this does not appear here, but in the InteractionWrappedVec class TODO: refactor the CreateInteractions to be useful here and in InteractionWrappedVec

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_name1
java.lang.String	_name2

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static Model.InteractionPair[]	generatePairwiseInteractionsFromList(Frame f, int... indexes) Generate all pairwise combinations of the arguments.
int	getV1()
int	getV2()
int	hashCode()
boolean	isNumeric()
boolean	needsAllFactorLevels() Indicates that Interaction should be created from all factor levels (regardless of the global setting useAllFactorLevels).
void	setNeedsAllFactorLevels(boolean needsAllFactorLevels)
java.lang.String	toString()

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_name1

public final java.lang.String _name1

_name2

public final java.lang.String _name2

Method Detail

needsAllFactorLevels

public boolean needsAllFactorLevels()

Indicates that Interaction should be created from all factor levels (regardless of the global setting useAllFactorLevels).

Returns:

do we need to make all factor levels?

setNeedsAllFactorLevels

public void setNeedsAllFactorLevels(boolean needsAllFactorLevels)

generatePairwiseInteractionsFromList

public static Model.InteractionPair[] generatePairwiseInteractionsFromList(Frame f,
                                                                           int... indexes)

Generate all pairwise combinations of the arguments.

Parameters:

indexes - An array of column indices.

Returns:

An array of interaction pairs

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getV1

public int getV1()

getV2

public int getV2()

isNumeric

public boolean isNumeric()