LAL: LALDatatypes.h File Reference

These datatypes store arbitrarily large sets or collections of primitive datatypes.

At this level there is no physical interpretation assigned to the objects (such as names or units); the aggregate datatypes simply collect and arrange the primitive datatypes. The following types of aggregate datatypes are defines: vectors, arrays, sequences, vector sequences, and array sequences.

Vector structures store an ordered set of n elements of any primative datatype.

Sequence structures are synonyms for Vector structures.

Array structures store a set of elements of any primative datatype, arranged as an m dimensional array. That is, each element can be thought of as having m indecies, $A_{i_0\cdots i_{m-1}}$ , where each index $i_k$ runs over its own range $0,\ldots,n_k-1$ . The total number of elements is then $N=n_0\times\cdots\times n_{m-1}$ . In memory the array is flattened so that the elements are stored sequentially in a contiguous block. That is, the array of memory is packed so that element $A_{i_0\cdots i_{m-1}}$ is stored as $\mathtt{data[}i_{m-1} + n_{m-2}\times(i_{m-2} + n_{m-3}\times(\cdots(i_1 + n_0\times i_0)\cdots))\mathtt{]}$ .

VectorSequence structures store an ordered set of l elements of type <datatype>Vector, where <datatype> can be any primitive datatype. Mathematically the sequence can be written as $\{\vec{v}^{(0)},\ldots,\vec{v}^{(l-1)}\}$ , where each element $\vec{v}^{(j)}=(v^{(j)}_0,\ldots,v^{(i)}_{n-1})$ is a vector of length $n$ . In memory the elements are flattened; that is, they are stored sequentially in a contiguous block of memory such that element $v^{(j)}_i$ is stored as $\mathtt{data[}j\times n + i\mathtt{]}$ .

