VisionCpp  0.0.1
Public Types | Public Member Functions | Public Attributes | List of all members
visioncpp::internal::ConstNeighbour< T > Struct Template Reference

ConstNeighbour is used to provide global access to the constant memory. More...

#include <mem_neighbour.hpp>

Inheritance diagram for visioncpp::internal::ConstNeighbour< T >:
Collaboration diagram for visioncpp::internal::ConstNeighbour< T >:

Public Types

using PixelType = T
 

Public Member Functions

 ConstNeighbour (cl::sycl::constant_ptr< T > &ptr, size_t colsArg, size_t rowsArg)
 
PixelType at (int c, int r) const
 function at provides access to a specific coordinate for a 2d buffer parameters: More...
 
PixelType at (int c) const
 function at provides access to an specific Coordinate for a 1d buffer parameters: More...
 

Public Attributes

cl::sycl::constant_ptr< T > & ptr
 
size_t cols
 
size_t rows
 

Detailed Description

template<typename T>
struct visioncpp::internal::ConstNeighbour< T >

ConstNeighbour is used to provide global access to the constant memory.

It is used as an input type for user functor when a constant pointer needed to be passed on the device side. An example of such node can be a filter node for convolution operation. template parameters

Template Parameters
Tis the pixel type for the constant memory

Definition at line 124 of file mem_neighbour.hpp.

Member Typedef Documentation

◆ PixelType

template<typename T >
using visioncpp::internal::ConstNeighbour< T >::PixelType = T

Definition at line 125 of file mem_neighbour.hpp.

Constructor & Destructor Documentation

◆ ConstNeighbour()

template<typename T >
visioncpp::internal::ConstNeighbour< T >::ConstNeighbour ( cl::sycl::constant_ptr< T > &  ptr,
size_t  colsArg,
size_t  rowsArg 
)
inline

Definition at line 129 of file mem_neighbour.hpp.

Member Function Documentation

◆ at() [1/2]

template<typename T >
PixelType visioncpp::internal::ConstNeighbour< T >::at ( int  c) const
inline

function at provides access to an specific Coordinate for a 1d buffer parameters:

Parameters
cindex
Returns
PixelType

Definition at line 145 of file mem_neighbour.hpp.

References visioncpp::internal::ConstNeighbour< T >::ptr.

◆ at() [2/2]

template<typename T >
PixelType visioncpp::internal::ConstNeighbour< T >::at ( int  c,
int  r 
) const
inline

function at provides access to a specific coordinate for a 2d buffer parameters:

Parameters
ccolumn index
rrow index
Returns
PixelType

Definition at line 136 of file mem_neighbour.hpp.

References visioncpp::internal::calculate_index(), visioncpp::internal::ConstNeighbour< T >::cols, visioncpp::internal::ConstNeighbour< T >::ptr, and visioncpp::internal::ConstNeighbour< T >::rows.

Here is the call graph for this function:

Member Data Documentation

◆ cols

template<typename T >
size_t visioncpp::internal::ConstNeighbour< T >::cols

Definition at line 127 of file mem_neighbour.hpp.

Referenced by visioncpp::internal::ConstNeighbour< T >::at().

◆ ptr

template<typename T >
cl::sycl::constant_ptr<T>& visioncpp::internal::ConstNeighbour< T >::ptr

Definition at line 126 of file mem_neighbour.hpp.

Referenced by visioncpp::internal::ConstNeighbour< T >::at().

◆ rows

template<typename T >
size_t visioncpp::internal::ConstNeighbour< T >::rows

Definition at line 128 of file mem_neighbour.hpp.

Referenced by visioncpp::internal::ConstNeighbour< T >::at().


The documentation for this struct was generated from the following file: