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

#include <InputComplexVectorData.hpp>

Public Member Functions
	InputComplexVectorData (std::vector< std::complex< double > > &dataComplex)
	Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::vector< std::complex< double > > &dataComplex, Dimension dimension)
	Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (double *dataComplex, std::size_t size)
	Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (double *dataComplex, std::size_t size, Dimension dimension)
	Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::complex< double > *dataComplex, std::size_t size)
	Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::complex< double > *dataComplex, std::size_t size, Dimension dimension)
	Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::vector< double > &dataReal, std::vector< double > &dataImaginary)
	Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

	InputComplexVectorData (double dataReal, double dataImaginary, std::size_t size)
	Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

	InputComplexVectorData (std::vector< std::complex< double > > &dataComplex1, std::vector< std::complex< double > > &dataComplex2, std::vector< std::complex< double > > &dataComplex3)
	Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

	InputComplexVectorData (std::complex< double > dataComplex1, std::complex< double > dataComplex2, std::complex< double > *dataComplex3, std::size_t size)
	Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

	InputComplexVectorData (double dataComplex1, double dataComplex2, double *dataComplex3, std::size_t size)
	Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

	InputComplexVectorData (std::vector< double > &dataReal1, std::vector< double > &dataImaginary1, std::vector< double > &dataReal2, std::vector< double > &dataImaginary2, std::vector< double > &dataReal3, std::vector< double > &dataImaginary3)
	Create an input complex vector data access object with split storage for vector components and split storage for complex components.

	InputComplexVectorData (double dataReal1, double dataImaginary1, double dataReal2, double dataImaginary2, double dataReal3, double dataImaginary3, std::size_t size)
	Create an input complex vector data access object with split storage for vector components and split storage for complex components.

	InputComplexVectorData (std::vector< std::complex< float > > &dataComplex)
	Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::vector< std::complex< float > > &dataComplex, Dimension dimension)
	Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (float *dataComplex, std::size_t size)
	Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (float *dataComplex, std::size_t size, Dimension dimension)
	Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::complex< float > *dataComplex, std::size_t size)
	Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::complex< float > *dataComplex, std::size_t size, Dimension dimension)
	Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

	InputComplexVectorData (std::vector< float > &dataReal, std::vector< float > &dataImaginary)
	Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

	InputComplexVectorData (float dataReal, float dataImaginary, std::size_t size)
	Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

	InputComplexVectorData (std::vector< std::complex< float > > &dataComplex1, std::vector< std::complex< float > > &dataComplex2, std::vector< std::complex< float > > &dataComplex3)
	Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

	InputComplexVectorData (std::complex< float > dataComplex1, std::complex< float > dataComplex2, std::complex< float > *dataComplex3, std::size_t size)
	Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

	InputComplexVectorData (float dataComplex1, float dataComplex2, float *dataComplex3, std::size_t size)
	Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

	InputComplexVectorData (std::vector< float > &dataReal1, std::vector< float > &dataImaginary1, std::vector< float > &dataReal2, std::vector< float > &dataImaginary2, std::vector< float > &dataReal3, std::vector< float > &dataImaginary3)
	Create an input complex vector data access object with split storage for vector components and split storage for complex components.

	InputComplexVectorData (float dataReal1, float dataImaginary1, float dataReal2, float dataImaginary2, float dataReal3, float dataImaginary3, std::size_t size)
	Create an input complex vector data access object with split storage for vector components and split storage for complex components.

	InputComplexVectorData ()=default
	Provide a default constructor.

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

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

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

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

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

bool	empty () const noexcept
	Check if array "data" is empty.

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

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

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

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

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

void *	getData3 () const noexcept
	Get pointer to data3.

void *	getData4 () const noexcept
	Get pointer to data4.

void *	getData5 () const noexcept
	Get pointer to data5.

void *	getData6 () const noexcept
	Get pointer to data6.

Dimension	getDimension () const noexcept
	Get the Dimension object.

Detailed Description

Provide a class for input complex vector data.

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

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

Definition at line 29 of file InputComplexVectorData.hpp.

Constructor & Destructor Documentation

◆ InputComplexVectorData() [1/26]

sysc::InputComplexVectorData::InputComplexVectorData ( std::vector< std::complex< double > > & dataComplex )

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex - reference to the STL vector of complex double-precision data.

◆ InputComplexVectorData() [2/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< std::complex< double > > &	dataComplex,
		Dimension	dimension
	)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- reference to the STL vector of complex double-precision data.
dimension	- dimension of complex vector data.

