#line 1 "/user/cvsspst/ees1cg/RAVL/RAVL-0.7/PatternRec/Modeling/Basic/FuncLinear.hh"
// This file is part of RAVL, Recognition And Vision Library 
// Copyright (C) 2002, University of Surrey
// This code may be redistributed under the terms of the GNU Lesser
// General Public License (LGPL). See the lgpl.licence file for details or
// see http://www.gnu.org/copyleft/lesser.html
// file-header-ends-here
#ifndef RAVL_FUNCLINEAR_HEADER
#define RAVL_FUNCLINEAR_HEADER 1
//! rcsid="$Id: FuncLinear.hh,v 1.5 2002/08/08 16:03:22 craftit Exp $"
//! lib=RavlPatternRec
//! date="21/4/1998"
//! author="Robert Crida and Charles Galambos"
//! docentry="Ravl.Pattern Recognition.Numerical Modeling"
//! file="Ravl/PatternRec/Modeling/Basic/FuncLinear.hh"

#include "Ravl/PatternRec/FuncLinearCoeff.hh"
#include "Ravl/VirtualConstructor.hh"

namespace RavlN {
  
  //! userlevel=Develop
  //: Linear function.
  
  class FuncLinearBodyC 
    : public FuncLinearCoeffBodyC
  {
  public:
    FuncLinearBodyC();
    //: Construct from a transform matrix.
    
    FuncLinearBodyC(UIntT inSize,UIntT outSize)
      : FuncLinearCoeffBodyC(inSize,outSize)
    {}
    //: Construct with an input and output size.
    
    FuncLinearBodyC(istream &strm);
    //: Load from stream.
    
    FuncLinearBodyC(BinIStreamC &strm);
    //: Load from binary stream.
    
    virtual bool Save (ostream &out) const;
    //: Writes object to stream, can be loaded using constructor
    
    virtual bool Save (BinOStreamC &out) const;
    //: Writes object to stream, can be loaded using constructor

    virtual VectorC MakeInput (const VectorC &X) const;
    //: Expand vector to linear coefficients.
    
    virtual VectorC MakeJacobianInput (const VectorC &X, IntT i) const;
    //: Expand vector to linear coefficients.
    
    virtual UIntT NumberCoeffs(UIntT inputSize) const;
    //: Calculate the number of coefficents for a given input size.
    
  };
  
  
  //! userlevel=Normal
  //: Linear function.
  
  class FuncLinearC 
    : public FuncLinearCoeffC
  {
  public:
    FuncLinearC()
    {}
    //: Default constructor.
    
    FuncLinearC(UIntT inSize,UIntT outSize)
      : FuncLinearCoeffC(*new FuncLinearBodyC(inSize,outSize))
    {}
    //: Construct a linear function with given input and output size.
    // The transform itsself is left undefined.
    
    FuncLinearC(istream &strm);
    //: Load from stream.
    
    FuncLinearC(BinIStreamC &strm);
    //: Load from binary stream.
    
  protected:
    FuncLinearC(FuncLinearBodyC &bod)
      : FuncLinearCoeffC(bod)
    {}
    //: Body constructor.
    
    FuncLinearC(FuncLinearBodyC *bod)
      : FuncLinearCoeffC(bod)
    {}
    //: Body ptr constructor.
    
    FuncLinearBodyC &Body()
    { return static_cast<FuncLinearBodyC &>(FunctionC::Body()); }
    //: Access body.
    
    const FuncLinearBodyC &Body() const
    { return static_cast<const FuncLinearBodyC &>(FunctionC::Body()); }
    //: Access body.
    
  public:    
  };
  
  inline istream &operator>>(istream &strm,FuncLinearC &obj) {
    obj = FuncLinearC(strm);
    return strm;
  }
  //: Load from a stream.
  // Uses virtual constructor.
  
  inline ostream &operator<<(ostream &out,const FuncLinearC &obj) {
    obj.Save(out);
    return out;
  }
  //: Save to a stream.
  // Uses virtual constructor.
  
  inline BinIStreamC &operator>>(BinIStreamC &strm,FuncLinearC &obj) {
    obj = FuncLinearC(strm);
    return strm;
  }
  //: Load from a binary stream.
  // Uses virtual constructor.
  
  inline BinOStreamC &operator<<(BinOStreamC &out,const FuncLinearC &obj) {
    obj.Save(out);
    return out;
  }
  //: Save to a stream.
  // Uses virtual constructor.
  
}


#endif