PLearn 0.1
getDataSet.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,2000 Pascal Vincent, Yoshua Bengio and University of Montreal
00006 //
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 /* *******************************************************      
00039  * $Id: getDataSet.h 8822 2008-04-16 21:22:52Z chapados $
00040  * AUTHORS: Pascal Vincent
00041  * This file is part of the PLearn library.
00042  ******************************************************* */
00043 
00044 #ifndef getDataSet_INC
00045 #define getDataSet_INC
00046 
00047 #include <string>
00048 #include <map>
00049 #include <time.h>
00050 
00051 namespace PLearn {
00052 using namespace std;
00053 
00054 class VMat;
00055 class PPath;
00056 
00058 string getDataSetHelp();
00059 
00061 time_t getDataSetDate(const PPath& dataset_path);
00062 
00064 VMat getDataSet(const PPath& dataset_path);
00065 
00066 
00085 class VMatrixExtensionRegistrar
00086 {
00087 public:
00088     typedef VMat (*VMatrixInstantiator)(const PPath& filename);
00089     typedef map<string,VMatrixExtensionRegistrar> ExtensionMap;
00090     
00091 public:
00092     VMatrixExtensionRegistrar(const string& file_extension,
00093                               VMatrixInstantiator instantiation_function,
00094                               const string& documentation);
00095 
00097     const string& documentation() const
00098     {
00099         return m_documentation;
00100     }
00101     
00102     
00103     //#####  Static Interface  ################################################
00104     
00106     static const ExtensionMap& registeredExtensions()
00107     {
00108         return registeredExtensionsAux();
00109     }
00110 
00112     static void registerExtension(const VMatrixExtensionRegistrar& new_extension);
00113 
00115     static VMatrixInstantiator getInstantiator(const string& file_extension);
00116 
00117 private:
00118     // Members
00119     string m_file_extension;
00120     VMatrixInstantiator m_instantiator;
00121     string m_documentation;
00122     
00124     static ExtensionMap& registeredExtensionsAux();
00125 };
00126 
00127 } // end of namespace PLearn
00128 
00129 #endif
00130 
00131 
00132 /*
00133   Local Variables:
00134   mode:c++
00135   c-basic-offset:4
00136   c-file-style:"stroustrup"
00137   c-file-offsets:((innamespace . 0)(inline-open . 0))
00138   indent-tabs-mode:nil
00139   fill-column:79
00140   End:
00141 */
00142 // 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