Template Numerical Library version\ main:0b2c40fb1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator > Class Template Reference

Data structure for CSR segments. More...

#include <TNL/Algorithms/Segments/CSR.h>

Inheritance diagram for TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >:
[legend]
Collaboration diagram for TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >:
[legend]

Public Types

using ConstViewType = CSRView< Device, std::add_const_t< Index > >
 Type of constant segments view.
using IndexAllocatorType = IndexAllocator
using OffsetsContainer = Containers::Vector< Index, Device, typename Base::IndexType, IndexAllocator >
 Type of container storing offsets of particular segments.
template<typename Device_ = Device, typename Index_ = Index, typename IndexAllocator_ = typename Allocators::Default< Device_ >::template Allocator< Index_ >>
using Self = CSR< Device_, Index_, IndexAllocator_ >
 Templated type for creating CSR segments with different template parameters.
template<typename Device_, typename Index_>
using ViewTemplate = CSRView< Device_, Index_ >
 Templated view type.
using ViewType = CSRView< Device, Index >
 Type of segments view.
Public Types inherited from TNL::Algorithms::Segments::CSRBase< Device, Index >
using ConstOffsetsView = typename OffsetsView::ConstViewType
 The type for representing the constant vector view with segment offsets used in the CSR format.
using DeviceType = Device
 The device where the segments are operating.
using IndexType = std::remove_const_t< Index >
 The type used for indexing of segments elements.
using OffsetsView = Containers::VectorView< Index, DeviceType, IndexType >
 The type for representing the vector view with segment offsets used in the CSR format.
using SegmentViewType = SegmentView< IndexType, RowMajorOrder >
 Accessor type for one particular segment.

Public Member Functions

 CSR ()
 Constructor with no parameters to create empty segments.
 CSR (const CSR &segments)
 Copy constructor (makes deep copy).
template<typename SizesContainer, std::enable_if_t< IsArrayType< SizesContainer >::value, bool > = true>
 CSR (const SizesContainer &segmentsSizes)
 Constructor that initializes segments based on their sizes.
template<typename ListIndex>
 CSR (const std::initializer_list< ListIndex > &segmentsSizes)
 Constructor that initializes segments using an initializer list.
 CSR (CSR &&) noexcept=default
 Move constructor.
ConstViewType getConstView () const
 Returns a constant view for this instance of segments which can by used for example in lambda functions running in GPU kernels.
ViewType getView ()
 Returns a view for this instance of segments which can by used for example in lambda functions running in GPU kernels.
void load (File &file)
 Method for loading the segments from a file in a binary form.
CSR & operator= (const CSR &segments)
 Copy-assignment operator (makes a deep copy).
template<typename Device_, typename Index_, typename IndexAllocator_>
CSR & operator= (const CSR< Device_, Index_, IndexAllocator_ > &segments)
 Assignment operator for segments with different template parameters.
CSR & operator= (CSR &&) noexcept(false)
 Move-assignment operator.
void reset ()
 Reset the segments to empty states (it means that there is no segment in the segments).
void save (File &file) const
 Method for saving the segments to a file in a binary form.
template<typename SizesContainer>
void setSegmentsSizes (const SizesContainer &segmentsSizes)
 Set sizes of particular segments.
Public Member Functions inherited from TNL::Algorithms::Segments::CSRBase< Device, Index >
__cuda_callable__ CSRBase ()=default
 Default constructor with no parameters to create empty segments view.
__cuda_callable__ CSRBase (const CSRBase &)=default
 Copy constructor.
__cuda_callable__ CSRBase (const OffsetsView &offsets)
 Binds a new CSR view to an offsets vector.
__cuda_callable__ CSRBase (CSRBase &&) noexcept=default
 Move constructor.
__cuda_callable__ CSRBase (OffsetsView &&offsets)
 Binds a new CSR view to an offsets vector.
template<typename Function>
void forAllElements (Function function) const
 Call TNL::Algorithms::Segments::CSR::forElements for all elements of the segments.
template<typename Condition, typename Function>
void forAllElementsIf (Condition condition, Function function) const
template<typename Function>
void forAllSegments (Function &&function) const
 Call TNL::Algorithms::Segments::CSR::forSegments for all segments.
template<typename Array, typename Function>
void forElements (const Array &segmentIndexes, Function function) const
template<typename Array, typename Function>
void forElements (const Array &segmentIndexes, Index begin, Index end, Function function) const
template<typename Function>
void forElements (IndexType begin, IndexType end, Function function) const
 Iterate over all elements of given segments in parallel and call given lambda function.
