NLPInterfacePack_NLPWBCounterExample.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

#ifndef NLP_WB_COUNTER_EXAMPLE_H
#define NLP_WB_COUNTER_EXAMPLE_H

#include "NLPInterfacePack_NLPSerialPreprocessExplJac.hpp"

namespace NLPInterfacePack {

class NLPWBCounterExample : public NLPSerialPreprocessExplJac {
public:


  NLPWBCounterExample(
    value_type   xinit[3]
    ,value_type   a                  = 0.0
    ,value_type   b                  = 1.0
    ,bool         nlp_selects_basis  = true
    ,bool         linear_obj         = true
    );



  void initialize(bool test_setup);
  bool is_initialized() const;
  value_type max_var_bounds_viol() const;


  
  bool nlp_selects_basis() const;


protected:


  bool imp_nlp_has_changed() const;
  size_type imp_n_orig() const;
  size_type imp_m_orig() const;
  size_type imp_mI_orig() const;
  const DVectorSlice imp_xinit_orig() const;
  bool imp_has_var_bounds() const;
  const DVectorSlice imp_xl_orig() const;
  const DVectorSlice imp_xu_orig() const;
  const DVectorSlice imp_hl_orig() const;
  const DVectorSlice imp_hu_orig() const;
  void imp_calc_f_orig(
    const DVectorSlice &x_full, bool newx, const ZeroOrderInfoSerial &zero_order_info ) const;
  void imp_calc_c_orig(
    const DVectorSlice &x_full, bool newx, const ZeroOrderInfoSerial &zero_order_info ) const;
  void imp_calc_h_orig(
    const DVectorSlice &x_full, bool newx, const ZeroOrderInfoSerial &zero_order_info ) const;
  void imp_calc_Gf_orig(
    const DVectorSlice &x_full, bool newx, const ObjGradInfoSerial &obj_grad_info ) const;
  bool imp_get_next_basis(
    IVector *var_perm_full, IVector *equ_perm_full, size_type *rank_full, size_type *rank );
  void imp_report_orig_final_solution(
    const DVectorSlice &x_orig, const DVectorSlice *lambda_orig
    ,const DVectorSlice *lambdaI_orig, const DVectorSlice *nu_orig, bool is_optimal );

  

  size_type imp_Gc_nz_orig() const;
  size_type imp_Gh_nz_orig() const;
  void imp_calc_Gc_orig(
    const DVectorSlice& x_full, bool newx, const FirstOrderExplInfo& first_order_expl_info ) const;
  void imp_calc_Gh_orig(
    const DVectorSlice& x_full, bool newx, const FirstOrderExplInfo& first_order_expl_info ) const;


private:

  // /////////////////////////////////////////
  // Private data members

  bool         is_initialized_;                 // Flag for if this is initialized
  bool         nlp_selects_basis_;              // Flag for if this selects first basis
  bool         basis_selection_was_given_;      // Flag for if this already selected a basis
  bool         linear_obj_;                     // Flag for if objective is linear or quadratic
  size_type    n_orig_, m_orig_, Gc_orig_nz_;   // NLP sizes and number nonzeros in Jacobian
  value_type   a_, b_;                          // Constants for constraints
  DVector      xinit_orig_, xl_orig_, xu_orig_; // Guess, and bounds on x_orig

  // /////////////////////////////////////////
  // Private member functions

  // Not defined and not to be called
  NLPWBCounterExample();
  NLPWBCounterExample(const NLPWBCounterExample&);
  NLPWBCounterExample& operator=(const NLPWBCounterExample&);

};  // end class NLPWBCounterExample

} // end namespace NLPInterfacePack

#endif  // NLP_WB_COUNTER_EXAMPLE_H