PLearn 0.1
RegularGridVMatrix.h
Go to the documentation of this file.
00001 
00002 // -*- C++ -*-
00003 
00004 // RegularGridVMatrix.h
00005 //
00006 // Copyright (C) 2003  Pascal Vincent
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  * $Id: RegularGridVMatrix.h 6485 2006-12-11 18:55:02Z plearner $
00038  ******************************************************* */
00039 
00041 #ifndef RegularGridVMatrix_INC
00042 #define RegularGridVMatrix_INC
00043 
00044 #include "RowBufferedVMatrix.h"
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 class RegularGridVMatrix: public RowBufferedVMatrix
00050 {
00051     typedef RowBufferedVMatrix inherited;
00052 
00053 protected:
00054     // *********************
00055     // * protected options *
00056     // *********************
00057 
00058 public:
00059     // ************************
00060     // * public build options *
00061     // ************************
00062 
00063     TVec<int> dimensions;
00064     Vec coordstart;
00065     Vec coordend;
00066     TVec< pair<real,real> > range;
00067 
00068     // ****************
00069     // * Constructors *
00070     // ****************
00071 
00072     // Default constructor, make sure the implementation in the .cc
00073     // initializes all fields to reasonable default values.
00074     RegularGridVMatrix();
00075 
00076     RegularGridVMatrix(TVec<int> the_dimensions, Vec the_coordstart, Vec the_coordend);
00077 
00079     RegularGridVMatrix(TVec<int> the_dimensions, TVec< pair<real,real> > the_range);
00080 
00081     // ******************
00082     // * Object methods *
00083     // ******************
00084 
00085 private:
00087     // (Please implement in .cc)
00088     void build_();
00089 
00090 protected:
00092     // (Please implement in .cc)
00093     static void declareOptions(OptionList& ol);
00094 
00096     virtual void getNewRow(int i, const Vec& v) const;
00097 
00098 public:
00099     // simply calls inherited::build() then build_()
00100     virtual void build();
00101 
00103     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00104 
00106     PLEARN_DECLARE_OBJECT(RegularGridVMatrix);
00107 };
00108 
00109 DECLARE_OBJECT_PTR(RegularGridVMatrix);
00110 
00111 } // end of namespace PLearn
00112 #endif
00113 
00114 
00115 /*
00116   Local Variables:
00117   mode:c++
00118   c-basic-offset:4
00119   c-file-style:"stroustrup"
00120   c-file-offsets:((innamespace . 0)(inline-open . 0))
00121   indent-tabs-mode:nil
00122   fill-column:79
00123   End:
00124 */
00125 // 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