Commit 5c7757d1 authored by Joseph Mirabel's avatar Joseph Mirabel Committed by Joseph Mirabel
Browse files

Add some documentation

parent cd790bd8
......@@ -77,8 +77,18 @@ namespace hpp {
SplineGradientBased (const Problem& problem);
// Constraint creation
/// \name Constraint creation
/// \{
/// Compute a conservative linear representation of the constraints.
/// It determines:
/// \li which DoFs can be computed explicitely. These DoFs are removed
/// from the variables and computed explicitely.
/// \li which DoFs are constrained implicitely. These DoFs are removed
/// from the variables and are set constant.
/// \li which DoFs are not constrained. These DoFs are kept as
/// variables for optimization.
virtual void addProblemConstraints (const PathVectorPtr_t& init, const Splines_t& splines, LinearConstraint& lc, SplineOptimizationDatas_t& sods) const;
void addProblemConstraintOnPath (const PathPtr_t& path, const size_type& idxSpline, const SplinePtr_t& spline, LinearConstraint& lc, SplineOptimizationData& sod) const;
......@@ -91,6 +101,8 @@ namespace hpp {
const value_type& guessThr = -1,
const bool& useExplicitInput = false) const;
/// \}
bool checkOptimum_;
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment