BinaryVariable.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
// Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
// Copyright (C) 2002 Xiangdong Wang, Christian Dorion

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org


/* *******************************************************      
   * $Id: BinaryVariable.h,v 1.11 2004/07/21 16:30:54 chrish42 Exp $
   * This file is part of the PLearn library.
   ******************************************************* */

#ifndef BinaryVariable_INC
#define BinaryVariable_INC

#include "VarArray.h"
#include <plearn/math/TMat_maths.h>

namespace PLearn {
using namespace std;


class BinaryVariable: public Variable
{
  typedef Variable inherited;
  
protected:
  Var input1;
  Var input2;

public:
  BinaryVariable() {}
  BinaryVariable(Variable* v1, Variable* v2, int thelength, int thewidth);
  PLEARN_DECLARE_ABSTRACT_OBJECT(BinaryVariable);
  static void declareOptions(OptionList & ol);

  virtual void setParents(const VarArray& parents);
  
  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);
  virtual bool markPath();
  virtual void buildPath(VarArray& proppath);
  virtual VarArray sources();
  virtual VarArray random_sources();
  virtual VarArray ancestors();
  virtual void unmarkAncestors();
  virtual VarArray parents();
  void printInfo(bool print_gradient) { 
    cout << getName() << "[" << (void*)this << "] " << *this
         << "(" << (void*)input1 << "," << (void*)input2
         << ") = " << value;
    if (print_gradient) cout << " gradient=" << gradient;
    cout << endl; 
  }
  virtual void resizeRValue();
}; 


} // end of namespace PLearn

#endif 

---