Provide a class for input vector data. More...

#include <InputVectorData.hpp>

Public Member Functions
	InputVectorData (double *data, std::size_t size)
	Provide a constructor for input vector data with compact storage. More...

	InputVectorData (float *data, std::size_t size)
	Provide a constructor for input vector data with compact storage. More...

	InputVectorData (std::vector< double > &data)
	Provide a constructor for input vector data with compact storage. More...

	InputVectorData (std::vector< float > &data)
	Provide a constructor for input vector data with compact storage. More...

	InputVectorData (double data0, double data1, double *data2, std::size_t size)
	Create an input vector data access object with split storage. More...

	InputVectorData (float data0, float data1, float *data2, const std::size_t size)
	Create an input vector data access object with split storage. More...

	InputVectorData (std::vector< double > &data0, std::vector< double > &data1, std::vector< double > &data2)
	Create an input vector data access object with split storage. More...

	InputVectorData (std::vector< float > &data0, std::vector< float > &data1, std::vector< float > &data2)
	Create an input vector data access object with split storage. More...

	InputVectorData ()=default
	Provide a default constructor.

	InputVectorData (const InputVectorData &)=default
	Provide a copy-constructor.

	InputVectorData (InputVectorData &&)=default
	Provide a move-constructor.

InputVectorData &	operator= (const InputVectorData &)=default
	Provide a copy-assign operator.

InputVectorData &	operator= (InputVectorData &&)=default
	Provide a move-assign operator.

std::size_t	size () const noexcept
	Get the size of data.

sysc::PrimitiveType	getDataType () const noexcept
	Get the primitive type of data. More...

bool	isSplitVector () const noexcept
	Query whether it's a split or compact vector layout. More...

void *	getData0 () const noexcept
	Get pointer to data0. More...

void *	getData1 () const noexcept
	Get pointer to data1. More...

void *	getData2 () const noexcept
	Get pointer to data2. More...

Detailed Description

Provide a class for input vector data.

Input vector data provides read and write access to an array of vector data.

The size is the total number of vectors, not the total number of components, i.e. if all data is stored in one contiguous array, then size is 1/3 the size of that array.

Definition at line 27 of file InputVectorData.hpp.

Constructor & Destructor Documentation

◆ InputVectorData() [1/8]

sysc::InputVectorData::InputVectorData	(	double *	data,
		std::size_t	size
	)

Provide a constructor for input vector data with compact storage.

Parameters

data	- pointer to the array of double-precision data
size	- number of vectors.

◆ InputVectorData() [2/8]

sysc::InputVectorData::InputVectorData	(	float *	data,
		std::size_t	size
	)

Provide a constructor for input vector data with compact storage.

Parameters

data	- pointer to the array of single-precision data
size	- number of vectors.

◆ InputVectorData() [3/8]

sysc::InputVectorData::InputVectorData ( std::vector< double > & data )

Provide a constructor for input vector data with compact storage.

Parameters

data	- reference to the STL vector of double-precision data

◆ InputVectorData() [4/8]

sysc::InputVectorData::InputVectorData ( std::vector< float > & data )

Provide a constructor for input vector data with compact storage.

Parameters

data	- reference to the STL vector of single-precision data

◆ InputVectorData() [5/8]

sysc::InputVectorData::InputVectorData	(	double *	data0,
		double *	data1,
		double *	data2,
		std::size_t	size
	)

Create an input vector data access object with split storage.

Parameters

data0	- pointer to the first array of double-precision data
data1	- pointer to the second array of double-precision data
data2	- pointer to the third array of double-precision data
size	- number of vectors.

◆ InputVectorData() [6/8]

sysc::InputVectorData::InputVectorData	(	float *	data0,
		float *	data1,
		float *	data2,
		const std::size_t	size
	)

Create an input vector data access object with split storage.

Parameters

data0	- pointer to the first array of single-precision data
data1	- pointer to the second array of single-precision data
data2	- pointer to the third array of single-precision data
size	- number of vectors.

◆ InputVectorData() [7/8]

sysc::InputVectorData::InputVectorData	(	std::vector< double > &	data0,
		std::vector< double > &	data1,
		std::vector< double > &	data2
	)

Create an input vector data access object with split storage.

Parameters

data0	- reference to the first STL vector of double-precision data
data1	- reference to the second STL vector of double-precision data
data2	- reference to the third STL vector of double-precision data

◆ InputVectorData() [8/8]

sysc::InputVectorData::InputVectorData	(	std::vector< float > &	data0,
		std::vector< float > &	data1,
		std::vector< float > &	data2
	)

Create an input vector data access object with split storage.

Parameters

data0	- reference to the first STL vector of single-precision data
data1	- reference to the second STL vector of single-precision data
data2	- reference to the third STL vector of single-precision data

Member Function Documentation