PLearn 0.1
CenteredVMatrix.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // CenteredVMatrix.cc
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.cc 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #include "CenteredVMatrix.h"
00045 #include "VMat_basic_stats.h"       
00046 #include <plearn/math/TMat_maths.h>
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00052 // CenteredVMatrix //
00054 CenteredVMatrix::CenteredVMatrix()
00055 {
00056 }
00057 
00058 CenteredVMatrix::CenteredVMatrix(VMat the_source) {
00059     this->source = the_source;
00060     build();
00061 }
00062 
00063 PLEARN_IMPLEMENT_OBJECT(CenteredVMatrix,
00064                         "A VMatrix that centers a dataset.",
00065                         "The empirical mean is subtracted to each row of the underlying VMat."
00066     );
00067 
00069 // declareOptions //
00071 void CenteredVMatrix::declareOptions(OptionList& ol)
00072 {
00073     // ### Declare all of this object's options here
00074     // ### For the "flags" of each option, you should typically specify
00075     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00076     // ### OptionBase::tuningoption. Another possible flag to be combined with
00077     // ### is OptionBase::nosave
00078 
00079     // There is no need to save 'mu' since it is recomputed at build time.
00080     declareOption(ol, "mu", &CenteredVMatrix::mu, OptionBase::nosave,
00081                   "The sample mean");
00082 
00083     // Now call the parent class' declareOptions
00084     inherited::declareOptions(ol);
00085 }
00086 
00088 // build //
00090 void CenteredVMatrix::build()
00091 {
00092     // ### Nothing to add here, simply calls build_
00093     inherited::build();
00094     build_();
00095 }
00096 
00098 // build_ //
00100 void CenteredVMatrix::build_()
00101 {
00102     // ### This method should do the real building of the object,
00103     // ### according to set 'options', in *any* situation.
00104     // ### Typical situations include:
00105     // ###  - Initial building of an object from a few user-specified options
00106     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00107     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00108     // ### You should assume that the parent class' build_() has already been called.
00109 
00110     if (source) {
00111         // Compute the mean.
00112         computeMean(source, mu);
00113         setMetaInfoFromSource();
00114     }
00115 }
00116 
00118 // getMu //
00120 Vec CenteredVMatrix::getMu() const {
00121     return mu;
00122 }
00123 
00125 // getNewRow //
00127 void CenteredVMatrix::getNewRow(int i, const Vec& v) const
00128 {
00129     source->getRow(i, v);
00130     v -= mu;
00131 }
00132 
00134 // makeDeepCopyFromShallowCopy //
00136 void CenteredVMatrix::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00137 {
00138     inherited::makeDeepCopyFromShallowCopy(copies);
00139 
00140     // ### Call deepCopyField on all "pointer-like" fields
00141     // ### that you wish to be deepCopied rather than
00142     // ### shallow-copied.
00143     // ### ex:
00144     // deepCopyField(trainvec, copies);
00145 
00146     // ### Remove this line when you have fully implemented this method.
00147     PLERROR("CenteredVMatrix::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
00148 }
00149 
00150 } // end of namespace PLearn
00151 
00152 
00153 /*
00154   Local Variables:
00155   mode:c++
00156   c-basic-offset:4
00157   c-file-style:"stroustrup"
00158   c-file-offsets:((innamespace . 0)(inline-open . 0))
00159   indent-tabs-mode:nil
00160   fill-column:79
00161   End:
00162 */
00163 // 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