Data Structures
struct	appdata
	For the application, basic dimensions: number of countries and bounding years. More...

struct	datablock
	A two-dimensional array that contains information for country/year combinations. More...

struct	fixedfactor
	A one-dimensional array that contains information on countries that is the same for all years. More...

struct	timeseries
	A one-dimensional array that contains global information that is the same for all countries. More...

Macros
#define	DBLOCK_OK 0

#define	DBLOCK_FREADERROR 1

#define	DBLOCK_FCLOSEERROR 2

#define	DBLOCK_NOMEM 3

#define	DBLOCK_NRECMISMATCH 4

#define	DBLOCK_BADYEARS 5

Typedefs
typedef struct datablock *	datablockp
	Pointer to a datablock. More...

typedef datablockp *	datablockpp
	Pointer to a datablock pointer: for building arrays of datablock pointers. More...

Functions
int	getdata (char fname, struct datablock dblock, struct appdata ad)
	Read a datablock from a formatted file. More...

int	getff (char fname, struct fixedfactor ff, char **name, int datacol, struct appdata ad)
	Read a fixedfactor from a formatted file. More...

int	getts (char fname, struct timeseries ts, struct appdata ad)
	Read a timeseries from a formatted file. More...

void	data2ff (struct datablock dblock, struct fixedfactor ff, int year, struct appdata ad)
	Get all values for a particular year from a datablock. More...

void	ff2data (struct fixedfactor ff, struct datablock dblock, int year, struct appdata ad)
	Put the values for a particular year into a datablock. More...

int	allocdata (struct datablock *dblock, struct appdata ad)
	Create a datablock in memory, using application-specific dimensions. More...

int	allocff (struct fixedfactor *ff, struct appdata ad)
	Create a fixedfactor in memory, of length = number of countries. More...

int	allocts (struct timeseries *ts, struct appdata ad)
	Create a timeseries in memory, of length = y_start - y_end + 1. More...

void	cleardata (struct datablock dblock)
	Free the memory taken up by a datablock. More...

void	clearff (struct fixedfactor ff)
	Free the memory taken up by a fixedfactor. More...

void	clearts (struct timeseries ts)
	Free the memory taken up by a timeseries. More...

int	writedb2delim (struct datablock dblock, char *fname, char delim, struct appdata ad)
	Convenience function to dump a datablock to a file. More...

int	writets2delim (struct timeseries ts, char *fname, char delim, struct appdata ad)
	Convenience function to dump a timeseries to a file. More...

int	writeff2delim (struct fixedfactor ff, char *fname, char delim, struct appdata ad)
	Convenience function to dump a fixedfactor to a file. More...

double	getval (struct datablock db, int ctry, int year, struct appdata ad)
	Get the data value from the datablock for specified row & year. More...

void	setval (struct datablock db, double val, int row, int year, struct appdata ad)
	Set a specific value in a datablock, specified by row and year. More...

double	gettsval (struct timeseries ts, int year, struct appdata ad)
	Get the value for a particular year from a timeseries. More...

void	settsval (struct timeseries ts, double val, int year, struct appdata ad)
	Set the value for a particular year in a timeseries. More...

double	getffval (struct fixedfactor ff, int row, struct appdata ad)
	Get a value for a specified row (country) from a fixedfactor. More...

void	setffval (struct fixedfactor ff, double val, int row, struct appdata ad)
	Set a value for a specified row (country) for a fixedfactor. More...

Macro Definition Documentation

◆ DBLOCK_BADYEARS

#define DBLOCK_BADYEARS 5

Definition at line 41 of file datastruct.h.

◆ DBLOCK_FCLOSEERROR

#define DBLOCK_FCLOSEERROR 2

Definition at line 38 of file datastruct.h.

◆ DBLOCK_FREADERROR

#define DBLOCK_FREADERROR 1

Definition at line 37 of file datastruct.h.

◆ DBLOCK_NOMEM

#define DBLOCK_NOMEM 3

Definition at line 39 of file datastruct.h.

◆ DBLOCK_NRECMISMATCH

#define DBLOCK_NRECMISMATCH 4

Definition at line 40 of file datastruct.h.

◆ DBLOCK_OK

