Module LALSimInspiralTestGRParams.c

Detailed Description

Routines to manipulate non-GR parameter key-value pairs.

Prototypes
LALSimInspiralTestGRParam *	XLALSimInspiralCreateTestGRParam (const char *name, double value)
	Function that creates the head node of the test GR parameters linked list. More...
int	XLALSimInspiralAddTestGRParam (LALSimInspiralTestGRParam **parameter, const char *name, double value)
	Function that adds a prameter to the test GR parameters linked list. More...
int	XLALSimInspiralSetTestGRParam (LALSimInspiralTestGRParam *parameter, const char *name, const double value)
	Function that sets the value of the desired parameter in the test GR parameters linked list to 'value'. More...
double	XLALSimInspiralGetTestGRParam (const LALSimInspiralTestGRParam *parameter, const char *name)
	Function that returns the value of the desired parameters in the test GR parameters linked list. More...
bool	XLALSimInspiralTestGRParamExists (const LALSimInspiralTestGRParam *parameter, const char *name)
	Function that checks whether the requested parameter exists within the test GR parameters linked list. More...
int	XLALSimInspiralPrintTestGRParam (FILE *fp, LALSimInspiralTestGRParam *parameter)
	Function that prints the whole test GR params linked list. More...
void	XLALSimInspiralDestroyTestGRParam (LALSimInspiralTestGRParam *parameter)
	Function that destroys the whole test GR params linked list. More...
int	XLALSimInspiralWaveformParamsNonGRAreDefault (LALDict *params)

Function Documentation

XLALSimInspiralCreateTestGRParam()

LALSimInspiralTestGRParam * XLALSimInspiralCreateTestGRParam	(	const char *	name,
		double	value
	)

Function that creates the head node of the test GR parameters linked list.

It is initialized with a single parameter with given name and value

Parameters

name	Name of first parameter in new linked list
value	Value of first parameter in new linked list

Definition at line 31 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralAddTestGRParam()

int XLALSimInspiralAddTestGRParam	(	LALSimInspiralTestGRParam **	parameter,
		const char *	name,
		double	value
	)

Function that adds a prameter to the test GR parameters linked list.

If the parameter already exists, it throws an error.

Parameters

parameter	Pointer to the head node of the linked list of parameters
name	Parameter name
value	Parameter value

Definition at line 51 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralSetTestGRParam()

int XLALSimInspiralSetTestGRParam	(	LALSimInspiralTestGRParam *	parameter,
		const char *	name,
		const double	value
	)

Function that sets the value of the desired parameter in the test GR parameters linked list to 'value'.

Throws an error if the parameter is not found

Parameters

parameter	Linked list to be modified
name	Name of parameter to be modified
value	New value for parameter

Definition at line 90 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralGetTestGRParam()

double XLALSimInspiralGetTestGRParam	(	const LALSimInspiralTestGRParam *	parameter,
		const char *	name
	)

Function that returns the value of the desired parameters in the test GR parameters linked list.

Aborts if the parameter is not found

Parameters

parameter	Linked list to retrieve from
name	Name of parameter to be retrieved

Definition at line 117 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralTestGRParamExists()

bool XLALSimInspiralTestGRParamExists	(	const LALSimInspiralTestGRParam *	parameter,
		const char *	name
	)

Function that checks whether the requested parameter exists within the test GR parameters linked list.

Returns true (1) or false (0) accordingly

Parameters

parameter	Linked list to check
name	Parameter name to check for

Definition at line 143 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralPrintTestGRParam()

int XLALSimInspiralPrintTestGRParam	(	FILE *	fp,
		LALSimInspiralTestGRParam *	parameter
	)

Function that prints the whole test GR params linked list.

Parameters

fp	FILE pointer to write to
parameter	Linked list to print

Definition at line 154 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralDestroyTestGRParam()

void XLALSimInspiralDestroyTestGRParam

(

LALSimInspiralTestGRParam *

parameter

)

Function that destroys the whole test GR params linked list.

Parameters

parameter

Linked list to destroy

Definition at line 176 of file LALSimInspiralTestGRParams.c.

XLALSimInspiralWaveformParamsNonGRAreDefault()

int XLALSimInspiralWaveformParamsNonGRAreDefault

(

LALDict *

params

)

Definition at line 189 of file LALSimInspiralTestGRParams.c.