1
|
|
|
"""!
|
2
|
|
|
|
3
|
|
|
@brief Pyclustering package that is used to exchange between python core and 'ccore'.
|
4
|
|
|
|
5
|
|
|
@authors Andrei Novikov ([email protected])
|
6
|
|
|
@date 2014-2017
|
7
|
|
|
@copyright GNU Public License
|
8
|
|
|
|
9
|
|
|
@cond GNU_PUBLIC_LICENSE
|
10
|
|
|
PyClustering is free software: you can redistribute it and/or modify
|
11
|
|
|
it under the terms of the GNU General Public License as published by
|
12
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
13
|
|
|
(at your option) any later version.
|
14
|
|
|
|
15
|
|
|
PyClustering is distributed in the hope that it will be useful,
|
16
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
17
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
18
|
|
|
GNU General Public License for more details.
|
19
|
|
|
|
20
|
|
|
You should have received a copy of the GNU General Public License
|
21
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
22
|
|
|
@endcond
|
23
|
|
|
|
24
|
|
|
"""
|
25
|
|
|
|
26
|
|
|
|
27
|
|
|
|
28
|
|
|
from ctypes import *;
|
|
|
|
|
29
|
|
|
|
30
|
|
|
|
31
|
|
|
|
32
|
|
|
class pyclustering_package(Structure):
|
33
|
|
|
"""!
|
34
|
|
|
@brief pyclustering_package description in memory.
|
35
|
|
|
@details Represents following C++ structure:
|
36
|
|
|
|
37
|
|
|
typedef struct pyclustering_package {
|
38
|
|
|
std::size_t size;
|
39
|
|
|
unsigned int type;
|
40
|
|
|
void * data;
|
41
|
|
|
}
|
42
|
|
|
"""
|
43
|
|
|
|
44
|
|
|
_fields_ = [ ("size", c_size_t),
|
45
|
|
|
("type", c_uint),
|
46
|
|
|
("data", POINTER(c_void_p)) ];
|
47
|
|
|
|
48
|
|
|
|
49
|
|
|
|
50
|
|
|
class pyclustering_type_data:
|
51
|
|
|
"""!
|
52
|
|
|
@brief Contains constants that defines type of package.
|
53
|
|
|
|
54
|
|
|
"""
|
55
|
|
|
|
56
|
|
|
PYCLUSTERING_TYPE_INT = 0x00;
|
57
|
|
|
PYCLUSTERING_TYPE_UNSIGNED_INT = 0x01;
|
58
|
|
|
PYCLUSTERING_TYPE_FLOAT = 0x02;
|
59
|
|
|
PYCLUSTERING_TYPE_DOUBLE = 0x03;
|
60
|
|
|
PYCLUSTERING_TYPE_LONG = 0x04;
|
61
|
|
|
PYCLUSTERING_TYPE_UNSIGNED_LONG = 0x05;
|
62
|
|
|
PYCLUSTERING_TYPE_LIST = 0x06;
|
63
|
|
|
PYCLUSTERING_TYPE_SIZE_T = 0x07;
|
64
|
|
|
PYCLUSTERING_TYPE_UNDEFINED = 0x08;
|
65
|
|
|
|
66
|
|
|
__CTYPE_PYCLUSTERING_MAP = {
|
67
|
|
|
c_int : PYCLUSTERING_TYPE_INT,
|
68
|
|
|
c_uint : PYCLUSTERING_TYPE_UNSIGNED_INT,
|
69
|
|
|
c_float : PYCLUSTERING_TYPE_FLOAT,
|
70
|
|
|
c_double : PYCLUSTERING_TYPE_DOUBLE,
|
71
|
|
|
c_long : PYCLUSTERING_TYPE_LONG,
|
72
|
|
|
c_ulong : PYCLUSTERING_TYPE_UNSIGNED_LONG,
|
73
|
|
|
POINTER(pyclustering_package) : PYCLUSTERING_TYPE_LIST,
|
74
|
|
|
c_size_t : PYCLUSTERING_TYPE_SIZE_T,
|
75
|
|
|
None : PYCLUSTERING_TYPE_UNDEFINED
|
76
|
|
|
}
|
77
|
|
|
|
78
|
|
|
__PYCLUSTERING_CTYPE_MAP = {
|
79
|
|
|
PYCLUSTERING_TYPE_INT : c_int,
|
80
|
|
|
PYCLUSTERING_TYPE_UNSIGNED_INT : c_uint,
|
81
|
|
|
PYCLUSTERING_TYPE_FLOAT : c_float,
|
82
|
|
|
PYCLUSTERING_TYPE_DOUBLE : c_double,
|
83
|
|
|
PYCLUSTERING_TYPE_LONG : c_long,
|
84
|
|
|
PYCLUSTERING_TYPE_UNSIGNED_LONG : c_ulong,
|
85
|
|
|
PYCLUSTERING_TYPE_LIST : POINTER(pyclustering_package),
|
86
|
|
|
PYCLUSTERING_TYPE_SIZE_T : c_size_t,
|
87
|
|
|
PYCLUSTERING_TYPE_UNDEFINED : None
|
88
|
|
|
}
|
89
|
|
|
|
90
|
|
|
@staticmethod
|
91
|
|
|
def get_ctype(pyclustering_package_type):
|
92
|
|
|
"""!
|
93
|
|
|
@return (ctype) Return ctype that corresponds to pyclustering type data.
|
94
|
|
|
|
95
|
|
|
"""
|
96
|
|
|
return pyclustering_type_data.__PYCLUSTERING_CTYPE_MAP[pyclustering_package_type];
|
97
|
|
|
|
98
|
|
|
@staticmethod
|
99
|
|
|
def get_pyclustering_type(data_ctype):
|
100
|
|
|
"""!
|
101
|
|
|
@return (unit) Return pyclustering data type that corresponds to ctype.
|
102
|
|
|
|
103
|
|
|
"""
|
104
|
|
|
return pyclustering_type_data.__CTYPE_PYCLUSTERING_MAP[data_ctype];
|
105
|
|
|
|
106
|
|
|
|
107
|
|
|
class package_builder:
|
108
|
|
|
"""!
|
109
|
|
|
@brief Package builder provides service to create 'pyclustering_package' from data that is stored in 'list' container.
|
110
|
|
|
|
111
|
|
|
"""
|
112
|
|
|
def __init__(self, dataset, c_data_type):
|
113
|
|
|
"""!
|
114
|
|
|
@brief Initialize package builder object by dataset.
|
115
|
|
|
|
116
|
|
|
@param[in] dataset (list): Data that should be packed in 'pyclustering_package'.
|
117
|
|
|
@param[in] c_data_type (ctype.type): If specified than specified data type is used for data storing in package.
|
118
|
|
|
|
119
|
|
|
"""
|
120
|
|
|
self.__dataset = dataset;
|
121
|
|
|
self.__c_data_type = c_data_type;
|
122
|
|
|
|
123
|
|
|
|
124
|
|
|
def create(self):
|
125
|
|
|
"""!
|
126
|
|
|
@brief Performs packing procedure of the data to the package.
|
127
|
|
|
|
128
|
|
|
@return (pointer) ctype-pointer to pyclustering package.
|
129
|
|
|
|
130
|
|
|
"""
|
131
|
|
|
return self.__create_package(self.__dataset);
|
132
|
|
|
|
133
|
|
|
|
134
|
|
|
def __is_container_type(self, value):
|
135
|
|
|
if (isinstance(value, list) or isinstance(value, tuple)):
|
136
|
|
|
return True;
|
137
|
|
|
|
138
|
|
|
return False;
|
139
|
|
|
|
140
|
|
|
|
141
|
|
|
def __get_type(self, pyclustering_data_type):
|
142
|
|
|
if (self.__c_data_type is None):
|
143
|
|
|
return pyclustering_data_type;
|
144
|
|
|
|
145
|
|
|
return self.__c_data_type;
|
146
|
|
|
|
147
|
|
|
|
148
|
|
|
def __create_package(self, dataset):
|
149
|
|
|
dataset_package = pyclustering_package();
|
150
|
|
|
|
151
|
|
|
dataset_package.size = len(dataset);
|
152
|
|
|
|
153
|
|
|
if (len(dataset) == 0):
|
154
|
|
|
dataset_package.type = pyclustering_type_data.PYCLUSTERING_TYPE_UNDEFINED;
|
155
|
|
|
dataset_package.data = None;
|
156
|
|
|
|
157
|
|
|
return pointer(dataset_package);
|
158
|
|
|
|
159
|
|
|
c_data_type = self.__fill_type(dataset_package, dataset);
|
160
|
|
|
self.__fill_data(dataset_package, c_data_type, dataset);
|
161
|
|
|
|
162
|
|
|
return pointer(dataset_package);
|
163
|
|
|
|
164
|
|
|
|
165
|
|
|
def __fill_dataset_type(self, dataset_package, dataset):
|
166
|
|
|
if (self.__is_container_type(dataset[0])):
|
167
|
|
|
dataset_package.type = pyclustering_type_data.PYCLUSTERING_TYPE_LIST;
|
168
|
|
|
|
169
|
|
|
elif (isinstance(dataset[0], int)):
|
170
|
|
|
dataset_package.type = pyclustering_type_data.PYCLUSTERING_TYPE_LONG;
|
171
|
|
|
|
172
|
|
|
elif (isinstance(dataset[0], float)):
|
173
|
|
|
dataset_package.type = pyclustering_type_data.PYCLUSTERING_TYPE_DOUBLE;
|
174
|
|
|
|
175
|
|
|
else:
|
176
|
|
|
raise NameError("Not supported type of pyclustering package.");
|
177
|
|
|
|
178
|
|
|
return pyclustering_type_data.get_ctype(dataset_package.type);
|
179
|
|
|
|
180
|
|
|
|
181
|
|
|
def __fill_specify_type(self, dataset_package):
|
182
|
|
|
dataset_package.type = pyclustering_type_data.get_pyclustering_type(self.__c_data_type);
|
183
|
|
|
return self.__c_data_type;
|
184
|
|
|
|
185
|
|
|
|
186
|
|
|
def __fill_type(self, dataset_package, dataset):
|
187
|
|
|
if (self.__is_container_type(dataset[0])):
|
188
|
|
|
dataset_package.type = pyclustering_type_data.PYCLUSTERING_TYPE_LIST;
|
189
|
|
|
return None;
|
190
|
|
|
|
191
|
|
|
if (self.__c_data_type is None):
|
192
|
|
|
return self.__fill_dataset_type(dataset_package, dataset);
|
193
|
|
|
|
194
|
|
|
return self.__fill_specify_type(dataset_package);
|
195
|
|
|
|
196
|
|
|
|
197
|
|
|
def __fill_data(self, dataset_package, c_data_type, dataset):
|
198
|
|
|
if (dataset_package.type == pyclustering_type_data.PYCLUSTERING_TYPE_LIST):
|
199
|
|
|
package_data = (POINTER(pyclustering_package) * len(dataset))();
|
200
|
|
|
for index in range(len(dataset)):
|
201
|
|
|
package_data[index] = self.__create_package(dataset[index]);
|
202
|
|
|
|
203
|
|
|
dataset_package.data = cast(package_data, POINTER(c_void_p));
|
204
|
|
|
else:
|
205
|
|
|
array_object = (c_data_type * len(dataset))(*dataset);
|
206
|
|
|
dataset_package.data = cast(array_object, POINTER(c_void_p));
|
207
|
|
|
|
208
|
|
|
|
209
|
|
|
|
210
|
|
|
class package_extractor:
|
211
|
|
|
"""!
|
212
|
|
|
@brief Package extractor provides servies to unpack pyclustering package.
|
213
|
|
|
|
214
|
|
|
"""
|
215
|
|
|
def __init__(self, package_pointer):
|
216
|
|
|
"""!
|
217
|
|
|
@brief Initialize package extractor object by ctype-pointer to 'pyclustering_package'.
|
218
|
|
|
|
219
|
|
|
@param[in] package_pointer (pointer): ctype-pointer to 'pyclustering_package' that should be used for unpacking.
|
220
|
|
|
|
221
|
|
|
"""
|
222
|
|
|
self.__package_pointer = package_pointer;
|
223
|
|
|
|
224
|
|
|
|
225
|
|
|
def extract(self):
|
226
|
|
|
"""!
|
227
|
|
|
@brief Performs unpacking procedure of the pyclustering package to the data.
|
228
|
|
|
|
229
|
|
|
@return (list) Extracted data from the pyclustering package.
|
230
|
|
|
|
231
|
|
|
"""
|
232
|
|
|
return self.__extract_data(self.__package_pointer);
|
233
|
|
|
|
234
|
|
|
|
235
|
|
|
def __extract_data(self, ccore_package_pointer):
|
236
|
|
|
if (ccore_package_pointer == 0):
|
237
|
|
|
return [];
|
238
|
|
|
|
239
|
|
|
pointer_package = cast(ccore_package_pointer, POINTER(pyclustering_package));
|
240
|
|
|
return self.__unpack_pointer_data(pointer_package);
|
241
|
|
|
|
242
|
|
|
|
243
|
|
|
def __unpack_data(self, pointer_package, pointer_data, type_package):
|
244
|
|
|
result = [];
|
245
|
|
|
|
246
|
|
|
for index in range(0, pointer_package[0].size):
|
247
|
|
|
if (type_package == pyclustering_type_data.PYCLUSTERING_TYPE_LIST):
|
248
|
|
|
pointer_package = cast(pointer_data[index], (POINTER(pyclustering_package)));
|
249
|
|
|
result.append(self.__extract_data(pointer_package));
|
250
|
|
|
|
251
|
|
|
else:
|
252
|
|
|
result.append(pointer_data[index]);
|
253
|
|
|
|
254
|
|
|
return result;
|
255
|
|
|
|
256
|
|
|
|
257
|
|
|
def __unpack_pointer_data(self, pointer_package):
|
258
|
|
|
type_package = pointer_package[0].type;
|
259
|
|
|
|
260
|
|
|
if (pointer_package[0].size == 0):
|
261
|
|
|
return [];
|
262
|
|
|
|
263
|
|
|
pointer_data = cast(pointer_package[0].data, POINTER(pyclustering_type_data.get_ctype(type_package)));
|
264
|
|
|
return self.__unpack_data(pointer_package, pointer_data, type_package);
|
265
|
|
|
|