#define DBLOCK_OK 0

Definition at line 36 of file datastruct.h.

Typedef Documentation

◆ datablockp

datablockp

Pointer to a datablock.

Definition at line 70 of file datastruct.h.

◆ datablockpp

datablockpp

Pointer to a datablock pointer: for building arrays of datablock pointers.

Definition at line 77 of file datastruct.h.

Function Documentation

◆ allocdata()

int allocdata	(	struct datablock *	dblock,
		struct appdata	ad
	)

Create a datablock in memory, using application-specific dimensions.

Parameters

dblock	Datablock to create
ad	appdata structure with dimensions

Returns: Success code Create a datablock of size numrecs * num years, filled with NaN

Definition at line 223 of file datastruct.c.

◆ allocff()

int allocff	(	struct fixedfactor *	ff,
		struct appdata	ad
	)

Create a fixedfactor in memory, of length = number of countries.

Parameters

ff	Fixed factor to allocate and fill
ad	appdata structure with dimensions

Returns: Success code Allocate space to ff and fill with NaN

Definition at line 254 of file datastruct.c.

◆ allocts()

int allocts	(	struct timeseries *	ts,
		struct appdata	ad
	)

Create a timeseries in memory, of length = y_start - y_end + 1.

Parameters

ts	Time series to allocate and fill
ad	appdata structure with dimensions

Returns: Success code Allocate space to ts and fill with NaN

Definition at line 278 of file datastruct.c.

◆ cleardata()

void cleardata ( struct datablock dblock )

Free the memory taken up by a datablock.

Parameters

dblock Datablock to free

Definition at line 305 of file datastruct.c.

◆ clearff()

void clearff ( struct fixedfactor ff )

Free the memory taken up by a fixedfactor.

Parameters

ff	Fixed factor to free

Definition at line 314 of file datastruct.c.

◆ clearts()

void clearts ( struct timeseries ts )

Free the memory taken up by a timeseries.

Parameters

ts	Time series to free

Definition at line 323 of file datastruct.c.

◆ data2ff()

void data2ff	(	struct datablock	dblock,
		struct fixedfactor	ff,
		int	year,
		struct appdata	ad
	)

Get all values for a particular year from a datablock.

Parameters

dblock	Data block, 2-d data structure
ff	Fixed factor data structure
year	Year to pull data from dblock
ad	appdata structure with dimensions Fill in ff from one column of dblock

Definition at line 190 of file datastruct.c.

◆ ff2data()

void ff2data	(	struct fixedfactor	ff,
		struct datablock	dblock,
		int	year,
		struct appdata	ad
	)

Put the values for a particular year into a datablock.

Parameters

ff	Fixed factor (that is, values for all countries for one year) to insert
dblock	Datablock for which values are inserted
year	Year where ff should be inserted into dblock
ad	appdata structure with dimensions Overwrite column for year=year of dblock

Definition at line 207 of file datastruct.c.

◆ getdata()

int getdata	(	char *	fname,
		struct datablock *	dblock,
		struct appdata	ad
	)

Read a datablock from a formatted file.

This file provides functions for manipulating the array data structures used by the calculator.

Parameters

fname	Name of the text file
dblock	Datablock to read into
ad	appdata structure with dimensions

Returns: Success code

Note: Not currently used because now we read from an SQLite3 database

Definition at line 40 of file datastruct.c.

◆ getff()

int getff	(	char *	fname,
		struct fixedfactor *	ff,
		char **	name,
		int	datacol,
		struct appdata	ad
	)

Read a fixedfactor from a formatted file.

Parameters

fname	Name of the input file
ff	Fixed factor data structure
name	Name of the data column to read in: reads from file
datacol	Index of the data column to read in
ad	appdata structure with dimensions

Returns: Success code

Note: Not currently used because now we read from an SQLite3 database

Definition at line 90 of file datastruct.c.

◆ getffval()

double getffval	(	struct fixedfactor	ff,
		int	row,
		struct appdata	ad
	)

Get a value for a specified row (country) from a fixedfactor.

Parameters

ff	Fixed factor to read from
row	Specified row (country index)
ad	appdata structure with dimensions

