PLearn 0.1
Experiment.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // Experiment.h
00004 // 
00005 // Copyright (C) 2002 Pascal Vincent, Frederic Morin
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: Experiment.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00040 #ifndef Experiment_INC
00041 #define Experiment_INC
00042 
00043 #include <plearn/base/Object.h>
00044 #include <plearn_learners/generic/Learner.h>
00045 #include <plearn/vmat/VMat.h>
00046 #include <plearn/vmat/Splitter.h>
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 class Experiment: public Object
00052 {    
00053 public:
00054 
00055     typedef Object inherited;
00056 
00057     // ************************
00058     // * public build options *
00059     // ************************
00060   
00061     // See declareOptions method in .cc for the role of these options.
00062 
00064     string expdir;  
00065     PP<Learner> learner;
00066     VMat dataset;
00067     PP<Splitter> splitter;
00068     bool save_models;
00069     bool save_initial_models;
00070     bool save_test_outputs;
00071     bool save_test_costs;
00072 
00073     // ****************
00074     // * Constructors *
00075     // ****************
00076 
00077     // Default constructor
00078     Experiment();
00079 
00080 
00081     // ******************
00082     // * Object methods *
00083     // ******************
00084 
00085 private: 
00087     // (Please implement in .cc)
00088     void build_();
00089 
00090 protected: 
00092     // (Please implement in .cc)
00093     static void declareOptions(OptionList& ol);
00094 
00095 public:
00096     // simply calls inherited::build() then build_() 
00097     virtual void build();
00098 
00100     PLEARN_DECLARE_OBJECT(Experiment);
00101 
00103     virtual void run();
00104 
00105 };
00106 
00107 // Declares a few other classes and functions related to this class
00108 DECLARE_OBJECT_PTR(Experiment);
00109   
00110 } // end of namespace PLearn
00111 
00112 #endif
00113 
00114 
00115 /*
00116   Local Variables:
00117   mode:c++
00118   c-basic-offset:4
00119   c-file-style:"stroustrup"
00120   c-file-offsets:((innamespace . 0)(inline-open . 0))
00121   indent-tabs-mode:nil
00122   fill-column:79
00123   End:
00124 */
00125 // 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