PLearn 0.1
OptimizeOptionOracle.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // OptimizeOptionOracle.h
00004 //
00005 // Copyright (C) 2004 Olivier Delalleau
00006 //
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 //
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 //
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 //
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 //
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 //
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 /* *******************************************************
00036  * $Id: OptimizeOptionOracle.h 6863 2007-04-09 20:15:52Z saintmlx $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00043 #ifndef OptimizeOptionOracle_INC
00044 #define OptimizeOptionOracle_INC
00045 
00046 #include <plearn_learners/hyper/OptionsOracle.h>
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 class OptimizeOptionOracle: public OptionsOracle
00052 {
00053 
00054 private:
00055 
00056     typedef OptionsOracle inherited;
00057 
00058 protected:
00059 
00060     // *********************
00061     // * protected options *
00062     // *********************
00063 
00064     string current_direction;
00065     real best;
00066     real best_objective;
00067     real lower_bound;
00068     int n_steps;
00069     real upper_bound;
00070 
00071 public:
00072 
00073     // ************************
00074     // * public build options *
00075     // ************************
00076 
00077     real factor;
00078     int max_steps;
00079     real max_value;
00080     real min_value;
00081     real relative_precision;
00082     string option;
00083     string start_direction;
00084     real start_value;
00085 
00086     // ****************
00087     // * Constructors *
00088     // ****************
00089 
00090     // Default constructor, make sure the implementation in the .cc
00091     // initializes all fields to reasonable default values.
00092     OptimizeOptionOracle();
00093 
00094 
00095     // ******************
00096     // * OptionsOracle methods *
00097     // ******************
00098 
00099 private:
00100 
00102     void build_();
00103 
00104 protected:
00105 
00107     static void declareOptions(OptionList& ol);
00108 
00109 public:
00110 
00112     virtual TVec<string> getOptionNames() const;
00113     virtual TVec<string> generateNextTrial(const TVec<string>& older_trial, real obtained_objective);
00114     virtual void forget();
00115 
00116     // Simply calls inherited::build() then build_()
00117     virtual void build();
00118 
00120     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00121 
00123     PLEARN_DECLARE_OBJECT(OptimizeOptionOracle);
00124 
00125 };
00126 
00127 // Declares a few other classes and functions related to this class
00128 DECLARE_OBJECT_PTR(OptimizeOptionOracle);
00129 
00130 } // end of namespace PLearn
00131 
00132 #endif
00133 
00134 
00135 /*
00136   Local Variables:
00137   mode:c++
00138   c-basic-offset:4
00139   c-file-style:"stroustrup"
00140   c-file-offsets:((innamespace . 0)(inline-open . 0))
00141   indent-tabs-mode:nil
00142   fill-column:79
00143   End:
00144 */
00145 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines