ROL_TrustRegion_U_Types.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_TYPES_HPP
#define ROL_TRUSTREGION_U_TYPES_HPP

namespace ROL {

  enum ETrustRegionU{
    TRUSTREGION_U_CAUCHYPOINT = 0,
    TRUSTREGION_U_TRUNCATEDCG,
    TRUSTREGION_U_SPG,
    TRUSTREGION_U_DOGLEG,
    TRUSTREGION_U_DOUBLEDOGLEG,
    TRUSTREGION_U_LAST
  };

  inline std::string ETrustRegionUToString(ETrustRegionU tr) {
    std::string retString;
    switch(tr) {
      case TRUSTREGION_U_CAUCHYPOINT:   retString = "Cauchy Point";        break;
      case TRUSTREGION_U_TRUNCATEDCG:   retString = "Truncated CG";        break;
      case TRUSTREGION_U_SPG:           retString = "SPG";                 break;
      case TRUSTREGION_U_DOGLEG:        retString = "Dogleg";              break;
      case TRUSTREGION_U_DOUBLEDOGLEG:  retString = "Double Dogleg";       break;
      case TRUSTREGION_U_LAST:          retString = "Last Type (Dummy)";   break;
      default:                          retString = "INVALID ETrustRegionU";
    }
    return retString;
  }

  inline int isValidTrustRegionU(ETrustRegionU ls){
    return( (ls == TRUSTREGION_U_CAUCHYPOINT)  ||
            (ls == TRUSTREGION_U_TRUNCATEDCG)  ||
            (ls == TRUSTREGION_U_SPG)          ||
            (ls == TRUSTREGION_U_DOGLEG)       ||
            (ls == TRUSTREGION_U_DOUBLEDOGLEG)
          );
  }

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

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

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

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

  inline ETrustRegionU StringToETrustRegionU(std::string s) {
    s = removeStringFormat(s);
    for ( ETrustRegionU tr = TRUSTREGION_U_CAUCHYPOINT; tr < TRUSTREGION_U_LAST; tr++ ) {
      if ( !s.compare(removeStringFormat(ETrustRegionUToString(tr))) ) {
        return tr;
      }
    }
    return TRUSTREGION_U_CAUCHYPOINT;
  }
} // ROL

#endif