smile.data

Class Attribute

java.lang.Object

smile.data.Attribute

Direct Known Subclasses:

DateAttribute, NominalAttribute, NumericAttribute, StringAttribute

public abstract class Attribute
extends Object

Generic class to represent a named attribute/variable.

Author:

Haifeng Li

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attribute.Type The type of attributes.

Field Summary

Fields

Modifier and Type	Field and Description
String	description The detailed description of the attribute.
String	name The name of attribute.
Attribute.Type	type The type of attribute.
double	weight Optional weight of this attribute.

Constructor Summary

Constructors

Constructor and Description
Attribute(Attribute.Type type, String name) Constructor.
Attribute(Attribute.Type type, String name, double weight) Constructor.
Attribute(Attribute.Type type, String name, String description) Constructor.
Attribute(Attribute.Type type, String name, String description, double weight) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
String	toString()
abstract String	toString(double x) Returns the string representation of a double value of this attribute.
abstract double	valueOf(String s) Returns the double value of a string of this attribute.

Methods inherited from class java.lang.Object

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

Field Detail

type

public final Attribute.Type type

The type of attribute.

weight

public final double weight

Optional weight of this attribute. By default, it is 1.0. The particular meaning of weight depends on applications and machine learning algorithms. Although there are on explicit requirements on the weights, in general, they should be positive.

name

public final String name

The name of attribute.

description

public final String description

The detailed description of the attribute.

Constructor Detail

Attribute

public Attribute(Attribute.Type type,
         String name)

Constructor.

Attribute

public Attribute(Attribute.Type type,
         String name,
         double weight)

Constructor.

Attribute

public Attribute(Attribute.Type type,
         String name,
         String description)

Constructor.

Attribute

public Attribute(Attribute.Type type,
         String name,
         String description,
         double weight)

Constructor.

Method Detail

toString

public abstract String toString(double x)

Returns the string representation of a double value of this 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.

valueOf

public abstract double valueOf(String s)
                        throws ParseException

Returns the double value of a string of this attribute.

Parameters:

s - a string value of this attribute.

Throws:

ParseException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object