Define a templated mdspan class (non owner of data) More...

#include <cs_mdspan.h>

Collaboration diagram for mdspan< T, N, L >:

Public Member Functions
CS_F_HOST_DEVICE	mdspan ()
	Default constructor method leading to "empty container". More...

template<typename... Args>
CS_F_HOST_DEVICE	mdspan (T *data, Args... indices)
	Constructor method using only global size (works for N=1). More...

CS_F_HOST_DEVICE	mdspan (T *data, const cs_lnum_t(&dims)[N])
	Constructor method using dimensions. More...

CS_F_HOST_DEVICE	mdspan (const mdspan &other)
	Constructor method using copy. May be a shallow copy. More...

CS_F_HOST_DEVICE	mdspan (mdspan &&other)
	Move constructor. More...

CS_F_HOST_DEVICE	~mdspan ()
	Desstructor method using dimensions. More...

CS_F_HOST mdspan &	operator= (const mdspan &other)
	Assignment operator. More...

CS_F_HOST_DEVICE mdspan &	operator= (mdspan &&other)

CS_F_HOST_DEVICE	operator T* () const
	Cast operator to "T*" from this class. More...

CS_F_HOST_DEVICE T &	operator[] (cs_lnum_t i)
	Overloaded [] operator to access the ith value (val[i]). More...

CS_F_HOST_DEVICE T &	operator[] (cs_lnum_t i) const
	Overloaded [] operator to access the ith value (val[i]). More...

template<typename Id1 >
CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1 >::value &&N==1, T & >	operator() (Id1 i)
	Overloaded () operator to access the ith value (val[i]). More...

template<typename Id1 >
CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1 >::value &&N==1, T & >	operator() (Id1 i) const
	Overloaded [] operator to access the ith value (val[i]). More...

template<typename Id1 , typename Id2 >
CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1, Id2 >::value &&N==2, T & >	operator() (Id1 i, Id2 j)
	Overloaded () operator to access the (i,j)-th value couple. More...

template<typename Id1 , typename Id2 >
CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1, Id2 >::value &&N==2, T & >	operator() (Id1 i, Id2 j) const
	Overloaded () operator to access the (i,j)-th value couple. More...

template<typename... Args>
CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Args... >::value &&(N!=2) &&(N!=1), T & >	operator() (Args... indices)
	Overloaded () operator to access the (i,j,k)-th value tuple. More...

template<typename... Args>
CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Args... >::value &&(N!=2) &&(N!=1), T & >	operator() (Args... indices) const
	Overloaded () operator to access the (i,j,k)-th value tuple. More...

CS_F_HOST_DEVICE void	set_data_ptr (T *data_ptr) const
	Set data pointer. More...

template<typename... Args>
CS_F_HOST_DEVICE void	update_data (T *data_ptr, Args... dims)
	Update data pointer and dimensions of span. More...

CS_F_HOST_DEVICE bool	empty () const
	Check if object is empty or not. More...

CS_F_HOST_DEVICE cs_lnum_t	size () const
	Getter for total size. More...

CS_F_HOST_DEVICE cs_lnum_t	extent (int i) const
	Getter for extent along a given dimension. More...

CS_F_HOST_DEVICE cs_lnum_t	offset (int i) const
	Getter for extent along a given dimension. More...

CS_F_HOST_DEVICE T *	data () const
	Getter for data raw pointer. More...

template<typename U >
CS_F_HOST_DEVICE U *	data () const
	Getter for data raw pointer with recast (casts T* to U*) More...

CS_F_HOST_DEVICE mdspan< T, 1, L >	view_1d ()
	Get span 1D view of the array, same total size. More...

template<typename... Args>
CS_F_HOST_DEVICE mdspan< T, N-sizeof...(Args), L >	sub_view (Args... indices)
	Getter for a subspan based on first dimension. More...

template<typename... Args>
CS_F_HOST_DEVICE T *	sub_array (Args... indices)
	Get sub array based on index. More...

template<typename... Args>
CS_F_HOST_DEVICE T *	sub_array (Args... indices) const
	Get sub array based on index. More...

CS_F_HOST void	set_to_val (T val, const cs_lnum_t n_vals=-1)
	Set all values of the data array to a constant value. More...

