File: cpl_column.h

package info (click to toggle)
cpl 6.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 18,764 kB
  • sloc: ansic: 111,368; sh: 14,549; makefile: 626
file content (305 lines) | stat: -rw-r--r-- 15,247 bytes parent folder | download
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
/* $Id: cpl_column.h,v 1.50 2012/02/27 16:12:47 rpalsa Exp $
 *
 * This file is part of the ESO Common Pipeline Library
 * Copyright (C) 2001-2008 European Southern Observatory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/*
 * $Author: rpalsa $
 * $Date: 2012/02/27 16:12:47 $
 * $Revision: 1.50 $
 * $Name: cpl-6_1_1 $
 */

#ifndef CPL_COLUMN_H
#define CPL_COLUMN_H

#include <complex.h>
#include <cpl_macros.h>
#include <cpl_type.h>
#include <cpl_error.h>
#include <cpl_array.h>

CPL_BEGIN_DECLS


/*
 *  This is the type used for any flag used in cpl_column.
 */

typedef int cpl_column_flag;

typedef struct _cpl_column_ cpl_column;

void cpl_column_dump_structure(cpl_column *column);
void cpl_column_dump(cpl_column *column, cpl_size start, cpl_size count);

/*
 * Constructors and destructors:
 */

cpl_column *cpl_column_new_int(cpl_size length);
cpl_column *cpl_column_new_long(cpl_size length);
cpl_column *cpl_column_new_long_long(cpl_size length);
cpl_column *cpl_column_new_cplsize(cpl_size length);
cpl_column *cpl_column_new_float(cpl_size length);
cpl_column *cpl_column_new_double(cpl_size length);
cpl_column *cpl_column_new_float_complex(cpl_size length);
cpl_column *cpl_column_new_double_complex(cpl_size length);
cpl_column *cpl_column_new_string(cpl_size length);
cpl_column *cpl_column_new_array(cpl_type, cpl_size, cpl_size);

cpl_error_code cpl_column_set_save_type(cpl_column *, cpl_type);
cpl_type cpl_column_get_save_type(const cpl_column *);

cpl_column *cpl_column_wrap_int(int *, cpl_size length);
cpl_column *cpl_column_wrap_long(long *, cpl_size length);
cpl_column *cpl_column_wrap_long_long(long long *, cpl_size length);
cpl_column *cpl_column_wrap_cplsize(cpl_size *, cpl_size length);
cpl_column *cpl_column_wrap_float(float *, cpl_size length);
cpl_column *cpl_column_wrap_double(double *, cpl_size length);
cpl_column *cpl_column_wrap_float_complex(float complex *, cpl_size length);
cpl_column *cpl_column_wrap_double_complex(double complex *, cpl_size length);
cpl_column *cpl_column_wrap_string(char **, cpl_size length);

void *cpl_column_unwrap(cpl_column *);
void cpl_column_delete_but_strings(cpl_column *);
void cpl_column_delete_but_arrays(cpl_column *);

cpl_error_code cpl_column_copy_data(cpl_column *, const double *);
cpl_error_code cpl_column_copy_data_int(cpl_column *, const int *);
cpl_error_code cpl_column_copy_data_long(cpl_column *, const long *);
cpl_error_code cpl_column_copy_data_long_long(cpl_column *, const long long *);
cpl_error_code cpl_column_copy_data_cplsize(cpl_column *, const cpl_size *);
cpl_error_code cpl_column_copy_data_float(cpl_column *, const float *);
cpl_error_code cpl_column_copy_data_double(cpl_column *, const double *);
cpl_error_code cpl_column_copy_data_complex(cpl_column *,
                                            const double complex *);
cpl_error_code cpl_column_copy_data_float_complex(cpl_column *,
                                                  const float complex *);
cpl_error_code cpl_column_copy_data_double_complex(cpl_column *,
                                                   const double complex *);
cpl_error_code cpl_column_copy_data_string(cpl_column *, const char **);

void cpl_column_delete(cpl_column *);


/*
 * Methods:
 */

cpl_error_code cpl_column_set_name(cpl_column *, const char *);
const char *cpl_column_get_name(const cpl_column *);

cpl_error_code cpl_column_set_unit(cpl_column *, const char *);
const char *cpl_column_get_unit(const cpl_column *);

