Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gtsam::KeyInfo Class Reference

#include <IterativeSolver.h>

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

Public Types

typedef std::map< Key, KeyInfoEntryBase
 

Public Member Functions

std::vector< size_tcolSpec () const
 Return a vector of dimensions ordered by ordering() More...
 
 KeyInfo ()
 Default Constructor. More...
 
 KeyInfo (const GaussianFactorGraph &fg)
 Construct from Gaussian factor graph, use "Natural" ordering. More...
 
 KeyInfo (const GaussianFactorGraph &fg, const Ordering &ordering)
 Construct from Gaussian factor graph and a given ordering. More...
 
size_t numCols () const
 Return the total number of columns (scalar variables = sum of dimensions) More...
 
const Orderingordering () const
 Return the ordering. More...
 
VectorValues x0 () const
 Return VectorValues with zeros, of correct dimension. More...
 
Vector x0vector () const
 Return zero Vector of correct dimension. More...
 

Protected Member Functions

void initialize (const GaussianFactorGraph &fg)
 

Protected Attributes

size_t numCols_
 
Ordering ordering_
 

Detailed Description

Handy data structure for iterative solvers

Definition at line 127 of file IterativeSolver.h.

Member Typedef Documentation

◆ Base

Definition at line 131 of file IterativeSolver.h.

Constructor & Destructor Documentation

◆ KeyInfo() [1/3]

gtsam::KeyInfo::KeyInfo ( )
inline

Default Constructor.

Definition at line 143 of file IterativeSolver.h.

◆ KeyInfo() [2/3]

gtsam::KeyInfo::KeyInfo ( const GaussianFactorGraph fg)

Construct from Gaussian factor graph, use "Natural" ordering.

Definition at line 111 of file IterativeSolver.cpp.

◆ KeyInfo() [3/3]

gtsam::KeyInfo::KeyInfo ( const GaussianFactorGraph fg,
const Ordering ordering 
)

Construct from Gaussian factor graph and a given ordering.

Definition at line 105 of file IterativeSolver.cpp.

Member Function Documentation

◆ colSpec()

vector< size_t > gtsam::KeyInfo::colSpec ( ) const

Return a vector of dimensions ordered by ordering()

Definition at line 135 of file IterativeSolver.cpp.

◆ initialize()

void gtsam::KeyInfo::initialize ( const GaussianFactorGraph fg)
protected

Definition at line 117 of file IterativeSolver.cpp.

◆ numCols()

size_t gtsam::KeyInfo::numCols ( ) const
inline

Return the total number of columns (scalar variables = sum of dimensions)

Definition at line 154 of file IterativeSolver.h.

◆ ordering()

const Ordering& gtsam::KeyInfo::ordering ( ) const
inline

Return the ordering.

Definition at line 159 of file IterativeSolver.h.

◆ x0()

VectorValues gtsam::KeyInfo::x0 ( ) const

Return VectorValues with zeros, of correct dimension.

Definition at line 144 of file IterativeSolver.cpp.

◆ x0vector()

Vector gtsam::KeyInfo::x0vector ( ) const

Return zero Vector of correct dimension.

Definition at line 153 of file IterativeSolver.cpp.

Member Data Documentation

◆ numCols_

size_t gtsam::KeyInfo::numCols_
protected

Definition at line 136 of file IterativeSolver.h.

◆ ordering_

Ordering gtsam::KeyInfo::ordering_
protected

Definition at line 135 of file IterativeSolver.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:51:38