PLearn 0.1
CCCostVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
00007 // Copyright (C) 2002 Xiangdong Wang, Christian Dorion
00008 
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 // 
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 // 
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 // 
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 // 
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 // 
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 
00038 /* *******************************************************      
00039  * $Id: CCCostVariable.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef CCCostVariable_INC
00044 #define CCCostVariable_INC
00045 
00046 #include "NaryVariable.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00052 class CCCostVariable: public NaryVariable
00053 {
00054     typedef NaryVariable inherited;
00055   
00056 public:
00057   
00058     VMat distr;
00059     Func f_error;
00060     Func f_candidate;
00061     // To avoid allocation/deallocations in fprop/bprop
00062     Vec input_value;
00063     Vec input_gradient;
00064     Vec error_output_value;
00065     Vec candidate_output_value;
00066     Vec error_correlations;
00067     Vec adjusted_gradient;
00068 private:
00069     Vec mean_error;
00070     real mean_candidate;
00071     
00072 public:
00074     CCCostVariable() : distr(), f_error(), f_candidate() {}
00076     CCCostVariable(VMat the_distr, Func the_f, Func f_candidate);
00077     
00078     PLEARN_DECLARE_OBJECT(CCCostVariable);
00079     static void declareOptions(OptionList &ol);
00080 
00081     virtual void build();
00082 
00083     virtual void recomputeSize(int& l, int& w) const;
00084     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00085     virtual void fprop();
00086     virtual void bprop();
00087     virtual void fbprop();
00088     virtual void symbolicBprop();
00089     virtual void rfprop();
00090     
00091     void printInfo(bool print_gradient);
00092 
00093 protected:
00094     void build_();
00095 };
00096 
00097 DECLARE_OBJECT_PTR(CCCostVariable);
00098 
00100 inline Var cccost(VMat distr, Func the_f_error, Func the_f_candidate)
00101 { return new CCCostVariable(distr,the_f_error,the_f_candidate); }
00102 
00103 } // end of namespace PLearn
00104 
00105 #endif 
00106 
00107 
00108 /*
00109   Local Variables:
00110   mode:c++
00111   c-basic-offset:4
00112   c-file-style:"stroustrup"
00113   c-file-offsets:((innamespace . 0)(inline-open . 0))
00114   indent-tabs-mode:nil
00115   fill-column:79
00116   End:
00117 */
00118 // 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