PLearn 0.1
AppendNeighborsVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // AppendNeighborsVMatrix.h
00004 //
00005 // Copyright (C) 2004 Martin Monperrus 
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: AppendNeighborsVMatrix.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Martin Monperrus & Yoshua Bengio
00040 
00044 #ifndef AppendNeighborsVMatrix_INC
00045 #define AppendNeighborsVMatrix_INC
00046 
00047 #include "SourceVMatrix.h"
00048 #include <plearn/var/Func.h>
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00059 class AppendNeighborsVMatrix: public SourceVMatrix
00060 {
00061 
00062 private:
00063 
00064     typedef SourceVMatrix inherited;
00065 
00067     mutable Vec input, target, transf;
00068     mutable real weight;
00069 
00070 protected:
00071     // NON-OPTION FIELDS
00072 
00074     TMat<int> input_parts; 
00075 
00076     // *********************
00077     // * protected options *
00078     // *********************
00079 
00080 public:
00081 
00082     // ************************
00083     // * public build options *
00084     // ************************
00085 
00087     int n_neighbors;
00089     Func transformation;
00092     bool append_neighbor_indices;
00093 
00094     // ****************
00095     // * Constructors *
00096     // ****************
00097 
00098     // Default constructor, make sure the implementation in the .cc
00099     // initializes all fields to reasonable default values.
00100     AppendNeighborsVMatrix();
00101 
00102     // ******************
00103     // * Object methods *
00104     // ******************
00105 
00106 private: 
00108     // (Please implement in .cc)
00109     void build_();
00110 
00111 protected: 
00113     // (Please implement in .cc)
00114     static void declareOptions(OptionList& ol);
00115 
00117     virtual void getNewRow(int i, const Vec& v) const;
00118 
00119 public:
00120     // simply calls inherited::build() then build_() 
00121     virtual void build();
00122 
00124     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00125 
00127     PLEARN_DECLARE_OBJECT(AppendNeighborsVMatrix);
00128 
00129 };
00130 DECLARE_OBJECT_PTR(AppendNeighborsVMatrix);
00131 
00132 inline VMat append_neighbors(VMat source, int n_neighbors, bool append_neighbor_indices = false, Func transformation=0)
00133 {
00134     AppendNeighborsVMatrix* vmat = new AppendNeighborsVMatrix();
00135     vmat->source=source;
00136     vmat->n_neighbors=n_neighbors;
00137     vmat->transformation = transformation;
00138     vmat->append_neighbor_indices = append_neighbor_indices;
00139     vmat->build();
00140     return vmat;
00141 }
00142 
00143 } // end of namespace PLearn
00144 #endif
00145 
00146 
00147 /*
00148   Local Variables:
00149   mode:c++
00150   c-basic-offset:4
00151   c-file-style:"stroustrup"
00152   c-file-offsets:((innamespace . 0)(inline-open . 0))
00153   indent-tabs-mode:nil
00154   fill-column:79
00155   End:
00156 */
00157 // 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