CustomFactor.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2 
3  * GTSAM Copyright 2010, Georgia Tech Research Corporation,
4  * Atlanta, Georgia 30332-0415
5  * All Rights Reserved
6  * Authors: Frank Dellaert, et al. (see THANKS for the full author list)
7 
8  * See LICENSE for the license information
9 
10  * -------------------------------------------------------------------------- */
11 
18 #pragma once
19 
21 
22 namespace gtsam {
23 
24 using JacobianVector = std::vector<Matrix>;
25 
26 class CustomFactor;
27 
28 /*
29  * NOTE
30  * ==========
31  * pybind11 will invoke a copy if this is `JacobianVector &`, and modifications in Python will not be reflected.
32  *
33  * This is safe because this is passing a const pointer, and pybind11 will maintain the `std::vector` memory layout.
34  * Thus the pointer will never be invalidated.
35  */
36 using CustomErrorFunction = std::function<Vector(const CustomFactor &, const Values &, const JacobianVector *)>;
37 
46 protected:
48 
49 protected:
50 
52  using This = CustomFactor;
53 
54 public:
55 
59  CustomFactor() = default;
60 
68  Base(noiseModel, keys) {
69  this->error_function_ = errorFunction;
70  }
71 
76  Vector unwhitenedError(const Values &x, OptionalMatrixVecType H = nullptr) const override;
77 
79  void print(const std::string &s,
80  const KeyFormatter &keyFormatter = DefaultKeyFormatter) const override;
81 
85  bool sendable() const override {
86  return false;
87  }
88 
89 private:
90 
91 #ifdef GTSAM_ENABLE_BOOST_SERIALIZATION
92 
93  friend class boost::serialization::access;
94  template<class ARCHIVE>
95  void serialize(ARCHIVE &ar, const unsigned int /*version*/) {
96  ar & boost::serialization::make_nvp("CustomFactor",
97  boost::serialization::base_object<Base>(*this));
98  }
99 #endif
100 };
101 
102 }
std::vector< Matrix > * OptionalMatrixVecType
CustomFactor()=default
void print(const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
std::string serialize(const T &input)
serializes to a string
set noclip points set clip one set noclip two set bar set border lt lw set xdata set ydata set zdata set x2data set y2data set boxwidth set dummy y set format x g set format y g set format x2 g set format y2 g set format z g set angles radians set nogrid set key title set key left top Right noreverse box linetype linewidth samplen spacing width set nolabel set noarrow set nologscale set logscale x set set pointsize set encoding default set nopolar set noparametric set set set set surface set nocontour set clabel set mapping cartesian set nohidden3d set cntrparam order set cntrparam linear set cntrparam levels auto set cntrparam points set size set set xzeroaxis lt lw set x2zeroaxis lt lw set yzeroaxis lt lw set y2zeroaxis lt lw set tics in set ticslevel set tics set mxtics default set mytics default set mx2tics default set my2tics default set xtics border mirror norotate autofreq set ytics border mirror norotate autofreq set ztics border nomirror norotate autofreq set nox2tics set noy2tics set timestamp bottom norotate set rrange [*:*] noreverse nowriteback set trange [*:*] noreverse nowriteback set urange [*:*] noreverse nowriteback set vrange [*:*] noreverse nowriteback set xlabel matrix size set x2label set timefmt d m y n H
static const KeyFormatter DefaultKeyFormatter
Definition: Key.h:43
std::function< Vector(const CustomFactor &, const Values &, const JacobianVector *)> CustomErrorFunction
Definition: CustomFactor.h:36
Vector unwhitenedError(const Values &x, OptionalMatrixVecType H=nullptr) const override
const SharedNoiseModel & noiseModel() const
access to the noise model
Eigen::VectorXd Vector
Definition: Vector.h:38
RealScalar s
std::vector< Matrix > JacobianVector
Definition: CustomFactor.h:24
std::function< std::string(Key)> KeyFormatter
Typedef for a function to format a key, i.e. to convert it to a string.
Definition: Key.h:35
CustomFactor(const SharedNoiseModel &noiseModel, const KeyVector &keys, const CustomErrorFunction &errorFunction)
Definition: CustomFactor.h:67
traits
Definition: chartTesting.h:28
Non-linear factor base classes.
bool sendable() const override
Definition: CustomFactor.h:85
CustomErrorFunction error_function_
Definition: CustomFactor.h:47
const KeyVector & keys() const
Access the factor&#39;s involved variable keys.
Definition: Factor.h:142
FastVector< Key > KeyVector
Define collection type once and for all - also used in wrappers.
Definition: Key.h:86
set noclip points set clip one set noclip two set bar set border lt lw set xdata set ydata set zdata set x2data set y2data set boxwidth set dummy x
noiseModel::Base::shared_ptr SharedNoiseModel
Definition: NoiseModel.h:741


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:34:06