class Match

(Return to index)

Matching block.

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.

Type:	Instantiable
Include file:	./Match/Match.hh

Synopsis (including inherited members):

• Public members:
  • Match () ;
  • ~Match () ;
  • void addVariable (AbstractVar*) ;
  • void deleteVariable (const string&) ;
  • AbstractVar* findVariable (const string&) ;
  • void getVariables (Vector<double>&)const ;
  • void setVariables (const Vector<double>&) ;
  • int countVariables ()const ;
  • void addFunction (AbstractFun*) ;
  • bool evaluate (const Vector<double>&,Vector<double>&) ;
  • void getFunctions (Vector<double>&)const ;
  • int countFunctions ()const ;
  • void print (const char*,MatchState) ;
  • int getPrintLevel ()const ;
  • void setPrintLevel (int) ;
  • int getCallCount ()const ;
  • MatchParser parser ;
  • static Match* block ;
  • typedef std::list<AbstractVar*> VarList ;
  • typedef std::list<AbstractFun*> FunList ;

Documentation:

• Public members:

  Match () ;

  Constructor.

  void addFunction (AbstractFun*) ;

  Add a set of matching function(s).

  void addVariable (AbstractVar*) ;

  Add a matching variable.

  static Match* block ;

  The block of match data.

  int countFunctions ()const ;

  Return total number of functions.

  int countVariables ()const ;

  Get total number of variables.

  void deleteVariable (const string&) ;

  Delete a matching variable.
  Identified by name.

  bool evaluate (const Vector<double>&,Vector<double>&) ;

  Evaluate the matching functions.
  Set the matching variables to x, cache the function values, and return them in f. The boolean return value indicates success (true) or failure (false).

  AbstractVar* findVariable (const string&) ;

  Find a matching variable.
  Identified by name.

  int getCallCount ()const ;

  Return count of function evaluations.

  void getFunctions (Vector<double>&)const ;

  Get cached values of matching functions.

  int getPrintLevel ()const ;

  Get the flag for printing.

  void getVariables (Vector<double>&)const ;

  Get values of matching variables.

  MatchParser parser ;

  The parser used during for matching.

  void print (const char*,MatchState) ;

  Print the results of minimisation.

  void setPrintLevel (int) ;

  Set the flag for printing.

  void setVariables (const Vector<double>&) ;

  Set values of matching variables.