Units.h File Reference

#include <lal/LALStdlib.h>

Include dependency graph for Units.h:

Go to the source code of this file.

Data Structures
struct	tagRAT4
struct	tagLALUnitPair
Defines
#define	UNITSH_ENULLPIN   1
#define	UNITSH_ENULLPOUT   2
#define	UNITSH_ENULLPD   3
#define	UNITSH_ENULLPPARAM   4
#define	UNITSH_ESTRINGSIZE   5
#define	UNITSH_EOVERFLOW   6
#define	UNITSH_ENONINT   7
#define	UNITSH_EPARSE   8
#define	UNITSH_MSGENULLPIN   "Null pointer to input"
#define	UNITSH_MSGENULLPOUT   "Null pointer to output"
#define	UNITSH_MSGENULLPD   "Null pointer to data member of vector"
#define	UNITSH_MSGENULLPPARAM   "Null pointer to parameters"
#define	UNITSH_MSGESTRINGSIZE   "Output string too short"
#define	UNITSH_MSGEOVERFLOW   "Exponent outside of (U)INT2 bounds"
#define	UNITSH_MSGENONINT   "Non-integer power of ten"
#define	UNITSH_MSGEPARSE   "Error parsing unit string"
Typedefs
typedef tagRAT4	RAT4
typedef tagLALUnitPair	LALUnitPair
Enumerations
enum	{ LALUnitNameSize = sizeof("strain") }
enum	{ LALUnitTextSize }
Functions
	NRCSID (UNITSH,"$Id: Units.h,v 1.15 2007/08/13 16:16:59 whelan Exp $")
char *	XLALUnitAsString (char *string, UINT4 length, const LALUnit *input)
LALUnit *	XLALParseUnitString (LALUnit *output, const char *string)
int	XLALUnitNormalize (LALUnit *unit)
int	XLALUnitCompare (const LALUnit *unit1, const LALUnit *unit2)
LALUnit *	XLALUnitMultiply (LALUnit *output, const LALUnit *unit1, const LALUnit *unit2)
LALUnit *	XLALUnitDivide (LALUnit *output, const LALUnit *unit1, const LALUnit *unit2)
LALUnit *	XLALUnitRaiseRAT4 (LALUnit *output, const LALUnit *input, const RAT4 *power)
LALUnit *	XLALUnitRaiseINT2 (LALUnit *output, const LALUnit *input, INT2 power)
LALUnit *	XLALUnitSquare (LALUnit *output, const LALUnit *input)
LALUnit *	XLALUnitSqrt (LALUnit *output, const LALUnit *input)
LALUnit *	XLALUnitInvert (LALUnit *output, const LALUnit *input)
REAL8	XLALUnitPrefactor (const LALUnit *unit)
int	XLALUnitIsDimensionless (const LALUnit *unit)
REAL8	XLALUnitRatio (const LALUnit *unit1, const LALUnit *unit2)
void	LALUnitNormalize (LALStatus *status, LALUnit *output, const LALUnit *input)
void	LALUnitMultiply (LALStatus *status, LALUnit *output, const LALUnitPair *input)
void	LALUnitCompare (LALStatus *status, BOOLEAN *output, const LALUnitPair *input)
void	LALUnitRaise (LALStatus *status, LALUnit *output, const LALUnit *input, const RAT4 *power)
void	LALUnitAsString (LALStatus *status, CHARVector *output, const LALUnit *input)
void	LALParseUnitString (LALStatus *status, LALUnit *output, const CHARVector *input)
Variables
const CHAR	lalUnitName [LALNumUnits][LALUnitNameSize]
const LALUnit	lalDimensionlessUnit
const LALUnit	lalMeterUnit
const LALUnit	lalKiloGramUnit
const LALUnit	lalSecondUnit
const LALUnit	lalAmpereUnit
const LALUnit	lalKelvinUnit
const LALUnit	lalStrainUnit
const LALUnit	lalADCCountUnit
const LALUnit	lalHertzUnit
const LALUnit	lalNewtonUnit
const LALUnit	lalJouleUnit
const LALUnit	lalWattUnit
const LALUnit	lalPascalUnit
const LALUnit	lalCoulombUnit
const LALUnit	lalVoltUnit
const LALUnit	lalOhmUnit
const LALUnit	lalFaradUnit
const LALUnit	lalWeberUnit
const LALUnit	lalTeslaUnit
const LALUnit	lalHenryUnit
const LALUnit	lalYottaUnit
const LALUnit	lalZettaUnit
const LALUnit	lalExaUnit
const LALUnit	lalPetaUnit
const LALUnit	lalTeraUnit
const LALUnit	lalGigaUnit
const LALUnit	lalMegaUnit
const LALUnit	lalKiloUnit
const LALUnit	lalHectoUnit
const LALUnit	lalDekaUnit
const LALUnit	lalDeciUnit
const LALUnit	lalCentiUnit
const LALUnit	lalMilliUnit
const LALUnit	lalMicroUnit
const LALUnit	lalNanoUnit
const LALUnit	lalPicoUnit
const LALUnit	lalFemtoUnit
const LALUnit	lalAttoUnit
const LALUnit	lalZeptoUnit
const LALUnit	lalYoctoUnit
const LALUnit	lalGramUnit
const LALUnit	lalAttoStrainUnit
const LALUnit	lalPicoFaradUnit

