Ignore:
Timestamp:
Jan 15, 2009, 3:32:36 PM (12 years ago)
Author:
Jari Häkkinen
Message:

Fixes #466. GSL_error is now thrown on GSL errors. Last thing in this ticket.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/regression/GSLInterpolation.h

    r1722 r1724  
    5252     determined by the type of interpolation used.
    5353
    54      Some underlying GSL functions return GSL error codes. The error
    55      code is stored internally and should be checked for by the caller
    56      using GSLInterpolation::error_status(void). Refer to the
    57      gsl_errno.h for the error code listing.
     54     When underlying GSL functions return GSL error an GSL_error is
     55     thrown. Refer to the gsl_errno.h for the error code listing.
    5856
    5957     \since New in yat 0.5
     
    7371       not defined.
    7472
    75        Some underlying GSL functions return GSL error codes. The error
    76        code is stored internally and should be checked for by the
    77        caller. Refer to the gsl_errno.h for the error code listing.
    78 
    79        \see error_status(void)
     73       \throw GSL_error if some underlying GSL functions return GSL
     74       error. Refer to gsl_errno.h for the error code listing.
    8075    */
    8176    GSLInterpolation(const gsl_interp_type*, const utility::VectorBase& x,
     
    8883
    8984    /**
    90        \brief Check the error status
    91 
    92        Some underlying GSL functions return GSL error codes. The error
    93        code is stored internally and should be checked for by the
    94        caller. Refer to the gsl_errno.h for the error code listing.
    95 
    96        \return The current error status. A zero return values
    97        indicates no errors where encountered.
    98     */
    99     int error_status(void) const;
    100 
    101     /**
    10285       \brief Calculate the interpolated value for \a x.
    103 
    104        GSL error status is set if evaluation is requested outside the
    105        range defined by the interpolation algorithm. Use function
    106        error_status to check for errors.
    10786
    10887       \return The interpolated value of \f$ y \f$ for a given point
    10988       \a x.
    11089
    111        \see error_status(void)
     90       \throw GSL_error if evaluation is requested outside the range
     91       defined by the interpolation algorithm.
    11292    */
    11393    double evaluate(double x);
     
    11797       \a x.
    11898
    119        GSL error status is set if evaluation is requested outside the
    120        range defined by the interpolation algorithm. Use function
    121        error_status to check for errors.
    122 
    12399       \return The derivative.
    124100
    125        \see error_status(void)
     101       \throw GSL_error if evaluation is requested outside the range
     102       defined by the interpolation algorithm.
    126103    */
    127104    double evaluate_derivative(double x);
     
    131108       function at \a x.
    132109
    133        GSL error status is set if evaluation is requested outside the
    134        range defined by the interpolation algorithm. Use function
    135        error_status to check for errors.
    136 
    137110       \return The 2nd derivative.
    138111
    139        \see error_status(void)
     112       \throw GSL_error if evaluation is requested outside the range
     113       defined by the interpolation algorithm.
    140114    */
    141115    double evaluate_derivative2(double x);
     
    145119       function over the range \f$ [a,b] \f$.
    146120
    147        GSL error status is set if evaluation is requested outside the
    148        range defined by the interpolation algorithm. Use function
    149        error_status to check for errors.
    150 
    151121       \return The integral.
    152122
    153        \see error_status(void)
     123       \throw GSL_error if evaluation is requested outside the range
     124       defined by the interpolation algorithm.
    154125    */
    155126    double evaluate_integral(double a, double b);
     
    185156    double evaluation_;
    186157    gsl_interp* interpolator_;
    187     int gsl_status_;
    188158    double* x_;
    189159    double* y_;
Note: See TracChangeset for help on using the changeset viewer.