Skip to content

Commit 57ae03f

Browse files
committed
Updated docs on return and promote meta functions (Issue #2245)
1 parent d1f80e1 commit 57ae03f

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

stan/math/rev/meta/promote_var_matrix.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace stan {
99
/**
1010
* Given an Eigen type and several inputs, determine if a matrix should be
1111
* `var<Matrix>` or `Matrix<var>`.
12+
*
13+
* `Matrix` will not necessarily be a plain type
14+
*
1215
* @tparam ReturnType An Eigen matrix used for composing the `var<Matrix>` or
1316
* `Matrix<var>` type.
1417
* @tparam Types Parameter pack holding any mix of types. If any of `Types`

stan/math/rev/meta/return_var_matrix.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace stan {
99
/**
1010
* Given an Eigen type and several inputs, determine if a matrix should be
1111
* `var<Matrix>` or `Matrix<var>`.
12+
*
13+
* `Matrix` will be a plain type
14+
*
1215
* @tparam ReturnType An Eigen matrix used for composing the `var<Matrix>` or
1316
* `Matrix<var>` type.
1417
* @tparam Types Parameter pack holding any mix of types. If any of `Types`

0 commit comments

Comments
 (0)