1#ifndef STAN_MATH_MIX_FUNCTOR_LAPLACE_MARGINAL_DENSITY_ESTIMATOR_HPP
2#define STAN_MATH_MIX_FUNCTOR_LAPLACE_MARGINAL_DENSITY_ESTIMATOR_HPP
66 int max_num_steps_,
bool allow_fallthrough_,
67 int max_steps_line_search_)
76template <
bool HasInitTheta>
84 hessian_block_size = hessian_block_size_;
91 Eigen::VectorXd theta_0{0};
93 template <
typename ThetaVec>
95 int hessian_block_size_,
int solver_,
96 int max_steps_line_search_,
bool allow_fallthrough_)
98 max_num_steps_, allow_fallthrough_,
99 max_steps_line_search_),
100 theta_0(
value_of(
std::forward<ThetaVec>(theta_0_))) {}
108template <
typename Options>
110 using Ops = std::decay_t<Options>;
111 if constexpr (is_tuple_v<Ops>) {
112 if constexpr (!is_eigen_v<std::tuple_element_t<0, std::decay_t<Ops>>>) {
114 sizeof(std::decay_t<Ops>*) == 0,
115 "ERROR:(laplace_marginal_lpdf) The first laplace argument is "
116 "expected to be an Eigen vector of dynamic size representing the "
119 if constexpr (!stan::is_inner_tuple_type_v<1, Ops, double>) {
121 sizeof(std::decay_t<Ops>*) == 0,
122 "ERROR:(laplace_marginal_lpdf) The second laplace argument is "
123 "expected to be a double representing the tolerance.");
125 if constexpr (!stan::is_inner_tuple_type_v<2, Ops, int>) {
127 sizeof(std::decay_t<Ops>*) == 0,
128 "ERROR:(laplace_marginal_lpdf) The third laplace argument is "
129 "expected to be an int representing the maximum number of steps for "
130 "the laplace approximation.");
132 if constexpr (!stan::is_inner_tuple_type_v<3, Ops, int>) {
134 sizeof(std::decay_t<Ops>*) == 0,
135 "ERROR:(laplace_marginal_lpdf) The fourth laplace argument is "
136 "expected to be an int representing the solver.");
138 if constexpr (!stan::is_inner_tuple_type_v<4, Ops, int>) {
140 sizeof(std::decay_t<Ops>*) == 0,
141 "ERROR:(laplace_marginal_lpdf) The fifth laplace argument is "
142 "expected to be an int representing the max steps for the laplace "
143 "approximaton's wolfe line search.");
145 constexpr bool is_fallthrough
147 5, Ops,
int> || stan::is_inner_tuple_type_v<5, Ops, bool>;
148 if constexpr (!is_fallthrough) {
150 sizeof(std::decay_t<Ops>*) == 0,
151 "ERROR:(laplace_marginal_lpdf) The sixth laplace argument is "
152 "expected to be an int representing allow fallthrough (0/1).");
156 value_of(std::get<0>(std::forward<Options>(ops))),
159 defaults.hessian_block_size,
162 (std::get<5>(ops) > 0) ?
true :
false,
165 return std::forward<Options>(ops);
169template <
typename ThetaVec,
typename WR,
typename L_t,
typename A_vec,
170 typename ThetaGrad,
typename LU_t,
typename KRoot>
173 double lmd{std::numeric_limits<double>::infinity()};
209 A_vec&& a_, ThetaGrad&& theta_grad_, LU_t&& LU_,
210 KRoot&& K_root_,
int solver_used_)
241template <
typename WRootMat>
243 const Eigen::SparseMatrix<double>& W,
244 const Eigen::Index block_size) {
245 const Eigen::Index n_block = W.cols() / block_size;
246 Eigen::MatrixXd local_block(block_size, block_size);
247 Eigen::MatrixXd local_block_sqrt(block_size, block_size);
248 Eigen::SelfAdjointEigenSolver<Eigen::MatrixXd> eigensolver;
251 for (Eigen::Index i = 0; i < n_block; i++) {
253 = W.block(i * block_size, i * block_size, block_size, block_size);
254 if (
unlikely(!local_block.array().isFinite().all())) {
256 throw std::domain_error(
257 std::string(
"Error in block_matrix_sqrt: "
258 "non-finite values detected in block diagonal "
260 + std::to_string(i) +
", " + std::to_string(i) +
")");
263 local_block_sqrt = 0.5 * (local_block + local_block.transpose());
264 eigensolver.compute(local_block_sqrt);
265 if (
unlikely(eigensolver.info() != Eigen::Success)) {
267 throw std::domain_error(
268 std::string(
"Error in block_matrix_sqrt: "
269 "eigendecomposition failed for block diagonal "
271 + std::to_string(i) +
", " + std::to_string(i) +
")");
274 const Eigen::VectorXd
eigenvalues = eigensolver.eigenvalues();
275 const double tolerance = block_size * std::numeric_limits<double>::epsilon()
279 throw std::domain_error(
280 std::string(
"Error in block_matrix_sqrt: block diagonal starting "
282 + std::to_string(i) +
", " + std::to_string(i)
283 +
") is not positive semi-definite (smallest eigenvalue "
287 local_block_sqrt.noalias()
288 = eigensolver.eigenvectors()
289 *
eigenvalues.cwiseMax(0.0).cwiseSqrt().asDiagonal()
290 * eigensolver.eigenvectors().transpose();
291 for (Eigen::Index k = 0; k < block_size; k++) {
292 for (Eigen::Index j = 0; j < block_size; j++) {
293 W_root.coeffRef(i * block_size + j, i * block_size + k)
294 = local_block_sqrt(j, k);
309template <
bool InitTheta,
typename CovarMat>
312 const CovarMat& covariance) {
313 if constexpr (InitTheta) {
315 check_finite(frame_name,
"initial guess", options.theta_0);
316 if (
unlikely(options.theta_0.size() != covariance.rows())) {
317 std::stringstream msg;
318 msg << frame_name <<
": The size of the initial theta ("
319 << options.theta_0.size()
320 <<
") vector must match the rows and columns of the covariance "
322 << covariance.rows() <<
", " << covariance.cols() <<
").";
323 throw std::domain_error(msg.str());
327 check_positive(frame_name,
"max_num_steps", options.max_num_steps);
328 check_positive(frame_name,
"hessian_block_size", options.hessian_block_size);
331 const Eigen::Index theta_size = covariance.rows();
332 if (
unlikely(theta_size % options.hessian_block_size != 0
333 || theta_size < options.hessian_block_size)) {
334 throw std::domain_error(
335 "laplace_marginal_density: Hessian block size mismatch.");
338 if (
unlikely(options.solver < 1 || options.solver > 3)) {
339 throw std::domain_error(
340 "laplace_marginal_density: solver must be 1, 2, or 3. Got: "
341 + std::to_string(options.solver));
400 template <
typename ObjFun,
typename ThetaGradFun,
typename CovarianceT,
401 typename ThetaInitializer>
402 NewtonState(
int theta_size, ObjFun&& obj_fun, ThetaGradFun&& theta_grad_f,
403 CovarianceT&& covariance, ThetaInitializer&& theta_init)
405 covariance.llt().solve(theta_init),
406 std::forward<ThetaInitializer>(theta_init),
407 std::forward<ThetaGradFun>(theta_grad_f)),
410 B(theta_size, theta_size),
442 template <
typename Options>
446 = std::clamp(this->
curr().alpha(), 0.0, options.line_search.max_alpha);
459template <
typename LLT,
typename B_t>
461 double max_jitter = 1
e-5) {
463 if (llt_B.info() != Eigen::Success) {
464 double prev_jitter = 0.0;
465 double jitter_try = min_jitter;
466 for (; jitter_try < max_jitter; jitter_try *= 10) {
469 B.diagonal().array() += (jitter_try - prev_jitter);
470 prev_jitter = jitter_try;
472 if (llt_B.info() == Eigen::Success) {
476 if (llt_B.info() != Eigen::Success) {
477 throw std::domain_error(
478 "laplace_marginal_density: Cholesky failed after adding jitter up to "
479 + std::to_string(jitter_try));
507 template <
typename NewtonStateT,
typename CovarMat>
530 template <
typename NewtonStateT,
typename LLFun,
typename LLTupleArgs,
533 const LLTupleArgs& ll_args,
const CovarMat& covariance,
534 int , std::ostream* msgs) {
535 const Eigen::Index theta_size = state.b.size();
540 for (Eigen::Index j = 0; j <
W_diag.size(); j++) {
541 if (
W_diag.coeff(j) < 0 || !std::isfinite(
W_diag.coeff(j))) {
542 throw std::domain_error(
543 "laplace_marginal_density: Hessian matrix is not positive "
552 = Eigen::MatrixXd::Identity(theta_size, theta_size)
558 state.b.noalias() = (
W_diag.array() * state.prev().theta().array()).matrix()
559 + state.prev().theta_grad();
560 auto L =
llt_B.matrixL();
561 auto LT =
llt_B.matrixU();
562 state.proposal_step().a().noalias()
566 L.solve(
W_r_diag.cwiseProduct(covariance * state.b)));
574 return 2.0 *
llt_B.matrixLLT().diagonal().array().log().sum();
585 template <
typename NewtonStateT>
588 state.prev().obj() - 0.5 * log_det,
589 std::move(state).prev().
theta(),
590 Eigen::SparseMatrix<double>(
W_r_diag.asDiagonal()),
591 Eigen::MatrixXd(
llt_B.matrixL()),
592 std::move(state).prev().a(),
593 std::move(state).prev().theta_grad(),
594 Eigen::PartialPivLU<Eigen::MatrixXd>{},
595 Eigen::MatrixXd(0, 0),
615 Eigen::SparseMatrix<double>
W_r;
623 template <
typename NewtonStateT>
626 const Eigen::Index theta_size = state.b.size();
627 W_r.reserve(Eigen::VectorXi::Constant(theta_size, hessian_block_size));
628 const Eigen::Index n_block = theta_size / hessian_block_size;
629 for (Eigen::Index ii = 0; ii < n_block; ii++) {
630 for (Eigen::Index k = 0; k < hessian_block_size; k++) {
631 for (Eigen::Index j = 0; j < hessian_block_size; j++) {
632 W_r.insert(ii * hessian_block_size + j, ii * hessian_block_size + k)
637 W_r.makeCompressed();
662 template <
typename NewtonStateT,
typename LLFun,
typename LLTupleArgs,
665 const LLTupleArgs& ll_args,
const CovarMat& covariance,
666 int hessian_block_size, std::ostream* msgs) {
667 const Eigen::Index theta_size = state.b.size();
670 ll_fun, state.prev().theta(), hessian_block_size, ll_args, msgs);
672 for (Eigen::Index j = 0; j <
W_block.rows(); j++) {
673 if (
W_block.coeff(j, j) < 0 || !std::isfinite(
W_block.coeff(j, j))) {
674 throw std::domain_error(
675 "laplace_marginal_density: Hessian matrix is not positive "
684 state.B.noalias() = Eigen::MatrixXd::Identity(theta_size, theta_size)
685 +
W_r * (covariance *
W_r);
692 =
W_block * state.prev().theta() + state.prev().theta_grad();
693 auto L =
llt_B.matrixL();
694 auto LT =
llt_B.matrixU();
695 state.proposal_step().a().noalias()
696 = state.b -
W_r * LT.solve(L.solve(
W_r * (covariance * state.b)));
704 return 2.0 *
llt_B.matrixLLT().diagonal().array().log().sum();
715 template <
typename NewtonStateT>
718 std::move(state).prev().
theta(),
720 Eigen::MatrixXd(
llt_B.matrixL()),
721 std::move(state).prev().a(),
722 std::move(state).prev().theta_grad(),
723 Eigen::PartialPivLU<Eigen::MatrixXd>{},
724 Eigen::MatrixXd(0, 0),
751 template <
typename NewtonStateT,
typename CovarMat>
754 auto K_root_llt = covariance.template selfadjointView<Eigen::Lower>().llt();
755 if (K_root_llt.info() != Eigen::Success) {
756 throw std::domain_error(
757 "laplace_marginal_density: Cholesky of covariance failed at start");
759 K_root = std::move(K_root_llt.matrixL());
782 template <
typename NewtonStateT,
typename LLFun,
typename LLTupleArgs,
785 const LLTupleArgs& ll_args,
const CovarMat& covariance,
786 int hessian_block_size, std::ostream* msgs) {
787 const Eigen::Index theta_size = state.b.size();
791 ll_fun, state.prev().theta(), hessian_block_size, ll_args, msgs);
794 state.B.noalias() = Eigen::MatrixXd::Identity(theta_size, theta_size)
802 =
W_full * state.prev().theta() + state.prev().theta_grad();
803 auto L =
llt_B.matrixL();
804 auto LT =
llt_B.matrixU();
805 state.proposal_step().a().noalias()
806 =
K_root.transpose().template triangularView<Eigen::Upper>().solve(
807 LT.solve(L.solve(
K_root.transpose() * state.b)));
815 return 2.0 *
llt_B.matrixLLT().diagonal().array().log().sum();
826 template <
typename NewtonStateT>
829 std::move(state.prev().theta()),
831 Eigen::MatrixXd(
llt_B.matrixL()),
832 std::move(state.prev().a()),
833 std::move(state.prev().theta_grad()),
834 Eigen::PartialPivLU<Eigen::MatrixXd>{},
855 Eigen::PartialPivLU<Eigen::MatrixXd>
lu;
877 template <
typename NewtonStateT,
typename LLFun,
typename LLTupleArgs,
880 const LLTupleArgs& ll_args,
const CovarMat& covariance,
881 int hessian_block_size, std::ostream* msgs) {
882 const Eigen::Index theta_size = state.b.size();
886 ll_fun, state.prev().theta(), hessian_block_size, ll_args, msgs);
889 lu.compute(Eigen::MatrixXd::Identity(theta_size, theta_size)
894 =
W_full * state.prev().theta() + state.prev().theta_grad();
895 state.proposal_step().a().noalias()
896 = state.b -
W_full *
lu.solve(covariance * state.b);
909 return lu.matrixLU().diagonal().array().log().sum();
920 template <
typename NewtonStateT>
923 std::move(state).prev().
theta(),
925 Eigen::MatrixXd(0, 0),
926 std::move(state).prev().a(),
927 std::move(state).prev().theta_grad(),
929 Eigen::MatrixXd(0, 0),
956template <
typename SolverPolicy,
typename NewtonStateT,
typename OptionsT,
957 typename LLFunT,
typename LLTupleArgsT,
typename CovarMatT,
960 const OptionsT& options, Eigen::Index& step_iter,
961 const LLFunT& ll_fun,
const LLTupleArgsT& ll_args,
962 const CovarMatT& covariance, UpdateFun&& update_fun,
963 std::ostream* msgs) {
964 bool finish_update =
false;
965 for (; step_iter <= options.max_num_steps; step_iter++) {
966 solver.solve_step(state, ll_fun, ll_args, covariance,
967 options.hessian_block_size, msgs);
968 if (!state.final_loop) {
969 auto&& proposal = state.proposal_step();
970 state.wolfe_info.p_ = proposal.a() - state.prev().a();
971 state.prev_g.noalias() = -covariance * state.prev().a()
972 + covariance * state.prev().theta_grad();
973 state.wolfe_info.init_dir_ = state.prev_g.dot(state.wolfe_info.p_);
975 state.wolfe_info.flip_direction();
976 auto&& scratch = state.wolfe_info.scratch_;
977 proposal.eval_.alpha() = 1.0;
978 const bool proposal_valid
979 = update_fun(proposal, state.curr(), state.prev(), proposal.eval_,
980 state.wolfe_info.p_);
981 const bool cached_proposal_ok
982 = proposal_valid && std::isfinite(proposal.obj())
983 && std::isfinite(proposal.dir())
984 && proposal.alpha() > options.line_search.min_alpha;
985 if (!cached_proposal_ok) {
988 }
else if (options.line_search.max_iterations == 0) {
989 state.curr().update(proposal);
992 Eigen::VectorXd s = proposal.a() - state.prev().a();
994 = (-covariance * proposal.a() + covariance * proposal.theta_grad())
997 s, full_step_grad, state.prev_g, state.prev().alpha(),
998 state.wolfe_status.num_backtracks_, options.line_search.min_alpha,
999 options.line_search.max_alpha);
1001 state.wolfe_info, update_fun, options.line_search, msgs);
1003 bool search_failed = !state.wolfe_status.accept_;
1004 const bool proposal_armijo_ok
1005 = cached_proposal_ok
1007 proposal.obj(), state.prev().obj(), proposal.alpha(),
1008 state.wolfe_info.init_dir_, options.line_search);
1009 if (search_failed && proposal_armijo_ok) {
1010 state.curr().update(proposal);
1013 state.wolfe_status.num_backtracks_,
true};
1014 search_failed =
false;
1016 bool objective_converged
1017 = state.wolfe_status.accept_
1018 && std::abs(state.curr().obj() - state.prev().obj())
1019 < options.tolerance;
1020 finish_update = objective_converged || search_failed;
1022 if (finish_update) {
1023 if (!state.final_loop && state.wolfe_status.accept_) {
1025 state.final_loop =
true;
1026 state.update_next_step(options);
1029 return solver.build_result(state, solver.compute_log_determinant());
1031 state.update_next_step(options);
1037 "WARNING(laplace_marginal_density): max number of iterations: ")
1038 + std::to_string(options.max_num_steps) +
" exceeded.";
1040 return solver.build_result(state, solver.compute_log_determinant());
1053 std::string_view failed_solver,
1054 const std::exception&
e) {
1055 std::ostringstream os;
1056 os << context <<
": " << failed_solver <<
" failed at iteration " << iter
1057 <<
" and allow_fallthrough is false. Reason: " <<
e.what();
1058 throw std::domain_error(os.str());
1072 std::string_view failed_solver,
1073 std::string_view next_solver,
1074 const std::exception&
e) {
1079 std::ostringstream os;
1080 os <<
"[" << context <<
"] WARNING: solver fallback\n"
1081 <<
" " << std::left << std::setw(12) <<
"iteration:" << iter <<
"\n"
1082 <<
" " << std::left << std::setw(12) <<
"failed:" << failed_solver <<
"\n"
1083 <<
" " << std::left << std::setw(12) <<
"reason:" <<
e.what() <<
"\n"
1084 <<
" " << std::left << std::setw(12) <<
"action:"
1085 <<
"trying " << next_solver <<
"\n"
1086 <<
"note: this warning message will only be displayed once."
1088 (*msgs) << os.str();
1091template <
bool InitTheta,
typename Opts>
1093 if constexpr (InitTheta) {
1095 return std::decay_t<decltype(options)>(options).theta_0;
1097 return Eigen::MatrixXd::Zero(theta_size, 1);
1119template <
typename ObjFun,
typename ThetaGradFun,
typename Covariance,
1122 Covariance&& covariance, Options&& options) {
1123 auto update_step = [&covariance, &obj_fun, &theta_grad_f](
1124 auto& proposal,
auto&& ,
auto&& prev,
1125 auto& eval_in,
auto&& p) {
1127 proposal.a() = prev.a() + eval_in.alpha() * p;
1128 proposal.theta().noalias() = covariance * proposal.a();
1129 proposal.theta_grad() = theta_grad_f(proposal.theta());
1130 eval_in.obj() = obj_fun(proposal.a(), proposal.theta());
1132 = (-covariance * proposal.a() + covariance * proposal.theta_grad())
1134 return std::isfinite(eval_in.obj()) && std::isfinite(eval_in.dir());
1135 }
catch (
const std::exception&) {
1139 auto backoff = [&options](
auto&
eval) {
1140 eval.alpha() *= options.line_search.tau;
1141 return eval.alpha() > options.line_search.min_alpha;
1144 [update_step_ = std::move(update_step), backoff_ = std::move(backoff)](
1145 auto& proposal,
auto&& curr,
auto&& prev,
auto& eval_in,
auto&& p) {
1147 eval_in, p, backoff_);
1204template <
typename LLFun,
typename LLTupleArgs,
typename CovarMat,
1208 LLFun&& ll_fun, LLTupleArgs&& ll_args, CovarMat&& covariance,
1212 const Eigen::Index theta_size = covariance.rows();
1214 auto obj_fun = [&ll_fun, &ll_args, &msgs](
const Eigen::VectorXd& a_val,
1215 auto&& theta_val) ->
double {
1216 return -0.5 * a_val.dot(theta_val)
1220 auto theta_grad_f = [&ll_fun, &ll_args, &msgs](
auto&& theta_val) {
1223 decltype(
auto) theta_init = theta_init_impl<InitTheta>(theta_size, options);
1230 =
NewtonState(theta_size, obj_fun, theta_grad_f, covariance, theta_init);
1233 std::move(obj_fun), std::move(theta_grad_f), covariance, options);
1234 Eigen::Index step_iter = 0;
1236 if (options.solver == 1) {
1237 if (options.hessian_block_size == 1) {
1240 ll_args, covariance, update_fun, msgs);
1244 ll_args, covariance, update_fun, msgs);
1247 }
catch (
const std::exception&
e) {
1248 const std::string solver_type
1249 = (options.hessian_block_size == 1) ?
"Diagonal" :
"Block";
1250 std::string failed =
"solver 1 (" + solver_type +
" Hessian-root Cholesky)";
1251 if (!options.allow_fallthrough) {
1259 msgs,
"laplace_marginal_density", step_iter, std::move(failed),
1260 "solver 2 (Covariance-root Cholesky)",
e);
1263 if (options.solver == 2 || options.allow_fallthrough) {
1265 return run_newton_loop(solver, state, options, step_iter, ll_fun, ll_args,
1266 covariance, update_fun, msgs);
1268 }
catch (
const std::exception&
e) {
1269 if (!options.allow_fallthrough) {
1271 "solver 2 (Covariance-root Cholesky)",
e);
1278 msgs,
"laplace_marginal_density", step_iter,
1279 "solver 2 (Covariance-root Cholesky)",
"solver 3 (General LU solver)",
1282 if (options.solver == 3 || options.allow_fallthrough) {
1284 return run_newton_loop(solver, state, options, step_iter, ll_fun, ll_args,
1285 covariance, update_fun, msgs);
1287 throw std::domain_error(
1288 std::string(
"You chose a solver (") + std::to_string(options.solver)
1289 +
") that is not valid. Please choose either 1, 2, or 3.");
int64_t size(const T &m)
Returns the size (number of the elements) of a matrix_cl or var_value<matrix_cl<T>>.
(Expert) Numerical traits for algorithmic differentiation variables.
WolfeStatus wolfe_line_search(Info &wolfe_info, UpdateFun &&update_fun, Options &&opt, Stream *msgs)
Strong Wolfe line search for maximization.
static thread_local std::once_flag fallback_warning_2_3
auto create_update_fun(ObjFun &&obj_fun, ThetaGradFun &&theta_grad_f, Covariance &&covariance, Options &&options)
Create the update function for the line search, capturing necessary references.
auto run_newton_loop(SolverPolicy &solver, NewtonStateT &state, const OptionsT &options, Eigen::Index &step_iter, const LLFunT &ll_fun, const LLTupleArgsT &ll_args, const CovarMatT &covariance, UpdateFun &&update_fun, std::ostream *msgs)
Run a Newton loop with a solver policy, updating the shared state.
void log_solver_fallback(std::ostream *msgs, std::string_view context, Eigen::Index iter, std::string_view failed_solver, std::string_view next_solver, const std::exception &e)
Log a solver fallback event to the provided stream, if any.
double barzilai_borwein_step_size(const Eigen::VectorXd &s, const Eigen::VectorXd &g_curr, const Eigen::VectorXd &g_prev, double prev_step, int last_backtracks, double min_alpha, double max_alpha)
Curvature-aware Barzilai–Borwein (BB) step length with robust safeguards.
constexpr int laplace_default_max_num_steps
decltype(auto) theta_init_impl(Eigen::Index theta_size, Opts &&options)
auto check_armijo(double obj_next, double obj_init, double alpha_next, double dir0, Option &&opt)
constexpr double laplace_default_tolerance
void throw_solver_failure(std::string_view context, Eigen::Index iter, std::string_view failed_solver, const std::exception &e)
Throw for a solver failure when falling through to the next solver is not allowed.
constexpr int laplace_default_solver
constexpr auto tuple_to_laplace_options(Options &&ops)
constexpr int laplace_default_max_steps_line_search
constexpr int laplace_default_hessian_block_size
void validate_laplace_options(const char *frame_name, const laplace_options< InitTheta > &options, const CovarMat &covariance)
Validates the options for the Laplace approximation.
constexpr int laplace_default_allow_fallthrough
static thread_local std::once_flag fallback_warning_1_2
auto retry_evaluate(Update &&update, Proposal &&proposal, Curr &&curr, Prev &&prev, Eval &eval, P &&p, Backoff &&backoff)
Retry evaluation of a step until it passes a validity check.
auto laplace_marginal_density_est(LLFun &&ll_fun, LLTupleArgs &&ll_args, CovarMat &&covariance, const laplace_options< InitTheta > &options, std::ostream *msgs)
For a latent Gaussian model with hyperparameters phi and latent variables theta, and observations y,...
void llt_with_jitter(LLT &llt_B, B_t &B, double min_jitter=1e-10, double max_jitter=1e-5)
Factorize B with jittering fallback.
void block_matrix_sqrt(WRootMat &W_root, const Eigen::SparseMatrix< double > &W, const Eigen::Index block_size)
Returns the principal square root of a symmetric positive semi-definite block diagonal matrix.
auto diagonal_hessian(F &&f, Theta &&theta, TupleArgs &&ll_tuple, Stream *msgs)
auto log_likelihood(F &&f, Theta &&theta, TupleArgs &&ll_tup, Stream *msgs)
A wrapper that accepts a tuple as arguments.
auto block_hessian(F &&f, Theta &&theta, const Eigen::Index hessian_block_size, TupleArgs &&ll_tuple, Stream *msgs)
auto theta_grad(F &&f, Theta &&theta, TupleArgs &&ll_tup, Stream *msgs=nullptr)
A wrapper that accepts a tuple as arguments.
Eigen::Matrix< complex_return_t< value_type_t< EigMat > >, -1, 1 > eigenvalues(EigMat &&m)
Return the eigenvalues of a (real-valued) matrix.
void check_square(const char *function, const char *name, const T_y &y)
Check if the specified matrix is square.
void check_nonnegative(const char *function, const char *name, const T_y &y)
Check if y is non-negative.
static constexpr double e()
Return the base of the natural logarithm.
T eval(T &&arg)
Inputs which have a plain_type equal to the own time are forwarded unmodified (for Eigen expressions ...
T value_of(const fvar< T > &v)
Return the value of the specified variable.
void check_finite(const char *function, const char *name, const T_y &y)
Return true if all values in y are finite.
void check_nonzero_size(const char *function, const char *name, const T_y &y)
Check if the specified matrix/vector is of non-zero size.
void check_positive(const char *function, const char *name, const T_y &y)
Check if y is positive.
double dot(const std::vector< double > &x, const std::vector< double > &y)
constexpr bool is_inner_tuple_type_v
Checks if the N-th element of a tuple is of the same type as CheckType.
std::enable_if_t< Check::value > require_t
If condition is true, template is enabled.
The lgamma implementation in stan-math is based on either the reentrant safe lgamma_r implementation ...
void solve_step(NewtonStateT &state, const LLFun &ll_fun, const LLTupleArgs &ll_args, const CovarMat &covariance, int hessian_block_size, std::ostream *msgs)
Perform one Newton step using covariance Cholesky solver.
Eigen::MatrixXd K_root
Lower Cholesky factor of covariance: Sigma = K_root * K_root^T.
Eigen::LLT< Eigen::MatrixXd > llt_B
Cholesky factorization of B = I + K_root^T * W * K_root.
Eigen::SparseMatrix< double > W_full
Full (block) Hessian matrix from likelihood.
double compute_log_determinant() const
Compute log determinant of B from Cholesky factor.
auto build_result(NewtonStateT &state, double log_det)
Build the final result structure.
CholeskyKSolver(const NewtonStateT &state, const CovarMat &covariance)
Solver Policy 2: Cholesky decomposition of K (Covariance).
Eigen::LLT< Eigen::MatrixXd > llt_B
Cholesky factorization of B = I + W_r * Sigma * W_r.
Eigen::SparseMatrix< double > W_block
Sparse block-diagonal Hessian from likelihood.
Eigen::SparseMatrix< double > W_r
Sparse square root of block Hessian.
double compute_log_determinant() const
Compute log determinant of B from Cholesky factor.
void solve_step(NewtonStateT &state, const LLFun &ll_fun, const LLTupleArgs &ll_args, const CovarMat &covariance, int hessian_block_size, std::ostream *msgs)
Perform one Newton step using block-diagonal Hessian solver.
auto build_result(NewtonStateT &state, double log_det)
Build the final result structure.
CholeskyWSolverBlock(const NewtonStateT &state, int hessian_block_size)
Solver Policy 1 (Block): Cholesky decomposition using block W.
void solve_step(NewtonStateT &state, const LLFun &ll_fun, const LLTupleArgs &ll_args, const CovarMat &covariance, int, std::ostream *msgs)
Perform one Newton step using diagonal Hessian solver.
Eigen::LLT< Eigen::MatrixXd > llt_B
Cholesky factorization of B = I + W_r * Sigma * W_r.
CholeskyWSolverDiag(const NewtonStateT &state, const CovarMat &covariance)
Eigen::VectorXd W_r_diag
Square root of diagonal Hessian: W_r[j] = sqrt(W[j])
auto build_result(NewtonStateT &state, double log_det)
Build the final result structure.
Eigen::VectorXd W_diag
Diagonal Hessian values from the likelihood.
double compute_log_determinant() const
Compute log determinant of B from Cholesky factor.
Solver Policy 1 (Diagonal): Cholesky decomposition using W.
auto build_result(NewtonStateT &state, double log_det)
Build the final result structure.
void solve_step(NewtonStateT &state, const LLFun &ll_fun, const LLTupleArgs &ll_args, const CovarMat &covariance, int hessian_block_size, std::ostream *msgs)
Perform one Newton step using LU decomposition solver.
double compute_log_determinant() const
Compute log determinant from LU factorization.
Eigen::SparseMatrix< double > W_full
Full Hessian matrix from likelihood.
Eigen::PartialPivLU< Eigen::MatrixXd > lu
LU factorization of B = I + Sigma * W.
Solver Policy 3: LU Decomposition.
WolfeData proposal
Cached proposal evaluated before the Wolfe line search.
auto & prev() &
Access the previous step state (mutable).
Eigen::MatrixXd B
Workspace matrix: B = I + W_r * Sigma * W_r (or similar)
auto && proposal_step() &&
WolfeStatus wolfe_status
Status of the most recent Wolfe line search.
auto & curr() &
Access the current step state (mutable).
Eigen::VectorXd b
Workspace vector: b = W * theta + grad(log_lik)
const auto & proposal_step() const &
void update_next_step(const Options &options)
WolfeInfo wolfe_info
Wolfe line search state including current/previous steps.
const auto & curr() const &
Access the current step state (const).
NewtonState(int theta_size, ObjFun &&obj_fun, ThetaGradFun &&theta_grad_f, CovarianceT &&covariance, ThetaInitializer &&theta_init)
Constructs Newton state with a consistent (a_init, theta_init) pair.
Eigen::VectorXd prev_g
Previous gradient for Barzilai-Borwein step calculation.
bool final_loop
On the final loop if we found a better wolfe step, but we are going to exit, we want to make sure all...
const auto & prev() const &
Access the previous step state (const).
Holds the state for the Newton-Raphson optimization loop.
Data used in current evaluation of wolfe line search at a particular stepsize.
Data object used in wolfe line search.
Struct to hold the result status of the Wolfe line search.
L_t L
Solver-dependent factorization of the system matrix B.
KRoot K_root
Lower Cholesky factor of the covariance matrix.
WR W_r
Solver-dependent Hessian quantity.
A_vec a
Mode in the a parameterization, where theta = covariance * a.
ThetaGrad theta_grad
Gradient of the log-likelihood with respect to theta at the mode.
laplace_density_estimates(double lmd_, ThetaVec &&theta_, WR &&W_r_, L_t &&L_, A_vec &&a_, ThetaGrad &&theta_grad_, LU_t &&LU_, KRoot &&K_root_, int solver_used_)
Options for Wolfe line search during optimization.
laplace_options(int hessian_block_size_)
laplace_options()=default
laplace_options(ThetaVec &&theta_0_, double tolerance_, int max_num_steps_, int hessian_block_size_, int solver_, int max_steps_line_search_, bool allow_fallthrough_)
double tolerance
Iterations end when the absolute change in the optimization objective is less than this tolerance.
int solver
Which linear solver to use inside the Newton step.
laplace_options_base()=default
laplace_line_search_options line_search
laplace_options_base(int hessian_block_size_, int solver_, double tolerance_, int max_num_steps_, bool allow_fallthrough_, int max_steps_line_search_)
Options for the Laplace approximation.