LinearContainerFactor.h

Go to the documentation of this file.

#pragma once

#include <gtsam/nonlinear/NonlinearFactorGraph.h>

namespace gtsam {

  // Forward declarations
  class JacobianFactor;
  class HessianFactor;

class GTSAM_EXPORT LinearContainerFactor : public NonlinearFactor {
protected:

  GaussianFactor::shared_ptr factor_;
  boost::optional<Values> linearizationPoint_;

  LinearContainerFactor() {}

  LinearContainerFactor(const GaussianFactor::shared_ptr& factor, const boost::optional<Values>& linearizationPoint);

  // Some handy typedefs
  typedef NonlinearFactor Base;
  typedef LinearContainerFactor This;

public:

  typedef boost::shared_ptr<This> shared_ptr;

  LinearContainerFactor(const JacobianFactor& factor, const Values& linearizationPoint = Values());

  LinearContainerFactor(const HessianFactor& factor, const Values& linearizationPoint = Values());

  LinearContainerFactor(const GaussianFactor::shared_ptr& factor, const Values& linearizationPoint = Values());

  // Access

  const GaussianFactor::shared_ptr& factor() const { return factor_; }

  // Testable

  void print(const std::string& s = "", const KeyFormatter& keyFormatter = gtsam::DefaultKeyFormatter) const;

  bool equals(const NonlinearFactor& f, double tol = 1e-9) const;

  // NonlinearFactor

  double error(const Values& c) const;

  size_t dim() const;

  const boost::optional<Values>& linearizationPoint() const { return linearizationPoint_; }

  GaussianFactor::shared_ptr linearize(const Values& c) const;

  GaussianFactor::shared_ptr negateToGaussian() const;

  NonlinearFactor::shared_ptr negateToNonlinear() const;

  NonlinearFactor::shared_ptr clone() const {
    return NonlinearFactor::shared_ptr(new LinearContainerFactor(factor_,linearizationPoint_));
  }

  // casting syntactic sugar

  inline bool hasLinearizationPoint() const { return linearizationPoint_.is_initialized(); }

  bool isJacobian() const;
  bool isHessian() const;

  boost::shared_ptr<JacobianFactor> toJacobian() const;

  boost::shared_ptr<HessianFactor> toHessian() const;

  static NonlinearFactorGraph ConvertLinearGraph(const GaussianFactorGraph& linear_graph,
      const Values& linearizationPoint = Values());

#ifdef GTSAM_ALLOW_DEPRECATED_SINCE_V4
  static NonlinearFactorGraph convertLinearGraph(const GaussianFactorGraph& linear_graph,
      const Values& linearizationPoint = Values()) {
    return ConvertLinearGraph(linear_graph, linearizationPoint);
  }
#endif

protected:
  void initializeLinearizationPoint(const Values& linearizationPoint);

private:

  friend class boost::serialization::access;
  template<class ARCHIVE>
  void serialize(ARCHIVE & ar, const unsigned int /*version*/) {
    ar & boost::serialization::make_nvp("NonlinearFactor",
        boost::serialization::base_object<Base>(*this));
    ar & BOOST_SERIALIZATION_NVP(factor_);
    ar & BOOST_SERIALIZATION_NVP(linearizationPoint_);
  }

}; // \class LinearContainerFactor

template<> struct traits<LinearContainerFactor> : public Testable<LinearContainerFactor> {};

} // \namespace gtsam