jsat.classifiers

Class CategoricalData

java.lang.Object

jsat.classifiers.CategoricalData

All Implemented Interfaces:

Serializable, Cloneable

public class CategoricalData
extends Object
implements Cloneable, Serializable

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CategoricalData(int n)

Method Summary

Modifier and Type	Method and Description
CategoricalData	clone()
static CategoricalData[]	copyOf(CategoricalData[] orig)
String	getCategoryName()
int	getNumOfCategories()
String	getOptionName(int i)
boolean	isValidCategory(int i) Returns true if the given input is a valid category index for this object.
void	setCategoryName(String categoryName)
boolean	setOptionName(String name, int i) Sets the name of one of the value options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoricalData

public CategoricalData(int n)

Parameters:

n - the number of categories

Method Detail

getNumOfCategories

public int getNumOfCategories()

Returns:

the number of possible categories there are for this category

isValidCategory

public boolean isValidCategory(int i)

Returns true if the given input is a valid category index for this object. Missing values (negative categories) do not count.

Parameters:

i - the index for a category in this object

Returns:

true if it was a valid category, false otherwise.

getOptionName

public String getOptionName(int i)

getCategoryName

public String getCategoryName()

setCategoryName

public void setCategoryName(String categoryName)

setOptionName

public boolean setOptionName(String name,
                             int i)

Sets the name of one of the value options. Duplicate names are not allowed. Trying to set the name of a non existent option will result in false being returned.
All names will be converted to lower case

Parameters:

name - the name to give

i - the ith index to set.

Returns:

true if the name was set. False if the name could not be set.

clone

public CategoricalData clone()

Overrides:

clone in class Object

copyOf

public static CategoricalData[] copyOf(CategoricalData[] orig)