◆ InputComplexVectorData() [3/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	double *	dataComplex,
		std::size_t	size
	)

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- pointer to an array of complex double-precision vectors.
size	- number of vectors.

◆ InputComplexVectorData() [4/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	double *	dataComplex,
		std::size_t	size,
		Dimension	dimension
	)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- pointer to an array of complex double-precision vectors
size	- number of vectors.
dimension	- dimension of complex vector data.

◆ InputComplexVectorData() [5/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::complex< double > *	dataComplex,
		std::size_t	size
	)

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- pointer to an array of complex double-precision vectors.
size	- number of vectors.

◆ InputComplexVectorData() [6/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::complex< double > *	dataComplex,
		std::size_t	size,
		Dimension	dimension
	)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters

data	- pointer to an array of complex double-precision vectors.
size	- number of vectors.
dimension	- dimension of complex vector data.

◆ InputComplexVectorData() [7/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< double > &	dataReal,
		std::vector< double > &	dataImaginary
	)

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters

dataReal	- reference to the STL vector of double-precision data, that stores the real components of the complex vectors in compact storage format.
dataImaginary	- reference to the STL vector of double-precision data, that stores the imaginary components of the complex vectors in compact storage format.

◆ InputComplexVectorData() [8/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	double *	dataReal,
		double *	dataImaginary,
		std::size_t	size
	)

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters

dataReal	- pointer to an array of double-precision data, that stores the real components of the complex vectors in compact storage format.
dataImaginary	- pointer to an array of double-precision data, that stores the imaginary components of the complex vectors in compact storage format.
size	- number of vectors.

◆ InputComplexVectorData() [9/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< std::complex< double > > &	dataComplex1,
		std::vector< std::complex< double > > &	dataComplex2,
		std::vector< std::complex< double > > &	dataComplex3
	)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters

dataComplex1	- reference to the STL vector of complex double-precision data that stores the first components of the vectors of complex numbers.
dataComplex2	- reference to the STL vector of complex double-precision data that stores the second components of the vectors of complex numbers.
dataComplex3	- reference to the STL vector of complex double-precision data that stores the third components of the vectors of complex numbers.

◆ InputComplexVectorData() [10/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::complex< double > *	dataComplex1,
		std::complex< double > *	dataComplex2,
		std::complex< double > *	dataComplex3,
		std::size_t	size
	)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters

dataComplex1	- pointer to an array of double-precision complex data that stores the first components of the vectors of complex numbers.
dataComplex2	- pointer to an array of double-precision complex data that stores the second components of the vectors of complex numbers.
dataComplex3	- pointer to an array of double-precision complex data that stores the third components of the vectors of complex numbers.
size	- number of vectors.

◆ InputComplexVectorData() [11/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	double *	dataComplex1,
		double *	dataComplex2,
		double *	dataComplex3,
		std::size_t	size
	)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters

dataComplex1	- pointer to an array of double-precision data that stores the first components of the vectors of complex numbers.
dataComplex2	- pointer to an array of double-precision data that stores the second components of the vectors of complex numbers.
dataComplex3	- pointer to an array of double-precision data that stores the third components of the vectors of complex numbers.
size	- number of vectors.

◆ InputComplexVectorData() [12/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< double > &	dataReal1,
		std::vector< double > &	dataImaginary1,
		std::vector< double > &	dataReal2,
		std::vector< double > &	dataImaginary2,
		std::vector< double > &	dataReal3,
		std::vector< double > &	dataImaginary3
	)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters

dataReal1	- reference to the STL vector of double-precision data that stores the first real components of the vectors of complex numbers.
dataImaginary1	- reference to the STL vector of double-precision data that stores the first imaginary components of the vectors of complex numbers.
dataReal2	- reference to the STL vector of double-precision data that stores the second real components of the vectors of complex numbers.
dataImaginary2	- reference to the STL vector of double-precision data that stores the second imaginary components of the vectors of complex numbers.
dataReal3	- reference to the STL vector of double-precision data that stores the third real components of the vectors of complex numbers.
dataImaginary3	- reference to the STL vector of double-precision data that stores the third imaginary components of the vectors of complex numbers.

◆ InputComplexVectorData() [13/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	double *	dataReal1,
		double *	dataImaginary1,
		double *	dataReal2,
		double *	dataImaginary2,
		double *	dataReal3,
		double *	dataImaginary3,
		std::size_t	size
	)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters

