Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gtsam::DSFMap< KEY > Class Template Reference

#include <DSFMap.h>

Classes

struct  Entry
 We store the forest in an STL map, but parents are done with pointers. More...
 

Public Types

typedef std::set< KEY > Set
 

Public Member Functions

 DSFMap ()
 constructor More...
 
KEY find (const KEY &key) const
 Given key, find the representative key for the set in which it lives. More...
 
void merge (const KEY &x, const KEY &y)
 Merge two sets. More...
 
std::map< KEY, Setsets () const
 return all sets, i.e. a partition of all elements More...
 

Protected Types

typedef Map::iterator iterator
 
typedef std::map< KEY, EntryMap
 

Protected Member Functions

iterator find_ (const iterator &it) const
 Given iterator to initial entry, find the root Entry. More...
 
iterator find_ (const KEY &key) const
 Given key, find the root Entry. More...
 
iterator find__ (const KEY &key) const
 Given key, find iterator to initial entry. More...
 

Protected Attributes

Map entries_
 

Detailed Description

template<class KEY>
class gtsam::DSFMap< KEY >

Disjoint set forest using an STL map data structure underneath Uses rank compression and union by rank, iterator version

Definition at line 34 of file DSFMap.h.

Member Typedef Documentation

◆ iterator

template<class KEY >
typedef Map::iterator gtsam::DSFMap< KEY >::iterator
protected

Definition at line 44 of file DSFMap.h.

◆ Map

template<class KEY >
typedef std::map<KEY, Entry> gtsam::DSFMap< KEY >::Map
protected

Definition at line 43 of file DSFMap.h.

◆ Set

template<class KEY >
typedef std::set<KEY> gtsam::DSFMap< KEY >::Set

Definition at line 75 of file DSFMap.h.

Constructor & Destructor Documentation

◆ DSFMap()

template<class KEY >
gtsam::DSFMap< KEY >::DSFMap ( )
inline

constructor

Definition at line 78 of file DSFMap.h.

Member Function Documentation

◆ find()

template<class KEY >
KEY gtsam::DSFMap< KEY >::find ( const KEY &  key) const
inline

Given key, find the representative key for the set in which it lives.

Definition at line 81 of file DSFMap.h.

◆ find_() [1/2]

template<class KEY >
iterator gtsam::DSFMap< KEY >::find_ ( const iterator it) const
inlineprotected

Given iterator to initial entry, find the root Entry.

Definition at line 61 of file DSFMap.h.

◆ find_() [2/2]

template<class KEY >
iterator gtsam::DSFMap< KEY >::find_ ( const KEY &  key) const
inlineprotected

Given key, find the root Entry.

Definition at line 69 of file DSFMap.h.

◆ find__()

template<class KEY >
iterator gtsam::DSFMap< KEY >::find__ ( const KEY &  key) const
inlineprotected

Given key, find iterator to initial entry.

Definition at line 48 of file DSFMap.h.

◆ merge()

template<class KEY >
void gtsam::DSFMap< KEY >::merge ( const KEY &  x,
const KEY &  y 
)
inline

Merge two sets.

Definition at line 87 of file DSFMap.h.

◆ sets()

template<class KEY >
std::map<KEY, Set> gtsam::DSFMap< KEY >::sets ( ) const
inline

return all sets, i.e. a partition of all elements

Definition at line 105 of file DSFMap.h.

Member Data Documentation

◆ entries_

template<class KEY >
Map gtsam::DSFMap< KEY >::entries_
mutableprotected

Definition at line 45 of file DSFMap.h.


The documentation for this class was generated from the following file:


gtsam
Author(s):
autogenerated on Sat Nov 16 2024 04:15:22