/usr/include/Bpp/Numeric/Function/OneDimensionOptimizationTools.h is in libbpp-core-dev 2.1.0-1.
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 | //
// File: OneDimensionOptimizationTools.h
// Created by: Julien Dutheil
// Created on: Mon Nov 17 11:15:22 2003
//
/*
Copyright or © or Copr. CNRS, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for numerical calculus. This file is part of the Bio++ project.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _ONEDIMENSIONOPTIMIZATIONTOOLS_H_
#define _ONEDIMENSIONOPTIMIZATIONTOOLS_H_
#include "Functions.h"
#include "DirectionFunction.h"
#include "../../Io/OutputStream.h"
namespace bpp
{
class BracketPoint
{
public:
double x;
double f;
public: // Constructor and destructor:
BracketPoint(): x(0), f(0) {}
BracketPoint(double xval, double fval): x(xval), f(fval) {}
virtual ~BracketPoint() {}
public:
void set(double x, double f);
};
class Bracket
{
public: // Constructor and destructor::
Bracket(): a(), b(), c() {}
virtual ~Bracket() {}
public: // Methods:
void setA(double xa, double fa);
void setB(double xb, double fb);
void setC(double xc, double fc);
public:
BracketPoint a, b, c;
};
/**
* @brief Tools of one parameter-functions optimizations.
*
* For now, contains only one method to bracket a minimum.
*/
class OneDimensionOptimizationTools
{
public:
OneDimensionOptimizationTools() {}
virtual ~OneDimensionOptimizationTools() {}
public:
/**
* @brief Bracket a minimum.
*
* Given a function func, and given distinct initial points x1 and x2,
* this routine searches in the downhill direction (defined by the function as
* evaluated at the initial points) and returns a Bracket object with new points
* a.x, b.x and c.x that bracket a minimum of the function. Also returned are the
* function values at the three points, a.f, b.f and c.f.
*
* @param a, b Two initial values for the parameter.
* @param function The function to bracket.
* @param parameters The parameter to use as a variable.
* @return A bracket object.
*/
static Bracket bracketMinimum(double a, double b, Function* function, ParameterList parameters);
static unsigned int lineMinimization(DirectionFunction& f1dim, ParameterList& parameters, std::vector<double>& xi, double tolerance, OutputStream* profiler = 0, OutputStream* messenger = 0, int verbose = 2);
/**
* @brief Search a 'sufficiently low' value for a function in a given direction.
*
* This function performs a similar computation as the lnsrch function defined at page 385 of
*
* <pre>
* NUMERICAL RECIPES IN C: THE ART OF SCIENTIFIC COMPUTING
* (ISBN 0-521-43108-5)
* </pre>
*
* without the stpmax argument, since the steps are bounded in another way.
*/
static unsigned int lineSearch(DirectionFunction& f1dim, ParameterList& parameters, std::vector<double>& xi, std::vector<double>& gradient, OutputStream* profiler = 0, OutputStream* messenger = 0, int verbose = 2);
public:
/**
* @brief Maximum magnification allowed for a parabolic-fit step.
*/
static double GLIMIT;
};
} //end of namespace bpp.
#endif //_ONEDIMENSIONOPTIMIZATIONTOOLS_H_
|