ConstrainedOptPack_MeritFuncNLPL1.hpp

// @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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MERIT_FUNC_NLP_L1_H
#define MERIT_FUNC_NLP_L1_H

#include "ConstrainedOptPack_MeritFuncNLP.hpp"
#include "ConstrainedOptPack_MeritFuncNLPDirecDeriv.hpp"
#include "ConstrainedOptPack_MeritFuncPenaltyParam.hpp"

namespace ConstrainedOptPack {

class MeritFuncNLPL1
  : public MeritFuncNLP
  , public MeritFuncNLPDirecDeriv
  , public MeritFuncPenaltyParam
{
public:

  MeritFuncNLPL1();


  MeritFuncNLP& operator=(const MeritFuncNLP&);
  value_type value(
    value_type             f
    ,const Vector    *c
    ,const Vector    *h
    ,const Vector    *hl
    ,const Vector    *hu
    ) const;
  value_type deriv() const;
  void print_merit_func(
    std::ostream& out, const std::string& leading_str ) const;



  value_type calc_deriv(
    const Vector    &Gf_k
    ,const Vector   *c_k
    ,const Vector   *h_k
    ,const Vector   *hl
    ,const Vector   *hu
    ,const Vector   &d_k
    );



  void mu(value_type mu);

  value_type mu() const;


private:
  value_type deriv_;
  value_type mu_;

};  // end class MeritFuncNLPL1

} // end namespace ConstrainedOptPack

#endif  // MERIT_FUNC_NLP_L1_H