/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMultipleValuedNonLinearOptimizer.h,v $
  Language:  C++
  Date:      $Date: 2005/09/24 21:24:35 $
  Version:   $Revision: 1.21 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkMultipleValuedNonLinearOptimizer_h
#define __itkMultipleValuedNonLinearOptimizer_h

#include "itkNonLinearOptimizer.h"
#include "itkArray2D.h"
#include "itkMultipleValuedCostFunction.h"

namespace itk
{
  
/** \class MultipleValuedNonLinearOptimizer
 * \brief This class is a base for the Optimization methods that 
 * optimize a multiple valued function.
 *
 * \ingroup Numerics Optimizers
 */
class ITK_EXPORT MultipleValuedNonLinearOptimizer : 
    public NonLinearOptimizer 
{
public:
  /** Standard class typedefs. */
  typedef MultipleValuedNonLinearOptimizer  Self;
  typedef NonLinearOptimizer                Superclass;
  typedef SmartPointer<Self>                Pointer;
  typedef SmartPointer<const Self>          ConstPointer;
  
   /** Type of the Cost Function   */
  typedef  MultipleValuedCostFunction       CostFunctionType;
  typedef  CostFunctionType::Pointer        CostFunctionPointer;


  /** Method for creation through the object factory. */
  itkNewMacro(Self);
  
  /** Run-time type information (and related methods). */
  itkTypeMacro( MultipleValuedNonLinearOptimizer, NonLinearOptimizer );

  /**  Parameters type.
   *  It defines a position in the optimization search space. */
  typedef Superclass::ParametersType        ParametersType;

  /**  Measure type.
   *  It defines a type used to return the cost function value. 
   *  Here an Array is used for Multivalued functions   */
  typedef Array<double>                     MeasureType;

  /**  Derivative type.
   *  It defines a type used to return the cost function derivative. 
   *  Here a bidimensional Array is used for Multivalued functions   */
  typedef Array2D<double>                   DerivativeType;
 
  /** Set the cost function. */
  virtual void SetCostFunction( CostFunctionType * costFunction );

protected:
  MultipleValuedNonLinearOptimizer();
  virtual ~MultipleValuedNonLinearOptimizer() {}; 
  void PrintSelf(std::ostream& os, Indent indent) const;

  CostFunctionPointer           m_CostFunction;

private:
  MultipleValuedNonLinearOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  

};

} // end namespace itk



#endif



