Skip to content

Commit edd826e

Browse files
committed
Comment fixes
1 parent 25460e9 commit edd826e

3 files changed

Lines changed: 13 additions & 9 deletions

File tree

stan/math/prim/constraint/sum_to_zero_constrain.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ inline plain_type_t<Vec> sum_to_zero_constrain(const Vec& y,
8383
* Return a vector with sum zero corresponding to the specified
8484
* free vector.
8585
*
86-
* The sum-to-zero transform is defined using a modified version of the
86+
* The sum-to-zero transform is defined using a modified version of
8787
* the inverse of the isometric log ratio transform (ILR).
8888
* See:
8989
* Egozcue, Juan Jose; Pawlowsky-Glahn, Vera; Mateu-Figueras, Gloria;
@@ -111,15 +111,15 @@ inline plain_type_t<Vec> sum_to_zero_constrain(const Vec& y,
111111
* Return a vector with sum zero corresponding to the specified
112112
* free vector.
113113
*
114-
* The sum-to-zero transform is defined using a modified version of the
114+
* The sum-to-zero transform is defined using a modified version of
115115
* the inverse of the isometric log ratio transform (ILR).
116116
* See:
117117
* Egozcue, Juan Jose; Pawlowsky-Glahn, Vera; Mateu-Figueras, Gloria;
118118
* Barcelo-Vidal, Carles (2003), "Isometric logratio transformations for
119119
* compositional data analysis", Mathematical Geology, 35 (3): 279–300,
120120
* doi:10.1023/A:1023818214614, S2CID 122844634
121121
*
122-
* This is a linear transform, with no Jacobian.
122+
* This is a linear transform, with no Jacobian.
123123
*
124124
* @tparam Jacobian unused
125125
* @tparam Vec A standard vector with inner type inheriting from

stan/math/prim/constraint/sum_to_zero_free.hpp

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ namespace math {
1414
/**
1515
* Return an unconstrained vector.
1616
*
17-
* The sum-to-zero transform is defined such that the first K-1
18-
* elements are unconstrained and the last element is the negative
19-
* sum of those elements.
17+
* The sum-to-zero transform is defined using a modified version of the
18+
* isometric log ratio transform (ILR).
19+
* See:
20+
* Egozcue, Juan Jose; Pawlowsky-Glahn, Vera; Mateu-Figueras, Gloria;
21+
* Barcelo-Vidal, Carles (2003), "Isometric logratio transformations for
22+
* compositional data analysis", Mathematical Geology, 35 (3): 279–300,
23+
* doi:10.1023/A:1023818214614, S2CID 122844634
2024
*
2125
* @tparam ColVec a column vector type
2226
* @param z Vector of length K.

stan/math/rev/constraint/sum_to_zero_constrain.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ namespace math {
2020
* Return a vector with sum zero corresponding to the specified
2121
* free vector.
2222
*
23-
* The sum-to-zero transform is defined using a modified version of the
23+
* The sum-to-zero transform is defined using a modified version of
2424
* the inverse of the isometric log ratio transform (ILR).
2525
* See:
2626
* Egozcue, Juan Jose; Pawlowsky-Glahn, Vera; Mateu-Figueras, Gloria;
@@ -69,15 +69,15 @@ inline auto sum_to_zero_constrain(const T& y) {
6969
* Return a vector with sum zero corresponding to the specified
7070
* free vector.
7171
*
72-
* The sum-to-zero transform is defined using a modified version of the
72+
* The sum-to-zero transform is defined using a modified version of
7373
* the inverse of the isometric log ratio transform (ILR).
7474
* See:
7575
* Egozcue, Juan Jose; Pawlowsky-Glahn, Vera; Mateu-Figueras, Gloria;
7676
* Barcelo-Vidal, Carles (2003), "Isometric logratio transformations for
7777
* compositional data analysis", Mathematical Geology, 35 (3): 279–300,
7878
* doi:10.1023/A:1023818214614, S2CID 122844634
7979
*
80-
* This is a linear transform, with no Jacobian.
80+
* This is a linear transform, with no Jacobian.
8181
*
8282
* @tparam Vec type of the vector
8383
* @param y Free vector input of dimensionality K - 1.

0 commit comments

Comments
 (0)