PLearn 0.1
CorrelationProfiler.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // CorrelationProfiler.h
00004 //
00005 // Copyright (C) 2007 Pierre-Antoine Manzagol
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 // Authors: Pierre-Antoine Manzagol
00036 
00040 #ifndef CorrelationProfiler_INC
00041 #define CorrelationProfiler_INC
00042 
00043 #include <plearn/base/Object.h>
00044 
00045 namespace PLearn {
00046 
00053 class CorrelationProfiler : public Object
00054 {
00055     typedef Object inherited;
00056 
00057 public:
00058     //#####  Public Build Options  ############################################
00059 
00062     int its_dim;
00063     string its_name;
00064 
00065 public:
00066     //#####  Public Member Functions  #########################################
00067 
00069     // ### Make sure the implementation in the .cc
00070     // ### initializes all fields to reasonable default values.
00071     CorrelationProfiler();
00072     CorrelationProfiler(int dim, string name);
00073 
00074     // Your other public member functions go here
00075     void reset();
00076     void operator()(Vec& v);
00077     void printAndReset();
00078 
00079     //#####  PLearn::Object Protocol  #########################################
00080 
00081     // Declares other standard object methods.
00082     // ### If your class is not instantiatable (it has pure virtual methods)
00083     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00084     PLEARN_DECLARE_OBJECT(CorrelationProfiler);
00085 
00086     // Simply calls inherited::build() then build_()
00087     virtual void build();
00088 
00090     // (PLEASE IMPLEMENT IN .cc)
00091     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00092 
00093 protected:
00094     //#####  Protected Options  ###############################################
00095 
00096     // ### Declare protected option fields (such as learned parameters) here
00097 
00098 protected:
00099     //#####  Protected Member Functions  ######################################
00100 
00102     // (PLEASE IMPLEMENT IN .cc)
00103     static void declareOptions(OptionList& ol);
00104 
00105 private:
00106     //#####  Private Member Functions  ########################################
00107 
00109     // (PLEASE IMPLEMENT IN .cc)
00110     void build_();
00111 
00112 private:
00113     //#####  Private Data Members  ############################################
00114 
00115     // The rest of the private stuff goes here
00116     int n;  // number of vectors used in computing A
00117     Mat A;  // sum of the vv'
00118     Vec sum_v;  // sum of the v
00119     
00120 };
00121 
00122 // Declares a few other classes and functions related to this class
00123 DECLARE_OBJECT_PTR(CorrelationProfiler);
00124 
00125 } // end of namespace PLearn
00126 
00127 #endif
00128 
00129 
00130 /*
00131   Local Variables:
00132   mode:c++
00133   c-basic-offset:4
00134   c-file-style:"stroustrup"
00135   c-file-offsets:((innamespace . 0)(inline-open . 0))
00136   indent-tabs-mode:nil
00137   fill-column:79
00138   End:
00139 */
00140 // 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