/usr/include/openturns/BoundConstrainedAlgorithm.hxx is in libopenturns-dev 0.15-2.
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 138 139 140 141 142 143 144 145 146 | // -*- C++ -*-
/**
* @file BoundConstrainedAlgorithm.hxx
* @brief BoundConstrainedAlgorithm implements an algorithm for finding the
*
* (C) Copyright 2005-2011 EDF-EADS-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 2.1 of the License.
*
* 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
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: BoundConstrainedAlgorithm.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_BOUNDCONSTRAINEDALGORITHM_HXX
#define OPENTURNS_BOUNDCONSTRAINEDALGORITHM_HXX
#include "TypedInterfaceObject.hxx"
#include "Threadable.hxx"
#include "BoundConstrainedAlgorithmImplementation.hxx"
namespace OpenTURNS
{
namespace Base
{
namespace Optim
{
/**
* @class BoundConstrainedAlgorithm
* BoundConstrainedAlgorithm implements an interface to an algorithm for finding the
* point of an interval that minimize the given objective function
*/
class BoundConstrainedAlgorithm
: public Common::TypedInterfaceObject<BoundConstrainedAlgorithmImplementation>,
public Common::Threadable
{
CLASSNAME;
public:
typedef Pointer<BoundConstrainedAlgorithmImplementation> Implementation;
typedef BoundConstrainedAlgorithmImplementation::NumericalMathFunction NumericalMathFunction;
typedef BoundConstrainedAlgorithmImplementation::NumericalPoint NumericalPoint;
typedef BoundConstrainedAlgorithmImplementation::Interval Interval;
typedef BoundConstrainedAlgorithmImplementation::InternalException InternalException;
typedef BoundConstrainedAlgorithmImplementation::InvalidArgumentException InvalidArgumentException;
typedef BoundConstrainedAlgorithmImplementation::OptimizationProblem OptimizationProblem;
#ifndef SWIG
typedef BoundConstrainedAlgorithmImplementation::Result Result;
#else
typedef BoundConstrainedAlgorithmImplementationResult Result;
#endif
/** Default constructor */
explicit BoundConstrainedAlgorithm();
/** Constructor from an implementation */
BoundConstrainedAlgorithm(const BoundConstrainedAlgorithmImplementation & implementationconst);
/** Constructor from a Pointer to an implementation */
BoundConstrainedAlgorithm(const Implementation & p_implementation);
/** Constructor with parameters: no constraint, starting from the origin */
BoundConstrainedAlgorithm(const NumericalMathFunction & objectiveFunction,
const Bool verbose = false);
/** Constructor with parameters: bound constraints, starting from the given point */
BoundConstrainedAlgorithm(const NumericalMathFunction & objectiveFunction,
const Interval & boundConstraints,
const NumericalPoint & startingPoint,
const OptimizationProblem optimization = BoundConstrainedAlgorithmImplementationResult::MINIMIZATION,
const Bool verbose = false) /* throw(InvalidArgumentException) */;
/** Performs the actual computation. Must be overloaded by the actual optimisation algorithm */
virtual void run()
/* throw(InternalException) */;
/** Starting point accessor */
NumericalPoint getStartingPoint() const;
void setStartingPoint(const NumericalPoint & startingPoint);
/** Objective function accessor */
NumericalMathFunction getObjectiveFunction() const;
void setObjectiveFunction(const NumericalMathFunction & objectiveFunction);
/** Bound constraints accessor */
Interval getBoundConstraints() const;
void setBoundConstraints(const Interval & boundConstraints);
/** Optimization problem accessor */
OptimizationProblem getOptimizationProblem() const;
void setOptimizationProblem(const OptimizationProblem optimization);
/** Result accessor */
Result getResult() const;
void setResult(const Result & result);
/** Maximum iterations number accessor */
UnsignedLong getMaximumEvaluationsNumber() const;
void setMaximumEvaluationsNumber(const UnsignedLong maximumEvaluationsNumber);
/** Maximum absolute error accessor */
NumericalScalar getMaximumAbsoluteError() const;
void setMaximumAbsoluteError(const NumericalScalar maximumAbsoluteError);
/** Maximum relative error accessor */
NumericalScalar getMaximumRelativeError() const;
void setMaximumRelativeError(const NumericalScalar maximumRelativeError);
/** Maximum objective error accessor */
NumericalScalar getMaximumObjectiveError() const;
void setMaximumObjectiveError(const NumericalScalar maximumObjectiveError);
/** Maximum constraint error accessor */
NumericalScalar getMaximumConstraintError() const;
void setMaximumConstraintError(const NumericalScalar maximumConstraintError);
/** String converter */
virtual String __repr__() const;
/** Verbose accessor */
Bool getVerbose() const;
void setVerbose(const Bool verbose);
} ; /* class BoundConstrainedAlgorithm */
} /* namespace Optim */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_BOUNDCONSTRAINEDALGORITHM_HXX */
|