PLearn 0.1
SourceVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SourceVMatrix.h
00004 //
00005 // Copyright (C) 2003 Pascal Vincent
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: SourceVMatrix.h 8709 2008-03-20 16:39:48Z nouiz $
00037  ******************************************************* */
00038 
00039 // Authors: Pascal Vincent
00040 
00043 /*
00044   SourceVmatrix is a base class for vmatrices that are defined as a function of
00045   another vmatrix (the "source").
00046 
00047   It has a source buildoption to specify said source.
00048 
00049 */
00050 
00051 
00052 #ifndef SourceVMatrix_INC
00053 #define SourceVMatrix_INC
00054 
00055 #include "RowBufferedVMatrix.h"
00056 #include "VMat.h"
00057 
00058 namespace PLearn {
00059 using namespace std;
00060 
00061 class SourceVMatrix: public RowBufferedVMatrix
00062 {
00063 
00064 private:
00065 
00066     typedef RowBufferedVMatrix inherited;
00067 
00068 protected:
00069 
00070     // *********************
00071     // * protected options *
00072     // *********************
00073 
00074     // Fields below are not options.
00075 
00078     mutable Vec sourcerow;
00079 
00080 public:
00081 
00082     // ************************
00083     // * public build options *
00084     // ************************
00085 
00086     VMat source;
00087     
00088     bool deep_copy_source;//Default true, if true, we deep copy the source
00089 
00090     //  TVec<string> dependencies; // a list of paths to files that this VMat depends on
00091 
00092     // ****************
00093     // * Constructors *
00094     // ****************
00095 
00096     // Default constructor, make sure the implementation in the .cc
00097     // initializes all fields to reasonable default values.
00098     SourceVMatrix(bool call_build_ = false);
00099 
00100     SourceVMatrix(VMat the_source, bool call_build_ = false);
00101 
00102     SourceVMatrix(VMat the_source, int the_length, int the_width,
00103                   bool call_build_ = false);
00104 
00105     // ******************
00106     // * Object methods *
00107     // ******************
00108 
00109 private:
00111     // (Please implement in .cc)
00112     void build_();
00113 
00114 protected:
00116     // (Please implement in .cc)
00117     static void declareOptions(OptionList& ol);
00118 
00123     void setMetaInfoFromSource();
00124 
00126     virtual void getNewRow(int i, const Vec& v) const;
00127 
00128 public:
00129 
00131 
00134     virtual void setMetaDataDir(const PPath& the_metadatadir);
00135 
00136     // simply calls inherited::build() then build_()
00137     virtual void build();
00138 
00140     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00141 
00143     PLEARN_DECLARE_OBJECT(SourceVMatrix);
00144 
00147     virtual PP<Dictionary> getDictionary(int col) const;
00148 
00150     virtual void getValues(int row, int col, Vec& values) const;
00151 
00153     virtual void getValues(const Vec& input, int col, Vec& values) const;
00154 
00155 };
00156 
00157 DECLARE_OBJECT_PTR(SourceVMatrix);
00158 
00159 } // end of namespace PLearn
00160 #endif
00161 
00162 
00163 /*
00164   Local Variables:
00165   mode:c++
00166   c-basic-offset:4
00167   c-file-style:"stroustrup"
00168   c-file-offsets:((innamespace . 0)(inline-open . 0))
00169   indent-tabs-mode:nil
00170   fill-column:79
00171   End:
00172 */
00173 // 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