org.rosuda.ibase
Class SVarInt

java.lang.Object
  org.rosuda.ibase.Notifier
      org.rosuda.ibase.SVar
          org.rosuda.ibase.SVarInt

public class SVarInt
extends SVar

SVar implementation for ed-length ints variable

Field Summary

int[]

cont the actual content

Fields inherited from class org.rosuda.ibase.SVar

cacheRanks, cat, contentsType, CT_Map, CT_Number, CT_String, CT_Tree, double_NA, guessing, int_NA, isnum, IVT_Derived, IVT_Index, IVT_LeafID, IVT_Misclass, IVT_Normal, IVT_Prediction, IVT_RCC, IVT_Resid, IVT_ResidStat1, IVT_ResidStat2, linked, max, min, missingCat, missingCount, name, selected, seq, SM_lexi, SM_num, tag

Constructor Summary

SVarInt(java.lang.String Name, int len)
construct new variable

SVarInt(java.lang.String Name, int[] d)

SVarInt(java.lang.String Name, int[] d, boolean copyContents)

Method Summary

boolean	add(double d)
boolean	add(int d)
boolean	add(java.lang.Object o) adds a new case to the variable (NEVER use addElement!
java.lang.String	asS(int i)
java.lang.Object	at(int i)
double	atD(int i)
double	atF(int i)
int	atI(int i)
void	categorize(boolean rebuild) define the variable explicitely as categorical
void	dropCat() define the variable explicitely as non-categorial (drop category list)
java.lang.Object	getCatAt(int i) returns the category with index ID or null if variable is not categorial
java.lang.Object[]	getCategories() returns new, ed array of categories
int	getCatIndex(int i) returns ID of the category of i-th case in the variable or -1 if i oob
int	getCatIndex(java.lang.Object o) returns the ID of the category of the object
int	getNumCats() returns the number of categories for this variable or 0 if the variable is not categorial
int[]	getRanked(SMarker m, int markspec) returns list of indexes ordered by rank, for non-cat, num vars only. missing values are omitted.
int	getSizeCat(java.lang.Object o) returns size of the category o.
int	getSizeCatAt(int i) returns size of the category with index ID or -1 if variable is not categorial or index oob
boolean	hasEqualContents(int[] c2)
boolean	insert(java.lang.Object o, int index) inserts a new case to the variable at specified index. the exact behavior is implementation-dependent.
boolean	remove(int index) we don't support replace [[ME: replace needs to re-alloc the vector or something like that ... ]]
boolean	replace(int i, int d)
boolean	replace(int i, java.lang.Object o) replaces an element at specified position - use with care!.
boolean	replaceAll(int[] d)
void	setCategorical(boolean nc) define the type of the variable. note that setting nc to false does not necessarily drop categories information. this method should be used for quick toggling of the variable type
int	size() returns the size (number of cases) of the variable
void	sortCategories(int method) sort categories by specifeid method
java.lang.String	toString()

Methods inherited from class org.rosuda.ibase.SVar

atS, categorize, elementAt, filterRanksByID, filterRanksByMap, getContentsType, getInternalType, getMax, getMin, getMissingCount, getName, getNotifier, getRanked, hasMissing, insert, insert, isCat, isEmpty, isInternal, isMissingAt, isNA, isNA, isNum, isSelected, mainSeq, replace, setAllEmpty, setContentsType, setInternalType, setName, setSelected, setSeq, sortCategories

Methods inherited from class org.rosuda.ibase.Notifier

addDepend, beginBatch, delDepend, endBatch, NotifyAll, NotifyAll, NotifyAll, NotifyAll, startCascadedNotifyAll

Methods inherited from class java.lang.Object

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

Field Detail

cont

public int[] cont

the actual content

Constructor Detail

SVarInt

public SVarInt(java.lang.String Name,
               int len)

construct new variable

Parameters:

Name - variable name

len - length of the ed variable

SVarInt

public SVarInt(java.lang.String Name,
               int[] d)

SVarInt

public SVarInt(java.lang.String Name,
               int[] d,
               boolean copyContents)

Method Detail

size

public int size()

Description copied from class: SVar

returns the size (number of cases) of the variable

Specified by:

size in class SVar

categorize

public void categorize(boolean rebuild)

define the variable explicitely as categorical

Specified by:

categorize in class SVar

Parameters:

rebuild - if set to true force rebuild even if the variable is already categorial.

sortCategories

public void sortCategories(int method)

sort categories by specifeid method

Specified by:

sortCategories in class SVar

Parameters:

method - sort method, see SM_xxx constants

dropCat

public void dropCat()

define the variable explicitely as non-categorial (drop category list)

Specified by:

dropCat in class SVar

setCategorical

public void setCategorical(boolean nc)

Description copied from class: SVar

define the type of the variable. note that setting nc to false does not necessarily drop categories information. this method should be used for quick toggling of the variable type

Overrides:

setCategorical in class SVar

add

public boolean add(java.lang.Object o)

adds a new case to the variable (NEVER use addElement! see package header) Also beware, categorial varaibles are classified by object not by value!

Specified by:

add in class SVar

Parameters:

o - object to be added. First call to add (even implicit if an object was specified on the call to the constructor) does also decide whether the variable will be numeric or not. If the first object is a subclass of Number then the variable is defined as numeric. There is a significant difference in handling numeric and non-numeric variabels, see package header.

Returns:

true if element was successfully added, or false upon failure - currently when non-numerical value is inserted in a numerical variable. It is strongly recommended to check the result and act upon it, because failing to do so can result in non-consistent datasets - i.e. mismatched row IDs

add

public boolean add(double d)

Overrides:

add in class SVar

add

public boolean add(int d)

Overrides:

add in class SVar

replace

public boolean replace(int i,
                       java.lang.Object o)

replaces an element at specified position - use with care!. this doesn't work for categorical variables. in that case you need to dropCat(), make modifications and categorize(). also numerical variables only "grow" their min/max - i.e. if min/max was the removed element, then min/max is not adapted to shrink the range

Specified by:

replace in class SVar

replace

public boolean replace(int i,
                       int d)

Overrides:

replace in class SVar

replaceAll

public boolean replaceAll(int[] d)

at

public java.lang.Object at(int i)

Specified by:

at in class SVar

atD

public double atD(int i)

Overrides:

atD in class SVar

atF

public double atF(int i)

Overrides:

atF in class SVar

atI

public int atI(int i)

Overrides:

atI in class SVar

asS

public java.lang.String asS(int i)

getCatIndex

public int getCatIndex(java.lang.Object o)

returns the ID of the category of the object

Specified by:

getCatIndex in class SVar

Parameters:

object -

Returns:

category ID

getCatIndex

public int getCatIndex(int i)

returns ID of the category of i-th case in the variable or -1 if i oob

Overrides:

getCatIndex in class SVar

getCatAt

public java.lang.Object getCatAt(int i)

returns the category with index ID or null if variable is not categorial

Specified by:

getCatAt in class SVar

getSizeCatAt

public int getSizeCatAt(int i)

returns size of the category with index ID or -1 if variable is not categorial or index oob

Specified by:

getSizeCatAt in class SVar

getSizeCat

public int getSizeCat(java.lang.Object o)

returns size of the category o. If category does not exist or variable is not categorial, -1 is returned.

Specified by:

getSizeCat in class SVar

getNumCats

public int getNumCats()

returns the number of categories for this variable or 0 if the variable is not categorial

Specified by:

getNumCats in class SVar

getCategories

public java.lang.Object[] getCategories()

returns new, ed array of categories

Specified by:

getCategories in class SVar

remove

public boolean remove(int index)

we don't support replace [[ME: replace needs to re-alloc the vector or something like that ... ]]

Specified by:

remove in class SVar

insert

public boolean insert(java.lang.Object o,
                      int index)

Description copied from class: SVar

inserts a new case to the variable at specified index. the exact behavior is implementation-dependent.

Specified by:

insert in class SVar

getRanked

public int[] getRanked(SMarker m,
                       int markspec)

returns list of indexes ordered by rank, for non-cat, num vars only. missing values are omitted.

Specified by:

getRanked in class SVar

Parameters:

v - variable (should be obtained by at(..))

m - marker to use for filtering. if null all cases will be checked

markspec - mark for filtering, i.e. cases with that mark will be used only

Returns:

list of indexes or null is any of the following cases: variable is not numerical or is categorical, no cases matching specification are present

hasEqualContents

public boolean hasEqualContents(int[] c2)

toString

public java.lang.String toString()

Overrides:

toString in class SVar