Skip to content

Commit 008a131

Browse files
author
Jachym.Barvinek
committed
fix documentation
1 parent 5815b2e commit 008a131

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

stan/math/fwd/fun/log_softmax.hpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ namespace stan {
1212
namespace math {
1313

1414
/**
15-
* Return the log softmax of the specified vector or container of vectors.
15+
* Return the log softmax of the rows of the specified matrix.
16+
* Each row is transformed independently; the result has the same shape
17+
* as the input.
1618
*
17-
* @tparam T Type of input vector or matrix.
18-
* @param[in] x Unconstrained input vector.
19-
* @return Softmax of the input.
20-
* @throw std::domain_error If the input vector is size 0.
19+
* @tparam Mat type of input matrix (Eigen matrix with fvar scalar)
20+
* @param[in] m Matrix to transform row-wise.
21+
* @return Log-softmax applied row-wise.
22+
* @throw std::domain_error If the input matrix is size 0.
2123
*/
2224
template <typename Mat, require_eigen_t<Mat>* = nullptr,
2325
require_not_eigen_vector_t<Mat>* = nullptr,

0 commit comments

Comments
 (0)