-
-
Notifications
You must be signed in to change notification settings - Fork 1k
/
LinalgBackendBase.h
307 lines (284 loc) · 9.3 KB
/
LinalgBackendBase.h
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*
* Copyright (c) 2016, Shogun-Toolbox e.V. <shogun-team@shogun-toolbox.org>
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Authors: 2016 Pan Deng, Soumyajit De, Heiko Strathmann, Viktor Gal
*/
#include <shogun/lib/config.h>
#include <shogun/lib/common.h>
#include <shogun/lib/SGVector.h>
#include <shogun/lib/SGMatrix.h>
#include <shogun/io/SGIO.h>
#include <shogun/mathematics/linalg/GPUMemoryBase.h>
#include <shogun/mathematics/linalg/internal/Block.h>
#include <memory>
#ifndef LINALG_BACKEND_BASE_H__
#define LINALG_BACKEND_BASE_H__
namespace shogun
{
/** @brief Base interface of generic linalg methods
* and generic memory transfer methods.
*/
class LinalgBackendBase
{
public:
#define DEFINE_FOR_ALL_PTYPE(METHODNAME, Container) \
METHODNAME(bool, Container); \
METHODNAME(char, Container); \
METHODNAME(int8_t, Container); \
METHODNAME(uint8_t, Container); \
METHODNAME(int16_t, Container); \
METHODNAME(uint16_t, Container); \
METHODNAME(int32_t, Container); \
METHODNAME(uint32_t, Container); \
METHODNAME(int64_t, Container); \
METHODNAME(uint64_t, Container); \
METHODNAME(float32_t, Container); \
METHODNAME(float64_t, Container); \
METHODNAME(floatmax_t, Container); \
METHODNAME(complex128_t, Container); \
#define DEFINE_FOR_REAL_PTYPE(METHODNAME, Container) \
METHODNAME(bool, Container); \
METHODNAME(char, Container); \
METHODNAME(int8_t, Container); \
METHODNAME(uint8_t, Container); \
METHODNAME(int16_t, Container); \
METHODNAME(uint16_t, Container); \
METHODNAME(int32_t, Container); \
METHODNAME(uint32_t, Container); \
METHODNAME(int64_t, Container); \
METHODNAME(uint64_t, Container); \
METHODNAME(float32_t, Container); \
METHODNAME(float64_t, Container); \
METHODNAME(floatmax_t, Container);
/**
* Wrapper method of add operation the operation C = alpha*A + beta*B.
*
* @see linalg::add
*/
#define BACKEND_GENERIC_ADD(Type, Container) \
virtual Container<Type> add(const Container<Type>& a, const Container<Type>& b, Type alpha, Type beta) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_ADD, SGVector)
#undef BACKEND_GENERIC_ADD
/**
* Wrapper method of add operation the operation result = alpha*a + beta*b.
*
* @see linalg::add
*/
#define BACKEND_GENERIC_IN_PLACE_ADD(Type, Container) \
virtual void add(Container<Type>& a, Container<Type>& b, Type alpha, Type beta, Container<Type>& result) const \
{ \
SG_SNOTIMPLEMENTED; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_IN_PLACE_ADD, SGVector)
#undef BACKEND_GENERIC_IN_PLACE_ADD
/**
* Wrapper method of vector dot-product that works with generic vectors.
*
* @see linalg::dot
*/
#define BACKEND_GENERIC_DOT(Type, Container) \
virtual Type dot(const Container<Type>& a, const Container<Type>& b) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_DOT, SGVector)
#undef BACKEND_GENERIC_DOT
/**
* Wrapper method that computes mean of SGVectors and SGMatrices
* that are composed of real numbers.
*
* @see linalg::mean
*/
#define BACKEND_GENERIC_REAL_MEAN(Type, Container) \
virtual float64_t mean(const Container<Type>& a) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_REAL_PTYPE(BACKEND_GENERIC_REAL_MEAN, SGVector)
DEFINE_FOR_REAL_PTYPE(BACKEND_GENERIC_REAL_MEAN, SGMatrix)
#undef BACKEND_GENERIC_REAL_MEAN
/**
* Wrapper method that computes mean of SGVectors and SGMatrices
* that are composed of complex numbers.
*
* @see linalg::mean
*/
#define BACKEND_GENERIC_COMPLEX_MEAN(Container) \
virtual complex128_t mean(const Container<complex128_t>& a) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
BACKEND_GENERIC_COMPLEX_MEAN(SGVector)
BACKEND_GENERIC_COMPLEX_MEAN(SGMatrix)
#undef BACKEND_GENERIC_COMPLEX_MEAN
/**
* Wrapper method of scale operation the operation B = alpha*A.
*
* @see linalg::scale
*/
#define BACKEND_GENERIC_SCALE(Type, Container) \
virtual Container<Type> scale(const Container<Type>& a, Type alpha) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_SCALE, SGVector)
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_SCALE, SGMatrix)
#undef BACKEND_GENERIC_SCALE
/**
* Wrapper method of scale operation the operation result = alpha*A.
*
* @see linalg::scale
*/
#define BACKEND_GENERIC_IN_PLACE_SCALE(Type, Container) \
virtual void scale(Container<Type>& a, Type alpha, Container<Type>& result) const \
{ \
SG_SNOTIMPLEMENTED; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_IN_PLACE_SCALE, SGVector)
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_IN_PLACE_SCALE, SGMatrix)
#undef BACKEND_GENERIC_IN_PLACE_SCALE
/**
* Wrapper method of vector sum that works with generic vectors.
*
* @see linalg::sum
*/
#define BACKEND_GENERIC_SUM(Type, Container) \
virtual Type sum(const Container<Type>& a, bool no_diag) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_SUM, SGVector)
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_SUM, SGMatrix)
#undef BACKEND_GENERIC_SUM
/**
* Wrapper method of sum that works with matrix blocks.
*
* @see linalg::sum
*/
#define BACKEND_GENERIC_BLOCK_SUM(Type, Container) \
virtual Type sum(const linalg::Block<Container<Type>>& a, bool no_diag) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_BLOCK_SUM, SGMatrix)
#undef BACKEND_GENERIC_BLOCK_SUM
/**
* Wrapper method of matrix rowwise sum that works with dense matrices.
*
* @see linalg::colwise_sum
*/
#define BACKEND_GENERIC_COLWISE_SUM(Type, Container) \
virtual SGVector<Type> colwise_sum(const Container<Type>& a, bool no_diag) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_COLWISE_SUM, SGMatrix)
#undef BACKEND_GENERIC_COLWISE_SUM
/**
* Wrapper method of matrix colwise sum that works with dense matrices.
*
* @see linalg::colwise_sum
*/
#define BACKEND_GENERIC_BLOCK_COLWISE_SUM(Type, Container) \
virtual SGVector<Type> colwise_sum(const linalg::Block<Container<Type>>& a, bool no_diag) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_BLOCK_COLWISE_SUM, SGMatrix)
#undef BACKEND_GENERIC_BLOCK_COLWISE_SUM
/**
* Wrapper method of matrix rowwise sum that works with dense matrices.
*
* @see linalg::rowwise_sum
*/
#define BACKEND_GENERIC_ROWWISE_SUM(Type, Container) \
virtual SGVector<Type> rowwise_sum(const Container<Type>& a, bool no_diag) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_ROWWISE_SUM, SGMatrix)
#undef BACKEND_GENERIC_ROWWISE_SUM
/**
* Wrapper method of matrix rowwise sum that works with dense matrices.
*
* @see linalg::rowwise_sum
*/
#define BACKEND_GENERIC_BLOCK_ROWWISE_SUM(Type, Container) \
virtual SGVector<Type> rowwise_sum(const linalg::Block<Container<Type>>& a, bool no_diag) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_BLOCK_ROWWISE_SUM, SGMatrix)
#undef BACKEND_GENERIC_BLOCK_ROWWISE_SUM
/**
* Wrapper method of Transferring data to GPU memory.
* Does nothing if no GPU backend registered.
*
* @see linalg::to_gpu
*/
#define BACKEND_GENERIC_TO_GPU(Type, Container) \
virtual GPUMemoryBase<Type>* to_gpu(const Container<Type>&) const \
{ \
SG_SNOTIMPLEMENTED; \
return 0; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_TO_GPU, SGVector)
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_TO_GPU, SGMatrix)
#undef BACKEND_GENERIC_TO_GPU
/**
* Wrapper method of fetching data from GPU memory.
*
* @see linalg::from_gpu
*/
#define BACKEND_GENERIC_FROM_GPU(Type, Container) \
virtual void from_gpu(const Container<Type>&, Type* data) const \
{ \
SG_SNOTIMPLEMENTED; \
}
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_FROM_GPU, SGVector)
DEFINE_FOR_ALL_PTYPE(BACKEND_GENERIC_FROM_GPU, SGMatrix)
#undef BACKEND_GENERIC_FROM_GPU
#undef DEFINE_FOR_ALL_PTYPE
};
}
#endif //LINALG_BACKEND_BASE_H__