cpl_error_code cpl_column_set_format(cpl_column *, const char *);
const char *cpl_column_get_format(const cpl_column *);

cpl_size cpl_column_get_size(const cpl_column *);
cpl_size cpl_column_get_depth(const cpl_column *);
cpl_size cpl_column_get_dimensions(const cpl_column *);
cpl_error_code cpl_column_set_dimensions(cpl_column *, const cpl_array *);
cpl_size cpl_column_get_dimension(const cpl_column *, cpl_size);

cpl_type cpl_column_get_type(const cpl_column *);

int *cpl_column_get_data_int(cpl_column *);
const int *cpl_column_get_data_int_const(const cpl_column *);
long *cpl_column_get_data_long(cpl_column *);
const long *cpl_column_get_data_long_const(const cpl_column *);
long long *cpl_column_get_data_long_long(cpl_column *);
const long long *cpl_column_get_data_long_long_const(const cpl_column *);
cpl_size *cpl_column_get_data_cplsize(cpl_column *);
const cpl_size *cpl_column_get_data_cplsize_const(const cpl_column *);
float *cpl_column_get_data_float(cpl_column *);
const float *cpl_column_get_data_float_const(const cpl_column *);
double *cpl_column_get_data_double(cpl_column *);
const double *cpl_column_get_data_double_const(const cpl_column *);
float complex *cpl_column_get_data_float_complex(cpl_column *);
const float complex *
cpl_column_get_data_float_complex_const(const cpl_column *);
double complex *cpl_column_get_data_double_complex(cpl_column *);
const double complex *
cpl_column_get_data_double_complex_const(const cpl_column *);
char **cpl_column_get_data_string(cpl_column *);
const char **cpl_column_get_data_string_const(const cpl_column *);
cpl_array **cpl_column_get_data_array(cpl_column *);
const cpl_array **cpl_column_get_data_array_const(const cpl_column *);
cpl_column_flag *cpl_column_get_data_invalid(cpl_column *);
const cpl_column_flag *cpl_column_get_data_invalid_const(const cpl_column *);
cpl_error_code cpl_column_set_data_invalid(cpl_column *, 
                                           cpl_column_flag *, cpl_size);

cpl_error_code cpl_column_set_size(cpl_column *, cpl_size);
cpl_error_code cpl_column_set_depth(cpl_column *, cpl_size);

double cpl_column_get(cpl_column *, cpl_size, int *null); 
double complex cpl_column_get_complex(cpl_column *, cpl_size , int *null);
int cpl_column_get_int(cpl_column *, cpl_size, int *null); 
long cpl_column_get_long(cpl_column *, cpl_size, int *null);
long long cpl_column_get_long_long(cpl_column *, cpl_size, int *null);
cpl_size cpl_column_get_cplsize(cpl_column *, cpl_size, int *null);
float cpl_column_get_float(cpl_column *, cpl_size, int *null); 
double cpl_column_get_double(cpl_column *, cpl_size, int *null); 
float complex cpl_column_get_float_complex(cpl_column *, cpl_size, int *null);
double complex cpl_column_get_double_complex(cpl_column *, cpl_size, int *null);
char *cpl_column_get_string(cpl_column *, cpl_size);
const char *cpl_column_get_string_const(const cpl_column *, cpl_size);
cpl_array *cpl_column_get_array(cpl_column *, cpl_size);
const cpl_array *cpl_column_get_array_const(const cpl_column *, cpl_size);

cpl_error_code cpl_column_set(cpl_column *, cpl_size, double); 
cpl_error_code cpl_column_set_int(cpl_column *, cpl_size, int); 
cpl_error_code cpl_column_set_long(cpl_column *, cpl_size, long);
cpl_error_code cpl_column_set_long_long(cpl_column *, cpl_size, long long);
cpl_error_code cpl_column_set_cplsize(cpl_column *, cpl_size, cpl_size);
cpl_error_code cpl_column_set_float(cpl_column *, cpl_size, float); 
cpl_error_code cpl_column_set_double(cpl_column *, cpl_size, double); 
cpl_error_code cpl_column_set_complex(cpl_column *, cpl_size, double complex);
cpl_error_code cpl_column_set_float_complex(cpl_column *, cpl_size, float complex);
cpl_error_code cpl_column_set_double_complex(cpl_column *, cpl_size, double complex);
cpl_error_code cpl_column_set_string(cpl_column *, cpl_size, const char *);
cpl_error_code cpl_column_set_array(cpl_column *, cpl_size, const cpl_array *);