CS_F_HOST void	set_to_val (cs_dispatch_context &ctx, T val, const cs_lnum_t n_vals=-1)
	Set all values of the data array to a constant value while providing a dispatch context. It is up to the call to synchronize the context after this call. More...

CS_F_HOST void	set_to_val_on_subset (T val, const cs_lnum_t n_elts, const cs_lnum_t elt_ids[])
	Set subset of values of the data array to a constant value. More...

CS_F_HOST void	set_to_val_on_subset (cs_dispatch_context &ctx, T val, const cs_lnum_t n_elts, const cs_lnum_t elt_ids[])
	Set a subset of values of the data array to a constant value while providing a dispatch context. It is up to the call to synchronize the context after this call. More...

CS_F_HOST void	zero ()
	Set all values of the data array to 0. More...

CS_F_HOST void	zero (cs_dispatch_context &ctx)
	Set all values of the data array to 0. More...

CS_F_HOST void	copy_data (const T *data, const cs_lnum_t n_vals=-1)
	Copy data from const raw pointer, we suppose that data size is same as that of the array. More...

CS_F_HOST void	copy_data (mdspan &other, const cs_lnum_t n_vals=-1)
	Copy data from another mdspan, we suppose that data size is same as that of the array. An assert test the sizes in debug. More...

CS_F_HOST void	copy_data (cs_dispatch_context &ctx, T *data, const cs_lnum_t n_vals=-1)
	Copy data from raw pointer, we suppose that data size is same as that of the array. A dispatch_context is provided, hence no implicit synchronization which should be done by the caller. More...

CS_F_HOST void	copy_data (cs_dispatch_context &ctx, const T *data, const cs_lnum_t n_vals=-1)
	Copy data from const raw pointer, we suppose that data size is same as that of the array. A dispatch_context is provided, hence no implicit synchronization which should be done by the caller. More...

CS_F_HOST void	copy_data (cs_dispatch_context &ctx, mdspan &other, const cs_lnum_t n_vals=-1)
	Copy data from another mdspan, we suppose that data size is same as that of the array. An assert test the sizes in debug. More...

Protected Member Functions
template<typename... Args>
CS_F_HOST_DEVICE cs_lnum_t	data_offset_ (Args... indices) const
	Helper function to compute value offset. More...

template<typename... Args>
CS_F_HOST_DEVICE cs_lnum_t	contiguous_data_offset_ (Args... indices) const
	Helper function to compute value offset. More...

CS_F_HOST_DEVICE void	set_size_ (const cs_lnum_t(&dims)[N])
	Set size of array based on dimensions. More...

template<typename... Args>
CS_F_HOST_DEVICE void	set_size_ (Args... dims)
	Set size of N indices (variadic template) More...

template<typename... Args>
CS_F_HOST_DEVICE bool	check_bounds_ (Args... dims) const
	Check if provided arguments are within array bounds. More...

Static Protected Member Functions
template<typename... Args>
static CS_F_HOST_DEVICE void	check_operator_args_ (Args...)
	Helper function to static check operator input arguments. More...

template<typename... Args>
static CS_F_HOST_DEVICE void	check_sub_function_args_ (Args...)
	Helper function to static check sub-function input arguments. More...

Protected Attributes
cs_lnum_t	_extent [N]

cs_lnum_t	_offset [N]

cs_lnum_t	_size

T *	_data

Friends
template<class _T_ , int _N_, layout _L_>
class	array

CS_F_HOST_DEVICE friend void	swap (mdspan &first, mdspan &second)
	Class swap operator used for assignment or move. More...

Detailed Description

template<class T, int N, layout L = layout::right>
class cs::mdspan< T, N, L >

Define a templated mdspan class (non owner of data)

Template Parameters

T	: data type
N	: number of dimensions (int)
L	: memory layout (cs::layout)

Constructor & Destructor Documentation

◆ mdspan() [1/5]

CS_F_HOST_DEVICE mdspan ( )

inline

Default constructor method leading to "empty container".

◆ mdspan() [2/5]

CS_F_HOST_DEVICE mdspan	(	T *	data,
		Args...	indices
	)

inline

Constructor method using only global size (works for N=1).

Parameters

[in]	data	data pointer (raw)
[in]	indices	total size of data (1D)

◆ mdspan() [3/5]

