PatchDataField< T > Class Template Reference

Public Types
using	Field_type = T

Public Member Functions
	PatchDataField (PatchDataField &&other) noexcept
PatchDataField &	operator= (PatchDataField &&other) noexcept
	PatchDataField (std::string name, u32 nvar)
	PatchDataField (std::string name, u32 nvar, u32 obj_cnt)
	PatchDataField (const PatchDataField &other)
	PatchDataField (sham::DeviceBuffer< T > &&moved_buf, std::string name, u32 nvar)
	PatchDataField (sycl::buffer< T > &&moved_buf, u32 obj_cnt, std::string name, u32 nvar)
PatchDataField &	operator= (const PatchDataField &other)=delete
PatchDataField	duplicate () const
PatchDataField	duplicate (std::string new_name) const
std::unique_ptr< PatchDataField >	duplicate_to_ptr () const
sham::DeviceBuffer< T > &	get_buf ()
const sham::DeviceBuffer< T > &	get_buf () const
bool	is_empty () const
u64	memsize () const
const u32 &	get_nvar () const
u32	get_obj_cnt () const
u32	get_val_cnt () const
	Get the number of values stored in the field.
const std::string &	get_name () const
void	resize (u32 new_obj_cnt)
void	reserve (u32 new_obj_cnt)
void	expand (u32 obj_to_add)
void	shrink (u32 obj_to_rem)
void	insert_element (T v)
void	apply_offset (T off)
void	insert (const PatchDataField< T > &f2)
void	overwrite (const PatchDataField< T > &f2, u32 obj_cnt)
void	overwrite (const sham::DeviceBuffer< T > &f2, u32 len)
void	override (sycl::buffer< T > &data, u32 cnt)
void	override (std::vector< T > &data, u32 cnt)
void	override (const T val)
void	synchronize_buf ()
std::vector< T >	copy_to_stdvec ()
template<u32 nvar, bool is_pointer_access = shamrock::access_t_span>
shamrock::PatchDataFieldSpan< T, nvar, is_pointer_access >	get_span ()
	Returns a shamrock::PatchDataFieldSpan pointing to the current PatchDataField.
shamrock::PatchDataFieldSpan< T, shamrock::dynamic_nvar >	get_span_nvar_dynamic ()
	Returns a shamrock::PatchDataFieldSpan pointing to the current PatchDataField.
shamrock::PatchDataFieldSpan< T, shamrock::dynamic_nvar, shamrock::access_t_pointer >	get_pointer_span ()
template<class Lambdacd , class... Args>
std::set< u32 >	get_ids_set_where (Lambdacd &&cd_true, Args... args)
	Get the ids set where object.
template<class Lambdacd , class... Args>
std::vector< u32 >	get_ids_vec_where (Lambdacd &&cd_true, Args &&...args)
	Same function as.
template<class Lambdacd , class... Args>
std::tuple< std::optional< sycl::buffer< u32 > >, u32 >	get_ids_buf_where (Lambdacd &&cd_true, Args... args)
	Same function as.
template<class Lambdacd , class... Args>
sham::DeviceBuffer< u32 >	get_ids_where_recycle_buffer (sham::DeviceBuffer< u32 > &mask, Lambdacd &&cd_true, Args... args) const
template<class Lambdacd , class... Args>
sham::DeviceBuffer< u32 >	get_ids_where (Lambdacd &&cd_true, Args... args) const
	Same function as.
template<class Lambdacd >
std::vector< u32 >	get_elements_with_range (Lambdacd &&cd_true, T vmin, T vmax)
template<class LambdaCd >
std::tuple< std::optional< sycl::buffer< u32 > >, u32 >	get_elements_in_half_open (T vmin, T vmax)
	Get the indices of the elements in half open interval.
template<class Lambdacd >
std::unique_ptr< sycl::buffer< u32 > >	get_elements_with_range_buf (Lambdacd &&cd_true, T vmin, T vmax)
template<class Lambdacd >
void	check_err_range (Lambdacd &&cd_true, T vmin, T vmax, std::string add_log="")
void	extract_element (u32 pidx, PatchDataField< T > &to)
void	extract_elements (const sham::DeviceBuffer< u32 > &idxs, PatchDataField< T > &to)
bool	check_field_match (PatchDataField< T > &f2)
void	field_raz ()
void	append_subset_to (const std::vector< u32 > &idxs, PatchDataField &pfield)
	Copy all objects in idxs to pfield.
