smile.data

Class NominalAttribute

java.lang.Object

smile.data.Attribute

smile.data.NominalAttribute

public class NominalAttribute
extends Attribute

Nominal attribute. Nominal attributes are defined on a list of the unordered values.

Author:

Haifeng Li

Nested Class Summary

Nested classes/interfaces inherited from class smile.data.Attribute

Attribute.Type

Field Summary

Fields inherited from class smile.data.Attribute

description, name, type, weight

Constructor Summary

Constructors

Constructor and Description
NominalAttribute(String name) Constructor.
NominalAttribute(String name, double weight) Constructor.
NominalAttribute(String name, double weight, String[] values) Constructor.
NominalAttribute(String name, String description) Constructor.
NominalAttribute(String name, String[] values) Constructor.
NominalAttribute(String name, String description, double weight) Constructor.
NominalAttribute(String name, String description, double weight, String[] values) Constructor.
NominalAttribute(String name, String description, String[] values) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isOpen() Returns true if the string values of the nominal attribute is a open set.
void	setOpen(boolean open) Sets if the string values of the nominal attribute is a open set.
int	size() Returns the number of nominal values.
String	toString(double x) Returns the string representation of a double value of this attribute.
double	valueOf(String s) Returns the ordinal value of a string value.
String[]	values() Returns the string values of nominal attribute.

Methods inherited from class smile.data.Attribute

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NominalAttribute

public NominalAttribute(String name)

Constructor.

Parameters:

name - the name of attribute.

NominalAttribute

public NominalAttribute(String name,
                double weight)

Constructor.

Parameters:

name - the name of attribute.

NominalAttribute

public NominalAttribute(String name,
                String description)

Constructor.

Parameters:

name - the name of attribute.

description - the detailed description of attribute.

NominalAttribute

public NominalAttribute(String name,
                String description,
                double weight)

Constructor.

Parameters:

name - the name of attribute.

description - the detailed description of attribute.

NominalAttribute

public NominalAttribute(String name,
                String[] values)

Constructor.

Parameters:

name - the name of attribute.

values - the valid string values of nominal attribute.

NominalAttribute

public NominalAttribute(String name,
                double weight,
                String[] values)

Constructor.

Parameters:

name - the name of attribute.

values - the valid string values of nominal attribute.

NominalAttribute

public NominalAttribute(String name,
                String description,
                String[] values)

Constructor.

Parameters:

name - the name of attribute.

description - the detailed description of attribute.

values - the valid string values of nominal attribute.

NominalAttribute

public NominalAttribute(String name,
                String description,
                double weight,
                String[] values)

Constructor.

Parameters:

name - the name of attribute.

description - the detailed description of attribute.

values - the valid string values of nominal attribute.

Method Detail

size

public int size()

Returns the number of nominal values.

Returns:

the number of nominal values

isOpen

public boolean isOpen()

Returns true if the string values of the nominal attribute is a open set. The new string values will be added into the attribute when calling the method valueOf(String).

Returns:

true if the string values of the nominal attribute is a open set.

setOpen

public void setOpen(boolean open)

Sets if the string values of the nominal attribute is a open set.

Parameters:

open - true if the string values of the nominal attribute is a open set.

values

public String[] values()

Returns the string values of nominal attribute.

valueOf

public double valueOf(String s)
               throws ParseException

Returns the ordinal value of a string value.

Specified by:

valueOf in class Attribute

Parameters:

s - a string value of this attribute.

Throws:

ParseException

toString

public String toString(double x)

Description copied from class: Attribute

Returns the string representation of a double value of this attribute.

Specified by:

toString in class Attribute

Parameters:

x - a double value of this attribute. NaN means missing value.

Returns:

the string representation of x. For nominal, date and string attributes, null will be returned for missing values. For numeric attributes, "NaN" will be returned for missing values.