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.math.matrix;
031
032import java.util.Arrays;
033
034import Jama.Matrix;
035
036
037/**
038 * A pair of Eigen values and corresponding vectors
039 * 
040 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
041 *
042 */
043public class EigenValueVectorPair {
044        private Matrix val;
045        private Matrix vec;
046        
047        /**
048         * Construct with Eigen values and vectors.
049         * @param val values
050         * @param vec vectors
051         */
052        public EigenValueVectorPair(Matrix val, Matrix vec) {
053                this.setValues(val);
054                this.setVectors(vec);
055        }
056        
057        @Override
058        public String toString(){
059                String out = "[ \n";
060                for(int i = 0; i < 2; i ++ ){
061                        out+="\t" + (this.getVectors().get(i, 0)) + ";"  + "\n";
062                }
063                out += "] \n";
064                out += "[ \n";
065                for(int i = 0; i < 2; i ++ ){
066                        out+="\t" + Arrays.toString(this.getValues().getArray()[i]) + ";" + "\n" ;
067                }
068                out += "] \n";
069                
070                return out;
071        }
072
073        /**
074         * Set the Eigen values
075         * @param val the Eigen values
076         */
077        public void setValues(Matrix val) {
078                this.val = val;
079        }
080
081        /**
082         * @return The Eigen values
083         */
084        public Matrix getValues() {
085                return val;
086        }
087
088        /**
089         * Set the Eigen vectors
090         * @param vec the Eigen vectors
091         */
092        public void setVectors(Matrix vec) {
093                this.vec = vec;
094        }
095
096        /**
097         * @return The Eigen vectors
098         */
099        public Matrix getVectors() {
100                return vec;
101        }
102}