PLearn 0.1
NoSplitSplitter.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // NoSplitSplitter.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: NoSplitSplitter.cc 8128 2007-10-02 15:54:19Z tihocan $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #include "NoSplitSplitter.h"
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00050 // NoSplitSplitter //
00052 NoSplitSplitter::NoSplitSplitter()
00053 {
00054 }
00055 
00056 PLEARN_IMPLEMENT_OBJECT(NoSplitSplitter,
00057                         "A Splitter that actually just returns the original dataset.",
00058                         "This splitter can be used as a special case, e.g. in a StackedSplitter.\n"
00059     );
00060 
00062 // declareOptions //
00064 void NoSplitSplitter::declareOptions(OptionList& ol)
00065 {
00066     // ### Declare all of this object's options here
00067     // ### For the "flags" of each option, you should typically specify
00068     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00069     // ### OptionBase::tuningoption. Another possible flag to be combined with
00070     // ### is OptionBase::nosave
00071 
00072 //  declareOption(ol, "initial_splitter", &NoSplitSplitter::initial_splitter, OptionBase::buildoption,
00073 
00074     // Now call the parent class' declareOptions
00075     inherited::declareOptions(ol);
00076 }
00077 
00079 // build //
00081 void NoSplitSplitter::build()
00082 {
00083     inherited::build();
00084     build_();
00085 }
00086 
00088 // build_ //
00090 void NoSplitSplitter::build_()
00091 {
00092     // ### This method should do the real building of the object,
00093     // ### according to set 'options', in *any* situation.
00094     // ### Typical situations include:
00095     // ###  - Initial building of an object from a few user-specified options
00096     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00097     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00098     // ### You should assume that the parent class' build_() has already been called.
00099 }
00100 
00102 // makeDeepCopyFromShallowCopy //
00104 void NoSplitSplitter::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00105 {
00106     inherited::makeDeepCopyFromShallowCopy(copies);
00107 }
00108 
00110 // nsplits //
00112 int NoSplitSplitter::nsplits() const
00113 {
00114     return 1;
00115 }
00116 
00118 // nSetsPerSplit //
00120 int NoSplitSplitter::nSetsPerSplit() const
00121 {
00122     return 1;
00123 }
00124 
00126 // getSplit //
00128 TVec<VMat> NoSplitSplitter::getSplit(int k)
00129 {
00130     PLASSERT_MSG(k==0,"In NoSplitSplitter::getSplit - Asked for a split that "
00131                       "does not exist");
00132     TVec<VMat> result(1);
00133     result[0] = dataset;
00134     return result;
00135 }
00136 
00137 } // end of namespace PLearn
00138 
00139 
00140 /*
00141   Local Variables:
00142   mode:c++
00143   c-basic-offset:4
00144   c-file-style:"stroustrup"
00145   c-file-offsets:((innamespace . 0)(inline-open . 0))
00146   indent-tabs-mode:nil
00147   fill-column:79
00148   End:
00149 */
00150 // 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