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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
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/>.
*/
/**
* Common Interface for Matrix and Vector objects, where M is the actual type.
*
* The type M guarantees type safety for many operations.
*
* @param M the actual type
*
* @apiviz.landmark
*
* @author Elke Achtert
* @author Erich Schubert
*/
public interface MatrixLike<M extends MatrixLike<M>> extends Cloneable {
/**
* Make a deep copy of a matrix.
*
* @return a new matrix containing the same values as this matrix
*/
public M copy();
/**
* Clone the Matrix object.
*/
public Object clone();
/**
* Returns the dimensionality of the rows of this matrix.
*
* @return m, the number of rows.
*/
public int getRowDimensionality();
/**
* Returns the dimensionality of the columns of this matrix.
*
* @return n, the number of columns.
*/
public int getColumnDimensionality();
/**
* Get a single element.
*
* @param i Row index.
* @param j Column index.
* @return A(i,j)
* @throws ArrayIndexOutOfBoundsException on bounds error
*/
public double get(int i, int j);
/**
* Set a single element.
*
* @param i Row index.
* @param j Column index.
* @param s A(i,j).
* @throws ArrayIndexOutOfBoundsException on bounds error
*/
public M set(int i, int j, double s);
/**
* Increments a single element.
*
* @param i the row index
* @param j the column index
* @param s the increment value: A(i,j) = A(i.j) + s.
* @throws ArrayIndexOutOfBoundsException on bounds error
*/
public M increment(int i, int j, double s);
/**
* Returns the <code>i</code>th column of this matrix as vector.
*
* @param i the index of the column to be returned
* @return the <code>i</code>th column of this matrix
*/
public Vector getColumnVector(int i);
/**
* Matrix transpose.
*
* @return A<sup>T</sup>
*/
public Matrix transpose();
/**
* C = A + B
*
* @param B another matrix
* @return A + B in a new Matrix
*/
public M plus(M B);
/**
* C = A + s*B
*
* @param B another matrix
* @param s scalar
* @return A + s*B in a new Matrix
*/
public M plusTimes(M B, double s);
/**
* A = A + B
*
* @param B another matrix
* @return A + B in this Matrix
*/
public M plusEquals(M B);
/**
* C = A + s*B
*
* @param B another matrix
* @param s scalar
* @return A + s*B in this Matrix
*/
public M plusTimesEquals(M B, double s);
/**
* C = A - B
*
* @param B another matrix
* @return A - B in a new Matrix
*/
public M minus(M B);
/**
* C = A - s*B
*
* @param B another matrix
* @param s Scalar
* @return A - s*B in a new Matrix
*/
public M minusTimes(M B, double s);
/**
* A = A - B
*
* @param B another matrix
* @return A - B in this Matrix
*/
public M minusEquals(M B);
/**
* C = A - s*B
*
* @param B another matrix
* @param s Scalar
* @return A - s*B in a new Matrix
*/
public M minusTimesEquals(M B, double s);
/**
* Multiply a matrix by a scalar, C = s*A
*
* @param s scalar
* @return s*A
*/
public M times(double s);
/**
* Multiply a matrix by a scalar in place, A = s*A
*
* @param s scalar
* @return replace A by s*A
*/
public M timesEquals(double s);
}
|
