PLearn 0.1
FilterSplitter.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // FilterSplitter.cc
00004 //
00005 // Copyright (C) 2004 Pierre-Jean L Heureux
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: FilterSplitter.cc 8184 2007-10-15 20:09:46Z nouiz $
00037  ******************************************************* */
00038 
00039 // Authors: Pierre-Jean L Heureux
00040 
00043 #include "FilterSplitter.h"
00044 #include "FilteredVMatrix.h"
00045 #include <plearn/io/fileutils.h>   
00046 
00047 namespace PLearn {
00048 using namespace std;
00049 
00050 FilterSplitter::FilterSplitter()
00051     : report_progress(false)
00052 {
00053 }
00054 
00055 PLEARN_IMPLEMENT_OBJECT(FilterSplitter,
00056                         "Each set of this Splitter is a FilteredVMatrix of the dataset.",
00057                         ""
00058     );
00059 
00060 void FilterSplitter::declareOptions(OptionList& ol)
00061 {
00062     // ### Declare all of this object's options here
00063     // ### For the "flags" of each option, you should typically specify
00064     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00065     // ### OptionBase::tuningoption. Another possible flag to be combined with
00066     // ### is OptionBase::nosave
00067 
00068     declareOption(ol, "filters", &FilterSplitter::filters, OptionBase::buildoption,
00069                   "array of strings: The VPL code for each set that should produce a single scalar\n"
00070                   ", indicating whether we should keep the line (if the produced scalar is non zero)\n"
00071                   "or throw it away (if it's zero)");
00072 
00073     declareOption(ol, "report_progress", &FilterSplitter::report_progress, OptionBase::buildoption,
00074                   "Whether to report or not the progress in filtering.");
00075 
00076     // Now call the parent class' declareOptions
00077     inherited::declareOptions(ol);
00078 }
00079 
00080 void FilterSplitter::build_()
00081 {
00082     // ### This method should do the real building of the object,
00083     // ### according to set 'options', in *any* situation.
00084     // ### Typical situations include:
00085     // ###  - Initial building of an object from a few user-specified options
00086     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00087     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00088     // ### You should assume that the parent class' build_() has already been called.
00089 }
00090 
00091 // ### Nothing to add here, simply calls build_
00092 void FilterSplitter::build()
00093 {
00094     inherited::build();
00095     build_();
00096 }
00097 
00098 void FilterSplitter::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00099 {
00100     inherited::makeDeepCopyFromShallowCopy(copies);
00101     deepCopyField(filters, copies);
00102 }
00103 
00104 int FilterSplitter::nsplits() const
00105 {
00106     // ### Return the number of available splits
00107     return 1;
00108 }
00109 
00110 int FilterSplitter::nSetsPerSplit() const
00111 {
00112     // ### Return the number of sets per split
00113     return filters.length();
00114 }
00115 
00117 // getSplit //
00119 TVec<VMat> FilterSplitter::getSplit(int k)
00120 {
00121     if (k != 0) PLERROR("This splitter will only create a single split");
00122     // ### Build and return the kth split
00123     TVec<VMat> splitsets;
00124     for (int i=0; i<filters.length(); i++) {
00125         splitsets.append(new FilteredVMatrix(dataset, filters[i], newFilename("/tmp", "filtered_vmatrix_temp_dir_", true), report_progress));
00126     }
00127     return splitsets;
00128 }
00129 
00130 } // end of namespace PLearn
00131 
00132 
00133 /*
00134   Local Variables:
00135   mode:c++
00136   c-basic-offset:4
00137   c-file-style:"stroustrup"
00138   c-file-offsets:((innamespace . 0)(inline-open . 0))
00139   indent-tabs-mode:nil
00140   fill-column:79
00141   End:
00142 */
00143 // 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