Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template rms

boost::numeric::quadrature::rms — N,M Recursive Monotone Stable quadrature.

Synopsis

template<std::size_t N, std::size_t M, typename ErrorEst, typename Recorder, 
         typename Data> 
class rms {
public:
  // construct/copy/destruct
  rms(BOOST_QUADRATURE_CONSTRUCTOR_REF_ARG(error_estimator, ErrorEst), 
      BOOST_QUADRATURE_CONSTRUCTOR_REF_ARG(recorder, Recorder));

  // public member functions
  template<typename F, typename DL, typename DU, typename R> 
    quadrature_error operator()(F, DL, DU, R &) const;
  template<typename ErrorEst_> 
    rms< N, M, ErrorEst_, Recorder, Data > error_estimator(ErrorEst_ &) const;
  template<typename Recorder_> 
    rms< N, M, ErrorEst, Recorder_, Data > recorder(Recorder_ &) const;
  template<typename Data_> 
    rms< N, M, ErrorEst, Recorder, Data_ > kernel_data(Data_ &) const;

  // private member functions
   BOOST_QUADRATURE_REF_ARG(error_estimator, ErrorEst, unspecified, 
                            unspecified) ;
};

Description

N,M Recursive Monotone Stable quadrature. N and M are assumed odd, so coefficients become symmetric.

rms is defined for rms<19,13>, rms<27,19> and rms<41,27>.

rms construct/copy/destruct

  1. rms(BOOST_QUADRATURE_CONSTRUCTOR_REF_ARG(error_estimator, ErrorEst), 
        BOOST_QUADRATURE_CONSTRUCTOR_REF_ARG(recorder, Recorder));

rms public member functions

  1. template<typename F, typename DL, typename DU, typename R> 
      quadrature_error 
      operator()(F integrand, DL lower_limit, DU upper_limit, R & result) const;

    Parameters:
    integrand

    the integrand to be integrated

    lower_limit

    the lower limit of integration

    result

    the approcimation of the integral

    upper_limit

    the upper limit of integration

    Returns:

    error code

  2. template<typename ErrorEst_> 
      rms< N, M, ErrorEst_, Recorder, Data > 
      error_estimator(ErrorEst_ & error_estimator) const;

    Parameters:
    error_estimator

    the estimator to be used

    Returns:

    an rms integrator object, which includes the estimator

  3. template<typename Recorder_> 
      rms< N, M, ErrorEst, Recorder_, Data > recorder(Recorder_ & recorder) const;

    Parameters:
    recorder

    the recorder to be used

    Returns:

    an rms integrator object, which includes the recorder

  4. template<typename Data_> 
      rms< N, M, ErrorEst, Recorder, Data_ > 
      kernel_data(Data_ & kernel_data) const;

    Parameters:
    kernel_data

    the kernel_data to be used

    Returns:

    an rms integrator object, which includes the kernel data

rms private member functions

  1.  BOOST_QUADRATURE_REF_ARG(error_estimator, ErrorEst, unspecified, 
                              unspecified instance) ;
Copyright © 2007 Hugo Duncan

PrevUpHomeNext