CLUEstering
High-performance density-based weighted clustering library developed at CERN
Loading...
Searching...
No Matches
clue::PointsHost< Ndim > Class Template Reference

The PointsHost class is a data structure that manages points in host memory. It provides methods to allocate, access, and manipulate points in host memory. More...

#include <PointsHost.hpp>

Inheritance diagram for clue::PointsHost< Ndim >:

Classes

class  Point
 

Public Member Functions

template<concepts::queue TQueue>
 PointsHost (TQueue &queue, int32_t n_points)
 
template<concepts::queue TQueue>
 PointsHost (TQueue &queue, int32_t n_points, std::span< std::byte > buffer)
 
template<concepts::queue TQueue, std::ranges::contiguous_range... TBuffers>
requires (sizeof...(TBuffers) == 2 || sizeof...(TBuffers) == 4)
 PointsHost (TQueue &queue, int32_t n_points, TBuffers &&... buffers)
 
template<concepts::queue TQueue, concepts::contiguous_raw_data... TBuffers>
requires (sizeof...(TBuffers) == 2 || sizeof...(TBuffers) == 4)
 PointsHost (TQueue &queue, int32_t n_points, TBuffers... buffers)
 
 PointsHost (const PointsHost &)=delete
 
PointsHostoperator= (const PointsHost &)=delete
 
 PointsHost (PointsHost &&)=default
 
PointsHostoperator= (PointsHost &&)=default
 
ALPAKA_FN_HOST int32_t size () const
 Returns the number of points.
 
ALPAKA_FN_HOST auto coords () const
 Returns the coordinates of the points as a const span.
 
ALPAKA_FN_HOST auto coords ()
 Returns the coordinates of the points as a span.
 
ALPAKA_FN_HOST auto coords (size_t dim) const
 Returns the coordinates of the points for a specific dimension as a const span.
 
ALPAKA_FN_HOST auto coords (size_t dim)
 Returns the coordinates of the points for a specific dimension as a span.
 
ALPAKA_FN_HOST auto weights () const
 Returns the weights of the points as a const span.
 
ALPAKA_FN_HOST auto weights ()
 Returns the weights of the points as a span.
 
ALPAKA_FN_HOST auto clusterIndexes () const
 Returns the cluster indexes of the points as a const span.
 
ALPAKA_FN_HOST auto clusterIndexes ()
 Returns the cluster indexes of the points as a span.
 
ALPAKA_FN_HOST auto isSeed () const
 Returns the seed status of the points as a const span.
 
ALPAKA_FN_HOST auto isSeed ()
 Returns the seed status of the points as a span.
 
ALPAKA_FN_HOST const auto & view () const
 Returns the view of the points.
 
ALPAKA_FN_HOST auto & view ()
 Returns the view of the points.
 
Point operator[] (std::size_t idx) const
 

Friends

struct internal::points_interface< PointsHost< Ndim > >
 
template<concepts::queue _TQueue, uint8_t _Ndim, concepts::device _TDev>
void copyToHost (_TQueue &queue, PointsHost< _Ndim > &h_points, const PointsDevice< _Ndim, _TDev > &d_points)
 
template<concepts::queue _TQueue, uint8_t _Ndim, concepts::device _TDev>
void copyToDevice (_TQueue &queue, PointsDevice< _Ndim, _TDev > &d_points, const PointsHost< _Ndim > &h_points)
 

Detailed Description

template<uint8_t Ndim>
class clue::PointsHost< Ndim >

The PointsHost class is a data structure that manages points in host memory. It provides methods to allocate, access, and manipulate points in host memory.

Template Parameters
NdimThe number of dimensions of the points to manage

Member Function Documentation

◆ clusterIndexes() [1/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::clusterIndexes ( )

Returns the cluster indexes of the points as a span.

Returns
A span of the cluster indexes of the points

◆ clusterIndexes() [2/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::clusterIndexes ( ) const

Returns the cluster indexes of the points as a const span.

Returns
A const span of the cluster indexes of the points

◆ coords() [1/4]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::coords ( )

Returns the coordinates of the points as a span.

Returns
A span of the coordinates of the points

◆ coords() [2/4]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::coords ( ) const

Returns the coordinates of the points as a const span.

Returns
A const span of the coordinates of the points

◆ coords() [3/4]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::coords ( size_t dim)

Returns the coordinates of the points for a specific dimension as a span.

Parameters
dimThe dimension for which to get the coordinates
Returns
A span of the coordinates for the specified dimension

◆ coords() [4/4]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::coords ( size_t dim) const

Returns the coordinates of the points for a specific dimension as a const span.

Parameters
dimThe dimension for which to get the coordinates
Returns
A const span of the coordinates for the specified dimension

◆ isSeed() [1/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::isSeed ( )

Returns the seed status of the points as a span.

Returns
A span indicating whether each point is a seed

◆ isSeed() [2/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::isSeed ( ) const

Returns the seed status of the points as a const span.

Returns
A const span indicating whether each point is a seed

◆ size()

template<uint8_t Ndim>
ALPAKA_FN_HOST int32_t clue::PointsHost< Ndim >::size ( ) const

Returns the number of points.

Returns
The number of points

◆ view() [1/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto & clue::PointsHost< Ndim >::view ( )

Returns the view of the points.

Returns
A reference to the PointsView structure containing the points data

◆ view() [2/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST const auto & clue::PointsHost< Ndim >::view ( ) const

Returns the view of the points.

Returns
A const reference to the PointsView structure containing the points data

◆ weights() [1/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::weights ( )

Returns the weights of the points as a span.

Returns
A span of the weights of the points

◆ weights() [2/2]

template<uint8_t Ndim>
ALPAKA_FN_HOST auto clue::PointsHost< Ndim >::weights ( ) const

Returns the weights of the points as a const span.

Returns
A const span of the weights of the points

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