All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.openimaj.lsh.sketch.ByteLSHSketcher Maven / Gradle / Ivy

    /*
	AUTOMATICALLY GENERATED BY jTemp FROM
	/Users/jsh2/Work/openimaj/target/checkout/machine-learning/nearest-neighbour/src/main/jtemp/org/openimaj/lsh/sketch/#T#LSHSketcher.jtemp
*/
/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	Redistributions in binary form must reproduce the above copyright notice,
 * 	this list of conditions and the following disclaimer in the documentation
 * 	and/or other materials provided with the distribution.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openimaj.lsh.sketch;

import java.util.ArrayList;
import java.util.List;

import org.openimaj.util.hash.HashFunction;
import org.openimaj.util.hash.HashFunctionFactory;
import org.openimaj.util.sketch.Sketcher;

/**
 * A {@link Sketcher} that produces bit-string sketches encoded as byte arrays.
 * 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 ([email protected])
 * 
 * @param 
 *            Type of object being sketched
 */
public class ByteLSHSketcher implements Sketcher {
	List> hashFunctions;

	/**
	 * Construct with the given functions.
	 * 
	 * @param functions
	 *            the underlying hash functions.
	 */
	public ByteLSHSketcher(List> functions) {
		this.hashFunctions = functions;
	}

	/**
	 * Construct with the given functions.
	 * 
	 * @param first
	 *            the first function
	 * @param remainder
	 *            the remainder of the functions
	 */
	@SafeVarargs
	public ByteLSHSketcher(HashFunction first, HashFunction... remainder) {
		this.hashFunctions = new ArrayList>();
		this.hashFunctions.add(first);

		for (final HashFunction r : remainder)
			this.hashFunctions.add(r);
	}

	/**
	 * Construct with the factory which is used to produce the required number
	 * of functions.
	 * 
	 * @param factory
	 *            the factory to use to produce the underlying hash functions.
	 * @param nFuncs
	 *            the number of functions to create for the composition
	 */
	public ByteLSHSketcher(HashFunctionFactory factory, int nFuncs) {
		this.hashFunctions = new ArrayList>();

		for (int i = 0; i < nFuncs; i++)
			hashFunctions.add(factory.create());
	}

	@Override
	public byte[] createSketch(OBJECT input) {
		final int nele = arrayLength();
		final byte[] sketch = new byte[nele];

		for (int i = 0, j = 0; i < nele; i++) {
			for (int k = 0; k < Byte.SIZE; k++) {
				final int hash = hashFunctions.get(j++).computeHashCode(input);

				sketch[i] = (byte) (sketch[i] | ((byte) hash << k));
			}
		}

		return sketch;
	}

	/**
	 * Get the length of the sketch in bits.
	 * 
	 * @return the number of bits in the sketch
	 */
	public int bitLength() {
		return hashFunctions.size();
	}

	/**
	 * Get the length of the output byte array of packed bits.
	 * 
	 * @return the number of bytes that will be returned.
	 */
	public int arrayLength() {
		return (int) Math.ceil((double) hashFunctions.size() / Byte.SIZE);
	}
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy