a21fd7adb901faf13e5a3d8d492bbfb9c9b0603a
[blender.git] / extern / ceres / include / ceres / jet.h
1 // Ceres Solver - A fast non-linear least squares minimizer
2 // Copyright 2015 Google Inc. All rights reserved.
3 // http://ceres-solver.org/
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 //
8 // * Redistributions of source code must retain the above copyright notice,
9 //   this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright notice,
11 //   this list of conditions and the following disclaimer in the documentation
12 //   and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors may be
14 //   used to endorse or promote products derived from this software without
15 //   specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 // POSSIBILITY OF SUCH DAMAGE.
28 //
29 // Author: keir@google.com (Keir Mierle)
30 //
31 // A simple implementation of N-dimensional dual numbers, for automatically
32 // computing exact derivatives of functions.
33 //
34 // While a complete treatment of the mechanics of automatic differentation is
35 // beyond the scope of this header (see
36 // http://en.wikipedia.org/wiki/Automatic_differentiation for details), the
37 // basic idea is to extend normal arithmetic with an extra element, "e," often
38 // denoted with the greek symbol epsilon, such that e != 0 but e^2 = 0. Dual
39 // numbers are extensions of the real numbers analogous to complex numbers:
40 // whereas complex numbers augment the reals by introducing an imaginary unit i
41 // such that i^2 = -1, dual numbers introduce an "infinitesimal" unit e such
42 // that e^2 = 0. Dual numbers have two components: the "real" component and the
43 // "infinitesimal" component, generally written as x + y*e. Surprisingly, this
44 // leads to a convenient method for computing exact derivatives without needing
45 // to manipulate complicated symbolic expressions.
46 //
47 // For example, consider the function
48 //
49 //   f(x) = x^2 ,
50 //
51 // evaluated at 10. Using normal arithmetic, f(10) = 100, and df/dx(10) = 20.
52 // Next, augument 10 with an infinitesimal to get:
53 //
54 //   f(10 + e) = (10 + e)^2
55 //             = 100 + 2 * 10 * e + e^2
56 //             = 100 + 20 * e       -+-
57 //                     --            |
58 //                     |             +--- This is zero, since e^2 = 0
59 //                     |
60 //                     +----------------- This is df/dx!
61 //
62 // Note that the derivative of f with respect to x is simply the infinitesimal
63 // component of the value of f(x + e). So, in order to take the derivative of
64 // any function, it is only necessary to replace the numeric "object" used in
65 // the function with one extended with infinitesimals. The class Jet, defined in
66 // this header, is one such example of this, where substitution is done with
67 // templates.
68 //
69 // To handle derivatives of functions taking multiple arguments, different
70 // infinitesimals are used, one for each variable to take the derivative of. For
71 // example, consider a scalar function of two scalar parameters x and y:
72 //
73 //   f(x, y) = x^2 + x * y
74 //
75 // Following the technique above, to compute the derivatives df/dx and df/dy for
76 // f(1, 3) involves doing two evaluations of f, the first time replacing x with
77 // x + e, the second time replacing y with y + e.
78 //
79 // For df/dx:
80 //
81 //   f(1 + e, y) = (1 + e)^2 + (1 + e) * 3
82 //               = 1 + 2 * e + 3 + 3 * e
83 //               = 4 + 5 * e
84 //
85 //               --> df/dx = 5
86 //
87 // For df/dy:
88 //
89 //   f(1, 3 + e) = 1^2 + 1 * (3 + e)
90 //               = 1 + 3 + e
91 //               = 4 + e
92 //
93 //               --> df/dy = 1
94 //
95 // To take the gradient of f with the implementation of dual numbers ("jets") in
96 // this file, it is necessary to create a single jet type which has components
97 // for the derivative in x and y, and passing them to a templated version of f:
98 //
99 //   template<typename T>
100 //   T f(const T &x, const T &y) {
101 //     return x * x + x * y;
102 //   }
103 //
104 //   // The "2" means there should be 2 dual number components.
105 //   Jet<double, 2> x(0);  // Pick the 0th dual number for x.
106 //   Jet<double, 2> y(1);  // Pick the 1st dual number for y.
107 //   Jet<double, 2> z = f(x, y);
108 //
109 //   LOG(INFO) << "df/dx = " << z.v[0]
110 //             << "df/dy = " << z.v[1];
111 //
112 // Most users should not use Jet objects directly; a wrapper around Jet objects,
113 // which makes computing the derivative, gradient, or jacobian of templated
114 // functors simple, is in autodiff.h. Even autodiff.h should not be used
115 // directly; instead autodiff_cost_function.h is typically the file of interest.
116 //
117 // For the more mathematically inclined, this file implements first-order
118 // "jets". A 1st order jet is an element of the ring
119 //
120 //   T[N] = T[t_1, ..., t_N] / (t_1, ..., t_N)^2
121 //
122 // which essentially means that each jet consists of a "scalar" value 'a' from T
123 // and a 1st order perturbation vector 'v' of length N:
124 //
125 //   x = a + \sum_i v[i] t_i
126 //
127 // A shorthand is to write an element as x = a + u, where u is the pertubation.
128 // Then, the main point about the arithmetic of jets is that the product of
129 // perturbations is zero:
130 //
131 //   (a + u) * (b + v) = ab + av + bu + uv
132 //                     = ab + (av + bu) + 0
133 //
134 // which is what operator* implements below. Addition is simpler:
135 //
136 //   (a + u) + (b + v) = (a + b) + (u + v).
137 //
138 // The only remaining question is how to evaluate the function of a jet, for
139 // which we use the chain rule:
140 //
141 //   f(a + u) = f(a) + f'(a) u
142 //
143 // where f'(a) is the (scalar) derivative of f at a.
144 //
145 // By pushing these things through sufficiently and suitably templated
146 // functions, we can do automatic differentiation. Just be sure to turn on
147 // function inlining and common-subexpression elimination, or it will be very
148 // slow!
149 //
150 // WARNING: Most Ceres users should not directly include this file or know the
151 // details of how jets work. Instead the suggested method for automatic
152 // derivatives is to use autodiff_cost_function.h, which is a wrapper around
153 // both jets.h and autodiff.h to make taking derivatives of cost functions for
154 // use in Ceres easier.
155
156 #ifndef CERES_PUBLIC_JET_H_
157 #define CERES_PUBLIC_JET_H_
158
159 #include <cmath>
160 #include <iosfwd>
161 #include <iostream>  // NOLINT
162 #include <limits>
163 #include <string>
164
165 #include "Eigen/Core"
166 #include "ceres/fpclassify.h"
167
168 namespace ceres {
169
170 template <typename T, int N>
171 struct Jet {
172   enum { DIMENSION = N };
173
174   // Default-construct "a" because otherwise this can lead to false errors about
175   // uninitialized uses when other classes relying on default constructed T
176   // (where T is a Jet<T, N>). This usually only happens in opt mode. Note that
177   // the C++ standard mandates that e.g. default constructed doubles are
178   // initialized to 0.0; see sections 8.5 of the C++03 standard.
179   Jet() : a() {
180     v.setZero();
181   }
182
183   // Constructor from scalar: a + 0.
184   explicit Jet(const T& value) {
185     a = value;
186     v.setZero();
187   }
188
189   // Constructor from scalar plus variable: a + t_i.
190   Jet(const T& value, int k) {
191     a = value;
192     v.setZero();
193     v[k] = T(1.0);
194   }
195
196   // Constructor from scalar and vector part
197   // The use of Eigen::DenseBase allows Eigen expressions
198   // to be passed in without being fully evaluated until
199   // they are assigned to v
200   template<typename Derived>
201   EIGEN_STRONG_INLINE Jet(const T& a, const Eigen::DenseBase<Derived> &v)
202       : a(a), v(v) {
203   }
204
205   // Compound operators
206   Jet<T, N>& operator+=(const Jet<T, N> &y) {
207     *this = *this + y;
208     return *this;
209   }
210
211   Jet<T, N>& operator-=(const Jet<T, N> &y) {
212     *this = *this - y;
213     return *this;
214   }
215
216   Jet<T, N>& operator*=(const Jet<T, N> &y) {
217     *this = *this * y;
218     return *this;
219   }
220
221   Jet<T, N>& operator/=(const Jet<T, N> &y) {
222     *this = *this / y;
223     return *this;
224   }
225
226   // The scalar part.
227   T a;
228
229   // The infinitesimal part.
230   //
231   // Note the Eigen::DontAlign bit is needed here because this object
232   // gets allocated on the stack and as part of other arrays and
233   // structs. Forcing the right alignment there is the source of much
234   // pain and suffering. Even if that works, passing Jets around to
235   // functions by value has problems because the C++ ABI does not
236   // guarantee alignment for function arguments.
237   //
238   // Setting the DontAlign bit prevents Eigen from using SSE for the
239   // various operations on Jets. This is a small performance penalty
240   // since the AutoDiff code will still expose much of the code as
241   // statically sized loops to the compiler. But given the subtle
242   // issues that arise due to alignment, especially when dealing with
243   // multiple platforms, it seems to be a trade off worth making.
244   Eigen::Matrix<T, N, 1, Eigen::DontAlign> v;
245 };
246
247 // Unary +
248 template<typename T, int N> inline
249 Jet<T, N> const& operator+(const Jet<T, N>& f) {
250   return f;
251 }
252
253 // TODO(keir): Try adding __attribute__((always_inline)) to these functions to
254 // see if it causes a performance increase.
255
256 // Unary -
257 template<typename T, int N> inline
258 Jet<T, N> operator-(const Jet<T, N>&f) {
259   return Jet<T, N>(-f.a, -f.v);
260 }
261
262 // Binary +
263 template<typename T, int N> inline
264 Jet<T, N> operator+(const Jet<T, N>& f,
265                     const Jet<T, N>& g) {
266   return Jet<T, N>(f.a + g.a, f.v + g.v);
267 }
268
269 // Binary + with a scalar: x + s
270 template<typename T, int N> inline
271 Jet<T, N> operator+(const Jet<T, N>& f, T s) {
272   return Jet<T, N>(f.a + s, f.v);
273 }
274
275 // Binary + with a scalar: s + x
276 template<typename T, int N> inline
277 Jet<T, N> operator+(T s, const Jet<T, N>& f) {
278   return Jet<T, N>(f.a + s, f.v);
279 }
280
281 // Binary -
282 template<typename T, int N> inline
283 Jet<T, N> operator-(const Jet<T, N>& f,
284                     const Jet<T, N>& g) {
285   return Jet<T, N>(f.a - g.a, f.v - g.v);
286 }
287
288 // Binary - with a scalar: x - s
289 template<typename T, int N> inline
290 Jet<T, N> operator-(const Jet<T, N>& f, T s) {
291   return Jet<T, N>(f.a - s, f.v);
292 }
293
294 // Binary - with a scalar: s - x
295 template<typename T, int N> inline
296 Jet<T, N> operator-(T s, const Jet<T, N>& f) {
297   return Jet<T, N>(s - f.a, -f.v);
298 }
299
300 // Binary *
301 template<typename T, int N> inline
302 Jet<T, N> operator*(const Jet<T, N>& f,
303                     const Jet<T, N>& g) {
304   return Jet<T, N>(f.a * g.a, f.a * g.v + f.v * g.a);
305 }
306
307 // Binary * with a scalar: x * s
308 template<typename T, int N> inline
309 Jet<T, N> operator*(const Jet<T, N>& f, T s) {
310   return Jet<T, N>(f.a * s, f.v * s);
311 }
312
313 // Binary * with a scalar: s * x
314 template<typename T, int N> inline
315 Jet<T, N> operator*(T s, const Jet<T, N>& f) {
316   return Jet<T, N>(f.a * s, f.v * s);
317 }
318
319 // Binary /
320 template<typename T, int N> inline
321 Jet<T, N> operator/(const Jet<T, N>& f,
322                     const Jet<T, N>& g) {
323   // This uses:
324   //
325   //   a + u   (a + u)(b - v)   (a + u)(b - v)
326   //   ----- = -------------- = --------------
327   //   b + v   (b + v)(b - v)        b^2
328   //
329   // which holds because v*v = 0.
330   const T g_a_inverse = T(1.0) / g.a;
331   const T f_a_by_g_a = f.a * g_a_inverse;
332   return Jet<T, N>(f.a * g_a_inverse, (f.v - f_a_by_g_a * g.v) * g_a_inverse);
333 }
334
335 // Binary / with a scalar: s / x
336 template<typename T, int N> inline
337 Jet<T, N> operator/(T s, const Jet<T, N>& g) {
338   const T minus_s_g_a_inverse2 = -s / (g.a * g.a);
339   return Jet<T, N>(s / g.a, g.v * minus_s_g_a_inverse2);
340 }
341
342 // Binary / with a scalar: x / s
343 template<typename T, int N> inline
344 Jet<T, N> operator/(const Jet<T, N>& f, T s) {
345   const T s_inverse = 1.0 / s;
346   return Jet<T, N>(f.a * s_inverse, f.v * s_inverse);
347 }
348
349 // Binary comparison operators for both scalars and jets.
350 #define CERES_DEFINE_JET_COMPARISON_OPERATOR(op) \
351 template<typename T, int N> inline \
352 bool operator op(const Jet<T, N>& f, const Jet<T, N>& g) { \
353   return f.a op g.a; \
354 } \
355 template<typename T, int N> inline \
356 bool operator op(const T& s, const Jet<T, N>& g) { \
357   return s op g.a; \
358 } \
359 template<typename T, int N> inline \
360 bool operator op(const Jet<T, N>& f, const T& s) { \
361   return f.a op s; \
362 }
363 CERES_DEFINE_JET_COMPARISON_OPERATOR( <  )  // NOLINT
364 CERES_DEFINE_JET_COMPARISON_OPERATOR( <= )  // NOLINT
365 CERES_DEFINE_JET_COMPARISON_OPERATOR( >  )  // NOLINT
366 CERES_DEFINE_JET_COMPARISON_OPERATOR( >= )  // NOLINT
367 CERES_DEFINE_JET_COMPARISON_OPERATOR( == )  // NOLINT
368 CERES_DEFINE_JET_COMPARISON_OPERATOR( != )  // NOLINT
369 #undef CERES_DEFINE_JET_COMPARISON_OPERATOR
370
371 // Pull some functions from namespace std.
372 //
373 // This is necessary because we want to use the same name (e.g. 'sqrt') for
374 // double-valued and Jet-valued functions, but we are not allowed to put
375 // Jet-valued functions inside namespace std.
376 //
377 // TODO(keir): Switch to "using".
378 inline double abs     (double x) { return std::abs(x);      }
379 inline double log     (double x) { return std::log(x);      }
380 inline double exp     (double x) { return std::exp(x);      }
381 inline double sqrt    (double x) { return std::sqrt(x);     }
382 inline double cos     (double x) { return std::cos(x);      }
383 inline double acos    (double x) { return std::acos(x);     }
384 inline double sin     (double x) { return std::sin(x);      }
385 inline double asin    (double x) { return std::asin(x);     }
386 inline double tan     (double x) { return std::tan(x);      }
387 inline double atan    (double x) { return std::atan(x);     }
388 inline double sinh    (double x) { return std::sinh(x);     }
389 inline double cosh    (double x) { return std::cosh(x);     }
390 inline double tanh    (double x) { return std::tanh(x);     }
391 inline double pow  (double x, double y) { return std::pow(x, y);   }
392 inline double atan2(double y, double x) { return std::atan2(y, x); }
393
394 // In general, f(a + h) ~= f(a) + f'(a) h, via the chain rule.
395
396 // abs(x + h) ~= x + h or -(x + h)
397 template <typename T, int N> inline
398 Jet<T, N> abs(const Jet<T, N>& f) {
399   return f.a < T(0.0) ? -f : f;
400 }
401
402 // log(a + h) ~= log(a) + h / a
403 template <typename T, int N> inline
404 Jet<T, N> log(const Jet<T, N>& f) {
405   const T a_inverse = T(1.0) / f.a;
406   return Jet<T, N>(log(f.a), f.v * a_inverse);
407 }
408
409 // exp(a + h) ~= exp(a) + exp(a) h
410 template <typename T, int N> inline
411 Jet<T, N> exp(const Jet<T, N>& f) {
412   const T tmp = exp(f.a);
413   return Jet<T, N>(tmp, tmp * f.v);
414 }
415
416 // sqrt(a + h) ~= sqrt(a) + h / (2 sqrt(a))
417 template <typename T, int N> inline
418 Jet<T, N> sqrt(const Jet<T, N>& f) {
419   const T tmp = sqrt(f.a);
420   const T two_a_inverse = T(1.0) / (T(2.0) * tmp);
421   return Jet<T, N>(tmp, f.v * two_a_inverse);
422 }
423
424 // cos(a + h) ~= cos(a) - sin(a) h
425 template <typename T, int N> inline
426 Jet<T, N> cos(const Jet<T, N>& f) {
427   return Jet<T, N>(cos(f.a), - sin(f.a) * f.v);
428 }
429
430 // acos(a + h) ~= acos(a) - 1 / sqrt(1 - a^2) h
431 template <typename T, int N> inline
432 Jet<T, N> acos(const Jet<T, N>& f) {
433   const T tmp = - T(1.0) / sqrt(T(1.0) - f.a * f.a);
434   return Jet<T, N>(acos(f.a), tmp * f.v);
435 }
436
437 // sin(a + h) ~= sin(a) + cos(a) h
438 template <typename T, int N> inline
439 Jet<T, N> sin(const Jet<T, N>& f) {
440   return Jet<T, N>(sin(f.a), cos(f.a) * f.v);
441 }
442
443 // asin(a + h) ~= asin(a) + 1 / sqrt(1 - a^2) h
444 template <typename T, int N> inline
445 Jet<T, N> asin(const Jet<T, N>& f) {
446   const T tmp = T(1.0) / sqrt(T(1.0) - f.a * f.a);
447   return Jet<T, N>(asin(f.a), tmp * f.v);
448 }
449
450 // tan(a + h) ~= tan(a) + (1 + tan(a)^2) h
451 template <typename T, int N> inline
452 Jet<T, N> tan(const Jet<T, N>& f) {
453   const T tan_a = tan(f.a);
454   const T tmp = T(1.0) + tan_a * tan_a;
455   return Jet<T, N>(tan_a, tmp * f.v);
456 }
457
458 // atan(a + h) ~= atan(a) + 1 / (1 + a^2) h
459 template <typename T, int N> inline
460 Jet<T, N> atan(const Jet<T, N>& f) {
461   const T tmp = T(1.0) / (T(1.0) + f.a * f.a);
462   return Jet<T, N>(atan(f.a), tmp * f.v);
463 }
464
465 // sinh(a + h) ~= sinh(a) + cosh(a) h
466 template <typename T, int N> inline
467 Jet<T, N> sinh(const Jet<T, N>& f) {
468   return Jet<T, N>(sinh(f.a), cosh(f.a) * f.v);
469 }
470
471 // cosh(a + h) ~= cosh(a) + sinh(a) h
472 template <typename T, int N> inline
473 Jet<T, N> cosh(const Jet<T, N>& f) {
474   return Jet<T, N>(cosh(f.a), sinh(f.a) * f.v);
475 }
476
477 // tanh(a + h) ~= tanh(a) + (1 - tanh(a)^2) h
478 template <typename T, int N> inline
479 Jet<T, N> tanh(const Jet<T, N>& f) {
480   const T tanh_a = tanh(f.a);
481   const T tmp = T(1.0) - tanh_a * tanh_a;
482   return Jet<T, N>(tanh_a, tmp * f.v);
483 }
484
485 // Bessel functions of the first kind with integer order equal to 0, 1, n.
486 inline double BesselJ0(double x) { return j0(x); }
487 inline double BesselJ1(double x) { return j1(x); }
488 inline double BesselJn(int n, double x) { return jn(n, x); }
489
490 // For the formulae of the derivatives of the Bessel functions see the book:
491 // Olver, Lozier, Boisvert, Clark, NIST Handbook of Mathematical Functions,
492 // Cambridge University Press 2010.
493 //
494 // Formulae are also available at http://dlmf.nist.gov
495
496 // See formula http://dlmf.nist.gov/10.6#E3
497 // j0(a + h) ~= j0(a) - j1(a) h
498 template <typename T, int N> inline
499 Jet<T, N> BesselJ0(const Jet<T, N>& f) {
500   return Jet<T, N>(BesselJ0(f.a),
501                    -BesselJ1(f.a) * f.v);
502 }
503
504 // See formula http://dlmf.nist.gov/10.6#E1
505 // j1(a + h) ~= j1(a) + 0.5 ( j0(a) - j2(a) ) h
506 template <typename T, int N> inline
507 Jet<T, N> BesselJ1(const Jet<T, N>& f) {
508   return Jet<T, N>(BesselJ1(f.a),
509                    T(0.5) * (BesselJ0(f.a) - BesselJn(2, f.a)) * f.v);
510 }
511
512 // See formula http://dlmf.nist.gov/10.6#E1
513 // j_n(a + h) ~= j_n(a) + 0.5 ( j_{n-1}(a) - j_{n+1}(a) ) h
514 template <typename T, int N> inline
515 Jet<T, N> BesselJn(int n, const Jet<T, N>& f) {
516   return Jet<T, N>(BesselJn(n, f.a),
517                    T(0.5) * (BesselJn(n - 1, f.a) - BesselJn(n + 1, f.a)) * f.v);
518 }
519
520 // Jet Classification. It is not clear what the appropriate semantics are for
521 // these classifications. This picks that IsFinite and isnormal are "all"
522 // operations, i.e. all elements of the jet must be finite for the jet itself
523 // to be finite (or normal). For IsNaN and IsInfinite, the answer is less
524 // clear. This takes a "any" approach for IsNaN and IsInfinite such that if any
525 // part of a jet is nan or inf, then the entire jet is nan or inf. This leads
526 // to strange situations like a jet can be both IsInfinite and IsNaN, but in
527 // practice the "any" semantics are the most useful for e.g. checking that
528 // derivatives are sane.
529
530 // The jet is finite if all parts of the jet are finite.
531 template <typename T, int N> inline
532 bool IsFinite(const Jet<T, N>& f) {
533   if (!IsFinite(f.a)) {
534     return false;
535   }
536   for (int i = 0; i < N; ++i) {
537     if (!IsFinite(f.v[i])) {
538       return false;
539     }
540   }
541   return true;
542 }
543
544 // The jet is infinite if any part of the jet is infinite.
545 template <typename T, int N> inline
546 bool IsInfinite(const Jet<T, N>& f) {
547   if (IsInfinite(f.a)) {
548     return true;
549   }
550   for (int i = 0; i < N; i++) {
551     if (IsInfinite(f.v[i])) {
552       return true;
553     }
554   }
555   return false;
556 }
557
558 // The jet is NaN if any part of the jet is NaN.
559 template <typename T, int N> inline
560 bool IsNaN(const Jet<T, N>& f) {
561   if (IsNaN(f.a)) {
562     return true;
563   }
564   for (int i = 0; i < N; ++i) {
565     if (IsNaN(f.v[i])) {
566       return true;
567     }
568   }
569   return false;
570 }
571
572 // The jet is normal if all parts of the jet are normal.
573 template <typename T, int N> inline
574 bool IsNormal(const Jet<T, N>& f) {
575   if (!IsNormal(f.a)) {
576     return false;
577   }
578   for (int i = 0; i < N; ++i) {
579     if (!IsNormal(f.v[i])) {
580       return false;
581     }
582   }
583   return true;
584 }
585
586 // atan2(b + db, a + da) ~= atan2(b, a) + (- b da + a db) / (a^2 + b^2)
587 //
588 // In words: the rate of change of theta is 1/r times the rate of
589 // change of (x, y) in the positive angular direction.
590 template <typename T, int N> inline
591 Jet<T, N> atan2(const Jet<T, N>& g, const Jet<T, N>& f) {
592   // Note order of arguments:
593   //
594   //   f = a + da
595   //   g = b + db
596
597   T const tmp = T(1.0) / (f.a * f.a + g.a * g.a);
598   return Jet<T, N>(atan2(g.a, f.a), tmp * (- g.a * f.v + f.a * g.v));
599 }
600
601
602 // pow -- base is a differentiable function, exponent is a constant.
603 // (a+da)^p ~= a^p + p*a^(p-1) da
604 template <typename T, int N> inline
605 Jet<T, N> pow(const Jet<T, N>& f, double g) {
606   T const tmp = g * pow(f.a, g - T(1.0));
607   return Jet<T, N>(pow(f.a, g), tmp * f.v);
608 }
609
610 // pow -- base is a constant, exponent is a differentiable function.
611 // We have various special cases, see the comment for pow(Jet, Jet) for
612 // analysis:
613 //
614 // 1. For f > 0 we have: (f)^(g + dg) ~= f^g + f^g log(f) dg
615 //
616 // 2. For f == 0 and g > 0 we have: (f)^(g + dg) ~= f^g
617 //
618 // 3. For f < 0 and integer g we have: (f)^(g + dg) ~= f^g but if dg
619 // != 0, the derivatives are not defined and we return NaN.
620
621 template <typename T, int N> inline
622 Jet<T, N> pow(double f, const Jet<T, N>& g) {
623   if (f == 0 && g.a > 0) {
624     // Handle case 2.
625     return Jet<T, N>(T(0.0));
626   }
627   if (f < 0 && g.a == floor(g.a)) {
628     // Handle case 3.
629     Jet<T, N> ret(pow(f, g.a));
630     for (int i = 0; i < N; i++) {
631       if (g.v[i] != T(0.0)) {
632         // Return a NaN when g.v != 0.
633         ret.v[i] = std::numeric_limits<T>::quiet_NaN();
634       }
635     }
636     return ret;
637   }
638   // Handle case 1.
639   T const tmp = pow(f, g.a);
640   return Jet<T, N>(tmp, log(f) * tmp * g.v);
641 }
642
643 // pow -- both base and exponent are differentiable functions. This has a
644 // variety of special cases that require careful handling.
645 //
646 // 1. For f > 0:
647 //    (f + df)^(g + dg) ~= f^g + f^(g - 1) * (g * df + f * log(f) * dg)
648 //    The numerical evaluation of f * log(f) for f > 0 is well behaved, even for
649 //    extremely small values (e.g. 1e-99).
650 //
651 // 2. For f == 0 and g > 1: (f + df)^(g + dg) ~= 0
652 //    This cases is needed because log(0) can not be evaluated in the f > 0
653 //    expression. However the function f*log(f) is well behaved around f == 0
654 //    and its limit as f-->0 is zero.
655 //
656 // 3. For f == 0 and g == 1: (f + df)^(g + dg) ~= 0 + df
657 //
658 // 4. For f == 0 and 0 < g < 1: The value is finite but the derivatives are not.
659 //
660 // 5. For f == 0 and g < 0: The value and derivatives of f^g are not finite.
661 //
662 // 6. For f == 0 and g == 0: The C standard incorrectly defines 0^0 to be 1
663 //    "because there are applications that can exploit this definition". We
664 //    (arbitrarily) decree that derivatives here will be nonfinite, since that
665 //    is consistent with the behavior for f == 0, g < 0 and 0 < g < 1.
666 //    Practically any definition could have been justified because mathematical
667 //    consistency has been lost at this point.
668 //
669 // 7. For f < 0, g integer, dg == 0: (f + df)^(g + dg) ~= f^g + g * f^(g - 1) df
670 //    This is equivalent to the case where f is a differentiable function and g
671 //    is a constant (to first order).
672 //
673 // 8. For f < 0, g integer, dg != 0: The value is finite but the derivatives are
674 //    not, because any change in the value of g moves us away from the point
675 //    with a real-valued answer into the region with complex-valued answers.
676 //
677 // 9. For f < 0, g noninteger: The value and derivatives of f^g are not finite.
678
679 template <typename T, int N> inline
680 Jet<T, N> pow(const Jet<T, N>& f, const Jet<T, N>& g) {
681   if (f.a == 0 && g.a >= 1) {
682     // Handle cases 2 and 3.
683     if (g.a > 1) {
684       return Jet<T, N>(T(0.0));
685     }
686     return f;
687   }
688   if (f.a < 0 && g.a == floor(g.a)) {
689     // Handle cases 7 and 8.
690     T const tmp = g.a * pow(f.a, g.a - T(1.0));
691     Jet<T, N> ret(pow(f.a, g.a), tmp * f.v);
692     for (int i = 0; i < N; i++) {
693       if (g.v[i] != T(0.0)) {
694         // Return a NaN when g.v != 0.
695         ret.v[i] = std::numeric_limits<T>::quiet_NaN();
696       }
697     }
698     return ret;
699   }
700   // Handle the remaining cases. For cases 4,5,6,9 we allow the log() function
701   // to generate -HUGE_VAL or NaN, since those cases result in a nonfinite
702   // derivative.
703   T const tmp1 = pow(f.a, g.a);
704   T const tmp2 = g.a * pow(f.a, g.a - T(1.0));
705   T const tmp3 = tmp1 * log(f.a);
706   return Jet<T, N>(tmp1, tmp2 * f.v + tmp3 * g.v);
707 }
708
709 // Define the helper functions Eigen needs to embed Jet types.
710 //
711 // NOTE(keir): machine_epsilon() and precision() are missing, because they don't
712 // work with nested template types (e.g. where the scalar is itself templated).
713 // Among other things, this means that decompositions of Jet's does not work,
714 // for example
715 //
716 //   Matrix<Jet<T, N> ... > A, x, b;
717 //   ...
718 //   A.solve(b, &x)
719 //
720 // does not work and will fail with a strange compiler error.
721 //
722 // TODO(keir): This is an Eigen 2.0 limitation that is lifted in 3.0. When we
723 // switch to 3.0, also add the rest of the specialization functionality.
724 template<typename T, int N> inline const Jet<T, N>& ei_conj(const Jet<T, N>& x) { return x;              }  // NOLINT
725 template<typename T, int N> inline const Jet<T, N>& ei_real(const Jet<T, N>& x) { return x;              }  // NOLINT
726 template<typename T, int N> inline       Jet<T, N>  ei_imag(const Jet<T, N>&  ) { return Jet<T, N>(0.0); }  // NOLINT
727 template<typename T, int N> inline       Jet<T, N>  ei_abs (const Jet<T, N>& x) { return fabs(x);        }  // NOLINT
728 template<typename T, int N> inline       Jet<T, N>  ei_abs2(const Jet<T, N>& x) { return x * x;          }  // NOLINT
729 template<typename T, int N> inline       Jet<T, N>  ei_sqrt(const Jet<T, N>& x) { return sqrt(x);        }  // NOLINT
730 template<typename T, int N> inline       Jet<T, N>  ei_exp (const Jet<T, N>& x) { return exp(x);         }  // NOLINT
731 template<typename T, int N> inline       Jet<T, N>  ei_log (const Jet<T, N>& x) { return log(x);         }  // NOLINT
732 template<typename T, int N> inline       Jet<T, N>  ei_sin (const Jet<T, N>& x) { return sin(x);         }  // NOLINT
733 template<typename T, int N> inline       Jet<T, N>  ei_cos (const Jet<T, N>& x) { return cos(x);         }  // NOLINT
734 template<typename T, int N> inline       Jet<T, N>  ei_tan (const Jet<T, N>& x) { return tan(x);         }  // NOLINT
735 template<typename T, int N> inline       Jet<T, N>  ei_atan(const Jet<T, N>& x) { return atan(x);        }  // NOLINT
736 template<typename T, int N> inline       Jet<T, N>  ei_sinh(const Jet<T, N>& x) { return sinh(x);        }  // NOLINT
737 template<typename T, int N> inline       Jet<T, N>  ei_cosh(const Jet<T, N>& x) { return cosh(x);        }  // NOLINT
738 template<typename T, int N> inline       Jet<T, N>  ei_tanh(const Jet<T, N>& x) { return tanh(x);        }  // NOLINT
739 template<typename T, int N> inline       Jet<T, N>  ei_pow (const Jet<T, N>& x, Jet<T, N> y) { return pow(x, y); }  // NOLINT
740
741 // Note: This has to be in the ceres namespace for argument dependent lookup to
742 // function correctly. Otherwise statements like CHECK_LE(x, 2.0) fail with
743 // strange compile errors.
744 template <typename T, int N>
745 inline std::ostream &operator<<(std::ostream &s, const Jet<T, N>& z) {
746   return s << "[" << z.a << " ; " << z.v.transpose() << "]";
747 }
748
749 }  // namespace ceres
750
751 namespace Eigen {
752
753 // Creating a specialization of NumTraits enables placing Jet objects inside
754 // Eigen arrays, getting all the goodness of Eigen combined with autodiff.
755 template<typename T, int N>
756 struct NumTraits<ceres::Jet<T, N> > {
757   typedef ceres::Jet<T, N> Real;
758   typedef ceres::Jet<T, N> NonInteger;
759   typedef ceres::Jet<T, N> Nested;
760
761   static typename ceres::Jet<T, N> dummy_precision() {
762     return ceres::Jet<T, N>(1e-12);
763   }
764
765   static inline Real epsilon() {
766     return Real(std::numeric_limits<T>::epsilon());
767   }
768
769   enum {
770     IsComplex = 0,
771     IsInteger = 0,
772     IsSigned,
773     ReadCost = 1,
774     AddCost = 1,
775     // For Jet types, multiplication is more expensive than addition.
776     MulCost = 3,
777     HasFloatingPoint = 1,
778     RequireInitialization = 1
779   };
780 };
781
782 }  // namespace Eigen
783
784 #endif  // CERES_PUBLIC_JET_H_