mirror of
https://github.com/gosticks/openpose.git
synced 2026-08-12 20:30:20 +00:00
1416 lines
72 KiB
HTML
1416 lines
72 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>OpenPose: op::Array< T > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">OpenPose
|
|
 <span id="projectnumber">1.0.0rc2</span>
|
|
</div>
|
|
<div id="projectbrief">OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('classop_1_1_array.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classop_1_1_array-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">op::Array< T > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="array_8hpp_source.html">array.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a793b9851c7490bc98d4dd52020c0cd3c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a793b9851c7490bc98d4dd52020c0cd3c">Array</a> (const int size)</td></tr>
|
|
<tr class="separator:a793b9851c7490bc98d4dd52020c0cd3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48c1ba1f7017b5aa8e0451079dd3a6d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a48c1ba1f7017b5aa8e0451079dd3a6d3">Array</a> (const std::vector< int > &sizes={})</td></tr>
|
|
<tr class="separator:a48c1ba1f7017b5aa8e0451079dd3a6d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac833fdcb245fcc3135ce65227bb9e4b2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ac833fdcb245fcc3135ce65227bb9e4b2">Array</a> (const int size, const T value)</td></tr>
|
|
<tr class="separator:ac833fdcb245fcc3135ce65227bb9e4b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a959ede0df7e535d2d3ac40d098541c27"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a959ede0df7e535d2d3ac40d098541c27">Array</a> (const std::vector< int > &sizes, const T value)</td></tr>
|
|
<tr class="separator:a959ede0df7e535d2d3ac40d098541c27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cd386050e94c29b3c4ee40cafcacc46"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a9cd386050e94c29b3c4ee40cafcacc46">Array</a> (const int size, T *const dataPtr)</td></tr>
|
|
<tr class="separator:a9cd386050e94c29b3c4ee40cafcacc46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90895562def04a81db0b3e7eaa3722c7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a90895562def04a81db0b3e7eaa3722c7">Array</a> (const std::vector< int > &sizes, T *const dataPtr)</td></tr>
|
|
<tr class="separator:a90895562def04a81db0b3e7eaa3722c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a416e95541761c557c50b79b5e1b33389"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a416e95541761c557c50b79b5e1b33389">Array</a> (const <a class="el" href="classop_1_1_array.html">Array</a>< T > &array, const int index, const bool noCopy=false)</td></tr>
|
|
<tr class="separator:a416e95541761c557c50b79b5e1b33389"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a68cca98a3ebaf565f1e546eebd9f01"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a5a68cca98a3ebaf565f1e546eebd9f01">Array</a> (const <a class="el" href="classop_1_1_array.html">Array</a>< T > &array)</td></tr>
|
|
<tr class="separator:a5a68cca98a3ebaf565f1e546eebd9f01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c8e006e0eea472485f37971330ecbab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classop_1_1_array.html">Array</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a9c8e006e0eea472485f37971330ecbab">operator=</a> (const <a class="el" href="classop_1_1_array.html">Array</a>< T > &array)</td></tr>
|
|
<tr class="separator:a9c8e006e0eea472485f37971330ecbab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a7d854d63815e10e158fe889d17a88e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a7a7d854d63815e10e158fe889d17a88e">Array</a> (<a class="el" href="classop_1_1_array.html">Array</a>< T > &&array)</td></tr>
|
|
<tr class="separator:a7a7d854d63815e10e158fe889d17a88e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae388368128afac05369172198911e05d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classop_1_1_array.html">Array</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ae388368128afac05369172198911e05d">operator=</a> (<a class="el" href="classop_1_1_array.html">Array</a>< T > &&array)</td></tr>
|
|
<tr class="separator:ae388368128afac05369172198911e05d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af42f4570122d1b8259c211f52335909b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classop_1_1_array.html">Array</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#af42f4570122d1b8259c211f52335909b">clone</a> () const </td></tr>
|
|
<tr class="separator:af42f4570122d1b8259c211f52335909b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12e538b09e98bf0900163031602ed2ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a12e538b09e98bf0900163031602ed2ed">reset</a> (const int size)</td></tr>
|
|
<tr class="separator:a12e538b09e98bf0900163031602ed2ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ad0232daa69783cf2c8f7a0ff5b3b0c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a0ad0232daa69783cf2c8f7a0ff5b3b0c">reset</a> (const std::vector< int > &sizes={})</td></tr>
|
|
<tr class="separator:a0ad0232daa69783cf2c8f7a0ff5b3b0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7183eb2f4e78a6941da3a2079b9ed32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ac7183eb2f4e78a6941da3a2079b9ed32">reset</a> (const int size, const T value)</td></tr>
|
|
<tr class="separator:ac7183eb2f4e78a6941da3a2079b9ed32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add2eeccd967cdf0900449649cb6f5afb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#add2eeccd967cdf0900449649cb6f5afb">reset</a> (const std::vector< int > &sizes, const T value)</td></tr>
|
|
<tr class="separator:add2eeccd967cdf0900449649cb6f5afb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bf43d039478797722cf9401ceb951e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a6bf43d039478797722cf9401ceb951e9">setFrom</a> (const cv::Mat &cvMat)</td></tr>
|
|
<tr class="separator:a6bf43d039478797722cf9401ceb951e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28f09d11de753a741334ee8094296acb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a28f09d11de753a741334ee8094296acb">setTo</a> (const T value)</td></tr>
|
|
<tr class="separator:a28f09d11de753a741334ee8094296acb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad51b6ac12ed115f1056effefd6fa878b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ad51b6ac12ed115f1056effefd6fa878b">empty</a> () const </td></tr>
|
|
<tr class="separator:ad51b6ac12ed115f1056effefd6fa878b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2330657a79a444d1ab44370423be006e"><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a2330657a79a444d1ab44370423be006e">getSize</a> () const </td></tr>
|
|
<tr class="separator:a2330657a79a444d1ab44370423be006e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a146d6e773e14dd7aaa29a73f878358e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a146d6e773e14dd7aaa29a73f878358e1">getSize</a> (const int index) const </td></tr>
|
|
<tr class="separator:a146d6e773e14dd7aaa29a73f878358e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a337e33980c231bc207ea7d31ffa84fe3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a337e33980c231bc207ea7d31ffa84fe3">printSize</a> () const </td></tr>
|
|
<tr class="separator:a337e33980c231bc207ea7d31ffa84fe3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adeb008e878709bb5a51e26be55a5452d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#adeb008e878709bb5a51e26be55a5452d">getNumberDimensions</a> () const </td></tr>
|
|
<tr class="separator:adeb008e878709bb5a51e26be55a5452d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afee5e6149bc917586b3fd56323d20a87"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#afee5e6149bc917586b3fd56323d20a87">getVolume</a> () const </td></tr>
|
|
<tr class="separator:afee5e6149bc917586b3fd56323d20a87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ea46377ca7d89874f6f4c8c437ec777"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a2ea46377ca7d89874f6f4c8c437ec777">getVolume</a> (const int indexA, const int indexB=-1) const </td></tr>
|
|
<tr class="separator:a2ea46377ca7d89874f6f4c8c437ec777"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afeacae113dd204df98b78353205c05f1"><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#afeacae113dd204df98b78353205c05f1">getStride</a> () const </td></tr>
|
|
<tr class="separator:afeacae113dd204df98b78353205c05f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af318ada5d29b0d22e6c94dc62055793b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#af318ada5d29b0d22e6c94dc62055793b">getStride</a> (const int index) const </td></tr>
|
|
<tr class="separator:af318ada5d29b0d22e6c94dc62055793b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4715967fd2b028a97fd30257e697275"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#af4715967fd2b028a97fd30257e697275">getPtr</a> ()</td></tr>
|
|
<tr class="separator:af4715967fd2b028a97fd30257e697275"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17a44d11cf476f705ce4a5223cfb4f81"><td class="memItemLeft" align="right" valign="top">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a17a44d11cf476f705ce4a5223cfb4f81">getConstPtr</a> () const </td></tr>
|
|
<tr class="separator:a17a44d11cf476f705ce4a5223cfb4f81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af65f2606b13011870bf0467116246fbc"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#af65f2606b13011870bf0467116246fbc">getPseudoConstPtr</a> () const </td></tr>
|
|
<tr class="separator:af65f2606b13011870bf0467116246fbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab70165463db3e2fb3f15ad14001eb592"><td class="memItemLeft" align="right" valign="top">const cv::Mat & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ab70165463db3e2fb3f15ad14001eb592">getConstCvMat</a> () const </td></tr>
|
|
<tr class="separator:ab70165463db3e2fb3f15ad14001eb592"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac817621e848601cf7d6571e75d8f6865"><td class="memItemLeft" align="right" valign="top">cv::Mat & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ac817621e848601cf7d6571e75d8f6865">getCvMat</a> ()</td></tr>
|
|
<tr class="separator:ac817621e848601cf7d6571e75d8f6865"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa40dc59e800d3c4cce623d560c0e0fad"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#aa40dc59e800d3c4cce623d560c0e0fad">operator[]</a> (const int index)</td></tr>
|
|
<tr class="separator:aa40dc59e800d3c4cce623d560c0e0fad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeccfa42607d5deb5039ff260eb980abc"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#aeccfa42607d5deb5039ff260eb980abc">operator[]</a> (const int index) const </td></tr>
|
|
<tr class="separator:aeccfa42607d5deb5039ff260eb980abc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aada0f1bd6e9eb73b4f977e62da536f58"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#aada0f1bd6e9eb73b4f977e62da536f58">operator[]</a> (const std::vector< int > &indexes)</td></tr>
|
|
<tr class="separator:aada0f1bd6e9eb73b4f977e62da536f58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f6c6f7ddeed3d1edbc907441888a8cf"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a3f6c6f7ddeed3d1edbc907441888a8cf">operator[]</a> (const std::vector< int > &indexes) const </td></tr>
|
|
<tr class="separator:a3f6c6f7ddeed3d1edbc907441888a8cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e0afd5f447efbfc29efbeac62716eff"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a6e0afd5f447efbfc29efbeac62716eff">at</a> (const int index)</td></tr>
|
|
<tr class="separator:a6e0afd5f447efbfc29efbeac62716eff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95e83e3379fd43460db68c2adb61f981"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a95e83e3379fd43460db68c2adb61f981">at</a> (const int index) const </td></tr>
|
|
<tr class="separator:a95e83e3379fd43460db68c2adb61f981"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8eebb6c34642cdf19ac74c7ed38d128b"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a8eebb6c34642cdf19ac74c7ed38d128b">at</a> (const std::vector< int > &indexes)</td></tr>
|
|
<tr class="separator:a8eebb6c34642cdf19ac74c7ed38d128b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cb014203b418de3996b90597df53b6e"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#a5cb014203b418de3996b90597df53b6e">at</a> (const std::vector< int > &indexes) const </td></tr>
|
|
<tr class="separator:a5cb014203b418de3996b90597df53b6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3ec6553128d77b0c26b848c0a0f81ca"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classop_1_1_array.html#ae3ec6553128d77b0c26b848c0a0f81ca">toString</a> () const </td></tr>
|
|
<tr class="separator:ae3ec6553128d77b0c26b848c0a0f81ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename T><br/>
|
|
class op::Array< T ></h3>
|
|
|
|
<p>Array<T>: The OpenPose Basic Raw Data Container This template class implements a multidimensional data array. It is our basic data container, analogous to cv::Mat in OpenCV, Tensor in Torch/TensorFlow or Blob in Caffe. It wraps a cv::Mat and a std::shared_ptr, both of them pointing to the same raw data. I.e. they both share the same memory, so we can read and modify this data in both formats with no performance impact. Hence, it keeps high performance while adding high-level functions. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a793b9851c7490bc98d4dd52020c0cd3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. Equivalent to default constructor + <a class="el" href="classop_1_1_array.html#a12e538b09e98bf0900163031602ed2ed">reset(const int size)</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Integer with the number of T element to be allocated. E.g., size = 5 is internally similar to <code>new T[5]</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a48c1ba1f7017b5aa8e0451079dd3a6d3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>sizes</em> = <code>{}</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. Equivalent to default constructor + reset(const std::vector<int>& size = {}). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sizes</td><td>Vector with the size of each dimension. E.g., size = {3, 5, 2} is internally similar to <code>new T[3*5*2]</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac833fdcb245fcc3135ce65227bb9e4b2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const T </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. Equivalent to default constructor + <a class="el" href="classop_1_1_array.html#ac7183eb2f4e78a6941da3a2079b9ed32">reset(const int size, const T value)</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Integer with the number of T element to be allocated. E.g., size = 5 is internally similar to <code>new T[5]</code>. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Initial value for each component of the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a959ede0df7e535d2d3ac40d098541c27"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>sizes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const T </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. Equivalent to default constructor + <a class="el" href="classop_1_1_array.html#add2eeccd967cdf0900449649cb6f5afb">reset(const std::vector<int>& size, const T value)</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sizes</td><td>Vector with the size of each dimension. E.g., size = {3, 5, 2} is internally similar to: <code>new T[3*5*2]</code>. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Initial value for each component of the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9cd386050e94c29b3c4ee40cafcacc46"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T *const </td>
|
|
<td class="paramname"><em>dataPtr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. Equivalent to default constructor, but it does not allocate memory, but rather use dataPtr. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Integer with the number of T element to be allocated. E.g., size = 5 is internally similar to <code>new T[5]</code>. </td></tr>
|
|
<tr><td class="paramname">dataPtr</td><td>Pointer to the memory to be used by the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a90895562def04a81db0b3e7eaa3722c7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>sizes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T *const </td>
|
|
<td class="paramname"><em>dataPtr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. Equivalent to default constructor, but it does not allocate memory, but rather use dataPtr. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sizes</td><td>Vector with the size of each dimension. E.g., size = {3, 5, 2} is internally similar to: <code>new T[3*5*2]</code>. </td></tr>
|
|
<tr><td class="paramname">dataPtr</td><td>Pointer to the memory to be used by the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a416e95541761c557c50b79b5e1b33389"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classop_1_1_array.html">Array</a>< T > & </td>
|
|
<td class="paramname"><em>array</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>noCopy</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html">Array</a> constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td>Array<T> with the original data array to slice. </td></tr>
|
|
<tr><td class="paramname">index</td><td>indicates the index of the array to extract. </td></tr>
|
|
<tr><td class="paramname">noCopy</td><td>indicates whether to perform a copy. Copy will never go to undefined behavior, however, if noCopy == true, then:<ol type="1">
|
|
<li>It is faster, as no data copy is involved, but...</li>
|
|
<li>If the <a class="el" href="classop_1_1_array.html">Array</a> array goes out of scope, then the resulting <a class="el" href="classop_1_1_array.html">Array</a> will provoke an undefined behavior.</li>
|
|
<li>If the returned <a class="el" href="classop_1_1_array.html">Array</a> is modified, the information in the <a class="el" href="classop_1_1_array.html">Array</a> array will also be. </li>
|
|
</ol>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Array<T> with the same dimension than array expect the first dimension being 1. E.g., if array is {p,k,m}, the resulting Array<T> is {1,k,m}. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5a68cca98a3ebaf565f1e546eebd9f01"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classop_1_1_array.html">Array</a>< T > & </td>
|
|
<td class="paramname"><em>array</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Copy constructor. It performs <code>fast copy</code>: For performance purpose, copying a Array<T> or <a class="el" href="structop_1_1_datum.html">Datum</a> or cv::Mat just copies the reference, it still shares the same internal data. Modifying the copied element will modify the original one. Use <a class="el" href="classop_1_1_array.html#af42f4570122d1b8259c211f52335909b">clone()</a> for a slower but real copy, similarly to cv::Mat and Array<T>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td><a class="el" href="classop_1_1_array.html">Array</a> to be copied. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7a7d854d63815e10e158fe889d17a88e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">op::Array</a>< T >::<a class="el" href="classop_1_1_array.html">Array</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classop_1_1_array.html">Array</a>< T > && </td>
|
|
<td class="paramname"><em>array</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Move constructor. It destroys the original <a class="el" href="classop_1_1_array.html">Array</a> to be moved. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td><a class="el" href="classop_1_1_array.html">Array</a> to be moved. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a6e0afd5f447efbfc29efbeac62716eff"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::at </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html#a6e0afd5f447efbfc29efbeac62716eff">at()</a> function Same functionality as <a class="el" href="classop_1_1_array.html#aa40dc59e800d3c4cce623d560c0e0fad">operator[](const int index)</a>, but it always check whether the indexes are within the data bounds. Otherwise, it will throw an error. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>The desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a95e83e3379fd43460db68c2adb61f981"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::at </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html#a6e0afd5f447efbfc29efbeac62716eff">at()</a> function Same functionality as <a class="el" href="classop_1_1_array.html#aeccfa42607d5deb5039ff260eb980abc">operator[](const int index) const</a>, but it always check whether the indexes are within the data bounds. Otherwise, it will throw an error. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>The desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A non-editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8eebb6c34642cdf19ac74c7ed38d128b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::at </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>indexes</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html#a6e0afd5f447efbfc29efbeac62716eff">at()</a> function Same functionality as <a class="el" href="classop_1_1_array.html#aada0f1bd6e9eb73b4f977e62da536f58">operator[](const std::vector<int>& indexes)</a>, but it always check whether the indexes are within the data bounds. Otherwise, it will throw an error. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexes</td><td>Vector with the desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5cb014203b418de3996b90597df53b6e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::at </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>indexes</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="classop_1_1_array.html#a6e0afd5f447efbfc29efbeac62716eff">at()</a> function Same functionality as <a class="el" href="classop_1_1_array.html#a3f6c6f7ddeed3d1edbc907441888a8cf">operator[](const std::vector<int>& indexes) const</a>, but it always check whether the indexes are within the data bounds. Otherwise, it will throw an error. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexes</td><td>Vector with the desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A non-editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af42f4570122d1b8259c211f52335909b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">Array</a><T> <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::clone </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Clone function. Similar to cv::Mat::clone and <a class="el" href="structop_1_1_datum.html#a847f62b3060c5d0d106e60c29df87a0b">Datum::clone</a>. It performs a real but slow copy of the data, i.e., even if the copied element is modified, the original one is not. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting <a class="el" href="classop_1_1_array.html">Array</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad51b6ac12ed115f1056effefd6fa878b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::empty </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Check whether memory has been allocated. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if no memory has been allocated, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab70165463db3e2fb3f15ad14001eb592"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const cv::Mat& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getConstCvMat </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return a cv::Mat wrapper to the data. It forbids the data to be modified. OpenCV only admits unsigned char, signed char, int, float & double. If the T class is not supported by OpenCV, it will throw an error. Note: Array<T> does not return an editable cv::Mat because some OpenCV functions reallocate memory and it would not longer point to the Array<T> instance. If you want to perform some OpenCV operation on the <a class="el" href="classop_1_1_array.html">Array</a> data, you can use: editedCvMat = array.getConstCvMat().<a class="el" href="classop_1_1_array.html#af42f4570122d1b8259c211f52335909b">clone()</a>; // modify data array.setFrom(editedCvMat) </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A const cv::Mat pointing to the data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a17a44d11cf476f705ce4a5223cfb4f81"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T* <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getConstPtr </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Similar to <a class="el" href="classop_1_1_array.html#af4715967fd2b028a97fd30257e697275">getPtr()</a>, but it forbids the data to be edited. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A raw const pointer to the data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac817621e848601cf7d6571e75d8f6865"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cv::Mat& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getCvMat </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Analogous to getConstCvMat, but in this case it returns a editable cv::Mat. Very important: Only allowed functions which do not provoke data reallocation. E.g., resizing functions will not work and they would provoke an undefined behaviour and/or execution crashes. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A cv::Mat pointing to the data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adeb008e878709bb5a51e26be55a5452d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getNumberDimensions </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return the total number of dimensions, equivalent to <a class="el" href="classop_1_1_array.html#a2330657a79a444d1ab44370423be006e">getSize()</a>.size(). </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of dimensions. If no memory is allocated, it returns 0. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af65f2606b13011870bf0467116246fbc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T* <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getPseudoConstPtr </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Similar to <a class="el" href="classop_1_1_array.html#a17a44d11cf476f705ce4a5223cfb4f81">getConstPtr()</a>, but it allows the data to be edited. This function is only implemented for Pybind11 usage. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A raw pointer to the data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af4715967fd2b028a97fd30257e697275"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T* <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getPtr </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return a raw pointer to the data. Similar to: std::shared_ptr::get(). Note: if you modify the pointer data, you will directly modify it in the Array<T> instance too. If you know you do not want to modify the data, then use <a class="el" href="classop_1_1_array.html#a17a44d11cf476f705ce4a5223cfb4f81">getConstPtr()</a> instead. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A raw pointer to the data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2330657a79a444d1ab44370423be006e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<int> <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return a vector with the size of each dimension allocated. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A std::vector<int> with the size of each dimension. If no memory has been allocated, it will return an empty std::vector. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a146d6e773e14dd7aaa29a73f878358e1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return a vector with the size of the desired dimension. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>Dimension to check its size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size of the desired dimension. It will return 0 if the requested dimension is higher than the number of dimensions. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afeacae113dd204df98b78353205c05f1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<int> <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getStride </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return the stride or step size of the array. E.g., given and Array<T> of size 5x3, <a class="el" href="classop_1_1_array.html#afeacae113dd204df98b78353205c05f1">getStride()</a> would return the following vector: {5x3sizeof(T), 3sizeof(T), sizeof(T)}. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af318ada5d29b0d22e6c94dc62055793b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getStride </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return the stride or step size of the array at the index-th dimension. E.g., given and Array<T> of size 5x3, getStride(2) would return sizeof(T). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afee5e6149bc917586b3fd56323d20a87"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getVolume </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return the total number of elements allocated, equivalent to multiply all the components from <a class="el" href="classop_1_1_array.html#a2330657a79a444d1ab44370423be006e">getSize()</a>. E.g., for a Array<T> of size = {2,5,3}, the volume or total number of elements is: 2x5x3 = 30. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total volume of the allocated data. If no memory is allocated, it returns 0. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2ea46377ca7d89874f6f4c8c437ec777"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::getVolume </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>indexA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>indexB</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Similar to <a class="el" href="classop_1_1_array.html#afee5e6149bc917586b3fd56323d20a87">getVolume()</a>, but in this case it just returns the volume between the desired dimensions. E.g., for a Array<T> of size = {2,5,3}, the volume or total number of elements for getVolume(1,2) is 5x3 = 15. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexA</td><td>Dimension where to start. </td></tr>
|
|
<tr><td class="paramname">indexB</td><td>Dimension where to stop. If indexB == -1, then it will take up to the last dimension. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total volume of the allocated data between the desired dimensions. If the index are out of bounds, it throws an error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9c8e006e0eea472485f37971330ecbab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">Array</a><T>& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classop_1_1_array.html">Array</a>< T > & </td>
|
|
<td class="paramname"><em>array</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Copy assignment. Similar to <a class="el" href="classop_1_1_array.html#a5a68cca98a3ebaf565f1e546eebd9f01">Array<T>(const Array<T>& array)</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td><a class="el" href="classop_1_1_array.html">Array</a> to be copied. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting <a class="el" href="classop_1_1_array.html">Array</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae388368128afac05369172198911e05d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classop_1_1_array.html">Array</a><T>& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classop_1_1_array.html">Array</a>< T > && </td>
|
|
<td class="paramname"><em>array</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Move assignment. Similar to <a class="el" href="classop_1_1_array.html#a7a7d854d63815e10e158fe889d17a88e">Array<T>(Array<T>&& array)</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td><a class="el" href="classop_1_1_array.html">Array</a> to be moved. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting <a class="el" href="classop_1_1_array.html">Array</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa40dc59e800d3c4cce623d560c0e0fad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>[] operator Similar to the [] operator for raw pointer data. If debug mode is enabled, then it will check that the desired index is in the data range, and it will throw an exception otherwise (similar to the at operator). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>The desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeccfa42607d5deb5039ff260eb980abc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>[] operator Same functionality as <a class="el" href="classop_1_1_array.html#aa40dc59e800d3c4cce623d560c0e0fad">operator[](const int index)</a>, but it forbids modifying the value. Otherwise, const functions would not be able to call the [] operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>The desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A non-editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aada0f1bd6e9eb73b4f977e62da536f58"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>indexes</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>[] operator Same functionality as <a class="el" href="classop_1_1_array.html#aa40dc59e800d3c4cce623d560c0e0fad">operator[](const int index)</a>, but it lets the user introduce the multi-dimensional index. E.g., given a (10 x 10 x 10) array, array[11] is equivalent to array[{1,1,0}] </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexes</td><td>Vector with the desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3f6c6f7ddeed3d1edbc907441888a8cf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T& <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>indexes</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>[] operator Same functionality as <a class="el" href="classop_1_1_array.html#aada0f1bd6e9eb73b4f977e62da536f58">operator[](const std::vector<int>& indexes)</a>, but it forbids modifying the value. Otherwise, const functions would not be able to call the [] operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexes</td><td>Vector with the desired memory location. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A non-editable reference to the data on the desired index location. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a337e33980c231bc207ea7d31ffa84fe3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::printSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return a string with the size of each dimension allocated. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A std::stringwith the size of each dimension. If no memory has been allocated, it will return an empty string. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a12e538b09e98bf0900163031602ed2ed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Data allocation function. It allocates the required space for the memory (it does not initialize that memory). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Integer with the number of T element to be allocated. E.g., size = 5 is internally similar to <code>new T[5]</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0ad0232daa69783cf2c8f7a0ff5b3b0c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>sizes</em> = <code>{}</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Data allocation function. Similar to <a class="el" href="classop_1_1_array.html#a12e538b09e98bf0900163031602ed2ed">reset(const int size)</a>, but it allocates a multi-dimensional array of dimensions each of the values of the argument. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sizes</td><td>Vector with the size of each dimension. E.g., size = {3, 5, 2} is internally similar to <code>new T[3*5*2]</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac7183eb2f4e78a6941da3a2079b9ed32"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const T </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Data allocation function. Similar to <a class="el" href="classop_1_1_array.html#a12e538b09e98bf0900163031602ed2ed">reset(const int size)</a>, but initializing the data to the value specified by the second argument. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Integer with the number of T element to be allocated. E.g., size = 5 is internally similar to <code>new T[5]</code>. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Initial value for each component of the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="add2eeccd967cdf0900449649cb6f5afb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< int > & </td>
|
|
<td class="paramname"><em>sizes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const T </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Data allocation function. Similar to <a class="el" href="classop_1_1_array.html#a0ad0232daa69783cf2c8f7a0ff5b3b0c">reset(const std::vector<int>& size)</a>, but initializing the data to the value specified by the second argument. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sizes</td><td>Vector with the size of each dimension. E.g., size = {3, 5, 2} is internally similar to <code>new T[3*5*2]</code>. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Initial value for each component of the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6bf43d039478797722cf9401ceb951e9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::setFrom </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const cv::Mat & </td>
|
|
<td class="paramname"><em>cvMat</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Data allocation function. It internally allocates memory and copies the data of the argument to the <a class="el" href="classop_1_1_array.html">Array</a> allocated memory. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cvMat</td><td>cv::Mat to be copied. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a28f09d11de753a741334ee8094296acb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::setTo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Data allocation function. It internally assigns all the allocated memory to the value indicated by the argument. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>Value for each component of the <a class="el" href="classop_1_1_array.html">Array</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae3ec6553128d77b0c26b848c0a0f81ca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string <a class="el" href="classop_1_1_array.html">op::Array</a>< T >::toString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>It returns a string with the whole array data. Useful for debugging. The format is: values separated by a space, and a enter for each dimension. E.g., For the <a class="el" href="classop_1_1_array.html">Array</a>{2, 2, 3}, it will print: <a class="el" href="classop_1_1_array.html#ae3ec6553128d77b0c26b848c0a0f81ca">Array<T>::toString()</a>: x1 x2 x3 x4 x5 x6</p>
|
|
<p>x7 x8 x9 x10 x11 x12 </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string with the array values in the above format. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>/home/travis/build/CMU-Perceptual-Computing-Lab/openpose/include/openpose/core/<a class="el" href="array_8hpp_source.html">array.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceop.html">op</a></li><li class="navelem"><a class="el" href="classop_1_1_array.html">Array</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|