ITK  6.0.0
Insight Toolkit
itkConjugateGradientOptimizer.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 itkConjugateGradientOptimizer_h
19#define itkConjugateGradientOptimizer_h
20
21#include "itkIntTypes.h"
23#include "vnl/algo/vnl_conjugate_gradient.h"
24#include "ITKOptimizersExport.h"
25#include <memory> // For unique_ptr.
26
27namespace itk
28{
36
37{
38public:
39 ITK_DISALLOW_COPY_AND_MOVE(ConjugateGradientOptimizer);
40
46
48 itkNewMacro(Self);
49
51 itkOverrideGetNameOfClassMacro(ConjugateGradientOptimizer);
52
54 using InternalParametersType = vnl_vector<double>;
55
57 using InternalOptimizerType = vnl_conjugate_gradient;
58
60 vnl_conjugate_gradient *
62
64 void
66
68 void
69 SetCostFunction(SingleValuedCostFunction * costFunction) override;
70
74
77
80 GetValue() const;
81
82protected:
85
86 using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
87
88private:
90 bool m_OptimizerInitialized{};
91 std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
92};
93} // end namespace itk
94
95#endif
Wrap of the vnl_conjugate_gradient.
SizeValueType GetCurrentIteration() const
vnl_conjugate_gradient * GetOptimizer()
SizeValueType GetNumberOfIterations() const
Superclass::CostFunctionAdaptorType CostFunctionAdaptorType
std::unique_ptr< InternalOptimizerType > m_VnlOptimizer
MeasureType GetValue() const
void SetCostFunction(SingleValuedCostFunction *costFunction) override
Light weight base class for most itk classes.
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.
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
unsigned long SizeValueType
Definition: itkIntTypes.h:86