org.openimaj.feature

Class ArrayFeatureVector<ARRAYTYPE>

java.lang.Object

org.openimaj.feature.ArrayFeatureVector<ARRAYTYPE>

Type Parameters:

ARRAYTYPE - Primitive a type of the backing array

All Implemented Interfaces:

Serializable, Cloneable, FeatureVector, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

Direct Known Subclasses:

ByteFV, DoubleFV, FloatFV, IntFV, LongFV, ShortFV

public abstract class ArrayFeatureVector<ARRAYTYPE>
extends Object
implements FeatureVector

Abstract base class for all types of FeatureVector that are backed by a native array.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ARRAYTYPE	values Array of all the values in the feature vector

Constructor Summary

Constructors

Constructor and Description
ArrayFeatureVector()

Method Summary

Methods

Modifier and Type	Method and Description
ARRAYTYPE	getVector() Get the underlying representation
abstract ArrayFeatureVector<ARRAYTYPE>	subvector(int beginIndex) Returns a new featurevector that is a subsequence of this vector.
abstract ArrayFeatureVector<ARRAYTYPE>	subvector(int beginIndex, int endIndex) Returns a new string that is a subvector of this vector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.feature.FeatureVector

asDoubleFV, asDoubleVector, length, normaliseFV, normaliseFV, normaliseFV, normaliseFV

Methods inherited from interface org.openimaj.io.ReadableASCII

asciiHeader, readASCII

Methods inherited from interface org.openimaj.io.ReadableBinary

binaryHeader, readBinary

Methods inherited from interface org.openimaj.io.WriteableASCII

asciiHeader, writeASCII

Methods inherited from interface org.openimaj.io.WriteableBinary

binaryHeader, writeBinary

Field Detail

values

public ARRAYTYPE values

Array of all the values in the feature vector

Constructor Detail

ArrayFeatureVector

public ArrayFeatureVector()

Method Detail

getVector

public ARRAYTYPE getVector()

Get the underlying representation

Specified by:

getVector in interface FeatureVector

Returns:

the feature as an array

subvector

public abstract ArrayFeatureVector<ARRAYTYPE> subvector(int beginIndex)

Returns a new featurevector that is a subsequence of this vector. The subsequence begins with the element at the specified index and extends to the end of this vector.

Parameters:

beginIndex - the beginning index, inclusive.

Returns:

the specified subvector.

Throws:

IndexOutOfBoundsException - if beginIndex is negative or larger than the length of this ArrayFeatureVector object.

subvector

public abstract ArrayFeatureVector<ARRAYTYPE> subvector(int beginIndex,
                                      int endIndex)

Returns a new string that is a subvector of this vector. The subvector begins at the specified beginIndex and extends to the element at index endIndex - 1. Thus the length of the subvector is endIndex-beginIndex.

Parameters:

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

Returns:

the specified subvector.

Throws:

IndexOutOfBoundsException - if the beginIndex is negative, or endIndex is larger than the length of this ArrayFeatureVector object, or beginIndex is larger than endIndex.