PLearn 0.1
BernoulliSampleVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // BernoulliSampleVariable.h
00004 //
00005 // Copyright (C) 2007 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: Pascal Vincent
00036 
00040 #ifndef BernoulliSampleVariable_INC
00041 #define BernoulliSampleVariable_INC
00042 
00043 #include <plearn/var/UnaryVariable.h>
00044 #include <plearn/math/PRandom.h>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00058 class BernoulliSampleVariable : public UnaryVariable
00059 {
00060     typedef UnaryVariable inherited;
00061 
00062 public:
00063     //#####  Public Build Options  ############################################
00064 
00067 
00068     PP<PRandom> random_gen;
00069 
00070 public:
00071     //#####  Public Member Functions  #########################################
00072 
00074     BernoulliSampleVariable()
00075     {}
00076 
00077 
00078     // ### If your class has parameters, you probably want a constructor that
00079     // ### initializes them
00080     BernoulliSampleVariable(Variable* input);
00081 
00082     // Your other public member functions go here
00083 
00084     //#####  PLearn::Variable methods #########################################
00085     // (PLEASE IMPLEMENT IN .cc)
00086     virtual void recomputeSize(int& l, int& w) const;
00087     virtual void fprop();
00088     virtual void bprop();
00089 
00090     // ### These ones are not always implemented
00091     // virtual void bbprop();
00092     // virtual void symbolicBprop();
00093     // virtual void rfprop();
00094 
00095     //#####  PLearn::Object Protocol  #########################################
00096 
00097     // Declares other standard object methods.
00098     // ### If your class is not instantiatable (it has pure virtual methods)
00099     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00100     PLEARN_DECLARE_OBJECT(BernoulliSampleVariable);
00101 
00102     // Simply calls inherited::build() then build_()
00103     virtual void build();
00104 
00106     // (PLEASE IMPLEMENT IN .cc)
00107     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00108 
00109 protected:
00110     //#####  Protected Options  ###############################################
00111 
00112     // ### Declare protected option fields (such as learned parameters) here
00113     // ...
00114 
00115 protected:
00116     //#####  Protected Member Functions  ######################################
00117 
00119     // (PLEASE IMPLEMENT IN .cc)
00120     static void declareOptions(OptionList& ol);
00121 
00122 private:
00123     //#####  Private Member Functions  ########################################
00124 
00126     // (PLEASE IMPLEMENT IN .cc)
00127     void build_();
00128 
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(BernoulliSampleVariable);
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