PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // HorizonStatefulLearner.cc 00004 // 00005 // Copyright (C) 2004 Réjean Ducharme 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: HorizonStatefulLearner.cc 3994 2005-08-25 13:35:03Z chapados $ 00037 ******************************************************* */ 00038 00039 // Authors: Réjean Ducharme 00040 00044 #include "HorizonStatefulLearner.h" 00045 00046 namespace PLearn { 00047 using namespace std; 00048 00049 HorizonStatefulLearner::HorizonStatefulLearner() 00050 : inherited(), horizon(0) 00051 {} 00052 00053 PLEARN_IMPLEMENT_ABSTRACT_OBJECT( 00054 HorizonStatefulLearner, 00055 "Kind of StatefulLearner designed for forecasting at horizon h", 00056 "A HorizonStatefulLearner is a StatefulLearner designed for forecasting\n" 00057 "at horizon h. It serves as a base class for more specialized\n" 00058 "forecasters. Contrarily to StatefulLearner, the HorizonStatefulLearner\n" 00059 "introduces a few additional assumptions on the structure of the training\n" 00060 "set and the interpretation of the various test methods:\n" 00061 "\n" 00062 "- In the training set, it assumes that the inputs and targets are spaced\n" 00063 " apart by the forecasting horizon. Hence, for the inputs at row t, the\n" 00064 " targets are located at row t+horizon.\n" 00065 "\n" 00066 "- For computeOutputAndCosts (and friends), the inputs and outputs vector\n" 00067 " are FOR THE CURRENT TIME STEP, but the targets and costs correspond to\n" 00068 " the inputs/outputs that were horizon time steps IN THE PAST. This\n" 00069 " means that derived classes will usually have to keep a memory of the\n" 00070 " past \"horizon\" inputs and/or outputs in order to compute meaningful\n" 00071 " costs."); 00072 00073 void HorizonStatefulLearner::declareOptions(OptionList& ol) 00074 { 00075 declareOption( 00076 ol, "horizon", &HorizonStatefulLearner::horizon, 00077 OptionBase::buildoption, 00078 "Forecasting horizon for the learner; see detailed class help for\n" 00079 "interpretation. (Default value = 0)"); 00080 00081 inherited::declareOptions(ol); 00082 } 00083 00084 void HorizonStatefulLearner::build_() 00085 { 00086 if (horizon < 0) 00087 PLERROR("HorizonStatefulLearner::build_: horizon must be non-negative"); 00088 } 00089 00090 // ### Nothing to add here, simply calls build_ 00091 void HorizonStatefulLearner::build() 00092 { 00093 inherited::build(); 00094 build_(); 00095 } 00096 00097 void HorizonStatefulLearner::makeDeepCopyFromShallowCopy(CopiesMap& copies) 00098 { 00099 inherited::makeDeepCopyFromShallowCopy(copies); 00100 } 00101 00102 } // end of namespace PLearn 00103 00104 00105 /* 00106 Local Variables: 00107 mode:c++ 00108 c-basic-offset:4 00109 c-file-style:"stroustrup" 00110 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00111 indent-tabs-mode:nil 00112 fill-column:79 00113 End: 00114 */ 00115 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :