gtsam  3.2.1
gtsam
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Key.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2 
3  * GTSAM Copyright 2010, Georgia Tech Research Corporation,
4  * Atlanta, Georgia 30332-0415
5  * All Rights Reserved
6  * Authors: Frank Dellaert, et al. (see THANKS for the full author list)
7 
8  * See LICENSE for the license information
9 
10  * -------------------------------------------------------------------------- */
11 
18 #pragma once
19 
20 #include <boost/function.hpp>
21 #include <string>
22 
23 #include <gtsam/global_includes.h>
24 #include <gtsam/base/FastVector.h>
25 #include <gtsam/base/FastList.h>
26 #include <gtsam/base/FastSet.h>
27 #include <gtsam/base/FastMap.h>
28 
29 namespace gtsam {
30 
31 
32  // Helper function for Multi-robot Key Formatter
33  GTSAM_EXPORT std::string _multirobotKeyFormatter(gtsam::Key key);
34 
41  static const gtsam::KeyFormatter MultiRobotKeyFormatter = &_multirobotKeyFormatter;
42 
45  typedef FastVector<Key> KeyVector;
46  typedef FastSet<Key> KeySet;
48 
50  GTSAM_EXPORT void printKeyList(const KeyList& keys, const std::string& s = "",
51  const KeyFormatter& keyFormatter = DefaultKeyFormatter);
52 
54  GTSAM_EXPORT void printKeyVector(const KeyVector& keys, const std::string& s = "",
55  const KeyFormatter& keyFormatter = DefaultKeyFormatter);
56 
58  GTSAM_EXPORT void printKeySet(const KeySet& keys, const std::string& s = "",
59  const KeyFormatter& keyFormatter = DefaultKeyFormatter);
60 }
61 
void printKeyVector(const KeyVector &keys, const std::string &s, const KeyFormatter &keyFormatter)
Utility function to print sets of keys with optional prefix.
Definition: Key.cpp:63
Definition: FastMap.h:37
A thin wrapper around std::set that uses boost's fast_pool_allocator.
A thin wrapper around std::list that uses boost's fast_pool_allocator.
Included from all GTSAM files.
void printKeyList(const KeyList &keys, const std::string &s, const KeyFormatter &keyFormatter)
Utility function to print sets of keys with optional prefix.
Definition: Key.cpp:58
void printKeySet(const KeySet &keys, const std::string &s, const KeyFormatter &keyFormatter)
Utility function to print sets of keys with optional prefix.
Definition: Key.cpp:68
A thin wrapper around std::map that uses boost's fast_pool_allocator.
size_t Key
Integer nonlinear key type.
Definition: types.h:59
FastList< Key > KeyList
Useful typedefs for operations with Values - allow for matlab interfaces.
Definition: Key.h:44
Definition: FastList.h:38
A thin wrapper around std::vector that uses boost's pool_allocator.
boost::function< std::string(Key)> KeyFormatter
Typedef for a function to format a key, i.e. to convert it to a string.
Definition: types.h:62