modulo< Modulus, UpLength > Struct Template Reference

modulo&lt; Modulus, UpLength &gt; Struct Template Reference#

Composable Kernel: ck_tile::modulo< Modulus, UpLength > Struct Template Reference
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ck_tile::modulo< Modulus, UpLength > Struct Template Reference

#include <coordinate_transform.hpp>

Inheritance diagram for ck_tile::modulo< Modulus, UpLength >:
ck_tile::base_transform< 1, 1 >

Public Types

using LowerIndex = multi_index< 1 >
 
using UpperIndex = multi_index< 1 >
 
using UpLengths = decltype(make_tuple(UpLength{}))
 

Public Member Functions

constexpr CK_TILE_HOST_DEVICE modulo ()=default
 
constexpr CK_TILE_HOST_DEVICE modulo (const Modulus &modulus, const UpLength &up_length)
 
constexpr CK_TILE_HOST_DEVICE const auto & get_upper_lengths () const
 
template<typename LowIdx , typename UpIdx >
constexpr CK_TILE_HOST_DEVICE void calculate_lower_index (LowIdx &idx_low, const UpIdx &idx_up) const
 
template<typename LowIdxDiff , typename UpIdxDiff , typename LowIdx , typename UpIdx >
CK_TILE_HOST_DEVICE void update_lower_index (LowIdxDiff &idx_diff_low, const UpIdxDiff &idx_diff_up, LowIdx &idx_low, const UpIdx &up_idx) const
 
CK_TILE_HOST_DEVICE void print () const
 

Static Public Member Functions

static constexpr CK_TILE_HOST_DEVICE bool is_valid_upper_index_always_mapped_to_valid_lower_index ()
 
template<typename UpIdx >
static constexpr CK_TILE_HOST_DEVICE bool is_valid_upper_index_mapped_to_valid_lower_index (const UpIdx &)
 
static constexpr CK_TILE_HOST_DEVICE bool is_known_at_compile_time ()
 
- Static Public Member Functions inherited from ck_tile::base_transform< 1, 1 >
static constexpr CK_TILE_HOST_DEVICE auto get_type_enum ()
 
static constexpr CK_TILE_HOST_DEVICE index_t get_num_of_lower_dimension ()
 
static constexpr CK_TILE_HOST_DEVICE index_t get_num_of_upper_dimension ()
 
static constexpr CK_TILE_HOST_DEVICE auto calculate_upper_dimension_safe_vector_length_strides (const LowVectorLengths &, const LowVectorStrides &)
 

Public Attributes

Modulus modulus_
 
UpLengths up_lengths_
 

Member Typedef Documentation

◆ LowerIndex

template<typename Modulus , typename UpLength >
using ck_tile::modulo< Modulus, UpLength >::LowerIndex = multi_index<1>

◆ UpLengths

template<typename Modulus , typename UpLength >
using ck_tile::modulo< Modulus, UpLength >::UpLengths = decltype(make_tuple(UpLength{}))

◆ UpperIndex

template<typename Modulus , typename UpLength >
using ck_tile::modulo< Modulus, UpLength >::UpperIndex = multi_index<1>

Constructor & Destructor Documentation

◆ modulo() [1/2]

template<typename Modulus , typename UpLength >
constexpr CK_TILE_HOST_DEVICE ck_tile::modulo< Modulus, UpLength >::modulo ( )
constexprdefault

◆ modulo() [2/2]

template<typename Modulus , typename UpLength >
constexpr CK_TILE_HOST_DEVICE ck_tile::modulo< Modulus, UpLength >::modulo ( const Modulus &  modulus,
const UpLength &  up_length 
)
inlineconstexpr

Member Function Documentation

◆ calculate_lower_index()

template<typename Modulus , typename UpLength >
template<typename LowIdx , typename UpIdx >
constexpr CK_TILE_HOST_DEVICE void ck_tile::modulo< Modulus, UpLength >::calculate_lower_index ( LowIdx &  idx_low,
const UpIdx &  idx_up 
) const
inlineconstexpr

◆ get_upper_lengths()

template<typename Modulus , typename UpLength >
constexpr CK_TILE_HOST_DEVICE const auto& ck_tile::modulo< Modulus, UpLength >::get_upper_lengths ( ) const
inlineconstexpr

◆ is_known_at_compile_time()

template<typename Modulus , typename UpLength >
static constexpr CK_TILE_HOST_DEVICE bool ck_tile::modulo< Modulus, UpLength >::is_known_at_compile_time ( )
inlinestaticconstexpr

◆ is_valid_upper_index_always_mapped_to_valid_lower_index()

template<typename Modulus , typename UpLength >
static constexpr CK_TILE_HOST_DEVICE bool ck_tile::modulo< Modulus, UpLength >::is_valid_upper_index_always_mapped_to_valid_lower_index ( )
inlinestaticconstexpr

◆ is_valid_upper_index_mapped_to_valid_lower_index()

template<typename Modulus , typename UpLength >
template<typename UpIdx >
static constexpr CK_TILE_HOST_DEVICE bool ck_tile::modulo< Modulus, UpLength >::is_valid_upper_index_mapped_to_valid_lower_index ( const UpIdx &  )
inlinestaticconstexpr

◆ print()

template<typename Modulus , typename UpLength >
CK_TILE_HOST_DEVICE void ck_tile::modulo< Modulus, UpLength >::print ( ) const
inline

◆ update_lower_index()

template<typename Modulus , typename UpLength >
template<typename LowIdxDiff , typename UpIdxDiff , typename LowIdx , typename UpIdx >
CK_TILE_HOST_DEVICE void ck_tile::modulo< Modulus, UpLength >::update_lower_index ( LowIdxDiff &  idx_diff_low,
const UpIdxDiff &  idx_diff_up,
LowIdx &  idx_low,
const UpIdx &  up_idx 
) const
inline

Member Data Documentation

◆ modulus_

template<typename Modulus , typename UpLength >
Modulus ck_tile::modulo< Modulus, UpLength >::modulus_

◆ up_lengths_

template<typename Modulus , typename UpLength >
UpLengths ck_tile::modulo< Modulus, UpLength >::up_lengths_
The documentation for this struct was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-composable-kernel/checkouts/docs-7.0.0/include/ck_tile/core/algorithm/coordinate_transform.hpp