dataReal1	- pointer to an array of double-precision data that stores the first real components of the vectors of complex numbers.
dataImaginary1	- pointer to an array of double-precision data that stores the first imaginary components of the vectors of complex numbers.
dataReal2	- pointer to an array of double-precision data that stores the second real components of the vectors of complex numbers.
dataImaginary2	- pointer to an array of double-precision data that stores the second imaginary components of the vectors of complex numbers.
dataReal3	- pointer to an array of double-precision data that stores the third real components of the vectors of complex numbers.
dataImaginary3	- pointer to an array of double-precision data that stores the third imaginary components of the vectors of complex numbers.
size	- number of vectors.

◆ InputComplexVectorData() [14/26]

sysc::InputComplexVectorData::InputComplexVectorData ( std::vector< std::complex< float > > & dataComplex )

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex - reference to the STL vector of complex double-precision data.

◆ InputComplexVectorData() [15/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< std::complex< float > > &	dataComplex,
		Dimension	dimension
	)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- reference to the STL vector of complex double-precision data.
dimension	dimension of complex vector data.

◆ InputComplexVectorData() [16/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	float *	dataComplex,
		std::size_t	size
	)

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- pointer to an array of complex single-precision vectors.
size	- number of vectors.

◆ InputComplexVectorData() [17/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	float *	dataComplex,
		std::size_t	size,
		Dimension	dimension
	)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- pointer to an array of complex single-precision vectors.
size	- number of vectors.
dimension	dimension of complex vector data.

◆ InputComplexVectorData() [18/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::complex< float > *	dataComplex,
		std::size_t	size
	)

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters

dataComplex	- pointer to an array of complex single-precision vectors.
size	- number of vectors.

◆ InputComplexVectorData() [19/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::complex< float > *	dataComplex,
		std::size_t	size,
		Dimension	dimension
	)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters

data	- pointer to an array of complex single-precision vectors.
size	- number of vectors.
dimension	dimension of complex vector data.

◆ InputComplexVectorData() [20/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< float > &	dataReal,
		std::vector< float > &	dataImaginary
	)

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters

dataReal	- reference to the STL vector of single-precision data, that stores the real components of the complex vectors in compact storage format.
dataImaginary	- reference to the STL vector of single-precision data, that stores the imaginary components of the complex vectors in compact storage format.

◆ InputComplexVectorData() [21/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	float *	dataReal,
		float *	dataImaginary,
		std::size_t	size
	)

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters

dataReal	- pointer to an array of single-precision data, that stores the real components of the complex vectors in compact storage format.
dataImaginary	- pointer to an array of single-precision data, that stores the imaginary components of the complex vectors in compact storage format.
size	- number of vectors.

◆ InputComplexVectorData() [22/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< std::complex< float > > &	dataComplex1,
		std::vector< std::complex< float > > &	dataComplex2,
		std::vector< std::complex< float > > &	dataComplex3
	)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters

dataComplex1	- reference to the STL vector of complex single-precision data that stores the first components of the vectors of complex numbers.
dataComplex2	- reference to the STL vector of complex single-precision data that stores the second components of the vectors of complex numbers.
dataComplex3	- reference to the STL vector of complex single-precision data that stores the third components of the vectors of complex numbers.

◆ InputComplexVectorData() [23/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::complex< float > *	dataComplex1,
		std::complex< float > *	dataComplex2,
		std::complex< float > *	dataComplex3,
		std::size_t	size
	)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters

dataComplex1	- pointer to an array of single-precision complex data that stores the first components of the vectors of complex numbers.
dataComplex2	- pointer to an array of single-precision complex data that stores the second components of the vectors of complex numbers.
dataComplex3	- pointer to an array of single-precision complex data that stores the third components of the vectors of complex numbers.
size	- number of vectors.

◆ InputComplexVectorData() [24/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	float *	dataComplex1,
		float *	dataComplex2,
		float *	dataComplex3,
		std::size_t	size
	)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters

dataComplex1	- pointer to an array of single-precision data that stores the first components of the vectors of complex numbers.
dataComplex2	- pointer to an array of single-precision data that stores the second components of the vectors of complex numbers.
dataComplex3	- pointer to an array of single-precision data that stores the third components of the vectors of complex numbers.
size	- number of vectors.

◆ InputComplexVectorData() [25/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	std::vector< float > &	dataReal1,
		std::vector< float > &	dataImaginary1,
		std::vector< float > &	dataReal2,
		std::vector< float > &	dataImaginary2,
		std::vector< float > &	dataReal3,
		std::vector< float > &	dataImaginary3
	)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters

