cmtkFunctional.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2735 $
//
//  $LastChangedDate: 2011-01-14 10:34:12 -0800 (Fri, 14 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkFunctional_h_included_
#define __cmtkFunctional_h_included_

#include <cmtkconfig.h>

#include <System/cmtkSmartPtr.h>
#include <System/cmtkConsole.h>

#include <Base/cmtkVector.h>
#include <Base/cmtkTypes.h>

#ifdef HAVE_UNISTD_H
#  include <unistd.h>
#endif

namespace
cmtk
{


class Functional
{
public:
  typedef Functional Self;

  typedef SmartPointer<Self> SmartPtr;

  typedef Types::Combined<Types::Coordinate,Types::DataItem>::Type ReturnType;

  typedef Vector<Types::Coordinate> ParameterVectorType;

  typedef Types::Coordinate ParameterType;

  virtual void SetParamVector ( ParameterVectorType& )
  {
    StdErr << "ERROR: Functional::SetParamVector() was called but not implemented\n";
    exit( 1 );
  }

  virtual void GetParamVector ( ParameterVectorType& )
  {
    StdErr << "ERROR: Functional::GetParamVector() was called but not implemented\n";
    exit( 1 );
  }

  virtual Self::ReturnType Evaluate() { return 0; } // cannot make this abstract because we need to instantiate this for generic initialization

  virtual Self::ReturnType EvaluateAt( ParameterVectorType& v )
  {
    this->SetParamVector( v );
    return this->Evaluate();
  }

#ifdef CMTK_BUILD_DEMO

  virtual void SnapshotAt( ParameterVectorType& ) {}
#endif

  virtual Self::ReturnType EvaluateAlongGradientAt( ParameterVectorType& v ) { return this->EvaluateAt( v ); }

  virtual Self::ReturnType EvaluateWithGradient( ParameterVectorType& v, ParameterVectorType& g, const Types::Coordinate step = 1 );

  virtual size_t ParamVectorDim() const = 0;

  virtual size_t VariableParamVectorDim() const
  {
    return this->ParamVectorDim();
  }

  virtual ~Functional() {};

  virtual Types::Coordinate GetParamStep( const size_t, const Types::Coordinate mmStep = 1 ) const 
  {
    return mmStep;
  }

  virtual bool Wiggle() { return false; }
};


} // namespace cmtk

#endif // #ifndef _FUNCTIONAL_H_