template<typename Condition, typename Function>
void forElementsIf (IndexType begin, IndexType end, Condition condition, Function function) const
template<typename Function>
void forSegments (IndexType begin, IndexType end, Function &&function) const
 Iterate over all segments in parallel and call given lambda function.
__cuda_callable__ IndexType getElementCount () const
 Returns the number of elements managed by all segments.
__cuda_callable__ IndexType getGlobalIndex (Index segmentIdx, Index localIdx) const
 Computes the global index of an element managed by the segments.
__cuda_callable__ OffsetsView getOffsets ()
 Returns a modifiable vector view with segment offsets used in the CSR format.
__cuda_callable__ ConstOffsetsView getOffsets () const
 Returns a constant vector view with segment offsets used in the CSR format.
__cuda_callable__ IndexType getSegmentCount () const
 Returns the number of segments.
__cuda_callable__ IndexType getSegmentsCount () const
 Returns the number of segments. Deprecated, use getSegmentCount().
__cuda_callable__ IndexType getSegmentSize (IndexType segmentIdx) const
 Returns the size of a particular segment denoted by segmentIdx.
__cuda_callable__ SegmentViewType getSegmentView (IndexType segmentIdx) const
 Returns a segment view (i.e., a segment accessor) for the specified segment index.
__cuda_callable__ IndexType getSize () const
 Returns the number of elements managed by all segments.
__cuda_callable__ IndexType getStorageSize () const
 Returns number of elements that needs to be allocated by a container connected to this segments.
CSRBase & operator= (const CSRBase &)=delete
 Copy-assignment operator.
CSRBase & operator= (CSRBase &&)=delete
 Move-assignment operator.
template<typename Function>
void sequentialForAllSegments (Function &&function) const
 Call TNL::Algorithms::Segments::CSR::sequentialForSegments for all segments.
template<typename Function>
void sequentialForSegments (IndexType begin, IndexType end, Function &&function) const
 Call TNL::Algorithms::Segments::CSR::forSegments sequentially for particular segments.

Protected Attributes

OffsetsContainer offsets
Protected Attributes inherited from TNL::Algorithms::Segments::CSRBase< Device, Index >
OffsetsView offsets
 Vector view with row offsets used in the CSR format.

Additional Inherited Members

Static Public Member Functions inherited from TNL::Algorithms::Segments::CSRBase< Device, Index >
static constexpr ElementsOrganization getOrganization ()
 Returns the data layout for the CSR format (it is always row-major order).
static std::string getSegmentsType ()
 Returns string with the segments type.
static std::string getSerializationType ()
 Returns string with the serialization type.
static constexpr bool havePadding ()
 This function denotes that the CSR format does not use padding elements.
Protected Member Functions inherited from TNL::Algorithms::Segments::CSRBase< Device, Index >
__cuda_callable__ void bind (OffsetsView offsets)
 Re-initializes the internal attributes of the base class.

Detailed Description

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
class TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >

Data structure for CSR segments.

CSR segments are inspired by the Compressed Sparse Row (CSR) format, which is widely used for storing sparse matrices. It is the most popular format due to its versatility, making it the preferred choice for segment representation.

See TNL::Algorithms::Segments for more details about segments.

Template Parameters
DeviceThe type of device on which the segments will operate.
IndexThe type used for indexing elements managed by the segments.
IndexAllocatorThe allocator used for managing index containers.

Member Typedef Documentation

◆ Self

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
template<typename Device_ = Device, typename Index_ = Index, typename IndexAllocator_ = typename Allocators::Default< Device_ >::template Allocator< Index_ >>
using TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::Self = CSR< Device_, Index_, IndexAllocator_ >

Templated type for creating CSR segments with different template parameters.

Template Parameters
Device_is alternative device type.
Index_is alternative index type.
IndexAllocator_is alternative index allocator type.

◆ ViewTemplate

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
template<typename Device_, typename Index_>
using TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::ViewTemplate = CSRView< Device_, Index_ >

Templated view type.

Template Parameters
Device_is alternative device type for the view.
Index_is alternative index type for the view.

Constructor & Destructor Documentation

◆ CSR() [1/2]

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
template<typename SizesContainer, std::enable_if_t< IsArrayType< SizesContainer >::value, bool > = true>
TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::CSR ( const SizesContainer & segmentsSizes)

Constructor that initializes segments based on their sizes.

The number of segments is determined by the size of segmentsSizes. Each element in this container specifies the size of a corresponding segment.

Template Parameters
SizesContainerThe type of container used to store segment sizes. It can be, for example, TNL::Containers::Array or TNL::Containers::Vector.
Parameters
segmentsSizesAn instance of the container holding the sizes of the segments.