ArraySequence structures stores an ordered set of l elements of type <datatype>Array where <datatype> can be any primitive datatype. The indexing of an array sequence can get quite complicated; it helps to read first the documentation for data arrays, above. Mathematically the data can be written as a set $\{A^{(j)}_{i_0\cdots i_{m-1}}$ , where the sequence number $j$ runs from 0 to $l-1$ , and each array index $i_k$ runs over its own range $0,\ldots,n_k-1$ . The total number of data in a given array element is then $N=n_0\times\cdots\times n_{m-1}$ , and the total number of data in the sequence is $N\times l$ . In memory the array is flattened so that the elements are stored sequentially in a contiguous block. The element $A^{(j)}_{i_0\cdots i_{m-1}}$ is stored as $\mathtt{data[}j\times N + i_{m-1} + n_{m-2}\times(i_{m-2} + n_{m-3}\times(\cdots(i_1 + n_0\times i_0)\cdots))\mathtt{]}$ ; that is, the index of data[] runs over the internal indecies of each array element before incrementing to the next array element.

LALDatatypes.h File Reference

Data Structures

Structured datatypes.

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation


Data Structures
struct	tagCHARVector
	Vector of type CHAR. More...
struct	LALStringVector
	Vector of type CHAR*, ie 'strings'. More...
struct	tagINT2Vector
	Vector of type INT2. More...
struct	tagUINT2Vector
	Vector of type UINT2. More...
struct	tagINT4Vector
	Vector of type INT4. More...
struct	tagUINT4Vector
	Vector of type UINT4. More...
struct	tagINT8Vector
	Vector of type INT8. More...
struct	tagUINT8Vector
	Vector of type UINT8. More...
struct	tagREAL4Vector
	Vector of type REAL4. More...
struct	tagREAL8Vector
	Vector of type REAL8. More...
struct	tagCOMPLEX8Vector
	Vector of type COMPLEX8. More...
struct	tagCOMPLEX16Vector
	Vector of type COMPLEX16. More...
struct	tagINT2Array
	Multidimentional array of INT2. More...
struct	tagUINT2Array
	Multidimentional array of UINT2. More...
struct	tagINT4Array
	Multidimentional array of INT4. More...
struct	tagUINT4Array
	Multidimentional array of UINT4. More...
struct	tagINT8Array
	Multidimentional array of INT8. More...
struct	tagUINT8Array
	Multidimentional array of UINT8. More...
struct	tagREAL4Array
	Multidimentional array of REAL4. More...
struct	tagREAL8Array
	Multidimentional array of REAL8. More...
struct	tagCOMPLEX8Array
	Multidimentional array of COMPLEX8. More...
struct	tagCOMPLEX16Array
	Multidimentional array of COMPLEX16. More...
struct	tagCHARVectorSequence
	Sequence of CHAR Vectors. More...
struct	tagINT2VectorSequence
	Sequence of INT2 Vectors. More...
struct	tagUINT2VectorSequence
	Sequence of UINT2 Vectors. More...
struct	tagINT4VectorSequence
	Sequence of INT4 Vectors. More...
struct	tagUINT4VectorSequence
	Sequence of UINT4 Vectors. More...
struct	tagINT8VectorSequence
	Sequence of INT8 Vectors. More...
struct	tagUINT8VectorSequence
	Sequence of UINT8 Vectors. More...
struct	tagREAL4VectorSequence
	Sequence of REAL4 Vectors. More...
struct	tagREAL8VectorSequence
	Sequence of REAL8 Vectors. More...
struct	tagCOMPLEX8VectorSequence
	Sequence of COMPLEX8 Vectors. More...
struct	tagCOMPLEX16VectorSequence
	Sequence of COMPLEX16 Vectors. More...
struct	tagINT2ArraySequence
	Sequency of INT2 multidimensional arrays. More...
struct	tagUINT2ArraySequence
	Sequency of UINT2 multidimensional arrays. More...
struct	tagINT4ArraySequence
	Sequency of INT4 multidimensional arrays. More...
struct	tagUINT4ArraySequence
	Sequency of UINT4 multidimensional arrays. More...
struct	tagINT8ArraySequence
	Sequency of INT8 multidimensional arrays. More...
struct	tagUINT8ArraySequence
	Sequency of UINT8 multidimensional arrays. More...
struct	tagREAL4ArraySequence
	Sequency of REAL4 multidimensional arrays. More...
struct	tagREAL8ArraySequence
	Sequency of REAL8 multidimensional arrays. More...
struct	tagCOMPLEX8ArraySequence
	Sequency of COMPLEX8 multidimensional arrays. More...
struct	tagCOMPLEX16ArraySequence
	Sequency of COMPLEX16 multidimensional arrays. More...
struct	tagLIGOTimeGPS
	Epoch relative to GPS epoch. More...
struct	tagLALUnit
	Unit in the mksA system. More...
struct	tagINT2TimeSeries
	Time series of INT2 data. More...
struct	tagUINT2TimeSeries
	Time series of UINT2 data. More...
struct	tagINT4TimeSeries
	Time series of INT4 data. More...
struct	tagUINT4TimeSeries
	Time series of UINT4 data. More...
struct	tagINT8TimeSeries
	Time series of INT8 data. More...
struct	tagUINT8TimeSeries
	Time series of UINT8 data. More...
struct	tagREAL4TimeSeries
	Time series of REAL4 data. More...
struct	tagREAL8TimeSeries
	Time series of REAL8 data. More...
struct	tagCOMPLEX8TimeSeries
	Time series of COMPLEX8 data. More...
struct	tagCOMPLEX16TimeSeries
	Time series of COMPLEX16 data. More...
struct	tagINT2TimeVectorSeries
	Time series of INT2 vectors. More...
struct	tagUINT2TimeVectorSeries
	Time series of UINT2 vectors. More...
struct	tagINT4TimeVectorSeries
	Time series of INT4 vectors. More...
struct	tagUINT4TimeVectorSeries
	Time series of UINT4 vectors. More...
struct	tagINT8TimeVectorSeries
	Time series of INT8 vectors. More...
struct	tagUINT8TimeVectorSeries
	Time series of UINT8 vectors. More...
struct	tagREAL4TimeVectorSeries
	Time series of REAL4 vectors. More...
struct	tagREAL8TimeVectorSeries
	Time series of REAL8 vectors. More...
struct	tagCOMPLEX8TimeVectorSeries
	Time series of COMPLEX8 vectors. More...
struct	tagCOMPLEX16TimeVectorSeries
	Time series of COMPLEX16 vectors. More...
struct	tagINT2TimeArraySeries
struct	tagUINT2TimeArraySeries
struct	tagINT4TimeArraySeries
struct	tagUINT4TimeArraySeries
struct	tagINT8TimeArraySeries
struct	tagUINT8TimeArraySeries
struct	tagREAL4TimeArraySeries
struct	tagREAL8TimeArraySeries
struct	tagCOMPLEX8TimeArraySeries
struct	tagCOMPLEX16TimeArraySeries
struct	tagINT2FrequencySeries
struct	tagUINT2FrequencySeries
struct	tagINT4FrequencySeries
struct	tagUINT4FrequencySeries
struct	tagINT8FrequencySeries
struct	tagUINT8FrequencySeries
struct	tagREAL4FrequencySeries
struct	tagREAL8FrequencySeries
struct	tagCOMPLEX8FrequencySeries
struct	tagCOMPLEX16FrequencySeries
struct	tagCOMPLEX8ZPGFilter
struct	tagCOMPLEX16ZPGFilter
struct	tagLALStatus
Structured datatypes.
These datatypes embed primitive and aggregate datatypes inside structures that define their physical meaning. Most of these structures are wrappers for aggregate datatypes that store a physical quantity as a function of time or frequency. Other structures store specific physical information, such as the GPS time, or the factored response function of a filter.
#define	LIGOTIMEGPSZERO { 0, 0 }
enum	{ LALUnitIndexMeter, LALUnitIndexKiloGram, LALUnitIndexSecond, LALUnitIndexAmpere, LALUnitIndexKelvin, LALUnitIndexStrain, LALUnitIndexADCCount, LALNumUnits }
	Indices of arrays corresponding to particular units. More...
enum	{ LALNameLength = 64 }
	Length of name fields of LAL structured data types. More...
typedef tagLIGOTimeGPS	LIGOTimeGPS
	Epoch relative to GPS epoch.
typedef tagLALUnit	LALUnit
	Unit in the mksA system.
typedef tagINT2TimeSeries	INT2TimeSeries
	Time series of INT2 data.
typedef tagUINT2TimeSeries	UINT2TimeSeries
	Time series of UINT2 data.
typedef tagINT4TimeSeries	INT4TimeSeries
	Time series of INT4 data.
typedef tagUINT4TimeSeries	UINT4TimeSeries
	Time series of UINT4 data.
typedef tagINT8TimeSeries	INT8TimeSeries
	Time series of INT8 data.
typedef tagUINT8TimeSeries	UINT8TimeSeries
	Time series of UINT8 data.
typedef tagREAL4TimeSeries	REAL4TimeSeries
	Time series of REAL4 data.
typedef tagREAL8TimeSeries	REAL8TimeSeries
	Time series of REAL8 data.
typedef tagCOMPLEX8TimeSeries	COMPLEX8TimeSeries
	Time series of COMPLEX8 data.
typedef tagCOMPLEX16TimeSeries	COMPLEX16TimeSeries
	Time series of COMPLEX16 data.
typedef tagINT2TimeVectorSeries	INT2TimeVectorSeries
	Time series of INT2 vectors.
typedef tagUINT2TimeVectorSeries	UINT2TimeVectorSeries
	Time series of UINT2 vectors.
typedef tagINT4TimeVectorSeries	INT4TimeVectorSeries
	Time series of INT4 vectors.
typedef tagUINT4TimeVectorSeries	UINT4TimeVectorSeries
	Time series of UINT4 vectors.
typedef tagINT8TimeVectorSeries	INT8TimeVectorSeries
	Time series of INT8 vectors.
typedef tagUINT8TimeVectorSeries	UINT8TimeVectorSeries
	Time series of UINT8 vectors.
typedef tagREAL4TimeVectorSeries	REAL4TimeVectorSeries
	Time series of REAL4 vectors.
typedef tagREAL8TimeVectorSeries	REAL8TimeVectorSeries
	Time series of REAL8 vectors.
typedef tagCOMPLEX8TimeVectorSeries	COMPLEX8TimeVectorSeries
	Time series of COMPLEX8 vectors.
typedef tagCOMPLEX16TimeVectorSeries	COMPLEX16TimeVectorSeries
	Time series of COMPLEX16 vectors.
typedef tagINT2TimeArraySeries	INT2TimeArraySeries
typedef tagUINT2TimeArraySeries	UINT2TimeArraySeries
typedef tagINT4TimeArraySeries	INT4TimeArraySeries
typedef tagUINT4TimeArraySeries	UINT4TimeArraySeries
typedef tagINT8TimeArraySeries	INT8TimeArraySeries
typedef tagUINT8TimeArraySeries	UINT8TimeArraySeries
typedef tagREAL4TimeArraySeries	REAL4TimeArraySeries
typedef tagREAL8TimeArraySeries	REAL8TimeArraySeries
typedef tagCOMPLEX8TimeArraySeries	COMPLEX8TimeArraySeries
typedef tagCOMPLEX16TimeArraySeries	COMPLEX16TimeArraySeries
typedef tagINT2FrequencySeries	INT2FrequencySeries
typedef tagUINT2FrequencySeries	UINT2FrequencySeries
typedef tagINT4FrequencySeries	INT4FrequencySeries
typedef tagUINT4FrequencySeries	UINT4FrequencySeries
typedef tagINT8FrequencySeries	INT8FrequencySeries
typedef tagUINT8FrequencySeries	UINT8FrequencySeries
typedef tagREAL4FrequencySeries	REAL4FrequencySeries
typedef tagREAL8FrequencySeries	REAL8FrequencySeries
typedef tagCOMPLEX8FrequencySeries	COMPLEX8FrequencySeries
typedef tagCOMPLEX16FrequencySeries	COMPLEX16FrequencySeries
typedef tagCOMPLEX8ZPGFilter	COMPLEX8ZPGFilter
typedef tagCOMPLEX16ZPGFilter	COMPLEX16ZPGFilter
Typedefs
typedef tagLALStatus	LALStatus
Aggregate datatypes.
These datatypes store arbitrarily large sets or collections of primitive datatypes. At this level there is no physical interpretation assigned to the objects (such as names or units); the aggregate datatypes simply collect and arrange the primitive datatypes. The following types of aggregate datatypes are defines: vectors, arrays, sequences, vector sequences, and array sequences. Vector structures store an ordered set of n elements of any primative datatype. Sequence structures are synonyms for Vector structures. Array structures store a set of elements of any primative datatype, arranged as an m dimensional array. That is, each element can be thought of as having m indecies, $A_{i_0\cdots i_{m-1}}$ , where each index runs over its own range $0,\ldots,n_k-1$ . The total number of elements is then $N=n_0\times\cdots\times n_{m-1}$ . In memory the array is flattened so that the elements are stored sequentially in a contiguous block. That is, the array of memory is packed so that element $A_{i_0\cdots i_{m-1}}$ is stored as $\mathtt{data[}i_{m-1} + n_{m-2}\times(i_{m-2} + n_{m-3}\times(\cdots(i_1 + n_0\times i_0)\cdots))\mathtt{]}$ . VectorSequence structures store an ordered set of l elements of type `<datatype>Vector`, where `<datatype>` can be any primitive datatype. Mathematically the sequence can be written as $\{\vec{v}^{(0)},\ldots,\vec{v}^{(l-1)}\}$ , where each element $\vec{v}^{(j)}=(v^{(j)}_0,\ldots,v^{(i)}_{n-1})$ is a vector of length . In memory the elements are flattened; that is, they are stored sequentially in a contiguous block of memory such that element $v^{(j)}_i$ is stored as $\mathtt{data[}j\times n + i\mathtt{]}$ . ArraySequence structures stores an ordered set of l elements of type `<datatype>Array` where `<datatype>` can be any primitive datatype. The indexing of an array sequence can get quite complicated; it helps to read first the documentation for data arrays, above. Mathematically the data can be written as a set $\{A^{(j)}_{i_0\cdots i_{m-1}}$ , where the sequence number runs from 0 to , and each array index runs over its own range $0,\ldots,n_k-1$ . The total number of data in a given array element is then $N=n_0\times\cdots\times n_{m-1}$ , and the total number of data in the sequence is $N\times l$ . In memory the array is flattened so that the elements are stored sequentially in a contiguous block. The element $A^{(j)}_{i_0\cdots i_{m-1}}$ is stored as $\mathtt{data[}j\times N + i_{m-1} + n_{m-2}\times(i_{m-2} + n_{m-3}\times(\cdots(i_1 + n_0\times i_0)\cdots))\mathtt{]}$ ; that is, the index of `data`[] runs over the internal indecies of each array element before incrementing to the next array element.
typedef tagCHARVector	CHARVector
	Vector of type CHAR.
typedef tagINT2Vector	INT2Vector
	Vector of type INT2.
typedef tagUINT2Vector	UINT2Vector
	Vector of type UINT2.
typedef tagINT4Vector	INT4Vector
	Vector of type INT4.
typedef tagUINT4Vector	UINT4Vector
	Vector of type UINT4.
typedef tagINT8Vector	INT8Vector
	Vector of type INT8.
typedef tagUINT8Vector	UINT8Vector
	Vector of type UINT8.
typedef tagREAL4Vector	REAL4Vector
	Vector of type REAL4.
typedef tagREAL8Vector	REAL8Vector
	Vector of type REAL8.
typedef tagCOMPLEX8Vector	COMPLEX8Vector
	Vector of type COMPLEX8.
typedef tagCOMPLEX16Vector	COMPLEX16Vector
	Vector of type COMPLEX16.
typedef tagINT2Array	INT2Array
	Multidimentional array of INT2.
typedef tagUINT2Array	UINT2Array
	Multidimentional array of UINT2.
typedef tagINT4Array	INT4Array
	Multidimentional array of INT4.
typedef tagUINT4Array	UINT4Array
	Multidimentional array of UINT4.
typedef tagINT8Array	INT8Array
	Multidimentional array of INT8.
typedef tagUINT8Array	UINT8Array
	Multidimentional array of UINT8.
typedef tagREAL4Array	REAL4Array
	Multidimentional array of REAL4.
typedef tagREAL8Array	REAL8Array
	Multidimentional array of REAL8.
typedef tagCOMPLEX8Array	COMPLEX8Array
	Multidimentional array of COMPLEX8.
typedef tagCOMPLEX16Array	COMPLEX16Array
	Multidimentional array of COMPLEX16.
typedef CHARVector	CHARSequence
typedef INT2Vector	INT2Sequence
typedef UINT2Vector	UINT2Sequence
typedef INT4Vector	INT4Sequence
typedef UINT4Vector	UINT4Sequence
typedef INT8Vector	INT8Sequence
typedef UINT8Vector	UINT8Sequence
typedef REAL4Vector	REAL4Sequence
typedef REAL8Vector	REAL8Sequence
typedef COMPLEX8Vector	COMPLEX8Sequence
typedef COMPLEX16Vector	COMPLEX16Sequence
typedef tagCHARVectorSequence	CHARVectorSequence
	Sequence of CHAR Vectors.
typedef tagINT2VectorSequence	INT2VectorSequence
	Sequence of INT2 Vectors.
typedef tagUINT2VectorSequence	UINT2VectorSequence
	Sequence of UINT2 Vectors.
typedef tagINT4VectorSequence	INT4VectorSequence
	Sequence of INT4 Vectors.
typedef tagUINT4VectorSequence	UINT4VectorSequence
	Sequence of UINT4 Vectors.
typedef tagINT8VectorSequence	INT8VectorSequence
	Sequence of INT8 Vectors.
typedef tagUINT8VectorSequence	UINT8VectorSequence
	Sequence of UINT8 Vectors.
typedef tagREAL4VectorSequence	REAL4VectorSequence
	Sequence of REAL4 Vectors.
typedef tagREAL8VectorSequence	REAL8VectorSequence
	Sequence of REAL8 Vectors.
typedef tagCOMPLEX8VectorSequence	COMPLEX8VectorSequence
	Sequence of COMPLEX8 Vectors.
typedef tagCOMPLEX16VectorSequence	COMPLEX16VectorSequence
	Sequence of COMPLEX16 Vectors.
typedef tagINT2ArraySequence	INT2ArraySequence
	Sequency of INT2 multidimensional arrays.
typedef tagUINT2ArraySequence	UINT2ArraySequence
	Sequency of UINT2 multidimensional arrays.
typedef tagINT4ArraySequence	INT4ArraySequence
	Sequency of INT4 multidimensional arrays.
typedef tagUINT4ArraySequence	UINT4ArraySequence
	Sequency of UINT4 multidimensional arrays.
typedef tagINT8ArraySequence	INT8ArraySequence
	Sequency of INT8 multidimensional arrays.
typedef tagUINT8ArraySequence	UINT8ArraySequence
	Sequency of UINT8 multidimensional arrays.
typedef tagREAL4ArraySequence	REAL4ArraySequence
	Sequency of REAL4 multidimensional arrays.
typedef tagREAL8ArraySequence	REAL8ArraySequence
	Sequency of REAL8 multidimensional arrays.
typedef tagCOMPLEX8ArraySequence	COMPLEX8ArraySequence
	Sequency of COMPLEX8 multidimensional arrays.
typedef tagCOMPLEX16ArraySequence	COMPLEX16ArraySequence
	Sequency of COMPLEX16 multidimensional arrays.
Enumerations
enum	{ LAL_1_BYTE_TYPE_SIZE = 000, LAL_2_BYTE_TYPE_SIZE = 001, LAL_4_BYTE_TYPE_SIZE = 002, LAL_8_BYTE_TYPE_SIZE = 003, LAL_16_BYTE_TYPE_SIZE = 004, LAL_TYPE_SIZE_MASK = 007 }
	Type size constants. More...
enum	{ LAL_FLTPT_TYPE_FLAG = 010, LAL_CMPLX_TYPE_FLAG = 020, LAL_UNSGN_TYPE_FLAG = 040 }
	Type flag constants. More...
enum	LALTYPECODE { LAL_CHAR_TYPE_CODE = LAL_1_BYTE_TYPE_SIZE, LAL_I2_TYPE_CODE = LAL_2_BYTE_TYPE_SIZE, LAL_I4_TYPE_CODE = LAL_4_BYTE_TYPE_SIZE, LAL_I8_TYPE_CODE = LAL_8_BYTE_TYPE_SIZE, LAL_UCHAR_TYPE_CODE = LAL_1_BYTE_TYPE_SIZE \| LAL_UNSGN_TYPE_FLAG, LAL_U2_TYPE_CODE = LAL_2_BYTE_TYPE_SIZE \| LAL_UNSGN_TYPE_FLAG, LAL_U4_TYPE_CODE = LAL_4_BYTE_TYPE_SIZE \| LAL_UNSGN_TYPE_FLAG, LAL_U8_TYPE_CODE = LAL_8_BYTE_TYPE_SIZE \| LAL_UNSGN_TYPE_FLAG, LAL_S_TYPE_CODE = LAL_4_BYTE_TYPE_SIZE \| LAL_FLTPT_TYPE_FLAG, LAL_D_TYPE_CODE = LAL_8_BYTE_TYPE_SIZE \| LAL_FLTPT_TYPE_FLAG, LAL_C_TYPE_CODE = LAL_8_BYTE_TYPE_SIZE \| LAL_CMPLX_TYPE_FLAG \| LAL_FLTPT_TYPE_FLAG, LAL_Z_TYPE_CODE = LAL_16_BYTE_TYPE_SIZE \| LAL_CMPLX_TYPE_FLAG \| LAL_FLTPT_TYPE_FLAG }
	Type codes: use these type codes to identify a LAL atomic data type. More...
Functions
	NRCSID (LALDATATYPESH,"$Id: LALDatatypes.h,v 1.20 2008/02/22 16:11:08 reinhard Exp $")