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.dbscan;
031
032import java.util.Arrays;
033
034import org.openimaj.ml.clustering.IndexClusters;
035
036/**
037 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
038 */
039public class DBSCANClusters extends IndexClusters {
040        /**
041         * Indexes of noise elements
042         */
043        private int[] noise;
044        
045        /**
046         * @param noise
047         * @param clusters
048         */
049        public DBSCANClusters(int[] noise, int[][] clusters) {
050                super(clusters);
051                this.noise = noise;
052        }
053        
054        /**
055         * @param noise
056         * @param clusters
057         * @param nEntries 
058         */
059        public DBSCANClusters(int[] noise, int[][] clusters, int nEntries) {
060                super(clusters,nEntries);
061                this.noise = noise;
062        }
063        
064        @Override
065        public String toString() {
066                String str = String.format("%s", Arrays.toString(this.noise));
067                return super.toString() + "\n" + str;
068        }
069        
070        /**
071         * @return the data indexes assigned to noise
072         */
073        public int[] getNoise(){
074                return this.noise;
075        }
076        
077}