001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.knn;
031
032import java.util.Collection;
033
034import org.openimaj.math.geometry.point.Coordinate;
035
036/**
037 * Interface representing an index of {@link Coordinate}s that can
038 * have points added to it and can be searched in a variety of ways.
039 * 
040 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
041 *
042 * @param <T> the type of coordinate.
043 */
044public interface CoordinateIndex<T extends Coordinate> {
045        /**
046         * Insert a single coordinate into the index.
047         * @param point coordinate to add.
048         */
049        public void insert(T point);
050        
051        /**
052         * Search for all the coordinates in the index that
053         * lie in the hyper-rectangle defined by the lower and
054         * upper bound coordinates. Store found coordinates
055         * in the results collection.
056         * 
057         * @param results Collection to hold the found coordinates.
058         * @param lowerExtreme Lower bound of the hyper-rectangle.
059         * @param upperExtreme Upper bound of the hyper-rectangle.
060         */
061        public void rangeSearch(Collection<T> results, Coordinate lowerExtreme, Coordinate upperExtreme);
062        
063        /**
064         * Find the nearest coordinate in the index to the query
065         * coordinate.
066         * 
067         * @param query The query coordinate.
068         * @return the closest coordinate in the index.
069         */
070        public T nearestNeighbour(Coordinate query);
071        
072        /**
073         * Find the k nearest neighbour points in the index to
074         * the query coordinate. Store found coordinates
075         * in the results collection.
076         * 
077         * @param result Collection to hold the found coordinates.
078         * @param query The query coordinate.
079         * @param k The number of neighbours to find.
080         */
081        public void kNearestNeighbour(Collection<T> result, Coordinate query, int k);
082}