PLearn 0.1
GaussianizeVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // GaussianizeVMatrix.h
00004 //
00005 // Copyright (C) 2006 Olivier Delalleau
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: Olivier Delalleau
00036 
00040 #ifndef GaussianizeVMatrix_INC
00041 #define GaussianizeVMatrix_INC
00042 
00043 #include <plearn/vmat/SourceVMatrix.h>
00044 
00045 namespace PLearn {
00046 
00057 class GaussianizeVMatrix : public SourceVMatrix
00058 {
00059     typedef SourceVMatrix inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00066 
00067     bool gaussianize_input;
00068     bool gaussianize_target;
00069     bool gaussianize_weight;
00070     bool gaussianize_extra;
00071     bool gaussianize_binary;
00072     real threshold_ratio;
00073     bool save_and_reuse_stats;
00074     VMat train_source;
00075     string stats_file_to_use;
00076     TVec<int> fields_to_gaussianize;
00077     PPath save_fields_gaussianized;
00078 
00079 public:
00080     //#####  Public Member Functions  #########################################
00081 
00083     // ### Make sure the implementation in the .cc
00084     // ### initializes all fields to reasonable default values.
00085     GaussianizeVMatrix();
00086 
00087 
00088     //#####  PLearn::Object Protocol  #########################################
00089 
00090     // Declares other standard object methods.
00091     // ### If your class is not instantiatable (it has pure virtual methods)
00092     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00093     PLEARN_DECLARE_OBJECT(GaussianizeVMatrix);
00094 
00095     // Simply calls inherited::build() then build_()
00096     virtual void build();
00097 
00099     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00100 
00101 
00103     real unGauss(real value, int col)const;
00104     void unGauss(Vec& values, Vec& ret, int col)const;
00105 
00106 protected:
00107 
00109     TVec<int> features_to_gaussianize;
00110 
00111     TVec<int> fields_gaussianized;
00112 
00114     Vec scaling_factor;
00115 
00118     TVec<Vec> values;
00119 
00120 protected:
00121     //#####  Protected Member Functions  ######################################
00122 
00124     static void declareOptions(OptionList& ol);
00125 
00127     static void declareMethods(RemoteMethodMap& rmm);
00128 
00132     virtual void getNewRow(int i, const Vec& v) const;
00133 
00134 private:
00135     //#####  Private Member Functions  ########################################
00136 
00138     void build_();
00139     virtual void setMetaDataDir(const PPath& the_metadatadir);
00140     real remote_unGauss(real input, int col)const;
00141     Vec remote_unGauss_vec(Vec inputs, int col) const;
00142     void append_col_to_gaussianize(int col, StatsCollector stat);
00143 private:
00144     //#####  Private Data Members  ############################################
00145 
00146     // The rest of the private stuff goes here
00147 };
00148 
00149 // Declares a few other classes and functions related to this class
00150 DECLARE_OBJECT_PTR(GaussianizeVMatrix);
00151 
00152 } // end of namespace PLearn
00153 
00154 #endif
00155 
00156 
00157 /*
00158   Local Variables:
00159   mode:c++
00160   c-basic-offset:4
00161   c-file-style:"stroustrup"
00162   c-file-offsets:((innamespace . 0)(inline-open . 0))
00163   indent-tabs-mode:nil
00164   fill-column:79
00165   End:
00166 */
00167 // 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