Skip to content

Commit d5dcdbd

Browse files
lvjonokjcarpent
authored andcommitted
docs: add proper description
1 parent fecf8f8 commit d5dcdbd

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

include/pinocchio/algorithm/regressor.hpp

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,29 @@ namespace pinocchio
380380
DataTpl<Scalar, Options, JointCollectionTpl> & data,
381381
const Eigen::MatrixBase<ConfigVectorType> & q);
382382

383-
// TODO: Add documentation
383+
///
384+
/// \brief Computes the momentum regressor and component of time derivative
385+
/// of momentum regressor of the system based on the current robot state.
386+
///
387+
/// The result stored in `data.momentumRegressor` corresponds to a matrix \f$ Y_p \f$ such that
388+
/// \f$ P = Y_p(q, v) \pi = M v \f$ where \f$ \pi \f$ represents the vector of dynamic parameters
389+
/// of each link.
390+
///
391+
/// The result stored in `data.dpartial_lagrangian_q` corresponds to a matrix
392+
/// \f$ Y_h \f$ such that \f$ \frac{\partial L}{\partial q} = Y_h(q, v) \f$.
393+
///
394+
/// \tparam JointCollection Collection of Joint types.
395+
/// \tparam ConfigVectorType Type of the joint configuration vector.
396+
///
397+
/// \param[in] model The model structure representing the rigid body system.
398+
/// \param[in] data The data structure of the rigid body system.
399+
/// \param[in] q The joint configuration vector (dim model.nq).
400+
/// \param[in] v The joint velocity vector (dim model.nv).
401+
///
402+
/// \return A pair containing:
403+
/// - The momentum regressor matrix.
404+
/// - A matrix containing a component of the time derivative of the momentum regressor.
405+
///
384406
template<
385407
typename Scalar,
386408
int Options,

0 commit comments

Comments
 (0)