| Sameer Agarwal | 1fdc520 | 2012-05-12 07:29:10 -0700 | [diff] [blame] | 1 | // Ceres Solver - A fast non-linear least squares minimizer |
| 2 | // Copyright 2012 Google Inc. All rights reserved. |
| 3 | // http://code.google.com/p/ceres-solver/ |
| 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: sameeragarwal@google.com (Sameer Agarwal) |
| 30 | // |
| Sameer Agarwal | 509f68c | 2013-02-20 01:39:03 -0800 | [diff] [blame] | 31 | // Utility routines for validating arrays. |
| Sameer Agarwal | 1fdc520 | 2012-05-12 07:29:10 -0700 | [diff] [blame] | 32 | // |
| 33 | // These are useful for detecting two common class of errors. |
| 34 | // |
| 35 | // 1. Uninitialized memory - where the user for some reason did not |
| 36 | // compute part of an array, but the code expects it. |
| 37 | // |
| 38 | // 2. Numerical failure while computing the cost/residual/jacobian, |
| 39 | // e.g. NaN, infinities etc. This is particularly useful since the |
| 40 | // automatic differentiation code does computations that are not |
| 41 | // evident to the user and can silently generate hard to debug errors. |
| 42 | |
| 43 | #ifndef CERES_INTERNAL_ARRAY_UTILS_H_ |
| 44 | #define CERES_INTERNAL_ARRAY_UTILS_H_ |
| 45 | |
| 46 | #include "ceres/internal/port.h" |
| 47 | |
| 48 | namespace ceres { |
| 49 | namespace internal { |
| 50 | |
| 51 | // Fill the array x with an impossible value that the user code is |
| 52 | // never expected to compute. |
| 53 | void InvalidateArray(int size, double* x); |
| 54 | |
| 55 | // Check if all the entries of the array x are valid, i.e. all the |
| 56 | // values in the array should be finite and none of them should be |
| 57 | // equal to the "impossible" value used by InvalidateArray. |
| 58 | bool IsArrayValid(int size, const double* x); |
| 59 | |
| 60 | extern const double kImpossibleValue; |
| 61 | |
| 62 | } // namespace internal |
| 63 | } // namespace ceres |
| 64 | |
| 65 | #endif // CERES_INTERNAL_ARRAY_UTILS_H_ |
