Skip to main content

System Coupling C++ library 2023 R2

sysc::InputComplexVectorData Class Reference

Last update: 17.07.2025

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. More...
 
 InputComplexVectorData (double *const dataComplex, std::size_t size)
 Provide a constructor for input complex vector data with compact storage for both vector components and complex components. More...
 
 InputComplexVectorData (std::complex< double > *const dataComplex, std::size_t size)
 Provide a constructor for input complex vector data with compact storage for both vector components and complex components. More...
 
 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 compex components. More...
 
 InputComplexVectorData (double *const dataReal, double *const dataImaginary, std::size_t size)
 Create an input complex vector data access object with compact storage for vector components and split storage for compex components. More...
 
 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. More...
 
 InputComplexVectorData (std::complex< double > *const dataComplex1, std::complex< double > *const dataComplex2, std::complex< double > *const 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. More...
 
 InputComplexVectorData (double *const dataComplex1, double *const dataComplex2, double *const 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. More...
 
 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. More...
 
 InputComplexVectorData (double *const dataReal1, double *const dataImaginary1, double *const dataReal2, double *const dataImaginary2, double *const dataReal3, double *const 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. More...
 
 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. More...
 
 InputComplexVectorData (float *const dataComplex, std::size_t size)
 Provide a constructor for input complex vector data with compact storage for both vector components and complex components. More...
 
 InputComplexVectorData (std::complex< float > *const dataComplex, std::size_t size)
 Provide a constructor for input complex vector data with compact storage for both vector components and complex components. More...
 
 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 compex components. More...
 
 InputComplexVectorData (float *const dataReal, float *const dataImaginary, std::size_t size)
 Create an input complex vector data access object with compact storage for vector components and split storage for compex components. More...
 
 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. More...
 
 InputComplexVectorData (std::complex< float > *const dataComplex1, std::complex< float > *const dataComplex2, std::complex< float > *const 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. More...
 
 InputComplexVectorData (float *const dataComplex1, float *const dataComplex2, float *const 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. More...
 
 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. More...
 
 InputComplexVectorData (float *const dataReal1, float *const dataImaginary1, float *const dataReal2, float *const dataImaginary2, float *const dataReal3, float *const 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. More...
 
 InputComplexVectorData ()=default
 Provide a default constructor.
 
 InputComplexVectorData (const InputComplexVectorData &)=default
 Provide a copy-constructor.
 
 InputComplexVectorData (InputComplexVectorData &&)=default
 Provide a move-constructor.
 
InputComplexVectorDataoperator= (const InputComplexVectorData &)=default
 Provide a copy-assign operator.
 
InputComplexVectorDataoperator= (InputComplexVectorData &&)=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...
 
bool isSplitComplex () const noexcept
 Query whether it's a split or compact vector layout. More...
 
void * getData1 () const noexcept
 Get pointer to data1. More...
 
void * getData2 () const noexcept
 Get pointer to data2. More...
 
void * getData3 () const noexcept
 Get pointer to data3. More...
 
void * getData4 () const noexcept
 Get pointer to data4. More...
 
void * getData5 () const noexcept
 Get pointer to data5. More...
 
void * getData6 () const noexcept
 Get pointer to data6. More...
 

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/20]

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/20]

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

Provide a constructor for 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

◆ InputComplexVectorData() [3/20]

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

Provide a constructor for 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

◆ InputComplexVectorData() [4/20]

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 compex 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() [5/20]

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

Create an input complex vector data access object with compact storage for vector components and split storage for compex 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() [6/20]

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() [7/20]

sysc::InputComplexVectorData::InputComplexVectorData ( std::complex< double > *const  dataComplex1,
std::complex< double > *const  dataComplex2,
std::complex< double > *const  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() [8/20]

sysc::InputComplexVectorData::InputComplexVectorData ( double *const  dataComplex1,
double *const  dataComplex2,
double *const  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() [9/20]

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() [10/20]

sysc::InputComplexVectorData::InputComplexVectorData ( double *const  dataReal1,
double *const  dataImaginary1,
double *const  dataReal2,
double *const  dataImaginary2,
double *const  dataReal3,
double *const  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() [11/20]

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() [12/20]

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

Provide a constructor for 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

◆ InputComplexVectorData() [13/20]

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

Provide a constructor for 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

◆ InputComplexVectorData() [14/20]

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 compex 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() [15/20]

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

Create an input complex vector data access object with compact storage for vector components and split storage for compex 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() [16/20]

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() [17/20]

sysc::InputComplexVectorData::InputComplexVectorData ( std::complex< float > *const  dataComplex1,
std::complex< float > *const  dataComplex2,
std::complex< float > *const  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() [18/20]

sysc::InputComplexVectorData::InputComplexVectorData ( float *const  dataComplex1,
float *const  dataComplex2,
float *const  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() [19/20]

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() [20/20]

sysc::InputComplexVectorData::InputComplexVectorData ( float *const  dataReal1,
float *const  dataImaginary1,
float *const  dataReal2,
float *const  dataImaginary2,
float *const  dataReal3,
float *const  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).

References sysc::Double.

◆ getDataType()

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

Get the primitive type of data.

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

◆ 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).

Connect with Ansys