Add documentation for reverse() #148
Conversation
| @@ -409,3 +410,21 @@ Number of components of v less than v[s] | |||
| `int` **`rank`**`(int[] v, int s)`<br>\newline | |||
| Number of components of v less than v[s] | |||
|
|
|||
| ## Reversing Functions {#reversing-functions} | |||
|
|
|||
| Reversing allows to create a copy of array in which elements are in reverse | |||
There was a problem hiding this comment.
This isn't quite grammatical and it's not a copy. Also, we want to make the doc more active. So this should be:
Stan provides functions to create a new array by reversing the order of elements in an existing array. For example, ...
There was a problem hiding this comment.
Thanks for the much improved wording!
| \index{{\tt \bfseries reverse }!{\tt (int[] v): int[]}|hyperpage} | ||
|
|
||
| `int[]` **`reverse`**`(int[] v)`<br>\newline | ||
| Create a copy of the array with the elements in reverse order. |
There was a problem hiding this comment.
Does this only work for integer and real arrays? It should work for any array if possible, or if not, at least all arrays up to a given number of dimensions. If this PR doesn't create a generic reverse function, please create a new issue with that goal. Then the doc can just use T[] reverse (T[] x).
There was a problem hiding this comment.
The implementation does not restrict what can be reversed, so I'll change that to use T[].
| \index{{\tt \bfseries reverse }!{\tt (vector v): vector}|hyperpage} | ||
|
|
||
| `vector` **`reverse`**`(vector v)`<br>\newline | ||
| Create a copy of the vector with the elements in reverse order. |
There was a problem hiding this comment.
This isn't a copy any more than sorting is a copy. It returns a new vector containing the elements of the argument vector in reverse order.
| \index{{\tt \bfseries reverse }!{\tt (real[] v): real[]}|hyperpage} | ||
|
|
||
| `real[]` **`reverse`**`(real[] v)`<br>\newline | ||
| Create a copy of the array with the elements in reverse order. |
There was a problem hiding this comment.
A copy would have the elements in the same order. This function returns a new array with the argument array's elements in reverse order.
| @@ -334,7 +335,7 @@ Any mismatches will cause an error to be thrown. | |||
| x3 = append_array(x1, x2); | |||
| ``` | |||
|
|
|||
| ## Sorting functions {#sorting-functions} | |||
| ## Sorting Functions {#sorting-functions} | |||
There was a problem hiding this comment.
This should be Sorting functions not Sorting Functions.
# XXXuses title punctuation forXXX(all caps other than "function" words [prepositions, determiners, auxliary verbs, other particles, etc.])## XXXshould use sentence punctuation forXXX(initial caps, not all caps)
| @@ -409,3 +410,16 @@ Number of components of v less than v[s] | |||
| `int` **`rank`**`(int[] v, int s)`<br>\newline | |||
| Number of components of v less than v[s] | |||
|
|
|||
| ## Reversing Functions {#reversing-functions} | |||
Submission Checklist
Summary
This adds docs for
reverse, which was added in stan-dev/math#1650. I'm not entirely convinced of the section titles I used, I followed what was around and couldn't think of something better.Copyright and Licensing
Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company):
Marco Colombo
By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses: