water.fvec

Class Frame

java.lang.Object

water.Iced

water.Lockable<Frame>

water.fvec.Frame

All Implemented Interfaces:

java.lang.Cloneable, Freezable

public class Frame
extends Lockable<Frame>

A collection of named Vecs. Essentially an R-like data-frame. Multiple Frames can reference the same Vecs. A Frame is a lightweight object, it is meant to be cheaply created and discarded for data munging purposes. E.g. to exclude a Vec from a computation on a Frame, create a new Frame that references all the Vecs but this one.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String[]	_names

Fields inherited from class water.Lockable

_key, _lockers, DOC_FIELDS

Constructor Summary

Constructors

Constructor and Description
Frame(Frame fr)
Frame(Key k)
Frame(Key key, java.lang.String[] names, Vec[] vecs)
Frame(java.lang.String[] names, Vec[] vecs)
Frame(Vec... vecs)

Method Summary

Methods

Modifier and Type	Method and Description
Frame	add(Frame fr, boolean rename)
Frame	add(Frame fr, java.lang.String[] names) Appends an entire Frame
Frame	add(java.lang.String name, Vec vec) Appends a named column, keeping the last Vec as the response
Vec	anyVec() Returns the first readable vector.
long	byteSize()
boolean	checkCompatible() Check that the vectors are all compatible.
void	closeAppendables()
Futures	closeAppendables(Futures fs)
Frame	deepSlice(java.lang.Object orows, java.lang.Object ocols)
Futures	delete_impl(Futures fs) Actually remove/delete all Vecs from memory, not just from the Frame.
java.lang.String[][]	domains() All the domains for enum columns; null for non-enum columns.
java.lang.String	errStr()
Frame	extractFrame(int startIdx, int endIdx)
Vec	factor(int col)
int	find(java.lang.String name) Finds the first column with a matching name.
int	find(Vec vec)
UniqueId	getUniqueId()
byte[]	hash() 64-bit hash of the hashes of the vecs.
boolean	isRawData()
Vec	lastVec()
java.lang.String[]	names()
int	numCols()
int	numExpCols()
long	numRows()
Vec[]	reloadVecs()
Vec	remove(int idx) Removes a numbered column.
Vec[]	remove(int[] idxs) Removes a numbered column.
Vec[]	remove(int startIdx, int endIdx) Remove given interval of columns from frame.
Vec	remove(java.lang.String name) Removes the first column with a matching name.
Vec	replace(int col, Vec nv)
Frame	subframe(int startIdx, int endIdx) Create a subframe from given interval of columns.
Frame	subframe(java.lang.String[] names) Returns a subframe of this frame containing only vectors with desired names.
Frame[]	subframe(java.lang.String[] names, double c) Returns a new frame composed of vectors of this frame selected by given names.
Vec	theVec(java.lang.String err)
java.io.InputStream	toCSV(boolean headers)
java.io.InputStream	toCSV(boolean headers, boolean hex_string)
java.lang.String	toString()
java.lang.String	toString(long idx)
java.lang.StringBuilder	toString(java.lang.StringBuilder sb, java.lang.String[] fs, long idx)
java.lang.String	toStringAll()
java.lang.String[]	toStringHdr(java.lang.StringBuilder sb)
java.lang.String	toStringNames()
Vec	vec(int idx) Returns the vector by given index.
Vec	vec(java.lang.String name)
Vec[]	vecs()
Flow.FlowFilter	with(Flow.Filter fr)
Flow.FlowGroupBy	with(Flow.GroupBy fr)
<Y extends Flow.PerRow<Y>> Flow.FlowPerRow<Y>	with(Flow.PerRow<Y> pr)

Methods inherited from class water.Lockable

delete_and_lock, delete, delete, delete, delete, is_unlocked, is_wlocked, read_lock, read_lock, unlock_all, unlock, update, write_lock

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON, writeJSONFields

Methods inherited from class java.lang.Object

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

Field Detail

_names

public java.lang.String[] _names

Constructor Detail

Frame

public Frame(Key k)

Frame

public Frame(Frame fr)

Frame

public Frame(Vec... vecs)

Frame

public Frame(java.lang.String[] names,
     Vec[] vecs)

Frame

public Frame(Key key,
     java.lang.String[] names,
     Vec[] vecs)

Method Detail

getUniqueId

public UniqueId getUniqueId()

hash

public byte[] hash()

