src/selection/SelectionEvaluator.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#ifndef SELECTION_SELECTIONEVALUATOR_HPP
#define SELECTION_SELECTIONEVALUATOR_HPP

#include <map>
#include <string>
#include <vector>
#include <fstream>

#include "brains/SimInfo.hpp"
#include "selection/SelectionToken.hpp"
#include "selection/SelectionCompiler.hpp"
#include "selection/NameFinder.hpp"
#include "selection/DistanceFinder.hpp"
#include "selection/HullFinder.hpp"
#include "selection/IndexFinder.hpp"
#include "utils/OpenMDBitSet.hpp"
#include "primitives/StuntDouble.hpp"
#include "utils/StringUtils.hpp"
namespace OpenMD {


  /**
   * @class SelectionEvaluator SelectionEvaluator.hpp "selection/SelectionEvaluator"
   * @brief Evalute the tokens compiled by SelectionCompiler and return a OpenMDBitSet
   */
  class SelectionEvaluator{
  public:

    SelectionEvaluator(SimInfo* info);

    bool loadScriptString(const std::string& script);
    bool loadScriptFile(const std::string& filename);
        
    OpenMDBitSet evaluate();
    OpenMDBitSet evaluate(int frame);
        
    /**
     * Tests if the result from evaluation of script is dynamic.
     */         
    bool isDynamic() {
      return isDynamic_;
    }

    bool hadRuntimeError() const{
      return error;
    }

    std::string getErrorMessage() const {
      return errorMessage;
    }


    int getLinenumber() {
      return linenumbers[pc];
    }

    std::string getLine() {
      int ichBegin = lineIndices[pc];
      int ichEnd;
      if ((ichEnd = script.find('\r', ichBegin)) == std::string::npos &&
          (ichEnd = script.find('\n', ichBegin)) == std::string::npos) {
        ichEnd = script.size();
      }            
      return script.substr(ichBegin, ichEnd);
    }
  
  private:

    void clearState();
        
    bool loadScript(const std::string& filename, const std::string& script); 

    bool loadScriptFileInternal(const std::string& filename);


    void clearDefinitionsAndLoadPredefined();
         
    void define();
    void select(OpenMDBitSet& bs);
    void select(OpenMDBitSet& bs, int frame);
    void predefine(const std::string& script);

    void instructionDispatchLoop(OpenMDBitSet& bs);
    void instructionDispatchLoop(OpenMDBitSet& bs, int frame);

    void withinInstruction(const Token& instruction, OpenMDBitSet& bs);
    void withinInstruction(const Token& instruction, OpenMDBitSet& bs, int frame);
    OpenMDBitSet allInstruction();
        
    OpenMDBitSet comparatorInstruction(const Token& instruction); 
    OpenMDBitSet comparatorInstruction(const Token& instruction, int frame); 
    void compareProperty(StuntDouble* sd, OpenMDBitSet& bs, int property, int comparator, float comparisonValue);
    void compareProperty(StuntDouble* sd, OpenMDBitSet& bs, int property, int comparator, float comparisonValue, int frame);
    OpenMDBitSet nameInstruction(const std::string& name);
    OpenMDBitSet indexInstruction(const boost::any& value);
    OpenMDBitSet expression(const std::vector<Token>& tokens, int pc);
    OpenMDBitSet expression(const std::vector<Token>& tokens, int pc, int frame);

    OpenMDBitSet lookupValue(const std::string& variable);

    OpenMDBitSet hull();
    OpenMDBitSet hull(int frame);
        
    void evalError(const std::string& message) {
      sprintf( painCave.errMsg,
               "SelectionEvaluator Error: %s\n", message.c_str());
      painCave.severity = OPENMD_ERROR;
      painCave.isFatal = 1;
      simError();
    }

    void unrecognizedCommand(const Token& token) {
      evalError("unrecognized command:" + boost::any_cast<std::string>(token.value));
    }        

    void unrecognizedExpression() {
      evalError("unrecognized expression");
    }

    void unrecognizedAtomProperty(int property){
      evalError("unrecognized atom property");
    }

    void unrecognizedIdentifier(const std::string& identifier) {
      evalError("unrecognized identifier:" + identifier);
    }    

    void invalidIndexRange(std::pair<int, int> range) {
      evalError("invalid index range: [" + toString(range.first) + ", " + toString(range.second) + ")");
    }

