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.spectral;
031
032import org.openimaj.ml.clustering.IndexClusters;
033import org.openimaj.util.pair.IndependentPair;
034
035/**
036 * {@link IndexClusters} which also hold the eigenvector/value pairs which created them
037 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
038 *
039 */
040public class SpectralIndexedClusters extends IndexClusters {
041        private IndependentPair<double[], double[][]> valvects;
042
043        /**
044         * 
045         * @param c the underlying {@link IndexClusters}
046         * @param valvects the eigen values and vectors
047         */
048        public SpectralIndexedClusters(IndexClusters c, IndependentPair<double[], double[][]>valvects) {
049                this.clusters = c.clusters();
050                this.nEntries = c.numEntries();
051                this.valvects = valvects;
052        }
053
054        /**
055         * @return the eigen values
056         */
057        public double[] eigenValues() {
058                return valvects.firstObject();
059        }
060
061        /**
062         * @return eigenvectors
063         */
064        public double[][] eigenVectors() {
065                return valvects.getSecondObject();
066        }
067
068        /**
069         * @return the eigenvectors and values
070         */
071        public IndependentPair<double[], double[][]> getValVect() {
072                return this.valvects;
073        }
074}