PLearn 0.1
LIBSVMSparseVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // LIBSVMSparseVMatrix.h
00004 //
00005 // Copyright (C) 2008 Hugo Larochelle
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: Hugo Larochelle
00036 
00040 #ifndef LIBSVMSparseVMatrix_INC
00041 #define LIBSVMSparseVMatrix_INC
00042 
00043 #include <plearn/vmat/RowBufferedVMatrix.h>
00044 #include <plearn/db/getDataSet.h>
00045 #include <plearn/vmat/VMat.h>
00046 
00047 namespace PLearn {
00048 
00052 class LIBSVMSparseVMatrix : public RowBufferedVMatrix
00053 {
00054     typedef RowBufferedVMatrix inherited;
00055     static VMatrixExtensionRegistrar* extension_registrar;
00056 
00057 public:
00058     //#####  Public Build Options  ############################################
00059 
00061     TVec<string> class_strings;
00062 
00064     PPath libsvm_file;
00065 
00068     bool use_coarse_representation;
00069 
00071     TVec< Vec > libsvm_input_data;
00072 
00074     TVec< Vec > libsvm_extra_data;
00075 
00077     Vec libsvm_target_data;
00078 
00079 public:
00080     //#####  Public Member Functions  #########################################
00081 
00083     LIBSVMSparseVMatrix();
00084     LIBSVMSparseVMatrix(PPath filename, bool use_coarse_representation);
00085 
00086     //#####  PLearn::Object Protocol  #########################################
00087 
00088     // Declares other standard object methods.
00089     PLEARN_DECLARE_OBJECT(LIBSVMSparseVMatrix);
00090 
00091     // Simply calls inherited::build() then build_()
00092     virtual void build();
00093 
00094     static VMat instantiateFromPPath(const PPath& filename)
00095     {
00096         //By default use normal representation
00097         return VMat(new LIBSVMSparseVMatrix(filename, true));
00098     }
00099 
00101     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00102 
00103     virtual void getExample(int i, Vec& input, Vec& target, real& weight);
00104 
00105     void getExamples(int i_start, int length, Mat& inputs, Mat& targets,
00106                      Vec& weights, Mat* extra = NULL,
00107                      bool allow_circular = false);
00108 
00109     virtual void getExtra(int i, Vec& extra);
00110 
00111 protected:
00112     //#####  Protected Options  ###############################################
00113 
00114 protected:
00115     //#####  Protected Member Functions  ######################################
00116 
00118     static void declareOptions(OptionList& ol);
00119 
00122     virtual void getNewRow(int i, const Vec& v) const;
00123 
00124 private:
00125     //#####  Private Member Functions  ########################################
00126 
00128     void build_();
00129 
00130 private:
00131     //#####  Private Data Members  ############################################
00132 
00133     // The rest of the private stuff goes here
00134 };
00135 
00136 // Declares a few other classes and functions related to this class
00137 DECLARE_OBJECT_PTR(LIBSVMSparseVMatrix);
00138 
00139 } // end of namespace PLearn
00140 
00141 #endif
00142 
00143 
00144 /*
00145   Local Variables:
00146   mode:c++
00147   c-basic-offset:4
00148   c-file-style:"stroustrup"
00149   c-file-offsets:((innamespace . 0)(inline-open . 0))
00150   indent-tabs-mode:nil
00151   fill-column:79
00152   End:
00153 */
00154 // 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