Skip to content

Commit dbdd658

Browse files
committed
Update doc comments
1 parent cab76de commit dbdd658

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

stan/math/prim/constraint/simplex_constrain.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ namespace math {
1919
* to 0 that sum to 1. A vector with (K-1) unconstrained values
2020
* will produce a simplex of size K.
2121
*
22-
* The simplex transform is defined using the Isometric Log Ratio
23-
* transform (ILR). This code is equilvalent to
22+
* The simplex transform is defined using the inverse of the
23+
* isometric log ratio (ILR) transform. This code is equivalent to
2424
* `softmax(sum_to_zero_constrain(y))`, but is more efficient and
2525
* stable if computed this way thanks to the use of the online
2626
* softmax algorithm courtesy of https://arxiv.org/abs/1805.02867.
@@ -77,8 +77,8 @@ inline plain_type_t<Vec> simplex_constrain(const Vec& y) {
7777
* and increment the specified log probability reference with
7878
* the log absolute Jacobian determinant of the transform.
7979
*
80-
* The simplex transform is defined using the Isometric Log Ratio
81-
* transform (ILR). This code is equilvalent to
80+
* The simplex transform is defined using the inverse of the
81+
* isometric log ratio (ILR) transform. This code is equivalent to
8282
* `softmax(sum_to_zero_constrain(y))`, but is more efficient and
8383
* stable if computed this way thanks to the use of the online
8484
* softmax algorithm courtesy of https://arxiv.org/abs/1805.02867.

stan/math/prim/constraint/simplex_free.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ namespace math {
1717
* the specified simplex. It applies to a simplex of dimensionality
1818
* K and produces an unconstrained vector of dimensionality (K-1).
1919
*
20-
* <p>The simplex transform is defined through a centered
21-
* stick-breaking process.
20+
* The simplex transform is defined using isometric log ratio (ILR)
21+
* transform
2222
*
2323
* @tparam ColVec type of the simplex (must be a column vector)
2424
* @param x Simplex of dimensionality K.

stan/math/rev/constraint/simplex_constrain.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ namespace math {
2121
* to 0 that sum to 1. A vector with (K-1) unconstrained values
2222
* will produce a simplex of size K.
2323
*
24-
* The simplex transform is defined using the Isometric Log Ratio
25-
* transform (ILR). This is equilvalent to
24+
* The simplex transform is defined using the inverse of the
25+
* isometric log ratio (ILR) transform. This is equivalent to
2626
* `softmax(sum_to_zero_constrain(y))`.
2727
*
2828
* @tparam T Type of vector to constrain
@@ -39,8 +39,8 @@ inline auto simplex_constrain(const T& y) {
3939
* and increment the specified log probability reference with
4040
* the log absolute Jacobian determinant of the transform.
4141
*
42-
* The simplex transform is defined using the Isometric Log Ratio
43-
* transform (ILR). This is equilvalent to
42+
* The simplex transform is defined using the inverse of the
43+
* isometric log ratio (ILR) transform. This is equivalent to
4444
* `softmax(sum_to_zero_constrain(y))`.
4545
*
4646
* @tparam T type of the vector to constrain

0 commit comments

Comments
 (0)