PLearn 0.1
NaryVariable.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: NaryVariable.h 10201 2009-05-12 17:57:00Z plearner $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef NaryVariable_INC
00044 #define NaryVariable_INC
00045 
00046 #include "VarArray.h"
00047 #include <plearn/math/TMat.h>
00048 #include <plearn/vmat/VMat.h>
00049 #include "Func.h"
00050 
00051 // norman: multi threading unix standard not supported in win32
00052 #ifndef WIN32
00053 #include <plearn/sys/Popen.h>
00054 #endif
00055 
00056 namespace PLearn {
00057 using namespace std;
00058 
00059 class NaryVariable: public Variable
00060 {
00061     typedef Variable inherited;
00062 
00063 public:
00064     //#####  Public Build Options  ############################################
00065 
00066     VarArray varray;
00067 
00068 public:
00069     //#####  PLearn::Object Interface  ########################################
00070 
00071     NaryVariable() {}
00072     NaryVariable(const VarArray& the_varray, int thelength, int thewidth = 1,
00073                  bool call_build_ = true);
00074 
00075     PLEARN_DECLARE_ABSTRACT_OBJECT(NaryVariable);
00076     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00077 
00078     virtual void build();
00079     
00080     //#####  PLearn::Variable Interface  ######################################
00081 
00082     virtual void setParents(const VarArray& parents);
00083 
00084     virtual bool markPath();
00085     virtual void buildPath(VarArray& proppath);
00086     virtual VarArray sources();
00087     virtual VarArray random_sources();
00088     virtual VarArray ancestors();
00089     virtual void unmarkAncestors();
00090     virtual VarArray parents();
00091     void printInfo(bool print_gradient) { 
00092         pout <<  getName() << "[" << (void*)this << "] " << classname() << "(" << (void*)varray[0];
00093         for (int i=1;i<varray.size();i++)
00094             pout << "," << (void*)varray[i];
00095         pout << ") = " << value;
00096         if (print_gradient) pout << " gradient=" << gradient;
00097         pout << endl; 
00098     }
00099     virtual void resizeRValue();
00100 
00101 protected:
00103     static void declareOptions(OptionList & ol);
00104 
00105 private:
00106 
00107     void build_();
00108 };
00109 
00110 
00111 } // end of namespace PLearn
00112 
00113 #endif 
00114 
00115 
00116 /*
00117   Local Variables:
00118   mode:c++
00119   c-basic-offset:4
00120   c-file-style:"stroustrup"
00121   c-file-offsets:((innamespace . 0)(inline-open . 0))
00122   indent-tabs-mode:nil
00123   fill-column:79
00124   End:
00125 */
00126 // 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