Public Member Functions | Private Member Functions | List of all members
gtsam::Scatter Class Reference

#include <Scatter.h>

Inheritance diagram for gtsam::Scatter:
Inheritance graph
[legend]

Public Member Functions

GTSAM_EXPORT void add (Key key, size_t dim)
 Add a key/dim pair. More...
 
GTSAM_EXPORT Scatter ()
 Default Constructor. More...
 
GTSAM_EXPORT Scatter (const GaussianFactorGraph &gfg)
 Construct from gaussian factor graph, without ordering. More...
 
GTSAM_EXPORT Scatter (const GaussianFactorGraph &gfg, const Ordering &ordering)
 Construct from gaussian factor graph, with (partial or complete) ordering. More...
 

Private Member Functions

iterator find (Key key)
 Find the SlotEntry with the right key (linear time worst case) More...
 

Detailed Description

Scatter is an intermediate data structure used when building a HessianFactor incrementally, to get the keys in the right order. In spirit, it is a map from global variable indices to slot indices in the union of involved variables. We also include the dimensionality of the variable.

Definition at line 49 of file Scatter.h.

Constructor & Destructor Documentation

◆ Scatter() [1/3]

GTSAM_EXPORT gtsam::Scatter::Scatter ( )
inline

Default Constructor.

Definition at line 52 of file Scatter.h.

◆ Scatter() [2/3]

gtsam::Scatter::Scatter ( const GaussianFactorGraph gfg)
explicit

Construct from gaussian factor graph, without ordering.

Definition at line 36 of file Scatter.cpp.

◆ Scatter() [3/3]

gtsam::Scatter::Scatter ( const GaussianFactorGraph gfg,
const Ordering ordering 
)
explicit

Construct from gaussian factor graph, with (partial or complete) ordering.

Definition at line 39 of file Scatter.cpp.

Member Function Documentation

◆ add()

void gtsam::Scatter::add ( Key  key,
size_t  dim 
)

Add a key/dim pair.

Definition at line 76 of file Scatter.cpp.

◆ find()

FastVector< SlotEntry >::iterator gtsam::Scatter::find ( Key  key)
private

Find the SlotEntry with the right key (linear time worst case)

Definition at line 81 of file Scatter.cpp.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:08