PLearn 0.1
OptionsOracle.h
Go to the documentation of this file.
00001 
00002 // -*- C++ -*-
00003 
00004 // OptionsOracle.h
00005 //
00006 // Copyright (C) 2003-2004 ApSTAT Technologies Inc.
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 // Author: Pascal Vincent
00037 
00038 /* *******************************************************
00039  * $Id: OptionsOracle.h 5677 2006-05-25 23:43:50Z lamblin $
00040  ******************************************************* */
00041 
00043 #ifndef OptionsOracle_INC
00044 #define OptionsOracle_INC
00045 
00046 #include <plearn/base/Object.h>
00047 #include <plearn/math/TMat.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 
00053 class OptionsOracle: public Object
00054 {
00055     typedef Object inherited;
00056 
00057 protected:
00058     // *********************
00059     // * protected options *
00060     // *********************
00061 
00062     // ### declare protected option fields (such as learnt parameters) here
00063     // ...
00064 
00065 public:
00066 
00067     // ************************
00068     // * public build options *
00069     // ************************
00070 
00071     // This is an abstract base class. Not much in ways of build options here...
00072 
00073     // ****************
00074     // * Constructors *
00075     // ****************
00076 
00077     // Default constructor, make sure the implementation in the .cc
00078     // initializes all fields to reasonable default values.
00079     OptionsOracle();
00080 
00081 
00082     // ******************
00083     // * Object methods *
00084     // ******************
00085 
00086 private:
00088     // (Please implement in .cc)
00089     void build_();
00090 
00091 protected:
00093     // (Please implement in .cc)
00094     static void declareOptions(OptionList& ol);
00095 
00096 public:
00097 
00100     virtual TVec<string>  getOptionNames() const =0;
00101 
00109     virtual TVec<string> generateNextTrial(const TVec<string>& older_trial, real obtained_objective) =0;
00110 
00112     virtual void forget() =0;
00113 
00114     inline TVec<string> generateFirstTrial()
00115     {
00116         forget();
00117         return generateNextTrial(TVec<string>(), FLT_MAX);
00118     }
00119 
00120     // simply calls inherited::build() then build_()
00121     virtual void build();
00122 
00124     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00125 
00127     PLEARN_DECLARE_ABSTRACT_OBJECT(OptionsOracle);
00128 
00129 };
00130 
00131 // Declares a few other classes and functions related to this class
00132 DECLARE_OBJECT_PTR(OptionsOracle);
00133 
00134 } // end of namespace PLearn
00135 
00136 #endif
00137 
00138 
00139 /*
00140   Local Variables:
00141   mode:c++
00142   c-basic-offset:4
00143   c-file-style:"stroustrup"
00144   c-file-offsets:((innamespace . 0)(inline-open . 0))
00145   indent-tabs-mode:nil
00146   fill-column:79
00147   End:
00148 */
00149 // 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