water.fvec

Class Frame

java.lang.Object

water.Iced

water.Keyed

water.Lockable

water.fvec.Frame

All Implemented Interfaces:

java.lang.Cloneable, Freezable

public class Frame
extends Lockable

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

_lockers

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
Frame(Frame fr)
Frame(Key key)
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)
Vec	add(java.lang.String name, Vec vec)
Vec	add(Vec vec)
Vec	anyVec() Returns the first readable vector.
long	byteSize()
boolean	checkCompatible(Frame fr)
Frame	deepcopy()
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)
int	find(java.lang.String name) Finds the first column with a matching name.
int	find(Vec vec)
Vec	lastVec()
java.lang.String[]	names()
int	numCols()
long	numRows()
Futures	postWrite(Futures fs)
Vec[]	reloadVecs()
Futures	remove_impl(Futures fs) Actually remove/delete all Vecs from memory, not just from the Frame.
Vec	remove(int idx) Removes a numbered column.
Vec[]	remove(int[] idxs) Removes a numbered column.
Vec	remove(java.lang.String name) Removes the first column with a matching name.
Vec	replace(int col, Vec nv)
boolean[]	strings() true/false whether each Vec is a string
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.
void	swap(int lo, int hi)
byte[]	times() Time status for every Vec
boolean[]	uuids() true/false whether each Vec is a UUID
Vec	vec(int idx) Returns the vector by given index.
Vec	vec(java.lang.String name)
Vec[]	vecs()

Methods inherited from class water.Lockable

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

Methods inherited from class water.Keyed

remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readJSON_impl, readJSON, write_impl, write, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_names

public java.lang.String[] _names

Constructor Detail

Frame

public Frame(Vec... vecs)

Frame

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

Frame

public Frame(Key key)

Frame

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

Frame

public Frame(Frame fr)

Method Detail

add

public Vec add(Vec vec)

add

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

add

public Frame add(Frame fr)

swap

public void swap(int lo,
        int hi)

checkCompatible

public boolean checkCompatible(Frame fr)

deepcopy

public Frame deepcopy()

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

anyVec

public final Vec anyVec()

Returns the first readable vector.

vecs

public final Vec[] vecs()

uuids

public boolean[] uuids()

true/false whether each Vec is a UUID

strings

public boolean[] strings()

true/false whether each Vec is a string

times

public byte[] times()

Time status for every Vec

domains

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

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

names

public java.lang.String[] names()

byteSize

public long byteSize()

postWrite

public Futures postWrite(Futures fs)

remove_impl

public Futures remove_impl(Futures fs)

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

Overrides:

remove_impl in class Keyed

replace

public Vec replace(int col,
          Vec nv)

extractFrame

public Frame extractFrame(int startIdx,
                 int endIdx)

errStr

public java.lang.String errStr()

Specified by:

errStr in class Lockable

numCols

public int numCols()

numRows

public long numRows()

lastVec

public Vec lastVec()

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

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)

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.