gtsam  4.0.0
gtsam
gtsam::LinearEquality Class Reference

Detailed Description

This class defines a linear equality constraints, inheriting JacobianFactor with the special Constrained noise model.

+ Inheritance diagram for gtsam::LinearEquality:

Public Member Functions

 LinearEquality ()
 default constructor for I/O
 
 LinearEquality (const JacobianFactor &jf, Key dualKey)
 Construct from a constrained noisemodel JacobianFactor with a dual key.
 
 LinearEquality (const HessianFactor &hf)
 Conversion from HessianFactor (does Cholesky to obtain Jacobian matrix)
 
 LinearEquality (Key i1, const Matrix &A1, const Vector &b, Key dualKey)
 Construct unary factor.
 
 LinearEquality (Key i1, const Matrix &A1, Key i2, const Matrix &A2, const Vector &b, Key dualKey)
 Construct binary factor.
 
 LinearEquality (Key i1, const Matrix &A1, Key i2, const Matrix &A2, Key i3, const Matrix &A3, const Vector &b, Key dualKey)
 Construct ternary factor.
 
template<typename TERMS >
 LinearEquality (const TERMS &terms, const Vector &b, Key dualKey)
 Construct an n-ary factor. More...
 
virtual ~LinearEquality ()
 Virtual destructor.
 
virtual bool equals (const GaussianFactor &lf, double tol=1e-9) const
 equals
 
