/usr/include/ITK-4.5/itkSingleValuedCostFunctionv4.h is in libinsighttoolkit4-dev 4.5.0-3.
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 | /*=========================================================================
*
* 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 __itkSingleValuedCostFunctionv4_h
#define __itkSingleValuedCostFunctionv4_h
#include "itkCostFunction.h"
#include "itkNumericTraits.h"
namespace itk
{
/** \class SingleValuedCostFunctionv4Template
* \brief This class is a base for a CostFunction that returns a
* single value.
*
* This class differs from the SingleValuedCostFunction in that it is fine
* tunned for managing very large numbers of parameters. For example, to be
* used in conditions where the number of parameters is in the range of
* thousands or even millions. Due to the large number of parameters, the API
* of this class avoids any copying of the parameters array, and of the classes
* that have dimensionality related to the size of the parameters array.
*
* As you look at the code of this class, keep in mind that the types
* ParametersType and DerivativeType will be some sort of array-like type with
* millions of elements.
*
* Derived classes must provide implementations for:
* GetValue
* GetValueAndDerivative
*
* \ingroup Numerics Optimizers
* \ingroup ITKOptimizersv4
*/
template< typename TInternalComputationValueType >
class SingleValuedCostFunctionv4Template:
public CostFunctionTemplate< TInternalComputationValueType >
{
public:
/** Standard class typedefs. */
typedef SingleValuedCostFunctionv4Template Self;
typedef CostFunctionTemplate< TInternalComputationValueType > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Run-time type information (and related methods). */
itkTypeMacro(SingleValuedCostFunctionv4Template, CostFunctionTemplate);
/** MeasureType typedef.
* It defines a type used to return the cost function value. */
typedef TInternalComputationValueType MeasureType;
/** ParametersType typedef.
* It defines a position in the optimization search space. */
typedef typename Superclass::ParametersType ParametersType;
/** DerivativeType typedef.
* It defines a type used to return the cost function derivative. */
typedef Array< TInternalComputationValueType > DerivativeType;
/** This method returns the value of the cost function corresponding
* to the specified parameters. */
virtual MeasureType GetValue() const = 0;
/** This method returns the value and derivative of the cost function.
* \c derivative will be sized and allocated as needed by metric.
* If it's already proper size, no new allocation is done. */
virtual void GetValueAndDerivative(MeasureType & value,
DerivativeType & derivative) const = 0;
protected:
SingleValuedCostFunctionv4Template() {}
virtual ~SingleValuedCostFunctionv4Template() {}
private:
SingleValuedCostFunctionv4Template(const Self &); //purposely not implemented
void operator=(const Self &); //purposely not implemented
};
/** This helps to meet backward compatibility */
typedef SingleValuedCostFunctionv4Template<double> SingleValuedCostFunctionv4;
} // end namespace itk
#endif
|