Add documentation for examples Also remove random.h which is not used anymore. Change-Id: I389a0fc0fd771619e179dcf305bb0991ad1d82ff
diff --git a/examples/curve_fitting.cc b/examples/curve_fitting.cc index 8cbf3aa..c6b3a6b 100644 --- a/examples/curve_fitting.cc +++ b/examples/curve_fitting.cc
@@ -27,6 +27,9 @@ // POSSIBILITY OF SUCH DAMAGE. // // Author: sameeragarwal@google.com (Sameer Agarwal) +// +// This example fits the curve f(x;m,c) = e^(m * x + c) to data, minimizing the +// sum squared loss. #include "ceres/ceres.h" #include "glog/logging.h"
diff --git a/examples/iteration_callback_example.cc b/examples/iteration_callback_example.cc index 2e8a2fb..993565d 100644 --- a/examples/iteration_callback_example.cc +++ b/examples/iteration_callback_example.cc
@@ -27,6 +27,11 @@ // POSSIBILITY OF SUCH DAMAGE. // // Author: sameeragarwal@google.com (Sameer Agarwal) +// +// This example is a variant of curve_fitting.cc where we use an +// IterationCallback to implement custom logging which prints out the values of +// the parameter blocks as they evolve over the course of the optimization. This +// also requires the use of Solver::Options::update_state_every_iteration. #include "ceres/ceres.h" #include "glog/logging.h"
diff --git a/examples/random.h b/examples/random.h deleted file mode 100644 index dcd326a..0000000 --- a/examples/random.h +++ /dev/null
@@ -1,62 +0,0 @@ -// Ceres Solver - A fast non-linear least squares minimizer -// Copyright 2023 Google Inc. All rights reserved. -// http://ceres-solver.org/ -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// * Redistributions of source code must retain the above copyright notice, -// this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above copyright notice, -// this list of conditions and the following disclaimer in the documentation -// and/or other materials provided with the distribution. -// * Neither the name of Google Inc. nor the names of its contributors may be -// used to endorse or promote products derived from this software without -// specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -// POSSIBILITY OF SUCH DAMAGE. -// -// Author: sameeragarwal@google.com (Sameer Agarwal) - -#ifndef CERES_EXAMPLES_RANDOM_H_ -#define CERES_EXAMPLES_RANDOM_H_ - -#include <cmath> -#include <cstdlib> - -namespace ceres::examples { - -// Return a random number sampled from a uniform distribution in the range -// [0,1]. -inline double RandDouble() { - auto r = static_cast<double>(rand()); - return r / RAND_MAX; -} - -// Marsaglia Polar method for generation standard normal (pseudo) -// random numbers http://en.wikipedia.org/wiki/Marsaglia_polar_method -inline double RandNormal() { - double x1, x2, w; - do { - x1 = 2.0 * RandDouble() - 1.0; - x2 = 2.0 * RandDouble() - 1.0; - w = x1 * x1 + x2 * x2; - } while (w >= 1.0 || w == 0.0); - - w = sqrt((-2.0 * log(w)) / w); - return x1 * w; -} - -} // namespace ceres::examples - -#endif // CERES_EXAMPLES_RANDOM_H_
diff --git a/examples/robust_curve_fitting.cc b/examples/robust_curve_fitting.cc index 915b619..8759a46 100644 --- a/examples/robust_curve_fitting.cc +++ b/examples/robust_curve_fitting.cc
@@ -27,6 +27,12 @@ // POSSIBILITY OF SUCH DAMAGE. // // Author: sameeragarwal@google.com (Sameer Agarwal) +// +// This example fits the curve f(x;m,c) = e^(m * x + c) to data. However unlike +// the data in curve_fitting.cc, the data here has outliers in it, so minimizing +// the sum squared loss will result in a bad fit. So this example illustrates +// the use of a robust loss function (CauchyLoss) to reduce the influence of the +// outliers on the fit. #include "ceres/ceres.h" #include "glog/logging.h"
diff --git a/examples/rosenbrock.cc b/examples/rosenbrock.cc index 4a7e456..a382ccd 100644 --- a/examples/rosenbrock.cc +++ b/examples/rosenbrock.cc
@@ -27,6 +27,10 @@ // POSSIBILITY OF SUCH DAMAGE. // // Author: sameeragarwal@google.com (Sameer Agarwal) +// +// Example of minimizing the Rosenbrock function +// (https://en.wikipedia.org/wiki/Rosenbrock_function) using +// GradientProblemSolver using automatically computed derivatives. #include "ceres/ceres.h" #include "glog/logging.h"
diff --git a/examples/rosenbrock_analytic_diff.cc b/examples/rosenbrock_analytic_diff.cc index 6a4e8b7..65e49eb 100644 --- a/examples/rosenbrock_analytic_diff.cc +++ b/examples/rosenbrock_analytic_diff.cc
@@ -27,6 +27,10 @@ // POSSIBILITY OF SUCH DAMAGE. // // Author: sameeragarwal@google.com (Sameer Agarwal) +// +// Example of minimizing the Rosenbrock function +// (https://en.wikipedia.org/wiki/Rosenbrock_function) using +// GradientProblemSolver using analytic derivatives. #include "ceres/ceres.h" #include "glog/logging.h"
diff --git a/examples/rosenbrock_numeric_diff.cc b/examples/rosenbrock_numeric_diff.cc index ec5ca5d..a711b2f 100644 --- a/examples/rosenbrock_numeric_diff.cc +++ b/examples/rosenbrock_numeric_diff.cc
@@ -27,6 +27,11 @@ // POSSIBILITY OF SUCH DAMAGE. // // Author: sameeragarwal@google.com (Sameer Agarwal) +// +// Example of minimizing the Rosenbrock function +// (https://en.wikipedia.org/wiki/Rosenbrock_function) using +// GradientProblemSolver using derivatives computed using numeric +// differentiation. #include "ceres/ceres.h" #include "glog/logging.h"