src/optimization/OptimizationFactory.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 OPTIMIZATION_OPTIMIZATIONFACTORY_HPP
#define OPTIMIZATION_OPTIMIZATIONFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>
#include <iostream>
#include "optimization/Method.hpp"

using namespace QuantLib;
namespace OpenMD {

  //forward declaration
  class QuantLib::OptimizationMethod;
  class OptimizationCreator;
  class SimInfo;
  /**
   * @class OptimizationFactory
   * Factory pattern and Singleton Pattern are used to define an interface for creating an Optimization.
   */
  class OptimizationFactory {
  public:
                
    typedef std::map<std::string, OptimizationCreator*> CreatorMapType;
    typedef std::vector<std::string> IdentVectorType;
    typedef std::vector<std::string>::iterator IdentVectorIterator;

    ~OptimizationFactory();
                    
    /**
     * Returns an instance of Optimization factory
     * @return an instance of Optimization factory
     */        
    static OptimizationFactory* getInstance() {

      if (instance_ == NULL) {
        instance_ = new OptimizationFactory();
      }
      return instance_;
            
    }

    /**
     * Registers a creator with a type identifier
     * @return true if registration is succeed, otherwise return false
     * @id the identification of the concrete object
     * @creator the object responsible to create the concrete object 
     */
    bool registerOptimization(OptimizationCreator* creator);

    /**
     * Unregisters the creator for the given type identifier. If the type identifier 
     * was previously registered, the function returns true.
     * @return truethe type identifier was previously registered and the creator is removed,
     * otherwise return false
     * @id the identification of the concrete object
     */
    bool unregisterOptimization(const std::string& id);
    /**
     * Looks up the type identifier in the internal map. If it is found, it invokes the
     * corresponding creator for the type identifier and returns its result. 
     * @return a pointer of the concrete object, return NULL if no creator is registed for 
     * creating this concrete object
     * @param id the identification of the concrete object
     */
    QuantLib::OptimizationMethod* createOptimization(const std::string& id, SimInfo* info);

    /** 
     *  Returns all of the registed  type identifiers
     * @return all of the registed  type identifiers
     */
    IdentVectorType getIdents();
        
  private:
    OptimizationFactory() {}
        
    static OptimizationFactory* instance_;
    CreatorMapType creatorMap_;
  };

  /** write out all of the type identifiers to an output stream */
  std::ostream& operator <<(std::ostream& o, OptimizationFactory& factory);

}//namespace OpenMD
#endif //OPTIMIZATIONS_OPTIMIZATIONFACTORY_HPP

Revision:	1741
Committed:	Tue Jun 5 18:02:44 2012 UTC (12 years, 10 months ago) by gezelter
File size:	4989 byte(s)
Log Message:	Adding initial import of optimization library
#	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 OPTIMIZATION_OPTIMIZATIONFACTORY_HPP
44	#define OPTIMIZATION_OPTIMIZATIONFACTORY_HPP
45	#include <cassert>
46	#include <map>
47	#include <string>
48	#include <vector>
49	#include <iostream>
50	#include "optimization/Method.hpp"
51
52	using namespace QuantLib;
53	namespace OpenMD {
54
55	//forward declaration
56	class QuantLib::OptimizationMethod;
57	class OptimizationCreator;
58	class SimInfo;
59	/**
60	* @class OptimizationFactory
61	* Factory pattern and Singleton Pattern are used to define an interface for creating an Optimization.
62	*/
63	class OptimizationFactory {
64	public:
65
66	typedef std::map<std::string, OptimizationCreator*> CreatorMapType;
67	typedef std::vector<std::string> IdentVectorType;
68	typedef std::vector<std::string>::iterator IdentVectorIterator;
69
70	~OptimizationFactory();
71
72	/**
73	* Returns an instance of Optimization factory
74	* @return an instance of Optimization factory
75	*/
76	static OptimizationFactory* getInstance() {
77
78	if (instance_ == NULL) {
79	instance_ = new OptimizationFactory();
80	}
81	return instance_;
82
83	}
84
85	/**
86	* Registers a creator with a type identifier
87	* @return true if registration is succeed, otherwise return false
88	* @id the identification of the concrete object
89	* @creator the object responsible to create the concrete object
90	*/
91	bool registerOptimization(OptimizationCreator* creator);
92
93	/**
94	* Unregisters the creator for the given type identifier. If the type identifier
95	* was previously registered, the function returns true.
96	* @return truethe type identifier was previously registered and the creator is removed,
97	* otherwise return false
98	* @id the identification of the concrete object
99	*/
100	bool unregisterOptimization(const std::string& id);
101	/**
102	* Looks up the type identifier in the internal map. If it is found, it invokes the
103	* corresponding creator for the type identifier and returns its result.
104	* @return a pointer of the concrete object, return NULL if no creator is registed for
105	* creating this concrete object
106	* @param id the identification of the concrete object
107	*/
108	QuantLib::OptimizationMethod* createOptimization(const std::string& id, SimInfo* info);
109
110	/**
111	* Returns all of the registed type identifiers
112	* @return all of the registed type identifiers
113	*/
114	IdentVectorType getIdents();
115
116	private:
117	OptimizationFactory() {}
118
119	static OptimizationFactory* instance_;
120	CreatorMapType creatorMap_;
121	};
122
123	/** write out all of the type identifiers to an output stream */
124	std::ostream& operator <<(std::ostream& o, OptimizationFactory& factory);
125
126	}//namespace OpenMD
127	#endif //OPTIMIZATIONS_OPTIMIZATIONFACTORY_HPP
128