void	append_subset_to (sycl::buffer< u32 > &idxs_buf, u32 sz, PatchDataField &pfield)
void	append_subset_to (const sham::DeviceBuffer< u32 > &idxs_buf, u32 sz, PatchDataField &pfield) const
PatchDataField	make_new_from_subset (sycl::buffer< u32 > &idxs_buf, u32 sz)
PatchDataField	make_new_from_subset (sham::DeviceBuffer< u32 > &idxs_buf, u32 sz)
void	gen_mock_data (u32 obj_cnt, std::mt19937 &eng)
void	index_remap (sham::DeviceBuffer< u32 > &index_map, u32 len)
	this function remaps the patchdatafield like so val[id] = val[index_map[id]] index map describe : at index i, we will have the value that was at index_map[i]
void	permut_vars (const std::vector< u32 > &permut)
	permut the variables of the field according to the permut
void	index_remap_resize (sham::DeviceBuffer< u32 > &index_map, u32 len)
	this function remaps the patchdatafield like so val[id] = val[index_map[id]] index map describe : at index i, we will have the value that was at index_map[i] This function will resize the current field to the specified length
void	remove_ids (const sham::DeviceBuffer< u32 > &indexes, u32 len)
	remove the ids from the field
void	serialize_buf (shamalgs::SerializeHelper &serializer)
	minimal serialization assuming the user know the layout of the field
shamalgs::SerializeSize	serialize_buf_byte_size ()
	record the size usage of the serialization using serialize_buf
void	serialize_full (shamalgs::SerializeHelper &serializer)
	serialize everything in the class
shamalgs::SerializeSize	serialize_full_byte_size ()
	give the size usage of serialize_full
T	compute_max () const
T	compute_min () const
T	compute_sum () const
shambase::VecComponent< T >	compute_dot_sum ()
bool	has_nan ()
bool	has_inf ()
bool	has_nan_or_inf ()

Static Public Member Functions
static PatchDataField	deserialize_buf (shamalgs::SerializeHelper &serializer, std::string field_name, u32 nvar)
	deserialize a field inverse of serialize_buf
static PatchDataField	deserialize_full (shamalgs::SerializeHelper &serializer)
	deserialize a field inverse of serialize_full
static PatchDataField< T >	mock_field (u64 seed, u32 obj_cnt, std::string name, u32 nvar)
static PatchDataField< T >	mock_field (u64 seed, u32 obj_cnt, std::string name, u32 nvar, T vmin, T vmax)

Detailed Description

template<class T>
class PatchDataField< T >

Definition at line 43 of file PatchDataField.hpp.

Member Typedef Documentation

Field_type

template<class T >

using PatchDataField< T >::Field_type = T

Definition at line 112 of file PatchDataField.hpp.

Constructor & Destructor Documentation

PatchDataField() [1/6]

template<class T >

PatchDataField< T >::PatchDataField ( PatchDataField< T > &&  other )

inlinenoexcept

Definition at line 98 of file PatchDataField.hpp.

PatchDataField() [2/6]

template<class T >

PatchDataField< T >::PatchDataField ( std::string  name, u32  nvar  )

inline

Definition at line 114 of file PatchDataField.hpp.

PatchDataField() [3/6]

template<class T >

PatchDataField< T >::PatchDataField ( std::string  name, u32  nvar, u32  obj_cnt  )

inline

Definition at line 120 of file PatchDataField.hpp.

PatchDataField() [4/6]

template<class T >

PatchDataField< T >::PatchDataField ( const PatchDataField< T > &  other )

inline

Definition at line 126 of file PatchDataField.hpp.

PatchDataField() [5/6]

template<class T >

PatchDataField< T >::PatchDataField ( sham::DeviceBuffer< T > &&  moved_buf, std::string  name, u32  nvar  )

inline

Definition at line 131 of file PatchDataField.hpp.

PatchDataField() [6/6]

template<class T >

PatchDataField< T >::PatchDataField ( sycl::buffer< T > &&  moved_buf, u32  obj_cnt, std::string  name, u32  nvar  )

