gsl_util.h

Go to the documentation of this file.

/*
 * $Id: gsl_util.h 14342 2013-05-02 02:35:41Z predoehl $
 */

#ifndef GSL_UTIL_H_KJBLIB_UARIZONAVISION
#define GSL_UTIL_H_KJBLIB_UARIZONAVISION

#ifdef KJB_HAVE_GSL
#include "gsl/gsl_errno.h"
#else
#warning "GNU GSL is absent"
#define GSL_SUCCESS 0
#endif

/*
 * @brief This throws an exception if its argument is a GSL error.
 * @throws KJB_error if the gsl_code is not equal to GSL_SUCCESS
 *
 * This macro is intended to be used like other KJB-library macros like ETE
 * or EPE:  it surrounds executable code that might return a GSL error.
 * In the common case the expression is GSL_SUCCESS and the macro does nothing.
 * When the argument is not GSL_SUCCESS, this will generate an error string
 * describing the flavor of GSL error, and throw a kjb::KJB_error object
 * containing the error string.
 *
 * This macro invokes an implementation function that is designed to be as
 * lightweight as possible, so that each use injects a minimum of code inline.
 */
#define GSL_ETX( gsl_expr ) kjb::Gsl_Etx_impl( (gsl_expr), __FILE__, __LINE__ )


namespace kjb {


void report_gsl_failure_and_throw_kjb_error(
    int gsl_code,
    const char* file,
    unsigned line_no
);


inline
void Gsl_Etx_impl( int gsl_code, const char* file, unsigned line_no )
{
    if ( GSL_SUCCESS != gsl_code )
    {
        report_gsl_failure_and_throw_kjb_error( gsl_code, file, line_no );
    }
}

void gsl_iterate_EPE(int gsl_error_code);

}

#endif