ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/utils/Utility.hpp
(Generate patch)

Comparing:
trunk/src/utils/Utility.hpp (file contents), Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
branches/development/src/utils/Utility.hpp (file contents), Revision 1465 by chuckv, Fri Jul 9 23:08:25 2010 UTC

# Line 1 | Line 1
1 < /*
1 > /*
2   * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3   *
4   * The University of Notre Dame grants you ("Licensee") a
# Line 6 | Line 6
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
9 > * 1. Redistributions of source code must retain the above copyright
10   *    notice, this list of conditions and the following disclaimer.
11   *
12 < * 3. Redistributions in binary form must reproduce the above copyright
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.
# Line 37 | Line 28
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]  Vardeman & Gezelter, in progress (2009).                        
40   */
41  
42   #ifndef UTILS_UTILITY_HPP
43   #define UTILS_UTILITY_HPP
44   #include <vector>
45   #include <math.h>
46 + #include "config.h"
47   #include "utils/next_combination.hpp"
48  
49 < namespace oopse {
50 < inline double roundMe( double x ){
51 <  return ( x >= 0 ) ? floor( x + 0.5 ) : ceil( x - 0.5 );
52 < }
49 > namespace OpenMD {
50 >  inline RealType roundMe( RealType x ){
51 >    return ( x >= 0 ) ? floor( x + 0.5 ) : ceil( x - 0.5 );
52 >  }
53  
54 < /**
55 < * @brief iteratively replace the sequence with wild cards
56 < * @return true if more combination sequence is avaliable, otherwise return true
57 < * @param cont iterator container, if expect the whole series of combinations,  pass an empty iterator
58 < * container. The user should not modify this iterator container
59 < * @param sequence the whole sequence used to generate combination
60 < * @param result a possible combination sequence which is set on return
61 < * @param wildCard the wild card string. Its value is "X" by default
62 < * @note since next_combination never returns an empty sequence, replaceWildCard will not generate
63 < * one special combination, which is n identical wild cards (n is equal to the size of the passing sequence)
64 < *
65 < * @code
66 < * std::vector<std::string> sv;
67 < * std::vector<std::vector<std::string>::iterator> sic;
68 < * std::vector<std::string> resultString;
69 < * sv.push_back("H");
70 < * sv.push_back("C");
71 < * sv.push_back("N");
54 >  /**
55 >   * @brief iteratively replace the sequence with wild cards
56 >   * @return true if more combination sequence is avaliable, otherwise return true
57 >   * @param cont iterator container, if expect the whole series of combinations,  pass an empty iterator
58 >   * container. The user should not modify this iterator container
59 >   * @param sequence the whole sequence used to generate combination
60 >   * @param result a possible combination sequence which is set on return
61 >   * @param wildCard the wild card string. Its value is "X" by default
62 >   * @note since next_combination never returns an empty sequence, replaceWildCard will not generate
63 >   * one special combination, which is n identical wild cards (n is equal to the size of the passing sequence)
64 >   *
65 >   * @code
66 >   * std::vector<std::string> sv;
67 >   * std::vector<std::vector<std::string>::iterator> sic;
68 >   * std::vector<std::string> resultString;
69 >   * sv.push_back("H");
70 >   * sv.push_back("C");
71 >   * sv.push_back("N");
72  
73 < * while (replaceWithWildCard(sic, sv, resultString)) {  
74 < *     for(std::vector<std::string>::iterator i = resultString.begin(); i != resultString.end(); ++i) {
75 < *         std::cout << *i << "\t";
76 < *     }
77 < *     std::cout << std::endl;
78 < * }
79 < * //output
80 < * //H X X
81 < * //X C X
82 < * //X X N
83 < * //H C X
84 < * //H X N
85 < * //X C N
86 < * //H C N
87 < * @endcode
88 < */
89 < bool replaceWithWildCard(std::vector<std::vector<std::string>::iterator>& cont,
90 <                                             std::vector<std::string>& sequence, std::vector<std::string>& result, const std::string& wildCard = "X");
73 >   * while (replaceWithWildCard(sic, sv, resultString)) {  
74 >   *     for(std::vector<std::string>::iterator i = resultString.begin(); i != resultString.end(); ++i) {
75 >   *         std::cout << *i << "\t";
76 >   *     }
77 >   *     std::cout << std::endl;
78 >   * }
79 >   * //output
80 >   * //H X X
81 >   * //X C X
82 >   * //X X N
83 >   * //H C X
84 >   * //H X N
85 >   * //X C N
86 >   * //H C N
87 >   * @endcode
88 >   */
89 >  bool replaceWithWildCard(std::vector<std::vector<std::string>::iterator>& cont,
90 >                           std::vector<std::string>& sequence, std::vector<std::string>& result, const std::string& wildCard = "X");
91   }
92   #endif
93  

Comparing:
trunk/src/utils/Utility.hpp (property svn:keywords), Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
branches/development/src/utils/Utility.hpp (property svn:keywords), Revision 1465 by chuckv, Fri Jul 9 23:08:25 2010 UTC

# Line 0 | Line 1
1 + Author Id Revision Date

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines