ROL_LineSearch_U_Factory.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) 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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef ROL_LINESEARCH_U_FACTORY_H
#define ROL_LINESEARCH_U_FACTORY_H

#include "ROL_IterationScaling_U.hpp"
#include "ROL_PathBasedTargetLevel_U.hpp"
#include "ROL_BackTracking_U.hpp"
#include "ROL_CubicInterp_U.hpp"
#include "ROL_ScalarMinimizationLineSearch_U.hpp"

namespace ROL {
template<typename Real>
inline Ptr<LineSearch_U<Real>> LineSearchUFactory(ParameterList &parlist) {
  ELineSearchU els = StringToELineSearchU(
    parlist.sublist("Step").sublist("Line Search").sublist("Line-Search Method").get("Type","Cubic Interpolation"));
  switch(els) {
    case LINESEARCH_U_ITERATIONSCALING:     return makePtr<IterationScaling_U<Real>>(parlist);
    case LINESEARCH_U_PATHBASEDTARGETLEVEL: return makePtr<PathBasedTargetLevel_U<Real>>(parlist);
    case LINESEARCH_U_BACKTRACKING:         return makePtr<BackTracking_U<Real>>(parlist);
    case LINESEARCH_U_CUBICINTERP:          return makePtr<CubicInterp_U<Real>>(parlist);
    case LINESEARCH_U_BRENTS:
    case LINESEARCH_U_GOLDENSECTION:
    case LINESEARCH_U_BISECTION:            return makePtr<ScalarMinimizationLineSearch_U<Real>>(parlist);
    default:                                return nullPtr;
  }
}
} // namespace ROL

#endif