CS_F_HOST_DEVICE mdspan	(	T *	data,
		const cs_lnum_t(&)	dims[N]
	)

inline

Constructor method using dimensions.

Parameters

[in]	data	data pointer (raw)
[in]	dims	array of sizes along dimensions

◆ mdspan() [4/5]

CS_F_HOST_DEVICE mdspan ( const mdspan< T, N, L > & other )

inline

Constructor method using copy. May be a shallow copy.

◆ mdspan() [5/5]

CS_F_HOST_DEVICE mdspan ( mdspan< T, N, L > && other )

inline

Move constructor.

Parameters

[in] other reference to other instance

◆ ~mdspan()

CS_F_HOST_DEVICE ~mdspan ( )

inline

Desstructor method using dimensions.

Member Function Documentation

◆ check_bounds_()

CS_F_HOST_DEVICE bool check_bounds_ ( Args... dims ) const

inlineprotected

Check if provided arguments are within array bounds.

Returns: True if out of bounds, false otherwise

◆ check_operator_args_()

static CS_F_HOST_DEVICE void check_operator_args_ ( Args... )

inlinestaticprotected

Helper function to static check operator input arguments.

◆ check_sub_function_args_()

static CS_F_HOST_DEVICE void check_sub_function_args_ ( Args... )

inlinestaticprotected

Helper function to static check sub-function input arguments.

◆ contiguous_data_offset_()

CS_F_HOST_DEVICE cs_lnum_t contiguous_data_offset_ ( Args... indices ) const

inlineprotected

Helper function to compute value offset.

Parameters

[in] indices Input arguments (parameter pack)

◆ copy_data() [1/5]

