PLearn 0.1
TMatTest.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // TMatTest.h
00004 //
00005 // Copyright (C) 2005-2006 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: .pyskeleton_header 544 2003-09-01 00:05:31Z plearner $ 
00037    ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef TMatTest_INC
00045 #define TMatTest_INC
00046 
00047 #include <plearn/misc/PTest.h>
00048 
00049 namespace PLearn {
00050 
00061 class TMatTest : public PTest
00062 {
00063     typedef PTest inherited;
00064 
00065 public:
00066     //#####  Public Build Options  ############################################
00067 
00068     // ### declare public option fields (such as build options) here
00069     // Start your comments with Doxygen-compatible comments such as //!
00070     // ### Typically, a PTest options are used to store the test results.
00071 
00072     real bound;
00073     int mat_length;
00074     int mat_width;
00075     int vec_length;
00076 
00077 public:
00078     //#####  Public Member Functions  #########################################
00079 
00081     // ### Make sure the implementation in the .cc
00082     // ### initializes all fields to reasonable default values.
00083     TMatTest();
00084 
00085     // Your other public member functions go here
00086     
00087     
00088     //#####  PLearn::Object Protocol  #########################################
00089 
00090     // Declares other standard object methods.
00091     // ### If your class is not instantiatable (it has pure virtual methods)
00092     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 
00093     PLEARN_DECLARE_OBJECT(TMatTest);
00094 
00095     // Simply calls inherited::build() then build_() 
00096     virtual void build();
00097 
00099     // (PLEASE IMPLEMENT IN .cc)
00100     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00101 
00102     //#####  PLearn::PTest Protocol  ##########################################
00103 
00106     virtual void perform();
00107 
00108 protected:
00109     //#####  Protected Options  ###############################################
00110 
00111     // ### Declare protected option fields (such as learned parameters) here
00112     // ...
00113 
00114     map<string, Mat>  mat_options;
00115     map<string, real> real_options;
00116     map<string, Vec>  vec_options;
00117     
00118 protected:
00119     //#####  Protected Member Functions  ######################################
00120     
00122     // (PLEASE IMPLEMENT IN .cc)
00123     static void declareOptions(OptionList& ol);
00124 
00125 private: 
00126     //#####  Private Member Functions  ########################################
00127 
00129     // (PLEASE IMPLEMENT IN .cc)
00130     void build_();
00131 
00132 private:
00133     //#####  Private Data Members  ############################################
00134 
00135     // The rest of the private stuff goes here
00136 };
00137 
00138 // Declares a few other classes and functions related to this class
00139 DECLARE_OBJECT_PTR(TMatTest);
00140   
00141 } // end of namespace PLearn
00142 
00143 #endif
00144 
00145 
00146 /*
00147   Local Variables:
00148   mode:c++
00149   c-basic-offset:4
00150   c-file-style:"stroustrup"
00151   c-file-offsets:((innamespace . 0)(inline-open . 0))
00152   indent-tabs-mode:nil
00153   fill-column:79
00154   End:
00155 */
00156 // 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