1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
package de.lmu.ifi.dbs.elki.math.linearalgebra;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2011
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import de.lmu.ifi.dbs.elki.utilities.FormatUtil;
/**
* Helper class which encapsulates an eigenvector and its corresponding
* eigenvalue. This class is used to sort eigenpairs.
*
* @author Elke Achtert
*
* @apiviz.composedOf Matrix
*/
public class EigenPair implements Comparable<EigenPair> {
/**
* The eigenvector as a matrix.
*/
private Vector eigenvector;
/**
* The corresponding eigenvalue.
*/
private double eigenvalue;
/**
* Creates a new EigenPair object.
*
* @param eigenvector the eigenvector as a matrix
* @param eigenvalue the corresponding eigenvalue
*/
public EigenPair(Vector eigenvector, double eigenvalue) {
this.eigenvalue = eigenvalue;
this.eigenvector = eigenvector;
}
/**
* Compares this object with the specified object for order. Returns a
* negative integer, zero, or a positive integer as this object's eigenvalue
* is greater than, equal to, or less than the specified object's eigenvalue.
*
* @param o the Eigenvector to be compared.
* @return a negative integer, zero, or a positive integer as this object's
* eigenvalue is greater than, equal to, or less than the specified
* object's eigenvalue.
*/
@Override
public int compareTo(EigenPair o) {
if(this.eigenvalue < o.eigenvalue) {
return -1;
}
if(this.eigenvalue > o.eigenvalue) {
return +1;
}
return 0;
}
/**
* Returns the eigenvector.
*
* @return the eigenvector
*/
public Vector getEigenvector() {
return eigenvector;
}
/**
* Returns the eigenvalue.
*
* @return the eigenvalue
*/
public double getEigenvalue() {
return eigenvalue;
}
/**
* Returns a string representation of this EigenPair.
*
* @return a string representation of this EigenPair
*/
@Override
public String toString() {
return "(ew = " + FormatUtil.format(eigenvalue) + ", ev = [" + FormatUtil.format(eigenvector) + "])";
}
}
|
