smile.data.measure

Class CategoricalMeasure

java.lang.Object

smile.data.measure.CategoricalMeasure

All Implemented Interfaces:

java.io.Serializable, Measure

Direct Known Subclasses:

NominalScale, OrdinalScale

public abstract class CategoricalMeasure
extends java.lang.Object
implements Measure

Categorical data can be stored into groups or categories with the aid of names or labels. Also known as qualitative data, each element of a categorical data can be placed in only one category according to its qualities, where each of the categories is mutually exclusive.

Categorical data may be subdivided into nominal data and ordinal data.

Both integer and string variables can be made into categorical measure, but a categorical measure's levels will always be string values.

See Also:

Serialized Form

Field Summary

Fields inherited from interface smile.data.measure.Measure

Currency, Percent

Constructor Summary

Constructors

Constructor and Description
CategoricalMeasure(int[] values) Constructor.
CategoricalMeasure(int[] values, java.lang.String[] levels) Constructor.
CategoricalMeasure(java.util.List<java.lang.String> levels) Constructor.
CategoricalMeasure(java.lang.String... levels) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	factor(int value) Returns the factor value (in range [0, size)) of level.
java.lang.String	level(int value) Returns the level string representation.
java.lang.String[]	levels() Returns the levels.
int	size() Returns the number of levels.
java.lang.String	toString(int value) Returns the string value of a level.
java.lang.String	toString(java.lang.Object o) Returns the string representation of a value of the measure.
DataType	type() Returns the data type that is suitable for this measure scale.
java.lang.Number	valueOf(java.lang.String s) Returns a measurement value object represented by the argument string s.
int[]	values() Returns the valid value set.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoricalMeasure

public CategoricalMeasure(java.lang.String... levels)

Constructor.

Parameters:

levels - the levels of discrete values.

CategoricalMeasure

public CategoricalMeasure(java.util.List<java.lang.String> levels)

Constructor.

Parameters:

levels - the levels of discrete values.

CategoricalMeasure

public CategoricalMeasure(int[] values)

Constructor.

Parameters:

values - the valid values.

CategoricalMeasure

public CategoricalMeasure(int[] values,
                          java.lang.String[] levels)

Constructor.

Parameters:

values - the valid values.

levels - the levels of discrete values.

Method Detail

size

public int size()

Returns the number of levels.

values

public int[] values()

Returns the valid value set.

levels

public java.lang.String[] levels()

Returns the levels.

level

public java.lang.String level(int value)

Returns the level string representation.

factor

public int factor(int value)

Returns the factor value (in range [0, size)) of level.

type

public DataType type()

Returns the data type that is suitable for this measure scale.

toString

public java.lang.String toString(int value)

Returns the string value of a level.

toString

public java.lang.String toString(java.lang.Object o)

Description copied from interface: Measure

Returns the string representation of a value of the measure.

Specified by:

toString in interface Measure

valueOf

public java.lang.Number valueOf(java.lang.String s)

Description copied from interface: Measure

Returns a measurement value object represented by the argument string s.

Specified by:

valueOf in interface Measure

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object