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
|
package de.lmu.ifi.dbs.elki.data;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
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 gnu.trove.map.TIntDoubleMap;
/**
* Combines the SparseFeatureVector and NumberVector.
*
* @author Erich Schubert
*/
public interface SparseNumberVector extends NumberVector, SparseFeatureVector<Number> {
/**
* Iterator over non-zero features only, <em>ascendingly</em>.
*
* Note: depending on the underlying implementation, this may or may not be
* the dimension. Use {@link #iterDim} to get the actual dimension. In fact,
* usually this will be the ith non-zero value, assuming an array
* representation.
*
* Think of this number as an iterator. For efficiency, it has a primitive
* type!
*
* Intended usage:
*
* <pre>
* {@code
* for (int iter = v.iter(); v.iterValid(iter); iter = v.iterAdvance(iter)) {
* final int dim = v.iterDim(iter);
* final double val = v.iterDoubleValue(iter);
* // Do something.
* }
* }
* </pre>
*
* @return Identifier for the first non-zero dimension, <b>not necessarily the
* dimension!</b>
*/
@Override
int iter();
/**
* Update the vector space dimensionality.
*
* @param maxdim New dimensionality
*/
void setDimensionality(int maxdim);
/**
* Get the value of the iterators' current dimension.
*
* @param iter Iterator
* @return Value at the current position
*/
double iterDoubleValue(int iter);
/**
* Get the value of the iterators' current dimension.
*
* @param iter Iterator
* @return Value at the current position
*/
float iterFloatValue(int iter);
/**
* Get the value of the iterators' current dimension.
*
* @param iter Iterator
* @return Value at the current position
*/
int iterIntValue(int iter);
/**
* Get the value of the iterators' current dimension.
*
* @param iter Iterator
* @return Value at the current position
*/
short iterShortValue(int iter);
/**
* Get the value of the iterators' current dimension.
*
* @param iter Iterator
* @return Value at the current position
*/
long iterLongValue(int iter);
/**
* Get the value of the iterators' current dimension.
*
* @param iter Iterator
* @return Value at the current position
*/
byte iterByteValue(int iter);
/**
* @deprecated As the vectors are sparse, try to iterate over the sparse
* dimensions only, see {@link #iterDoubleValue}.
*/
@Override
@Deprecated
double doubleValue(int dimension);
/**
* @deprecated As the vectors are sparse, try to iterate over the sparse
* dimensions only, see {@link #iterFloatValue}.
*/
@Override
@Deprecated
float floatValue(int dimension);
/**
* @deprecated As the vectors are sparse, try to iterate over the sparse
* dimensions only, see {@link #iterIntValue}.
*/
@Override
@Deprecated
int intValue(int dimension);
/**
* @deprecated As the vectors are sparse, try to iterate over the sparse
* dimensions only, see {@link #iterLongValue}.
*/
@Override
@Deprecated
long longValue(int dimension);
/**
* @deprecated As the vectors are sparse, try to iterate over the sparse
* dimensions only, see {@link #iterShortValue}.
*/
@Override
@Deprecated
short shortValue(int dimension);
/**
* @deprecated As the vectors are sparse, try to iterate over the sparse
* dimensions only, see {@link #iterByteValue}.
*/
@Override
@Deprecated
byte byteValue(int dimension);
/**
* Factory for sparse number vectors: make from a dim-value map.
*
* @author Erich Schubert
*
* @apiviz.has SparseNumberVector
*
* @param <V> Vector type number type
*/
interface Factory<V extends SparseNumberVector> extends NumberVector.Factory<V> {
/**
* Returns a new NumberVector of N for the given values.
*
* @param values the values of the NumberVector
* @param maxdim Maximum dimensionality.
* @return a new NumberVector of N for the given values
*/
V newNumberVector(TIntDoubleMap values, int maxdim);
}
}
|
