edu.ucla.sspace.index

Class RandomIndexVectorGenerator

java.lang.Object

edu.ucla.sspace.index.RandomIndexVectorGenerator

All Implemented Interfaces:

IntegerVectorGenerator<TernaryVector>, Generator<TernaryVector>, Serializable

public class RandomIndexVectorGenerator
extends Object
implements IntegerVectorGenerator<TernaryVector>, Serializable

An class that generates RandomTernaryVector instances based on configurable properties. This class supports two properties:

Property: "edu.ucla.sspace.index.RandomIndexVectorGenerator.values"
Default: 4

This variable sets the number of bits to set in an index vector.

Property: "edu.ucla.sspace.index.RandomIndexVectorGenerator.variance"
Default: 0

This variable sets the variance in the number of bits to set in an index vector. For example, having "edu.ucla.sspace.index.RandomIndexVectorGenerator.values"=4 and setting this property to 2 would mean that 4 ± 2 value would be randomly set in each index vector.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDEX_VECTOR_LENGTH The default number of dimensions to create in each TernaryVector.
static int	DEFAULT_INDEX_VECTOR_VALUES The default number of values to set in an TernaryVector.
static int	DEFAULT_INDEX_VECTOR_VARIANCE The default random variance in the number of values that are set in an TernaryVector.
static String	INDEX_VECTOR_VARIANCE_PROPERTY The property to specify the variance in the number of values to set in an TernaryVector.
static Random	RANDOM A random number generator that can be accessed to other classes which will rely on the same source of random values.
static String	VALUES_TO_SET_PROPERTY The property to specify the number of values to set in an TernaryVector.

Constructor Summary

Constructors

Constructor and Description
RandomIndexVectorGenerator(int indexVectorLength) Constructs this instance using the system properties.
RandomIndexVectorGenerator(int indexVectorLength, Properties properties) Constructs this instance using the provided properties.

Method Summary

Methods

Modifier and Type	Method and Description
TernaryVector	generate() Creates an TernaryVector with the provided length.

Methods inherited from class java.lang.Object

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

Field Detail

RANDOM

public static final Random RANDOM

A random number generator that can be accessed to other classes which will rely on the same source of random values.

VALUES_TO_SET_PROPERTY

public static final String VALUES_TO_SET_PROPERTY

The property to specify the number of values to set in an TernaryVector.

See Also:

Constant Field Values

INDEX_VECTOR_VARIANCE_PROPERTY

public static final String INDEX_VECTOR_VARIANCE_PROPERTY

The property to specify the variance in the number of values to set in an TernaryVector.

See Also:

Constant Field Values

DEFAULT_INDEX_VECTOR_VALUES

public static final int DEFAULT_INDEX_VECTOR_VALUES

The default number of values to set in an TernaryVector.

See Also:

Constant Field Values

DEFAULT_INDEX_VECTOR_LENGTH

public static final int DEFAULT_INDEX_VECTOR_LENGTH

The default number of dimensions to create in each TernaryVector.

See Also:

Constant Field Values

DEFAULT_INDEX_VECTOR_VARIANCE

public static final int DEFAULT_INDEX_VECTOR_VARIANCE

The default random variance in the number of values that are set in an TernaryVector.

See Also:

Constant Field Values

Constructor Detail

RandomIndexVectorGenerator

public RandomIndexVectorGenerator(int indexVectorLength)

Constructs this instance using the system properties.

RandomIndexVectorGenerator

public RandomIndexVectorGenerator(int indexVectorLength,
                          Properties properties)

Constructs this instance using the provided properties.

Method Detail

generate

public TernaryVector generate()

Creates an TernaryVector with the provided length.

Specified by:

generate in interface IntegerVectorGenerator<TernaryVector>

Specified by:

generate in interface Generator<TernaryVector>

Parameters:

length - the length of the index vector

Returns:

an index vector