Public Types | Public Member Functions | Public Attributes | List of all members
gtsam::CGState< S, V, E > Struct Template Reference

#include <iterative-inl.h>

Public Types

typedef ConjugateGradientParameters Parameters
 

Public Member Functions

 CGState (const S &Ab, const V &x, const Parameters &parameters, bool steep)
 
void print (const V &x)
 
bool step (const S &Ab, V &x)
 
double takeOptimalStep (V &x)
 

Public Attributes

E Ad
 
V d
 gradient g and search direction d for CG More...
 
V g
 
double gamma
 
int k
 iteration More...
 
const Parametersparameters_
 
bool steepest
 flag to indicate we are doing steepest descent More...
 
double threshold
 gamma (squared L2 norm of g) and convergence threshold More...
 

Detailed Description

template<class S, class V, class E>
struct gtsam::CGState< S, V, E >

Definition at line 29 of file iterative-inl.h.

Member Typedef Documentation

◆ Parameters

template<class S, class V, class E>
typedef ConjugateGradientParameters gtsam::CGState< S, V, E >::Parameters

Definition at line 31 of file iterative-inl.h.

Constructor & Destructor Documentation

◆ CGState()

template<class S, class V, class E>
gtsam::CGState< S, V, E >::CGState ( const S Ab,
const V x,
const Parameters parameters,
bool  steep 
)
inline

Definition at line 42 of file iterative-inl.h.

Member Function Documentation

◆ print()

template<class S, class V, class E>
void gtsam::CGState< S, V, E >::print ( const V x)
inline

Definition at line 60 of file iterative-inl.h.

◆ step()

template<class S, class V, class E>
bool gtsam::CGState< S, V, E >::step ( const S Ab,
V x 
)
inline

Definition at line 80 of file iterative-inl.h.

◆ takeOptimalStep()

template<class S, class V, class E>
double gtsam::CGState< S, V, E >::takeOptimalStep ( V x)
inline

Definition at line 71 of file iterative-inl.h.

Member Data Documentation

◆ Ad

template<class S, class V, class E>
E gtsam::CGState< S, V, E >::Ad

Definition at line 38 of file iterative-inl.h.

◆ d

template<class S, class V, class E>
V gtsam::CGState< S, V, E >::d

gradient g and search direction d for CG

Definition at line 36 of file iterative-inl.h.

◆ g

template<class S, class V, class E>
V gtsam::CGState< S, V, E >::g

Definition at line 36 of file iterative-inl.h.

◆ gamma

template<class S, class V, class E>
double gtsam::CGState< S, V, E >::gamma

Definition at line 37 of file iterative-inl.h.

◆ k

template<class S, class V, class E>
int gtsam::CGState< S, V, E >::k

iteration

Definition at line 34 of file iterative-inl.h.

◆ parameters_

template<class S, class V, class E>
const Parameters& gtsam::CGState< S, V, E >::parameters_

Definition at line 32 of file iterative-inl.h.

◆ steepest

template<class S, class V, class E>
bool gtsam::CGState< S, V, E >::steepest

flag to indicate we are doing steepest descent

Definition at line 35 of file iterative-inl.h.

◆ threshold

template<class S, class V, class E>
double gtsam::CGState< S, V, E >::threshold

gamma (squared L2 norm of g) and convergence threshold

Definition at line 37 of file iterative-inl.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:46:15