Skip to content

Commit

Permalink
Documentation fixes. This commit is targeted for a 0.924 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew W. Steiner committed Dec 31, 2019
1 parent 5b3a1d1 commit 5d0314a
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 10 deletions.
4 changes: 2 additions & 2 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Improvements to the ode_iv_solve_grid class.

Improved error handling for calculator class.

Created functions vector_refine(), file_exists(), o2isfinite(),
Created functions vector_refine(), file_exists(), and o2isfinite().

Created classes inte_tanh_sinh_boost, inte_sinh_sinh_boost,
inte_kronrod_boost, inte_exp_tanh_boost, nucmass_gen, and frib_mex.
Expand All @@ -35,7 +35,7 @@ vector_spec() and mult_vector_spec().

Improved tabulate option for tov_love::calc_y().

Updated constants to CODATA 2018 release.
Updated constants for CODATA 2018 release.

------------------------------------------------------------------------
Notes for 0.923 release:
Expand Down
2 changes: 1 addition & 1 deletion src/inte/inte_kronrod_gsl.h
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ namespace o2scl {
- 6: 61-point rule
Any value other than 1-6 forces the error handler to be
called. All classes default to the 15-point rule,
except for \ref inte_qags_gsl which defaults to
except for \ref o2scl::inte_qags_gsl which defaults to
the 21-point rule for singularities.
The integration coefficients for use with this class and
Expand Down
2 changes: 1 addition & 1 deletion src/inte/inte_qagil_gsl.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace o2scl {
\int_{-\infty}^b f(x)~dx =
\int_0^1 f(b - (1-t)/t)t^{-2}~dt,
\f]
and the right hand side is evaluated with \ref inte_qags_gsl.
and the right hand side is evaluated with \ref o2scl::inte_qags_gsl.
See \ref gslinte_subsect in the User's guide for general
information about the GSL integration classes.
Expand Down
2 changes: 1 addition & 1 deletion src/inte/inte_qagiu_gsl.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace o2scl {
\int_a^{\infty} f(x)~dx =
\int_0^1 f(a + (1-t)/t)t^{-2}~dt,
\f]
and the right hand side is evaluated with \ref inte_qags_gsl.
and the right hand side is evaluated with \ref o2scl::inte_qags_gsl.
See \ref gslinte_subsect in the User's guide for general
information about the GSL integration classes.
Expand Down
6 changes: 3 additions & 3 deletions src/inte/inte_qawo_gsl.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ namespace o2scl {
\int_a^b f(x) \sin (\omega x)~dx
\f]
is computed for some frequency parameter \f$ \omega \f$,
stored in \ref inte_qawo_gsl_sin::omega .
stored in \ref o2scl::inte_qawo_gsl_sin::omega .
An adaptive algorithm together with an series-acceleration
method like that of \ref inte_qags_gsl is used. Those
method like that of \ref o2scl::inte_qags_gsl is used. Those
subintervals with "large" widths \f$ d \equiv b-a \f$ where \f$
d\omega > 4 \f$ are computed using a 25-point Clenshaw-Curtis
integration rule to handle the oscillatory behavior. In order to
Expand Down Expand Up @@ -639,7 +639,7 @@ namespace o2scl {
\f]
is computed for some frequency parameter \f$ \omega \f$ .
This class is exactly analogous to \ref inte_qawo_gsl_sin .
This class is exactly analogous to \ref o2scl::inte_qawo_gsl_sin .
See that class documentation for more details.
*/
template<class func_t> class inte_qawo_gsl_cos :
Expand Down
2 changes: 1 addition & 1 deletion src/inte/inte_singular_gsl.h
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ namespace o2scl {

public:

/** \brief A structure for extrapolation for \ref inte_qags_gsl
/** \brief A structure for extrapolation for \ref o2scl::inte_qags_gsl
\future Move this to a new class, with qelg() as a method
*/
Expand Down
7 changes: 6 additions & 1 deletion src/part/fermion_nonrel.h
Original file line number Diff line number Diff line change
Expand Up @@ -289,13 +289,18 @@ namespace o2scl {
return 0;
}


/** \brief Compute thermodynamics with antiparticles at fixed
chemical potential (unimplemented)
*/
virtual void pair_mu(fermion &f, fp_t temper) {
O2SCL_ERR2("Function fermion_nonrel::pair_mu() not ",
"implemented.",exc_eunimpl);
return;
}

/** \brief Compute thermodynamics with antiparticles at fixed
density (unimplemented)
*/
virtual int pair_density(fermion &f, fp_t temper) {
O2SCL_ERR2("Function fermion_nonrel::pair_density() not ",
"implemented.",exc_eunimpl);
Expand Down

0 comments on commit 5d0314a

Please sign in to comment.