cs2.introml

Class SparseExample

java.lang.Object

cs2.introml.Example

cs2.introml.SparseExample

All Implemented Interfaces:

TestingExample, java.lang.Iterable<FeatureEntry>

public class SparseExample
extends Example

Implements an example by storing index/value pairs, useful in situations where many/most of the example features are 0

Constructor Summary

Constructors

Constructor and Description
SparseExample(java.lang.Object result, int numFeatures) Initializes the example with all-zero values

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getFeature(int featureNumber) Gets a feature given its number
java.util.Iterator<FeatureEntry>	iterator()
SparseExample	removeFeature(int featureNumber) Removes the feature.
SparseExample	setFeature(int featureNumber, double value) Changes the value of a feature.
java.lang.Iterable<FeatureEntry>	sparseFeatures() Supports iteration over non-zero features
java.util.Iterator<FeatureEntry>	sparseIterator() Iterator over non-zero features

Methods inherited from class cs2.introml.Example

getNumFeatures, getResult, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SparseExample

public SparseExample(java.lang.Object result,
                     int numFeatures)

Initializes the example with all-zero values

Parameters:

result - result object

numFeatures - number of features

Method Detail

getFeature

public java.lang.Double getFeature(int featureNumber)

Description copied from interface: TestingExample

Gets a feature given its number

Specified by:

getFeature in interface TestingExample

Specified by:

getFeature in class Example

Parameters:

featureNumber - index of the feature

Returns:

feature value, or null if invalid featureNumber (less than 0 or greater-than-or-equal-to getNumFeatures())

setFeature

public SparseExample setFeature(int featureNumber,
                                double value)

Changes the value of a feature. If value is zero, the feature is removed.

Parameters:

featureNumber - feature index to change

value - feature value

Returns:

reference to this example (may be useful for chained calls), null if invalid index

removeFeature

public SparseExample removeFeature(int featureNumber)

Removes the feature. Same as calling setFeature with a 0.0 value.

Parameters:

featureNumber - feature index to remove

Returns:

reference to this example (may be useful for chained calls), null if invalid index

sparseFeatures

public java.lang.Iterable<FeatureEntry> sparseFeatures()

Supports iteration over non-zero features

Returns:

non-zero feature entries

sparseIterator

public java.util.Iterator<FeatureEntry> sparseIterator()

Iterator over non-zero features

Returns:

non-zero feature entries

iterator

public java.util.Iterator<FeatureEntry> iterator()