PLearn 0.1
ValueSelectRowsVMatrix.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ValueSelectRowsVMatrix.cc
00004 //
00005 // Copyright (C) 2009 Frederic Bastien
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: Frederic Bastien
00036 
00040 #include "ValueSelectRowsVMatrix.h"
00041 
00042 namespace PLearn {
00043 using namespace std;
00044 
00045 PLEARN_IMPLEMENT_OBJECT(
00046     ValueSelectRowsVMatrix,
00047     "Select rows based on an index column. The value should be in another VMatrix.",
00048     "MULTI-LINE \nHELP"
00049     );
00050 
00052 // ValueSelectRowsVMatrix //
00054 ValueSelectRowsVMatrix::ValueSelectRowsVMatrix()
00055 {
00056 }
00057 
00059 // declareOptions //
00061 void ValueSelectRowsVMatrix::declareOptions(OptionList& ol)
00062 {
00063     // ### Declare all of this object's options here.
00064     // ### For the "flags" of each option, you should typically specify
00065     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00066     // ### OptionBase::tuningoption. If you don't provide one of these three,
00067     // ### this option will be ignored when loading values from a script.
00068     // ### You can also combine flags, for example with OptionBase::nosave:
00069     // ### (OptionBase::buildoption | OptionBase::nosave)
00070 
00071     declareOption(ol, "col_name", &ValueSelectRowsVMatrix::col_name,
00072                   OptionBase::buildoption,
00073                   "The name of the column to compare values.");
00074 
00075     declareOption(ol, "col_name_sec", &ValueSelectRowsVMatrix::col_name,
00076                   OptionBase::buildoption,
00077                   "The name of the column to compare values for the second matrix."
00078                   " If not provided, will use col_name.");
00079 
00080     declareOption(ol, "second", &ValueSelectRowsVMatrix::second,
00081                   OptionBase::buildoption,
00082                   "The matrix that have the value that we keep the columns.");
00083 
00084     inherited::declareOptions(ol);
00085 }
00086 
00088 // build //
00090 void ValueSelectRowsVMatrix::build()
00091 {
00092     // ### Nothing to add here, simply calls build_
00093 //    inherited::build();
00094     build_();
00095     inherited::build();//must recall as we changed selected_indices
00096 }
00097 
00099 // build_ //
00101 void ValueSelectRowsVMatrix::build_()
00102 {
00103     // ### This method should do the real building of the object,
00104     // ### according to set 'options', in *any* situation.
00105     // ### Typical situations include:
00106     // ###  - Initial building of an object from a few user-specified options
00107     // ###  - Building of a "reloaded" object: i.e. from the complete set of
00108     // ###    all serialised options.
00109     // ###  - Updating or "re-building" of an object after a few "tuning"
00110     // ###    options have been modified.
00111     // ### You should assume that the parent class' build_() has already been
00112     // ### called.
00113 
00114     // ### In a SourceVMatrix, you will typically end build_() with:
00115     // setMetaInfoFromSource();
00116 
00117     // ### You should keep the line 'updateMtime(0);' if you do not implement
00118     // ### the update of the mtime. Otherwise you can have an mtime != 0 that
00119     // ### is not valid.
00120     // ### Note that setMetaInfoFromSource() updates the mtime to the same as
00121     // ### the source, but this value will be erased with 'updateMtime(0)'.
00122     if(col_name_sec.empty())
00123         col_name_sec=col_name;
00124     Vec values_src(source->length()), values_sec(second->length());
00125     int idx = source->getFieldIndex(col_name,false);
00126     if(idx<0)
00127         PLERROR("In ValueSelectRowsVMatrix::build_ - the matrix source don't have the column %s",
00128                 col_name.c_str());
00129     source->getColumn(idx,values_src);
00130     idx=second->getFieldIndex(col_name_sec);
00131     if(idx<0)
00132         PLERROR("In ValueSelectRowsVMatrix::build_ - the matrix second don't have the column %s",
00133                 col_name.c_str());
00134     second->getColumn(idx,values_sec);
00135 
00136     //sort values_sec as it is shorter.
00137     sortElements(values_sec);
00138     for(int i=0;i<values_src.size();i++){
00139         real val = values_src[i];
00140         int idx=values_sec.findSorted(val);
00141         if(values_sec[idx]==val){
00142             indices.append(i);
00143         }
00144     }
00145     if(indices.size()!=values_sec.size())
00146         PLWARNING("In ValueSelectRowsVMatrix::build_() - we selected less rows"
00147                 " (%d) than asked(%d). Maybe some disappeared.",
00148                 indices.size(), values_sec.size());
00149     updateMtime(source);
00150     updateMtime(second);
00151 }
00152 
00154 // makeDeepCopyFromShallowCopy //
00156 void ValueSelectRowsVMatrix::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00157 {
00158     inherited::makeDeepCopyFromShallowCopy(copies);
00159     deepCopyField(second, copies);
00160 }
00161 
00162 } // end of namespace PLearn
00163 
00164 
00165 /*
00166   Local Variables:
00167   mode:c++
00168   c-basic-offset:4
00169   c-file-style:"stroustrup"
00170   c-file-offsets:((innamespace . 0)(inline-open . 0))
00171   indent-tabs-mode:nil
00172   fill-column:79
00173   End:
00174 */
00175 // 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