PLearn 0.1
UCISpecification.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // UCISpecification.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: UCISpecification.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef UCISpecification_INC
00045 #define UCISpecification_INC
00046 
00047 #include <plearn/base/Object.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class UCISpecification: public Object
00053 {
00054 
00055 private:
00056   
00057     typedef Object inherited;
00058 
00059 protected:
00060     // *********************
00061     // * protected options *
00062     // *********************
00063 
00064     // ### declare protected option fields (such as learnt parameters) here
00065     // ...
00066     
00067 public:
00068 
00069     // ************************
00070     // * public build options *
00071     // ************************
00072  
00073     bool header_exists;
00074     TVec<pair<int,int> > header_fields;
00075     PPath data_all;
00076     PPath data_test;
00077     PPath data_train;
00078     string file_all;
00079     string file_test;
00080     string file_train;
00081     string format;
00082     int inputsize;
00083     int targetsize;
00084     int weightsize;
00085     bool target_is_first;
00086 
00087     // ****************
00088     // * Constructors *
00089     // ****************
00090 
00092     // ### Make sure the implementation in the .cc
00093     // ### initializes all fields to reasonable default values.
00094     UCISpecification();
00095 
00096 
00097     // ******************
00098     // * Object methods *
00099     // ******************
00100 
00101 private: 
00103     // (PLEASE IMPLEMENT IN .cc)
00104     void build_();
00105 
00106 protected: 
00108     // (PLEASE IMPLEMENT IN .cc)
00109     static void declareOptions(OptionList& ol);
00110 
00111 public:
00112     // Declares other standard object methods.
00113     // ### If your class is not instantiatable (it has pure virtual methods)
00114     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
00115     PLEARN_DECLARE_OBJECT(UCISpecification);
00116 
00117     // simply calls inherited::build() then build_() 
00118     virtual void build();
00119 
00121     // (PLEASE IMPLEMENT IN .cc)
00122     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00123 
00124 };
00125 
00126 // Declares a few other classes and functions related to this class
00127 DECLARE_OBJECT_PTR(UCISpecification);
00128   
00129 } // end of namespace PLearn
00130 
00131 #endif
00132 
00133 
00134 /*
00135   Local Variables:
00136   mode:c++
00137   c-basic-offset:4
00138   c-file-style:"stroustrup"
00139   c-file-offsets:((innamespace . 0)(inline-open . 0))
00140   indent-tabs-mode:nil
00141   fill-column:79
00142   End:
00143 */
00144 // 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