PLearn 0.1
AffineTransformWeightPenalty.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: AffineTransformWeightPenalty.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef AffineTransformWeightPenalty_INC
00044 #define AffineTransformWeightPenalty_INC
00045 
00046 #include "UnaryVariable.h"
00047 #include <plearn/base/stringutils.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 
00054 class AffineTransformWeightPenalty: public UnaryVariable
00055 {
00056     typedef UnaryVariable inherited;
00057 
00058 protected:    
00059     real weight_decay_;
00060     real bias_decay_;
00061     string penalty_type_;
00062 
00063 public:
00065     AffineTransformWeightPenalty()
00066         : weight_decay_(0.0), bias_decay_(0.0), penalty_type_("L2_square")
00067     {
00068         string pt = lowerstring( penalty_type_ );
00069         if( pt == "l1" )
00070             penalty_type_ = "L1";
00071         else if( pt == "l1_square" || pt == "l1 square" || pt == "l1square" )
00072             penalty_type_ = "L1_square";
00073         else if( pt == "l2_square" || pt == "l2 square" || pt == "l2square" )
00074             penalty_type_ = "L2_square";
00075         else if( pt == "l2" )
00076         {
00077             PLWARNING("L2 penalty not supported, assuming you want L2 square");
00078             penalty_type_ = "L2_square";
00079         }
00080         else
00081             PLERROR("penalty_type_ \"%s\" not supported", penalty_type_.c_str());
00082     }
00083 
00084     AffineTransformWeightPenalty(Variable* affinetransform, real weight_decay, real bias_decay=0., string penalty_type="L2_square")
00085         : inherited(affinetransform, 1,1),weight_decay_(weight_decay),bias_decay_(bias_decay),penalty_type_(penalty_type)
00086     {
00087         string pt = lowerstring( penalty_type_ );
00088         if( pt == "l1" )
00089             penalty_type_ = "L1";
00090         else if( pt == "l1_square" || pt == "l1 square" || pt == "l1square" )
00091             penalty_type_ = "L1_square";
00092         else if( pt == "l2_square" || pt == "l2 square" || pt == "l2square" )
00093             penalty_type_ = "L2_square";
00094         else if( pt == "l2" )
00095         {
00096             PLWARNING("L2 penalty not supported, assuming you want L2 square");
00097             penalty_type_ = "L2_square";
00098         }
00099         else
00100             PLERROR("penalty_type_ \"%s\" not supported", penalty_type_.c_str());
00101     }
00102 
00103     PLEARN_DECLARE_OBJECT(AffineTransformWeightPenalty);
00104     static void declareOptions(OptionList &ol);
00105 
00106     virtual void recomputeSize(int& l, int& w) const;    
00107     virtual void fprop();
00108     virtual void bprop();
00109 };
00110 
00111 DECLARE_OBJECT_PTR(AffineTransformWeightPenalty);
00112 
00115 inline Var affine_transform_weight_penalty(Var transformation, real weight_decay, real bias_decay=0, string penalty_type="L2_square")
00116 { return new AffineTransformWeightPenalty(transformation, weight_decay, bias_decay, penalty_type); } 
00117 
00118 } // end of namespace PLearn
00119 
00120 #endif 
00121 
00122 
00123 /*
00124   Local Variables:
00125   mode:c++
00126   c-basic-offset:4
00127   c-file-style:"stroustrup"
00128   c-file-offsets:((innamespace . 0)(inline-open . 0))
00129   indent-tabs-mode:nil
00130   fill-column:79
00131   End:
00132 */
00133 // 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