From 552f66193af3c34d3f9cb88451dd9b00c844cb3a Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de>
Date: Tue, 8 Feb 2022 19:57:01 +0100
Subject: [PATCH] doxyuser: cover IMinimizer
---
Fit/Minimizer/IMinimizer.h | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/Fit/Minimizer/IMinimizer.h b/Fit/Minimizer/IMinimizer.h
index 64c668b47c1..2a09f848112 100644
--- a/Fit/Minimizer/IMinimizer.h
+++ b/Fit/Minimizer/IMinimizer.h
@@ -12,7 +12,6 @@
//
// ************************************************************************************************
-#ifndef USER_API
#ifndef BORNAGAIN_FIT_MINIMIZER_IMINIMIZER_H
#define BORNAGAIN_FIT_MINIMIZER_IMINIMIZER_H
@@ -23,6 +22,7 @@
namespace mumufit {
class Parameters;
+
}
//! Abstract base class for all kind minimizers.
@@ -35,30 +35,30 @@ public:
IMinimizer(const IMinimizer& other) = delete;
IMinimizer& operator=(const IMinimizer& other) = delete;
- //! return name of the minimizer
+ //! Returns name of the minimizer.
virtual std::string minimizerName() const = 0;
- //! return name of the minimization algorithm
+ //! Return name of the minimization algorithm.
virtual std::string algorithmName() const = 0;
- //! run minimization
+ //! Runs minimization.
virtual mumufit::MinimizerResult minimize_scalar(fcn_scalar_t, mumufit::Parameters);
+ //! Runs minimization.
virtual mumufit::MinimizerResult minimize_residual(fcn_residual_t, mumufit::Parameters);
- //! clear resources (parameters) for consecutives minimizations
+ //! Clears resources (parameters) for consecutives minimizations.
virtual void clear() {}
- //! Returns minimum function value
+ //! Returns minimum function value.
virtual double minValue() const;
- //! Sets option string to the minimizer
+ //! Sets option string to the minimizer.
virtual void setOptions(const std::string& options);
#ifndef SWIG
- //! Returns true if minimizer computations are residual-based, false otherwise
+ //! Returns true if minimizer computations are residual-based, false otherwise.
virtual bool requiresResiduals() { return false; }
-#endif // USER_API
+#endif // SWIG
};
#endif // BORNAGAIN_FIT_MINIMIZER_IMINIMIZER_H
-#endif // USER_API
--
GitLab