PLearn 0.1
HyperCommand.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // HyperCommand.h
00004 //
00005 // Copyright (C) 2003-2004 ApSTAT Technologies Inc.
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 // Author: Pascal Vincent
00036 
00037 /* *******************************************************
00038  * $Id: HyperCommand.h 9171 2008-06-26 15:27:22Z chapados $
00039  ******************************************************* */
00040 
00042 #ifndef HyperCommand_INC
00043 #define HyperCommand_INC
00044 
00045 #include <plearn/base/Object.h>
00046 #include <plearn_learners/generic/PLearner.h>
00047 #include <plearn/io/PPath.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class HyperLearner;
00053 class VecStatsCollector;
00054 
00055 class HyperCommand: public Object
00056 {
00057 
00058 private:
00059 
00060     typedef Object inherited;
00061 
00062 protected:
00063 
00064     HyperLearner* hlearner;   
00065     PPath expdir; 
00066 
00067 public:
00068 
00069     PLEARN_DECLARE_ABSTRACT_OBJECT(HyperCommand);
00070 
00076     int verbosity; 
00077 
00078     // ****************
00079     // * Constructors *
00080     // ****************
00081 
00082     // Default constructor, make sure the implementation in the .cc
00083     // initializes all fields to reasonable default values.
00084     HyperCommand();
00085 
00086     // ******************
00087     // * Object methods *
00088     // ******************
00089 
00090 private:
00091 
00093     void build_();
00094 
00095 protected:
00096 
00098     static void declareOptions(OptionList& ol);
00099 
00101     static void declareMethods(RemoteMethodMap& rmm);
00102 
00103 public:
00104     // simply calls inherited::build() then build_()
00105     virtual void build();
00106 
00108     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00109 
00110     void setHyperLearner(HyperLearner* the_hlearner)
00111     { hlearner = the_hlearner; }
00112 
00113     virtual void setExperimentDirectory(const PPath& the_expdir);
00114 
00115     PPath getExperimentDirectory() const
00116     { return expdir; }
00117 
00120     virtual void forget();
00121 
00124     virtual Vec optimize() =0;
00125 
00127     virtual TVec<string> getResultNames() const =0;
00128 
00129 };
00130 
00131 // Declares a few other classes and functions related to this class
00132 DECLARE_OBJECT_PTR(HyperCommand);
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