Isis::GSL::GSLUtility Class Reference
[Utility]

GSLUtility Provides top level interface to the GNU GSL. More...

#include <GSLUtility.h>

Public Types
typedef TNT::Array1D< double >	GSLVector
typedef TNT::Array2D< double >	GSLMatrix
Public Member Functions
bool	success (int status) const
	Tests if status is success.
QString	status (int gsl_errno) const
	Returns GSL specific error text.
void	check (int gsl_status, const char *src=__FILE__, int line=__LINE__) const
	Performs a check on GSL library function return status.
size_t	Rows (const gsl_matrix *m) const
	Returns number of rows in a GSL matrix.
size_t	Columns (const gsl_matrix *m) const
	Returns the number of coulumns in a GSL matrix.
size_t	Rows (const GSLMatrix &m) const
	Returns the number of rows in TNT-based matrix.
size_t	Columns (const GSLMatrix &m) const
	Returns the number of columns in TNT-based matrix.
size_t	size (const gsl_vector *v) const
	Returns the size of a GSL vector.
size_t	size (const gsl_matrix *m) const
	Returns the total number of elements in a GSL matrix.
gsl_vector *	vector (size_t n, bool zero=false) const
	Creates a GSL vector.
gsl_matrix *	matrix (size_t n1, size_t n2, bool zero=false) const
	Creates a GSL matrix.
gsl_matrix *	identity (size_t n1, size_t n2) const
	Returns a GSL identity matrix of the specified size.
void	setIdentity (gsl_matrix *m) const
	Initializes an existing GSL matrix to the identity matrix.
void	free (gsl_vector *v) const
	Frees a GSL vector.
void	free (gsl_matrix *m) const
	Frees a GSL matrix.
GSLVector	gslToGSL (const gsl_vector *v) const
	Converts a GSL vector to a TNT-based vector.
GSLMatrix	gslToGSL (const gsl_matrix *m) const
	Converts a GSL matrix to a TNT-based matrix.
gsl_vector *	GSLTogsl (const GSLVector &v, gsl_vector *gv=0) const
	Converts TNT-based vector to GSL vector.
gsl_matrix *	GSLTogsl (const GSLMatrix &m, gsl_matrix *gm=0) const
	Converts TNT-based matrix to GSL matrix.
Static Public Member Functions
static GSLUtility *	getInstance ()
	Return a reference to the GSL (singleton) object.

Detailed Description

GSLUtility Provides top level interface to the GNU GSL.

Provides GSL setup and interface utilities. This object is provided for convenience of GSL vector and matrix manipulation as well as better management of GSL error handling.

Without setting up GSL error handling, the GSL will abort when certain errors occur. This singleton object, an object where there is never more than one instance, an error handler is established that captures GSL errors and formats them into ISIS exceptions.

There are many convenience methods provided for manipulation of GSL vectors and matrixs. Motivation for this is to address element access and efficient parameter and copy mechanisms (provided by the TNT library).

There are some compile options on by default that help optimize the GSL. When the compile time DEBUG macro is set, range checking is turned on. Inline functions are also turned on by default unless the DEBUG macro is set. In addition, an additional compile time macro called SAFE_GSL is provided to emulate the DEBUG behavior, but does not invoke additional DEBUG behavior/side effects.

See http://www.gnu.org/software/gsl/ for additional details on the GNU Scientific Library.

Author:: 2008-05-06 Kris Becker

Member Typedef Documentation

typedef TNT::Array2D<double> Isis::GSL::GSLUtility::GSLMatrix

typedef TNT::Array1D<double> Isis::GSL::GSLUtility::GSLVector

Member Function Documentation

void Isis::GSL::GSLUtility::check	(	int	gsl_status,
		const char *	src = `__FILE__`,
		int	line = `__LINE__`
	)			const

Performs a check on GSL library function return status.

This covenience method performs a validity check on the return status of a GSL function. It will throw an ISIS exception should the status be anything other than GSL_SUCCESS.

Parameters:

	gsl_status	Return value of GSL function
	src	Name of the source file where the function was called.
	line	Line number in the source where the call/error occurs

References Isis::IException::Programmer.

size_t Isis::GSL::GSLUtility::Columns ( const GSLMatrix & m ) const

Returns the number of columns in TNT-based matrix.

size_t Isis::GSL::GSLUtility::Columns ( const gsl_matrix * m ) const

Returns the number of coulumns in a GSL matrix.

Referenced by GSLTogsl(), gslToGSL(), and size().

void Isis::GSL::GSLUtility::free ( gsl_matrix * m ) const

Frees a GSL matrix.

Frees the memory allocated to a GSL matrix. As with any free operation, the matrix cannot be used thereafter.

It is up to the user to manage all GSL allocated elements. It is not done automatically.

Parameters:

m

GSL matrix to free

void Isis::GSL::GSLUtility::free ( gsl_vector * v ) const

Frees a GSL vector.

Frees the memory allocated to a GSL vector. As with any free operation, the vector cannot be used thereafter.

It is up to the user to manage all GSL allocated elements. It is not done automatically.

Parameters:

v

GSL vector to free

