cs2.introml

Class Example

java.lang.Object

cs2.introml.Example

All Implemented Interfaces:

TestingExample, java.lang.Iterable<FeatureEntry>

Direct Known Subclasses:

DenseExample, SparseExample

public abstract class Example
extends java.lang.Object
implements java.lang.Iterable<FeatureEntry>, TestingExample

Represents a fixed-size sequence of features with an associated result.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Double	getFeature(int featureNumber) Gets a feature given its number
int	getNumFeatures() Gets the number of features
java.lang.Object	getResult() Gets the example result
java.lang.String	toString() Returns a string representation of the example using the LibSVM format: result (index_A+1):value_A (index_B+1):value_B ...

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getResult

public final java.lang.Object getResult()

Gets the example result

Returns:

result

getNumFeatures

public final int getNumFeatures()

Description copied from interface: TestingExample

Gets the number of features

Specified by:

getNumFeatures in interface TestingExample

Returns:

number of features

toString

public final java.lang.String toString()

Returns a string representation of the example using the LibSVM format: result (index_A+1):value_A (index_B+1):value_B ...

Overrides:

toString in class java.lang.Object

Returns:

example in LibSVM format

getFeature

public abstract java.lang.Double getFeature(int featureNumber)

Description copied from interface: TestingExample

Gets a feature given its number

Specified by:

getFeature in interface TestingExample

Parameters:

featureNumber - index of the feature

Returns:

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