inline

Definition at line 136 of file PatchDataField.hpp.

Member Function Documentation

append_subset_to() [1/3]

template<class T >

void PatchDataField< T >::append_subset_to	(	const sham::DeviceBuffer< u32 > &	idxs_buf,
		u32	sz,
		PatchDataField< T > &	pfield
	)		const

Definition at line 127 of file PatchDataField.cpp.

append_subset_to() [2/3]

template<class T >

void PatchDataField< T >::append_subset_to	(	const std::vector< u32 > &	idxs,
		PatchDataField< T > &	pfield
	)

Copy all objects in idxs to pfield.

Parameters

idxs
pfield

Definition at line 159 of file PatchDataField.cpp.

Here is the call graph for this function:

append_subset_to() [3/3]

template<class T >

void PatchDataField< T >::append_subset_to	(	sycl::buffer< u32 > &	idxs_buf,
		u32	sz,
		PatchDataField< T > &	pfield
	)

Definition at line 148 of file PatchDataField.cpp.

apply_offset()

template<class T >

void PatchDataField< T >::apply_offset

(

T

off

)

Definition at line 203 of file PatchDataField.cpp.

check_err_range()

template<class T >

template<class Lambdacd >

void PatchDataField< T >::check_err_range ( Lambdacd &&  cd_true, T  vmin, T  vmax, std::string  add_log = ""  )

inline

Definition at line 734 of file PatchDataField.hpp.

check_field_match()

template<class T >

bool PatchDataField< T >::check_field_match

(

PatchDataField< T > &

f2

)

Definition at line 112 of file PatchDataField.cpp.

compute_dot_sum()

template<class T >

shambase::VecComponent< T > PatchDataField< T >::compute_dot_sum

(

)

Definition at line 484 of file PatchDataField.cpp.

compute_max()

template<class T >

T PatchDataField< T >::compute_max

(

)

const

Definition at line 451 of file PatchDataField.cpp.

compute_min()

template<class T >

T PatchDataField< T >::compute_min

(

)

const

Definition at line 462 of file PatchDataField.cpp.

compute_sum()

template<class T >

T PatchDataField< T >::compute_sum

(

)

const

Definition at line 473 of file PatchDataField.cpp.

copy_to_stdvec()

template<class T >

std::vector< T > PatchDataField< T >::copy_to_stdvec ( )

inline

Definition at line 228 of file PatchDataField.hpp.

deserialize_buf()

template<class T >

PatchDataField< T > PatchDataField< T >::deserialize_buf ( shamalgs::SerializeHelper &  serializer, std::string  field_name, u32  nvar  )

static

deserialize a field inverse of serialize_buf

Parameters

serializer
field_name
nvar

Returns

PatchDataField

Definition at line 401 of file PatchDataField.cpp.

deserialize_full()

template<class T >

PatchDataField< T > PatchDataField< T >::deserialize_full ( shamalgs::SerializeHelper &  serializer )

static

deserialize a field inverse of serialize_full

Parameters

serializer

Returns

PatchDataField

Definition at line 440 of file PatchDataField.cpp.

duplicate() [1/2]

template<class T >

PatchDataField PatchDataField< T >::duplicate ( ) const

inline

Definition at line 149 of file PatchDataField.hpp.

duplicate() [2/2]

template<class T >

PatchDataField PatchDataField< T >::duplicate ( std::string  new_name ) const

inline

Definition at line 154 of file PatchDataField.hpp.

duplicate_to_ptr()

template<class T >

std::unique_ptr< PatchDataField > PatchDataField< T >::duplicate_to_ptr ( ) const

inline

Definition at line 161 of file PatchDataField.hpp.

expand()

template<class T >

void PatchDataField< T >::expand ( u32  obj_to_add )

inline

Definition at line 611 of file PatchDataField.hpp.

extract_element()

template<class T >

void PatchDataField< T >::extract_element	(	u32	pidx,
		PatchDataField< T > &	to
	)

Definition at line 46 of file PatchDataField.cpp.

extract_elements()

template<class T >

void PatchDataField< T >::extract_elements	(	const sham::DeviceBuffer< u32 > &	idxs,
		PatchDataField< T > &	to
	)

