PLearn 0.1
AsciiVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // AsciiVMatrix.h
00004 //
00005 // Copyright (C) 2003 Rejean Ducharme, 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: AsciiVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00040 #ifndef AsciiVMatrix_INC
00041 #define AsciiVMatrix_INC
00042 
00043 #include "RowBufferedVMatrix.h"
00044 #include <fstream>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 class AsciiVMatrix: public RowBufferedVMatrix
00050 {
00051     typedef RowBufferedVMatrix inherited;
00052 
00053 protected:
00054     string filename;
00055     mutable PStream file;
00056     vector<streampos> pos_rows;
00057     streampos vmatlength_pos;
00058     bool readwritemode;
00059     bool newfile;
00060     bool rewrite_length;
00061     int length_max;
00062 
00063 public:
00064     // ******************
00065     // *  Constructors  *
00066     // ******************
00067     AsciiVMatrix(); 
00068 
00069     // Open an existing file.
00070     // If readwrite==false, the appendRow method sends an error.
00071     // If readwrite==true (the default), the file is open in read/write mode.
00072     AsciiVMatrix(const string& fname, bool readwrite=true);
00073 
00074     // Open a new file (in read/write mode).
00075     // If a file of the same name already exist, an error is sent!
00076     // The width of the matrix to be writen must be given.
00077     // Optional fieldnames may be given (as many as width, blanks will be converted to underscore)
00078     // Optional comment string (must start with a #, may be multiline with \n provided each line starts with a #).
00079     AsciiVMatrix(const string& fname, int the_width,
00080                  const TVec<string>& fieldnames = TVec<string>(),
00081                  const string& the_comment="");
00082 
00083 private:
00085     void build_();
00086 
00087 protected:
00089     static void declareOptions(OptionList& ol);
00090 
00092     virtual void getNewRow(int i, const Vec& v) const;
00093 
00094 public:
00096     virtual void appendRow(Vec v);
00097 
00100     virtual void put(int i, int j, real value);
00101     virtual void putSubRow(int i, int j, Vec v);
00102     virtual void putRow(int i, Vec v);
00103 
00104     // simply calls inherited::build() then build_()
00105     virtual void build();
00106 
00107     virtual ~AsciiVMatrix();
00108 
00110     PLEARN_DECLARE_OBJECT(AsciiVMatrix);
00111 
00112 };
00113 
00114 // Declares a few other classes and functions related to this class
00115 DECLARE_OBJECT_PTR(AsciiVMatrix);
00116 
00117 } // end of namespace PLearn
00118 #endif
00119 
00120 
00121 /*
00122   Local Variables:
00123   mode:c++
00124   c-basic-offset:4
00125   c-file-style:"stroustrup"
00126   c-file-offsets:((innamespace . 0)(inline-open . 0))
00127   indent-tabs-mode:nil
00128   fill-column:79
00129   End:
00130 */
00131 // 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