See the following example:

1#include <iostream>
2#include <TNL/Containers/Vector.h>
3#include <TNL/Algorithms/Segments/traverse.h>
4#include <TNL/Devices/Host.h>
5#include <TNL/Devices/Cuda.h>
6
7template< typename Segments >
8void
9SegmentsExample()
10{
11 using Device = typename Segments::DeviceType;
12
13 /***
14 * Create segments with given segments sizes.
15 */
16 TNL::Containers::Vector< int, Device > segmentsSizes{ 1, 2, 3, 4, 5 };
17 Segments segments( segmentsSizes );
18 std::cout << "Segments sizes are: " << segments << '\n';
19
20 /***
21 * Allocate array for the segments;
22 */
23 TNL::Containers::Array< double, Device > data( segments.getStorageSize(), 0.0 );
24
25 /***
26 * Insert data into particular segments.
27 */
28 auto data_view = data.getView();
29 TNL::Algorithms::Segments::forAllElements(
30 segments,
31 [ = ] __cuda_callable__( int segmentIdx, int localIdx, int globalIdx ) mutable
32 {
33 if( localIdx <= segmentIdx )
34 data_view[ globalIdx ] = segmentIdx;
35 } );
36
37 /***
38 * Print the data managed by the segments.
39 */
40 auto fetch = [ = ] __cuda_callable__( int globalIdx ) -> double
41 {
42 return data_view[ globalIdx ];
43 };
44 std::cout << TNL::Algorithms::Segments::print( segments, fetch ) << '\n';
45}
46
47int
48main( int argc, char* argv[] )
49{
50 std::cout << "Example of CSR segments on host:\n";
51 SegmentsExample< TNL::Algorithms::Segments::CSR< TNL::Devices::Host, int > >();
52
53 std::cout << "Example of Ellpack segments on host:\n";
54 SegmentsExample< TNL::Algorithms::Segments::Ellpack< TNL::Devices::Host, int > >();
55
56#ifdef __CUDACC__
57 std::cout << "Example of CSR segments on CUDA GPU:\n";
58 SegmentsExample< TNL::Algorithms::Segments::CSR< TNL::Devices::Cuda, int > >();
59
60 std::cout << "Example of Ellpack segments on CUDA GPU:\n";
61 SegmentsExample< TNL::Algorithms::Segments::Ellpack< TNL::Devices::Cuda, int > >();
62#endif
63 return EXIT_SUCCESS;
64}
__cuda_callable__
#define __cuda_callable__
Definition Macros.h:49
TNL::Containers::Array
Array is responsible for memory management, access to array elements, and general array operations.
Definition Array.h:65
TNL::Containers::Vector
Vector extends Array with algebraic operations.
Definition Vector.h:37
TNL::Algorithms::Segments
Namespace for the segments data structures.
Definition _NamespaceDoxy.h:7
TNL::Algorithms::Segments::print
SegmentsPrinter< typename Segments::ConstViewType, Fetch > print(const Segments &segments, Fetch fetch)
Print segments sizes, i.e. the segments setup.
TNL::Algorithms::Segments::forAllElements
void forAllElements(const Segments &segments, Function &&function, LaunchConfiguration launchConfig=Algorithms::Segments::LaunchConfiguration())
Iterates in parallel over all elements of all segments and applies the specified lambda function.

The expected output is:

Example of CSR segments on host:
Segments sizes are: [ 1, 2, 3, 4, 5 ]
Segment 0: [ 0 ]
Segment 1: [ 1, 1 ]
Segment 2: [ 2, 2, 2 ]
Segment 3: [ 3, 3, 3, 3 ]
Segment 4: [ 4, 4, 4, 4, 4 ]
Example of Ellpack segments on host:
Segments sizes are: [ 5, 5, 5, 5, 5 ]
Segment 0: [ 0, 0, 0, 0, 0 ]
Segment 1: [ 1, 1, 0, 0, 0 ]
Segment 2: [ 2, 2, 2, 0, 0 ]
Segment 3: [ 3, 3, 3, 3, 0 ]
Segment 4: [ 4, 4, 4, 4, 4 ]

◆ CSR() [2/2]

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
template<typename ListIndex>
TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::CSR ( const std::initializer_list< ListIndex > & segmentsSizes)

Constructor that initializes segments using an initializer list.

The number of segments is determined by the size of segmentsSizes. Each element in this initializer list specifies the size of a corresponding segment.

Template Parameters
ListIndexThe type used for indexing elements in the initializer list.
Parameters
segmentsSizesAn initializer list defining the sizes of the segments.

