source/inc/numeric/nlpmodel.hxx

Go to the documentation of this file.

/*************************************************************************
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Kohei Yoshida.
 *    1039 Kingsway Dr., Apex, NC 27502, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    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
 *
 ************************************************************************/

#ifndef _NUMERIC_OPRES_NLP_NLPMODEL_HXX_
#define _NUMERIC_OPRES_NLP_NLPMODEL_HXX_

#include "numeric/type.hxx"
#include <memory>
#include <string>
#include <vector>

namespace scsolver { namespace numeric {
    class BaseFuncObj;
}}

namespace scsolver { namespace numeric { namespace nlp {

class ModelImpl;
class BaseAlgorithm;

struct Constraint
{
    BaseFuncObj*    FuncObj;
    EqualityType    Equality;
    double          RightValue;

    explicit Constraint(BaseFuncObj* pFunc, EqualityType eq, double rightValue);
private:
    Constraint();
};

// ============================================================================

class Model
{
public:
    Model();
    Model( const Model& );
    ~Model() throw();

    void print() const;

    void setPrecision(unsigned long n);

    unsigned long getPrecision() const;

    void setGoal(scsolver::numeric::GoalType goal);

    scsolver::numeric::GoalType getGoal() const;

    void setVerbose(bool b);

    bool getVerbose() const;

    void setFuncObject(BaseFuncObj* pFuncObj);

    BaseFuncObj* getFuncObject() const;

    void pushVar( double var );

    void getVars( ::std::vector<double>& vars ) const;

    double getVarBound( size_t index, BoundType bound ) const;

    void setVarBound( size_t index, BoundType bound, double value );

    bool isVarBounded( size_t index, BoundType bound ) const;

    void pushConstraint(BaseFuncObj* pFunc, EqualityType eq, double rightValue);

    const ::std::vector<Constraint>& getAllConstraints() const;

private:
    ::std::auto_ptr<ModelImpl> m_pImpl;
};


}}}


#endif

---