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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkSingleValuedCostFunction_h
#define itkSingleValuedCostFunction_h
#include "itkCostFunction.h"
#include "itkNumericTraits.h"
#include "ITKOptimizersExport.h"
namespace itk
{
/** \class SingleValuedCostFunction
* \brief This class is a base for the CostFunctions returning a
* single value
*
* \ingroup Numerics Optimizers
* \ingroup ITKOptimizers
*/
class ITKOptimizers_EXPORT SingleValuedCostFunction : public CostFunction
{
public:
ITK_DISALLOW_COPY_AND_MOVE(SingleValuedCostFunction);
/** Standard class type aliases. */
using Self = SingleValuedCostFunction;
using Superclass = CostFunction;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(SingleValuedCostFunction);
/** MeasureType type alias.
* It defines a type used to return the cost function value. */
using MeasureType = double;
/** ParametersType type alias.
* It defines a position in the optimization search space. */
using ParametersType = Superclass::ParametersType;
using ParametersValueType = Superclass::ParametersValueType;
/** DerivativeType type alias.
* It defines a type used to return the cost function derivative. */
using DerivativeType = Array<ParametersValueType>;
/** This method returns the value of the cost function corresponding
* to the specified parameters. */
virtual MeasureType
GetValue(const ParametersType & parameters) const = 0;
/** This method returns the derivative of the cost function corresponding
* to the specified parameters. */
virtual void
GetDerivative(const ParametersType & parameters, DerivativeType & derivative) const = 0;
/** This method returns the value and derivative of the cost function corresponding
* to the specified parameters */
virtual void
GetValueAndDerivative(const ParametersType & parameters, MeasureType & value, DerivativeType & derivative) const;
protected:
SingleValuedCostFunction() = default;
~SingleValuedCostFunction() override;
};
} // end namespace itk
#endif
|
