org.openimaj.ml.sketch.SummarySketcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twitter Show documentation

The twitter project contains tools with which to read JSON data from the twitter API and process the data.

There is a newer version: 1.3.10

/**
 * Copyright (c) 2012, 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.ml.sketch;


/**
 * As described by: http://lkozma.net/blog/sketching-data-structures/
 * 
 * "Sketching" data structures store a summary of a data set in situations where
 * the whole data would be prohibitively costly to store (at least in a
 * fast-access place like the memory as opposed to the hard disk).
 * 
 * @author Sina Samangooei ([email protected])
 * 
 * @param 
 *            the type of data being accumulated into the summary
 * @param 
 *            the value type of the summary being sketched
 * 
 */
public interface SummarySketcher /* extends Sketcher, V> */{
	/**
	 * @param data
	 *            update the sketch with this data
	 * @param value
	 *            the value to update with
	 */
	public void update(T data, V value);

	/**
	 * @param data
	 *            the data to query with
	 * @return the value to return
	 */
	public V query(T data);
}