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.ml.clustering.assignment;
031
032import org.openimaj.util.pair.IndependentPair;
033
034/**
035 * The {@link SoftAssigner} interface describes classes that
036 * assign a spatial point to multiple clusters, possibly with 
037 * weighting.
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 *
041 * @param <DATATYPE> the primitive array datatype which represents a centroid of this cluster.
042 * @param <DISTANCES> primitive array datatype for recording distances between points and cluster centroids.
043 */
044public interface SoftAssigner<DATATYPE, DISTANCES> extends Assigner<DATATYPE> {
045        /**
046         * Assign data to clusters.
047         * 
048         * @param data the data.
049         * @return The cluster indices which the data was assigned to.
050         */
051        public int[][] assign(DATATYPE[] data);
052
053        /**
054         * Assign a single point to some clusters.
055         * 
056         * @param data datum to assign.
057         * 
058         * @return the assigned cluster indices.
059         */
060        public int[] assign(DATATYPE data);
061        
062        /**
063         * Assign data to clusters. The results are returned
064         * in the indices and distances arrays. The return arrays
065         * must have the same length as the data array. 
066         *            
067         * @param data the data.
068         * @param assignments the cluster indices for each data point.
069         * @param weights the weights to the for each cluster for each data point.
070         */
071        public void assignWeighted(DATATYPE[] data, int[][] assignments, DISTANCES[] weights);
072
073        /**
074         * Assign a single point to some clusters.
075         * 
076         * @param data point to assign.
077         * 
078         * @return the assigned cluster indices and weights.
079         */
080        public IndependentPair<int[], DISTANCES> assignWeighted(DATATYPE data);
081}