hex

Class FrameSplitter

java.lang.Object

jsr166y.ForkJoinTask<java.lang.Void>

jsr166y.CountedCompleter

water.H2O.H2OCountedCompleter

hex.FrameSplitter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.concurrent.Future<java.lang.Void>

public class FrameSplitter
extends H2O.H2OCountedCompleter

Frame splitter function to divide given frame into multiple partitions based on given ratios.

The task creates ratios.length+1 output frame each containing a demanded fraction of rows from source dataset

The task internally processes each chunk of each column of source dataset and extract i-th fraction of chunk rows into output chunk. The task does not shuffle rows inside the tasks, nevertheless it would be possible.

Assumptions and invariants

• number of demanding split parts is reasonable number, i.e., <10. The task is not designed to split into many small parts.
• the worker preserves distribution of new chunks over the cloud according to source dataset chunks.
• rows inside one chunk are not shuffled, they are extracted deterministically in the same order based on output part index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FrameSplitter(Frame dataset, float[] ratios)
FrameSplitter(Frame dataset, float[] ratios, Key[] destKeys, Key jobKey, long seed)
FrameSplitter(Frame dataset, float[] ratios, long seed)

Method Summary

Methods

Modifier and Type	Method and Description
void	compute2()
Frame[]	getResult()
void	onCompletion(jsr166y.CountedCompleter caller) Performs an action when method CountedCompleter.tryComplete() is invoked and there are no pending counts, or when the unconditional method CountedCompleter.complete(java.lang.Void) is invoked.
boolean	onExceptionalCompletion(java.lang.Throwable ex, jsr166y.CountedCompleter caller) Performs an action when method ForkJoinTask.completeExceptionally(java.lang.Throwable) is invoked or method CountedCompleter.compute() throws an exception, and this task has not otherwise already completed normally.

Methods inherited from class water.H2O.H2OCountedCompleter

clone, compute, priority

Methods inherited from class jsr166y.CountedCompleter

addToPendingCount, compareAndSetPendingCount, complete, exec, getCompleter, getPendingCount, getRawResult, setCompleter, setPendingCount, setRawResult, tryComplete

Methods inherited from class jsr166y.ForkJoinTask

adapt, adapt, adapt, cancel, compareAndSetForkJoinTaskTag, completeExceptionally, fork, get, get, getException, getForkJoinTaskTag, getPool, getQueuedTaskCount, getSurplusQueuedTaskCount, helpQuiesce, inForkJoinPool, invoke, invokeAll, invokeAll, invokeAll, isCancelled, isCompletedAbnormally, isCompletedNormally, isDone, join, peekNextLocalTask, pollNextLocalTask, pollTask, quietlyComplete, quietlyInvoke, quietlyJoin, reinitialize, setForkJoinTaskTag, tryUnfork

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameSplitter

public FrameSplitter(Frame dataset,
             float[] ratios)

FrameSplitter

public FrameSplitter(Frame dataset,
             float[] ratios,
             long seed)

FrameSplitter

public FrameSplitter(Frame dataset,
             float[] ratios,
             Key[] destKeys,
             Key jobKey,
             long seed)

Method Detail

compute2

public void compute2()

Specified by:

compute2 in class H2O.H2OCountedCompleter

onCompletion

public void onCompletion(jsr166y.CountedCompleter caller)

Description copied from class: jsr166y.CountedCompleter

Performs an action when method CountedCompleter.tryComplete() is invoked and there are no pending counts, or when the unconditional method CountedCompleter.complete(java.lang.Void) is invoked. By default, this method does nothing.

Overrides:

onCompletion in class jsr166y.CountedCompleter

Parameters:

caller - the task invoking this method (which may be this task itself).

onExceptionalCompletion

public boolean onExceptionalCompletion(java.lang.Throwable ex,
                              jsr166y.CountedCompleter caller)

Description copied from class: jsr166y.CountedCompleter

Performs an action when method ForkJoinTask.completeExceptionally(java.lang.Throwable) is invoked or method CountedCompleter.compute() throws an exception, and this task has not otherwise already completed normally. On entry to this method, this task ForkJoinTask.isCompletedAbnormally(). The return value of this method controls further propagation: If true and this task has a completer, then this completer is also completed exceptionally. The default implementation of this method does nothing except return true.

Overrides:

onExceptionalCompletion in class H2O.H2OCountedCompleter

Parameters:

ex - the exception

caller - the task invoking this method (which may be this task itself).

Returns:

true if this exception should be propagated to this tasks completer, if one exists.

getResult

public Frame[] getResult()