PLearn 0.1
ProbabilityPairsVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ProbabilityPairsVariable.h
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, Pascal Vincent
00036 
00040 #ifndef ProbabilityPairsVariable_INC
00041 #define ProbabilityPairsVariable_INC
00042 
00043 #include <plearn/var/UnaryVariable.h>
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00061 class ProbabilityPairsVariable : public UnaryVariable
00062 {
00063     typedef UnaryVariable inherited;
00064 
00065 public:
00066     //#####  Public Build Options  ############################################
00067 
00070 
00071 
00074     real min;
00075     
00077     real max;
00078 
00079 public:
00080     //#####  Public Member Functions  #########################################
00081 
00083     ProbabilityPairsVariable();
00084 
00085     ProbabilityPairsVariable(Variable* input, real min, real max);
00086     ProbabilityPairsVariable(Variable* input, real max);
00087     ProbabilityPairsVariable(Variable* input);
00088 
00089     // Your other public member functions go here
00090 
00091     //#####  PLearn::Variable methods #########################################
00092     // (PLEASE IMPLEMENT IN .cc)
00093     virtual void recomputeSize(int& l, int& w) const;
00094     virtual void fprop();
00095     virtual void bprop();
00096 
00097     // ### These ones are not always implemented
00098     // virtual void bbprop();
00099     // virtual void symbolicBprop();
00100     // virtual void rfprop();
00101 
00102     //#####  PLearn::Object Protocol  #########################################
00103 
00104     // Declares other standard object methods.
00105     // ### If your class is not instantiatable (it has pure virtual methods)
00106     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00107     PLEARN_DECLARE_OBJECT(ProbabilityPairsVariable);
00108 
00109     // Simply calls inherited::build() then build_()
00110     virtual void build();
00111 
00113     // (PLEASE IMPLEMENT IN .cc)
00114     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00115 
00116 protected:
00117     //#####  Protected Options  ###############################################
00118 
00119     // ### Declare protected option fields (such as learned parameters) here
00120     // ...
00121 
00122 protected:
00123     //#####  Protected Member Functions  ######################################
00124 
00126     // (PLEASE IMPLEMENT IN .cc)
00127     static void declareOptions(OptionList& ol);
00128 
00129 private:
00130     //#####  Private Member Functions  ########################################
00131 
00133     // (PLEASE IMPLEMENT IN .cc)
00134     void build_();
00135 
00136 private:
00137     //#####  Private Data Members  ############################################
00138 
00139     // The rest of the private stuff goes here
00140 };
00141 
00142 // Declares a few other classes and functions related to this class
00143 DECLARE_OBJECT_PTR(ProbabilityPairsVariable);
00144 
00145 // ### Put here a convenient method for building your variable.
00146 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo
00147 // ### and bar_type bar, you could write:
00148 // inline Var toto(Var v, foo_type foo=default_foo, bar_type bar=default_bar)
00149 // { return new TotoVariable(v, foo, bar); }
00150 
00151 } // end of namespace PLearn
00152 
00153 #endif
00154 
00155 
00156 /*
00157   Local Variables:
00158   mode:c++
00159   c-basic-offset:4
00160   c-file-style:"stroustrup"
00161   c-file-offsets:((innamespace . 0)(inline-open . 0))
00162   indent-tabs-mode:nil
00163   fill-column:79
00164   End:
00165 */
00166 // 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