org.openimaj.lsh.sketch

Class BitSetLSHSketcher<OBJECT>

java.lang.Object

org.openimaj.lsh.sketch.BitSetLSHSketcher<OBJECT>

Type Parameters:

OBJECT - Type of object being sketched

All Implemented Interfaces:

Sketcher<OBJECT,BitSet>

public class BitSetLSHSketcher<OBJECT>
extends Object
implements Sketcher<OBJECT,BitSet>

A Sketcher that produces bit-string sketches encoded as a BitSet. Only the least-significant bit of each hash function will be appended to the final sketch. The length of the output array will be computed such that the bit from each hash function is contained.

Author:

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

Constructor Summary

Constructors

Constructor and Description
BitSetLSHSketcher(HashFunction<OBJECT> first, HashFunction<OBJECT>... remainder) Construct with the given functions.
BitSetLSHSketcher(HashFunctionFactory<OBJECT> factory, int nFuncs) Construct with the factory which is used to produce the required number of functions.
BitSetLSHSketcher(List<HashFunction<OBJECT>> functions) Construct with the given functions.

Method Summary

Modifier and Type	Method and Description
int	bitLength() Get the length of the sketch in bits.
BitSet	createSketch(OBJECT input) Create a sketch for the given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitSetLSHSketcher

public BitSetLSHSketcher(List<HashFunction<OBJECT>> functions)

Construct with the given functions.

Parameters:

functions - the underlying hash functions.

BitSetLSHSketcher

@SafeVarargs
public BitSetLSHSketcher(HashFunction<OBJECT> first,
                                      HashFunction<OBJECT>... remainder)

Construct with the given functions.

Parameters:

first - the first function

remainder - the remainder of the functions

BitSetLSHSketcher

public BitSetLSHSketcher(HashFunctionFactory<OBJECT> factory,
                         int nFuncs)

Construct with the factory which is used to produce the required number of functions.

Parameters:

factory - the factory to use to produce the underlying hash functions.

nFuncs - the number of functions to create for the composition

Method Detail

createSketch

public BitSet createSketch(OBJECT input)

Description copied from interface: Sketcher

Create a sketch for the given object.

Specified by:

createSketch in interface Sketcher<OBJECT,BitSet>

Parameters:

input - the object to sketch

Returns:

the sketch of the object.

bitLength

public int bitLength()

Get the length of the sketch in bits.

Returns:

the number of bits in the sketch