    void invalidIndex(int index) {
      evalError("invalid index : " + toString(index) );
    }

        
    bool containDynamicToken(const std::vector<Token>& tokens);

    RealType getCharge(Atom* atom);
    RealType getCharge(Atom* atom, int frame);
        
    SelectionCompiler compiler;

    //const static int scriptLevelMax = 10;
    //int scriptLevel;

    //Context stack[scriptLevelMax];

    std::string filename;
    std::string script;
    std::vector<int> linenumbers;
    std::vector<int> lineIndices;
    std::vector<std::vector<Token> > aatoken;
    unsigned int pc; // program counter

    bool error;
    std::string errorMessage;

    std::vector<Token> statement;
    int statementLength;

    SimInfo* info;
    NameFinder nameFinder;
    DistanceFinder distanceFinder;
    HullFinder hullFinder;
    IndexFinder indexFinder;
    int nStuntDouble;   //nGLOBALatoms + nGLOBALrigidbodies

    typedef std::map<std::string, boost::any > VariablesType;
    VariablesType variables;

    bool isDynamic_;
    bool isLoaded_;
        
  };

}
#endif
Revision:	1831
Committed:	Thu Jan 10 14:06:34 2013 UTC (12 years, 3 months ago) by gezelter
File size:	7295 byte(s)
Log Message:	Merging trunk changes 1812:1830 into development branch.
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* The University of Notre Dame grants you ("Licensee") a
5	* non-exclusive, royalty free, license to use, modify and
6	* redistribute this software in source and binary code form, provided
7	* that the following conditions are met:
8	*
9	* 1. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the
15	* distribution.
16	*
17	* This software is provided "AS IS," without a warranty of any
18	* kind. All express or implied conditions, representations and
19	* warranties, including any implied warranty of merchantability,
20	* fitness for a particular purpose or non-infringement, are hereby
21	* excluded. The University of Notre Dame and its licensors shall not
22	* be liable for any damages suffered by licensee as a result of
23	* using, modifying or distributing the software or its
24	* derivatives. In no event will the University of Notre Dame or its
25	* licensors be liable for any lost revenue, profit or data, or for
26	* direct, indirect, special, consequential, incidental or punitive
27	* damages, however caused and regardless of the theory of liability,
28	* arising out of the use of or inability to use software, even if the
29	* University of Notre Dame has been advised of the possibility of
30	* such damages.
31	*
32	* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33	* research, please cite the appropriate papers when you publish your
34	* work. Good starting points are:
35	*
36	* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37	* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	*/
42
43	#ifndef SELECTION_SELECTIONEVALUATOR_HPP
44	#define SELECTION_SELECTIONEVALUATOR_HPP
45
46	#include <map>
47	#include <string>
48	#include <vector>
49	#include <fstream>
50
51	#include "brains/SimInfo.hpp"
52	#include "selection/SelectionToken.hpp"
53	#include "selection/SelectionCompiler.hpp"
54	#include "selection/NameFinder.hpp"
55	#include "selection/DistanceFinder.hpp"
56	#include "selection/HullFinder.hpp"
57	#include "selection/IndexFinder.hpp"
58	#include "utils/OpenMDBitSet.hpp"
59	#include "primitives/StuntDouble.hpp"
60	#include "utils/StringUtils.hpp"
61	namespace OpenMD {
62
63
64	/**
65	* @class SelectionEvaluator SelectionEvaluator.hpp "selection/SelectionEvaluator"
66	* @brief Evalute the tokens compiled by SelectionCompiler and return a OpenMDBitSet
67	*/
68	class SelectionEvaluator{
69	public:
70
71	SelectionEvaluator(SimInfo* info);
72
73	bool loadScriptString(const std::string& script);
74	bool loadScriptFile(const std::string& filename);
75
76	OpenMDBitSet evaluate();
77	OpenMDBitSet evaluate(int frame);
78
79	/**
80	* Tests if the result from evaluation of script is dynamic.
81	*/
82	bool isDynamic() {
83	return isDynamic_;
84	}
85
86	bool hadRuntimeError() const{
87	return error;
88	}
89
90	std::string getErrorMessage() const {
91	return errorMessage;
92	}
93
94
95	int getLinenumber() {
96	return linenumbers[pc];
97	}
98
99	std::string getLine() {
100	int ichBegin = lineIndices[pc];
101	int ichEnd;
102	if ((ichEnd = script.find('\r', ichBegin)) == std::string::npos &&
103	(ichEnd = script.find('\n', ichBegin)) == std::string::npos) {
104	ichEnd = script.size();
105	}
106	return script.substr(ichBegin, ichEnd);
107	}
108
109	private:
110
111	void clearState();
112
113	bool loadScript(const std::string& filename, const std::string& script);
114
115	bool loadScriptFileInternal(const std::string& filename);
116
117
118	void clearDefinitionsAndLoadPredefined();
119
120	void define();
121	void select(OpenMDBitSet& bs);
122	void select(OpenMDBitSet& bs, int frame);
123	void predefine(const std::string& script);
124
125	void instructionDispatchLoop(OpenMDBitSet& bs);
126	void instructionDispatchLoop(OpenMDBitSet& bs, int frame);
127
128	void withinInstruction(const Token& instruction, OpenMDBitSet& bs);
129	void withinInstruction(const Token& instruction, OpenMDBitSet& bs, int frame);
130	OpenMDBitSet allInstruction();
131
132	OpenMDBitSet comparatorInstruction(const Token& instruction);
133	OpenMDBitSet comparatorInstruction(const Token& instruction, int frame);
134	void compareProperty(StuntDouble* sd, OpenMDBitSet& bs, int property, int comparator, float comparisonValue);
135	void compareProperty(StuntDouble* sd, OpenMDBitSet& bs, int property, int comparator, float comparisonValue, int frame);
136	OpenMDBitSet nameInstruction(const std::string& name);
137	OpenMDBitSet indexInstruction(const boost::any& value);
138	OpenMDBitSet expression(const std::vector<Token>& tokens, int pc);
139	OpenMDBitSet expression(const std::vector<Token>& tokens, int pc, int frame);
140
141	OpenMDBitSet lookupValue(const std::string& variable);
142
143	OpenMDBitSet hull();
144	OpenMDBitSet hull(int frame);
145
146	void evalError(const std::string& message) {
147	sprintf( painCave.errMsg,
148	"SelectionEvaluator Error: %s\n", message.c_str());
149	painCave.severity = OPENMD_ERROR;
150	painCave.isFatal = 1;
151	simError();
152	}
153
154	void unrecognizedCommand(const Token& token) {
155	evalError("unrecognized command:" + boost::any_cast<std::string>(token.value));
156	}
157
158	void unrecognizedExpression() {
159	evalError("unrecognized expression");
160	}
161
162	void unrecognizedAtomProperty(int property){
163	evalError("unrecognized atom property");
164	}
165
166	void unrecognizedIdentifier(const std::string& identifier) {
167	evalError("unrecognized identifier:" + identifier);
168	}
169
170	void invalidIndexRange(std::pair<int, int> range) {
171	evalError("invalid index range: [" + toString(range.first) + ", " + toString(range.second) + ")");
172	}
173
174	void invalidIndex(int index) {
175	evalError("invalid index : " + toString(index) );
176	}
177
178
179	bool containDynamicToken(const std::vector<Token>& tokens);
180
181	RealType getCharge(Atom* atom);
182	RealType getCharge(Atom* atom, int frame);
183
184	SelectionCompiler compiler;
185
186	//const static int scriptLevelMax = 10;
187	//int scriptLevel;
188
189	//Context stack[scriptLevelMax];
190
191	std::string filename;
192	std::string script;
193	std::vector<int> linenumbers;
194	std::vector<int> lineIndices;
195	std::vector<std::vector<Token> > aatoken;
196	unsigned int pc; // program counter
197
198	bool error;
199	std::string errorMessage;
200
201	std::vector<Token> statement;
202	int statementLength;
203
204	SimInfo* info;
205	NameFinder nameFinder;
206	DistanceFinder distanceFinder;
207	HullFinder hullFinder;
208	IndexFinder indexFinder;
209	int nStuntDouble; //nGLOBALatoms + nGLOBALrigidbodies
210
211	typedef std::map<std::string, boost::any > VariablesType;
212	VariablesType variables;
213
214	bool isDynamic_;
215	bool isLoaded_;
216
217	};
218
219	}
220	#endif