PLearn 0.1
ProbabilityPairsInverseVariable.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ProbabilityPairsInverseVariable.cc
00004 //
00005 // Copyright (C) 2007 Simon Lemieux, Pascal Vincent
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: Simon Lemieux
00036 
00040 #include "ProbabilityPairsInverseVariable.h"
00041 
00042 namespace PLearn {
00043 using namespace std;
00044 
00047 PLEARN_IMPLEMENT_OBJECT(
00048     ProbabilityPairsInverseVariable,
00049     "[x1,x2,x3,...,xn] -> [f(x1), f(x3), ..., f(xn)] with f(x) = (max-min)*x - min and with n even",
00050     "MULTI LINE\nHELP FOR USERS"
00051     );
00052 
00053 
00054 ProbabilityPairsInverseVariable::ProbabilityPairsInverseVariable()
00055     : min(0.), max(1.)
00056 {}
00057 
00058 ProbabilityPairsInverseVariable::ProbabilityPairsInverseVariable(Variable* input, real min, real max)
00059     : inherited(input, input->length(), input->width()/2),
00060       min(min),max(max)
00061 {
00062     build_();
00063 }
00064 
00065 ProbabilityPairsInverseVariable::ProbabilityPairsInverseVariable(Variable* input, real max)
00066     :inherited(input, input->length(), input->width()/2),
00067      min(0.), max(max)
00068 {
00069     build_();
00070 }
00071 
00072 ProbabilityPairsInverseVariable::ProbabilityPairsInverseVariable(Variable* input)
00073     :inherited(input, input->length(), input->width()/2),
00074      min(0.), max(1.)
00075 {
00076     build_();
00077 }
00078 
00079 void ProbabilityPairsInverseVariable::recomputeSize(int& l, int& w) const
00080 {
00081         if (input) {
00082             l = input->length(); // the computed length of this Var
00083             w = input->width()/2; // the computed width
00084         } else
00085             l = w = 0;
00086 }
00087 
00088 // ### computes value from input's value
00089 void ProbabilityPairsInverseVariable::fprop()
00090 {
00091     for(int n=0; n<input->length(); n++)
00092         for(int i=0; i<input->width()/2; i++)
00093             matValue(n,i) = input->matValue(n,i*2)*(max-min) + min;
00094 }
00095 
00096 // ### computes input's gradient from gradient
00097 void ProbabilityPairsInverseVariable::bprop()
00098 {
00099     for(int n=0; n<input->length(); n++)
00100         for(int i=0; i<input->width()/2; i++)
00101             input->matGradient(n,i*2) += matGradient(n,i)*(max-min);
00102 }
00103 
00104 // ### You can implement these methods:
00105 // void ProbabilityPairsInverseVariable::bbprop() {}
00106 // void ProbabilityPairsInverseVariable::symbolicBprop() {}
00107 // void ProbabilityPairsInverseVariable::rfprop() {}
00108 
00109 
00110 // ### Nothing to add here, simply calls build_
00111 void ProbabilityPairsInverseVariable::build()
00112 {
00113     inherited::build();
00114     build_();
00115 }
00116 
00117 void ProbabilityPairsInverseVariable::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00118 {
00119     inherited::makeDeepCopyFromShallowCopy(copies);
00120 
00121     // ### Call deepCopyField on all "pointer-like" fields
00122     // ### that you wish to be deepCopied rather than
00123     // ### shallow-copied.
00124     // ### ex:
00125     // deepCopyField(trainvec, copies);
00126 
00127     // ### If you want to deepCopy a Var field:
00128     // varDeepCopyField(somevariable, copies);
00129 }
00130 
00131 void ProbabilityPairsInverseVariable::declareOptions(OptionList& ol)
00132 {
00133     // ### Declare all of this object's options here.
00134     // ### For the "flags" of each option, you should typically specify
00135     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00136     // ### OptionBase::tuningoption. If you don't provide one of these three,
00137     // ### this option will be ignored when loading values from a script.
00138     // ### You can also combine flags, for example with OptionBase::nosave:
00139     // ### (OptionBase::buildoption | OptionBase::nosave)
00140 
00141   
00142     declareOption(ol, "min", &ProbabilityPairsInverseVariable::min,
00143                   OptionBase::buildoption,
00144                   "The lower bound a value of the input should be. It will be used to calculate the corresponding probability of each input.");
00145 
00146     declareOption(ol, "max", &ProbabilityPairsInverseVariable::max,
00147                   OptionBase::buildoption,
00148                   "analog to min");
00149 
00150     // Now call the parent class' declareOptions
00151     inherited::declareOptions(ol);
00152 }
00153 
00154 void ProbabilityPairsInverseVariable::build_()
00155 {
00156     // ### This method should do the real building of the object,
00157     // ### according to set 'options', in *any* situation.
00158     // ### Typical situations include:
00159     // ###  - Initial building of an object from a few user-specified options
00160     // ###  - Building of a "reloaded" object: i.e. from the complete set of
00161     // ###    all serialised options.
00162     // ###  - Updating or "re-building" of an object after a few "tuning"
00163     // ###    options have been modified.
00164     // ### You should assume that the parent class' build_() has already been
00165     // ### called.
00166 }
00167 
00168 
00169 } // end of namespace PLearn
00170 
00171 
00172 /*
00173   Local Variables:
00174   mode:c++
00175   c-basic-offset:4
00176   c-file-style:"stroustrup"
00177   c-file-offsets:((innamespace . 0)(inline-open . 0))
00178   indent-tabs-mode:nil
00179   fill-column:79
00180   End:
00181 */
00182 // 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