12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved documentation

release/4.3a0
Richard Roberts 2011-10-03 17:39:18 +00:00
parent a9117a6c1f
commit 8fe0f6a501
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gtsam/nonlinear/Ordering.h
View File

@ -146,16 +146,22 @@ public:
/// Adds a new key to the ordering with an index of one greater than the current highest index. /// Adds a new key to the ordering with an index of one greater than the current highest index.
Index push_back(const Symbol& key) { return insert(std::make_pair(key, nVars_))->second; } Index push_back(const Symbol& key) { return insert(std::make_pair(key, nVars_))->second; }
/** Remove the last symbol/index pair from the ordering - this is inefficient. /** Remove the last (last-ordered, not highest-sorting key) symbol/index pair
* If you already know the last-ordered symbol, call the version of pop_back * from the ordering (this version is \f$ O(n) \f$, use it when you do not
* know the last-ordered key).
*
* If you already know the last-ordered symbol, call popback(const Symbol&)
* that accepts this symbol as an argument. * that accepts this symbol as an argument.
* *
* @return The symbol and index that were removed. * @return The symbol and index that were removed.
*/ */
value_type pop_back(); value_type pop_back();
/** Remove the last-ordered symbol from the ordering. This is efficient, as /** Remove the last-ordered symbol from the ordering (this version is
* opposed to the no-argument version of pop_back. * \f$ O(1) \f$, use it if you already know the last-ordered key).
*
* Throws std::invalid_argument if the requested key is not actually the
* last-ordered.
* *
* @return The index of the symbol that was removed. * @return The index of the symbol that was removed.
*/ */