ROL_TrustRegion_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_TRUSTREGION_U_FACTORY_HPP
#define ROL_TRUSTREGION_U_FACTORY_HPP

#include "ROL_TrustRegion_U_Types.hpp"
#include "ROL_CauchyPoint_U.hpp"
#include "ROL_DogLeg_U.hpp"
#include "ROL_DoubleDogLeg_U.hpp"
#include "ROL_TruncatedCG_U.hpp"
#include "ROL_SPGTrustRegion_U.hpp"

namespace ROL {
  template<typename Real>
  inline Ptr<TrustRegion_U<Real>> TrustRegionUFactory(ParameterList &list) {
    ETrustRegionU etr = StringToETrustRegionU(
      list.sublist("Step").sublist("Trust Region").get("Subproblem Solver","Dogleg"));
    switch(etr) {
      case TRUSTREGION_U_CAUCHYPOINT:  return makePtr<CauchyPoint_U<Real>>();
      case TRUSTREGION_U_DOGLEG:       return makePtr<DogLeg_U<Real>>();
      case TRUSTREGION_U_DOUBLEDOGLEG: return makePtr<DoubleDogLeg_U<Real>>();
      case TRUSTREGION_U_TRUNCATEDCG:  return makePtr<TruncatedCG_U<Real>>(list);
      case TRUSTREGION_U_SPG:          return makePtr<SPGTrustRegion_U<Real>>(list);
      default:                         return nullPtr;
    }
  }
} // ROL

#endif