GSLUtility * Isis::GSL::GSLUtility::getInstance ( ) [static]

Return a reference to the GSL (singleton) object.

This method returns a pointer reference to the GSL utility object. If it is not yet created, one is constructed and lives until the application terminates.

Returns:: GSLUtility::GSLUtility* Pointer reference to GSLUtility singleton

gsl_matrix * Isis::GSL::GSLUtility::GSLTogsl	(	const GSLMatrix &	m,
		gsl_matrix *	gm = `0`
	)			const

Converts TNT-based matrix to GSL matrix.

Convenience method to convert TNT-based matrix to a GSL matrix.

Parameters:

	m	TNT-based matrix to convert
	gm	Optional GSL matrix of same size to copy data to

Returns:: gsl_matrix* Pointer to GSL matrix copy

References _FILEINFO_, Columns(), Isis::IException::Programmer, and Rows().

gsl_vector * Isis::GSL::GSLUtility::GSLTogsl	(	const GSLVector &	v,
		gsl_vector *	gv = `0`
	)			const

Converts TNT-based vector to GSL vector.

Convenience method to convert TNT-based vector to a GSL vector.

Parameters:

	v	TNT-based vector to convert
	gv	Optional GSL vector of same size to copy data to

Returns:: gsl_vector* Pointer to GSL vector copy

References _FILEINFO_, Isis::IException::Programmer, and size().

GSLUtility::GSLMatrix Isis::GSL::GSLUtility::gslToGSL ( const gsl_matrix * m ) const

Converts a GSL matrix to a TNT-based matrix.

Convenience method to convert to GSLMatrix type

Parameters:

m

GSL matrix to convert

Returns:: GSLUtility::GSLMatrix TNT-based matrix

References Columns(), and Rows().

GSLUtility::GSLVector Isis::GSL::GSLUtility::gslToGSL ( const gsl_vector * v ) const

Converts a GSL vector to a TNT-based vector.

Convenience method to convert to GSLVector type

Parameters:

v

GSL vector to convert

Returns:: GSLUtility::GSLVector TNT-based vector

References size().

gsl_matrix * Isis::GSL::GSLUtility::identity	(	size_t	n1,
		size_t	n2
	)			const

Returns a GSL identity matrix of the specified size.

This method allocates a square or rectanglar matrix and initilizes it to the identity matrix. The diagonal elements are all set to 1.0, all other elements are set to 0.

Parameters:

	n1	Number rows to allocate
	n2	Number columns to allocate

Returns:: gsl_matrix* Returns pointer to identity matrix

gsl_matrix * Isis::GSL::GSLUtility::matrix	(	size_t	n1,
		size_t	n2,
		bool	zero = `false`
	)			const

Creates a GSL matrix.

This convenience method creates a GSL matrix for use within applications. The memory is dynamically allocated and must be managed (i.e., freed) by the caller. See the free() method for this provision.

Parameters:

	n1	Size of rows in the GSL matrix to create
	n2	Size of columns in the GSL matrix to create
	zero	Set to true if you want GSL to assign 0 to the allocated matrix otherwise, false will not initilize the memory.

Returns:: gsl_matrix* Returns an allocated GSL matrix

size_t Isis::GSL::GSLUtility::Rows ( const GSLMatrix & m ) const

Returns the number of rows in TNT-based matrix.

size_t Isis::GSL::GSLUtility::Rows ( const gsl_matrix * m ) const

Returns number of rows in a GSL matrix.

Referenced by GSLTogsl(), gslToGSL(), and size().

void Isis::GSL::GSLUtility::setIdentity ( gsl_matrix * m ) const

Initializes an existing GSL matrix to the identity matrix.

Parameters:

m

Pointer to matrix to set to identity

size_t Isis::GSL::GSLUtility::size ( const gsl_matrix * m ) const

Returns the total number of elements in a GSL matrix.

References Columns(), and Rows().

size_t Isis::GSL::GSLUtility::size ( const gsl_vector * v ) const

Returns the size of a GSL vector.

Referenced by GSLTogsl(), and gslToGSL().

QString Isis::GSL::GSLUtility::status ( int gsl_errno ) const [inline]

Returns GSL specific error text.

Parameters:

gsl_errno

GSL error number

Returns:: QString Textual context of GSL error

bool Isis::GSL::GSLUtility::success ( int status ) const [inline]

Tests if status is success.

gsl_vector * Isis::GSL::GSLUtility::vector	(	size_t	n,
		bool	zero = `false`
	)			const

Creates a GSL vector.

This convenience method creates a GSL vector for use within applications. The memory is dynamically allocated and must be managed (i.e., freed) by the caller. See the free() method for this provision.

Parameters:

	n	Size of GSL vector to create
	zero	Set to true if you want GSL to assign 0 to the allocated vector otherwise, false will not initilize the memory.

Returns:: gsl_vector* Returns an allocated GSL vector

The documentation for this class was generated from the following files:

src/base/objs/GSLUtility/GSLUtility.h
src/base/objs/GSLUtility/GSLUtility.cpp

Isis::GSL::GSLUtility Class Reference [Utility]

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation

Isis::GSL::GSLUtility Class Reference
[Utility]