Skip to content

Commit ea9ac8b

Browse files
update doc
1 parent 6b43b13 commit ea9ac8b

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

ocs2_core/include/ocs2_core/constraint/StateConstraintCollection.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class StateConstraintCollection : public Collection<StateConstraint> {
5555
/** Returns the number of active constraints at a given time for each term. If a term is inactive, its size is zero. */
5656
size_array_t getTermsSize(scalar_t time) const;
5757

58-
/** Get an array of all constraints */
58+
/** Get an array of all constraints. If a term is inactive, the corresponding element is a vector of size zero. */
5959
virtual vector_array_t getValue(scalar_t time, const vector_t& state, const PreComputation& preComp) const;
6060

6161
/** Get the constraint linear approximation */

ocs2_core/include/ocs2_core/constraint/StateInputConstraintCollection.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class StateInputConstraintCollection : public Collection<StateInputConstraint> {
5555
/** Returns the number of active constraints at a given time for each term. If a term is inactive, its size is zero. */
5656
size_array_t getTermsSize(scalar_t time) const;
5757

58-
/** Get an array of all constraints */
58+
/** Get an array of all constraints. If a term is inactive, the corresponding element is a vector of size zero. */
5959
virtual vector_array_t getValue(scalar_t time, const vector_t& state, const vector_t& input, const PreComputation& preComp) const;
6060

6161
/** Get the constraint linear approximation */

0 commit comments

Comments
 (0)