PLearn 0.1
BinaryVariable.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-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
00007 // Copyright (C) 2002 Xiangdong Wang, Christian Dorion
00008 
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 // 
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 // 
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 // 
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 // 
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 // 
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 
00038 /* *******************************************************      
00039  * $Id: BinaryVariable.h 6505 2006-12-13 20:41:11Z tihocan $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef BinaryVariable_INC
00044 #define BinaryVariable_INC
00045 
00046 #include "VarArray.h"
00047 #include <plearn/math/TMat_maths.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 
00053 class BinaryVariable: public Variable
00054 {
00055     typedef Variable inherited;
00056   
00057 protected:
00058 
00059     Var input1;
00060     Var input2;
00061 
00062 public:
00063     BinaryVariable() {}
00064     BinaryVariable(Variable* v1, Variable* v2, int thelength, int thewidth,
00065                    bool call_build_ = true);
00066     PLEARN_DECLARE_ABSTRACT_OBJECT(BinaryVariable);
00067 
00068     virtual void setParents(const VarArray& parents);
00069 
00070     // Simply calls inherited::build() then build_().
00071     virtual void build();
00072   
00073     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00074     virtual bool markPath();
00075     virtual void buildPath(VarArray& proppath);
00076     virtual VarArray sources();
00077     virtual VarArray random_sources();
00078     virtual VarArray ancestors();
00079     virtual void unmarkAncestors();
00080     virtual VarArray parents();
00081     void printInfo(bool print_gradient) { 
00082         pout << getName() << "[" << (void*)this << "] " << *this
00083              << "(" << (void*)input1 << "," << (void*)input2
00084              << ") = " << value;
00085         if (print_gradient) pout << " gradient=" << gradient;
00086         pout << endl; 
00087     }
00088     virtual void resizeRValue();
00089 
00090 protected:
00091 
00092     static void declareOptions(OptionList & ol);
00093 
00094 private:
00095 
00097     void build_();
00098 
00099 }; 
00100 
00101 DECLARE_OBJECT_PTR(BinaryVariable);
00102 
00103 } // end of namespace PLearn
00104 
00105 #endif 
00106 
00107 
00108 /*
00109   Local Variables:
00110   mode:c++
00111   c-basic-offset:4
00112   c-file-style:"stroustrup"
00113   c-file-offsets:((innamespace . 0)(inline-open . 0))
00114   indent-tabs-mode:nil
00115   fill-column:79
00116   End:
00117 */
00118 // 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