Definition at line 100 of file PatchDataField.cpp.

field_raz()

template<class T >

void PatchDataField< T >::field_raz ( )

inline

Definition at line 464 of file PatchDataField.hpp.

get_buf() [1/2]

template<class T >

sham::DeviceBuffer< T > & PatchDataField< T >::get_buf ( )

inline

Definition at line 166 of file PatchDataField.hpp.

get_buf() [2/2]

template<class T >

const sham::DeviceBuffer< T > & PatchDataField< T >::get_buf ( ) const

inline

Definition at line 167 of file PatchDataField.hpp.

get_elements_in_half_open()

template<class T >

template<class LambdaCd >

std::tuple< std::optional< sycl::buffer< u32 > >, u32 > PatchDataField< T >::get_elements_in_half_open	(	T	vmin,
		T	vmax
	)

Get the indices of the elements in half open interval.

Template Parameters

LambdaCd

Parameters

vmin
vmax

Returns

std::tuple<std::optional<sycl::buffer<u32>>, u32>

get_elements_with_range()

template<class T >

template<class Lambdacd >

std::vector< u32 > PatchDataField< T >::get_elements_with_range ( Lambdacd &&  cd_true, T  vmin, T  vmax  )

inline

Definition at line 659 of file PatchDataField.hpp.

get_elements_with_range_buf()

template<class T >

template<class Lambdacd >

std::unique_ptr< sycl::buffer< u32 > > PatchDataField< T >::get_elements_with_range_buf ( Lambdacd &&  cd_true, T  vmin, T  vmax  )

inline

Definition at line 708 of file PatchDataField.hpp.

get_ids_buf_where()

template<class T >

template<class Lambdacd , class... Args>

std::tuple< std::optional< sycl::buffer< u32 > >, u32 > PatchDataField< T >::get_ids_buf_where ( Lambdacd &&  cd_true, Args...  args  )

inline

Same function as.

See also

PatchDataField::get_ids_set_where but return a optional sycl::buffer of the found index

Template Parameters

Lambdacd
Args

Parameters

cd_true
args

Returns

std::vector<u32>

Definition at line 333 of file PatchDataField.hpp.

Here is the call graph for this function:

get_ids_set_where()

template<class T >

template<class Lambdacd , class... Args>

std::set< u32 > PatchDataField< T >::get_ids_set_where ( Lambdacd &&  cd_true, Args...  args  )

inline

Get the ids set where object.

Template Parameters

Lambdacd
Args

Parameters

cd_true
args

Returns

std::set<u32>

Definition at line 281 of file PatchDataField.hpp.

get_ids_vec_where()

template<class T >

template<class Lambdacd , class... Args>

std::vector< u32 > PatchDataField< T >::get_ids_vec_where ( Lambdacd &&  cd_true, Args &&...  args  )

inline

Same function as.

See also

PatchDataField::get_ids_set_where but return a std::vector of the found index

Template Parameters

Lambdacd
Args

Parameters

cd_true
args

Returns

std::vector<u32>

Definition at line 307 of file PatchDataField.hpp.

get_ids_where()

template<class T >

template<class Lambdacd , class... Args>

sham::DeviceBuffer< u32 > PatchDataField< T >::get_ids_where ( Lambdacd &&  cd_true, Args...  args  ) const

inline

Same function as.

See also

PatchDataField::get_ids_set_where but return a optional sycl::buffer of the found index

Template Parameters

Lambdacd
Args

Parameters

cd_true
args

Returns

std::vector<u32>

Definition at line 405 of file PatchDataField.hpp.

Here is the call graph for this function:

get_ids_where_recycle_buffer()

template<class T >

template<class Lambdacd , class... Args>

sham::DeviceBuffer< u32 > PatchDataField< T >::get_ids_where_recycle_buffer ( sham::DeviceBuffer< u32 > &  mask, Lambdacd &&  cd_true, Args...  args  ) const

inline

Definition at line 367 of file PatchDataField.hpp.

get_name()

template<class T >

const std::string & PatchDataField< T >::get_name ( ) const

inline

Definition at line 199 of file PatchDataField.hpp.

get_nvar()

template<class T >

const u32 & PatchDataField< T >::get_nvar ( ) const

