Commit 83f32e71 authored by Jean-Baptiste Mouret's avatar Jean-Baptiste Mouret
Browse files

[doc] the GP returns sigma squared, not sigma

parent 78df57d9
......@@ -70,7 +70,7 @@ namespace limbo {
/**
\rst
return :math:`\mu`, :math:`\sigma` (unormalized). If there is no sample, return the value according to the mean function. Using this method instead of separate calls to mu() and sigma() is more efficient because some computations are shared between mu() and sigma().
return :math:`\mu`, :math:`\sigma^2` (unormalized). If there is no sample, return the value according to the mean function. Using this method instead of separate calls to mu() and sigma() is more efficient because some computations are shared between mu() and sigma().
\endrst
*/
std::tuple<Eigen::VectorXd, double> query(const Eigen::VectorXd& v) const
......@@ -101,7 +101,7 @@ namespace limbo {
/**
\rst
return :math:`\sigma` (unormalized). If there is no sample, return the value according to the mean function.
return :math:`\sigma^2` (unormalized). If there is no sample, return the value according to the mean function.
\endrst
*/
double sigma(const Eigen::VectorXd& v) const
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment