PLearn 0.1
MatrixElementsVariable.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: MatrixElementsVariable.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef MatrixElementsVariable_INC
00044 #define MatrixElementsVariable_INC
00045 
00046 #include "NaryVariable.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00052 class MatrixElementsVariable: public NaryVariable
00053 {
00054     typedef NaryVariable inherited;
00055 
00056 protected:
00057     Var i;
00058     Var j;
00059     int ni;
00060     int nj;
00061     Var expression;
00062     VarArray parameters;
00063 
00064     VarArray full_fproppath; 
00065     VarArray fproppath; 
00066     VarArray bproppath; 
00067 
00068 public:
00070     MatrixElementsVariable()
00071         : i(), j(), ni(), nj(), expression(), parameters(), full_fproppath(), fproppath(),
00072           bproppath()
00073     {}
00074     MatrixElementsVariable(Variable* the_expression, const Var& i_index, const Var& j_index,
00075                            int number_of_i_values, int number_of_j_values, const VarArray& the_parameters);
00076                          
00077     PLEARN_DECLARE_OBJECT(MatrixElementsVariable);
00078     static void declareOptions(OptionList &ol);
00079 
00080     virtual void build();
00081 
00082     virtual void recomputeSize(int& l, int& w) const;
00083     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00084     virtual void fprop();
00085     virtual void bprop();
00086     virtual void fbprop();
00087 
00088 protected:
00089     void build_();
00090 };
00091 
00092 DECLARE_OBJECT_PTR(MatrixElementsVariable);
00093 
00094 inline Var matrixElements(Var expression, const Var& i, const Var& j,
00095                           int ni, int nj, const VarArray& parameters)
00096 { return new MatrixElementsVariable(expression, i, j, ni, nj, parameters); }
00097 
00098 } // end of namespace PLearn
00099 
00100 #endif 
00101 
00102 
00103 /*
00104   Local Variables:
00105   mode:c++
00106   c-basic-offset:4
00107   c-file-style:"stroustrup"
00108   c-file-offsets:((innamespace . 0)(inline-open . 0))
00109   indent-tabs-mode:nil
00110   fill-column:79
00111   End:
00112 */
00113 // 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