/usr/include/openturns/TNC.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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | // -*- C++ -*-
/**
* @brief TNC is an actual implementation for OptimizationAlgorithmImplementation using the TNC library
*
* 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_TNC_HXX
#define OPENTURNS_TNC_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/OptimizationAlgorithmImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class TNC
* TNC is an actual implementation for
* OptimizationAlgorithmImplementation using the TNC library
*/
class OT_API TNC :
public OptimizationAlgorithmImplementation
{
CLASSNAME;
public:
/** Default constructor */
TNC();
/** Constructor with parameters */
explicit TNC(const OptimizationProblem & problem);
/** Constructor with parameters */
TNC(const OptimizationProblem & problem,
const Point & scale,
const Point & offset,
const UnsignedInteger maxCGit,
const Scalar eta,
const Scalar stepmx,
const Scalar accuracy,
const Scalar fmin,
const Scalar rescale);
/** Virtual constructor */
virtual TNC * clone() const;
/** Performs the actual computation. Must be overloaded by the actual optimisation algorithm */
void run();
/** Scale accessor */
Point getScale() const;
void setScale(const Point & scale);
/** Offset accessor */
Point getOffset() const;
void setOffset(const Point & offset);
/** MaxCGit accessor */
UnsignedInteger getMaxCGit() const;
void setMaxCGit(const UnsignedInteger maxCGit);
/** Eta accessor */
Scalar getEta() const;
void setEta(const Scalar eta);
/** Stepmx accessor */
Scalar getStepmx() const;
void setStepmx(const Scalar stepmx);
/** Accuracy accessor */
Scalar getAccuracy() const;
void setAccuracy(const Scalar accuracy);
/** Fmin accessor */
Scalar getFmin() const;
void setFmin(const Scalar fmin);
/** Rescale accessor */
Scalar getRescale() const;
void setRescale(const Scalar rescale);
/** String converter */
String __repr__() const;
/** Method save() stores the object through the StorageManager */
void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(Advocate & adv);
protected:
/** Check whether this problem can be solved by this solver. Must be overloaded by the actual optimisation algorithm */
void checkProblem(const OptimizationProblem & problem) const;
private:
/** Function that computes the objective function and its gradient */
static int ComputeObjectiveAndGradient(double *x, double *f, double *g, void *state);
/** Specific parameters */
Point scale_;
Point offset_;
UnsignedInteger maxCGit_;
Scalar eta_;
Scalar stepmx_;
Scalar accuracy_;
Scalar fmin_;
Scalar rescale_;
/// temporary, used to track input/outputs
Sample evaluationInputHistory_;
Sample evaluationOutputHistory_;
void * p_nfeval_;
}; /* class TNC */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_TNC_HXX */
|