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: keir@google.com (Keir Mierle)
30
31#include "gtest/gtest.h"
32#include "ceres/iteration_callback.h"
33#include "ceres/minimizer.h"
34#include "ceres/solver.h"
35
36namespace ceres {
37namespace internal {
38
39class FakeIterationCallback : public IterationCallback {
40 public:
41  virtual ~FakeIterationCallback() {}
42  virtual CallbackReturnType operator()(const IterationSummary& summary) {
43    return SOLVER_CONTINUE;
44  }
45};
46
47TEST(Minimizer, InitializationCopiesCallbacks) {
48  FakeIterationCallback callback0;
49  FakeIterationCallback callback1;
50
51  Solver::Options solver_options;
52  solver_options.callbacks.push_back(&callback0);
53  solver_options.callbacks.push_back(&callback1);
54
55  Minimizer::Options minimizer_options(solver_options);
56  ASSERT_EQ(2, minimizer_options.callbacks.size());
57
58  EXPECT_EQ(minimizer_options.callbacks[0], &callback0);
59  EXPECT_EQ(minimizer_options.callbacks[1], &callback1);
60}
61
62class AbortingIterationCallback : public IterationCallback {
63 public:
64  virtual ~AbortingIterationCallback() {}
65  virtual CallbackReturnType operator()(const IterationSummary& summary) {
66    return SOLVER_ABORT;
67  }
68};
69
70TEST(Minimizer, UserAbortUpdatesSummaryMessage) {
71  AbortingIterationCallback callback;
72  Solver::Options solver_options;
73  solver_options.callbacks.push_back(&callback);
74  Minimizer::Options minimizer_options(solver_options);
75  Solver::Summary summary;
76  Minimizer::RunCallbacks(minimizer_options, IterationSummary(), &summary);
77  EXPECT_EQ(summary.message, "User callback returned SOLVER_ABORT.");
78}
79
80class SucceedingIterationCallback : public IterationCallback {
81 public:
82  virtual ~SucceedingIterationCallback() {}
83  virtual CallbackReturnType operator()(const IterationSummary& summary) {
84    return SOLVER_TERMINATE_SUCCESSFULLY;
85  }
86};
87
88TEST(Minimizer, UserSuccessUpdatesSummaryMessage) {
89  SucceedingIterationCallback callback;
90  Solver::Options solver_options;
91  solver_options.callbacks.push_back(&callback);
92  Minimizer::Options minimizer_options(solver_options);
93  Solver::Summary summary;
94  Minimizer::RunCallbacks(minimizer_options, IterationSummary(), &summary);
95  EXPECT_EQ(summary.message,
96            "User callback returned SOLVER_TERMINATE_SUCCESSFULLY.");
97}
98
99}  // namespace internal
100}  // namespace ceres
101