Class sysc::OutputVectorData

Definition: OutputVectorData.hpp (line 27)

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.

Members

• empty
• getData0
• getData1
• getData2
• getDataType
• getDimension
• isSplitVector
• m_data0
• m_data1
• m_data2
• m_dataType
• m_dimension
• m_isSplitVector
• m_size
• operator=
• operator=
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• OutputVectorData
• size

Private attributes

Variable m_dataType

Definition: OutputVectorData.hpp (line 260)

sysc::PrimitiveType sysc::OutputVectorData::m_dataType {sysc::Double}

Type: sysc::PrimitiveType

Variable m_isSplitVector

Definition: OutputVectorData.hpp (line 261)

bool sysc::OutputVectorData::m_isSplitVector {false}

Type: bool

Variable m_data0

Definition: OutputVectorData.hpp (line 262)

const void* sysc::OutputVectorData::m_data0 {nullptr}

Type: const void *

Variable m_data1

Definition: OutputVectorData.hpp (line 263)

const void* sysc::OutputVectorData::m_data1 {nullptr}

Type: const void *

Variable m_data2

Definition: OutputVectorData.hpp (line 264)

const void* sysc::OutputVectorData::m_data2 {nullptr}

Type: const void *

Variable m_size

Definition: OutputVectorData.hpp (line 265)

std::size_t sysc::OutputVectorData::m_size {0}

Type: std::size_t

Variable m_dimension

Definition: OutputVectorData.hpp (line 266)

Dimension sysc::OutputVectorData::m_dimension {Dimension::D3}

Type: Dimension

Public functions

Function OutputVectorData

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.

Parameters:

• const double * data
• std::size_t size

Return type:

Function OutputVectorData

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

Provide a constructor for 2D output vector data with compact storage.

Parameters:

• data: - pointer to the array of double-precision data.
• size: - number of vectors.
• dimension: - dimension of double-precision vector data.

Parameters:

• const double * data
• std::size_t size
• Dimension dimension

Return type:

Function OutputVectorData

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.

Parameters:

• const float * data
• std::size_t size

Return type:

Function OutputVectorData

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

Provide a constructor for 2D output vector data with compact storage.

Parameters:

• data: - pointer to the array of single-precision data.
• size: - number of vectors.
• dimension: - dimension of single-precision vector data.

Parameters:

• const float * data
• std::size_t size
• Dimension dimension

Return type:

Function OutputVectorData

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.

Parameters:

• const std::vector< double > & data

Return type:

Function OutputVectorData

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

Provide a constructor for 2D output vector data with compact storage.

Parameters:

• data: - reference to the STL vector of double-precision data.
• dimension: - dimension of double-precision vector data.

Parameters:

• const std::vector< double > & data
• Dimension dimension

Return type:

Function OutputVectorData

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.

Parameters:

• const std::vector< float > & data

Return type:

Function OutputVectorData

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

Provide a constructor for 2D output vector data with compact storage.

Parameters:

• data: - reference to the STL vector of single-precision data.
• dimension: - dimension of single-precision vector data.

Parameters:

• const std::vector< float > & data
• Dimension dimension

Return type:

Function OutputVectorData

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.

Parameters:

• const double * data0
• const double * data1
• const double * data2
• std::size_t size

Return type:

Function OutputVectorData

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

Create an 2D 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.
• size: - number of vectors.

Parameters:

• const double * data0
• const double * data1
• std::size_t size

Return type:

Function OutputVectorData

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.

Parameters:

• const float * data0
• const float * data1
• const float * data2
• std::size_t size

Return type:

Function OutputVectorData

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

Create an 2D 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.
• size: - number of vectors.

Parameters:

• const float * data0
• const float * data1
• std::size_t size

Return type:

Function OutputVectorData

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.

Parameters:

• const std::vector< double > & data0
• const std::vector< double > & data1
• const std::vector< double > & data2

Return type:

Function OutputVectorData

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

Create an 2D 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.

Parameters:

• const std::vector< double > & data0
• const std::vector< double > & data1

Return type:

Function OutputVectorData

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.

Parameters:

• const std::vector< float > & data0
• const std::vector< float > & data1
• const std::vector< float > & data2

Return type:

Function OutputVectorData

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

Create an 2D 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.

Parameters:

• const std::vector< float > & data0
• const std::vector< float > & data1

Return type:

Function OutputVectorData

sysc::OutputVectorData::OutputVectorData()=default

Provide a default constructor.

Return type:

Function OutputVectorData

sysc::OutputVectorData::OutputVectorData(const OutputVectorData &)=default

Provide a copy-constructor.

Parameters:

• const OutputVectorData &

Return type:

Function OutputVectorData

sysc::OutputVectorData::OutputVectorData(OutputVectorData &&)=default

Provide a move-constructor.

Parameters:

• OutputVectorData &&

Return type:

Function operator=

OutputVectorData& sysc::OutputVectorData::operator=(const OutputVectorData &)=default

Provide a copy-assign operator.

Parameters:

• const OutputVectorData &

Return type: OutputVectorData &

Function operator=

OutputVectorData& sysc::OutputVectorData::operator=(OutputVectorData &&)=default

Provide a move-assign operator.

Parameters:

• OutputVectorData &&

Return type: OutputVectorData &

Function size

std::size_t sysc::OutputVectorData::size() const noexcept

Get the size of data.

Return type: std::size_t

Function empty

bool sysc::OutputVectorData::empty() const noexcept

Check if array "data" is empty.

Return type: bool

Function getDataType

sysc::PrimitiveType sysc::OutputVectorData::getDataType() const noexcept

Get the primitive type of data.

For internal use only (no back-compatibility guarantee).

Return type: sysc::PrimitiveType

Function isSplitVector

bool sysc::OutputVectorData::isSplitVector() const noexcept

Query whether it's a split or compact vector layout.

For internal use only (no back-compatibility guarantee).

Return type: bool

Function getData0

const void* sysc::OutputVectorData::getData0() const noexcept

Get pointer to data0.

For internal use only (no back-compatibility guarantee).

Return type: const void *

Function getData1

const void* sysc::OutputVectorData::getData1() const noexcept

Get pointer to data1.

For internal use only (no back-compatibility guarantee).

Return type: const void *

Function getData2

const void* sysc::OutputVectorData::getData2() const noexcept

Get pointer to data2.

For internal use only (no back-compatibility guarantee).

Return type: const void *

Function getDimension

Dimension sysc::OutputVectorData::getDimension() const noexcept

Get the Dimension object.

Returns:

const Dimension

Return type: Dimension

References:

• sysc::Double