cpl_error_code cpl_column_fill(cpl_column *, cpl_size, cpl_size, double); 
cpl_error_code cpl_column_fill_int(cpl_column *, cpl_size, cpl_size, int); 
cpl_error_code cpl_column_fill_long(cpl_column *, cpl_size, cpl_size, long);
cpl_error_code cpl_column_fill_long_long(cpl_column *, cpl_size, cpl_size, long long);
cpl_error_code cpl_column_fill_cplsize(cpl_column *, cpl_size, cpl_size, cpl_size);
cpl_error_code cpl_column_fill_float(cpl_column *, cpl_size, cpl_size, float); 
cpl_error_code cpl_column_fill_double(cpl_column *, cpl_size, cpl_size, double);
cpl_error_code cpl_column_fill_complex(cpl_column *, cpl_size, cpl_size, double complex);
cpl_error_code cpl_column_fill_float_complex(cpl_column *, 
                                             cpl_size, cpl_size, float complex);
cpl_error_code cpl_column_fill_double_complex(cpl_column *, 
                                              cpl_size, cpl_size, double complex);
cpl_error_code cpl_column_fill_string(cpl_column *, cpl_size, cpl_size, const char *);
cpl_error_code cpl_column_fill_array(cpl_column *, cpl_size, cpl_size, const cpl_array *);

cpl_error_code cpl_column_copy_segment(cpl_column *, cpl_size, cpl_size, double *);
cpl_error_code cpl_column_copy_segment_int(cpl_column *, cpl_size, cpl_size, int *);
cpl_error_code cpl_column_copy_segment_long(cpl_column *, cpl_size, cpl_size, long *);
cpl_error_code cpl_column_copy_segment_long_long(cpl_column *, cpl_size,
                                                 cpl_size, long long *);
cpl_error_code cpl_column_copy_segment_cplsize(cpl_column *, cpl_size,
                                               cpl_size, cpl_size *);
cpl_error_code cpl_column_copy_segment_float(cpl_column *, cpl_size, cpl_size, float *);
cpl_error_code cpl_column_copy_segment_double(cpl_column *, cpl_size, cpl_size, double *);
cpl_error_code cpl_column_copy_segment_complex(cpl_column *, 
                                               cpl_size, cpl_size, double complex *);
cpl_error_code cpl_column_copy_segment_float_complex(cpl_column *, 
                                               cpl_size, cpl_size, float complex *);
cpl_error_code cpl_column_copy_segment_double_complex(cpl_column *, 
                                               cpl_size, cpl_size, double complex *);
cpl_error_code cpl_column_copy_segment_string(cpl_column *, cpl_size, cpl_size, char **);
cpl_error_code cpl_column_copy_segment_array(cpl_column *, cpl_size, cpl_size, 
                                             cpl_array **);

cpl_error_code cpl_column_shift(cpl_column *, cpl_size);

cpl_error_code cpl_column_set_invalid(cpl_column *, cpl_size);
cpl_error_code cpl_column_fill_invalid(cpl_column *, cpl_size, cpl_size);
int cpl_column_is_invalid(cpl_column *, cpl_size);
int cpl_column_has_invalid(cpl_column *);
int cpl_column_has_valid(cpl_column *);
cpl_size cpl_column_count_invalid(cpl_column *);

cpl_error_code cpl_column_fill_invalid_int(cpl_column *, int);
cpl_error_code cpl_column_fill_invalid_long(cpl_column *, long);
cpl_error_code cpl_column_fill_invalid_long_long(cpl_column *, long long);
cpl_error_code cpl_column_fill_invalid_cplsize(cpl_column *, cpl_size);
cpl_error_code cpl_column_fill_invalid_float(cpl_column *, float);
cpl_error_code cpl_column_fill_invalid_double(cpl_column *, double);
cpl_error_code cpl_column_fill_invalid_float_complex(cpl_column *, 
                                                     float complex);
cpl_error_code cpl_column_fill_invalid_double_complex(cpl_column *, 
                                                     double complex);

cpl_error_code cpl_column_erase_segment(cpl_column *, cpl_size, cpl_size);
cpl_error_code cpl_column_erase_pattern(cpl_column *, int *);
cpl_error_code cpl_column_insert_segment(cpl_column *, cpl_size, cpl_size);

