/usr/include/openturns/OptimizationAlgorithm.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief OptimizationAlgorithm provides capabilities to solve optimization problems
*
* Copyright 2005-2017 Airbus-EDF-IMACS-Phimeca
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef OPENTURNS_OPTIMIZATIONALGORITHM_HXX
#define OPENTURNS_OPTIMIZATIONALGORITHM_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/TypedInterfaceObject.hxx"
#include "openturns/Function.hxx"
#include "openturns/OptimizationAlgorithmImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class OptimizationAlgorithm
* This class provides capabilities to solve optimization problems
*/
class OT_API OptimizationAlgorithm
: public TypedInterfaceObject<OptimizationAlgorithmImplementation>
{
CLASSNAME;
public:
typedef Pointer<OptimizationAlgorithmImplementation> Implementation;
typedef OptimizationResult Result;
/** Default constructor */
OptimizationAlgorithm();
/** Constructor from an implementation */
OptimizationAlgorithm(const OptimizationAlgorithmImplementation & implementation);
/** Constructor from a Pointer to an implementation */
OptimizationAlgorithm(const Implementation & p_implementation);
/** Constructor with parameters */
explicit OptimizationAlgorithm(const OptimizationProblem & problem);
/** Performs the actual computation. Must be overloaded by the actual optimisation algorithm */
void run();
/** Starting point accessor */
Point getStartingPoint() const;
void setStartingPoint(const Point & startingPoint);
/** Problem accessor */
OptimizationProblem getProblem() const;
void setProblem(const OptimizationProblem & problem);
/** Result accessor */
Result getResult() const;
void setResult(const Result & result);
/** Maximum iterations number accessor */
UnsignedInteger getMaximumIterationNumber() const;
void setMaximumIterationNumber(const UnsignedInteger maximumIterationNumber);
/** Maximum absolute error accessor */
Scalar getMaximumAbsoluteError() const;
void setMaximumAbsoluteError(const Scalar maximumAbsoluteError);
/** Maximum relative error accessor */
Scalar getMaximumRelativeError() const;
void setMaximumRelativeError(const Scalar maximumRelativeError);
/** Maximum residual error accessor */
Scalar getMaximumResidualError() const;
void setMaximumResidualError(const Scalar maximumResidualError);
/** Maximum constraint error accessor */
Scalar getMaximumConstraintError() const;
void setMaximumConstraintError(const Scalar maximumConstraintError);
/* Verbose accessor */
Bool getVerbose() const;
void setVerbose(const Bool verbose);
/** Progress callback */
typedef void (*ProgressCallback)(Scalar, void * data);
void setProgressCallback(ProgressCallback callBack, void * data = 0);
/** Stop callback */
typedef Bool (*StopCallback)(void * data);
void setStopCallback(StopCallback callBack, void * data = 0);
/** String converter */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
} ; /* class OptimizationAlgorithm */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_OPTIMIZATIONALGORITHM_HXX */
|