inline

Definition at line 173 of file PatchDataField.hpp.

get_obj_cnt()

template<class T >

u32 PatchDataField< T >::get_obj_cnt ( ) const

inline

Definition at line 175 of file PatchDataField.hpp.

get_pointer_span()

template<class T >

shamrock::PatchDataFieldSpan< T, shamrock::dynamic_nvar, shamrock::access_t_pointer > PatchDataField< T >::get_pointer_span ( )

inline

Definition at line 262 of file PatchDataField.hpp.

get_span()

template<class T >

template<u32 nvar, bool is_pointer_access = shamrock::access_t_span>

shamrock::PatchDataFieldSpan< T, nvar, is_pointer_access > PatchDataField< T >::get_span ( )

inline

Returns a shamrock::PatchDataFieldSpan pointing to the current PatchDataField.

Template Parameters

nvar	The number of variables in the span.

Returns

A shamrock::PatchDataFieldSpan pointing to this PatchDataField.

Definition at line 245 of file PatchDataField.hpp.

get_span_nvar_dynamic()

template<class T >

shamrock::PatchDataFieldSpan< T, shamrock::dynamic_nvar > PatchDataField< T >::get_span_nvar_dynamic ( )

inline

Returns a shamrock::PatchDataFieldSpan pointing to the current PatchDataField.

Returns

A shamrock::PatchDataFieldSpan pointing to this PatchDataField with dynamic number of variables.

Definition at line 256 of file PatchDataField.hpp.

get_val_cnt()

template<class T >

u32 PatchDataField< T >::get_val_cnt ( ) const

inline

Get the number of values stored in the field.

This function was introduced to replace the legacy one size() which could be confused with the of the buffer, which is not required to be the same.

Returns

u32 the total number of values of the field, which is the product of the number of objects and the number of variables per object.

Definition at line 195 of file PatchDataField.hpp.

Here is the call graph for this function:

has_inf()

template<class T >

bool PatchDataField< T >::has_inf

(

)

Definition at line 502 of file PatchDataField.cpp.

has_nan()

template<class T >

bool PatchDataField< T >::has_nan

(

)

Definition at line 494 of file PatchDataField.cpp.

has_nan_or_inf()

template<class T >

bool PatchDataField< T >::has_nan_or_inf

(

)

Definition at line 510 of file PatchDataField.cpp.

index_remap()

template<class T >

void PatchDataField< T >::index_remap	(	sham::DeviceBuffer< u32 > &	index_map,
		u32	len
	)

this function remaps the patchdatafield like so val[id] = val[index_map[id]] index map describe : at index i, we will have the value that was at index_map[i]

This function can be used to apply the result of a sort to the field

Parameters

index_map
len	the length of the map (must match with the current count)

Definition at line 253 of file PatchDataField.cpp.

Here is the call graph for this function:

index_remap_resize()

template<class T >

void PatchDataField< T >::index_remap_resize	(	sham::DeviceBuffer< u32 > &	index_map,
		u32	len
	)

this function remaps the patchdatafield like so val[id] = val[index_map[id]] index map describe : at index i, we will have the value that was at index_map[i] This function will resize the current field to the specified length

This function can be used to apply the result of a sort to the field

Parameters

index_map
len	the length of the map

Definition at line 234 of file PatchDataField.cpp.

Here is the call graph for this function:

insert()

template<class T >

void PatchDataField< T >::insert

(

const PatchDataField< T > &

f2

)

Definition at line 229 of file PatchDataField.cpp.

insert_element()

template<class T >

void PatchDataField< T >::insert_element

(

T

v

)

Definition at line 174 of file PatchDataField.cpp.

is_empty()

template<class T >

bool PatchDataField< T >::is_empty ( ) const

inline

Definition at line 169 of file PatchDataField.hpp.

make_new_from_subset() [1/2]

template<class T >

PatchDataField PatchDataField< T >::make_new_from_subset ( sham::DeviceBuffer< u32 > &  idxs_buf, u32  sz  )

inline

Definition at line 486 of file PatchDataField.hpp.

make_new_from_subset() [2/2]

template<class T >

PatchDataField PatchDataField< T >::make_new_from_subset ( sycl::buffer< u32 > &  idxs_buf, u32  sz  )

