modules/core/include/opencv2/core/mat.hpp

   1 /*M///////////////////////////////////////////////////////////////////////////////////////
   2 //
   3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
   4 //
   5 //  By downloading, copying, installing or using the software you agree to this license.
   6 //  If you do not agree to this license, do not download, install,
   7 //  copy or use the software.
   8 //
   9 //
  10 //                          License Agreement
  11 //                For Open Source Computer Vision Library
  12 //
  13 // Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
  14 // Copyright (C) 2009, Willow Garage Inc., all rights reserved.
  15 // Copyright (C) 2013, OpenCV Foundation, all rights reserved.
  16 // Third party copyrights are property of their respective owners.
  17 //
  18 // Redistribution and use in source and binary forms, with or without modification,
  19 // are permitted provided that the following conditions are met:
  20 //
  21 //   * Redistribution's of source code must retain the above copyright notice,
  22 //     this list of conditions and the following disclaimer.
  23 //
  24 //   * Redistribution's in binary form must reproduce the above copyright notice,
  25 //     this list of conditions and the following disclaimer in the documentation
  26 //     and/or other materials provided with the distribution.
  27 //
  28 //   * The name of the copyright holders may not be used to endorse or promote products
  29 //     derived from this software without specific prior written permission.
  30 //
  31 // This software is provided by the copyright holders and contributors "as is" and
  32 // any express or implied warranties, including, but not limited to, the implied
  33 // warranties of merchantability and fitness for a particular purpose are disclaimed.
  34 // In no event shall the Intel Corporation or contributors be liable for any direct,
  35 // indirect, incidental, special, exemplary, or consequential damages
  36 // (including, but not limited to, procurement of substitute goods or services;
  37 // loss of use, data, or profits; or business interruption) however caused
  38 // and on any theory of liability, whether in contract, strict liability,
  39 // or tort (including negligence or otherwise) arising in any way out of
  40 // the use of this software, even if advised of the possibility of such damage.
  41 //
  42 //M*/
  43
  44 #ifndef __OPENCV_CORE_MAT_HPP__
  45 #define __OPENCV_CORE_MAT_HPP__
  46
  47 #ifndef __cplusplus
  48 #  error mat.hpp header must be compiled as C++
  49 #endif
  50
  51 #include "opencv2/core/matx.hpp"
  52 #include "opencv2/core/types.hpp"
  53
  54 #include "opencv2/core/bufferpool.hpp"
  55
  56 namespace cv
  57 {
  58
  59 enum { ACCESS_READ=1<<24, ACCESS_WRITE=1<<25,
  60     ACCESS_RW=3<<24, ACCESS_MASK=ACCESS_RW, ACCESS_FAST=1<<26 };
  61
  62 class CV_EXPORTS _OutputArray;
  63
  64 //////////////////////// Input/Output Array Arguments /////////////////////////////////
  65
  66 /*!
  67  Proxy datatype for passing Mat's and vector<>'s as input parameters
  68  */
  69 class CV_EXPORTS _InputArray
  70 {
  71 public:
  72     enum {
  73         KIND_SHIFT = 16,
  74         FIXED_TYPE = 0x8000 << KIND_SHIFT,
  75         FIXED_SIZE = 0x4000 << KIND_SHIFT,
  76         KIND_MASK = 31 << KIND_SHIFT,
  77
  78         NONE              = 0 << KIND_SHIFT,
  79         MAT               = 1 << KIND_SHIFT,
  80         MATX              = 2 << KIND_SHIFT,
  81         STD_VECTOR        = 3 << KIND_SHIFT,
  82         STD_VECTOR_VECTOR = 4 << KIND_SHIFT,
  83         STD_VECTOR_MAT    = 5 << KIND_SHIFT,
  84         EXPR              = 6 << KIND_SHIFT,
  85         OPENGL_BUFFER     = 7 << KIND_SHIFT,
  86         CUDA_MEM          = 8 << KIND_SHIFT,
  87         GPU_MAT           = 9 << KIND_SHIFT,
  88         UMAT              =10 << KIND_SHIFT,
  89         STD_VECTOR_UMAT   =11 << KIND_SHIFT
  90     };
  91
  92     _InputArray();
  93     _InputArray(int _flags, void* _obj);
  94     _InputArray(const Mat& m);
  95     _InputArray(const MatExpr& expr);
  96     _InputArray(const std::vector<Mat>& vec);
  97     template<typename _Tp> _InputArray(const Mat_<_Tp>& m);
  98     template<typename _Tp> _InputArray(const std::vector<_Tp>& vec);
  99     template<typename _Tp> _InputArray(const std::vector<std::vector<_Tp> >& vec);
 100     template<typename _Tp> _InputArray(const std::vector<Mat_<_Tp> >& vec);
 101     template<typename _Tp> _InputArray(const _Tp* vec, int n);
 102     template<typename _Tp, int m, int n> _InputArray(const Matx<_Tp, m, n>& matx);
 103     _InputArray(const double& val);
 104     _InputArray(const cuda::GpuMat& d_mat);
 105     _InputArray(const ogl::Buffer& buf);
 106     _InputArray(const cuda::CudaMem& cuda_mem);
 107     template<typename _Tp> _InputArray(const cudev::GpuMat_<_Tp>& m);
 108     _InputArray(const UMat& um);
 109     _InputArray(const std::vector<UMat>& umv);
 110
 111     virtual Mat getMat(int idx=-1) const;
 112     virtual UMat getUMat(int idx=-1) const;
 113     virtual void getMatVector(std::vector<Mat>& mv) const;
 114     virtual void getUMatVector(std::vector<UMat>& umv) const;
 115     virtual cuda::GpuMat getGpuMat() const;
 116     virtual ogl::Buffer getOGlBuffer() const;
 117     void* getObj() const;
 118
 119     virtual int kind() const;
 120     virtual int dims(int i=-1) const;
 121     virtual int cols(int i=-1) const;
 122     virtual int rows(int i=-1) const;
 123     virtual Size size(int i=-1) const;
 124     virtual int sizend(int* sz, int i=-1) const;
 125     virtual bool sameSize(const _InputArray& arr) const;
 126     virtual size_t total(int i=-1) const;
 127     virtual int type(int i=-1) const;
 128     virtual int depth(int i=-1) const;
 129     virtual int channels(int i=-1) const;
 130     virtual bool isContinuous(int i=-1) const;
 131     virtual bool isSubmatrix(int i=-1) const;
 132     virtual bool empty() const;
 133     virtual void copyTo(const _OutputArray& arr) const;
 134     virtual void copyTo(const _OutputArray& arr, const _InputArray & mask) const;
 135     virtual size_t offset(int i=-1) const;
 136     virtual size_t step(int i=-1) const;
 137     bool isMat() const;
 138     bool isUMat() const;
 139     bool isMatVector() const;
 140     bool isUMatVector() const;
 141     bool isMatx() const;
 142
 143     virtual ~_InputArray();
 144
 145 protected:
 146     int flags;
 147     void* obj;
 148     Size sz;
 149
 150     void init(int _flags, const void* _obj);
 151     void init(int _flags, const void* _obj, Size _sz);
 152 };
 153
 154
 155 /*!
 156  Proxy datatype for passing Mat's and vector<>'s as input parameters
 157  */
 158 class CV_EXPORTS _OutputArray : public _InputArray
 159 {
 160 public:
 161     enum
 162     {
 163         DEPTH_MASK_8U = 1 << CV_8U,
 164         DEPTH_MASK_8S = 1 << CV_8S,
 165         DEPTH_MASK_16U = 1 << CV_16U,
 166         DEPTH_MASK_16S = 1 << CV_16S,
 167         DEPTH_MASK_32S = 1 << CV_32S,
 168         DEPTH_MASK_32F = 1 << CV_32F,
 169         DEPTH_MASK_64F = 1 << CV_64F,
 170         DEPTH_MASK_ALL = (DEPTH_MASK_64F<<1)-1,
 171         DEPTH_MASK_ALL_BUT_8S = DEPTH_MASK_ALL & ~DEPTH_MASK_8S,
 172         DEPTH_MASK_FLT = DEPTH_MASK_32F + DEPTH_MASK_64F
 173     };
 174
 175     _OutputArray();
 176     _OutputArray(int _flags, void* _obj);
 177     _OutputArray(Mat& m);
 178     _OutputArray(std::vector<Mat>& vec);
 179     _OutputArray(cuda::GpuMat& d_mat);
 180     _OutputArray(ogl::Buffer& buf);
 181     _OutputArray(cuda::CudaMem& cuda_mem);
 182     template<typename _Tp> _OutputArray(cudev::GpuMat_<_Tp>& m);
 183     template<typename _Tp> _OutputArray(std::vector<_Tp>& vec);
 184     template<typename _Tp> _OutputArray(std::vector<std::vector<_Tp> >& vec);
 185     template<typename _Tp> _OutputArray(std::vector<Mat_<_Tp> >& vec);
 186     template<typename _Tp> _OutputArray(Mat_<_Tp>& m);
 187     template<typename _Tp> _OutputArray(_Tp* vec, int n);
 188     template<typename _Tp, int m, int n> _OutputArray(Matx<_Tp, m, n>& matx);
 189     _OutputArray(UMat& m);
 190     _OutputArray(std::vector<UMat>& vec);
 191
 192     _OutputArray(const Mat& m);
 193     _OutputArray(const std::vector<Mat>& vec);
 194     _OutputArray(const cuda::GpuMat& d_mat);
 195     _OutputArray(const ogl::Buffer& buf);
 196     _OutputArray(const cuda::CudaMem& cuda_mem);
 197     template<typename _Tp> _OutputArray(const cudev::GpuMat_<_Tp>& m);
 198     template<typename _Tp> _OutputArray(const std::vector<_Tp>& vec);
 199     template<typename _Tp> _OutputArray(const std::vector<std::vector<_Tp> >& vec);
 200     template<typename _Tp> _OutputArray(const std::vector<Mat_<_Tp> >& vec);
 201     template<typename _Tp> _OutputArray(const Mat_<_Tp>& m);
 202     template<typename _Tp> _OutputArray(const _Tp* vec, int n);
 203     template<typename _Tp, int m, int n> _OutputArray(const Matx<_Tp, m, n>& matx);
 204     _OutputArray(const UMat& m);
 205     _OutputArray(const std::vector<UMat>& vec);
 206
 207     virtual bool fixedSize() const;
 208     virtual bool fixedType() const;
 209     virtual bool needed() const;
 210     virtual Mat& getMatRef(int i=-1) const;
 211     virtual UMat& getUMatRef(int i=-1) const;
 212     virtual cuda::GpuMat& getGpuMatRef() const;
 213     virtual ogl::Buffer& getOGlBufferRef() const;
 214     virtual cuda::CudaMem& getCudaMemRef() const;
 215     virtual void create(Size sz, int type, int i=-1, bool allowTransposed=false, int fixedDepthMask=0) const;
 216     virtual void create(int rows, int cols, int type, int i=-1, bool allowTransposed=false, int fixedDepthMask=0) const;
 217     virtual void create(int dims, const int* size, int type, int i=-1, bool allowTransposed=false, int fixedDepthMask=0) const;
 218     virtual void createSameSize(const _InputArray& arr, int mtype) const;
 219     virtual void release() const;
 220     virtual void clear() const;
 221     virtual void setTo(const _InputArray& value, const _InputArray & mask = _InputArray()) const;
 222
 223     void assign(const UMat& u) const;
 224     void assign(const Mat& m) const;
 225 };
 226
 227
 228 class CV_EXPORTS _InputOutputArray : public _OutputArray
 229 {
 230 public:
 231     _InputOutputArray();
 232     _InputOutputArray(int _flags, void* _obj);
 233     _InputOutputArray(Mat& m);
 234     _InputOutputArray(std::vector<Mat>& vec);
 235     _InputOutputArray(cuda::GpuMat& d_mat);
 236     _InputOutputArray(ogl::Buffer& buf);
 237     _InputOutputArray(cuda::CudaMem& cuda_mem);
 238     template<typename _Tp> _InputOutputArray(cudev::GpuMat_<_Tp>& m);
 239     template<typename _Tp> _InputOutputArray(std::vector<_Tp>& vec);
 240     template<typename _Tp> _InputOutputArray(std::vector<std::vector<_Tp> >& vec);
 241     template<typename _Tp> _InputOutputArray(std::vector<Mat_<_Tp> >& vec);
 242     template<typename _Tp> _InputOutputArray(Mat_<_Tp>& m);
 243     template<typename _Tp> _InputOutputArray(_Tp* vec, int n);
 244     template<typename _Tp, int m, int n> _InputOutputArray(Matx<_Tp, m, n>& matx);
 245     _InputOutputArray(UMat& m);
 246     _InputOutputArray(std::vector<UMat>& vec);
 247
 248     _InputOutputArray(const Mat& m);
 249     _InputOutputArray(const std::vector<Mat>& vec);
 250     _InputOutputArray(const cuda::GpuMat& d_mat);
 251     _InputOutputArray(const ogl::Buffer& buf);
 252     _InputOutputArray(const cuda::CudaMem& cuda_mem);
 253     template<typename _Tp> _InputOutputArray(const cudev::GpuMat_<_Tp>& m);
 254     template<typename _Tp> _InputOutputArray(const std::vector<_Tp>& vec);
 255     template<typename _Tp> _InputOutputArray(const std::vector<std::vector<_Tp> >& vec);
 256     template<typename _Tp> _InputOutputArray(const std::vector<Mat_<_Tp> >& vec);
 257     template<typename _Tp> _InputOutputArray(const Mat_<_Tp>& m);
 258     template<typename _Tp> _InputOutputArray(const _Tp* vec, int n);
 259     template<typename _Tp, int m, int n> _InputOutputArray(const Matx<_Tp, m, n>& matx);
 260     _InputOutputArray(const UMat& m);
 261     _InputOutputArray(const std::vector<UMat>& vec);
 262 };
 263
 264 typedef const _InputArray& InputArray;
 265 typedef InputArray InputArrayOfArrays;
 266 typedef const _OutputArray& OutputArray;
 267 typedef OutputArray OutputArrayOfArrays;
 268 typedef const _InputOutputArray& InputOutputArray;
 269 typedef InputOutputArray InputOutputArrayOfArrays;
 270
 271 CV_EXPORTS InputOutputArray noArray();
 272
 273 /////////////////////////////////// MatAllocator //////////////////////////////////////
 274
 275 //! Usage flags for allocator
 276 enum UMatUsageFlags
 277 {
 278     USAGE_DEFAULT = 0,
 279
 280     // default allocation policy is platform and usage specific
 281     USAGE_ALLOCATE_HOST_MEMORY = 1 << 0,
 282     USAGE_ALLOCATE_DEVICE_MEMORY = 1 << 1,
 283
 284     __UMAT_USAGE_FLAGS_32BIT = 0x7fffffff // Binary compatibility hint
 285 };
 286
 287 struct CV_EXPORTS UMatData;
 288
 289 /*!
 290    Custom array allocator
 291
 292 */
 293 class CV_EXPORTS MatAllocator
 294 {
 295 public:
 296     MatAllocator() {}
 297     virtual ~MatAllocator() {}
 298
 299     // let's comment it off for now to detect and fix all the uses of allocator
 300     //virtual void allocate(int dims, const int* sizes, int type, int*& refcount,
 301     //                      uchar*& datastart, uchar*& data, size_t* step) = 0;
 302     //virtual void deallocate(int* refcount, uchar* datastart, uchar* data) = 0;
 303     virtual UMatData* allocate(int dims, const int* sizes, int type,
 304                                void* data, size_t* step, int flags, UMatUsageFlags usageFlags) const = 0;
 305     virtual bool allocate(UMatData* data, int accessflags, UMatUsageFlags usageFlags) const = 0;
 306     virtual void deallocate(UMatData* data) const = 0;
 307     virtual void map(UMatData* data, int accessflags) const;
 308     virtual void unmap(UMatData* data) const;
 309     virtual void download(UMatData* data, void* dst, int dims, const size_t sz[],
 310                           const size_t srcofs[], const size_t srcstep[],
 311                           const size_t dststep[]) const;
 312     virtual void upload(UMatData* data, const void* src, int dims, const size_t sz[],
 313                         const size_t dstofs[], const size_t dststep[],
 314                         const size_t srcstep[]) const;
 315     virtual void copy(UMatData* srcdata, UMatData* dstdata, int dims, const size_t sz[],
 316                       const size_t srcofs[], const size_t srcstep[],
 317                       const size_t dstofs[], const size_t dststep[], bool sync) const;
 318
 319     // default implementation returns DummyBufferPoolController
 320     virtual BufferPoolController* getBufferPoolController() const;
 321 };
 322
 323
 324 //////////////////////////////// MatCommaInitializer //////////////////////////////////
 325
 326 /*!
 327  Comma-separated Matrix Initializer
 328
 329  The class instances are usually not created explicitly.
 330  Instead, they are created on "matrix << firstValue" operator.
 331
 332  The sample below initializes 2x2 rotation matrix:
 333
 334  \code
 335  double angle = 30, a = cos(angle*CV_PI/180), b = sin(angle*CV_PI/180);
 336  Mat R = (Mat_<double>(2,2) << a, -b, b, a);
 337  \endcode
 338 */
 339 template<typename _Tp> class MatCommaInitializer_
 340 {
 341 public:
 342     //! the constructor, created by "matrix << firstValue" operator, where matrix is cv::Mat
 343     MatCommaInitializer_(Mat_<_Tp>* _m);
 344     //! the operator that takes the next value and put it to the matrix
 345     template<typename T2> MatCommaInitializer_<_Tp>& operator , (T2 v);
 346     //! another form of conversion operator
 347     operator Mat_<_Tp>() const;
 348 protected:
 349     MatIterator_<_Tp> it;
 350 };
 351
 352
 353 /////////////////////////////////////// Mat ///////////////////////////////////////////
 354
 355 // note that umatdata might be allocated together
 356 // with the matrix data, not as a separate object.
 357 // therefore, it does not have constructor or destructor;
 358 // it should be explicitly initialized using init().
 359 struct CV_EXPORTS UMatData
 360 {
 361     enum { COPY_ON_MAP=1, HOST_COPY_OBSOLETE=2,
 362         DEVICE_COPY_OBSOLETE=4, TEMP_UMAT=8, TEMP_COPIED_UMAT=24,
 363         USER_ALLOCATED=32, DEVICE_MEM_MAPPED=64};
 364     UMatData(const MatAllocator* allocator);
 365     ~UMatData();
 366
 367     // provide atomic access to the structure
 368     void lock();
 369     void unlock();
 370
 371     bool hostCopyObsolete() const;
 372     bool deviceCopyObsolete() const;
 373     bool deviceMemMapped() const;
 374     bool copyOnMap() const;
 375     bool tempUMat() const;
 376     bool tempCopiedUMat() const;
 377     void markHostCopyObsolete(bool flag);
 378     void markDeviceCopyObsolete(bool flag);
 379     void markDeviceMemMapped(bool flag);
 380
 381     const MatAllocator* prevAllocator;
 382     const MatAllocator* currAllocator;
 383     int urefcount;
 384     int refcount;
 385     uchar* data;
 386     uchar* origdata;
 387     size_t size, capacity;
 388
 389     int flags;
 390     void* handle;
 391     void* userdata;
 392     int allocatorFlags_;
 393 };
 394
 395
 396 struct CV_EXPORTS UMatDataAutoLock
 397 {
 398     UMatDataAutoLock(UMatData* u);
 399     ~UMatDataAutoLock();
 400     UMatData* u;
 401 };
 402
 403
 404 struct CV_EXPORTS MatSize
 405 {
 406     MatSize(int* _p);
 407     Size operator()() const;
 408     const int& operator[](int i) const;
 409     int& operator[](int i);
 410     operator const int*() const;
 411     bool operator == (const MatSize& sz) const;
 412     bool operator != (const MatSize& sz) const;
 413
 414     int* p;
 415 };
 416
 417 struct CV_EXPORTS MatStep
 418 {
 419     MatStep();
 420     MatStep(size_t s);
 421     const size_t& operator[](int i) const;
 422     size_t& operator[](int i);
 423     operator size_t() const;
 424     MatStep& operator = (size_t s);
 425
 426     size_t* p;
 427     size_t buf[2];
 428 protected:
 429     MatStep& operator = (const MatStep&);
 430 };
 431
 432  /*!
 433    The n-dimensional matrix class.
 434
 435    The class represents an n-dimensional dense numerical array that can act as
 436    a matrix, image, optical flow map, 3-focal tensor etc.
 437    It is very similar to CvMat and CvMatND types from earlier versions of OpenCV,
 438    and similarly to those types, the matrix can be multi-channel. It also fully supports ROI mechanism.
 439
 440    There are many different ways to create cv::Mat object. Here are the some popular ones:
 441    <ul>
 442    <li> using cv::Mat::create(nrows, ncols, type) method or
 443      the similar constructor cv::Mat::Mat(nrows, ncols, type[, fill_value]) constructor.
 444      A new matrix of the specified size and specifed type will be allocated.
 445      "type" has the same meaning as in cvCreateMat function,
 446      e.g. CV_8UC1 means 8-bit single-channel matrix, CV_32FC2 means 2-channel (i.e. complex)
 447      floating-point matrix etc:
 448
 449      \code
 450      // make 7x7 complex matrix filled with 1+3j.
 451      cv::Mat M(7,7,CV_32FC2,Scalar(1,3));
 452      // and now turn M to 100x60 15-channel 8-bit matrix.
 453      // The old content will be deallocated
 454      M.create(100,60,CV_8UC(15));
 455      \endcode
 456
 457      As noted in the introduction of this chapter, Mat::create()
 458      will only allocate a new matrix when the current matrix dimensionality
 459      or type are different from the specified.
 460
 461    <li> by using a copy constructor or assignment operator, where on the right side it can
 462      be a matrix or expression, see below. Again, as noted in the introduction,
 463      matrix assignment is O(1) operation because it only copies the header
 464      and increases the reference counter. cv::Mat::clone() method can be used to get a full
 465      (a.k.a. deep) copy of the matrix when you need it.
 466
 467    <li> by constructing a header for a part of another matrix. It can be a single row, single column,
 468      several rows, several columns, rectangular region in the matrix (called a minor in algebra) or
 469      a diagonal. Such operations are also O(1), because the new header will reference the same data.
 470      You can actually modify a part of the matrix using this feature, e.g.
 471
 472      \code
 473      // add 5-th row, multiplied by 3 to the 3rd row
 474      M.row(3) = M.row(3) + M.row(5)*3;
 475
 476      // now copy 7-th column to the 1-st column
 477      // M.col(1) = M.col(7); // this will not work
 478      Mat M1 = M.col(1);
 479      M.col(7).copyTo(M1);
 480
 481      // create new 320x240 image
 482      cv::Mat img(Size(320,240),CV_8UC3);
 483      // select a roi
 484      cv::Mat roi(img, Rect(10,10,100,100));
 485      // fill the ROI with (0,255,0) (which is green in RGB space);
 486      // the original 320x240 image will be modified
 487      roi = Scalar(0,255,0);
 488      \endcode
 489
 490      Thanks to the additional cv::Mat::datastart and cv::Mat::dataend members, it is possible to
 491      compute the relative sub-matrix position in the main "container" matrix using cv::Mat::locateROI():
 492
 493      \code
 494      Mat A = Mat::eye(10, 10, CV_32S);
 495      // extracts A columns, 1 (inclusive) to 3 (exclusive).
 496      Mat B = A(Range::all(), Range(1, 3));
 497      // extracts B rows, 5 (inclusive) to 9 (exclusive).
 498      // that is, C ~ A(Range(5, 9), Range(1, 3))
 499      Mat C = B(Range(5, 9), Range::all());
 500      Size size; Point ofs;
 501      C.locateROI(size, ofs);
 502      // size will be (width=10,height=10) and the ofs will be (x=1, y=5)
 503      \endcode
 504
 505      As in the case of whole matrices, if you need a deep copy, use cv::Mat::clone() method
 506      of the extracted sub-matrices.
 507
 508    <li> by making a header for user-allocated-data. It can be useful for
 509       <ol>
 510       <li> processing "foreign" data using OpenCV (e.g. when you implement
 511          a DirectShow filter or a processing module for gstreamer etc.), e.g.
 512
 513          \code
 514          void process_video_frame(const unsigned char* pixels,
 515                                   int width, int height, int step)
 516          {
 517             cv::Mat img(height, width, CV_8UC3, pixels, step);
 518             cv::GaussianBlur(img, img, cv::Size(7,7), 1.5, 1.5);
 519          }
 520          \endcode
 521
 522       <li> for quick initialization of small matrices and/or super-fast element access
 523
 524          \code
 525          double m[3][3] = {{a, b, c}, {d, e, f}, {g, h, i}};
 526          cv::Mat M = cv::Mat(3, 3, CV_64F, m).inv();
 527          \endcode
 528       </ol>
 529
 530        partial yet very common cases of this "user-allocated data" case are conversions
 531        from CvMat and IplImage to cv::Mat. For this purpose there are special constructors
 532        taking pointers to CvMat or IplImage and the optional
 533        flag indicating whether to copy the data or not.
 534
 535        Backward conversion from cv::Mat to CvMat or IplImage is provided via cast operators
 536        cv::Mat::operator CvMat() an cv::Mat::operator IplImage().
 537        The operators do not copy the data.
 538
 539
 540        \code
 541        IplImage* img = cvLoadImage("greatwave.jpg", 1);
 542        Mat mtx(img); // convert IplImage* -> cv::Mat
 543        CvMat oldmat = mtx; // convert cv::Mat -> CvMat
 544        CV_Assert(oldmat.cols == img->width && oldmat.rows == img->height &&
 545            oldmat.data.ptr == (uchar*)img->imageData && oldmat.step == img->widthStep);
 546        \endcode
 547
 548    <li> by using MATLAB-style matrix initializers, cv::Mat::zeros(), cv::Mat::ones(), cv::Mat::eye(), e.g.:
 549
 550    \code
 551    // create a double-precision identity martix and add it to M.
 552    M += Mat::eye(M.rows, M.cols, CV_64F);
 553    \endcode
 554
 555    <li> by using comma-separated initializer:
 556
 557    \code
 558    // create 3x3 double-precision identity matrix
 559    Mat M = (Mat_<double>(3,3) << 1, 0, 0, 0, 1, 0, 0, 0, 1);
 560    \endcode
 561
 562    here we first call constructor of cv::Mat_ class (that we describe further) with the proper matrix,
 563    and then we just put "<<" operator followed by comma-separated values that can be constants,
 564    variables, expressions etc. Also, note the extra parentheses that are needed to avoid compiler errors.
 565
 566    </ul>
 567
 568    Once matrix is created, it will be automatically managed by using reference-counting mechanism
 569    (unless the matrix header is built on top of user-allocated data,
 570    in which case you should handle the data by yourself).
 571    The matrix data will be deallocated when no one points to it;
 572    if you want to release the data pointed by a matrix header before the matrix destructor is called,
 573    use cv::Mat::release().
 574
 575    The next important thing to learn about the matrix class is element access. Here is how the matrix is stored.
 576    The elements are stored in row-major order (row by row). The cv::Mat::data member points to the first element of the first row,
 577    cv::Mat::rows contains the number of matrix rows and cv::Mat::cols - the number of matrix columns. There is yet another member,
 578    cv::Mat::step that is used to actually compute address of a matrix element. cv::Mat::step is needed because the matrix can be
 579    a part of another matrix or because there can some padding space in the end of each row for a proper alignment.
 580
 581    \image html roi.png
 582
 583    Given these parameters, address of the matrix element M_{ij} is computed as following:
 584
 585    addr(M_{ij})=M.data + M.step*i + j*M.elemSize()
 586
 587    if you know the matrix element type, e.g. it is float, then you can use cv::Mat::at() method:
 588
 589    addr(M_{ij})=&M.at<float>(i,j)
 590
 591    (where & is used to convert the reference returned by cv::Mat::at() to a pointer).
 592    if you need to process a whole row of matrix, the most efficient way is to get
 593    the pointer to the row first, and then just use plain C operator []:
 594
 595    \code
 596    // compute sum of positive matrix elements
 597    // (assuming that M is double-precision matrix)
 598    double sum=0;
 599    for(int i = 0; i < M.rows; i++)
 600    {
 601        const double* Mi = M.ptr<double>(i);
 602        for(int j = 0; j < M.cols; j++)
 603            sum += std::max(Mi[j], 0.);
 604    }
 605    \endcode
 606
 607    Some operations, like the above one, do not actually depend on the matrix shape,
 608    they just process elements of a matrix one by one (or elements from multiple matrices
 609    that are sitting in the same place, e.g. matrix addition). Such operations are called
 610    element-wise and it makes sense to check whether all the input/output matrices are continuous,
 611    i.e. have no gaps in the end of each row, and if yes, process them as a single long row:
 612
 613    \code
 614    // compute sum of positive matrix elements, optimized variant
 615    double sum=0;
 616    int cols = M.cols, rows = M.rows;
 617    if(M.isContinuous())
 618    {
 619        cols *= rows;
 620        rows = 1;
 621    }
 622    for(int i = 0; i < rows; i++)
 623    {
 624        const double* Mi = M.ptr<double>(i);
 625        for(int j = 0; j < cols; j++)
 626            sum += std::max(Mi[j], 0.);
 627    }
 628    \endcode
 629    in the case of continuous matrix the outer loop body will be executed just once,
 630    so the overhead will be smaller, which will be especially noticeable in the case of small matrices.
 631
 632    Finally, there are STL-style iterators that are smart enough to skip gaps between successive rows:
 633    \code
 634    // compute sum of positive matrix elements, iterator-based variant
 635    double sum=0;
 636    MatConstIterator_<double> it = M.begin<double>(), it_end = M.end<double>();
 637    for(; it != it_end; ++it)
 638        sum += std::max(*it, 0.);
 639    \endcode
 640
 641    The matrix iterators are random-access iterators, so they can be passed
 642    to any STL algorithm, including std::sort().
 643 */
 644 class CV_EXPORTS Mat
 645 {
 646 public:
 647     //! default constructor
 648     Mat();
 649     //! constructs 2D matrix of the specified size and type
 650     // (_type is CV_8UC1, CV_64FC3, CV_32SC(12) etc.)
 651     Mat(int rows, int cols, int type);
 652     Mat(Size size, int type);
 653     //! constucts 2D matrix and fills it with the specified value _s.
 654     Mat(int rows, int cols, int type, const Scalar& s);
 655     Mat(Size size, int type, const Scalar& s);
 656
 657     //! constructs n-dimensional matrix
 658     Mat(int ndims, const int* sizes, int type);
 659     Mat(int ndims, const int* sizes, int type, const Scalar& s);
 660
 661     //! copy constructor
 662     Mat(const Mat& m);
 663     //! constructor for matrix headers pointing to user-allocated data
 664     Mat(int rows, int cols, int type, void* data, size_t step=AUTO_STEP);
 665     Mat(Size size, int type, void* data, size_t step=AUTO_STEP);
 666     Mat(int ndims, const int* sizes, int type, void* data, const size_t* steps=0);
 667
 668     //! creates a matrix header for a part of the bigger matrix
 669     Mat(const Mat& m, const Range& rowRange, const Range& colRange=Range::all());
 670     Mat(const Mat& m, const Rect& roi);
 671     Mat(const Mat& m, const Range* ranges);
 672     //! builds matrix from std::vector with or without copying the data
 673     template<typename _Tp> explicit Mat(const std::vector<_Tp>& vec, bool copyData=false);
 674     //! builds matrix from cv::Vec; the data is copied by default
 675     template<typename _Tp, int n> explicit Mat(const Vec<_Tp, n>& vec, bool copyData=true);
 676     //! builds matrix from cv::Matx; the data is copied by default
 677     template<typename _Tp, int m, int n> explicit Mat(const Matx<_Tp, m, n>& mtx, bool copyData=true);
 678     //! builds matrix from a 2D point
 679     template<typename _Tp> explicit Mat(const Point_<_Tp>& pt, bool copyData=true);
 680     //! builds matrix from a 3D point
 681     template<typename _Tp> explicit Mat(const Point3_<_Tp>& pt, bool copyData=true);
 682     //! builds matrix from comma initializer
 683     template<typename _Tp> explicit Mat(const MatCommaInitializer_<_Tp>& commaInitializer);
 684
 685     //! download data from GpuMat
 686     explicit Mat(const cuda::GpuMat& m);
 687
 688     //! destructor - calls release()
 689     ~Mat();
 690     //! assignment operators
 691     Mat& operator = (const Mat& m);
 692     Mat& operator = (const MatExpr& expr);
 693
 694     //! retrieve UMat from Mat
 695     UMat getUMat(int accessFlags, UMatUsageFlags usageFlags = USAGE_DEFAULT) const;
 696
 697     //! returns a new matrix header for the specified row
 698     Mat row(int y) const;
 699     //! returns a new matrix header for the specified column
 700     Mat col(int x) const;
 701     //! ... for the specified row span
 702     Mat rowRange(int startrow, int endrow) const;
 703     Mat rowRange(const Range& r) const;
 704     //! ... for the specified column span
 705     Mat colRange(int startcol, int endcol) const;
 706     Mat colRange(const Range& r) const;
 707     //! ... for the specified diagonal
 708     // (d=0 - the main diagonal,
 709     //  >0 - a diagonal from the lower half,
 710     //  <0 - a diagonal from the upper half)
 711     Mat diag(int d=0) const;
 712     //! constructs a square diagonal matrix which main diagonal is vector "d"
 713     static Mat diag(const Mat& d);
 714
 715     //! returns deep copy of the matrix, i.e. the data is copied
 716     Mat clone() const;
 717     //! copies the matrix content to "m".
 718     // It calls m.create(this->size(), this->type()).
 719     void copyTo( OutputArray m ) const;
 720     //! copies those matrix elements to "m" that are marked with non-zero mask elements.
 721     void copyTo( OutputArray m, InputArray mask ) const;
 722     //! converts matrix to another datatype with optional scalng. See cvConvertScale.
 723     void convertTo( OutputArray m, int rtype, double alpha=1, double beta=0 ) const;
 724
 725     void assignTo( Mat& m, int type=-1 ) const;
 726
 727     //! sets every matrix element to s
 728     Mat& operator = (const Scalar& s);
 729     //! sets some of the matrix elements to s, according to the mask
 730     Mat& setTo(InputArray value, InputArray mask=noArray());
 731     //! creates alternative matrix header for the same data, with different
 732     // number of channels and/or different number of rows. see cvReshape.
 733     Mat reshape(int cn, int rows=0) const;
 734     Mat reshape(int cn, int newndims, const int* newsz) const;
 735
 736     //! matrix transposition by means of matrix expressions
 737     MatExpr t() const;
 738     //! matrix inversion by means of matrix expressions
 739     MatExpr inv(int method=DECOMP_LU) const;
 740     //! per-element matrix multiplication by means of matrix expressions
 741     MatExpr mul(InputArray m, double scale=1) const;
 742
 743     //! computes cross-product of 2 3D vectors
 744     Mat cross(InputArray m) const;
 745     //! computes dot-product
 746     double dot(InputArray m) const;
 747
 748     //! Matlab-style matrix initialization
 749     static MatExpr zeros(int rows, int cols, int type);
 750     static MatExpr zeros(Size size, int type);
 751     static MatExpr zeros(int ndims, const int* sz, int type);
 752     static MatExpr ones(int rows, int cols, int type);
 753     static MatExpr ones(Size size, int type);
 754     static MatExpr ones(int ndims, const int* sz, int type);
 755     static MatExpr eye(int rows, int cols, int type);
 756     static MatExpr eye(Size size, int type);
 757
 758     //! allocates new matrix data unless the matrix already has specified size and type.
 759     // previous data is unreferenced if needed.
 760     void create(int rows, int cols, int type);
 761     void create(Size size, int type);
 762     void create(int ndims, const int* sizes, int type);
 763
 764     //! increases the reference counter; use with care to avoid memleaks
 765     void addref();
 766     //! decreases reference counter;
 767     // deallocates the data when reference counter reaches 0.
 768     void release();
 769
 770     //! deallocates the matrix data
 771     void deallocate();
 772     //! internal use function; properly re-allocates _size, _step arrays
 773     void copySize(const Mat& m);
 774
 775     //! reserves enough space to fit sz hyper-planes
 776     void reserve(size_t sz);
 777     //! resizes matrix to the specified number of hyper-planes
 778     void resize(size_t sz);
 779     //! resizes matrix to the specified number of hyper-planes; initializes the newly added elements
 780     void resize(size_t sz, const Scalar& s);
 781     //! internal function
 782     void push_back_(const void* elem);
 783     //! adds element to the end of 1d matrix (or possibly multiple elements when _Tp=Mat)
 784     template<typename _Tp> void push_back(const _Tp& elem);
 785     template<typename _Tp> void push_back(const Mat_<_Tp>& elem);
 786     void push_back(const Mat& m);
 787     //! removes several hyper-planes from bottom of the matrix
 788     void pop_back(size_t nelems=1);
 789
 790     //! locates matrix header within a parent matrix. See below
 791     void locateROI( Size& wholeSize, Point& ofs ) const;
 792     //! moves/resizes the current matrix ROI inside the parent matrix.
 793     Mat& adjustROI( int dtop, int dbottom, int dleft, int dright );
 794     //! extracts a rectangular sub-matrix
 795     // (this is a generalized form of row, rowRange etc.)
 796     Mat operator()( Range rowRange, Range colRange ) const;
 797     Mat operator()( const Rect& roi ) const;
 798     Mat operator()( const Range* ranges ) const;
 799
 800     // //! converts header to CvMat; no data is copied
 801     // operator CvMat() const;
 802     // //! converts header to CvMatND; no data is copied
 803     // operator CvMatND() const;
 804     // //! converts header to IplImage; no data is copied
 805     // operator IplImage() const;
 806
 807     template<typename _Tp> operator std::vector<_Tp>() const;
 808     template<typename _Tp, int n> operator Vec<_Tp, n>() const;
 809     template<typename _Tp, int m, int n> operator Matx<_Tp, m, n>() const;
 810
 811     //! returns true iff the matrix data is continuous
 812     // (i.e. when there are no gaps between successive rows).
 813     // similar to CV_IS_MAT_CONT(cvmat->type)
 814     bool isContinuous() const;
 815
 816     //! returns true if the matrix is a submatrix of another matrix
 817     bool isSubmatrix() const;
 818
 819     //! returns element size in bytes,
 820     // similar to CV_ELEM_SIZE(cvmat->type)
 821     size_t elemSize() const;
 822     //! returns the size of element channel in bytes.
 823     size_t elemSize1() const;
 824     //! returns element type, similar to CV_MAT_TYPE(cvmat->type)
 825     int type() const;
 826     //! returns element type, similar to CV_MAT_DEPTH(cvmat->type)
 827     int depth() const;
 828     //! returns element type, similar to CV_MAT_CN(cvmat->type)
 829     int channels() const;
 830     //! returns step/elemSize1()
 831     size_t step1(int i=0) const;
 832     //! returns true if matrix data is NULL
 833     bool empty() const;
 834     //! returns the total number of matrix elements
 835     size_t total() const;
 836
 837     //! returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise
 838     int checkVector(int elemChannels, int depth=-1, bool requireContinuous=true) const;
 839
 840     //! returns pointer to i0-th submatrix along the dimension #0
 841     uchar* ptr(int i0=0);
 842     const uchar* ptr(int i0=0) const;
 843
 844     //! returns pointer to (i0,i1) submatrix along the dimensions #0 and #1
 845     uchar* ptr(int i0, int i1);
 846     const uchar* ptr(int i0, int i1) const;
 847
 848     //! returns pointer to (i0,i1,i3) submatrix along the dimensions #0, #1, #2
 849     uchar* ptr(int i0, int i1, int i2);
 850     const uchar* ptr(int i0, int i1, int i2) const;
 851
 852     //! returns pointer to the matrix element
 853     uchar* ptr(const int* idx);
 854     //! returns read-only pointer to the matrix element
 855     const uchar* ptr(const int* idx) const;
 856
 857     template<int n> uchar* ptr(const Vec<int, n>& idx);
 858     template<int n> const uchar* ptr(const Vec<int, n>& idx) const;
 859
 860     //! template version of the above method
 861     template<typename _Tp> _Tp* ptr(int i0=0);
 862     template<typename _Tp> const _Tp* ptr(int i0=0) const;
 863
 864     template<typename _Tp> _Tp* ptr(int i0, int i1);
 865     template<typename _Tp> const _Tp* ptr(int i0, int i1) const;
 866
 867     template<typename _Tp> _Tp* ptr(int i0, int i1, int i2);
 868     template<typename _Tp> const _Tp* ptr(int i0, int i1, int i2) const;
 869
 870     template<typename _Tp> _Tp* ptr(const int* idx);
 871     template<typename _Tp> const _Tp* ptr(const int* idx) const;
 872
 873     template<typename _Tp, int n> _Tp* ptr(const Vec<int, n>& idx);
 874     template<typename _Tp, int n> const _Tp* ptr(const Vec<int, n>& idx) const;
 875
 876     //! the same as above, with the pointer dereferencing
 877     template<typename _Tp> _Tp& at(int i0=0);
 878     template<typename _Tp> const _Tp& at(int i0=0) const;
 879
 880     template<typename _Tp> _Tp& at(int i0, int i1);
 881     template<typename _Tp> const _Tp& at(int i0, int i1) const;
 882
 883     template<typename _Tp> _Tp& at(int i0, int i1, int i2);
 884     template<typename _Tp> const _Tp& at(int i0, int i1, int i2) const;
 885
 886     template<typename _Tp> _Tp& at(const int* idx);
 887     template<typename _Tp> const _Tp& at(const int* idx) const;
 888
 889     template<typename _Tp, int n> _Tp& at(const Vec<int, n>& idx);
 890     template<typename _Tp, int n> const _Tp& at(const Vec<int, n>& idx) const;
 891
 892     //! special versions for 2D arrays (especially convenient for referencing image pixels)
 893     template<typename _Tp> _Tp& at(Point pt);
 894     template<typename _Tp> const _Tp& at(Point pt) const;
 895
 896     //! template methods for iteration over matrix elements.
 897     // the iterators take care of skipping gaps in the end of rows (if any)
 898     template<typename _Tp> MatIterator_<_Tp> begin();
 899     template<typename _Tp> MatIterator_<_Tp> end();
 900     template<typename _Tp> MatConstIterator_<_Tp> begin() const;
 901     template<typename _Tp> MatConstIterator_<_Tp> end() const;
 902
 903     enum { MAGIC_VAL  = 0x42FF0000, AUTO_STEP = 0, CONTINUOUS_FLAG = CV_MAT_CONT_FLAG, SUBMATRIX_FLAG = CV_SUBMAT_FLAG };
 904     enum { MAGIC_MASK = 0xFFFF0000, TYPE_MASK = 0x00000FFF, DEPTH_MASK = 7 };
 905
 906     /*! includes several bit-fields:
 907          - the magic signature
 908          - continuity flag
 909          - depth
 910          - number of channels
 911      */
 912     int flags;
 913     //! the matrix dimensionality, >= 2
 914     int dims;
 915     //! the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions
 916     int rows, cols;
 917     //! pointer to the data
 918     uchar* data;
 919
 920     //! helper fields used in locateROI and adjustROI
 921     uchar* datastart;
 922     uchar* dataend;
 923     uchar* datalimit;
 924
 925     //! custom allocator
 926     MatAllocator* allocator;
 927     //! and the standard allocator
 928     static MatAllocator* getStdAllocator();
 929
 930     //! interaction with UMat
 931     UMatData* u;
 932
 933     MatSize size;
 934     MatStep step;
 935
 936 protected:
 937 };
 938
 939
 940 ///////////////////////////////// Mat_<_Tp> ////////////////////////////////////
 941
 942 /*!
 943  Template matrix class derived from Mat
 944
 945  The class Mat_ is a "thin" template wrapper on top of cv::Mat. It does not have any extra data fields,
 946  nor it or cv::Mat have any virtual methods and thus references or pointers to these two classes
 947  can be safely converted one to another. But do it with care, for example:
 948
 949  \code
 950  // create 100x100 8-bit matrix
 951  Mat M(100,100,CV_8U);
 952  // this will compile fine. no any data conversion will be done.
 953  Mat_<float>& M1 = (Mat_<float>&)M;
 954  // the program will likely crash at the statement below
 955  M1(99,99) = 1.f;
 956  \endcode
 957
 958  While cv::Mat is sufficient in most cases, cv::Mat_ can be more convenient if you use a lot of element
 959  access operations and if you know matrix type at compile time.
 960  Note that cv::Mat::at<_Tp>(int y, int x) and cv::Mat_<_Tp>::operator ()(int y, int x) do absolutely the
 961  same thing and run at the same speed, but the latter is certainly shorter:
 962
 963  \code
 964  Mat_<double> M(20,20);
 965  for(int i = 0; i < M.rows; i++)
 966     for(int j = 0; j < M.cols; j++)
 967        M(i,j) = 1./(i+j+1);
 968  Mat E, V;
 969  eigen(M,E,V);
 970  cout << E.at<double>(0,0)/E.at<double>(M.rows-1,0);
 971  \endcode
 972
 973  It is easy to use Mat_ for multi-channel images/matrices - just pass cv::Vec as cv::Mat_ template parameter:
 974
 975  \code
 976  // allocate 320x240 color image and fill it with green (in RGB space)
 977  Mat_<Vec3b> img(240, 320, Vec3b(0,255,0));
 978  // now draw a diagonal white line
 979  for(int i = 0; i < 100; i++)
 980      img(i,i)=Vec3b(255,255,255);
 981  // and now modify the 2nd (red) channel of each pixel
 982  for(int i = 0; i < img.rows; i++)
 983     for(int j = 0; j < img.cols; j++)
 984        img(i,j)[2] ^= (uchar)(i ^ j); // img(y,x)[c] accesses c-th channel of the pixel (x,y)
 985  \endcode
 986 */
 987 template<typename _Tp> class Mat_ : public Mat
 988 {
 989 public:
 990     typedef _Tp value_type;
 991     typedef typename DataType<_Tp>::channel_type channel_type;
 992     typedef MatIterator_<_Tp> iterator;
 993     typedef MatConstIterator_<_Tp> const_iterator;
 994
 995     //! default constructor
 996     Mat_();
 997     //! equivalent to Mat(_rows, _cols, DataType<_Tp>::type)
 998     Mat_(int _rows, int _cols);
 999     //! constructor that sets each matrix element to specified value
1000     Mat_(int _rows, int _cols, const _Tp& value);
1001     //! equivalent to Mat(_size, DataType<_Tp>::type)
1002     explicit Mat_(Size _size);
1003     //! constructor that sets each matrix element to specified value
1004     Mat_(Size _size, const _Tp& value);
1005     //! n-dim array constructor
1006     Mat_(int _ndims, const int* _sizes);
1007     //! n-dim array constructor that sets each matrix element to specified value
1008     Mat_(int _ndims, const int* _sizes, const _Tp& value);
1009     //! copy/conversion contructor. If m is of different type, it's converted
1010     Mat_(const Mat& m);
1011     //! copy constructor
1012     Mat_(const Mat_& m);
1013     //! constructs a matrix on top of user-allocated data. step is in bytes(!!!), regardless of the type
1014     Mat_(int _rows, int _cols, _Tp* _data, size_t _step=AUTO_STEP);
1015     //! constructs n-dim matrix on top of user-allocated data. steps are in bytes(!!!), regardless of the type
1016     Mat_(int _ndims, const int* _sizes, _Tp* _data, const size_t* _steps=0);
1017     //! selects a submatrix
1018     Mat_(const Mat_& m, const Range& rowRange, const Range& colRange=Range::all());
1019     //! selects a submatrix
1020     Mat_(const Mat_& m, const Rect& roi);
1021     //! selects a submatrix, n-dim version
1022     Mat_(const Mat_& m, const Range* ranges);
1023     //! from a matrix expression
1024     explicit Mat_(const MatExpr& e);
1025     //! makes a matrix out of Vec, std::vector, Point_ or Point3_. The matrix will have a single column
1026     explicit Mat_(const std::vector<_Tp>& vec, bool copyData=false);
1027     template<int n> explicit Mat_(const Vec<typename DataType<_Tp>::channel_type, n>& vec, bool copyData=true);
1028     template<int m, int n> explicit Mat_(const Matx<typename DataType<_Tp>::channel_type, m, n>& mtx, bool copyData=true);
1029     explicit Mat_(const Point_<typename DataType<_Tp>::channel_type>& pt, bool copyData=true);
1030     explicit Mat_(const Point3_<typename DataType<_Tp>::channel_type>& pt, bool copyData=true);
1031     explicit Mat_(const MatCommaInitializer_<_Tp>& commaInitializer);
1032
1033     Mat_& operator = (const Mat& m);
1034     Mat_& operator = (const Mat_& m);
1035     //! set all the elements to s.
1036     Mat_& operator = (const _Tp& s);
1037     //! assign a matrix expression
1038     Mat_& operator = (const MatExpr& e);
1039
1040     //! iterators; they are smart enough to skip gaps in the end of rows
1041     iterator begin();
1042     iterator end();
1043     const_iterator begin() const;
1044     const_iterator end() const;
1045
1046     //! equivalent to Mat::create(_rows, _cols, DataType<_Tp>::type)
1047     void create(int _rows, int _cols);
1048     //! equivalent to Mat::create(_size, DataType<_Tp>::type)
1049     void create(Size _size);
1050     //! equivalent to Mat::create(_ndims, _sizes, DatType<_Tp>::type)
1051     void create(int _ndims, const int* _sizes);
1052     //! cross-product
1053     Mat_ cross(const Mat_& m) const;
1054     //! data type conversion
1055     template<typename T2> operator Mat_<T2>() const;
1056     //! overridden forms of Mat::row() etc.
1057     Mat_ row(int y) const;
1058     Mat_ col(int x) const;
1059     Mat_ diag(int d=0) const;
1060     Mat_ clone() const;
1061
1062     //! overridden forms of Mat::elemSize() etc.
1063     size_t elemSize() const;
1064     size_t elemSize1() const;
1065     int type() const;
1066     int depth() const;
1067     int channels() const;
1068     size_t step1(int i=0) const;
1069     //! returns step()/sizeof(_Tp)
1070     size_t stepT(int i=0) const;
1071
1072     //! overridden forms of Mat::zeros() etc. Data type is omitted, of course
1073     static MatExpr zeros(int rows, int cols);
1074     static MatExpr zeros(Size size);
1075     static MatExpr zeros(int _ndims, const int* _sizes);
1076     static MatExpr ones(int rows, int cols);
1077     static MatExpr ones(Size size);
1078     static MatExpr ones(int _ndims, const int* _sizes);
1079     static MatExpr eye(int rows, int cols);
1080     static MatExpr eye(Size size);
1081
1082     //! some more overriden methods
1083     Mat_& adjustROI( int dtop, int dbottom, int dleft, int dright );
1084     Mat_ operator()( const Range& rowRange, const Range& colRange ) const;
1085     Mat_ operator()( const Rect& roi ) const;
1086     Mat_ operator()( const Range* ranges ) const;
1087
1088     //! more convenient forms of row and element access operators
1089     _Tp* operator [](int y);
1090     const _Tp* operator [](int y) const;
1091
1092     //! returns reference to the specified element
1093     _Tp& operator ()(const int* idx);
1094     //! returns read-only reference to the specified element
1095     const _Tp& operator ()(const int* idx) const;
1096
1097     //! returns reference to the specified element
1098     template<int n> _Tp& operator ()(const Vec<int, n>& idx);
1099     //! returns read-only reference to the specified element
1100     template<int n> const _Tp& operator ()(const Vec<int, n>& idx) const;
1101
1102     //! returns reference to the specified element (1D case)
1103     _Tp& operator ()(int idx0);
1104     //! returns read-only reference to the specified element (1D case)
1105     const _Tp& operator ()(int idx0) const;
1106     //! returns reference to the specified element (2D case)
1107     _Tp& operator ()(int idx0, int idx1);
1108     //! returns read-only reference to the specified element (2D case)
1109     const _Tp& operator ()(int idx0, int idx1) const;
1110     //! returns reference to the specified element (3D case)
1111     _Tp& operator ()(int idx0, int idx1, int idx2);
1112     //! returns read-only reference to the specified element (3D case)
1113     const _Tp& operator ()(int idx0, int idx1, int idx2) const;
1114
1115     _Tp& operator ()(Point pt);
1116     const _Tp& operator ()(Point pt) const;
1117
1118     //! conversion to vector.
1119     operator std::vector<_Tp>() const;
1120     //! conversion to Vec
1121     template<int n> operator Vec<typename DataType<_Tp>::channel_type, n>() const;
1122     //! conversion to Matx
1123     template<int m, int n> operator Matx<typename DataType<_Tp>::channel_type, m, n>() const;
1124 };
1125
1126 typedef Mat_<uchar> Mat1b;
1127 typedef Mat_<Vec2b> Mat2b;
1128 typedef Mat_<Vec3b> Mat3b;
1129 typedef Mat_<Vec4b> Mat4b;
1130
1131 typedef Mat_<short> Mat1s;
1132 typedef Mat_<Vec2s> Mat2s;
1133 typedef Mat_<Vec3s> Mat3s;
1134 typedef Mat_<Vec4s> Mat4s;
1135
1136 typedef Mat_<ushort> Mat1w;
1137 typedef Mat_<Vec2w> Mat2w;
1138 typedef Mat_<Vec3w> Mat3w;
1139 typedef Mat_<Vec4w> Mat4w;
1140
1141 typedef Mat_<int>   Mat1i;
1142 typedef Mat_<Vec2i> Mat2i;
1143 typedef Mat_<Vec3i> Mat3i;
1144 typedef Mat_<Vec4i> Mat4i;
1145
1146 typedef Mat_<float> Mat1f;
1147 typedef Mat_<Vec2f> Mat2f;
1148 typedef Mat_<Vec3f> Mat3f;
1149 typedef Mat_<Vec4f> Mat4f;
1150
1151 typedef Mat_<double> Mat1d;
1152 typedef Mat_<Vec2d> Mat2d;
1153 typedef Mat_<Vec3d> Mat3d;
1154 typedef Mat_<Vec4d> Mat4d;
1155
1156 class CV_EXPORTS UMat
1157 {
1158 public:
1159     //! default constructor
1160     UMat(UMatUsageFlags usageFlags = USAGE_DEFAULT);
1161     //! constructs 2D matrix of the specified size and type
1162     // (_type is CV_8UC1, CV_64FC3, CV_32SC(12) etc.)
1163     UMat(int rows, int cols, int type, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1164     UMat(Size size, int type, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1165     //! constucts 2D matrix and fills it with the specified value _s.
1166     UMat(int rows, int cols, int type, const Scalar& s, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1167     UMat(Size size, int type, const Scalar& s, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1168
1169     //! constructs n-dimensional matrix
1170     UMat(int ndims, const int* sizes, int type, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1171     UMat(int ndims, const int* sizes, int type, const Scalar& s, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1172
1173     //! copy constructor
1174     UMat(const UMat& m);
1175
1176     //! creates a matrix header for a part of the bigger matrix
1177     UMat(const UMat& m, const Range& rowRange, const Range& colRange=Range::all());
1178     UMat(const UMat& m, const Rect& roi);
1179     UMat(const UMat& m, const Range* ranges);
1180     //! builds matrix from std::vector with or without copying the data
1181     template<typename _Tp> explicit UMat(const std::vector<_Tp>& vec, bool copyData=false);
1182     //! builds matrix from cv::Vec; the data is copied by default
1183     template<typename _Tp, int n> explicit UMat(const Vec<_Tp, n>& vec, bool copyData=true);
1184     //! builds matrix from cv::Matx; the data is copied by default
1185     template<typename _Tp, int m, int n> explicit UMat(const Matx<_Tp, m, n>& mtx, bool copyData=true);
1186     //! builds matrix from a 2D point
1187     template<typename _Tp> explicit UMat(const Point_<_Tp>& pt, bool copyData=true);
1188     //! builds matrix from a 3D point
1189     template<typename _Tp> explicit UMat(const Point3_<_Tp>& pt, bool copyData=true);
1190     //! builds matrix from comma initializer
1191     template<typename _Tp> explicit UMat(const MatCommaInitializer_<_Tp>& commaInitializer);
1192
1193     //! destructor - calls release()
1194     ~UMat();
1195     //! assignment operators
1196     UMat& operator = (const UMat& m);
1197
1198     Mat getMat(int flags) const;
1199
1200     //! returns a new matrix header for the specified row
1201     UMat row(int y) const;
1202     //! returns a new matrix header for the specified column
1203     UMat col(int x) const;
1204     //! ... for the specified row span
1205     UMat rowRange(int startrow, int endrow) const;
1206     UMat rowRange(const Range& r) const;
1207     //! ... for the specified column span
1208     UMat colRange(int startcol, int endcol) const;
1209     UMat colRange(const Range& r) const;
1210     //! ... for the specified diagonal
1211     // (d=0 - the main diagonal,
1212     //  >0 - a diagonal from the lower half,
1213     //  <0 - a diagonal from the upper half)
1214     UMat diag(int d=0) const;
1215     //! constructs a square diagonal matrix which main diagonal is vector "d"
1216     static UMat diag(const UMat& d);
1217
1218     //! returns deep copy of the matrix, i.e. the data is copied
1219     UMat clone() const;
1220     //! copies the matrix content to "m".
1221     // It calls m.create(this->size(), this->type()).
1222     void copyTo( OutputArray m ) const;
1223     //! copies those matrix elements to "m" that are marked with non-zero mask elements.
1224     void copyTo( OutputArray m, InputArray mask ) const;
1225     //! converts matrix to another datatype with optional scalng. See cvConvertScale.
1226     void convertTo( OutputArray m, int rtype, double alpha=1, double beta=0 ) const;
1227
1228     void assignTo( UMat& m, int type=-1 ) const;
1229
1230     //! sets every matrix element to s
1231     UMat& operator = (const Scalar& s);
1232     //! sets some of the matrix elements to s, according to the mask
1233     UMat& setTo(InputArray value, InputArray mask=noArray());
1234     //! creates alternative matrix header for the same data, with different
1235     // number of channels and/or different number of rows. see cvReshape.
1236     UMat reshape(int cn, int rows=0) const;
1237     UMat reshape(int cn, int newndims, const int* newsz) const;
1238
1239     //! matrix transposition by means of matrix expressions
1240     UMat t() const;
1241     //! matrix inversion by means of matrix expressions
1242     UMat inv(int method=DECOMP_LU) const;
1243     //! per-element matrix multiplication by means of matrix expressions
1244     UMat mul(InputArray m, double scale=1) const;
1245
1246     //! computes dot-product
1247     double dot(InputArray m) const;
1248
1249     //! Matlab-style matrix initialization
1250     static UMat zeros(int rows, int cols, int type);
1251     static UMat zeros(Size size, int type);
1252     static UMat zeros(int ndims, const int* sz, int type);
1253     static UMat ones(int rows, int cols, int type);
1254     static UMat ones(Size size, int type);
1255     static UMat ones(int ndims, const int* sz, int type);
1256     static UMat eye(int rows, int cols, int type);
1257     static UMat eye(Size size, int type);
1258
1259     //! allocates new matrix data unless the matrix already has specified size and type.
1260     // previous data is unreferenced if needed.
1261     void create(int rows, int cols, int type, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1262     void create(Size size, int type, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1263     void create(int ndims, const int* sizes, int type, UMatUsageFlags usageFlags = USAGE_DEFAULT);
1264
1265     //! increases the reference counter; use with care to avoid memleaks
1266     void addref();
1267     //! decreases reference counter;
1268     // deallocates the data when reference counter reaches 0.
1269     void release();
1270
1271     //! deallocates the matrix data
1272     void deallocate();
1273     //! internal use function; properly re-allocates _size, _step arrays
1274     void copySize(const UMat& m);
1275
1276     //! locates matrix header within a parent matrix. See below
1277     void locateROI( Size& wholeSize, Point& ofs ) const;
1278     //! moves/resizes the current matrix ROI inside the parent matrix.
1279     UMat& adjustROI( int dtop, int dbottom, int dleft, int dright );
1280     //! extracts a rectangular sub-matrix
1281     // (this is a generalized form of row, rowRange etc.)
1282     UMat operator()( Range rowRange, Range colRange ) const;
1283     UMat operator()( const Rect& roi ) const;
1284     UMat operator()( const Range* ranges ) const;
1285
1286     //! returns true iff the matrix data is continuous
1287     // (i.e. when there are no gaps between successive rows).
1288     // similar to CV_IS_MAT_CONT(cvmat->type)
1289     bool isContinuous() const;
1290
1291     //! returns true if the matrix is a submatrix of another matrix
1292     bool isSubmatrix() const;
1293
1294     //! returns element size in bytes,
1295     // similar to CV_ELEM_SIZE(cvmat->type)
1296     size_t elemSize() const;
1297     //! returns the size of element channel in bytes.
1298     size_t elemSize1() const;
1299     //! returns element type, similar to CV_MAT_TYPE(cvmat->type)
1300     int type() const;
1301     //! returns element type, similar to CV_MAT_DEPTH(cvmat->type)
1302     int depth() const;
1303     //! returns element type, similar to CV_MAT_CN(cvmat->type)
1304     int channels() const;
1305     //! returns step/elemSize1()
1306     size_t step1(int i=0) const;
1307     //! returns true if matrix data is NULL
1308     bool empty() const;
1309     //! returns the total number of matrix elements
1310     size_t total() const;
1311
1312     //! returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise
1313     int checkVector(int elemChannels, int depth=-1, bool requireContinuous=true) const;
1314
1315     void* handle(int accessFlags) const;
1316     void ndoffset(size_t* ofs) const;
1317
1318     enum { MAGIC_VAL  = 0x42FF0000, AUTO_STEP = 0, CONTINUOUS_FLAG = CV_MAT_CONT_FLAG, SUBMATRIX_FLAG = CV_SUBMAT_FLAG };
1319     enum { MAGIC_MASK = 0xFFFF0000, TYPE_MASK = 0x00000FFF, DEPTH_MASK = 7 };
1320
1321     /*! includes several bit-fields:
1322          - the magic signature
1323          - continuity flag
1324          - depth
1325          - number of channels
1326      */
1327     int flags;
1328     //! the matrix dimensionality, >= 2
1329     int dims;
1330     //! the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions
1331     int rows, cols;
1332
1333     //! custom allocator
1334     MatAllocator* allocator;
1335     UMatUsageFlags usageFlags; // usage flags for allocator
1336     //! and the standard allocator
1337     static MatAllocator* getStdAllocator();
1338
1339     // black-box container of UMat data
1340     UMatData* u;
1341
1342     // offset of the submatrix (or 0)
1343     size_t offset;
1344
1345     MatSize size;
1346     MatStep step;
1347
1348 protected:
1349 };
1350
1351
1352 /////////////////////////// multi-dimensional sparse matrix //////////////////////////
1353
1354 /*!
1355  Sparse matrix class.
1356
1357  The class represents multi-dimensional sparse numerical arrays. Such a sparse array can store elements
1358  of any type that cv::Mat is able to store. "Sparse" means that only non-zero elements
1359  are stored (though, as a result of some operations on a sparse matrix, some of its stored elements
1360  can actually become 0. It's user responsibility to detect such elements and delete them using cv::SparseMat::erase().
1361  The non-zero elements are stored in a hash table that grows when it's filled enough,
1362  so that the search time remains O(1) in average. Elements can be accessed using the following methods:
1363
1364  <ol>
1365  <li>Query operations: cv::SparseMat::ptr() and the higher-level cv::SparseMat::ref(),
1366       cv::SparseMat::value() and cv::SparseMat::find, for example:
1367  \code
1368  const int dims = 5;
1369  int size[] = {10, 10, 10, 10, 10};
1370  SparseMat sparse_mat(dims, size, CV_32F);
1371  for(int i = 0; i < 1000; i++)
1372  {
1373      int idx[dims];
1374      for(int k = 0; k < dims; k++)
1375         idx[k] = rand()%sparse_mat.size(k);
1376      sparse_mat.ref<float>(idx) += 1.f;
1377  }
1378  \endcode
1379
1380  <li>Sparse matrix iterators. Like cv::Mat iterators and unlike cv::Mat iterators, the sparse matrix iterators are STL-style,
1381  that is, the iteration is done as following:
1382  \code
1383  // prints elements of a sparse floating-point matrix and the sum of elements.
1384  SparseMatConstIterator_<float>
1385         it = sparse_mat.begin<float>(),
1386         it_end = sparse_mat.end<float>();
1387  double s = 0;
1388  int dims = sparse_mat.dims();
1389  for(; it != it_end; ++it)
1390  {
1391      // print element indices and the element value
1392      const Node* n = it.node();
1393      printf("(")
1394      for(int i = 0; i < dims; i++)
1395         printf("%3d%c", n->idx[i], i < dims-1 ? ',' : ')');
1396      printf(": %f\n", *it);
1397      s += *it;
1398  }
1399  printf("Element sum is %g\n", s);
1400  \endcode
1401  If you run this loop, you will notice that elements are enumerated
1402  in no any logical order (lexicographical etc.),
1403  they come in the same order as they stored in the hash table, i.e. semi-randomly.
1404
1405  You may collect pointers to the nodes and sort them to get the proper ordering.
1406  Note, however, that pointers to the nodes may become invalid when you add more
1407  elements to the matrix; this is because of possible buffer reallocation.
1408
1409  <li>A combination of the above 2 methods when you need to process 2 or more sparse
1410  matrices simultaneously, e.g. this is how you can compute unnormalized
1411  cross-correlation of the 2 floating-point sparse matrices:
1412  \code
1413  double crossCorr(const SparseMat& a, const SparseMat& b)
1414  {
1415      const SparseMat *_a = &a, *_b = &b;
1416      // if b contains less elements than a,
1417      // it's faster to iterate through b
1418      if(_a->nzcount() > _b->nzcount())
1419         std::swap(_a, _b);
1420      SparseMatConstIterator_<float> it = _a->begin<float>(),
1421                                     it_end = _a->end<float>();
1422      double ccorr = 0;
1423      for(; it != it_end; ++it)
1424      {
1425          // take the next element from the first matrix
1426          float avalue = *it;
1427          const Node* anode = it.node();
1428          // and try to find element with the same index in the second matrix.
1429          // since the hash value depends only on the element index,
1430          // we reuse hashvalue stored in the node
1431          float bvalue = _b->value<float>(anode->idx,&anode->hashval);
1432          ccorr += avalue*bvalue;
1433      }
1434      return ccorr;
1435  }
1436  \endcode
1437  </ol>
1438 */
1439 class CV_EXPORTS SparseMat
1440 {
1441 public:
1442     typedef SparseMatIterator iterator;
1443     typedef SparseMatConstIterator const_iterator;
1444
1445     enum { MAGIC_VAL=0x42FD0000, MAX_DIM=32, HASH_SCALE=0x5bd1e995, HASH_BIT=0x80000000 };
1446
1447     //! the sparse matrix header
1448     struct CV_EXPORTS Hdr
1449     {
1450         Hdr(int _dims, const int* _sizes, int _type);
1451         void clear();
1452         int refcount;
1453         int dims;
1454         int valueOffset;
1455         size_t nodeSize;
1456         size_t nodeCount;
1457         size_t freeList;
1458         std::vector<uchar> pool;
1459         std::vector<size_t> hashtab;
1460         int size[MAX_DIM];
1461     };
1462
1463     //! sparse matrix node - element of a hash table
1464     struct CV_EXPORTS Node
1465     {
1466         //! hash value
1467         size_t hashval;
1468         //! index of the next node in the same hash table entry
1469         size_t next;
1470         //! index of the matrix element
1471         int idx[MAX_DIM];
1472     };
1473
1474     //! default constructor
1475     SparseMat();
1476     //! creates matrix of the specified size and type
1477     SparseMat(int dims, const int* _sizes, int _type);
1478     //! copy constructor
1479     SparseMat(const SparseMat& m);
1480     //! converts dense 2d matrix to the sparse form
1481     /*!
1482      \param m the input matrix
1483     */
1484     explicit SparseMat(const Mat& m);
1485     //! converts old-style sparse matrix to the new-style. All the data is copied
1486     //SparseMat(const CvSparseMat* m);
1487     //! the destructor
1488     ~SparseMat();
1489
1490     //! assignment operator. This is O(1) operation, i.e. no data is copied
1491     SparseMat& operator = (const SparseMat& m);
1492     //! equivalent to the corresponding constructor
1493     SparseMat& operator = (const Mat& m);
1494
1495     //! creates full copy of the matrix
1496     SparseMat clone() const;
1497
1498     //! copies all the data to the destination matrix. All the previous content of m is erased
1499     void copyTo( SparseMat& m ) const;
1500     //! converts sparse matrix to dense matrix.
1501     void copyTo( Mat& m ) const;
1502     //! multiplies all the matrix elements by the specified scale factor alpha and converts the results to the specified data type
1503     void convertTo( SparseMat& m, int rtype, double alpha=1 ) const;
1504     //! converts sparse matrix to dense n-dim matrix with optional type conversion and scaling.
1505     /*!
1506       \param rtype The output matrix data type. When it is =-1, the output array will have the same data type as (*this)
1507       \param alpha The scale factor
1508       \param beta The optional delta added to the scaled values before the conversion
1509     */
1510     void convertTo( Mat& m, int rtype, double alpha=1, double beta=0 ) const;
1511
1512     // not used now
1513     void assignTo( SparseMat& m, int type=-1 ) const;
1514
1515     //! reallocates sparse matrix.
1516     /*!
1517         If the matrix already had the proper size and type,
1518         it is simply cleared with clear(), otherwise,
1519         the old matrix is released (using release()) and the new one is allocated.
1520     */
1521     void create(int dims, const int* _sizes, int _type);
1522     //! sets all the sparse matrix elements to 0, which means clearing the hash table.
1523     void clear();
1524     //! manually increments the reference counter to the header.
1525     void addref();
1526     // decrements the header reference counter. When the counter reaches 0, the header and all the underlying data are deallocated.
1527     void release();
1528
1529     //! converts sparse matrix to the old-style representation; all the elements are copied.
1530     //operator CvSparseMat*() const;
1531     //! returns the size of each element in bytes (not including the overhead - the space occupied by SparseMat::Node elements)
1532     size_t elemSize() const;
1533     //! returns elemSize()/channels()
1534     size_t elemSize1() const;
1535
1536     //! returns type of sparse matrix elements
1537     int type() const;
1538     //! returns the depth of sparse matrix elements
1539     int depth() const;
1540     //! returns the number of channels
1541     int channels() const;
1542
1543     //! returns the array of sizes, or NULL if the matrix is not allocated
1544     const int* size() const;
1545     //! returns the size of i-th matrix dimension (or 0)
1546     int size(int i) const;
1547     //! returns the matrix dimensionality
1548     int dims() const;
1549     //! returns the number of non-zero elements (=the number of hash table nodes)
1550     size_t nzcount() const;
1551
1552     //! computes the element hash value (1D case)
1553     size_t hash(int i0) const;
1554     //! computes the element hash value (2D case)
1555     size_t hash(int i0, int i1) const;
1556     //! computes the element hash value (3D case)
1557     size_t hash(int i0, int i1, int i2) const;
1558     //! computes the element hash value (nD case)
1559     size_t hash(const int* idx) const;
1560
1561     //@{
1562     /*!
1563      specialized variants for 1D, 2D, 3D cases and the generic_type one for n-D case.
1564
1565      return pointer to the matrix element.
1566      <ul>
1567       <li>if the element is there (it's non-zero), the pointer to it is returned
1568       <li>if it's not there and createMissing=false, NULL pointer is returned
1569       <li>if it's not there and createMissing=true, then the new element
1570         is created and initialized with 0. Pointer to it is returned
1571       <li>if the optional hashval pointer is not NULL, the element hash value is
1572       not computed, but *hashval is taken instead.
1573      </ul>
1574     */
1575     //! returns pointer to the specified element (1D case)
1576     uchar* ptr(int i0, bool createMissing, size_t* hashval=0);
1577     //! returns pointer to the specified element (2D case)
1578     uchar* ptr(int i0, int i1, bool createMissing, size_t* hashval=0);
1579     //! returns pointer to the specified element (3D case)
1580     uchar* ptr(int i0, int i1, int i2, bool createMissing, size_t* hashval=0);
1581     //! returns pointer to the specified element (nD case)
1582     uchar* ptr(const int* idx, bool createMissing, size_t* hashval=0);
1583     //@}
1584
1585     //@{
1586     /*!
1587      return read-write reference to the specified sparse matrix element.
1588
1589      ref<_Tp>(i0,...[,hashval]) is equivalent to *(_Tp*)ptr(i0,...,true[,hashval]).
1590      The methods always return a valid reference.
1591      If the element did not exist, it is created and initialiazed with 0.
1592     */
1593     //! returns reference to the specified element (1D case)
1594     template<typename _Tp> _Tp& ref(int i0, size_t* hashval=0);
1595     //! returns reference to the specified element (2D case)
1596     template<typename _Tp> _Tp& ref(int i0, int i1, size_t* hashval=0);
1597     //! returns reference to the specified element (3D case)
1598     template<typename _Tp> _Tp& ref(int i0, int i1, int i2, size_t* hashval=0);
1599     //! returns reference to the specified element (nD case)
1600     template<typename _Tp> _Tp& ref(const int* idx, size_t* hashval=0);
1601     //@}
1602
1603     //@{
1604     /*!
1605      return value of the specified sparse matrix element.
1606
1607      value<_Tp>(i0,...[,hashval]) is equivalent
1608
1609      \code
1610      { const _Tp* p = find<_Tp>(i0,...[,hashval]); return p ? *p : _Tp(); }
1611      \endcode
1612
1613      That is, if the element did not exist, the methods return 0.
1614      */
1615     //! returns value of the specified element (1D case)
1616     template<typename _Tp> _Tp value(int i0, size_t* hashval=0) const;
1617     //! returns value of the specified element (2D case)
1618     template<typename _Tp> _Tp value(int i0, int i1, size_t* hashval=0) const;
1619     //! returns value of the specified element (3D case)
1620     template<typename _Tp> _Tp value(int i0, int i1, int i2, size_t* hashval=0) const;
1621     //! returns value of the specified element (nD case)
1622     template<typename _Tp> _Tp value(const int* idx, size_t* hashval=0) const;
1623     //@}
1624
1625     //@{
1626     /*!
1627      Return pointer to the specified sparse matrix element if it exists
1628
1629      find<_Tp>(i0,...[,hashval]) is equivalent to (_const Tp*)ptr(i0,...false[,hashval]).
1630
1631      If the specified element does not exist, the methods return NULL.
1632     */
1633     //! returns pointer to the specified element (1D case)
1634     template<typename _Tp> const _Tp* find(int i0, size_t* hashval=0) const;
1635     //! returns pointer to the specified element (2D case)
1636     template<typename _Tp> const _Tp* find(int i0, int i1, size_t* hashval=0) const;
1637     //! returns pointer to the specified element (3D case)
1638     template<typename _Tp> const _Tp* find(int i0, int i1, int i2, size_t* hashval=0) const;
1639     //! returns pointer to the specified element (nD case)
1640     template<typename _Tp> const _Tp* find(const int* idx, size_t* hashval=0) const;
1641
1642     //! erases the specified element (2D case)
1643     void erase(int i0, int i1, size_t* hashval=0);
1644     //! erases the specified element (3D case)
1645     void erase(int i0, int i1, int i2, size_t* hashval=0);
1646     //! erases the specified element (nD case)
1647     void erase(const int* idx, size_t* hashval=0);
1648
1649     //@{
1650     /*!
1651        return the sparse matrix iterator pointing to the first sparse matrix element
1652     */
1653     //! returns the sparse matrix iterator at the matrix beginning
1654     SparseMatIterator begin();
1655     //! returns the sparse matrix iterator at the matrix beginning
1656     template<typename _Tp> SparseMatIterator_<_Tp> begin();
1657     //! returns the read-only sparse matrix iterator at the matrix beginning
1658     SparseMatConstIterator begin() const;
1659     //! returns the read-only sparse matrix iterator at the matrix beginning
1660     template<typename _Tp> SparseMatConstIterator_<_Tp> begin() const;
1661     //@}
1662     /*!
1663        return the sparse matrix iterator pointing to the element following the last sparse matrix element
1664     */
1665     //! returns the sparse matrix iterator at the matrix end
1666     SparseMatIterator end();
1667     //! returns the read-only sparse matrix iterator at the matrix end
1668     SparseMatConstIterator end() const;
1669     //! returns the typed sparse matrix iterator at the matrix end
1670     template<typename _Tp> SparseMatIterator_<_Tp> end();
1671     //! returns the typed read-only sparse matrix iterator at the matrix end
1672     template<typename _Tp> SparseMatConstIterator_<_Tp> end() const;
1673
1674     //! returns the value stored in the sparse martix node
1675     template<typename _Tp> _Tp& value(Node* n);
1676     //! returns the value stored in the sparse martix node
1677     template<typename _Tp> const _Tp& value(const Node* n) const;
1678
1679     ////////////// some internal-use methods ///////////////
1680     Node* node(size_t nidx);
1681     const Node* node(size_t nidx) const;
1682
1683     uchar* newNode(const int* idx, size_t hashval);
1684     void removeNode(size_t hidx, size_t nidx, size_t previdx);
1685     void resizeHashTab(size_t newsize);
1686
1687     int flags;
1688     Hdr* hdr;
1689 };
1690
1691
1692
1693 ///////////////////////////////// SparseMat_<_Tp> ////////////////////////////////////
1694
1695 /*!
1696  The Template Sparse Matrix class derived from cv::SparseMat
1697
1698  The class provides slightly more convenient operations for accessing elements.
1699
1700  \code
1701  SparseMat m;
1702  ...
1703  SparseMat_<int> m_ = (SparseMat_<int>&)m;
1704  m_.ref(1)++; // equivalent to m.ref<int>(1)++;
1705  m_.ref(2) += m_(3); // equivalent to m.ref<int>(2) += m.value<int>(3);
1706  \endcode
1707 */
1708 template<typename _Tp> class SparseMat_ : public SparseMat
1709 {
1710 public:
1711     typedef SparseMatIterator_<_Tp> iterator;
1712     typedef SparseMatConstIterator_<_Tp> const_iterator;
1713
1714     //! the default constructor
1715     SparseMat_();
1716     //! the full constructor equivelent to SparseMat(dims, _sizes, DataType<_Tp>::type)
1717     SparseMat_(int dims, const int* _sizes);
1718     //! the copy constructor. If DataType<_Tp>.type != m.type(), the m elements are converted
1719     SparseMat_(const SparseMat& m);
1720     //! the copy constructor. This is O(1) operation - no data is copied
1721     SparseMat_(const SparseMat_& m);
1722     //! converts dense matrix to the sparse form
1723     SparseMat_(const Mat& m);
1724     //! converts the old-style sparse matrix to the C++ class. All the elements are copied
1725     //SparseMat_(const CvSparseMat* m);
1726     //! the assignment operator. If DataType<_Tp>.type != m.type(), the m elements are converted
1727     SparseMat_& operator = (const SparseMat& m);
1728     //! the assignment operator. This is O(1) operation - no data is copied
1729     SparseMat_& operator = (const SparseMat_& m);
1730     //! converts dense matrix to the sparse form
1731     SparseMat_& operator = (const Mat& m);
1732
1733     //! makes full copy of the matrix. All the elements are duplicated
1734     SparseMat_ clone() const;
1735     //! equivalent to cv::SparseMat::create(dims, _sizes, DataType<_Tp>::type)
1736     void create(int dims, const int* _sizes);
1737     //! converts sparse matrix to the old-style CvSparseMat. All the elements are copied
1738     //operator CvSparseMat*() const;
1739
1740     //! returns type of the matrix elements
1741     int type() const;
1742     //! returns depth of the matrix elements
1743     int depth() const;
1744     //! returns the number of channels in each matrix element
1745     int channels() const;
1746
1747     //! equivalent to SparseMat::ref<_Tp>(i0, hashval)
1748     _Tp& ref(int i0, size_t* hashval=0);
1749     //! equivalent to SparseMat::ref<_Tp>(i0, i1, hashval)
1750     _Tp& ref(int i0, int i1, size_t* hashval=0);
1751     //! equivalent to SparseMat::ref<_Tp>(i0, i1, i2, hashval)
1752     _Tp& ref(int i0, int i1, int i2, size_t* hashval=0);
1753     //! equivalent to SparseMat::ref<_Tp>(idx, hashval)
1754     _Tp& ref(const int* idx, size_t* hashval=0);
1755
1756     //! equivalent to SparseMat::value<_Tp>(i0, hashval)
1757     _Tp operator()(int i0, size_t* hashval=0) const;
1758     //! equivalent to SparseMat::value<_Tp>(i0, i1, hashval)
1759     _Tp operator()(int i0, int i1, size_t* hashval=0) const;
1760     //! equivalent to SparseMat::value<_Tp>(i0, i1, i2, hashval)
1761     _Tp operator()(int i0, int i1, int i2, size_t* hashval=0) const;
1762     //! equivalent to SparseMat::value<_Tp>(idx, hashval)
1763     _Tp operator()(const int* idx, size_t* hashval=0) const;
1764
1765     //! returns sparse matrix iterator pointing to the first sparse matrix element
1766     SparseMatIterator_<_Tp> begin();
1767     //! returns read-only sparse matrix iterator pointing to the first sparse matrix element
1768     SparseMatConstIterator_<_Tp> begin() const;
1769     //! returns sparse matrix iterator pointing to the element following the last sparse matrix element
1770     SparseMatIterator_<_Tp> end();
1771     //! returns read-only sparse matrix iterator pointing to the element following the last sparse matrix element
1772     SparseMatConstIterator_<_Tp> end() const;
1773 };
1774
1775
1776
1777 ////////////////////////////////// MatConstIterator //////////////////////////////////
1778
1779 class CV_EXPORTS MatConstIterator
1780 {
1781 public:
1782     typedef uchar* value_type;
1783     typedef ptrdiff_t difference_type;
1784     typedef const uchar** pointer;
1785     typedef uchar* reference;
1786
1787 #ifndef OPENCV_NOSTL
1788     typedef std::random_access_iterator_tag iterator_category;
1789 #endif
1790
1791     //! default constructor
1792     MatConstIterator();
1793     //! constructor that sets the iterator to the beginning of the matrix
1794     MatConstIterator(const Mat* _m);
1795     //! constructor that sets the iterator to the specified element of the matrix
1796     MatConstIterator(const Mat* _m, int _row, int _col=0);
1797     //! constructor that sets the iterator to the specified element of the matrix
1798     MatConstIterator(const Mat* _m, Point _pt);
1799     //! constructor that sets the iterator to the specified element of the matrix
1800     MatConstIterator(const Mat* _m, const int* _idx);
1801     //! copy constructor
1802     MatConstIterator(const MatConstIterator& it);
1803
1804     //! copy operator
1805     MatConstIterator& operator = (const MatConstIterator& it);
1806     //! returns the current matrix element
1807     uchar* operator *() const;
1808     //! returns the i-th matrix element, relative to the current
1809     uchar* operator [](ptrdiff_t i) const;
1810
1811     //! shifts the iterator forward by the specified number of elements
1812     MatConstIterator& operator += (ptrdiff_t ofs);
1813     //! shifts the iterator backward by the specified number of elements
1814     MatConstIterator& operator -= (ptrdiff_t ofs);
1815     //! decrements the iterator
1816     MatConstIterator& operator --();
1817     //! decrements the iterator
1818     MatConstIterator operator --(int);
1819     //! increments the iterator
1820     MatConstIterator& operator ++();
1821     //! increments the iterator
1822     MatConstIterator operator ++(int);
1823     //! returns the current iterator position
1824     Point pos() const;
1825     //! returns the current iterator position
1826     void pos(int* _idx) const;
1827
1828     ptrdiff_t lpos() const;
1829     void seek(ptrdiff_t ofs, bool relative = false);
1830     void seek(const int* _idx, bool relative = false);
1831
1832     const Mat* m;
1833     size_t elemSize;
1834     uchar* ptr;
1835     uchar* sliceStart;
1836     uchar* sliceEnd;
1837 };
1838
1839
1840
1841 ////////////////////////////////// MatConstIterator_ /////////////////////////////////
1842
1843 /*!
1844  Matrix read-only iterator
1845  */
1846 template<typename _Tp>
1847 class MatConstIterator_ : public MatConstIterator
1848 {
1849 public:
1850     typedef _Tp value_type;
1851     typedef ptrdiff_t difference_type;
1852     typedef const _Tp* pointer;
1853     typedef const _Tp& reference;
1854
1855 #ifndef OPENCV_NOSTL
1856     typedef std::random_access_iterator_tag iterator_category;
1857 #endif
1858
1859     //! default constructor
1860     MatConstIterator_();
1861     //! constructor that sets the iterator to the beginning of the matrix
1862     MatConstIterator_(const Mat_<_Tp>* _m);
1863     //! constructor that sets the iterator to the specified element of the matrix
1864     MatConstIterator_(const Mat_<_Tp>* _m, int _row, int _col=0);
1865     //! constructor that sets the iterator to the specified element of the matrix
1866     MatConstIterator_(const Mat_<_Tp>* _m, Point _pt);
1867     //! constructor that sets the iterator to the specified element of the matrix
1868     MatConstIterator_(const Mat_<_Tp>* _m, const int* _idx);
1869     //! copy constructor
1870     MatConstIterator_(const MatConstIterator_& it);
1871
1872     //! copy operator
1873     MatConstIterator_& operator = (const MatConstIterator_& it);
1874     //! returns the current matrix element
1875     _Tp operator *() const;
1876     //! returns the i-th matrix element, relative to the current
1877     _Tp operator [](ptrdiff_t i) const;
1878
1879     //! shifts the iterator forward by the specified number of elements
1880     MatConstIterator_& operator += (ptrdiff_t ofs);
1881     //! shifts the iterator backward by the specified number of elements
1882     MatConstIterator_& operator -= (ptrdiff_t ofs);
1883     //! decrements the iterator
1884     MatConstIterator_& operator --();
1885     //! decrements the iterator
1886     MatConstIterator_ operator --(int);
1887     //! increments the iterator
1888     MatConstIterator_& operator ++();
1889     //! increments the iterator
1890     MatConstIterator_ operator ++(int);
1891     //! returns the current iterator position
1892     Point pos() const;
1893 };
1894
1895
1896
1897 //////////////////////////////////// MatIterator_ ////////////////////////////////////
1898
1899 /*!
1900  Matrix read-write iterator
1901 */
1902 template<typename _Tp>
1903 class MatIterator_ : public MatConstIterator_<_Tp>
1904 {
1905 public:
1906     typedef _Tp* pointer;
1907     typedef _Tp& reference;
1908
1909 #ifndef OPENCV_NOSTL
1910     typedef std::random_access_iterator_tag iterator_category;
1911 #endif
1912
1913     //! the default constructor
1914     MatIterator_();
1915     //! constructor that sets the iterator to the beginning of the matrix
1916     MatIterator_(Mat_<_Tp>* _m);
1917     //! constructor that sets the iterator to the specified element of the matrix
1918     MatIterator_(Mat_<_Tp>* _m, int _row, int _col=0);
1919     //! constructor that sets the iterator to the specified element of the matrix
1920     MatIterator_(const Mat_<_Tp>* _m, Point _pt);
1921     //! constructor that sets the iterator to the specified element of the matrix
1922     MatIterator_(const Mat_<_Tp>* _m, const int* _idx);
1923     //! copy constructor
1924     MatIterator_(const MatIterator_& it);
1925     //! copy operator
1926     MatIterator_& operator = (const MatIterator_<_Tp>& it );
1927
1928     //! returns the current matrix element
1929     _Tp& operator *() const;
1930     //! returns the i-th matrix element, relative to the current
1931     _Tp& operator [](ptrdiff_t i) const;
1932
1933     //! shifts the iterator forward by the specified number of elements
1934     MatIterator_& operator += (ptrdiff_t ofs);
1935     //! shifts the iterator backward by the specified number of elements
1936     MatIterator_& operator -= (ptrdiff_t ofs);
1937     //! decrements the iterator
1938     MatIterator_& operator --();
1939     //! decrements the iterator
1940     MatIterator_ operator --(int);
1941     //! increments the iterator
1942     MatIterator_& operator ++();
1943     //! increments the iterator
1944     MatIterator_ operator ++(int);
1945 };
1946
1947
1948
1949 /////////////////////////////// SparseMatConstIterator ///////////////////////////////
1950
1951 /*!
1952  Read-Only Sparse Matrix Iterator.
1953  Here is how to use the iterator to compute the sum of floating-point sparse matrix elements:
1954
1955  \code
1956  SparseMatConstIterator it = m.begin(), it_end = m.end();
1957  double s = 0;
1958  CV_Assert( m.type() == CV_32F );
1959  for( ; it != it_end; ++it )
1960     s += it.value<float>();
1961  \endcode
1962 */
1963 class CV_EXPORTS SparseMatConstIterator
1964 {
1965 public:
1966     //! the default constructor
1967     SparseMatConstIterator();
1968     //! the full constructor setting the iterator to the first sparse matrix element
1969     SparseMatConstIterator(const SparseMat* _m);
1970     //! the copy constructor
1971     SparseMatConstIterator(const SparseMatConstIterator& it);
1972
1973     //! the assignment operator
1974     SparseMatConstIterator& operator = (const SparseMatConstIterator& it);
1975
1976     //! template method returning the current matrix element
1977     template<typename _Tp> const _Tp& value() const;
1978     //! returns the current node of the sparse matrix. it.node->idx is the current element index
1979     const SparseMat::Node* node() const;
1980
1981     //! moves iterator to the previous element
1982     SparseMatConstIterator& operator --();
1983     //! moves iterator to the previous element
1984     SparseMatConstIterator operator --(int);
1985     //! moves iterator to the next element
1986     SparseMatConstIterator& operator ++();
1987     //! moves iterator to the next element
1988     SparseMatConstIterator operator ++(int);
1989
1990     //! moves iterator to the element after the last element
1991     void seekEnd();
1992
1993     const SparseMat* m;
1994     size_t hashidx;
1995     uchar* ptr;
1996 };
1997
1998
1999
2000 ////////////////////////////////// SparseMatIterator /////////////////////////////////
2001
2002 /*!
2003  Read-write Sparse Matrix Iterator
2004
2005  The class is similar to cv::SparseMatConstIterator,
2006  but can be used for in-place modification of the matrix elements.
2007 */
2008 class CV_EXPORTS SparseMatIterator : public SparseMatConstIterator
2009 {
2010 public:
2011     //! the default constructor
2012     SparseMatIterator();
2013     //! the full constructor setting the iterator to the first sparse matrix element
2014     SparseMatIterator(SparseMat* _m);
2015     //! the full constructor setting the iterator to the specified sparse matrix element
2016     SparseMatIterator(SparseMat* _m, const int* idx);
2017     //! the copy constructor
2018     SparseMatIterator(const SparseMatIterator& it);
2019
2020     //! the assignment operator
2021     SparseMatIterator& operator = (const SparseMatIterator& it);
2022     //! returns read-write reference to the current sparse matrix element
2023     template<typename _Tp> _Tp& value() const;
2024     //! returns pointer to the current sparse matrix node. it.node->idx is the index of the current element (do not modify it!)
2025     SparseMat::Node* node() const;
2026
2027     //! moves iterator to the next element
2028     SparseMatIterator& operator ++();
2029     //! moves iterator to the next element
2030     SparseMatIterator operator ++(int);
2031 };
2032
2033
2034
2035 /////////////////////////////// SparseMatConstIterator_ //////////////////////////////
2036
2037 /*!
2038  Template Read-Only Sparse Matrix Iterator Class.
2039
2040  This is the derived from SparseMatConstIterator class that
2041  introduces more convenient operator *() for accessing the current element.
2042 */
2043 template<typename _Tp> class SparseMatConstIterator_ : public SparseMatConstIterator
2044 {
2045 public:
2046
2047 #ifndef OPENCV_NOSTL
2048     typedef std::forward_iterator_tag iterator_category;
2049 #endif
2050
2051     //! the default constructor
2052     SparseMatConstIterator_();
2053     //! the full constructor setting the iterator to the first sparse matrix element
2054     SparseMatConstIterator_(const SparseMat_<_Tp>* _m);
2055     SparseMatConstIterator_(const SparseMat* _m);
2056     //! the copy constructor
2057     SparseMatConstIterator_(const SparseMatConstIterator_& it);
2058
2059     //! the assignment operator
2060     SparseMatConstIterator_& operator = (const SparseMatConstIterator_& it);
2061     //! the element access operator
2062     const _Tp& operator *() const;
2063
2064     //! moves iterator to the next element
2065     SparseMatConstIterator_& operator ++();
2066     //! moves iterator to the next element
2067     SparseMatConstIterator_ operator ++(int);
2068 };
2069
2070
2071
2072 ///////////////////////////////// SparseMatIterator_ /////////////////////////////////
2073
2074 /*!
2075  Template Read-Write Sparse Matrix Iterator Class.
2076
2077  This is the derived from cv::SparseMatConstIterator_ class that
2078  introduces more convenient operator *() for accessing the current element.
2079 */
2080 template<typename _Tp> class SparseMatIterator_ : public SparseMatConstIterator_<_Tp>
2081 {
2082 public:
2083
2084 #ifndef OPENCV_NOSTL
2085     typedef std::forward_iterator_tag iterator_category;
2086 #endif
2087
2088     //! the default constructor
2089     SparseMatIterator_();
2090     //! the full constructor setting the iterator to the first sparse matrix element
2091     SparseMatIterator_(SparseMat_<_Tp>* _m);
2092     SparseMatIterator_(SparseMat* _m);
2093     //! the copy constructor
2094     SparseMatIterator_(const SparseMatIterator_& it);
2095
2096     //! the assignment operator
2097     SparseMatIterator_& operator = (const SparseMatIterator_& it);
2098     //! returns the reference to the current element
2099     _Tp& operator *() const;
2100
2101     //! moves the iterator to the next element
2102     SparseMatIterator_& operator ++();
2103     //! moves the iterator to the next element
2104     SparseMatIterator_ operator ++(int);
2105 };
2106
2107
2108
2109 /////////////////////////////////// NAryMatIterator //////////////////////////////////
2110
2111 /*!
2112  n-Dimensional Dense Matrix Iterator Class.
2113
2114  The class cv::NAryMatIterator is used for iterating over one or more n-dimensional dense arrays (cv::Mat's).
2115
2116  The iterator is completely different from cv::Mat_ and cv::SparseMat_ iterators.
2117  It iterates through the slices (or planes), not the elements, where "slice" is a continuous part of the arrays.
2118
2119  Here is the example on how the iterator can be used to normalize 3D histogram:
2120
2121  \code
2122  void normalizeColorHist(Mat& hist)
2123  {
2124  #if 1
2125      // intialize iterator (the style is different from STL).
2126      // after initialization the iterator will contain
2127      // the number of slices or planes
2128      // the iterator will go through
2129      Mat* arrays[] = { &hist, 0 };
2130      Mat planes[1];
2131      NAryMatIterator it(arrays, planes);
2132      double s = 0;
2133      // iterate through the matrix. on each iteration
2134      // it.planes[i] (of type Mat) will be set to the current plane of
2135      // i-th n-dim matrix passed to the iterator constructor.
2136      for(int p = 0; p < it.nplanes; p++, ++it)
2137         s += sum(it.planes[0])[0];
2138      it = NAryMatIterator(hist);
2139      s = 1./s;
2140      for(int p = 0; p < it.nplanes; p++, ++it)
2141         it.planes[0] *= s;
2142  #elif 1
2143      // this is a shorter implementation of the above
2144      // using built-in operations on Mat
2145      double s = sum(hist)[0];
2146      hist.convertTo(hist, hist.type(), 1./s, 0);
2147  #else
2148      // and this is even shorter one
2149      // (assuming that the histogram elements are non-negative)
2150      normalize(hist, hist, 1, 0, NORM_L1);
2151  #endif
2152  }
2153  \endcode
2154
2155  You can iterate through several matrices simultaneously as long as they have the same geometry
2156  (dimensionality and all the dimension sizes are the same), which is useful for binary
2157  and n-ary operations on such matrices. Just pass those matrices to cv::MatNDIterator.
2158  Then, during the iteration it.planes[0], it.planes[1], ... will
2159  be the slices of the corresponding matrices
2160 */
2161 class CV_EXPORTS NAryMatIterator
2162 {
2163 public:
2164     //! the default constructor
2165     NAryMatIterator();
2166     //! the full constructor taking arbitrary number of n-dim matrices
2167     NAryMatIterator(const Mat** arrays, uchar** ptrs, int narrays=-1);
2168     //! the full constructor taking arbitrary number of n-dim matrices
2169     NAryMatIterator(const Mat** arrays, Mat* planes, int narrays=-1);
2170     //! the separate iterator initialization method
2171     void init(const Mat** arrays, Mat* planes, uchar** ptrs, int narrays=-1);
2172
2173     //! proceeds to the next plane of every iterated matrix
2174     NAryMatIterator& operator ++();
2175     //! proceeds to the next plane of every iterated matrix (postfix increment operator)
2176     NAryMatIterator operator ++(int);
2177
2178     //! the iterated arrays
2179     const Mat** arrays;
2180     //! the current planes
2181     Mat* planes;
2182     //! data pointers
2183     uchar** ptrs;
2184     //! the number of arrays
2185     int narrays;
2186     //! the number of hyper-planes that the iterator steps through
2187     size_t nplanes;
2188     //! the size of each segment (in elements)
2189     size_t size;
2190 protected:
2191     int iterdepth;
2192     size_t idx;
2193 };
2194
2195
2196
2197 ///////////////////////////////// Matrix Expressions /////////////////////////////////
2198
2199 class CV_EXPORTS MatOp
2200 {
2201 public:
2202     MatOp();
2203     virtual ~MatOp();
2204
2205     virtual bool elementWise(const MatExpr& expr) const;
2206     virtual void assign(const MatExpr& expr, Mat& m, int type=-1) const = 0;
2207     virtual void roi(const MatExpr& expr, const Range& rowRange,
2208                      const Range& colRange, MatExpr& res) const;
2209     virtual void diag(const MatExpr& expr, int d, MatExpr& res) const;
2210     virtual void augAssignAdd(const MatExpr& expr, Mat& m) const;
2211     virtual void augAssignSubtract(const MatExpr& expr, Mat& m) const;
2212     virtual void augAssignMultiply(const MatExpr& expr, Mat& m) const;
2213     virtual void augAssignDivide(const MatExpr& expr, Mat& m) const;
2214     virtual void augAssignAnd(const MatExpr& expr, Mat& m) const;
2215     virtual void augAssignOr(const MatExpr& expr, Mat& m) const;
2216     virtual void augAssignXor(const MatExpr& expr, Mat& m) const;
2217
2218     virtual void add(const MatExpr& expr1, const MatExpr& expr2, MatExpr& res) const;
2219     virtual void add(const MatExpr& expr1, const Scalar& s, MatExpr& res) const;
2220
2221     virtual void subtract(const MatExpr& expr1, const MatExpr& expr2, MatExpr& res) const;
2222     virtual void subtract(const Scalar& s, const MatExpr& expr, MatExpr& res) const;
2223
2224     virtual void multiply(const MatExpr& expr1, const MatExpr& expr2, MatExpr& res, double scale=1) const;
2225     virtual void multiply(const MatExpr& expr1, double s, MatExpr& res) const;
2226
2227     virtual void divide(const MatExpr& expr1, const MatExpr& expr2, MatExpr& res, double scale=1) const;
2228     virtual void divide(double s, const MatExpr& expr, MatExpr& res) const;
2229
2230     virtual void abs(const MatExpr& expr, MatExpr& res) const;
2231
2232     virtual void transpose(const MatExpr& expr, MatExpr& res) const;
2233     virtual void matmul(const MatExpr& expr1, const MatExpr& expr2, MatExpr& res) const;
2234     virtual void invert(const MatExpr& expr, int method, MatExpr& res) const;
2235
2236     virtual Size size(const MatExpr& expr) const;
2237     virtual int type(const MatExpr& expr) const;
2238 };
2239
2240
2241 class CV_EXPORTS MatExpr
2242 {
2243 public:
2244     MatExpr();
2245     explicit MatExpr(const Mat& m);
2246
2247     MatExpr(const MatOp* _op, int _flags, const Mat& _a = Mat(), const Mat& _b = Mat(),
2248             const Mat& _c = Mat(), double _alpha = 1, double _beta = 1, const Scalar& _s = Scalar());
2249
2250     operator Mat() const;
2251     template<typename _Tp> operator Mat_<_Tp>() const;
2252
2253     Size size() const;
2254     int type() const;
2255
2256     MatExpr row(int y) const;
2257     MatExpr col(int x) const;
2258     MatExpr diag(int d = 0) const;
2259     MatExpr operator()( const Range& rowRange, const Range& colRange ) const;
2260     MatExpr operator()( const Rect& roi ) const;
2261
2262     MatExpr t() const;
2263     MatExpr inv(int method = DECOMP_LU) const;
2264     MatExpr mul(const MatExpr& e, double scale=1) const;
2265     MatExpr mul(const Mat& m, double scale=1) const;
2266
2267     Mat cross(const Mat& m) const;
2268     double dot(const Mat& m) const;
2269
2270     const MatOp* op;
2271     int flags;
2272
2273     Mat a, b, c;
2274     double alpha, beta;
2275     Scalar s;
2276 };
2277
2278
2279 CV_EXPORTS MatExpr operator + (const Mat& a, const Mat& b);
2280 CV_EXPORTS MatExpr operator + (const Mat& a, const Scalar& s);
2281 CV_EXPORTS MatExpr operator + (const Scalar& s, const Mat& a);
2282 CV_EXPORTS MatExpr operator + (const MatExpr& e, const Mat& m);
2283 CV_EXPORTS MatExpr operator + (const Mat& m, const MatExpr& e);
2284 CV_EXPORTS MatExpr operator + (const MatExpr& e, const Scalar& s);
2285 CV_EXPORTS MatExpr operator + (const Scalar& s, const MatExpr& e);
2286 CV_EXPORTS MatExpr operator + (const MatExpr& e1, const MatExpr& e2);
2287
2288 CV_EXPORTS MatExpr operator - (const Mat& a, const Mat& b);
2289 CV_EXPORTS MatExpr operator - (const Mat& a, const Scalar& s);
2290 CV_EXPORTS MatExpr operator - (const Scalar& s, const Mat& a);
2291 CV_EXPORTS MatExpr operator - (const MatExpr& e, const Mat& m);
2292 CV_EXPORTS MatExpr operator - (const Mat& m, const MatExpr& e);
2293 CV_EXPORTS MatExpr operator - (const MatExpr& e, const Scalar& s);
2294 CV_EXPORTS MatExpr operator - (const Scalar& s, const MatExpr& e);
2295 CV_EXPORTS MatExpr operator - (const MatExpr& e1, const MatExpr& e2);
2296
2297 CV_EXPORTS MatExpr operator - (const Mat& m);
2298 CV_EXPORTS MatExpr operator - (const MatExpr& e);
2299
2300 CV_EXPORTS MatExpr operator * (const Mat& a, const Mat& b);
2301 CV_EXPORTS MatExpr operator * (const Mat& a, double s);
2302 CV_EXPORTS MatExpr operator * (double s, const Mat& a);
2303 CV_EXPORTS MatExpr operator * (const MatExpr& e, const Mat& m);
2304 CV_EXPORTS MatExpr operator * (const Mat& m, const MatExpr& e);
2305 CV_EXPORTS MatExpr operator * (const MatExpr& e, double s);
2306 CV_EXPORTS MatExpr operator * (double s, const MatExpr& e);
2307 CV_EXPORTS MatExpr operator * (const MatExpr& e1, const MatExpr& e2);
2308
2309 CV_EXPORTS MatExpr operator / (const Mat& a, const Mat& b);
2310 CV_EXPORTS MatExpr operator / (const Mat& a, double s);
2311 CV_EXPORTS MatExpr operator / (double s, const Mat& a);
2312 CV_EXPORTS MatExpr operator / (const MatExpr& e, const Mat& m);
2313 CV_EXPORTS MatExpr operator / (const Mat& m, const MatExpr& e);
2314 CV_EXPORTS MatExpr operator / (const MatExpr& e, double s);
2315 CV_EXPORTS MatExpr operator / (double s, const MatExpr& e);
2316 CV_EXPORTS MatExpr operator / (const MatExpr& e1, const MatExpr& e2);
2317
2318 CV_EXPORTS MatExpr operator < (const Mat& a, const Mat& b);
2319 CV_EXPORTS MatExpr operator < (const Mat& a, double s);
2320 CV_EXPORTS MatExpr operator < (double s, const Mat& a);
2321
2322 CV_EXPORTS MatExpr operator <= (const Mat& a, const Mat& b);
2323 CV_EXPORTS MatExpr operator <= (const Mat& a, double s);
2324 CV_EXPORTS MatExpr operator <= (double s, const Mat& a);
2325
2326 CV_EXPORTS MatExpr operator == (const Mat& a, const Mat& b);
2327 CV_EXPORTS MatExpr operator == (const Mat& a, double s);
2328 CV_EXPORTS MatExpr operator == (double s, const Mat& a);
2329
2330 CV_EXPORTS MatExpr operator != (const Mat& a, const Mat& b);
2331 CV_EXPORTS MatExpr operator != (const Mat& a, double s);
2332 CV_EXPORTS MatExpr operator != (double s, const Mat& a);
2333
2334 CV_EXPORTS MatExpr operator >= (const Mat& a, const Mat& b);
2335 CV_EXPORTS MatExpr operator >= (const Mat& a, double s);
2336 CV_EXPORTS MatExpr operator >= (double s, const Mat& a);
2337
2338 CV_EXPORTS MatExpr operator > (const Mat& a, const Mat& b);
2339 CV_EXPORTS MatExpr operator > (const Mat& a, double s);
2340 CV_EXPORTS MatExpr operator > (double s, const Mat& a);
2341
2342 CV_EXPORTS MatExpr operator & (const Mat& a, const Mat& b);
2343 CV_EXPORTS MatExpr operator & (const Mat& a, const Scalar& s);
2344 CV_EXPORTS MatExpr operator & (const Scalar& s, const Mat& a);
2345
2346 CV_EXPORTS MatExpr operator | (const Mat& a, const Mat& b);
2347 CV_EXPORTS MatExpr operator | (const Mat& a, const Scalar& s);
2348 CV_EXPORTS MatExpr operator | (const Scalar& s, const Mat& a);
2349
2350 CV_EXPORTS MatExpr operator ^ (const Mat& a, const Mat& b);
2351 CV_EXPORTS MatExpr operator ^ (const Mat& a, const Scalar& s);
2352 CV_EXPORTS MatExpr operator ^ (const Scalar& s, const Mat& a);
2353
2354 CV_EXPORTS MatExpr operator ~(const Mat& m);
2355
2356 CV_EXPORTS MatExpr min(const Mat& a, const Mat& b);
2357 CV_EXPORTS MatExpr min(const Mat& a, double s);
2358 CV_EXPORTS MatExpr min(double s, const Mat& a);
2359
2360 CV_EXPORTS MatExpr max(const Mat& a, const Mat& b);
2361 CV_EXPORTS MatExpr max(const Mat& a, double s);
2362 CV_EXPORTS MatExpr max(double s, const Mat& a);
2363
2364 CV_EXPORTS MatExpr abs(const Mat& m);
2365 CV_EXPORTS MatExpr abs(const MatExpr& e);
2366
2367 } // cv
2368
2369 #include "opencv2/core/mat.inl.hpp"
2370
2371 #endif // __OPENCV_CORE_MAT_HPP__