opencv/modules/optim/include/opencv2/optim.hpp

/*M///////////////////////////////////////////////////////////////////////////////////////
//
//  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
//
//  By downloading, copying, installing or using the software you agree to this license.
//  If you do not agree to this license, do not download, install,
//  copy or use the software.
//
//
//                           License Agreement
//                For Open Source Computer Vision Library
//
// Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
// Copyright (C) 2008-2012, Willow Garage Inc., all rights reserved.
// Third party copyrights are property of their respective owners.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
//   * Redistribution's of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//
//   * Redistribution's 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.
//
//   * The name of the copyright holders may not be used to endorse or promote products
//     derived from this software without specific prior written permission.
//
// This software is provided by the copyright holders and contributors "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 Intel Corporation or contributors 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.
//
//M*/

#ifndef __OPENCV_OPTIM_HPP__
#define __OPENCV_OPTIM_HPP__

#include "opencv2/core.hpp"
#include "opencv2/core/mat.hpp"

/*! \namespace cv
 Namespace where all the C++ OpenCV functionality resides
 */
namespace cv
{

/* //! restores the damaged image areas using one of the available intpainting algorithms */
class Solver : public Algorithm /* Algorithm is the base OpenCV class */
{
  class Function
  {
  public:
        virtual ~Function();
        virtual double calc(InputArray args) const = 0;
        //virtual double calc(InputArray args, OutputArray grad) const = 0;
  };

  // could be reused for all the generic algorithms like downhill simplex.
  virtual void solve(InputArray x0, OutputArray result) const = 0;

  virtual void setTermCriteria(const TermCriteria& criteria) = 0;
  virtual TermCriteria getTermCriteria() = 0;

  // more detailed API to be defined later ...

};

class LPSolver : public Solver
{
public:
     virtual void solve(InputArray coeffs, InputArray constraints, OutputArray result) const = 0;
     // ...
};

Ptr<LPSolver> createLPSimplexSolver();
}// cv

#endif