PLearn 0.1
LocalNeighborsDifferencesVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // LocalNeighborsDifferencesVMatrix.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: LocalNeighborsDifferencesVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Martin Monperrus & Yoshua Bengio
00040 
00044 #ifndef LocalNeighborsDifferencesVMatrix_INC
00045 #define LocalNeighborsDifferencesVMatrix_INC
00046 
00047 #include "SourceVMatrix.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class LocalNeighborsDifferencesVMatrix: public SourceVMatrix
00053 {
00054 
00055 private:
00056 
00057     typedef SourceVMatrix inherited;
00058 
00060     mutable Vec neighbor_row, ith_row, a_row, diff_k;
00061 
00062 protected:
00063     // NON-OPTION FIELDS
00064 
00065     TMat<int> neighbors; // length x n_neighbors matrix of nearest neighbor indices
00066 
00067     // *********************
00068     // * protected options *
00069     // *********************
00070 
00071 public:
00072 
00073     // ************************
00074     // * public build options *
00075     // ************************
00076 
00077     // ### declare public option fields (such as build options) here
00078     // ...
00079     int n_neighbors;
00080     bool concat_neighbors;
00081     bool append_indexes;
00082     bool append_neighbors;
00083 
00084     // ****************
00085     // * Constructors *
00086     // ****************
00087 
00088     // Default constructor, make sure the implementation in the .cc
00089     // initializes all fields to reasonable default values.
00090     LocalNeighborsDifferencesVMatrix();
00091 
00092     // ******************
00093     // * Object methods *
00094     // ******************
00095 
00096 private:
00098     // (Please implement in .cc)
00099     void build_();
00100 
00101 protected:
00103     // (Please implement in .cc)
00104     static void declareOptions(OptionList& ol);
00105 
00107     virtual void getNewRow(int i, const Vec& v) const;
00108 
00109 public:
00110     // simply calls inherited::build() then build_()
00111     virtual void build();
00112 
00114     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00115 
00117     PLEARN_DECLARE_OBJECT(LocalNeighborsDifferencesVMatrix);
00118 
00119 };
00120 DECLARE_OBJECT_PTR(LocalNeighborsDifferencesVMatrix);
00121 
00122 inline VMat local_neighbors_differences(VMat source, int n_neighbors, bool concat = false, bool append_indexes = false, bool append_neighbors=false)
00123 {
00124     LocalNeighborsDifferencesVMatrix* vmat = new LocalNeighborsDifferencesVMatrix();
00125     vmat->concat_neighbors = concat;
00126     vmat->source=source;
00127     vmat->n_neighbors=n_neighbors;
00128     vmat->append_indexes = append_indexes;
00129     vmat->append_neighbors = append_neighbors;
00130     vmat->build();
00131     return vmat;
00132 }
00133 
00134 } // end of namespace PLearn
00135 #endif
00136 
00137 
00138 /*
00139   Local Variables:
00140   mode:c++
00141   c-basic-offset:4
00142   c-file-style:"stroustrup"
00143   c-file-offsets:((innamespace . 0)(inline-open . 0))
00144   indent-tabs-mode:nil
00145   fill-column:79
00146   End:
00147 */
00148 // 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