ConstrainedOptPack_QPOPT_CppDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER
//
// C declarations for QPSOL functions.  These declarations should not have to change
// for different platforms.  As long as the fortran object code uses capitalized
// names for its identifers then the declarations in Teuchos_F77_wrappers.h should be
// sufficent for portability.

#ifndef QPOPT_CPP_DECL_H
#define QPOPT_CPP_DECL_H

#include "Teuchos_F77_wrappers.h"

namespace QPOPT_CppDecl {

// Declarations that will link to the fortran object file.
// These may change for different platforms

using FortranTypes::f_int;      // INTEGER
using FortranTypes::f_real;     // REAL
using FortranTypes::f_dbl_prec;   // DOUBLE PRECISION
using FortranTypes::f_logical;    // LOGICAL

// /////////////////////////////////////////////////////////////////////////

typedef FORTRAN_FUNC_PTR_DECL_UL_(void,QPHESS_FUNC,qphess_func) ( const f_int& N, const f_int& LDH
  , const f_int& JTHCOL, const f_dbl_prec* HESS, const f_dbl_prec* X, f_dbl_prec* HX
  , f_int* IW, const f_int& LENIW, f_dbl_prec* W, const f_int& LENW );

void qpopt(
  const f_int& N, const f_int& NCLIN
  ,const f_int& LDA, const f_int& LDH, const f_dbl_prec* A
  ,const f_dbl_prec* BL, const f_dbl_prec* BU, const f_dbl_prec* CVEC
  ,const f_dbl_prec* H, FORTRAN_NAME_UL_(QPHESS_FUNC,qphess_func) QPHESS, f_int* ISTATE, f_dbl_prec* X
  ,f_int& INFORM, f_int& ITER, f_dbl_prec& OBJ, f_dbl_prec* AX
  ,f_dbl_prec* CLAMDA, f_int* IW, const f_int& LENIW, f_dbl_prec* W
  ,const f_int& LENW
  );

// //////////////////////////////////////////////////////////
// Enumerations for QPOPT options

enum EQPOPT_problem_type {
    FP                = 1,
    LP                = 2,
    QP1               = 3,
    QP2               = 4,
    QP3               = 5,
    QP4               = 6
};

enum EQPOPT_int_option {
    CHECK_FREQUENCY         = 1,
    EXPAND_FREQUENCY        = 2,
    FEASIBILITY_PHASE_ITER_LIMIT  = 3,
    OPTIMALITY_PHASE_ITER_LIMIT   = 4,
    HESSIAN_ROWS          = 5,
    ITERATION_LIMIT         = 6,
    MAXIMUM_DEGREES_OF_FREEDOM    = 7,
    PRINT_FILE            = 8,
    PRINT_LEVEL           = 9,
    PROBLEM_TYPE          = 10, // Use EQPOPT_problem_type
    SUMMARY_FILE          = 11
};


enum EQPOPT_logical_option {
    WARM_START            = 1,
    LIST              = 2,
    MIN_SUM             = 3
};

enum EQPOPT_real_option {
    CRASH_TOLERANCE         = 1,
    FEASIBILITY_TOLERANCE     = 2,
    INFINITE_BOUND_SIZE       = 3,
    INFINITE_STEP_SIZE        = 4,
    OPTIMALITY_TOLERANCE      = 5,
    RANK_TOLERANCE          = 6
};

// ///////////////////////////////////////////////////////////
// C++ functions for setting QPOPT options.

void reset_defaults();

void set_int_option(EQPOPT_int_option option, const f_int&);

void set_logical_option(EQPOPT_logical_option option, const f_logical&);

void set_real_option(EQPOPT_real_option option, const f_dbl_prec&);

// ////////////////////////////////////////////////////
// Declarations to link with Fortran QPSOL procedures

namespace Fortran {
extern "C" {

FORTRAN_FUNC_DECL_UL(void,QPOPT,qpopt) ( const f_int& N, const f_int& NCLIN
  , const f_int& LDA, const f_int& LDH, const f_dbl_prec* A
  , const f_dbl_prec* BL, const f_dbl_prec* BU, const f_dbl_prec* CVEC
  , const f_dbl_prec* H, FORTRAN_NAME_UL_(QPHESS_FUNC,qphess_func) QPHESS, f_int* ISTATE, f_dbl_prec* X
  , f_int& INFORM, f_int& ITER, f_dbl_prec& OBJ, f_dbl_prec* AX
  , f_dbl_prec* CLAMDA, f_int* IW, const f_int& LENIW, f_dbl_prec* W
  , const f_int& LENW );

FORTRAN_FUNC_DECL_UL(void,QPHESS,qphess) ( const f_int& N, const f_int& LDH
  , const f_int& JTHCOL, const f_dbl_prec* H, const f_dbl_prec* X, f_dbl_prec* HX
  , f_int* IW, const f_int& LENIW, f_dbl_prec* W, const f_int& LENW );

FORTRAN_FUNC_DECL_UL_(void,QPOPT_SET_DEFAULTS,qpopt_set_defaults) ();

FORTRAN_FUNC_DECL_UL_(void,QPOPT_INT_OPT,qpopt_int_opt) (const f_int& option, const f_int& );

FORTRAN_FUNC_DECL_UL_(void,QPOPT_LOG_OPT,qpopt_log_opt) (const f_int& option, const f_logical& );

FORTRAN_FUNC_DECL_UL_(void,QPOPT_REAL_OPT,qpopt_real_opt) (const f_int& option, const f_dbl_prec& );

} // end extern "C"
} // end namespace Fortran

// ///////////////////////////////////////////////////////////////////////////////
// Inline definitions.

inline
void qpopt( const f_int& N, const f_int& NCLIN
  , const f_int& LDA, const f_int& LDH, const f_dbl_prec* A
  , const f_dbl_prec* BL, const f_dbl_prec* BU, const f_dbl_prec* CVEC
  , const f_dbl_prec* H, FORTRAN_NAME_UL_(QPHESS_FUNC,qphess_func) QPHESS, f_int* ISTATE, f_dbl_prec* X
  , f_int& INFORM, f_int& ITER, f_dbl_prec& OBJ, f_dbl_prec* AX
  , f_dbl_prec* CLAMDA, f_int* IW, const f_int& LENIW, f_dbl_prec* W
  , const f_int& LENW )
{
  Fortran::FORTRAN_FUNC_CALL_UL(QPOPT,qpopt) ( N, NCLIN, LDA, LDH, A, BL, BU, CVEC, H, QPHESS
    , ISTATE, X, INFORM, ITER, OBJ, AX, CLAMDA, IW, LENIW, W, LENW );
}

inline
void reset_defaults()
{ Fortran::FORTRAN_FUNC_CALL_UL_(QPOPT_SET_DEFAULTS,qpopt_set_defaults) (); }

inline
void set_int_option(EQPOPT_int_option option, const f_int& val)
{ Fortran::FORTRAN_FUNC_CALL_UL_(QPOPT_INT_OPT,qpopt_int_opt) ( option, val ); }

inline
void set_logical_option(EQPOPT_logical_option option, const f_logical& val)
{ Fortran::FORTRAN_FUNC_CALL_UL_(QPOPT_LOG_OPT,qpopt_log_opt) ( option, val ); }

inline
void set_real_option(EQPOPT_real_option option, const f_dbl_prec& val)
{ Fortran::FORTRAN_FUNC_CALL_UL_(QPOPT_REAL_OPT,qpopt_real_opt) ( option, val ); }


} // end namespace QPOPT_CppDecl

#endif // QPOPT_CPP_DECL_H