64-bit hash of the hashes of the vecs. SHA-265 hashes of the chunks are XORed together. Since parse always parses the same pieces of files into the same offsets in some chunk this hash will be consistent across reparses.

vec

public Vec vec(java.lang.String name)

vec

public Vec vec(int idx)

Returns the vector by given index.

The call is direct equivalent to call vecs()[i] and it does not do any array bounds checking.

Parameters:

idx - idx of column

Returns:

this frame idx-th vector, never returns null

subframe

public Frame subframe(java.lang.String[] names)

Returns a subframe of this frame containing only vectors with desired names.

Parameters:

names - list of vector names

Returns:

a new frame which collects vectors from this frame with desired names.

Throws:

java.lang.IllegalArgumentException - if there is no vector with desired name in this frame.

subframe

public Frame[] subframe(java.lang.String[] names,
               double c)

Returns a new frame composed of vectors of this frame selected by given names. The method replaces missing vectors by a constant column filled by given value.

Parameters:

names - names of vector to compose a subframe

c - value to fill missing columns.

Returns:

two frames, the first contains subframe, the second contains newly created constant vectors or null

vecs

public final Vec[] vecs()

reloadVecs

public final Vec[] reloadVecs()

find

public int find(java.lang.String name)

Finds the first column with a matching name.

find

public int find(Vec vec)

add

public Frame add(java.lang.String name,
        Vec vec)

Appends a named column, keeping the last Vec as the response

add

public Frame add(Frame fr,
        java.lang.String[] names)

Appends an entire Frame

add

public Frame add(Frame fr,
        boolean rename)

remove

public Vec remove(java.lang.String name)

Removes the first column with a matching name.

remove

public Vec[] remove(int[] idxs)

Removes a numbered column.

remove

public Vec remove(int idx)

Removes a numbered column.

remove

public Vec[] remove(int startIdx,
           int endIdx)

Remove given interval of columns from frame. Motivated by R intervals.

Parameters:

startIdx - - start index of column (inclusive)

endIdx - - end index of column (exclusive)

Returns:

an array of remove columns

replace

public Vec replace(int col,
          Vec nv)

factor

public Vec factor(int col)

extractFrame

public Frame extractFrame(int startIdx,
                 int endIdx)

subframe

public Frame subframe(int startIdx,
             int endIdx)

Create a subframe from given interval of columns.

Parameters:

startIdx - index of first column (inclusive)

endIdx - index of the last column (exclusive)

Returns:

a new frame containing specified interval of columns

names

public final java.lang.String[] names()

numCols

public int numCols()

numRows

public long numRows()

isRawData

public boolean isRawData()

numExpCols

public int numExpCols()

domains

public java.lang.String[][] domains()

All the domains for enum columns; null for non-enum columns.

lastVec

public Vec lastVec()

anyVec

public Vec anyVec()

Returns the first readable vector.

theVec

public final Vec theVec(java.lang.String err)

checkCompatible

public boolean checkCompatible()

Check that the vectors are all compatible. All Vecs have their content sharded using same number of rows per chunk.

closeAppendables

public void closeAppendables()

closeAppendables

public Futures closeAppendables(Futures fs)

delete_impl

public Futures delete_impl(Futures fs)

Actually remove/delete all Vecs from memory, not just from the Frame.

Specified by:

delete_impl in class Lockable<Frame>

errStr

public java.lang.String errStr()

Specified by:

errStr in class Lockable<Frame>

byteSize

public long byteSize()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringNames

public java.lang.String toStringNames()

toString

public java.lang.String toString(long idx)

toStringHdr

public java.lang.String[] toStringHdr(java.lang.StringBuilder sb)

toString

public java.lang.StringBuilder toString(java.lang.StringBuilder sb,
                               java.lang.String[] fs,
                               long idx)

toStringAll

public java.lang.String toStringAll()

toCSV

public java.io.InputStream toCSV(boolean headers)

toCSV

public java.io.InputStream toCSV(boolean headers,
                        boolean hex_string)

deepSlice

public Frame deepSlice(java.lang.Object orows,
              java.lang.Object ocols)

with

public <Y extends Flow.PerRow<Y>> Flow.FlowPerRow<Y> with(Flow.PerRow<Y> pr)

with

public Flow.FlowFilter with(Flow.Filter fr)

with

public Flow.FlowGroupBy with(Flow.GroupBy fr)