---

Define Documentation

#define UNITSH_ENULLPIN   1

Definition at line 196 of file Units.h.

#define UNITSH_ENULLPOUT   2

Definition at line 197 of file Units.h.

#define UNITSH_ENULLPD   3

Definition at line 198 of file Units.h.

#define UNITSH_ENULLPPARAM   4

Definition at line 199 of file Units.h.

#define UNITSH_ESTRINGSIZE   5

Definition at line 200 of file Units.h.

#define UNITSH_EOVERFLOW   6

Definition at line 201 of file Units.h.

#define UNITSH_ENONINT   7

Definition at line 202 of file Units.h.

#define UNITSH_EPARSE   8

Definition at line 203 of file Units.h.

#define UNITSH_MSGENULLPIN   "Null pointer to input"

Definition at line 205 of file Units.h.

#define UNITSH_MSGENULLPOUT   "Null pointer to output"

Definition at line 206 of file Units.h.

#define UNITSH_MSGENULLPD   "Null pointer to data member of vector"

Definition at line 207 of file Units.h.

#define UNITSH_MSGENULLPPARAM   "Null pointer to parameters"

Definition at line 208 of file Units.h.

#define UNITSH_MSGESTRINGSIZE   "Output string too short"

Definition at line 209 of file Units.h.

#define UNITSH_MSGEOVERFLOW   "Exponent outside of (U)INT2 bounds"

Definition at line 210 of file Units.h.

#define UNITSH_MSGENONINT   "Non-integer power of ten"

Definition at line 211 of file Units.h.

#define UNITSH_MSGEPARSE   "Error parsing unit string"

Definition at line 212 of file Units.h.

---

Typedef Documentation

typedef struct tagRAT4 RAT4

typedef struct tagLALUnitPair LALUnitPair

---

Enumeration Type Documentation

anonymous enum

Enumerator:

LALUnitNameSize

Definition at line 314 of file Units.h.

anonymous enum

Enumerator:

LALUnitTextSize

Definition at line 315 of file Units.h.

---

Function Documentation

NRCSID	(	UNITSH	,
		"$Id: Units.	h,
		v 1.15 2007/08/13 16:16:59 whelan Exp $"
	)

char* XLALUnitAsString	(	char *	string,
		UINT4	length,
		const LALUnit *	input
	)

Definition at line 355 of file UnitDefs.c.

LALUnit* XLALParseUnitString	(	LALUnit *	output,
		const char *	string
	)

Definition at line 462 of file UnitDefs.c.

int XLALUnitNormalize

(

LALUnit *

unit

)

Definition at line 92 of file UnitNormalize.c.

int XLALUnitCompare	(	const LALUnit *	unit1,
		const LALUnit *	unit2
	)

Definition at line 113 of file UnitCompare.c.

LALUnit* XLALUnitMultiply	(	LALUnit *	output,
		const LALUnit *	unit1,
		const LALUnit *	unit2
	)

Definition at line 70 of file UnitMultiply.c.

LALUnit* XLALUnitDivide	(	LALUnit *	output,
		const LALUnit *	unit1,
		const LALUnit *	unit2
	)

Definition at line 115 of file UnitMultiply.c.

LALUnit* XLALUnitRaiseRAT4	(	LALUnit *	output,
		const LALUnit *	input,
		const RAT4 *	power
	)

Definition at line 72 of file UnitRaise.c.

LALUnit* XLALUnitRaiseINT2	(	LALUnit *	output,
		const LALUnit *	input,
		INT2	power
	)

Definition at line 121 of file UnitRaise.c.

LALUnit* XLALUnitSquare	(	LALUnit *	output,
		const LALUnit *	input
	)

Definition at line 134 of file UnitRaise.c.

LALUnit* XLALUnitSqrt	(	LALUnit *	output,
		const LALUnit *	input
	)

Definition at line 146 of file UnitRaise.c.

LALUnit* XLALUnitInvert	(	LALUnit *	output,
		const LALUnit *	input
	)

Definition at line 158 of file UnitRaise.c.

REAL8 XLALUnitPrefactor

(

const LALUnit *

unit

)

Definition at line 87 of file UnitCompare.c.

int XLALUnitIsDimensionless

(

const LALUnit *

unit

)

Definition at line 72 of file UnitCompare.c.

REAL8 XLALUnitRatio	(	const LALUnit *	unit1,
		const LALUnit *	unit2
	)

Definition at line 96 of file UnitCompare.c.

void LALUnitNormalize	(	LALStatus *	status,
		LALUnit *	output,
		const LALUnit *	input
	)

