hex.createframe.postprocess

Class ShuffleColumnsCfps

java.lang.Object

water.Iced<CreateFramePostprocessStep>

hex.createframe.CreateFramePostprocessStep

hex.createframe.postprocess.ShuffleColumnsCfps

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<CreateFramePostprocessStep>

public class ShuffleColumnsCfps
extends CreateFramePostprocessStep

Action to shuffle the columns of the frame.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ShuffleColumnsCfps()
ShuffleColumnsCfps(boolean reassignNames, boolean responseFirst)

Method Summary

Modifier and Type	Method and Description
void	exec(Frame fr, java.util.Random rng) This method performs the actual work of the postprocessing task.
static java.lang.String	removeNumericSuffix(java.lang.String name) Helper function which strips the provided name from any numeric suffix in the end.

Methods inherited from class hex.createframe.CreateFramePostprocessStep

workAmount

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

ShuffleColumnsCfps

public ShuffleColumnsCfps()

ShuffleColumnsCfps

public ShuffleColumnsCfps(boolean reassignNames,
                          boolean responseFirst)

Parameters:

reassignNames - If true, the columns will be renamed within each group starting with a common alpha-prefix. I.e. if the original frame had columns [A1, A3, B2, B5] then after shuffling it may look like this: [B1, A1, A2, B2]. In this new frame column "A1" may have been either "A1" or "A3" in the original frame. If false, each vec will keep its name.

responseFirst - If true, the "response" column will be moved to the beginning of the frame. Otherwise it will be shuffled together with the rest of the columns.

Method Detail

exec

public void exec(Frame fr,
                 java.util.Random rng)

Description copied from class: CreateFramePostprocessStep

This method performs the actual work of the postprocessing task.

Specified by:

exec in class CreateFramePostprocessStep

Parameters:

fr - Frame that the task modifies.

rng - Random number generator to use if the task needs to modify the frame randomly.

removeNumericSuffix

public static java.lang.String removeNumericSuffix(java.lang.String name)

Helper function which strips the provided name from any numeric suffix in the end. Equivalent to name.rstrip("0123456789") in Python.