datastruct.h

Go to the documentation of this file.

/***************************************************
Apache License Version 2.0

Copyright 2007-2011 EcoEquity and Stockholm Environment Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the specific language governing
permissions and limitations under the License.
****************************************************/

#ifndef DATASTRUCT_H
#define DATASTRUCT_H

/*
 * This defines data structures for blocks of data arranged by record x year
 * Each "record" might correspond, for example, to a country.
 *
 * The number of records must be the same for each data block, and so it
 * is part of "app data". The number of years can vary by data block. However,
 * there are "app"-wide minimum and maximum years. These are not used when
 * reading data blocks, but might be used by functions that use these
 * data structures.
 *
 */

#define DBLOCK_OK 0
#define DBLOCK_FREADERROR 1
#define DBLOCK_FCLOSEERROR 2
#define DBLOCK_NOMEM 3
#define DBLOCK_NRECMISMATCH 4
#define DBLOCK_BADYEARS 5

struct appdata {
    int numrecs; 
    int minyear; 
    int maxyear; 
};

struct datablock {
    int y_start; 
    int y_end; 
    double *data; 
};

typedef struct datablock* datablockp;

typedef datablockp* datablockpp;

struct fixedfactor {
   double *data; 
};

struct timeseries {
   int y_start; 
   int y_end; 
   double *data; 
};

// Read in datablock from a formatted file--0 on success
int getdata(char *fname, struct datablock *dblock, struct appdata ad);
// A fixed factor has no time dimension
int getff(char *fname, struct fixedfactor *ff, char **name, int datacol, struct appdata ad);
// A timeseries has no records
int getts(char *fname, struct timeseries *ts, struct appdata ad);
// Get all values for a particular year from a datablock
void data2ff(struct datablock dblock, struct fixedfactor ff, int year, struct appdata ad);
// Put the values for a particular year into a datablock
void ff2data(struct fixedfactor ff, struct datablock dblock, int year, struct appdata ad);
// Note: must have sensible years defined to use this
int allocdata(struct datablock *dblock, struct appdata ad);
int allocff(struct fixedfactor *ff, struct appdata ad);
int allocts(struct timeseries *ts, struct appdata ad);
// Free the memory taken up by a datablock--0 on success
void cleardata(struct datablock dblock);
void clearff(struct fixedfactor ff);
void clearts(struct timeseries ts);

// Output
int writedb2delim(struct datablock dblock, char *fname, char delim, struct appdata ad);
int writets2delim(struct timeseries ts, char * fname, char delim, struct appdata ad);
int writeff2delim(struct fixedfactor ff, char * fname, char delim, struct appdata ad);

// Get the data value from the datablock for specified country (row) & year
// Return NAN if out of bounds
double getval(struct datablock db, int ctry, int year, struct appdata ad);
void setval(struct datablock db, double val, int row, int year, struct appdata ad);

double gettsval(struct timeseries ts, int year, struct appdata ad);
void settsval(struct timeseries ts, double val, int year, struct appdata ad);

double getffval(struct fixedfactor ff, int row, struct appdata ad);
void setffval(struct fixedfactor ff, double val, int row, struct appdata ad);

#endif