wcsutil.h File Reference

Go to the source code of this file.

Functions
void	wcsutil_blank_fill (int n, char c[])
	Fill a character string with blanks.
void	wcsutil_null_fill (int n, char c[])
	Fill a character string with NULLs.
int	wcsutil_allEq (int nvec, int nelem, const double *first)
	Test for equality of a particular vector element.
void	wcsutil_setAll (int nvec, int nelem, double *first)
	Set a particular vector element.
void	wcsutil_setAli (int nvec, int nelem, int *first)
	Set a particular vector element.
void	wcsutil_setBit (int nelem, const int *sel, int bits, int *array)
	Set bits in selected elements of an array.

---

Detailed Description

Simple utility functions used by WCSLIB. They are documented here solely as an aid to understanding the code. Thay are not intended for external use - the API may change without notice!

---

Function Documentation

void wcsutil_blank_fill	(	int	n,
		char	c[]
	)

wcsutil_blank_fill() pads a character string with blanks starting with the terminating NULL character.

Used by the Fortran wrapper functions in translating C character strings into Fortran CHARACTER variables.

Parameters:

[in]	n	Length of the character array, c[].
[in,out]	c	The character string. It will not be null-terminated on return.

Returns:

void wcsutil_null_fill	(	int	n,
		char	c[]
	)

wcsutil_null_fill() pads a character string with NULL characters.

Used mainly to make character strings intelligible in the GNU debugger - it prints the rubbish following the terminating NULL, obscuring the valid part of the string.

Parameters:

[in]	n	Number of characters.
[in,out]	c	The character string.

Returns:

int wcsutil_allEq	(	int	nvec,
		int	nelem,
		const double *	first
	)

wcsutil_allEq() tests for equality of a particular element in a set of vectors.

Parameters:

[in]	nvec	The number of vectors.
[in]	nelem	The length of each vector.
[in]	first	Pointer to the first element to test in the array. The elements tested for equality are *first == *(first + nelem) == *(first + nelem*2) : == *(first + nelem*(nvec-1)); The array might be dimensioned as double v[nvec][nelem];

Returns:

Status return value:

• 0: Not all equal.
• 1: All equal.

void wcsutil_setAll	(	int	nvec,
		int	nelem,
		double *	first
	)

wcsutil_setAll() sets the value of a particular element in a set of vectors.

Parameters:

[in]	nvec	The number of vectors.
[in]	nelem	The length of each vector.
[in,out]	first	Pointer to the first element in the array, the value of which is used to set the others *(first + nelem) = *first; *(first + nelem*2) = *first; : *(first + nelem*(nvec-1)) = *first; The array might be dimensioned as double v[nvec][nelem];

Returns:

void wcsutil_setAli	(	int	nvec,
		int	nelem,
		int *	first
	)

wcsutil_setAli() sets the value of a particular element in a set of vectors.

Parameters:

[in]	nvec	The number of vectors.
[in]	nelem	The length of each vector.
[in,out]	first	Pointer to the first element in the array, the value of which is used to set the others *(first + nelem) = *first; *(first + nelem*2) = *first; : *(first + nelem*(nvec-1)) = *first; The array might be dimensioned as int v[nvec][nelem];

Returns:

void wcsutil_setBit	(	int	nelem,
		const int *	sel,
		int	bits,
		int *	array
	)

wcsutil_setBit() sets bits in selected elements of an array.

Parameters:

[in]	nelem	Number of elements in the array.
[in]	sel	Address of a selection array of length nelem. May be specified as the null pointer in which case all elements are selected.
[in]	bits	Bit mask.
[in,out]	array	Address of the array of length nelem.

Returns:

---