PLearn 0.1
CenteredVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // CenteredVMatrix.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: CenteredVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef CenteredVMatrix_INC
00045 #define CenteredVMatrix_INC
00046 
00047 #include "SourceVMatrix.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class CenteredVMatrix: public SourceVMatrix
00053 {
00054 
00055 private:
00056 
00057     typedef SourceVMatrix inherited;
00058 
00059 protected:
00060 
00061     // *********************
00062     // * protected options *
00063     // *********************
00064 
00065     // Fields below are not options.
00066 
00068     Vec mu;
00069 
00070 public:
00071 
00072     // ************************
00073     // * public build options *
00074     // ************************
00075 
00076 
00077     // ****************
00078     // * Constructors *
00079     // ****************
00080 
00082     CenteredVMatrix();
00083 
00085     CenteredVMatrix(VMat the_source);
00086 
00087     // ******************
00088     // * Object methods *
00089     // ******************
00090 
00091 private:
00092 
00094     void build_();
00095 
00096 protected:
00097 
00099     static void declareOptions(OptionList& ol);
00100 
00102     virtual void getNewRow(int i, const Vec& v) const;
00103 
00104 public:
00105 
00107     Vec getMu() const;
00108 
00109     // Simply calls inherited::build() then build_().
00110     virtual void build();
00111 
00113     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00114 
00116     PLEARN_DECLARE_OBJECT(CenteredVMatrix);
00117 
00118 };
00119 
00120 DECLARE_OBJECT_PTR(CenteredVMatrix);
00121 
00122 } // end of namespace PLearn
00123 
00124 #endif
00125 
00126 
00127 /*
00128   Local Variables:
00129   mode:c++
00130   c-basic-offset:4
00131   c-file-style:"stroustrup"
00132   c-file-offsets:((innamespace . 0)(inline-open . 0))
00133   indent-tabs-mode:nil
00134   fill-column:79
00135   End:
00136 */
00137 // 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