virtual void print (const std::string &s="", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print
 
virtual GaussianFactor::shared_ptr clone () const
 Clone this LinearEquality.
 
Key dualKey () const
 dual key
 
bool active () const
 for active set method: equality constraints are always active
 
Vector error_vector (const VectorValues &c) const
 Special error_vector for constraints (A*x-b)
 
virtual double error (const VectorValues &c) const
 Special error for constraints. More...
 
- Public Member Functions inherited from gtsam::JacobianFactor
 JacobianFactor (const GaussianFactor &gf)
 Convert from other GaussianFactor.
 
 JacobianFactor (const JacobianFactor &jf)
 Copy constructor.
 
 JacobianFactor (const HessianFactor &hf)
 Conversion from HessianFactor (does Cholesky to obtain Jacobian matrix)
 
 JacobianFactor ()
 default constructor for I/O
 
 JacobianFactor (const Vector &b_in)
 Construct Null factor.
 
 JacobianFactor (Key i1, const Matrix &A1, const Vector &b, const SharedDiagonal &model=SharedDiagonal())
 Construct unary factor.
 
 JacobianFactor (Key i1, const Matrix &A1, Key i2, const Matrix &A2, const Vector &b, const SharedDiagonal &model=SharedDiagonal())
 Construct binary factor.
 
 JacobianFactor (Key i1, const Matrix &A1, Key i2, const Matrix &A2, Key i3, const Matrix &A3, const Vector &b, const SharedDiagonal &model=SharedDiagonal())
 Construct ternary factor.
 
template<typename TERMS >
 JacobianFactor (const TERMS &terms, const Vector &b, const SharedDiagonal &model=SharedDiagonal())
 Construct an n-ary factor. More...
 
template<typename KEYS >
 JacobianFactor (const KEYS &keys, const VerticalBlockMatrix &augmentedMatrix, const SharedDiagonal &sigmas=SharedDiagonal())
 Constructor with arbitrary number keys, and where the augmented matrix is given all together instead of in block terms. More...
 
 JacobianFactor (const GaussianFactorGraph &graph, boost::optional< const Ordering & > ordering=boost::none, boost::optional< const VariableSlots & > p_variableSlots=boost::none)
 Build a dense joint factor from all the factors in a factor graph. More...
 
virtual ~JacobianFactor ()
 Virtual destructor.
 
Vector unweighted_error (const VectorValues &c) const
 
Vector error_vector (const VectorValues &c) const
 (A*x-b)
 
virtual Matrix augmentedInformation () const
 0.5*(A*x-b)'D(A*x-b) More...
 
virtual Matrix information () const
 Return the non-augmented information matrix represented by this GaussianFactor.
 
virtual VectorValues hessianDiagonal () const
 Return the diagonal of the Hessian for this factor.
 
virtual void hessianDiagonal (double *d) const
 Raw memory access version of hessianDiagonal.
 
virtual std::map< Key, Matrix > hessianBlockDiagonal () const
 Return the block diagonal of the Hessian for this factor.
 
virtual std::pair< Matrix, Vector > jacobian () const
 Returns (dense) A,b pair associated with factor, bakes in the weights.
 
std::pair< Matrix, Vector > jacobianUnweighted () const
 Returns (dense) A,b pair associated with factor, does not bake in weights.
 
virtual Matrix augmentedJacobian () const
 Return (dense) matrix associated with factor. More...
 
Matrix augmentedJacobianUnweighted () const
 Return (dense) matrix associated with factor. More...
 
const VerticalBlockMatrixmatrixObject () const
 Return the full augmented Jacobian matrix of this factor as a VerticalBlockMatrix object. More...
 
VerticalBlockMatrixmatrixObject ()
 Mutable access to the full augmented Jacobian matrix of this factor as a VerticalBlockMatrix object. More...
 
virtual GaussianFactor::shared_ptr negate () const
 Construct the corresponding anti-factor to negate information stored stored in this factor. More...
 
virtual bool empty () const
 Check if the factor is empty. More...
 
bool isConstrained () const
 is noise model constrained ?
 
virtual DenseIndex getDim (const_iterator variable) const
 Return the dimension of the variable pointed to by the given key iterator todo: Remove this in favor of keeping track of dimensions with variables?
 
size_t rows () const
 return the number of rows in the corresponding linear system
 
size_t cols () const
 return the number of columns in the corresponding linear system
 
const SharedDiagonal & get_model () const
 get a copy of model
 
SharedDiagonal & get_model ()
 get a copy of model (non-const version)
 
const constBVector getb () const
 Get a view of the r.h.s. More...
 
constABlock getA (const_iterator variable) const
 Get a view of the A matrix for the variable pointed to by the given key iterator.
 
constABlock getA () const
 Get a view of the A matrix, not weighted by noise.
 
BVector getb ()
 Get a view of the r.h.s. More...
 
ABlock getA (iterator variable)
 Get a view of the A matrix for the variable pointed to by the given key iterator (non-const version)
 
ABlock getA ()
 Get a view of the A matrix.
 
void updateHessian (const KeyVector &keys, SymmetricBlockMatrix *info) const
 Update an information matrix by adding the information corresponding to this factor (used internally during elimination). More...
 
Vector operator * (const VectorValues &x) const
 Return A*x.
 
void transposeMultiplyAdd (double alpha, const Vector &e, VectorValues &x) const
 x += A'*e. More...
 
void multiplyHessianAdd (double alpha, const VectorValues &x, VectorValues &y) const
 y += alpha * A'*A*x
 
void multiplyHessianAdd (double alpha, const double *x, double *y, const std::vector< size_t > &accumulatedDims) const
 Raw memory access version of multiplyHessianAdd y += alpha * A'*A*x Requires the vector accumulatedDims to tell the dimension of each variable: e.g. More...
 
VectorValues gradientAtZero () const
 A'*b for Jacobian.
 
virtual void gradientAtZero (double *d) const
 A'*b for Jacobian (raw memory version)
 
Vector gradient (Key key, const VectorValues &x) const
 Compute the gradient wrt a key at any values.
 
JacobianFactor whiten () const
 Return a whitened version of the factor, i.e. More...
 
std::pair< boost::shared_ptr< GaussianConditional >, shared_ptreliminate (const Ordering &keys)
 Eliminate the requested variables. More...
 
void setModel (bool anyConstrained, const Vector &sigmas)
 set noiseModel correctly
 
boost::shared_ptr< GaussianConditionalsplitConditional (size_t nrFrontals)
 splits a pre-factorized factor into a conditional, and changes the current factor to be the remaining component. More...
 
- Public Member Functions inherited from gtsam::GaussianFactor
 GaussianFactor ()
 Default constructor creates empty factor.
 
template<typename CONTAINER >
 GaussianFactor (const CONTAINER &keys)
 Construct from container of keys. More...
 
virtual ~GaussianFactor ()
 Destructor.
 
- Public Member Functions inherited from gtsam::Factor
Key front () const
 First key.
 
Key back () const
 Last key.
 
const_iterator find (Key key) const
 find
 
const KeyVectorkeys () const
 Access the factor's involved variable keys.
 
const_iterator begin () const
 Iterator at beginning of involved variable keys.
 
const_iterator end () const
 Iterator at end of involved variable keys.
 
size_t size () const
 
void print (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print
 
void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys
 
KeyVectorkeys ()
 
iterator begin ()
 Iterator at beginning of involved variable keys.
 
iterator end ()
 Iterator at end of involved variable keys.
 

Public Types

typedef LinearEquality This
 Typedef to this class.
 
typedef JacobianFactor Base
 Typedef to base class.
 
typedef boost::shared_ptr< Thisshared_ptr
 shared_ptr to this class
 
- Public Types inherited from gtsam::JacobianFactor
typedef JacobianFactor This
 Typedef to this class.
 
typedef GaussianFactor Base
 Typedef to base class.
 
typedef boost::shared_ptr< Thisshared_ptr
 shared_ptr to this class
 
typedef VerticalBlockMatrix::Block ABlock
 
typedef VerticalBlockMatrix::constBlock constABlock
 
typedef ABlock::ColXpr BVector
 
typedef constABlock::ConstColXpr constBVector
 
- Public Types inherited from gtsam::GaussianFactor
typedef GaussianFactor This
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 shared_ptr to this class
 
typedef Factor Base
 Our base class.
 
- Public Types inherited from gtsam::Factor
typedef KeyVector::iterator iterator
 Iterator over keys.
 
typedef KeyVector::const_iterator const_iterator
 Const iterator over keys.
 

Additional Inherited Members

- Static Public Member Functions inherited from gtsam::GaussianFactor
template<typename CONTAINER >
static DenseIndex Slot (const CONTAINER &keys, Key key)
 
- Protected Member Functions inherited from gtsam::JacobianFactor
template<typename TERMS >
void fillTerms (const TERMS &terms, const Vector &b, const SharedDiagonal &noiseModel)
 Internal function to fill blocks and set dimensions.
 
- Protected Member Functions inherited from gtsam::Factor
 Factor ()
 Default constructor for I/O.
 
template<typename CONTAINER >
 Factor (const CONTAINER &keys)
 Construct factor from container of keys. More...
 
template<typename ITERATOR >
 Factor (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys. More...
 
bool equals (const This &other, double tol=1e-9) const
 check equality
 
- Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor FromKeys (const CONTAINER &keys)
 Construct factor from container of keys. More...
 
template<typename ITERATOR >
static Factor FromIterators (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys. More...
 
- Protected Attributes inherited from gtsam::JacobianFactor
VerticalBlockMatrix Ab_
 
noiseModel::Diagonal::shared_ptr model_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor.
 

Constructor & Destructor Documentation

◆ LinearEquality()

template<typename TERMS >
gtsam::LinearEquality::LinearEquality ( const TERMS &  terms,
const Vector &  b,
Key  dualKey 
)
inline

Construct an n-ary factor.

Template Parameters
TERMSA container whose value type is std::pair<Key, Matrix>, specifying the collection of keys and matrices making up the factor.

Member Function Documentation

◆ error()

virtual double gtsam::LinearEquality::error ( const VectorValues c) const
inlinevirtual

Special error for constraints.

I think it should be zero, as this function is meant for objective cost. But the name "error" can be misleading. TODO: confirm with Frank!!

Reimplemented from gtsam::JacobianFactor.


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