include/sk_out.h

   1 /* Apache 2.0 INS-AMU 2015 */
   2
   3 #ifndef SK_OUT_H
   4 #define SK_OUT_H
   5
   6 #include <stdio.h>
   7
   8 #include "sk_util.h"
   9
  10 #ifdef __cplusplus
  11 extern "C" {
  12 #endif
  13
  14 /** SK_DEFOUT aids in creating a new output definition.
  15  * See ::sk_out for details of the generated output callback signature.
  16  *
  17  * \param name name of output callback being defined.
  18  */
  19 #define SK_DEFOUT(name) int name(void * restrict data,\
  20                 double t,\
  21                 int nx, double * restrict x,\
  22                 int nc, double * restrict c)
  23
  24 /**
  25  * Callback signature expected by solver framework for output callbacks.
  26  * Use #SK_DEFOUT to declare or define a new output callback.
  27  *
  28  * \param data user data for output function such as simulation length.
  29  * \param t current time.
  30  * \param nx number of state variables.
  31  * \param x state variable vector.
  32  * \param nc number of coupling terms.
  33  * \param c coupling term vector.
  34  * \return 1 if the solver should continue, 0 to stop solver.
  35  */
  36 typedef SK_DEFOUT((*sk_out));
  37
  38 typedef struct sk_out_file_data sk_out_file_data;
  39
  40 /**
  41  * Allocate memory for file output.
  42  */
  43 sk_out_file_data *sk_out_file_alloc();
  44
  45 /**
  46  * Initialize file output from a file name.
  47  */
  48 int sk_out_file_from_fname(sk_out_file_data *d, char *fname);
  49
  50 /**
  51  * Initialize file output from stdout or stderr.
  52  */
  53 int sk_out_file_from_std(sk_out_file_data *d, FILE *std);
  54
  55 /**
  56  * Query whether file output is on stdout stderr.
  57  */
  58 int sk_out_file_is_std(sk_out_file_data *d);
  59
  60 /**
  61  * Get file pointer.
  62  */
  63 FILE *sk_out_file_get_fd(sk_out_file_data *d);
  64
  65 /**
  66  * Free memory allocated for file output.
  67  */
  68 void sk_out_file_free(sk_out_file_data *d);
  69
  70 /**
  71  * Callback implementing file output.
  72  */
  73 SK_DEFOUT(sk_out_file);
  74
  75 /* auto-allocating array */
  76 typedef struct sk_out_mem_data sk_out_mem_data;
  77
  78 /**
  79  * Get number of state variables in memory buffer.
  80  */
  81 int sk_out_mem_get_nx(sk_out_mem_data *d);
  82
  83 /**
  84  * Get number of coupling variables in memory buffer.
  85  */
  86 int sk_out_mem_get_nc(sk_out_mem_data *d);
  87
  88 /**
  89  * Get number of samples in memory buffer.
  90  */
  91 int sk_out_mem_get_n_sample(sk_out_mem_data *d);
  92
  93 /**
  94  * Get capacity in number of samples in memory buffer.
  95  */
  96 int sk_out_mem_get_capacity(sk_out_mem_data *d);
  97
  98 /**
  99  * Get state variable buffer.
 100  */
 101 double *sk_out_mem_get_xs(sk_out_mem_data *d);
 102
 103 /**
 104  * Get coupling variable buffer.
 105  */
 106 double *sk_out_mem_get_cs(sk_out_mem_data *d);
 107
 108 /**
 109  * Allocate memory for output memory buffer.
 110  */
 111 sk_out_mem_data *sk_out_mem_alloc();
 112
 113 /**
 114  * Initialize output memory buffer.
 115  */
 116 int sk_out_mem_init(sk_out_mem_data *d);
 117
 118 /**
 119  * Free memory allocated to output memory buffer.
 120  */
 121 void sk_out_mem_free(sk_out_mem_data *d);
 122
 123 /**
 124  * Callback implementing output memory buffer.
 125  */
 126 SK_DEFOUT(sk_out_mem);
 127
 128 /* split n-ways */
 129 typedef struct sk_out_tee_data sk_out_tee_data;
 130
 131 /**
 132  * Allocate output splitter.
 133  */
 134 sk_out_tee_data *sk_out_tee_alloc();
 135
 136 /**
 137  * Initialize output splitter.
 138  *
 139  * \param d splitter instance
 140  * \param nout number of outputs to distribute to
 141  */
 142 int sk_out_tee_init(sk_out_tee_data *d, int nout);
 143
 144 /**
 145  * Get number of outputs for splitter.
 146  */
 147 int sk_out_tee_get_nout(sk_out_tee_data *d);
 148
 149 /**
 150  * Get NULL status of out data array.
 151  */
 152 int sk_out_tee_outd_is_null();
 153
 154 /**
 155  * Get NULL status of out callback array.
 156  */
 157 int sk_out_tee_outs_is_null();
 158
 159 /**
 160  * Set i'th output of splitter.
 161  *
 162  * \param d splitter instance
 163  * \param i output index
 164  * \param out i'th output callback
 165  * \param data i'th output user data
 166  */
 167 int sk_out_tee_set_out(sk_out_tee_data *d, int i, sk_out out, void *data);
 168
 169 /**
 170  * Get i'th output callback.
 171  */
 172 sk_out sk_out_tee_get_out_i(sk_out_tee_data *d, int i);
 173
 174 /**
 175  * Get i'th output user data.
 176  */
 177 void *sk_out_tee_get_outd_i(sk_out_tee_data *d, int i);
 178
 179 /**
 180  * Free memory allocated to splitter output.
 181  */
 182 void sk_out_tee_free(sk_out_tee_data *d);
 183
 184 /**
 185  * Callback implementing output splitter.
 186  */
 187 SK_DEFOUT(sk_out_tee);
 188
 189 /* TODO general temporal filter */
 190
 191 /* temporal average */
 192 typedef struct sk_out_tavg_data sk_out_tavg_data;
 193
 194 /**
 195  * Allocate memory for temporal average output.
 196  */
 197 sk_out_tavg_data *sk_out_tavg_alloc();
 198
 199 /**
 200  * Initialize temporal average output.
 201  */
 202 int sk_out_tavg_init(sk_out_tavg_data *d, int len, sk_out out, void *outd);
 203
 204 /**
 205  * Get len of temporal average output.
 206  */
 207 int sk_out_tavg_get_len(sk_out_tavg_data *d);
 208
 209 /**
 210  * Get pos of temporal average output.
 211  */
 212 int sk_out_tavg_get_pos(sk_out_tavg_data *d);
 213
 214 /**
 215  * Get t of temporal average output.
 216  */
 217 double sk_out_tavg_get_t(sk_out_tavg_data *d);
 218
 219 /**
 220  * Get out of temporal average output.
 221  */
 222 sk_out sk_out_tavg_get_out(sk_out_tavg_data *d);
 223
 224 /**
 225  * Get outd of temporal average output.
 226  */
 227 void *sk_out_tavg_get_outd(sk_out_tavg_data *d);
 228
 229 /**
 230  * Get x of temporal average output.
 231  */
 232 double *sk_out_tavg_get_x(sk_out_tavg_data *d);
 233
 234 /**
 235  * Get c of temporal average output.
 236  */
 237 double *sk_out_tavg_get_c(sk_out_tavg_data *d);
 238
 239 /**
 240  * Free memory allocated to temporal average output.
 241  */
 242 void sk_out_tavg_free(sk_out_tavg_data *d);
 243
 244 /**
 245  * Callback implementing temporal average output.
 246  */
 247 SK_DEFOUT(sk_out_tavg);
 248
 249 /* spatial filter (bank) */
 250 typedef struct sk_out_sfilt_data sk_out_sfilt_data;
 251
 252 /**
 253  * Allocate memory for spatial filter output.
 254  */
 255 sk_out_sfilt_data *sk_out_sfilt_alloc();
 256
 257 /**
 258  * Initialize spatial filter output.
 259  */
 260 int sk_out_sfilt_init(sk_out_sfilt_data *d, int nfilt, int filtlen,
 261                 double *xfilts, double *cfilts, sk_out out, void *outd);
 262
 263 /**
 264  * Get nfilt of spatial filter output.
 265  */
 266 int sk_out_sfilt_get_nfilt(sk_out_sfilt_data *d);
 267
 268 /**
 269  * Get filtlen of spatial filter output.
 270  */
 271 int sk_out_sfilt_get_filtlen(sk_out_sfilt_data *d);
 272
 273 /**
 274  * Get xfilts of spatial filter output.
 275  */
 276 double *sk_out_sfilt_get_xfilts(sk_out_sfilt_data *d);
 277
 278 /**
 279  * Get cfilts of spatial filter output.
 280  */
 281 double *sk_out_sfilt_get_cfilts(sk_out_sfilt_data *d);
 282
 283 /**
 284  * Get x of spatial filter output.
 285  */
 286 double *sk_out_sfilt_get_x(sk_out_sfilt_data *d);
 287
 288 /**
 289  * Get c of spatial filter output.
 290  */
 291 double *sk_out_sfilt_get_c(sk_out_sfilt_data *d);
 292
 293 /**
 294  * Get out of spatial filter output.
 295  */
 296 sk_out sk_out_sfilt_get_out(sk_out_sfilt_data *d);
 297
 298 /**
 299  * Get outd of spatial filter output.
 300  */
 301 void *sk_out_sfilt_get_outd(sk_out_sfilt_data *d);
 302
 303 /**
 304  * Free memory allocated to spatial filter output.
 305  */
 306 void sk_out_sfilt_free(sk_out_sfilt_data *d);
 307
 308 /**
 309  * Callback implementing spatial filter monitor.
 310  */
 311 SK_DEFOUT(sk_out_sfilt);
 312
 313 #ifdef __cplusplus
 314 }; /* extern "C" */
 315 #endif
 316
 317 #endif