tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ > Struct Template Reference

tile_window_base&lt; TileWindowType_, BottomTensorView_, WindowLengths_ &gt; Struct Template Reference#

Composable Kernel: ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ > Struct Template Reference
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ > Struct Template Reference

This class provides description of tile windowed view on the device memory. More...

#include <tile_window_base.hpp>

Inheritance diagram for ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >:
ck_tile::tile_window_with_tile_dstr_base< TileWindowType_, BottomTensorView_, WindowLengths_, StaticTileDistribution_ >

Public Types

using BottomTensorView = remove_reference_t< BottomTensorView_ >
 
using WindowLengths = remove_cvref_t< WindowLengths_ >
 
using BottomTensorDesc = typename BottomTensorView::TensorDesc
 
using DataType = remove_cvref_t< typename BottomTensorView::DataType >
 
using BottomTensorIndex = array< index_t, NDimBottomTensor >
 

Public Member Functions

constexpr CK_TILE_DEVICE auto get_window_origin () const
 
constexpr CK_TILE_DEVICE auto get_window_lengths () const
 
constexpr CK_TILE_DEVICE auto get_bottom_tensor_view () const
 
CK_TILE_DEVICE void set_window_origin (const BottomTensorIndex &new_window_origin)
 
CK_TILE_DEVICE void set_window_origin_extended (const BottomTensorIndex &)
 
constexpr CK_TILE_DEVICE void set_bottom_tensor_view_data_ptr (typename BottomTensorView::DataType *data)
 
CK_TILE_DEVICE void move (const BottomTensorIndex &step)
 
CK_TILE_DEVICE void move_extended (const BottomTensorIndex &)
 

Static Public Member Functions

static constexpr CK_TILE_DEVICE index_t get_num_of_dimension ()
 

Public Attributes

BottomTensorIndex window_origin_
 
WindowLengths window_lengths_
 
BottomTensorView bottom_tensor_view_
 

Static Public Attributes

static constexpr index_t NDimBottomTensor = BottomTensorDesc::get_num_of_dimension()
 

Detailed Description

template<typename TileWindowType_, typename BottomTensorView_, typename WindowLengths_>
struct ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >

This class provides description of tile windowed view on the device memory.

Note
This class does not provide any functions to read or modify device memory.
Template Parameters
BottomTensorView_Class describing & holding device tensor memory.
WindowLengths_Spatial sizes of windowed view on tensor.

Member Typedef Documentation

◆ BottomTensorDesc

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
using ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::BottomTensorDesc = typename BottomTensorView::TensorDesc

◆ BottomTensorIndex

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
using ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::BottomTensorIndex = array<index_t, NDimBottomTensor>

◆ BottomTensorView

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
using ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::BottomTensorView = remove_reference_t<BottomTensorView_>

◆ DataType

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
using ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::DataType = remove_cvref_t<typename BottomTensorView::DataType>

◆ WindowLengths

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
using ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::WindowLengths = remove_cvref_t<WindowLengths_>

Member Function Documentation

◆ get_bottom_tensor_view()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
constexpr CK_TILE_DEVICE auto ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::get_bottom_tensor_view ( ) const
inlineconstexpr

◆ get_num_of_dimension()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
static constexpr CK_TILE_DEVICE index_t ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::get_num_of_dimension ( )
inlinestaticconstexpr

◆ get_window_lengths()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
constexpr CK_TILE_DEVICE auto ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::get_window_lengths ( ) const
inlineconstexpr

◆ get_window_origin()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
constexpr CK_TILE_DEVICE auto ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::get_window_origin ( ) const
inlineconstexpr

◆ move()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
CK_TILE_DEVICE void ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::move ( const BottomTensorIndex &  step)
inline

◆ move_extended()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
CK_TILE_DEVICE void ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::move_extended ( const BottomTensorIndex &  )
inline

◆ set_bottom_tensor_view_data_ptr()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
constexpr CK_TILE_DEVICE void ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::set_bottom_tensor_view_data_ptr ( typename BottomTensorView::DataType *  data)
inlineconstexpr

◆ set_window_origin()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
CK_TILE_DEVICE void ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::set_window_origin ( const BottomTensorIndex &  new_window_origin)
inline

◆ set_window_origin_extended()

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
CK_TILE_DEVICE void ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::set_window_origin_extended ( const BottomTensorIndex &  )
inline

Member Data Documentation

◆ bottom_tensor_view_

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
BottomTensorView ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::bottom_tensor_view_

◆ NDimBottomTensor

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
constexpr index_t ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::NDimBottomTensor = BottomTensorDesc::get_num_of_dimension()
staticconstexpr

◆ window_lengths_

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
WindowLengths ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::window_lengths_

◆ window_origin_

template<typename TileWindowType_ , typename BottomTensorView_ , typename WindowLengths_ >
BottomTensorIndex ck_tile::tile_window_base< TileWindowType_, BottomTensorView_, WindowLengths_ >::window_origin_
The documentation for this struct was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-composable-kernel/checkouts/develop/include/ck_tile/core/tensor/tile_window_base.hpp