CS_F_HOST void copy_data	(	const T *	data,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Copy data from const raw pointer, we suppose that data size is same as that of the array.

Parameters

[in]	data	Pointer to copy
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ copy_data() [2/5]

CS_F_HOST void copy_data	(	cs_dispatch_context &	ctx,
		const T *	data,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Copy data from const raw pointer, we suppose that data size is same as that of the array. A dispatch_context is provided, hence no implicit synchronization which should be done by the caller.

Parameters

[in]	ctx	Reference to dispatch context
[in]	data	Pointer to copy
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ copy_data() [3/5]

CS_F_HOST void copy_data	(	cs_dispatch_context &	ctx,
		mdspan< T, N, L > &	other,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Copy data from another mdspan, we suppose that data size is same as that of the array. An assert test the sizes in debug.

Parameters

[in]	ctx	Reference to dispatch context
[in]	other	Reference to another mdspan object
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ copy_data() [4/5]

CS_F_HOST void copy_data	(	cs_dispatch_context &	ctx,
		T *	data,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Copy data from raw pointer, we suppose that data size is same as that of the array. A dispatch_context is provided, hence no implicit synchronization which should be done by the caller.

Parameters

[in]	ctx	Reference to dispatch context
[in]	data	Pointer to copy
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ copy_data() [5/5]

CS_F_HOST void copy_data	(	mdspan< T, N, L > &	other,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Copy data from another mdspan, we suppose that data size is same as that of the array. An assert test the sizes in debug.

Parameters

[in]	other	Reference to another mdspan object
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ data() [1/2]

CS_F_HOST_DEVICE T * data ( ) const

inline

Getter for data raw pointer.

Returns: raw pointer

◆ data() [2/2]

CS_F_HOST_DEVICE U * data ( ) const

inline

Getter for data raw pointer with recast (casts T* to U*)

Template Parameters

U	: data type used to cast T* into U*

Returns: raw pointer (U*)

◆ data_offset_()

CS_F_HOST_DEVICE cs_lnum_t data_offset_ ( Args... indices ) const

inlineprotected

Helper function to compute value offset.

Parameters

[in] indices Input arguments (parameter pack)

◆ empty()

CS_F_HOST_DEVICE bool empty ( ) const

inline

Check if object is empty or not.

Returns: true if size = 0 and false otherwise

◆ extent()

CS_F_HOST_DEVICE cs_lnum_t extent ( int i ) const

inline

Getter for extent along a given dimension.

Returns: extent.

◆ offset()

CS_F_HOST_DEVICE cs_lnum_t offset ( int i ) const

inline

Getter for extent along a given dimension.

Returns: extent.

◆ operator T*()

CS_F_HOST_DEVICE operator T* ( ) const

inline

Cast operator to "T*" from this class.

Returns: raw pointer which points to "_data" member

◆ operator()() [1/6]

CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Args... >::value &&(N!=2) &&(N!=1), T & > operator() ( Args... indices )

inline

Overloaded () operator to access the (i,j,k)-th value tuple.

Returns: const reference to the (i,j,k)-th value

Parameters

[in] indices Input arguments (parameter pack)

◆ operator()() [2/6]

CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Args... >::value &&(N!=2) &&(N!=1), T & > operator() ( Args... indices ) const

inline

Overloaded () operator to access the (i,j,k)-th value tuple.

Returns: const reference to the (i,j,k)-th value

Parameters

[in] indices Input arguments (parameter pack)

◆ operator()() [3/6]

CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1 >::value &&N==1, T & > operator() ( Id1 i )

inline

Overloaded () operator to access the ith value (val[i]).

Returns: raw pointer to the i-th value

Parameters

[in] i Index of value to get

◆ operator()() [4/6]

CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1 >::value &&N==1, T & > operator() ( Id1 i ) const

inline

Overloaded [] operator to access the ith value (val[i]).

Returns: raw pointer to the i-th value

Parameters

[in] i Index of value to get

◆ operator()() [5/6]

CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1, Id2 >::value &&N==2, T & > operator()	(	Id1	i,
		Id2	j
	)

inline

Overloaded () operator to access the (i,j)-th value couple.

Returns: reference to the (i,j)-th value

Parameters

[in]	i	Index along first dimension
[in]	j	Index along second dimension

◆ operator()() [6/6]

CS_F_HOST_DEVICE std::enable_if_t< cs::always_true< Id1, Id2 >::value &&N==2, T & > operator()	(	Id1	i,
		Id2	j
	)		const

inline

Overloaded () operator to access the (i,j)-th value couple.

Returns: const reference to the (i,j)-th value

Parameters

[in]	i	Index along first dimension
[in]	j	Index along second dimension

◆ operator=() [1/2]

CS_F_HOST mdspan & operator= ( const mdspan< T, N, L > & other )

inline

Assignment operator.

◆ operator=() [2/2]

CS_F_HOST_DEVICE mdspan & operator= ( mdspan< T, N, L > && other )

inline

◆ operator[]() [1/2]

CS_F_HOST_DEVICE T & operator[] ( cs_lnum_t i )

inline

Overloaded [] operator to access the ith value (val[i]).

Returns: raw pointer to the i-th value

Parameters

[in] i Index of value to get

◆ operator[]() [2/2]

CS_F_HOST_DEVICE T & operator[] ( cs_lnum_t i ) const

inline

Overloaded [] operator to access the ith value (val[i]).

Returns: raw pointer to the i-th value

Parameters

[in] i Index of value to get

◆ set_data_ptr()

CS_F_HOST_DEVICE void set_data_ptr ( T * data_ptr ) const

inline

Set data pointer.

Parameters

[in] data_ptr new pointer

◆ set_size_() [1/2]

CS_F_HOST_DEVICE void set_size_ ( Args... dims )

inlineprotected

Set size of N indices (variadic template)

Parameters

[in] dims Array of dimensions' sizes

◆ set_size_() [2/2]

CS_F_HOST_DEVICE void set_size_ ( const cs_lnum_t(&) dims[N] )

inlineprotected

Set size of array based on dimensions.

Parameters

[in] dims array of sizes along dimensions

◆ set_to_val() [1/2]

CS_F_HOST void set_to_val	(	cs_dispatch_context &	ctx,
		T	val,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Set all values of the data array to a constant value while providing a dispatch context. It is up to the call to synchronize the context after this call.

Parameters

	ctx	Reference to dispatch context
[in]	val	Value to set to entire data array.
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ set_to_val() [2/2]

CS_F_HOST void set_to_val	(	T	val,
		const cs_lnum_t	n_vals = `-1`
	)

inline

Set all values of the data array to a constant value.

Parameters

[in]	val	Value to set to entire data array.
[in]	n_vals	Number of values to copy. If -1, default, we use array size

◆ set_to_val_on_subset() [1/2]

CS_F_HOST void set_to_val_on_subset	(	cs_dispatch_context &	ctx,
		T	val,
		const cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[]
	)

inline

Set a subset of values of the data array to a constant value while providing a dispatch context. It is up to the call to synchronize the context after this call.

Parameters

	ctx	Reference to dispatch context
[in]	val	Value to set to entire data array.
[in]	n_elts	Number of values to set.
[in]	elt_ids	list of ids in the subset or null (size:n_elts)

◆ set_to_val_on_subset() [2/2]

CS_F_HOST void set_to_val_on_subset	(	T	val,
		const cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[]
	)

inline

Set subset of values of the data array to a constant value.

Parameters

[in]	val	Value to set to entire data array.
[in]	n_elts	Number of values to set.
[in]	elt_ids	list of ids in the subset or null (size:n_elts)

◆ size()

CS_F_HOST_DEVICE cs_lnum_t size ( ) const

inline

Getter for total size.

Returns: total size.

◆ sub_array() [1/2]

CS_F_HOST_DEVICE T * sub_array ( Args... indices )

inline

Get sub array based on index.

Parameters

[in] indices Input arguments (parameter pack)

◆ sub_array() [2/2]

CS_F_HOST_DEVICE T * sub_array ( Args... indices ) const

inline

Get sub array based on index.

Parameters

[in] indices Input arguments (parameter pack)

◆ sub_view()

CS_F_HOST_DEVICE mdspan< T, N-sizeof...(Args), L > sub_view ( Args... indices )

inline

Getter for a subspan based on first dimension.

Returns: pointer

Parameters

[in] indices Input arguments (parameter pack)

◆ update_data()

CS_F_HOST_DEVICE void update_data	(	T *	data_ptr,
		Args...	dims
	)

inline

Update data pointer and dimensions of span.

Parameters

[in]	data_ptr	New data pointer
[in]	dims	New dimensions (integer types)

◆ view_1d()

CS_F_HOST_DEVICE mdspan< T, 1, L > view_1d ( )

inline

Get span 1D view of the array, same total size.

Returns: mdspan<T,1,L> view with same total size as original object.

◆ zero() [1/2]

CS_F_HOST void zero ( )

inline

Set all values of the data array to 0.

◆ zero() [2/2]

CS_F_HOST void zero ( cs_dispatch_context & ctx )

inline

Set all values of the data array to 0.

Parameters

ctx	Reference to dispatch context

Friends And Related Function Documentation

◆ array

friend class array

friend

◆ swap

CS_F_HOST_DEVICE friend void swap	(	mdspan< T, N, L > &	first,
		mdspan< T, N, L > &	second
	)

friend

Class swap operator used for assignment or move.

Parameters

[in]	first	reference to first instance to swap
[in]	second	reference to second instance to swap

Member Data Documentation

◆ _data

T* _data

mutableprotected

◆ _extent

cs_lnum_t _extent[N]

protected

◆ _offset

cs_lnum_t _offset[N]

protected

◆ _size

cs_lnum_t _size

protected

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

src/base/cs_mdspan.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ mdspan() [1/5]

◆ mdspan() [2/5]

◆ mdspan() [3/5]

◆ mdspan() [4/5]

◆ mdspan() [5/5]

◆ ~mdspan()

Member Function Documentation

◆ check_bounds_()

◆ check_operator_args_()

◆ check_sub_function_args_()

◆ contiguous_data_offset_()

◆ copy_data() [1/5]

◆ copy_data() [2/5]

◆ copy_data() [3/5]

◆ copy_data() [4/5]

◆ copy_data() [5/5]

◆ data() [1/2]

◆ data() [2/2]

◆ data_offset_()

◆ empty()

◆ extent()

◆ offset()

◆ operator T*()

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ set_data_ptr()

◆ set_size_() [1/2]

◆ set_size_() [2/2]

◆ set_to_val() [1/2]

◆ set_to_val() [2/2]

◆ set_to_val_on_subset() [1/2]

◆ set_to_val_on_subset() [2/2]

◆ size()

◆ sub_array() [1/2]

◆ sub_array() [2/2]

◆ sub_view()

◆ update_data()

◆ view_1d()

◆ zero() [1/2]

◆ zero() [2/2]

Friends And Related Function Documentation

◆ array

◆ swap

Member Data Documentation

◆ _data

◆ _extent

◆ _offset

◆ _size