SubgraphSolver.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------

 * GTSAM Copyright 2010, Georgia Tech Research Corporation,
 * Atlanta, Georgia 30332-0415
 * All Rights Reserved
 * Authors: Frank Dellaert, et al. (see THANKS for the full author list)

 * See LICENSE for the license information

 * -------------------------------------------------------------------------- */

#pragma once

#include <gtsam/linear/ConjugateGradientSolver.h>
#include <gtsam/linear/SubgraphBuilder.h>

#include <map>
#include <utility>  // pair

namespace gtsam {

// Forward declarations
class GaussianFactorGraph;
class GaussianBayesNet;
class SubgraphPreconditioner;

struct GTSAM_EXPORT SubgraphSolverParameters
    : public ConjugateGradientParameters {
  SubgraphBuilderParameters builderParams;
  explicit SubgraphSolverParameters(const SubgraphBuilderParameters &p = SubgraphBuilderParameters())
    : builderParams(p) {}
  void print() const { Base::print(); }
  virtual void print(std::ostream &os) const {
    Base::print(os);
  }
};

class GTSAM_EXPORT SubgraphSolver : public IterativeSolver {
 public:
  typedef SubgraphSolverParameters Parameters;

 protected:
  Parameters parameters_;
  boost::shared_ptr<SubgraphPreconditioner> pc_;  

 public:

  SubgraphSolver(const GaussianFactorGraph &A, const Parameters &parameters,
                 const Ordering &ordering);

  SubgraphSolver(const GaussianFactorGraph &Ab1,
                 const boost::shared_ptr<GaussianFactorGraph> &Ab2,
                 const Parameters &parameters, const Ordering &ordering);
  SubgraphSolver(const boost::shared_ptr<GaussianBayesNet> &Rc1,
                 const boost::shared_ptr<GaussianFactorGraph> &Ab2,
                 const Parameters &parameters);

  virtual ~SubgraphSolver() {}


  VectorValues optimize() const;

  VectorValues optimize(const GaussianFactorGraph &gfg,
                        const KeyInfo &keyInfo,
                        const std::map<Key, Vector> &lambda,
                        const VectorValues &initial) override;


  std::pair < boost::shared_ptr<GaussianFactorGraph>,
      boost::shared_ptr<GaussianFactorGraph> > splitGraph(
          const GaussianFactorGraph &gfg);


#ifdef GTSAM_ALLOW_DEPRECATED_SINCE_V4
  SubgraphSolver(const boost::shared_ptr<GaussianFactorGraph> &A,
                 const Parameters &parameters, const Ordering &ordering)
      : SubgraphSolver(*A, parameters, ordering) {}
  SubgraphSolver(const GaussianFactorGraph &, const GaussianFactorGraph &,
                 const Parameters &, const Ordering &);
  SubgraphSolver(const boost::shared_ptr<GaussianFactorGraph> &Ab1,
                 const boost::shared_ptr<GaussianFactorGraph> &Ab2,
                 const Parameters &parameters, const Ordering &ordering)
      : SubgraphSolver(*Ab1, Ab2, parameters, ordering) {}
  SubgraphSolver(const boost::shared_ptr<GaussianBayesNet> &,
                 const GaussianFactorGraph &, const Parameters &);
#endif
};

}  // namespace gtsam