Match.h

Go to the documentation of this file.

#ifndef OPAL_Match_HH
#define OPAL_Match_HH 1

// ------------------------------------------------------------------------
// $RCSfile: Match.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class Match
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:44 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------

#include "Match/MatchParser.h"
#include "Match/MatchState.h"
#include <string>
#include <list>

class AbstractFun;
class AbstractVar;
class MatchParser;

template <class T> class Vector;


// Class Match
// ------------------------------------------------------------------------
//  This class encapsulates all data for matching which do not depend
//  on the matching method.
//  It acts as a communication area between the various matching commands.

class Match {

public:

    Match();

    ~Match();

    void addVariable(AbstractVar *);

    //  Identified by name.
    void deleteVariable(const std::string &name);

    //  Identified by name.
    AbstractVar *findVariable(const std::string &name);

    void getVariables(Vector<double> &x) const;

    void setVariables(const Vector<double> &x);

    int countVariables() const;

    void addFunction(AbstractFun *);

    //  Set the matching variables to  [b]x[/b], cache the function values,
    //  and return them in  [b]f[/b].  The boolean return value indicates
    //  success (true) or failure (false).
    bool evaluate(const Vector<double> &x, Vector<double> &f);

    void getFunctions(Vector<double> &f) const;

    int countFunctions() const;

    void print(const char *method, MatchState state);

    int getPrintLevel() const;

    void setPrintLevel(int);

    int getCallCount() const;

    MatchParser parser;

    static Match *block;

private:

    // Not implemented.
    Match(const Match &);
    void operator=(const Match &);

    // The list of access functions to variables.
    typedef std::list<AbstractVar *> VarList;
    VarList theVariables;

    // The list of matching functions.
    typedef std::list<AbstractFun *> FunList;
    FunList theFunctions;

    // Counter for matched values.
    int constraintCount;

    // Counter for functions calls.
    int callCount;

    // The flag for printing.
    int printLevel;
};

#endif // OPAL_Match_HH