Definition at line 118 of file UnitNormalize.c.

void LALUnitMultiply	(	LALStatus *	status,
		LALUnit *	output,
		const LALUnitPair *	input
	)

Definition at line 129 of file UnitMultiply.c.

void LALUnitCompare	(	LALStatus *	status,
		BOOLEAN *	output,
		const LALUnitPair *	input
	)

Definition at line 148 of file UnitCompare.c.

void LALUnitRaise	(	LALStatus *	status,
		LALUnit *	output,
		const LALUnit *	input,
		const RAT4 *	power
	)

Definition at line 172 of file UnitRaise.c.

void LALUnitAsString	(	LALStatus *	status,
		CHARVector *	output,
		const LALUnit *	input
	)

Definition at line 420 of file UnitDefs.c.

void LALParseUnitString	(	LALStatus *	status,
		LALUnit *	output,
		const CHARVector *	input
	)

Definition at line 636 of file UnitDefs.c.

---

Variable Documentation

const CHAR lalUnitName[LALNumUnits][LALUnitNameSize]

Definition at line 232 of file UnitDefs.c.

const LALUnit lalDimensionlessUnit

Definition at line 253 of file UnitDefs.c.

const LALUnit lalMeterUnit

Definition at line 256 of file UnitDefs.c.

const LALUnit lalKiloGramUnit

Definition at line 257 of file UnitDefs.c.

const LALUnit lalSecondUnit

Definition at line 258 of file UnitDefs.c.

const LALUnit lalAmpereUnit

Definition at line 259 of file UnitDefs.c.

const LALUnit lalKelvinUnit

Definition at line 260 of file UnitDefs.c.

const LALUnit lalStrainUnit

Definition at line 261 of file UnitDefs.c.

const LALUnit lalADCCountUnit

Definition at line 262 of file UnitDefs.c.

const LALUnit lalHertzUnit

Definition at line 265 of file UnitDefs.c.

const LALUnit lalNewtonUnit

Definition at line 266 of file UnitDefs.c.

const LALUnit lalJouleUnit

Definition at line 268 of file UnitDefs.c.

const LALUnit lalWattUnit

Definition at line 269 of file UnitDefs.c.

const LALUnit lalPascalUnit

Definition at line 267 of file UnitDefs.c.

const LALUnit lalCoulombUnit

Definition at line 272 of file UnitDefs.c.

const LALUnit lalVoltUnit

Definition at line 273 of file UnitDefs.c.

const LALUnit lalOhmUnit

Definition at line 274 of file UnitDefs.c.

const LALUnit lalFaradUnit

Definition at line 275 of file UnitDefs.c.

const LALUnit lalWeberUnit

Definition at line 276 of file UnitDefs.c.

const LALUnit lalTeslaUnit

Definition at line 278 of file UnitDefs.c.

const LALUnit lalHenryUnit

Definition at line 277 of file UnitDefs.c.

const LALUnit lalYottaUnit

Definition at line 281 of file UnitDefs.c.

const LALUnit lalZettaUnit

Definition at line 282 of file UnitDefs.c.

const LALUnit lalExaUnit

Definition at line 283 of file UnitDefs.c.

const LALUnit lalPetaUnit

Definition at line 284 of file UnitDefs.c.

const LALUnit lalTeraUnit

Definition at line 285 of file UnitDefs.c.

const LALUnit lalGigaUnit

Definition at line 286 of file UnitDefs.c.

const LALUnit lalMegaUnit

Definition at line 287 of file UnitDefs.c.

const LALUnit lalKiloUnit

Definition at line 288 of file UnitDefs.c.

const LALUnit lalHectoUnit

Definition at line 289 of file UnitDefs.c.

const LALUnit lalDekaUnit

Definition at line 290 of file UnitDefs.c.

const LALUnit lalDeciUnit

Definition at line 291 of file UnitDefs.c.

const LALUnit lalCentiUnit

Definition at line 292 of file UnitDefs.c.

const LALUnit lalMilliUnit

Definition at line 293 of file UnitDefs.c.

const LALUnit lalMicroUnit

Definition at line 294 of file UnitDefs.c.

const LALUnit lalNanoUnit

Definition at line 295 of file UnitDefs.c.

const LALUnit lalPicoUnit

Definition at line 296 of file UnitDefs.c.

const LALUnit lalFemtoUnit

Definition at line 297 of file UnitDefs.c.

const LALUnit lalAttoUnit

Definition at line 298 of file UnitDefs.c.

const LALUnit lalZeptoUnit

Definition at line 299 of file UnitDefs.c.

const LALUnit lalYoctoUnit

Definition at line 300 of file UnitDefs.c.

const LALUnit lalGramUnit

Definition at line 303 of file UnitDefs.c.

const LALUnit lalAttoStrainUnit

Definition at line 304 of file UnitDefs.c.

const LALUnit lalPicoFaradUnit

Definition at line 305 of file UnitDefs.c.

---