PLearn 0.1
BinaryNumbersVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // BinaryNumbersVMatrix.h
00004 //
00005 // Copyright (C) 2007 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 // Authors: Yoshua Bengio
00036 
00040 #ifndef BinaryNumbersVMatrix_INC
00041 #define BinaryNumbersVMatrix_INC
00042 
00043 #include <plearn/vmat/RowBufferedVMatrix.h>
00044 #include <plearn/io/fileutils.h>
00045 #include <plearn/io/pl_NSPR_io.h>
00046 
00047 namespace PLearn {
00048 
00055 class BinaryNumbersVMatrix : public RowBufferedVMatrix
00056 {
00057     typedef RowBufferedVMatrix inherited;
00058 
00059 public:
00060     //#####  Public Build Options  ############################################
00061 
00063 
00064     PPath filename;
00065     // u1 = 1-byte unsigned integers
00066     // u2 = 1-byte unsigned integers
00067     // i4 = 4-byte signed integers
00068     // f4 = 4-byte floating point
00069     // f8 = 8-byte floating point
00070     string format;
00071 
00072     // length of header in bytes
00073     int header_size;
00074 
00075     // endian-swapping option
00076     bool file_is_bigendian;
00077 
00078     // learnt options
00079 
00080     // number of bytes of each row
00081     int row_size;
00082 
00083 protected:
00084     // NON-OPTIONS
00085 
00086     PRFileDesc *f;
00087     void* buffer;
00088 
00089 public:
00090     //#####  Public Member Functions  #########################################
00091 
00093     // ### Make sure the implementation in the .cc
00094     // ### initializes all fields to reasonable default values.
00095     BinaryNumbersVMatrix();
00096 
00097     //#####  PLearn::Object Protocol  #########################################
00098 
00099     // Declares other standard object methods.
00100     // ### If your class is not instantiatable (it has pure virtual methods)
00101     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00102     PLEARN_DECLARE_OBJECT(BinaryNumbersVMatrix);
00103 
00104     // Simply calls inherited::build() then build_()
00105     virtual void build();
00106 
00108     // (PLEASE IMPLEMENT IN .cc)
00109     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00110 
00111 protected:
00112     //#####  Protected Options  ###############################################
00113 
00114     // ### Declare protected option fields (such as learned parameters) here
00115     // ...
00116 
00117 protected:
00118     //#####  Protected Member Functions  ######################################
00119 
00121     // (PLEASE IMPLEMENT IN .cc)
00122     static void declareOptions(OptionList& ol);
00123 
00126     // (PLEASE IMPLEMENT IN .cc)
00127     virtual void getNewRow(int i, const Vec& v) const;
00128 
00130     virtual ~BinaryNumbersVMatrix();
00131 
00132 private:
00133     //#####  Private Member Functions  ########################################
00134 
00136     // (PLEASE IMPLEMENT IN .cc)
00137     void build_();
00138 
00139 private:
00140     //#####  Private Data Members  ############################################
00141 
00142     // The rest of the private stuff goes here
00143 };
00144 
00145 // Declares a few other classes and functions related to this class
00146 DECLARE_OBJECT_PTR(BinaryNumbersVMatrix);
00147 
00148 } // end of namespace PLearn
00149 
00150 #endif
00151 
00152 
00153 /*
00154   Local Variables:
00155   mode:c++
00156   c-basic-offset:4
00157   c-file-style:"stroustrup"
00158   c-file-offsets:((innamespace . 0)(inline-open . 0))
00159   indent-tabs-mode:nil
00160   fill-column:79
00161   End:
00162 */
00163 // 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