1// Ceres Solver - A fast non-linear least squares minimizer
2// Copyright 2014 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
31#ifndef CERES_INTERNAL_CALLBACKS_H_
32#define CERES_INTERNAL_CALLBACKS_H_
33
34#include <string>
35#include "ceres/iteration_callback.h"
36#include "ceres/internal/port.h"
37
38namespace ceres {
39namespace internal {
40
41class Program;
42
43// Callback for updating the externally visible state of parameter
44// blocks.
45class StateUpdatingCallback : public IterationCallback {
46 public:
47  StateUpdatingCallback(Program* program, double* parameters);
48  virtual ~StateUpdatingCallback();
49  virtual CallbackReturnType operator()(const IterationSummary& summary);
50 private:
51  Program* program_;
52  double* parameters_;
53};
54
55// Callback for logging the state of the minimizer to STDERR or
56// STDOUT depending on the user's preferences and logging level.
57class LoggingCallback : public IterationCallback {
58 public:
59  LoggingCallback(MinimizerType minimizer_type, bool log_to_stdout);
60  virtual ~LoggingCallback();
61  virtual CallbackReturnType operator()(const IterationSummary& summary);
62
63 private:
64  const MinimizerType minimizer_type;
65  const bool log_to_stdout_;
66};
67
68}  // namespace internal
69}  // namespace ceres
70
71#endif  // CERES_INTERNAL_CALLBACKS_H_
72