Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarifying comments in model_base, namely 'set'-->'appended' parameters #3096

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Clarifying comments in model_base, namely 'set'-->'appended' parameters #3096

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions src/stan/model/model_base.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,9 @@ class model_base : public prob_grad {

/**
* Set the specified argument to sequence of parameters, transformed
* parameters, and generated quantities in the order in which they
* were declared. The input sequence is cleared and resized.
* parameters, and generated quantities in the order in which they were
* declared. Each parameter is included once, regardless of its size or
* dimensionality. The input sequence is cleared and resized.
*
* @param[in,out] names sequence of names parameters, transformed
* parameters, and generated quantities
Expand All @@ -91,9 +92,10 @@ class model_base : public prob_grad {
virtual void get_dims(std::vector<std::vector<size_t> >& dimss) const = 0;

/**
* Set the specified sequence to the indexed, scalar, constrained
* parameter names. Each variable is output with a
* period-separated list of indexes as a suffix, indexing from 1.
* Append to the given sequence with the names of the indexed, scalar,
* constrained parameters. Each variable is output with a period-separated
* list of indexes as a suffix, indexing from 1. This gives a "flattened"
* representation of all constrained parameters.
*
* <p>A real parameter `alpha` will produce output `alpha` with no
* indexes.
Expand Down Expand Up @@ -133,10 +135,11 @@ class model_base : public prob_grad {
bool include_gqs = true) const = 0;

/**
* Set the specified sequence of parameter names to the
* unconstrained parameter names. Each unconstrained parameter is
* represented as a simple one-dimensional sequence of values. The
* actual transforms are documented in the reference manual.
* Append to the given sequence with unconstrained parameter names. Each
* unconstrained parameter is represented as a simple one-dimensional
* sequence of values. Transforms from the unconstrained parameter space
* back to the constrained parameter space are documented in the reference
* manual, and implemented in the model_base::write_array methods.
*
* <p>The sizes will not be the declared sizes for types such as
* simplexes, correlation, and covariance matrices. A simplex of
Expand Down