PLearn 0.1
AffineTransformVariable.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: AffineTransformVariable.h 8770 2008-04-08 17:20:13Z tihocan $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef AffineTransformVariable_INC
00044 #define AffineTransformVariable_INC
00045 
00046 #include "BinaryVariable.h"
00047 // For inline function that can return either an AffineTransformVariable or a MatrixAffineTransformVariable
00048 #include "MatrixAffineTransformVariable.h"
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 
00054 class AffineTransformVariable: public BinaryVariable
00055 {
00056     typedef BinaryVariable inherited;
00057 
00058 public:
00059 
00060     // Public options.
00061 
00062     bool force_row_vec;
00063 
00065     AffineTransformVariable() {}
00066     AffineTransformVariable(Variable* vec, Variable* transformation,
00067                             bool call_build_ = true);
00068 
00069 
00070     PLEARN_DECLARE_OBJECT(AffineTransformVariable);
00071 
00072     virtual void build();
00073 
00074     virtual void recomputeSize(int& l, int& w) const;
00075     virtual void fprop();
00076     virtual void bprop();
00077     virtual void symbolicBprop();
00078 
00079 private:
00080 
00081     void build_();
00082 
00083 protected:
00084 
00085     static void declareOptions(OptionList& ol);
00086 
00087 };
00088 
00089 DECLARE_OBJECT_PTR(AffineTransformVariable);
00090 
00096 inline Var affine_transform(Var vec, Var transformation,
00097                             bool force_row_vec = false)
00098 { 
00099     if (vec->isVec()) {
00100         PP<AffineTransformVariable> res =
00101             new AffineTransformVariable(vec, transformation, false);
00102         res->force_row_vec = force_row_vec;
00103         res->build();
00104         return get_pointer(res);
00105     }
00106     else return new MatrixAffineTransformVariable(vec, transformation);
00107 }
00108 
00109 } // end of namespace PLearn
00110 
00111 #endif 
00112 
00113 
00114 /*
00115   Local Variables:
00116   mode:c++
00117   c-basic-offset:4
00118   c-file-style:"stroustrup"
00119   c-file-offsets:((innamespace . 0)(inline-open . 0))
00120   indent-tabs-mode:nil
00121   fill-column:79
00122   End:
00123 */
00124 // 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