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

#include <OutputVectorData.hpp>

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

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

	OutputVectorData (const std::vector< double > &data)
	Provide a constructor for output vector data with compact storage. More...

	OutputVectorData (const std::vector< float > &data)
	Provide a constructor for output vector data with compact storage. More...

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

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

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

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

	OutputVectorData ()=default
	Provide a default constructor.

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

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

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

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

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

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

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

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

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

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

Detailed Description

Provide a class for output vector data.

Output vector data provides read-only 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 OutputVectorData.hpp.

Constructor & Destructor Documentation

◆ OutputVectorData() [1/8]

sysc::OutputVectorData::OutputVectorData	(	const double *	data,
		std::size_t	size
	)

Provide a constructor for output vector data with compact storage.

Parameters

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

◆ OutputVectorData() [2/8]

sysc::OutputVectorData::OutputVectorData	(	const float *	data,
		std::size_t	size
	)

Provide a constructor for output vector data with compact storage.

Parameters

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

◆ OutputVectorData() [3/8]

sysc::OutputVectorData::OutputVectorData ( const std::vector< double > & data )

Provide a constructor for output vector data with compact storage.

Parameters

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

◆ OutputVectorData() [4/8]

sysc::OutputVectorData::OutputVectorData ( const std::vector< float > & data )

Provide a constructor for output vector data with compact storage.

Parameters

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

◆ OutputVectorData() [5/8]

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

Create an output 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.

◆ OutputVectorData() [6/8]

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

Create an output 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.

◆ OutputVectorData() [7/8]

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

Create an output 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

◆ OutputVectorData() [8/8]

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

Create an output 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