Skip to content

Commit 699fb35

Browse files
committed
Update doxygen
[ci skip]
1 parent 3574160 commit 699fb35

10 files changed

Lines changed: 21 additions & 2 deletions

doxygen/doxygen.cfg

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2743,6 +2743,7 @@ MSCGEN_TOOL =
27432743
MSCFILE_DIRS =
27442744

27452745
ALIASES += laplace_options="\
2746+
\param[in] theta_0 the initial guess for the Laplace approximation. \
27462747
\param[in] tolerance controls the convergence criterion when finding the mode in the Laplace approximation. \
27472748
\param[in] max_num_steps maximum number of steps before the Newton solver breaks and returns an error. \
27482749
\param[in] hessian_block_size Block size of Hessian of log likelihood w.r.t latent Gaussian variable theta. \
@@ -2754,7 +2755,6 @@ ALIASES += laplace_options="\
27542755
"
27552756

27562757
ALIASES += laplace_common_template_args="\
2757-
\tparam ThetaVec A type inheriting from `Eigen::EigenBase` with dynamic sized rows and 1 column. \
27582758
\tparam CovarFun A functor with an `operator()(CovarArgsElements..., {TrainTupleElements...| PredTupleElements...})` \
27592759
method. The `operator()` method should accept as arguments the \
27602760
inner elements of `CovarArgs`. The return type of the `operator()` method \
@@ -2764,7 +2764,6 @@ ALIASES += laplace_common_template_args="\
27642764
"
27652765

27662766
ALIASES += laplace_common_args="\
2767-
\param[in] theta_0 the initial guess for the Laplace approximation. \
27682767
\param[in] covariance_function a function which returns the prior covariance. \
27692768
\param[in] covar_args arguments for the covariance function. \
27702769
"

stan/math/mix/prob/laplace_latent_bernoulli_logit_rng.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ namespace math {
1717
* return a multivariate normal random variate sampled
1818
* from the gaussian approximation of p(theta | y, phi),
1919
* where the likelihood is a Bernoulli with logit link.
20+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
21+
* with dynamic sized rows and 1 column.
2022
* \laplace_common_template_args
2123
* @tparam RNG A valid boost rng type
2224
* @param[in] y Vector Vector of total number of trials with a positive outcome.

stan/math/mix/prob/laplace_latent_neg_binomial_2_log_rng.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ namespace math {
2121
* parameterization of the Negative Binomial.
2222
*
2323
* @tparam Eta A type for the overdispersion parameter.
24+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
25+
* with dynamic sized rows and 1 column.
2426
* \laplace_common_template_args
2527
* @tparam RNG A valid boost rng type
2628
* @param[in] y Observed counts.

stan/math/mix/prob/laplace_latent_poisson_log_2_rng.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ namespace math {
1717
*
1818
* @tparam YeVec A type inheriting from `Eigen::EigenBase` with dynamic
1919
* sized rows and 1 column.
20+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
21+
* with dynamic sized rows and 1 column.
2022
* \laplace_common_template_args
2123
* @tparam RNG A valid boost rng type
2224
* @param[in] y total counts per group. Second sufficient statistics.

stan/math/mix/prob/laplace_latent_poisson_log_rng.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ namespace math {
1717
* return a sample from the Laplace approximation to p(theta|y,phi).
1818
* The Laplace approximation is computed using a Newton solver.
1919
* In this specialized function, the likelihood p(y|theta) is a
20+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
21+
* with dynamic sized rows and 1 column.
2022
* \laplace_common_template_args
2123
* @tparam RNG A valid boost rng type
2224
* @param[in] y Observed counts.

stan/math/mix/prob/laplace_latent_rng.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ namespace math {
1818
* where the log likelihood is given by L_f.
1919
* @tparam LLFunc Type of likelihood function.
2020
* @tparam LLArgs Type of arguments of likelihood function.
21+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
22+
* with dynamic sized rows and 1 column.
2123
* \laplace_common_template_args
2224
* @tparam RNG A valid boost rng type
2325
* @param[in] L_f Function that returns log likelihood.

stan/math/mix/prob/laplace_marginal_bernoulli_logit_lpmf.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ struct bernoulli_logit_likelihood {
3737
* for more details.
3838
*
3939
* @tparam propto boolean ignored
40+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
41+
* with dynamic sized rows and 1 column.
4042
* \laplace_common_template_args
4143
* @param[in] y total counts per group. Second sufficient statistics.
4244
* @param[in] n_samples number of samples per group. First sufficient

stan/math/mix/prob/laplace_marginal_neg_binomial_2_log_lpmf.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ struct neg_binomial_2_log_likelihood {
5353
* See the laplace_marginal function for more details.
5454
*
5555
* @tparam Eta The type of parameter arguments for the likelihood function.
56+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
57+
* with dynamic sized rows and 1 column.
5658
* \laplace_common_template_args
5759
* @param[in] y observed counts.
5860
* @param[in] y_index group to which each observation belongs. Each group
@@ -136,6 +138,8 @@ struct neg_binomial_2_log_likelihood_summary {
136138
* See the laplace_marginal function for more details.
137139
*
138140
* @tparam Eta The type of parameter arguments for the likelihood function.
141+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
142+
* with dynamic sized rows and 1 column.
139143
* \laplace_common_template_args
140144
* @param[in] y observations.
141145
* @param[in] n_per_group number of samples per group

stan/math/mix/prob/laplace_marginal_poisson_log_2_lpmf.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ struct poisson_log_2_likelihood {
6161
* @tparam propto boolean ignored
6262
* @tparam YeVec A type inheriting from `Eigen::EigenBase` with dynamic
6363
* sized rows and 1 column.
64+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
65+
* with dynamic sized rows and 1 column.
6466
* \laplace_common_template_args
6567
* @param[in] y total counts per group. Second sufficient statistics.
6668
* @param[in] y_index group to which each observation belongs.

stan/math/mix/prob/laplace_marginal_poisson_log_lpmf.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ struct poisson_log_likelihood {
5252
* for more details.
5353
*
5454
* @tparam propto ignored
55+
* @tparam ThetaVec A type inheriting from `Eigen::EigenBase`
56+
* with dynamic sized rows and 1 column.
5557
* \laplace_common_template_args
5658
* @param[in] y observed counts
5759
* @param[in] y_index group to which each observation belongs

0 commit comments

Comments
 (0)