PLearn 0.1
BatchVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 2003 Olivier Delalleau
00005 //
00006 // Redistribution and use in source and binary forms, with or without
00007 // modification, are permitted provided that the following conditions are met:
00008 // 
00009 //  1. Redistributions of source code must retain the above copyright
00010 //     notice, this list of conditions and the following disclaimer.
00011 // 
00012 //  2. Redistributions in binary form must reproduce the above copyright
00013 //     notice, this list of conditions and the following disclaimer in the
00014 //     documentation and/or other materials provided with the distribution.
00015 // 
00016 //  3. The name of the authors may not be used to endorse or promote
00017 //     products derived from this software without specific prior written
00018 //     permission.
00019 // 
00020 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00021 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00022 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00023 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00024 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00025 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00026 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00027 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00028 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00029 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030 // 
00031 // This file is part of the PLearn library. For more information on the PLearn
00032 // library, go to the PLearn Web site at www.plearn.org
00033 
00034 
00035 /* *******************************************************      
00036  * $Id: BatchVMatrix.h 5176 2006-03-13 22:40:51Z lamblin $
00037  ******************************************************* */
00038 
00039 
00040 #ifndef BatchVMatrix_INC
00041 #define BatchVMatrix_INC
00042 
00043 #include "VMat.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00050 class BatchVMatrix: public VMatrix
00051 {
00052     typedef VMatrix inherited;
00053 
00054 public:
00055 
00057     VMat m;         //< the source matrix
00058     int batch_size; //< the size of each mini_batch
00059 
00060 private:
00061 
00062     int last_batch; // contains the index of the last mini-batch (=n_batches-1)
00063     int last_batch_size; // contains the size of the last batch
00064 
00065 public:
00066 
00067     BatchVMatrix();
00068 
00069     PLEARN_DECLARE_OBJECT(BatchVMatrix);
00070 
00071     static void declareOptions(OptionList& ol);
00072     
00074     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00075 
00076     virtual void build();
00077     virtual real get(int i, int j) const;
00078     virtual void put(int i, int j, real value);
00079 
00080 private:
00081 
00082     void build_();
00083 
00084 };
00085 
00086 DECLARE_OBJECT_PTR(BatchVMatrix);
00087 
00088 } // end of namespace PLearn
00089 #endif
00090 
00091 
00092 /*
00093   Local Variables:
00094   mode:c++
00095   c-basic-offset:4
00096   c-file-style:"stroustrup"
00097   c-file-offsets:((innamespace . 0)(inline-open . 0))
00098   indent-tabs-mode:nil
00099   fill-column:79
00100   End:
00101 */
00102 // 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