Returns: Value, or NaN if out of bounds

Definition at line 507 of file datastruct.c.

◆ getts()

int getts	(	char *	fname,
		struct timeseries *	ts,
		struct appdata	ad
	)

Read a timeseries from a formatted file.

Parameters

fname	Name of the input file
ts	Time series data structure to fill in
ad	appdata structure with dimensions

Returns: Success code

Note: Not currently used because now we read from an SQLite3 database

Definition at line 150 of file datastruct.c.

◆ gettsval()

double gettsval	(	struct timeseries	ts,
		int	year,
		struct appdata	ad
	)

Get the value for a particular year from a timeseries.

Parameters

ts	Time series to read from
year	Specified year
ad	appdata structure with dimensions

Returns: Value, or NaN if out of bounds

Definition at line 474 of file datastruct.c.

◆ getval()

double getval	(	struct datablock	db,
		int	row,
		int	year,
		struct appdata	ad
	)

Get the data value from the datablock for specified row & year.

Parameters

db	Datablock to get data from
row	Specified row (country index)
year	Specified year
ad	appdata structure with dimensions

Returns: Value, or NaN if out of bounds

Definition at line 432 of file datastruct.c.

◆ setffval()

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

Set a value for a specified row (country) for a fixedfactor.

Parameters

ff	Fixed factor to write to
val	Value to set
row	Row where value should be set
ad	appdata structure with dimensions Set value at row "row" in ff

Definition at line 524 of file datastruct.c.

◆ settsval()

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

Set the value for a particular year in a timeseries.

Parameters

ts	Time series to write to
val	Value to set
year	Year for which value should be set
ad	appdata structure with dimensions Set value at year "year" in ts

Definition at line 491 of file datastruct.c.

◆ setval()

void setval	(	struct datablock	db,
		double	val,
		int	row,
		int	year,
		struct appdata	ad
	)

Set a specific value in a datablock, specified by row and year.

Parameters

db	Datablock to write data to
val	Value to write
row	Specified row (country index)
year	Specified year
ad	appdata structure with dimensions Set value at row, year in db

Definition at line 454 of file datastruct.c.

◆ writedb2delim()

int writedb2delim	(	struct datablock	dblock,
		char *	fname,
		char	delim,
		struct appdata	ad
	)

Convenience function to dump a datablock to a file.

Parameters

dblock	Datablock to write
fname	Filename to write to
delim	Delimiter to use
ad	appdata structure with dimensions

Returns: Success code Creates a file with contents of datablock

Definition at line 337 of file datastruct.c.

◆ writeff2delim()

int writeff2delim	(	struct fixedfactor	ff,
		char *	fname,
		char	delim,
		struct appdata	ad
	)

Convenience function to dump a fixedfactor to a file.

Parameters

ff	Fixed factor to write
fname	Filename to write to
delim	Delimiter (currently ignored – just one column)
ad	appdata structure with dimensions

Returns: Success code Creates a file with contents of time series

Definition at line 403 of file datastruct.c.

◆ writets2delim()

int writets2delim	(	struct timeseries	ts,
		char *	fname,
		char	delim,
		struct appdata	ad
	)

Convenience function to dump a timeseries to a file.

Parameters

ts	Time series to write
fname	Filename to write to
delim	Delimiter to use
ad	appdata structure with dimensions

Returns: Success code Creates a file with contents of time series

Definition at line 374 of file datastruct.c.

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

◆ DBLOCK_BADYEARS

◆ DBLOCK_FCLOSEERROR

◆ DBLOCK_FREADERROR

◆ DBLOCK_NOMEM

◆ DBLOCK_NRECMISMATCH

◆ DBLOCK_OK

Typedef Documentation

◆ datablockp

◆ datablockpp

Function Documentation

◆ allocdata()

◆ allocff()

◆ allocts()

◆ cleardata()

◆ clearff()

◆ clearts()

◆ data2ff()

◆ ff2data()

◆ getdata()

◆ getff()

◆ getffval()

◆ getts()

◆ gettsval()

◆ getval()

◆ setffval()

◆ settsval()

◆ setval()

◆ writedb2delim()

◆ writeff2delim()

◆ writets2delim()