PLearn 0.1
KNNVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // KNNVMatrix.h
00004 //
00005 // Copyright (C) 2004 Olivier Delalleau
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: KNNVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef KNNVMatrix_INC
00045 #define KNNVMatrix_INC
00046 
00047 #include <plearn/ker/Kernel.h>
00048 #include "SourceVMatrix.h"
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class KNNVMatrix: public SourceVMatrix
00054 {
00055 
00056 private:
00057 
00058     typedef SourceVMatrix inherited;
00059 
00061     mutable Vec source_row;
00062 
00063 protected:
00064     // *********************
00065     // * protected options *
00066     // *********************
00067 
00068     // Fields below are not options.
00069 
00071     Mat nn;
00072 
00074     Mat pij;
00075 
00076 public:
00077 
00078     // ************************
00079     // * public build options *
00080     // ************************
00081 
00082     VMat k_nn_mat;
00083     Ker kernel_pij;
00084     int knn;
00085     bool report_progress;
00086 
00087     // ****************
00088     // * Constructors *
00089     // ****************
00090 
00091     // Default constructor, make sure the implementation in the .cc
00092     // initializes all fields to reasonable default values.
00093     KNNVMatrix();
00094 
00095     // ******************
00096     // * VMatrix methods *
00097     // ******************
00098 
00099 private:
00100 
00102     void build_();
00103 
00104 protected:
00105 
00107     static void declareOptions(OptionList& ol);
00108 
00112     inline int getSourceIndexOf(int i, int& i_ref, int& i_n) const;
00113 
00119     inline int getTag(int p) const;
00120 
00121 public:
00122 
00123     // ************************
00124     // **** Object methods ****
00125     // ************************
00126 
00128     virtual void build();
00129 
00131     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00132 
00133     // Declares other standard object methods
00134     //  If your class is not instantiatable (it has pure virtual methods)
00135     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00136     PLEARN_DECLARE_OBJECT(KNNVMatrix);
00137 
00138 
00139     // **************************
00140     // **** VMatrix methods ****
00141     // **************************
00142 
00143 protected:
00144 
00146     virtual void getNewRow(int i, const Vec& v) const;
00147 
00148 };
00149 
00150 // Declares a few other classes and functions related to this class
00151 DECLARE_OBJECT_PTR(KNNVMatrix);
00152 
00153 } // end of namespace PLearn
00154 
00155 #endif
00156 
00157 
00158 /*
00159   Local Variables:
00160   mode:c++
00161   c-basic-offset:4
00162   c-file-style:"stroustrup"
00163   c-file-offsets:((innamespace . 0)(inline-open . 0))
00164   indent-tabs-mode:nil
00165   fill-column:79
00166   End:
00167 */
00168 // 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