PLearn 0.1
FileVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2001 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2002 Pascal Vincent, Julien Keable, Xavier Saint-Mleux
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 
00037 /* *******************************************************
00038  * $Id: FileVMatrix.h 10262 2009-07-09 14:38:14Z nouiz $
00039  ******************************************************* */
00040 
00041 
00044 #ifndef FileVMatrix_INC
00045 #define FileVMatrix_INC
00046 
00047 #include "RowBufferedVMatrix.h"
00048 #include <nspr/prlong.h>
00049 // While under development, we use this define to control
00050 // whether to use the NSPR 64 bit file access or the old std C FILE*
00051 #define USE_NSPR_FILE
00052 struct PRFileDesc;
00053 
00054 namespace PLearn {
00055 using namespace std;
00056 
00059 class FileVMatrix: public RowBufferedVMatrix
00060 {
00061 
00062 private:
00063 
00064     typedef RowBufferedVMatrix inherited;
00065 
00066 protected:
00067 
00068     PPath filename_;
00069 
00070 #ifdef USE_NSPR_FILE
00071     PRFileDesc* f;
00072 #else
00073     FILE* f;
00074 #endif
00075     bool file_is_bigendian;
00076     bool file_is_float;
00077     bool force_float;
00078 
00079 private:
00080 
00081     bool build_new_file;
00082     void openfile(const PPath& path, const char *mode, PRIntn flags,
00083                   PRIntn mode2);
00084 
00085 public:
00086 
00087     FileVMatrix();
00088     FileVMatrix(const PPath& filename, bool writable_=false); 
00089     FileVMatrix(const PPath& filename, int the_length, int the_width,
00090                 bool force_float=false, bool call_build_ = true); 
00091     FileVMatrix(const PPath& filename, int the_length, const TVec<string>& fieldnames); 
00092 
00093 protected:
00094 
00095     static void declareOptions(OptionList & ol);
00096     virtual void getNewRow(int i, const Vec& v) const;
00097 
00099     virtual void closeCurrentFile();
00100 
00101 public:
00102 
00103      int remove_when_done; 
00104      int track_ref;        
00105 
00107     virtual void updateHeader();
00108 
00109     virtual void put(int i, int j, real value);
00110     virtual void putSubRow(int i, int j, Vec v);
00111     virtual void appendRow(Vec v);
00112     virtual void flush();
00113 
00114     virtual void build();
00115 
00116     PLEARN_DECLARE_OBJECT(FileVMatrix);
00117 
00118 
00120     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00121 
00123     virtual ~FileVMatrix();
00124 
00125     virtual int64_t getSizeOnDisk();
00126 private:
00127 
00128     void build_();
00129     // seek to element i,j in file
00130     void moveto(int i, int j=0) const;
00131 
00132 };
00133 
00134 DECLARE_OBJECT_PTR(FileVMatrix);
00135 
00136 } // end of namespace PLearn
00137 #endif
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