Package elki.data.type

Class VectorFieldTypeInformation<V extends FeatureVector<?>>

java.lang.Object

elki.data.type.SimpleTypeInformation<V>

elki.data.type.VectorTypeInformation<V>

elki.data.type.VectorFieldTypeInformation<V>

Type Parameters:

V - Vector type

All Implemented Interfaces:

FieldTypeInformation, TypeInformation

public class VectorFieldTypeInformation<V extends FeatureVector<?>>
extends VectorTypeInformation<V>
implements FieldTypeInformation

Type information to specify that a type has a fixed dimensionality.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String[]	labels	Labels.

Fields inherited from class elki.data.type.VectorTypeInformation

maxdim, mindim

Constructor Summary

Constructors

Modifier	Constructor	Description
	VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory, int dim)	Constructor with given dimensionality and factory, so usually an instance.
	VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory, int mindim, int maxdim, ByteBufferSerializer<? super V> serializer)	Constructor with given dimensionality and factory, so usually an instance.
	VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory, int dim, ByteBufferSerializer<? super V> serializer)	Constructor with given dimensionality and factory, so usually an instance.
	VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory, int dim, java.lang.String[] labels)	Constructor with given dimensionality and factory, so usually an instance.
	VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory, int dim, java.lang.String[] labels, ByteBufferSerializer<? super V> serializer)	Constructor with given dimensionality and factory, so usually an instance.
private	VectorFieldTypeInformation(java.lang.Class<? super V> cls, int mindim, int maxdim)	Constructor for a request with minimum and maximum dimensionality.

Method Summary

Modifier and Type	Method	Description
int	getDimensionality()	Get the dimensionality of the type.
java.lang.String	getLabel(int col)	Get the column label.
protected java.lang.String[]	getLabels()	Get the column labels.
boolean	isAssignableFromType(TypeInformation type)	Test whether this type is assignable from another type.
java.lang.String	toString()
static <V extends FeatureVector<?>> VectorFieldTypeInformation<V>	typeRequest(java.lang.Class<? super V> cls)	Constructor for a type request without dimensionality constraints.
static <V extends FeatureVector<?>> VectorFieldTypeInformation<V>	typeRequest(java.lang.Class<? super V> cls, int mindim, int maxdim)	Constructor for a type request with dimensionality constraints.

Methods inherited from class elki.data.type.VectorTypeInformation

getFactory, getMultiplicity, isAssignableFrom, maxdim, mindim

Methods inherited from class elki.data.type.SimpleTypeInformation

cast, getLabel, getRestrictionClass, getSerializer, setSerializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.data.type.TypeInformation

isAssignableFrom

Field Detail

labels

private java.lang.String[] labels

Labels.

Constructor Detail

VectorFieldTypeInformation

public VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory,
                                  int dim,
                                  java.lang.String[] labels,
                                  ByteBufferSerializer<? super V> serializer)

Constructor with given dimensionality and factory, so usually an instance.

Parameters:

factory - Factory class

dim - Dimensionality

labels - Labels

serializer - Serializer

VectorFieldTypeInformation

public VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory,
                                  int mindim,
                                  int maxdim,
                                  ByteBufferSerializer<? super V> serializer)

Constructor with given dimensionality and factory, so usually an instance.

Parameters:

factory - Factory class

mindim - Minimum dimensionality

maxdim - Maximum dimensionality

serializer - Serializer

VectorFieldTypeInformation

public VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory,
                                  int dim,
                                  ByteBufferSerializer<? super V> serializer)

Constructor with given dimensionality and factory, so usually an instance.

Parameters:

factory - Factory class

dim - Dimensionality

serializer - Serializer

VectorFieldTypeInformation

public VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory,
                                  int dim,
                                  java.lang.String[] labels)

Constructor with given dimensionality and factory, so usually an instance.

Parameters:

factory - Factory class

dim - Dimensionality

labels - Labels

VectorFieldTypeInformation

private VectorFieldTypeInformation(java.lang.Class<? super V> cls,
                                   int mindim,
                                   int maxdim)

Constructor for a request with minimum and maximum dimensionality.

Parameters:

cls - Vector restriction class.

mindim - Minimum dimensionality request

maxdim - Maximum dimensionality request

VectorFieldTypeInformation

public VectorFieldTypeInformation(FeatureVector.Factory<V,?> factory,
                                  int dim)

Constructor with given dimensionality and factory, so usually an instance.

Parameters:

factory - Factory class

dim - Dimensionality

Method Detail

typeRequest

public static <V extends FeatureVector<?>> VectorFieldTypeInformation<V> typeRequest(java.lang.Class<? super V> cls)

Constructor for a type request without dimensionality constraints.

Type Parameters:

V - vector type

Parameters:

cls - Class constraint

typeRequest

public static <V extends FeatureVector<?>> VectorFieldTypeInformation<V> typeRequest(java.lang.Class<? super V> cls,
                                                                                     int mindim,
                                                                                     int maxdim)

Constructor for a type request with dimensionality constraints.

Type Parameters:

V - vector type

Parameters:

cls - Class constraint

mindim - Minimum dimensionality

maxdim - Maximum dimensionality

isAssignableFromType

public boolean isAssignableFromType(TypeInformation type)

Description copied from interface: TypeInformation

Test whether this type is assignable from another type.

Specified by:

isAssignableFromType in interface TypeInformation

Overrides:

isAssignableFromType in class VectorTypeInformation<V extends FeatureVector<?>>

Parameters:

type - Other type

Returns:

true when the other type is accepted as subtype.

getDimensionality

public int getDimensionality()

Description copied from interface: FieldTypeInformation

Get the dimensionality of the type.

Specified by:

getDimensionality in interface FieldTypeInformation

Returns:

dimensionality

toString

public java.lang.String toString()

Overrides:

toString in class VectorTypeInformation<V extends FeatureVector<?>>

getLabel

public java.lang.String getLabel(int col)

Get the column label.

Parameters:

col - Column number

Returns:

Label

getLabels

protected java.lang.String[] getLabels()

Get the column labels.

Returns:

labels