PLearn 0.1
SubInputVMatrix.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SubInputVMatrix.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: SubInputVMatrix.cc 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00043 #include "SubInputVMatrix.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00049 // SubInputVMatrix //
00051 SubInputVMatrix::SubInputVMatrix()
00052     : inherited(),
00053       j_start(0),
00054       n_inputs(-1)
00055 {
00056 }
00057 
00058 PLEARN_IMPLEMENT_OBJECT(SubInputVMatrix,
00059                         "A VMat that only takes part of the input of its source VMat.",
00060                         "This can be useful for instance to only take the first k components\n"
00061                         "after applying some dimensionality reduction method.\n"
00062                         "The other columns (target and weight) are copied from the source.\n"
00063     );
00064 
00066 // declareOptions //
00068 void SubInputVMatrix::declareOptions(OptionList& ol)
00069 {
00070     declareOption(ol, "j_start", &SubInputVMatrix::j_start, OptionBase::buildoption,
00071                   "The column we start at.");
00072 
00073     declareOption(ol, "n_inputs", &SubInputVMatrix::n_inputs, OptionBase::buildoption,
00074                   "The number of inputs to keep (-1 means we keep them all, from j_start).");
00075 
00076     // Now call the parent class' declareOptions
00077     inherited::declareOptions(ol);
00078 }
00079 
00081 // build //
00083 void SubInputVMatrix::build()
00084 {
00085     inherited::build();
00086     build_();
00087 }
00088 
00090 // build_ //
00092 void SubInputVMatrix::build_()
00093 {
00094     if (source) {
00095         if (source->inputsize() < 0)
00096             PLERROR("In SubInputVMatrix::build_ - The source's inputsize must be set");
00097         if (n_inputs == -1) {
00098             // Default value: we keep all inputs.
00099             n_inputs = source->inputsize() - j_start;
00100         }
00101         if (n_inputs < 0 || n_inputs + j_start > source->inputsize()) {
00102             PLERROR("In SubInputVMatrix::build_ - Source VMatrix hasn't enough inputs");
00103         }
00104         int n_removed = source->inputsize() - n_inputs;
00105         inputsize_ = n_inputs;
00106         width_ = source->width() - n_removed;
00107         // Set field infos.
00108         Array<VMField>& source_infos = source->getFieldInfos();
00109         TVec<VMField> finfos(width_);
00110         finfos.subVec(0, inputsize_) << source_infos.subVec(0, inputsize_);
00111         finfos.subVec(inputsize_, finfos.length() - inputsize_)
00112             << source_infos.subVec(source->inputsize(), source_infos.length() - source->inputsize());
00113         setFieldInfos(finfos);
00114         // Set other meta information.
00115         setMetaInfoFromSource();
00116     }
00117 }
00118 
00120 // getNewRow //
00122 void SubInputVMatrix::getNewRow(int i, const Vec& v) const
00123 {
00124     // First fill the input part.
00125     source->getSubRow(i, j_start, v.subVec(0, n_inputs));
00126     // Then the rest (target + weight).
00127     source->getSubRow(
00128         i,
00129         source->inputsize(),
00130         v.subVec(n_inputs, v.length() - n_inputs));
00131 }
00132 
00134 // makeDeepCopyFromShallowCopy //
00136 void SubInputVMatrix::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00137 {
00138     inherited::makeDeepCopyFromShallowCopy(copies);
00139 }
00140 
00141 } // end of namespace PLearn
00142 
00143 
00144 /*
00145   Local Variables:
00146   mode:c++
00147   c-basic-offset:4
00148   c-file-style:"stroustrup"
00149   c-file-offsets:((innamespace . 0)(inline-open . 0))
00150   indent-tabs-mode:nil
00151   fill-column:79
00152   End:
00153 */
00154 // 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