PLearn 0.1
DatedJoinVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // DatedJoinVMatrix.h
00004 //
00005 // Copyright (C) 2004 *Yoshua Bengio*
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: DatedJoinVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: *Yoshua Bengio*
00040 
00044 #ifndef DatedJoinVMatrix_INC
00045 #define DatedJoinVMatrix_INC
00046 
00047 #include "RowBufferedVMatrix.h"
00048 #include "VMat.h"
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class DatedJoinVMatrix: public RowBufferedVMatrix
00054 {
00055     typedef RowBufferedVMatrix inherited;
00056 
00057 public:
00058     typedef hash_multimap<Array<real>,int > Maptype;
00059     //typedef hash_multimap<Array<real>,int> Maptype;
00060 
00061 protected:
00062     // *********************
00063     // * protected options *
00064     // *********************
00065 
00066     Vec slave_row, master_row;
00067     Array<real> key;
00068     Maptype mp; // maps a key to a list of row indices in the slave
00069     TVec<int> master2slave;  // maps indices in one db to the other
00070     TVec<list<int> > slave2master; // there may be more than one master row per slave row, sum them
00071     int n_master_fields, n_slave_fields; // number of fields of master and slave to copy in result
00072 
00073 public:
00074 
00075     // ************************
00076     // * public build options *
00077     // ************************
00078 
00079     VMat master, slave;
00080     TVec<int> master_key_indices;
00081     TVec<int> slave_key_indices;
00082     TVec<string> master_key_names;
00083     TVec<string> slave_key_names;
00084     TVec<int> slave_field_indices;
00085     TVec<string> slave_field_names;
00086     TVec<int> master_field_indices;
00087     TVec<string> master_field_names;
00088     int master_date_field_index;
00089     string master_date_field_name;
00090     int slave_date_interval_start_field_index;
00091     int slave_date_interval_end_field_index;
00092     string slave_date_interval_start_field_name;
00093     string slave_date_interval_end_field_name;
00094     int verbosity;
00095     bool output_the_slave;
00096     bool output_matching_index;
00097 
00098     // ****************
00099     // * Constructors *
00100     // ****************
00101 
00102     // Default constructor, make sure the implementation in the .cc
00103     // initializes all fields to reasonable default values.
00104     DatedJoinVMatrix();
00105 
00106     // ******************
00107     // * Object methods *
00108     // ******************
00109 
00110 private:
00112     // (Please implement in .cc)
00113     void build_();
00114 
00115 protected:
00116 
00118     static void declareOptions(OptionList& ol);
00119 
00121     virtual void getNewRow(int i, const Vec& v) const;
00122 
00123 public:
00124 
00125     // simply calls inherited::build() then build_()
00126     virtual void build();
00127 
00129     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00130 
00132     PLEARN_DECLARE_OBJECT(DatedJoinVMatrix);
00133 
00134 };
00135 DECLARE_OBJECT_PTR(DatedJoinVMatrix);
00136 
00137 } // end of namespace PLearn
00138 #endif
00139 
00140 
00141 /*
00142   Local Variables:
00143   mode:c++
00144   c-basic-offset:4
00145   c-file-style:"stroustrup"
00146   c-file-offsets:((innamespace . 0)(inline-open . 0))
00147   indent-tabs-mode:nil
00148   fill-column:79
00149   End:
00150 */
00151 // 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