/usr/include/ITK-4.9/itkLBFGSOptimizer.h is in libinsighttoolkit4-dev 4.9.0-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | /*=========================================================================
*
* Copyright Insight Software Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkLBFGSOptimizer_h
#define itkLBFGSOptimizer_h
#include "itkSingleValuedNonLinearVnlOptimizer.h"
#include "vnl/algo/vnl_lbfgs.h"
#include "ITKOptimizersExport.h"
namespace itk
{
/** \class LBFGSOptimizer
* \brief Wrap of the vnl_lbfgs algorithm
*
* \ingroup Numerics Optimizers
* \ingroup ITKOptimizers
*/
class ITKOptimizers_EXPORT LBFGSOptimizer:
public SingleValuedNonLinearVnlOptimizer
{
public:
/** Standard "Self" typedef. */
typedef LBFGSOptimizer Self;
typedef SingleValuedNonLinearVnlOptimizer Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(LBFGSOptimizer, SingleValuedNonLinearVnlOptimizer);
/** InternalParameters typedef. */
typedef vnl_vector< double > InternalParametersType;
/** Internal optimizer type. */
typedef vnl_lbfgs InternalOptimizerType;
/** Method for getting access to the internal optimizer. */
vnl_lbfgs * GetOptimizer();
/** Start optimization with an initial value. */
virtual void StartOptimization(void) ITK_OVERRIDE;
/** Plug in a Cost Function into the optimizer */
virtual void SetCostFunction(SingleValuedCostFunction *costFunction) ITK_OVERRIDE;
/** Set/Get the optimizer trace flag. If set to true, the optimizer
* prints out information every iteration.
*/
virtual void SetTrace(bool flag);
itkGetMacro(Trace, bool);
itkBooleanMacro(Trace);
/** Set/Get the maximum number of function evaluations allowed. */
virtual void SetMaximumNumberOfFunctionEvaluations(unsigned int n);
itkGetMacro(MaximumNumberOfFunctionEvaluations, unsigned int);
/** Set/Get the gradient convergence tolerance. This is a positive
* real number that determines the accuracy with which the solution is to
* be found. The optimization terminates when:
* ||G|| < gtol max(1,||X||) where ||.|| denotes the Euclidean norm.
*/
virtual void SetGradientConvergenceTolerance(double gtol);
itkGetMacro(GradientConvergenceTolerance, double);
/** Set/Get the line search accuracy. This is a positive real number
* with a default value of 0.9, which controls the accuracy of the line
* search. If the function and gradient evalutions are inexpensive with
* respect to the cost of the iterations it may be advantageous to set
* the value to a small value (say 0.1).
*/
virtual void SetLineSearchAccuracy(double tol);
itkGetMacro(LineSearchAccuracy, double);
/** Set/Get the default step size. This is a positive real number
* with a default value of 1.0 which determines the stpe size in the line
* search.
*/
virtual void SetDefaultStepLength(double stp);
itkGetMacro(DefaultStepLength, double);
/** Return Current Value */
MeasureType GetValue() const;
/** Get the reason for termination */
virtual const std::string GetStopConditionDescription() const ITK_OVERRIDE;
protected:
LBFGSOptimizer();
virtual ~LBFGSOptimizer();
virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
typedef Superclass::CostFunctionAdaptorType CostFunctionAdaptorType;
private:
LBFGSOptimizer(const Self &) ITK_DELETE_FUNCTION;
void operator=(const Self &) ITK_DELETE_FUNCTION;
bool m_OptimizerInitialized;
InternalOptimizerType * m_VnlOptimizer;
mutable std::ostringstream m_StopConditionDescription;
bool m_Trace;
unsigned int m_MaximumNumberOfFunctionEvaluations;
double m_GradientConvergenceTolerance;
double m_LineSearchAccuracy;
double m_DefaultStepLength;
};
} // end namespace itk
#endif
|