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;
031
032import org.openimaj.ml.clustering.assignment.HardAssigner;
033
034/**
035 * Interface to describe objects that are the result of the clustering performed
036 * by a {@link SpatialClusterer}.
037 * 
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 * 
040 * @param <DATATYPE>
041 *            the primitive array datatype which represents a centroid of this
042 *            cluster.
043 */
044public interface SpatialClusters<DATATYPE> extends Clusters {
045        /**
046         * Get the data dimensionality
047         * 
048         * @return the data dimensionality.
049         */
050        public abstract int numDimensions();
051
052        /**
053         * Get the number of clusters.
054         * 
055         * @return number of clusters.
056         */
057        public int numClusters();
058
059        /**
060         * Get the default hard assigner for this clusterer. This method is
061         * potentially expensive, so callers should only call it once, and hold on
062         * to the result (and reuse it).
063         * 
064         * @return a hard assigner.
065         */
066        public HardAssigner<DATATYPE, ?, ?> defaultHardAssigner();
067}