See the following example:

1#include <iostream>
2#include <TNL/Containers/Vector.h>
3#include <TNL/Algorithms/Segments/traverse.h>
4#include <TNL/Devices/Host.h>
5#include <TNL/Devices/Cuda.h>
6
7template< typename Segments >
8void
9SegmentsExample()
10{
11 using Device = typename Segments::DeviceType;
12
13 /***
14 * Create segments with given segments sizes.
15 */
16 Segments segments{ 1, 2, 3, 4, 5 };
17 std::cout << "Segments sizes are: " << segments << '\n';
18
19 /***
20 * Allocate array for the segments;
21 */
22 TNL::Containers::Array< double, Device > data( segments.getStorageSize(), 0.0 );
23
24 /***
25 * Insert data into particular segments.
26 */
27 auto data_view = data.getView();
28 TNL::Algorithms::Segments::forAllElements(
29 segments,
30 [ = ] __cuda_callable__( int segmentIdx, int localIdx, int globalIdx ) mutable
31 {
32 if( localIdx <= segmentIdx )
33 data_view[ globalIdx ] = segmentIdx;
34 } );
35
36 /***
37 * Print the data managed by the segments.
38 */
39 auto fetch = [ = ] __cuda_callable__( int globalIdx ) -> double
40 {
41 return data_view[ globalIdx ];
42 };
43 std::cout << TNL::Algorithms::Segments::print( segments, fetch ) << '\n';
44}
45
46int
47main( int argc, char* argv[] )
48{
49 std::cout << "Example of CSR segments on host:\n";
50 SegmentsExample< TNL::Algorithms::Segments::CSR< TNL::Devices::Host, int > >();
51
52 std::cout << "Example of Ellpack segments on host:\n";
53 SegmentsExample< TNL::Algorithms::Segments::Ellpack< TNL::Devices::Host, int > >();
54
55#ifdef __CUDACC__
56 std::cout << "Example of CSR segments on CUDA GPU:\n";
57 SegmentsExample< TNL::Algorithms::Segments::CSR< TNL::Devices::Cuda, int > >();
58
59 std::cout << "Example of Ellpack segments on CUDA GPU:\n";
60 SegmentsExample< TNL::Algorithms::Segments::Ellpack< TNL::Devices::Cuda, int > >();
61#endif
62 return EXIT_SUCCESS;
63}

The expected output is:

Example of CSR segments on host:
Segments sizes are: [ 1, 2, 3, 4, 5 ]
Segment 0: [ 0 ]
Segment 1: [ 1, 1 ]
Segment 2: [ 2, 2, 2 ]
Segment 3: [ 3, 3, 3, 3 ]
Segment 4: [ 4, 4, 4, 4, 4 ]
Example of Ellpack segments on host:
Segments sizes are: [ 5, 5, 5, 5, 5 ]
Segment 0: [ 0, 0, 0, 0, 0 ]
Segment 1: [ 1, 1, 0, 0, 0 ]
Segment 2: [ 2, 2, 2, 0, 0 ]
Segment 3: [ 3, 3, 3, 3, 0 ]
Segment 4: [ 4, 4, 4, 4, 4 ]

Member Function Documentation

◆ load()

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
void TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::load ( File & file)

Method for loading the segments from a file in a binary form.

Parameters
fileis the source file.

◆ operator=()

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
template<typename Device_, typename Index_, typename IndexAllocator_>
CSR & TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::operator= ( const CSR< Device_, Index_, IndexAllocator_ > & segments)

Assignment operator for segments with different template parameters.

Performs a deep copy of the source segments.

Template Parameters
Device_The device type of the source segments.
Index_The index type of the source segments.
IndexAllocator_The index allocator type of the source segments.
Parameters
segmentsThe source segments object.
Returns
A reference to this instance.

◆ save()

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
void TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::save ( File & file) const

Method for saving the segments to a file in a binary form.

Parameters
fileis the target file.

◆ setSegmentsSizes()

template<typename Device, typename Index, typename IndexAllocator = typename Allocators::Default< Device >::template Allocator< Index >>
template<typename SizesContainer>
void TNL::Algorithms::Segments::CSR< Device, Index, IndexAllocator >::setSegmentsSizes ( const SizesContainer & segmentsSizes)

Set sizes of particular segments.

Template Parameters
SizesContaineris a container with segments sizes. It can be TNL::Containers::Array or TNL::Containers::Vector for example.
Parameters
segmentsSizesis an instance of the container with segments sizes.
The documentation for this class was generated from the following file:
Generated on for Template Numerical Library by doxygen 1.16.1