Var.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 and University of Montreal
//

// 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: Var.h,v 1.12 2004/03/09 18:34:23 tihocan Exp $
   * This file is part of the PLearn library.
   ******************************************************* */


#ifndef Var_INC
#define Var_INC

#include "Variable.h"

namespace PLearn {
using namespace std;


inline ostream& operator<<(ostream& out, const Var& v)
{
  string name=v->getName();
  if (name != "")
    cout<<name<<endl;
  if (v->width()==1)
    out << v->value;
  else
    out << v->matValue;
  return out;
}


inline Var var(real init_value) { Var v(1); v=init_value; return v; }


template <> 
inline void deepCopyField(Var& field, CopiesMap& copies)
{
  PLWARNING(
      "In Var.h - You called deepCopyField on a Var, but this is known to sometimes "
      "cause bugs in optimized mode. Use varDeepCopyField instead! "
      "This warning may also appear when using a TVec<Var>, in this case, just switch "
      "to a VarArray."
  );
  if (field)
    field = field->deepCopy(copies);
}

} // end of namespace PLearn

#endif

---