Header PrintVector.h

Detailed Description

This is a simple utility to print vectors into a file.

Author

Allen, B.; generalized by J. T. Whelan jtwhe.nosp@m.lan@.nosp@m.loyno.nosp@m..edu

Synopsis

#include <lal/PrintVector.h>

Contains the prototypes for the LAL <datatype>PrintVector functions

Description

Each member of this family of functions prints the elements of \(\langle\mbox{datatype}\rangle\)Vector into a file. Note: the file names are <datatype>PrintVector.000, <datatype>PrintVector.001, and so on. (<datatype> is the abbreviation for the datatype, included in the function names above.) The file numbers are incremented with each additional call. This function is for debugging use only: it uses a static internal variable to keep track of the file number so it should not be used in any real analysis codes.

Notes

This function uses an internal static variable to keep track of file numbers. For this reason it should only be used for debugging purposes in test functions, not in any production code.

Additionally, since printf cannot handle INT8 as integers, the functions LALI8PrintVector() and LALU8PrintVector() use a typecast to REAL8 and are thus only valid for numbers between around \(-10^{15}\) and \(10^{15}\).

The output format is two or three space-separated columns: the first column is the index of the element; the second is the element itself for real and integer vectors and the real part of the element for complex vectors; complex vectors have a third column containing the imaginary part of the element.

Prototypes
void	LALCHARPrintVector (CHARVector *vector)
void	LALI2PrintVector (INT2Vector *vector)
void	LALI4PrintVector (INT4Vector *vector)
void	LALI8PrintVector (INT8Vector *vector)
void	LALU2PrintVector (UINT2Vector *vector)
void	LALU4PrintVector (UINT4Vector *vector)
void	LALU8PrintVector (UINT8Vector *vector)
void	LALPrintVector (REAL4Vector *vector)
void	LALSPrintVector (REAL4Vector *vector)
void	LALDPrintVector (REAL8Vector *vector)
void	LALCPrintVector (COMPLEX8Vector *vector)
void	LALZPrintVector (COMPLEX16Vector *vector)

Files
file	PrintVectorTest.c
	Tests the routines in PrintVector.c.

Function Documentation

LALCHARPrintVector()

void LALCHARPrintVector

(

CHARVector *

vector

)

LALI2PrintVector()

void LALI2PrintVector

(

INT2Vector *

vector

)

LALI4PrintVector()

void LALI4PrintVector

(

INT4Vector *

vector

)

LALI8PrintVector()

void LALI8PrintVector

(

INT8Vector *

vector

)

LALU2PrintVector()

void LALU2PrintVector

(

UINT2Vector *

vector

)

LALU4PrintVector()

void LALU4PrintVector

(

UINT4Vector *

vector

)

LALU8PrintVector()

void LALU8PrintVector

(

UINT8Vector *

vector

)

LALPrintVector()

void LALPrintVector

(

REAL4Vector *

vector

)

LALSPrintVector()

void LALSPrintVector

(

REAL4Vector *

vector

)

LALDPrintVector()

void LALDPrintVector

(

REAL8Vector *

vector

)

LALCPrintVector()

void LALCPrintVector

(

COMPLEX8Vector *

vector

)

LALZPrintVector()

void LALZPrintVector

(

COMPLEX16Vector *

vector

)