ROL_TypeP_AlgorithmFactory.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_TYPEP_ALGORITHMFACTORY_H
#define ROL_TYPEP_ALGORITHMFACTORY_H

#include "ROL_TypeP_ProxGradientAlgorithm.hpp"
#include "ROL_TypeP_SpectralGradientAlgorithm.hpp"
#include "ROL_TypeP_iPianoAlgorithm.hpp"
#include "ROL_TypeP_QuasiNewtonAlgorithm.hpp"
#include "ROL_TypeP_TrustRegionAlgorithm.hpp"
#include "ROL_TypeP_InexactNewtonAlgorithm.hpp"
#include "ROL_Types.hpp"

namespace ROL {
namespace TypeP {

enum EAlgorithmP{
  ALGORITHM_P_LINESEARCH = 0,
  ALGORITHM_P_TRUSTREGION,
  ALGORITHM_P_SPECTRALGRADIENT,
  ALGORITHM_P_IPIANO,
  ALGORITHM_P_LAST
};

inline std::string EAlgorithmPToString(EAlgorithmP alg) {
  std::string retString;
  switch(alg) {
    case ALGORITHM_P_LINESEARCH:          retString = "Line Search";            break;
    case ALGORITHM_P_TRUSTREGION:         retString = "Trust Region";           break;
    case ALGORITHM_P_SPECTRALGRADIENT:    retString = "Spectral Gradient";      break;
    case ALGORITHM_P_IPIANO:              retString = "iPiano";                 break;
    case ALGORITHM_P_LAST:                retString = "Last Type (Dummy)";      break;
    default:                              retString = "INVALID EAlgorithmP";
  }
  return retString;
}

inline int isValidAlgorithmP(EAlgorithmP alg){
  return( (alg == ALGORITHM_P_LINESEARCH)          ||
          (alg == ALGORITHM_P_TRUSTREGION)         ||
          (alg == ALGORITHM_P_SPECTRALGRADIENT)    ||
          (alg == ALGORITHM_P_IPIANO)              ||
          (alg == ALGORITHM_P_LAST)
        );
}

inline EAlgorithmP & operator++(EAlgorithmP &type) {
  return type = static_cast<EAlgorithmP>(type+1);
}

inline EAlgorithmP operator++(EAlgorithmP &type, int) {
  EAlgorithmP oldval = type;
  ++type;
  return oldval;
}

inline EAlgorithmP & operator--(EAlgorithmP &type) {
  return type = static_cast<EAlgorithmP>(type-1);
}

inline EAlgorithmP operator--(EAlgorithmP &type, int) {
  EAlgorithmP oldval = type;
  --type;
  return oldval;
}

inline EAlgorithmP StringToEAlgorithmP(std::string s) {
  s = removeStringFormat(s);
  for ( EAlgorithmP alg = ALGORITHM_P_LINESEARCH; alg < ALGORITHM_P_LAST; alg++ ) {
    if ( !s.compare(removeStringFormat(EAlgorithmPToString(alg))) ) {
      return alg;
    }
  }
  return ALGORITHM_P_TRUSTREGION;
}

template<typename Real>
inline Ptr<Algorithm<Real>> AlgorithmFactory(ParameterList &parlist) {
  EAlgorithmP ealg = StringToEAlgorithmP(parlist.sublist("Step").get("Type","Trust Region"));
  switch(ealg) {
    case ALGORITHM_P_LINESEARCH:
    {
      std::string desc
        = parlist.sublist("Step").sublist("Line Search").sublist("Descent Method").get("Type","Newton-Krylov");
      if (desc=="Newton-Krylov" || desc=="Newton")
        return makePtr<InexactNewtonAlgorithm<Real>>(parlist);
      else if (desc=="Quasi-Newton Method" || desc = "Quasi-Newton")
        return makePtr<QuasiNewtonAlgorithm<Real>>(parlist);
      else
        return makePtr<ProxGradientAlgorithm<Real>>(parlist);
    }
    case ALGORITHM_P_TRUSTREGION:         return makePtr<TrustRegionAlgorithm<Real>>(parlist);
    case ALGORITHM_P_SPECTRALGRADIENT:    return makePtr<SpectralGradientAlgorithm<Real>>(parlist);
    case ALGORITHM_P_IPIANO:              return makePtr<iPianoAlgorithm<Real>>(parlist);
    default:                              return nullPtr;
  }
}
} // namespace TypeP
} // namespace ROL

#endif