Skip to content

Commit

Permalink
added doxygen to ellispoid methods that missed it
Browse files Browse the repository at this point in the history
  • Loading branch information
EirikKolas committed Jul 14, 2024
1 parent 35969a3 commit fae5a0e
Showing 1 changed file with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ template <size_t n_dims> class Ellipsoid {

/** Construct a new Ellipsoid object
* @param gauss n-dimensional Gaussian distribution
* @param scale_factor scale factor for the standard deviations
* @param scale_factor scale factor for the number of standard deviations (NB! This is slightly different from the ellipse scale factor)
*/
Ellipsoid(T::Gauss_n gauss, double scale_factor = 1.0)
: gauss_(gauss)
Expand Down Expand Up @@ -53,6 +53,9 @@ template <size_t n_dims> class Ellipsoid {
return eigen_vectors;
}

/** Get the volume of the ellipsoid
* @return double
*/
double volume() const
{
constexpr double scaling = std::pow(std::numbers::pi, n_dims / 2.0) / std::tgamma(n_dims / 2.0 + 1);
Expand Down

0 comments on commit fae5a0e

Please sign in to comment.