PLearn 0.1
PerformanceEvaluator.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PerformanceEvaluator.cc
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 #include "PerformanceEvaluator.h"
00041 
00042 namespace PLearn {
00043 using namespace std;
00044 
00045 PLEARN_IMPLEMENT_ABSTRACT_OBJECT(
00046     PerformanceEvaluator,
00047     "Evaluates the performance of a learner given a testset VMat and the learner's corresponding output VMat",
00048     "Subclasses of this class are mainly designed to be plugged in a PTester, \n"
00049     "and allow to carry 'performance evaluations' that aren't just \n"
00050     "simple statistics of the test-costs computed by the learner. \n"
00051     "Indeed a PerformanceEvaluator has at its disposal the whole testset, \n"
00052     "and the whole corresponding learner output, and will also be passed a \n"
00053     "results directory in which it can create files such as performance curves, etc... \n"
00054     "Since it also receives a pointer to the trained PLearner, a specialized \n"
00055     "PerformanceEvaluator may even inspect learner-specific options and call learner-specific methods. \n"
00056     );
00057 
00058 PerformanceEvaluator::PerformanceEvaluator()
00059 {}
00060 
00061 void PerformanceEvaluator::build()
00062 {
00063     inherited::build();
00064     build_();
00065 }
00066 
00067 void PerformanceEvaluator::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00068 {
00069     inherited::makeDeepCopyFromShallowCopy(copies);
00070 }
00071 
00072 void PerformanceEvaluator::declareOptions(OptionList& ol)
00073 {
00074     // ### Declare all of this object's options here.
00075     // ### For the "flags" of each option, you should typically specify
00076     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00077     // ### OptionBase::tuningoption. If you don't provide one of these three,
00078     // ### this option will be ignored when loading values from a script.
00079     // ### You can also combine flags, for example with OptionBase::nosave:
00080     // ### (OptionBase::buildoption | OptionBase::nosave)
00081 
00082     // ### ex:
00083     // declareOption(ol, "myoption", &PerformanceEvaluator::myoption,
00084     //               OptionBase::buildoption,
00085     //               "Help text describing this option");
00086     // ...
00087 
00088     // Now call the parent class' declareOptions
00089     inherited::declareOptions(ol);
00090 }
00091 
00092 void PerformanceEvaluator::build_()
00093 {}
00094 
00095 
00096 } // end of namespace PLearn
00097 
00098 
00099 /*
00100   Local Variables:
00101   mode:c++
00102   c-basic-offset:4
00103   c-file-style:"stroustrup"
00104   c-file-offsets:((innamespace . 0)(inline-open . 0))
00105   indent-tabs-mode:nil
00106   fill-column:79
00107   End:
00108 */
00109 // 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