mirror/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2025-01-18 06:03:15 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Mat: use row/ col instead of i0/ i1 for parameter names in 2D case

Browse Source 
this improves documentation when using an IDE and reflects that Mats are
row major.
This commit is contained in:
Pavel Rojtberg 2016-08-02 11:38:14 +02:00
parent 89c9e7c2e6
commit 15dabc11b5
1 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
modules/core/include/opencv2/core/mat.hpp
View File

@ -1645,10 +1645,16 @@ public:
/** @overload */ /** @overload */
const uchar* ptr(int i0=0) const; const uchar* ptr(int i0=0) const;
/** @overload */ /** @overload
uchar* ptr(int i0, int i1); @param row Index along the dimension 0
/** @overload */ @param col Index along the dimension 1
const uchar* ptr(int i0, int i1) const; */
uchar* ptr(int row, int col);
/** @overload
@param row Index along the dimension 0
@param col Index along the dimension 1
*/
const uchar* ptr(int row, int col) const;
/** @overload */ /** @overload */
uchar* ptr(int i0, int i1, int i2); uchar* ptr(int i0, int i1, int i2);
@ -1668,10 +1674,16 @@ public:
template<typename _Tp> _Tp* ptr(int i0=0); template<typename _Tp> _Tp* ptr(int i0=0);
/** @overload */ /** @overload */
template<typename _Tp> const _Tp* ptr(int i0=0) const; template<typename _Tp> const _Tp* ptr(int i0=0) const;
/** @overload */ /** @overload
template<typename _Tp> _Tp* ptr(int i0, int i1); @param row Index along the dimension 0
/** @overload */ @param col Index along the dimension 1
template<typename _Tp> const _Tp* ptr(int i0, int i1) const; */
template<typename _Tp> _Tp* ptr(int row, int col);
/** @overload
@param row Index along the dimension 0
@param col Index along the dimension 1
*/
template<typename _Tp> const _Tp* ptr(int row, int col) const;
/** @overload */ /** @overload */
template<typename _Tp> _Tp* ptr(int i0, int i1, int i2); template<typename _Tp> _Tp* ptr(int i0, int i1, int i2);
/** @overload */ /** @overload */
@ -1721,15 +1733,15 @@ public:
*/ */
template<typename _Tp> const _Tp& at(int i0=0) const; template<typename _Tp> const _Tp& at(int i0=0) const;
/** @overload /** @overload
@param i0 Index along the dimension 0 @param row Index along the dimension 0
@param i1 Index along the dimension 1 @param col Index along the dimension 1
*/ */
template<typename _Tp> _Tp& at(int i0, int i1); template<typename _Tp> _Tp& at(int row, int col);
/** @overload /** @overload
@param i0 Index along the dimension 0 @param row Index along the dimension 0
@param i1 Index along the dimension 1 @param col Index along the dimension 1
*/ */
template<typename _Tp> const _Tp& at(int i0, int i1) const; template<typename _Tp> const _Tp& at(int row, int col) const;
/** @overload /** @overload
@param i0 Index along the dimension 0 @param i0 Index along the dimension 0
@ -2094,9 +2106,9 @@ public:
//! returns read-only reference to the specified element (1D case) //! returns read-only reference to the specified element (1D case)
const _Tp& operator ()(int idx0) const; const _Tp& operator ()(int idx0) const;
//! returns reference to the specified element (2D case) //! returns reference to the specified element (2D case)
_Tp& operator ()(int idx0, int idx1); _Tp& operator ()(int row, int col);
//! returns read-only reference to the specified element (2D case) //! returns read-only reference to the specified element (2D case)
const _Tp& operator ()(int idx0, int idx1) const; const _Tp& operator ()(int row, int col) const;
//! returns reference to the specified element (3D case) //! returns reference to the specified element (3D case)
_Tp& operator ()(int idx0, int idx1, int idx2); _Tp& operator ()(int idx0, int idx1, int idx2);
//! returns read-only reference to the specified element (3D case) //! returns read-only reference to the specified element (3D case)