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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */

#ifndef SELECTION_SELECTIONEVALUATOR_HPP
#define SELECTION_SELECTIONEVALUATOR_HPP

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

#include "brains/SimInfo.hpp"
#include "selection/Token.hpp"
#include "selection/SelectionCompiler.hpp"
#include "utils/BitSet.hpp"

namespace oopse {

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

        SelectionEvaluator(SimInfo* info, const std::string& script);

        BitSet evaluate();
        
        BitSet evaluate(int frameNo);

        /**
         * Tests if the result from evaluation of script is static.
         * @return true if the result keeps the same even the frame change, otherwise return false
         */         
        bool isStatic();
        
    private:

        /** */
        void define();

        /** */
        void predefine();

        withinInstruction(Token instruction, BitSet , BitSet);

        BitSet expression(std::vector<Token>& tokens, int pc);
        
        SimInfo* info_;

        std::map<std::string, std::vector<Token> > variables_;
        std::string script_;
};

}
#endif
Revision:	1961
Committed:	Tue Feb 1 06:55:00 2005 UTC (19 years, 5 months ago) by tim
File size:	3312 byte(s)
Log Message:	adding selection library
#	User	Rev	Content
1	tim	1961	/*
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. Acknowledgement of the program authors must be made in any
10			* publication of scientific results based in part on use of the
11			* program. An acceptable form of acknowledgement is citation of
12			* the article in which the program was described (Matthew
13			* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14			* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15			* Parallel Simulation Engine for Molecular Dynamics,"
16			* J. Comput. Chem. 26, pp. 252-271 (2005))
17			*
18			* 2. Redistributions of source code must retain the above copyright
19			* notice, this list of conditions and the following disclaimer.
20			*
21			* 3. Redistributions in binary form must reproduce the above copyright
22			* notice, this list of conditions and the following disclaimer in the
23			* documentation and/or other materials provided with the
24			* distribution.
25			*
26			* This software is provided "AS IS," without a warranty of any
27			* kind. All express or implied conditions, representations and
28			* warranties, including any implied warranty of merchantability,
29			* fitness for a particular purpose or non-infringement, are hereby
30			* excluded. The University of Notre Dame and its licensors shall not
31			* be liable for any damages suffered by licensee as a result of
32			* using, modifying or distributing the software or its
33			* derivatives. In no event will the University of Notre Dame or its
34			* licensors be liable for any lost revenue, profit or data, or for
35			* direct, indirect, special, consequential, incidental or punitive
36			* damages, however caused and regardless of the theory of liability,
37			* arising out of the use of or inability to use software, even if the
38			* University of Notre Dame has been advised of the possibility of
39			* such damages.
40			*/
41
42			#ifndef SELECTION_SELECTIONEVALUATOR_HPP
43			#define SELECTION_SELECTIONEVALUATOR_HPP
44
45			#include <map>
46			#include <string>
47			#include <vector>
48
49			#include "brains/SimInfo.hpp"
50			#include "selection/Token.hpp"
51			#include "selection/SelectionCompiler.hpp"
52			#include "utils/BitSet.hpp"
53
54			namespace oopse {
55
56			/**
57			* @class SelectionEvaluator SelectionEvaluator.hpp "selection/SelectionEvaluator"
58			* @brief Evalute the tokens compiled by SelectionCompiler and return a BitSet
59			*/
60			class SelectionEvaluator{
61			public:
62
63			SelectionEvaluator(SimInfo* info, const std::string& script);
64
65			BitSet evaluate();
66
67			BitSet evaluate(int frameNo);
68
69			/**
70			* Tests if the result from evaluation of script is static.
71			* @return true if the result keeps the same even the frame change, otherwise return false
72			*/
73			bool isStatic();
74
75			private:
76
77			/** */
78			void define();
79
80			/** */
81			void predefine();
82
83			withinInstruction(Token instruction, BitSet , BitSet);
84
85			BitSet expression(std::vector<Token>& tokens, int pc);
86
87			SimInfo* info_;
88
89			std::map<std::string, std::vector<Token> > variables_;
90			std::string script_;
91			};
92
93			}
94			#endif