org.datavec.api.transform.sequence.window

Interface WindowFunction

All Superinterfaces:

Serializable

All Known Implementing Classes:

OverlappingTimeWindowFunction, TimeWindowFunction

public interface WindowFunction
extends Serializable

A WindowFunction splits a sequence into a set of (possibly overlapping) sub-sequences. It is a general-purpose interface that can support many different types of Typically used for example with a transform such as ReduceSequenceByWindowTransform

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
List<List<List<Writable>>>	applyToSequence(List<List<Writable>> sequence) Apply the windowing function to the given sequence
Schema	getInputSchema()
void	setInputSchema(Schema schema)
Schema	transform(Schema inputSchema) Get the output schema, given the input schema.

Method Detail

applyToSequence

List<List<List<Writable>>> applyToSequence(List<List<Writable>> sequence)

Apply the windowing function to the given sequence

Parameters:

sequence - the input sequence

Returns:

the sequence with the window function applied

setInputSchema

void setInputSchema(Schema schema)

Parameters:

schema -

getInputSchema

Schema getInputSchema()

Returns:

transform

Schema transform(Schema inputSchema)

Get the output schema, given the input schema. Typically the output schema is the same as the input schema, but not necessarily (for example, if the window function adds columns for the window start/end times)

Parameters:

inputSchema - Schema of the input data

Returns:

Schema of the output windows