PLearn 0.1
UnaryVariable.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: UnaryVariable.h 9094 2008-06-03 21:08:22Z plearner $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef UnaryVariable_INC
00044 #define UnaryVariable_INC
00045 
00046 #include "VarArray.h"
00047 #include <plearn/math/TMat_maths.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class UnaryVariable: public Variable
00053 {
00054     typedef Variable inherited;
00055 
00056 protected:
00057 
00058     Var input;
00059 
00060 public:
00061 
00063     UnaryVariable() {}
00064 
00066     UnaryVariable(Variable* v, int thelength, int thewidth,
00067                   bool call_build_ = true);
00068 
00069     PLEARN_DECLARE_OBJECT(UnaryVariable);
00070 
00071     virtual void build();
00072   
00075     void setInput(Var the_input);
00076 
00077     virtual void setParents(const VarArray& parents);
00078   
00079     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00080     virtual bool markPath();
00081     virtual void buildPath(VarArray& proppath);
00082     virtual VarArray sources();
00083     virtual VarArray random_sources();
00084     virtual VarArray ancestors();
00085     virtual void unmarkAncestors();
00086     virtual void fprop() {} 
00087     virtual void bprop() {} 
00088     virtual VarArray parents();
00089     void printInfo(bool print_gradient) 
00090     { 
00091         pout << getName() << "[" << (void*)this << "] " << *this
00092              << " (" << (void*)input << ") = " << value;
00093         if (print_gradient) 
00094             pout << " gradient=" << gradient;
00095         pout << endl; 
00096     }
00097     virtual void resizeRValue();
00098 
00100     void checkContiguity() const;
00101 
00102 protected:
00103 
00104     static void declareOptions(OptionList & ol);
00105 
00106 private:
00107 
00108     void build_();
00109 };
00110 
00111 // Declares a few other classes and functions related to this class.
00112 DECLARE_OBJECT_PTR(UnaryVariable);
00113 
00114 } // end of namespace PLearn
00115 
00116 #endif 
00117 
00118 
00119 /*
00120   Local Variables:
00121   mode:c++
00122   c-basic-offset:4
00123   c-file-style:"stroustrup"
00124   c-file-offsets:((innamespace . 0)(inline-open . 0))
00125   indent-tabs-mode:nil
00126   fill-column:79
00127   End:
00128 */
00129 // 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