Home | History | Annotate | Download | only in ceres 
      1 // Ceres Solver - A fast non-linear least squares minimizer
      2 // Copyright 2010, 2011, 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: keir (at) google.com (Keir Mierle)
     30 
     31 #include <string>
     32 #include "ceres/internal/port.h"
     33 
     34 #ifndef CERES_INTERNAL_TEST_UTIL_H_
     35 #define CERES_INTERNAL_TEST_UTIL_H_
     36 
     37 namespace ceres {
     38 namespace internal {
     39 
     40 // Expects that x and y have a relative difference of no more than
     41 // max_abs_relative_difference. If either x or y is zero, then the relative
     42 // difference is interpreted as an absolute difference.
     43 bool ExpectClose(double x, double y, double max_abs_relative_difference);
     44 
     45 // Expects that for all i = 1,.., n - 1
     46 //
     47 //   |p[i] - q[i]| / max(|p[i]|, |q[i]|) < tolerance
     48 void ExpectArraysClose(int n,
     49                        const double* p,
     50                        const double* q,
     51                        double tolerance);
     52 
     53 // Expects that for all i = 1,.., n - 1
     54 //
     55 //   |p[i] / max_norm_p - q[i] / max_norm_q| < tolerance
     56 //
     57 // where max_norm_p and max_norm_q are the max norms of the arrays p
     58 // and q respectively.
     59 void ExpectArraysCloseUptoScale(int n,
     60                                 const double* p,
     61                                 const double* q,
     62                                 double tolerance);
     63 
     64 // Construct a fully qualified path for the test file depending on the
     65 // local build/testing environment.
     66 string TestFileAbsolutePath(const string& filename);
     67 
     68 }  // namespace internal
     69 }  // namespace ceres
     70 
     71 #endif  // CERES_INTERNAL_TEST_UTIL_H_
     72