dataReal1	- reference to the STL vector of single-precision data that stores the first real components of the vectors of complex numbers.
dataImaginary1	- reference to the STL vector of single-precision data that stores the first imaginary components of the vectors of complex numbers.
dataReal2	- reference to the STL vector of single-precision data that stores the second real components of the vectors of complex numbers.
dataImaginary2	- reference to the STL vector of single-precision data that stores the second imaginary components of the vectors of complex numbers.
dataReal3	- reference to the STL vector of single-precision data that stores the third real components of the vectors of complex numbers.
dataImaginary3	- reference to the STL vector of single-precision data that stores the third imaginary components of the vectors of complex numbers.

◆ InputComplexVectorData() [26/26]

sysc::InputComplexVectorData::InputComplexVectorData	(	float *	dataReal1,
		float *	dataImaginary1,
		float *	dataReal2,
		float *	dataImaginary2,
		float *	dataReal3,
		float *	dataImaginary3,
		std::size_t	size
	)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters

dataReal1	- pointer to an array of single-precision data that stores the first real components of the vectors of complex numbers.
dataImaginary1	- pointer to an array of single-precision data that stores the first imaginary components of the vectors of complex numbers.
dataReal2	- pointer to an array of single-precision data that stores the second real components of the vectors of complex numbers.
dataImaginary2	- pointer to an array of single-precision data that stores the second imaginary components of the vectors of complex numbers.
dataReal3	- pointer to an array of single-precision data that stores the third real components of the vectors of complex numbers.
dataImaginary3	- pointer to an array of single-precision data that stores the third imaginary components of the vectors of complex numbers.
size	- number of vectors.

Member Function Documentation

◆ getData1()

void * sysc::InputComplexVectorData::getData1 ( ) const

noexcept

Get pointer to data1.

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

◆ getData2()

void * sysc::InputComplexVectorData::getData2 ( ) const

noexcept

Get pointer to data2.

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

◆ getData3()

void * sysc::InputComplexVectorData::getData3 ( ) const

noexcept

Get pointer to data3.

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

◆ getData4()

void * sysc::InputComplexVectorData::getData4 ( ) const

noexcept

Get pointer to data4.

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

◆ getData5()

void * sysc::InputComplexVectorData::getData5 ( ) const

noexcept

Get pointer to data5.

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

◆ getData6()

void * sysc::InputComplexVectorData::getData6 ( ) const

noexcept

Get pointer to data6.

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

◆ getDataType()

sysc::PrimitiveType sysc::InputComplexVectorData::getDataType ( ) const

noexcept

Get the primitive type of data.

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

◆ getDimension()

Dimension sysc::InputComplexVectorData::getDimension ( ) const

noexcept

Get the Dimension object.

Returns: Dimension

References sysc::Double.

◆ isSplitComplex()

bool sysc::InputComplexVectorData::isSplitComplex ( ) const

noexcept

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

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

◆ isSplitVector()

bool sysc::InputComplexVectorData::isSplitVector ( ) const

noexcept

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

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

sysc::InputComplexVectorData Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ InputComplexVectorData() [1/26]

◆ InputComplexVectorData() [2/26]

◆ InputComplexVectorData() [3/26]

◆ InputComplexVectorData() [4/26]

◆ InputComplexVectorData() [5/26]

◆ InputComplexVectorData() [6/26]

◆ InputComplexVectorData() [7/26]

◆ InputComplexVectorData() [8/26]

◆ InputComplexVectorData() [9/26]

◆ InputComplexVectorData() [10/26]

◆ InputComplexVectorData() [11/26]

◆ InputComplexVectorData() [12/26]

◆ InputComplexVectorData() [13/26]

◆ InputComplexVectorData() [14/26]

◆ InputComplexVectorData() [15/26]

◆ InputComplexVectorData() [16/26]

◆ InputComplexVectorData() [17/26]

◆ InputComplexVectorData() [18/26]

◆ InputComplexVectorData() [19/26]

◆ InputComplexVectorData() [20/26]

◆ InputComplexVectorData() [21/26]

◆ InputComplexVectorData() [22/26]

◆ InputComplexVectorData() [23/26]

◆ InputComplexVectorData() [24/26]

◆ InputComplexVectorData() [25/26]

◆ InputComplexVectorData() [26/26]

Member Function Documentation

◆ getData1()

◆ getData2()

◆ getData3()

◆ getData4()

◆ getData5()

◆ getData6()

◆ getDataType()

◆ getDimension()

◆ isSplitComplex()

◆ isSplitVector()

Connect with Ansys