cs2.introml

Class DenseExample

java.lang.Object

cs2.introml.Example

cs2.introml.DenseExample

All Implemented Interfaces:

TestingExample, java.lang.Iterable<FeatureEntry>

public class DenseExample
extends Example

An array-backed example, useful in situations in which most if not all features are non-zero.

Constructor Summary

Constructors

Constructor and Description
DenseExample(java.lang.Object result, double[] features) Initializes the example using an array of features
DenseExample(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()
DenseExample	setFeature(int featureNumber, double feature) Changes the value of a feature

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

DenseExample

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

Initializes the example with all-zero values

Parameters:

result - result object

numFeatures - number of features

DenseExample

public DenseExample(java.lang.Object result,
                    double[] features)

Initializes the example using an array of features

Parameters:

result - result object

features - features to copy

Method Detail

setFeature

public DenseExample setFeature(int featureNumber,
                               double feature)

Changes the value of a feature

Parameters:

featureNumber - feature index to change

feature - feature value

Returns:

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

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())

iterator

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