PLearn 0.1
GramVMatrix.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // GramVMatrix.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: GramVMatrix.cc 8617 2008-03-03 17:45:54Z nouiz $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #include "GramVMatrix.h"
00045 #include <time.h>         
00046 
00047 namespace PLearn {
00048 using namespace std;
00049 
00051 // GramVMatrix //
00053 GramVMatrix::GramVMatrix()
00054     : verbosity(1)
00055 {
00056 }
00057 
00058 PLEARN_IMPLEMENT_OBJECT(GramVMatrix,
00059                         "Computes the Gram matrix of a given kernel.",
00060                         "Currently, this class inherits from a MemoryVMatrix, and the Gram matrix\n"
00061                         "is stored in memory.\n"
00062     );
00063 
00065 // declareOptions //
00067 void GramVMatrix::declareOptions(OptionList& ol)
00068 {
00069     // ### Declare all of this object's options here
00070     // ### For the "flags" of each option, you should typically specify
00071     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00072     // ### OptionBase::tuningoption. Another possible flag to be combined with
00073     // ### is OptionBase::nosave
00074 
00075     declareOption(ol, "kernel", &GramVMatrix::kernel, OptionBase::buildoption,
00076                   "The kernel whose Gram matrix we want to compute.");
00077 
00078     declareOption(ol, "verbosity", &GramVMatrix::verbosity, OptionBase::buildoption,
00079                   "The level of verbosity.");
00080 
00081     //               "Help text describing this option");
00082     // ...
00083 
00084     // Now call the parent class' declareOptions
00085     inherited::declareOptions(ol);
00086 
00087     // Hide the 'data' and 'source' options of a MemoryVMatrix, that are
00088     // not used in this subclass.
00089     redeclareOption(ol, "data", &GramVMatrix::data, OptionBase::nosave,
00090                     "Not needed here.");
00091 
00092     redeclareOption(ol, "source", &GramVMatrix::source, OptionBase::nosave,
00093                     "Not needed here.");
00094 
00095 }
00096 
00098 // build //
00100 void GramVMatrix::build()
00101 {
00102     inherited::build();
00103     build_();
00104 }
00105 
00107 // build_ //
00109 void GramVMatrix::build_()
00110 {
00111     if (kernel) {
00112         updateMtime(kernel->getData());
00113         updateMtime(kernel->specify_dataset);
00114         bool old_report_progress = kernel->report_progress != 0;
00115         if (verbosity < 1) {
00116             kernel->report_progress = false;
00117         }
00118         int n = kernel->getData()->length();
00119         data.resize(n, n);
00120         clock_t time_for_gram = clock();
00121         kernel->computeGramMatrix(data);
00122         time_for_gram = clock() - time_for_gram;
00123         real real_time_for_gram = real(time_for_gram) / real(CLOCKS_PER_SEC);
00124         if (verbosity >= 2) {
00125             cout << "Time to compute the Gram matrix: " << real_time_for_gram << endl;
00126         }
00127         kernel->report_progress = old_report_progress;
00128         length_ = width_ = n;
00129         inherited::build();
00130     }
00131 }
00132 
00134 // makeDeepCopyFromShallowCopy //
00136 void GramVMatrix::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("GramVMatrix::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