PLearn 0.1
PerformanceEvaluator.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PerformanceEvaluator.h
00004 //
00005 // Copyright (C) 2006 Pascal Vincent
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 // Authors: Pascal Vincent
00036 
00040 #ifndef PerformanceEvaluator_INC
00041 #define PerformanceEvaluator_INC
00042 
00043 #include <plearn/base/Object.h>
00044 #include <plearn/base/PP.h>
00045 #include <plearn/vmat/VMat.h>
00046 #include <plearn_learners/generic/PLearner.h>
00047 
00048 namespace PLearn {
00049 
00062 class PerformanceEvaluator : public Object
00063 {
00064     typedef Object inherited;
00065 
00066 public:
00067     //#####  Public Build Options  ############################################
00068 
00071 
00072 public:
00073     //#####  Public Member Functions  #########################################
00074 
00076     // ### Make sure the implementation in the .cc
00077     // ### initializes all fields to reasonable default values.
00078     PerformanceEvaluator();
00079 
00081     virtual TVec<string> getCostNames() const = 0;
00082 
00087     virtual Vec evaluatePerformance(PP<PLearner> learner, VMat testset, VMat learner_output, PPath resultsdir) const = 0;
00088 
00089     //#####  PLearn::Object Protocol  #########################################
00090 
00091     // Declares other standard object methods.
00092     PLEARN_DECLARE_ABSTRACT_OBJECT(PerformanceEvaluator);
00093 
00094     // Simply calls inherited::build() then build_()
00095     virtual void build();
00096 
00098     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00099 
00100 protected:
00101     //#####  Protected Options  ###############################################
00102 
00103 protected:
00104     //#####  Protected Member Functions  ######################################
00105 
00107     static void declareOptions(OptionList& ol);
00108 
00109 private:
00110     //#####  Private Member Functions  ########################################
00111 
00113     void build_();
00114 
00115 private:
00116     //#####  Private Data Members  ############################################
00117 
00118     // The rest of the private stuff goes here
00119 };
00120 
00121 // Declares a few other classes and functions related to this class
00122 DECLARE_OBJECT_PTR(PerformanceEvaluator);
00123 
00124 } // end of namespace PLearn
00125 
00126 #endif
00127 
00128 
00129 /*
00130   Local Variables:
00131   mode:c++
00132   c-basic-offset:4
00133   c-file-style:"stroustrup"
00134   c-file-offsets:((innamespace . 0)(inline-open . 0))
00135   indent-tabs-mode:nil
00136   fill-column:79
00137   End:
00138 */
00139 // 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