ITK  6.0.0
Insight Toolkit
itkLBFGSBOptimizer.h
Go to the documentation of this file.
1/*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18#ifndef itkLBFGSBOptimizer_h
19#define itkLBFGSBOptimizer_h
20
21#include "itkIntTypes.h"
23#include "ITKOptimizersExport.h"
24#include <memory> // For unique_ptr.
25
26namespace itk
27{
28/* Necessary forward declaration see below for definition */
36class ITK_FORWARD_EXPORT LBFGSBOptimizerHelper;
37
64class ITKOptimizers_EXPORT LBFGSBOptimizer : public SingleValuedNonLinearVnlOptimizer
65{
66public:
67 ITK_DISALLOW_COPY_AND_MOVE(LBFGSBOptimizer);
68
74
76 itkNewMacro(Self);
77
79 itkOverrideGetNameOfClassMacro(LBFGSBOptimizer);
80
85
90
92 using InternalBoundValueType = vnl_vector<double>;
93
95 using InternalBoundSelectionType = vnl_vector<long>;
96
99
101 void
103
105 void
107
111 virtual void
112 SetTrace(bool flag);
113
114 itkGetMacro(Trace, bool);
115 itkBooleanMacro(Trace);
116
118 virtual void
120 itkGetConstReferenceMacro(LowerBound, BoundValueType);
124 virtual void
126 itkGetConstReferenceMacro(UpperBound, BoundValueType);
135 virtual void
137 itkGetConstReferenceMacro(BoundSelection, BoundSelectionType);
146 virtual void
148
149 itkGetMacro(CostFunctionConvergenceFactor, double);
150
155 virtual void
157
158 itkGetMacro(ProjectedGradientTolerance, double);
159
161 virtual void
163
164 itkGetMacro(MaximumNumberOfIterations, unsigned int);
165
167 virtual void
169
170 itkGetMacro(MaximumNumberOfEvaluations, unsigned int);
171
173 virtual void
175
176 itkGetMacro(MaximumNumberOfCorrections, unsigned int);
177
179 void
181 {
182 itkExceptionMacro("This optimizer does not support scales.");
183 }
184
186 itkGetConstReferenceMacro(CurrentIteration, unsigned int);
187
190 GetValue() const;
191
194 itkGetConstReferenceMacro(InfinityNormOfProjectedGradient, double);
195
197 std::string
199
201 bool
202 CanUseScales() const override
203 {
204 return false;
205 }
206
207protected:
210 void
211 PrintSelf(std::ostream & os, Indent indent) const override;
212
213 using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
214
215private:
216 // give the helper access to member variables, to update iteration
217 // counts, etc.
219
220 bool m_Trace{ false };
221 bool m_OptimizerInitialized{ false };
222 double m_CostFunctionConvergenceFactor{ 1e+7 };
223 double m_ProjectedGradientTolerance{ 1e-5 };
224 unsigned int m_MaximumNumberOfIterations{ 500 };
225 unsigned int m_MaximumNumberOfEvaluations{ 500 };
226 unsigned int m_MaximumNumberOfCorrections{ 5 };
227 unsigned int m_CurrentIteration{ 0 };
228 double m_InfinityNormOfProjectedGradient{ 0.0 };
229
230 std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
231 BoundValueType m_LowerBound{};
232 BoundValueType m_UpperBound{};
233 BoundSelectionType m_BoundSelection{};
234};
235} // end namespace itk
236
237#endif
Wrapper helper around vnl_lbfgsb.
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Limited memory Broyden Fletcher Goldfarb Shannon minimization with simple bounds.
virtual void SetProjectedGradientTolerance(double)
~LBFGSBOptimizer() override
bool CanUseScales() const override
std::unique_ptr< InternalOptimizerType > m_VnlOptimizer
virtual void SetCostFunctionConvergenceFactor(double)
vnl_vector< long > InternalBoundSelectionType
void SetCostFunction(SingleValuedCostFunction *costFunction) override
Superclass::CostFunctionAdaptorType CostFunctionAdaptorType
virtual void SetMaximumNumberOfIterations(unsigned int)
virtual void SetMaximumNumberOfEvaluations(unsigned int)
virtual void SetMaximumNumberOfCorrections(unsigned int)
vnl_vector< double > InternalBoundValueType
std::string GetStopConditionDescription() const override
MeasureType GetValue() const
void StartOptimization() override
virtual void SetUpperBound(const BoundValueType &value)
virtual void SetLowerBound(const BoundValueType &value)
virtual void SetBoundSelection(const BoundSelectionType &value)
virtual void SetTrace(bool flag)
void SetScales(const ScalesType &)
void PrintSelf(std::ostream &os, Indent indent) const override
Light weight base class for most itk classes.
Superclass::ScalesType ScalesType
This class is a base for the CostFunctions returning a single value.
This class is a base for the Optimization methods that optimize a single valued function.
static constexpr double e
Definition: itkMath.h:56
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
class ITK_FORWARD_EXPORT LBFGSBOptimizerHelper