source/inc/numeric/penalty.hxx

Go to the documentation of this file.
00001 /*************************************************************************
00002  *
00003  *  The Contents of this file are made available subject to
00004  *  the terms of GNU Lesser General Public License Version 2.1.
00005  *
00006  *
00007  *    GNU Lesser General Public License Version 2.1
00008  *    =============================================
00009  *    Copyright 2008 by Kohei Yoshida.
00010  *    1039 Kingsway Dr., Apex, NC 27502, USA
00011  *
00012  *    This library is free software; you can redistribute it and/or
00013  *    modify it under the terms of the GNU Lesser General Public
00014  *    License version 2.1, as published by the Free Software Foundation.
00015  *
00016  *    This library is distributed in the hope that it will be useful,
00017  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019  *    Lesser General Public License for more details.
00020  *
00021  *    You should have received a copy of the GNU Lesser General Public
00022  *    License along with this library; if not, write to the Free Software
00023  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
00024  *    MA  02111-1307  USA
00025  *
00026  ************************************************************************/
00027 
00028 #ifndef _SCSOLVER_NUMERIC_PENALTY_HXX_
00029 #define _SCSOLVER_NUMERIC_PENALTY_HXX_
00030 
00031 #include "numeric/funcobj.hxx"
00032 #include <memory>
00033 
00034 namespace scsolver { namespace numeric { namespace nlp {
00035 
00036 class Model;
00037 struct PenaltyImpl;
00038 
00039 class Penalty : public ::scsolver::numeric::BaseFuncObj
00040 {
00041 public:
00042     Penalty();
00043     Penalty(const Penalty& r);
00044     virtual ~Penalty();
00045 
00046     virtual double eval();
00047     virtual const ::std::string getFuncString() const;
00048 
00056     void initFromModel(Model* pModel);
00057 
00067     void setConstraintFactor(double factor);
00068 
00069 private:
00070     ::std::auto_ptr<PenaltyImpl> mpImpl;
00071 };
00072 
00073 }}}
00074 
00075 
00076 #endif

Generated on Mon Jul 28 09:13:20 2008 for scsolver by  doxygen 1.5.3