cpl_column *cpl_column_duplicate(cpl_column *);

cpl_column *cpl_column_extract(cpl_column *, cpl_size, cpl_size);

cpl_column *cpl_column_cast_to_int(cpl_column *);
cpl_column *cpl_column_cast_to_long(cpl_column *);
cpl_column *cpl_column_cast_to_long_long(cpl_column *);
cpl_column *cpl_column_cast_to_cplsize(cpl_column *);
cpl_column *cpl_column_cast_to_float(cpl_column *);
cpl_column *cpl_column_cast_to_double(cpl_column *);
cpl_column *cpl_column_cast_to_float_complex(cpl_column *);
cpl_column *cpl_column_cast_to_double_complex(cpl_column *);
cpl_column *cpl_column_cast_to_int_array(cpl_column *);
cpl_column *cpl_column_cast_to_long_array(cpl_column *);
cpl_column *cpl_column_cast_to_long_long_array(cpl_column *);
cpl_column *cpl_column_cast_to_cplsize_array(cpl_column *);
cpl_column *cpl_column_cast_to_float_array(cpl_column *);
cpl_column *cpl_column_cast_to_double_array(cpl_column *);
cpl_column *cpl_column_cast_to_float_complex_array(cpl_column *);
cpl_column *cpl_column_cast_to_double_complex_array(cpl_column *);
cpl_column *cpl_column_cast_to_int_flat(cpl_column *);
cpl_column *cpl_column_cast_to_long_flat(cpl_column *);
cpl_column *cpl_column_cast_to_long_long_flat(cpl_column *);
cpl_column *cpl_column_cast_to_cplsize_flat(cpl_column *);
cpl_column *cpl_column_cast_to_float_flat(cpl_column *);
cpl_column *cpl_column_cast_to_double_flat(cpl_column *);
cpl_column *cpl_column_cast_to_float_complex_flat(cpl_column *);
cpl_column *cpl_column_cast_to_double_complex_flat(cpl_column *);

cpl_error_code cpl_column_merge(cpl_column *, cpl_column *, cpl_size);

cpl_error_code cpl_column_add(cpl_column *, cpl_column *);
cpl_error_code cpl_column_subtract(cpl_column *, cpl_column *);
cpl_error_code cpl_column_multiply(cpl_column *, cpl_column *);
cpl_error_code cpl_column_divide(cpl_column *, cpl_column *);

cpl_error_code cpl_column_add_scalar(cpl_column *, double);
cpl_error_code cpl_column_add_scalar_complex(cpl_column *, double complex);
cpl_error_code cpl_column_subtract_scalar(cpl_column *, double);
cpl_error_code cpl_column_subtract_scalar_complex(cpl_column *, double complex);
cpl_error_code cpl_column_multiply_scalar(cpl_column *, double);
cpl_error_code cpl_column_multiply_scalar_complex(cpl_column *, double complex);
cpl_error_code cpl_column_divide_scalar(cpl_column *, double);
cpl_error_code cpl_column_divide_scalar_complex(cpl_column *, double complex);
cpl_error_code cpl_column_absolute(cpl_column *);
cpl_column *cpl_column_absolute_complex(cpl_column *);
cpl_column *cpl_column_phase_complex(cpl_column *);
cpl_column *cpl_column_extract_real(cpl_column *);
cpl_column *cpl_column_extract_imag(cpl_column *);
cpl_error_code cpl_column_logarithm(cpl_column *, double);
cpl_error_code cpl_column_power(cpl_column *, double);
cpl_error_code cpl_column_exponential(cpl_column *, double);
cpl_error_code cpl_column_conjugate(cpl_column *);

double cpl_column_get_mean(cpl_column *);
double complex cpl_column_get_mean_complex(cpl_column *);
double cpl_column_get_median(cpl_column *);
double cpl_column_get_stdev(cpl_column *);

double cpl_column_get_max(cpl_column *);
double cpl_column_get_min(cpl_column *);
cpl_error_code cpl_column_get_maxpos(cpl_column *, cpl_size *);
cpl_error_code cpl_column_get_minpos(cpl_column *, cpl_size *);

CPL_END_DECLS

#endif
/* end of cpl_column.h */