/usr/include/trilinos/GlobiPack_BrentsLineSearch_decl.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
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 147 148 149 | /*
// @HEADER
// ***********************************************************************
//
// GlobiPack: Collection of Scalar 1D globalizaton utilities
// Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// 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, 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
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
//
// ***********************************************************************
// @HEADER
*/
#ifndef GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
#define GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
#include "GlobiPack_LineSearchBase.hpp"
#include "GlobiPack_GoldenQuadInterpBracket.hpp"
#include "GlobiPack_Brents1DMinimization.hpp"
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
namespace GlobiPack {
/** \brief Linesearch subclass implementing a function-value-only approximate
* minimization algorithm using bracketing and then Brent's 1D minimization
* method.
*
* This lineserach class is designed for more accurate linesearches and it
* will march forward (as well as backward) from the given initial guess for
* the step length in order to find it. This linesearch is therefore more
* appropriate for optimization algorithms like steppest decent and nonlinear
* CG what require more accurate linesearches and where the scaling of the
* step is not well know. Also, this linesearch likely satisifies the Strong
* Wolf Conditions but there are not checks for this at all so in the end it
* may not.
*
* ToDo: Finish Documentation!
*/
template<typename Scalar>
class BrentsLineSearch
: public LineSearchBase<Scalar>,
protected Teuchos::ParameterListAcceptorDefaultBase
{
public:
/** \name Constructor/Initializers/Accessors */
//@{
/** \brief Construct with default parameters. */
BrentsLineSearch();
/** \brief For unit testing only . */
const GoldenQuadInterpBracket<Scalar>& bracket() const;
/** \brief For unit testing only . */
const Brents1DMinimization<Scalar>& brentsMin() const;
//@}
/** @name Overridden from ParameterListAcceptor (simple forwarding functions) */
//@{
/** \brief . */
void setParameterList(RCP<ParameterList> const& paramList);
/** \brief . */
RCP<const ParameterList> getValidParameters() const;
//@}
/** \name Overrridden from LineSearchBase. */
//@{
/** \brief Returns true. */
virtual bool requiresBaseDeriv() const;
/** \brief Returns false. */
virtual bool requiresDerivEvals() const;
/** \brief . */
virtual bool doLineSearch(
const MeritFunc1DBase<Scalar> &phi,
const PointEval1D<Scalar> &point_k,
const Ptr<PointEval1D<Scalar> > &point_kp1,
const Ptr<int> &numIters
) const;
//@}
private:
// //////////////////////
// Private data members
GoldenQuadInterpBracket<Scalar> bracket_;
Brents1DMinimization<Scalar> brentsMin_;
};
/** \brief Nonmember constructor.
*
* \relates BrentsLineSearch
*/
template<typename Scalar>
const RCP<BrentsLineSearch<Scalar> > brentsLineSearch()
{
return Teuchos::rcp(new BrentsLineSearch<Scalar>());
}
// Default values are exposed here for unit testing purposes
namespace BrentsLineSearchUtils {
const std::string bracket_name = "Bracket";
const std::string minimize_name = "Minimize";
} // namespace BrentsLineSearchUtils
} // namespace GlobiPack
#endif // GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
|