inline

Definition at line 480 of file PatchDataField.hpp.

memsize()

template<class T >

u64 PatchDataField< T >::memsize ( ) const

inline

Definition at line 171 of file PatchDataField.hpp.

mock_field() [1/2]

template<class T >

PatchDataField< T > PatchDataField< T >::mock_field ( u64  seed, u32  obj_cnt, std::string  name, u32  nvar  )

static

Definition at line 383 of file PatchDataField.cpp.

mock_field() [2/2]

template<class T >

PatchDataField< T > PatchDataField< T >::mock_field ( u64  seed, u32  obj_cnt, std::string  name, u32  nvar, T  vmin, T  vmax  )

static

Definition at line 372 of file PatchDataField.cpp.

operator=()

template<class T >

PatchDataField & PatchDataField< T >::operator= ( PatchDataField< T > &&  other )

inlinenoexcept

Definition at line 102 of file PatchDataField.hpp.

override() [1/3]

template<class T >

void PatchDataField< T >::override ( const T  val )

inline

Definition at line 652 of file PatchDataField.hpp.

override() [2/3]

template<class T >

void PatchDataField< T >::override ( std::vector< T > &  data, u32  cnt  )

inline

Definition at line 646 of file PatchDataField.hpp.

override() [3/3]

template<class T >

void PatchDataField< T >::override ( sycl::buffer< T > &  data, u32  cnt  )

inline

Definition at line 640 of file PatchDataField.hpp.

overwrite() [1/2]

template<class T >

void PatchDataField< T >::overwrite ( const PatchDataField< T > &  f2, u32  obj_cnt  )

inline

Definition at line 628 of file PatchDataField.hpp.

overwrite() [2/2]

template<class T >

void PatchDataField< T >::overwrite ( const sham::DeviceBuffer< T > &  f2, u32  len  )

inline

Definition at line 634 of file PatchDataField.hpp.

permut_vars()

template<class T >

void PatchDataField< T >::permut_vars

(

const std::vector< u32 > &

permut

)

permut the variables of the field according to the permut

Definition at line 267 of file PatchDataField.cpp.

Here is the call graph for this function:

remove_ids()

template<class T >

void PatchDataField< T >::remove_ids	(	const sham::DeviceBuffer< u32 > &	indexes,
		u32	len
	)

remove the ids from the field

Parameters

indexes
len

Definition at line 300 of file PatchDataField.cpp.

Here is the call graph for this function:

reserve()

template<class T >

void PatchDataField< T >::reserve ( u32  new_obj_cnt )

inline

Definition at line 604 of file PatchDataField.hpp.

resize()

template<class T >

void PatchDataField< T >::resize ( u32  new_obj_cnt )

inline

Definition at line 599 of file PatchDataField.hpp.

serialize_buf()

template<class T >

void PatchDataField< T >::serialize_buf

(

shamalgs::SerializeHelper &

serializer

)

minimal serialization assuming the user know the layout of the field

Parameters

serializer

Definition at line 390 of file PatchDataField.cpp.

serialize_buf_byte_size()

template<class T >

shamalgs::SerializeSize PatchDataField< T >::serialize_buf_byte_size

(

)

record the size usage of the serialization using serialize_buf

Returns

u64

Definition at line 418 of file PatchDataField.cpp.

serialize_full()

template<class T >

void PatchDataField< T >::serialize_full

(

shamalgs::SerializeHelper &

serializer

)

serialize everything in the class

Parameters

serializer

Definition at line 425 of file PatchDataField.cpp.

serialize_full_byte_size()

template<class T >

shamalgs::SerializeSize PatchDataField< T >::serialize_full_byte_size

(

)

give the size usage of serialize_full

Returns

u64

Definition at line 433 of file PatchDataField.cpp.

shrink()

template<class T >

void PatchDataField< T >::shrink ( u32  obj_to_rem )

inline

Definition at line 616 of file PatchDataField.hpp.

synchronize_buf()

template<class T >

void PatchDataField< T >::synchronize_buf ( )

inline

Definition at line 226 of file PatchDataField.hpp.

---

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

• shamrock/include/shamrock/patch/PatchDataField.hpp
• shamrock/src/patch/PatchDataField.cpp