NonlinearInequalityConstraint.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/constrained/InequalityPenaltyFunction.h>
#include <gtsam/constrained/NonlinearEqualityConstraint.h>
#include <gtsam/nonlinear/expressions.h>
 
namespace gtsam {
 
class GTSAM_EXPORT NonlinearInequalityConstraint : public NonlinearConstraint {
 public:
  typedef NonlinearConstraint Base;
  typedef NonlinearInequalityConstraint This;
  typedef std::shared_ptr<This> shared_ptr;
 
  using Base::Base;
 
  virtual ~NonlinearInequalityConstraint() {}
 
  virtual Vector unwhitenedExpr(const Values& x, OptionalMatrixVecType H = nullptr) const = 0;
 
  virtual Vector whitenedExpr(const Values& x) const;
 
  virtual Vector unwhitenedError(const Values& x, OptionalMatrixVecType H = nullptr) const override;
 
  virtual bool active(const Values& x) const override;
 
  virtual NonlinearEqualityConstraint::shared_ptr createEqualityConstraint() const;
 
  virtual NoiseModelFactor::shared_ptr penaltyFactorCustom(
      InequalityPenaltyFunction::shared_ptr func, const double mu = 1.0) const;
 
  virtual NoiseModelFactor::shared_ptr penaltyFactorEquality(const double mu = 1.0) const;
 
 private:
#if GTSAM_ENABLE_BOOST_SERIALIZATION
 
  friend class boost::serialization::access;
  template <class ARCHIVE>
  void serialize(ARCHIVE& ar, const unsigned int /*version*/) {
    ar& boost::serialization::make_nvp("NonlinearInequalityConstraint",
                                       boost::serialization::base_object<Base>(*this));
  }
#endif
};
 
class GTSAM_EXPORT ScalarExpressionInequalityConstraint : public NonlinearInequalityConstraint {
 public:
  typedef NonlinearInequalityConstraint Base;
  typedef ScalarExpressionInequalityConstraint This;
  typedef std::shared_ptr<This> shared_ptr;
 
 protected:
  Double_ expression_;
  FastVector<int> dims_;
 
 public:
  ScalarExpressionInequalityConstraint(const Double_& expression, const double& sigma);
 
  static ScalarExpressionInequalityConstraint::shared_ptr GeqZero(const Double_& expression,
                                                                  const double& sigma);
 
  static ScalarExpressionInequalityConstraint::shared_ptr LeqZero(const Double_& expression,
                                                                  const double& sigma);
 
  virtual Vector unwhitenedExpr(const Values& x, OptionalMatrixVecType H = nullptr) const override;
 
  NonlinearEqualityConstraint::shared_ptr createEqualityConstraint() const override;
 
  NoiseModelFactor::shared_ptr penaltyFactor(const double mu = 1.0) const override;
 
  NoiseModelFactor::shared_ptr penaltyFactorCustom(InequalityPenaltyFunction::shared_ptr func,
                                                   const double mu = 1.0) const override;
 
  virtual NoiseModelFactor::shared_ptr penaltyFactorEquality(const double mu = 1.0) const override;
 
  const Double_& expression() const { return expression_; }
 
  gtsam::NonlinearFactor::shared_ptr clone() const override {
    return std::static_pointer_cast<gtsam::NonlinearFactor>(
        gtsam::NonlinearFactor::shared_ptr(new This(*this)));
  }
 
 private:
#if GTSAM_ENABLE_BOOST_SERIALIZATION
 
  friend class boost::serialization::access;
  template <class ARCHIVE>
  void serialize(ARCHIVE& ar, const unsigned int /*version*/) {
    ar& boost::serialization::make_nvp("ExpressionEqualityConstraint",
                                       boost::serialization::base_object<Base>(*this));
    ar& BOOST_SERIALIZATION_NVP(expression_);
    ar& BOOST_SERIALIZATION_NVP(dims_);
  }
#endif
};
 
class GTSAM_EXPORT NonlinearInequalityConstraints
    : public FactorGraph<NonlinearInequalityConstraint> {
 public:
  typedef FactorGraph<NonlinearInequalityConstraint> Base;
  typedef NonlinearInequalityConstraints This;
  typedef std::shared_ptr<This> shared_ptr;
 
  using Base::Base;
 
  size_t dim() const;
 
  Vector violationVector(const Values& values, bool whiten = true) const;
 
  double violationNorm(const Values& values) const;
 
  NonlinearFactorGraph penaltyGraph(const double mu = 1.0) const;
 
  NonlinearFactorGraph penaltyGraphCustom(InequalityPenaltyFunction::shared_ptr func,
                                          const double mu = 1.0) const;
 
 private:
#if GTSAM_ENABLE_BOOST_SERIALIZATION
 
  friend class boost::serialization::access;
  template <class ARCHIVE>
  void serialize(ARCHIVE& ar, const unsigned int /*version*/) {
    ar& boost::serialization::make_nvp("NonlinearInequalityConstraints",
                                       boost::serialization::base_object<Base>(*this));
  }
#endif
};
 
}  // namespace gtsam