## On this page

  

 

 # sysc::OutputComplexScalarData Class Reference

 Last update: 17.07.2025 

Provide a class for output complex scalar data. [More...](classsysc_1_1OutputComplexScalarData.xhtml#details)

`#include <<a class="el" href="OutputComplexScalarData_8hpp_source.xhtml">OutputComplexScalarData.hpp</a>>`

## <a name="pub-methods"></a>Public Member Functions

 [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#adf91ed9369ea790ff25efc8138429b3d) (const std::vector&lt; std::complex&lt; double &gt;&gt; &amp;dataComplex) Provide a constructor for output complex scalar data with compact storage for complex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#adf91ed9369ea790ff25efc8138429b3d)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#addb41ddd037b27dd19e6654294f7c194) (const std::complex&lt; double &gt; \*dataComplex, std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a)) Provide a constructor for output complex scalar data with compact storage for complex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#addb41ddd037b27dd19e6654294f7c194)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#aef2fe0ae45472d732a8fa1b6c3bf83a2) (const double \*dataComplex, std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a)) Provide a constructor for output complex scalar data with compact storage for complex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#aef2fe0ae45472d732a8fa1b6c3bf83a2)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a883a5a886f1ec85c866f73d93bb170bf) (const std::vector&lt; double &gt; &amp;dataReal, const std::vector&lt; double &gt; &amp;dataImaginary) Create an output complex scalar data access object with split storage for compex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a883a5a886f1ec85c866f73d93bb170bf)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a76a7cea2727d9cfad5419c65265e507e) (const double \*dataReal, const double \*dataImaginary, std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a)) Create an output complex scalar data access object with split storage for compex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a76a7cea2727d9cfad5419c65265e507e)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a1da27e8572b96fb4687735b8a32a3aa6) (const std::vector&lt; std::complex&lt; float &gt;&gt; &amp;dataComplex) Provide a constructor for output complex scalar data with compact storage for complex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a1da27e8572b96fb4687735b8a32a3aa6)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a723362aff534d9a651bb9ce11cd82f7a) (const std::complex&lt; float &gt; \*dataComplex, std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a)) Provide a constructor for output complex scalar data with compact storage for complex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a723362aff534d9a651bb9ce11cd82f7a)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a684da76ee59e2dcae970dfc34e89f9aa) (const float \*dataComplex, std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a)) Provide a constructor for output complex scalar data with compact storage for complex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a684da76ee59e2dcae970dfc34e89f9aa)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a509c85873eece0980798e7d0263b1552) (const std::vector&lt; float &gt; &amp;dataReal, const std::vector&lt; float &gt; &amp;dataImaginary) Create an output complex scalar data access object with split storage for compex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a509c85873eece0980798e7d0263b1552)  
  [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#acc8f1a93aaf429db11baf9043ea34bf9) (const float \*dataReal, const float \*dataImaginary, std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a)) Create an output complex scalar data access object with split storage for compex components. [More...](classsysc_1_1OutputComplexScalarData.xhtml#acc8f1a93aaf429db11baf9043ea34bf9)  
 <a id="a6826d90466e7bf1fabc6e1b8f78cda5a"></a> [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a6826d90466e7bf1fabc6e1b8f78cda5a) ()=default Provide a default constructor.   
 <a id="af33df90acece2bce5d93d7357c4b3d59"></a> [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#af33df90acece2bce5d93d7357c4b3d59) (const [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) &amp;)=default Provide a copy-constructor.   
 <a id="a869ea682dbf359db976655f2e3098408"></a> [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml#a869ea682dbf359db976655f2e3098408) ([OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) &amp;&amp;)=default Provide a move-constructor.   
 <a id="ae3e6b55441d7702c04f998f307cc957d"></a>[OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) &amp; [operator=](classsysc_1_1OutputComplexScalarData.xhtml#ae3e6b55441d7702c04f998f307cc957d) (const [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) &amp;)=default Provide a copy-assign operator.   
 <a id="aa14627de46b45ac3070900803114062c"></a>[OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) &amp; [operator=](classsysc_1_1OutputComplexScalarData.xhtml#aa14627de46b45ac3070900803114062c) ([OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) &amp;&amp;)=default Provide a move-assign operator.   
 <a id="a961c32a17e1d33ceb346c15768b5290a"></a>std::size\_t [size](classsysc_1_1OutputComplexScalarData.xhtml#a961c32a17e1d33ceb346c15768b5290a) () const noexcept Get the size of data.   
 <a id="ade274ee7bd0e02ea712cfac8c9c3df1e"></a>bool [empty](classsysc_1_1OutputComplexScalarData.xhtml#ade274ee7bd0e02ea712cfac8c9c3df1e) () const noexcept Check if array "data" is empty.   
 [sysc::PrimitiveType](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844) [getDataType](classsysc_1_1OutputComplexScalarData.xhtml#aa9fde7656420e140ec4b575dc27e3ed1) () const noexcept Get the primitive type of data. [More...](classsysc_1_1OutputComplexScalarData.xhtml#aa9fde7656420e140ec4b575dc27e3ed1)  
 bool [isSplitComplex](classsysc_1_1OutputComplexScalarData.xhtml#a2d9a5cce0e6fcb99344276db9b0d1030) () const noexcept Query whether it's a split or compact vector layout. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a2d9a5cce0e6fcb99344276db9b0d1030)  
 const void \* [getData1](classsysc_1_1OutputComplexScalarData.xhtml#afc4cf635f16255debd5367c71e2eeebb) () const noexcept Get pointer to data1. [More...](classsysc_1_1OutputComplexScalarData.xhtml#afc4cf635f16255debd5367c71e2eeebb)  
 const void \* [getData2](classsysc_1_1OutputComplexScalarData.xhtml#a7bb7e81085550fad868b9dc8927160e6) () const noexcept Get pointer to data2. [More...](classsysc_1_1OutputComplexScalarData.xhtml#a7bb7e81085550fad868b9dc8927160e6)  
 <a id="details" name="details"></a>## Detailed Description

Provide a class for output complex scalar data.

Output scalar data provides read-only access to an array of complex scalars.

Definition at line [24](OutputComplexScalarData_8hpp_source.xhtml#l00024) of file [OutputComplexScalarData.hpp](OutputComplexScalarData_8hpp_source.xhtml).



## Constructor &amp; Destructor Documentation

<a id="adf91ed9369ea790ff25efc8138429b3d"></a>## [◆ ](#adf91ed9369ea790ff25efc8138429b3d)OutputComplexScalarData() \[1/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const std::vector&lt; std::complex&lt; double &gt;&gt; &amp;  *dataComplex*) 

Provide a constructor for output complex scalar data with compact storage for complex components.

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



<a id="addb41ddd037b27dd19e6654294f7c194"></a>## [◆ ](#addb41ddd037b27dd19e6654294f7c194)OutputComplexScalarData() \[2/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const std::complex&lt; double &gt; \*  *dataComplex*,    std::size\_t  *size*   ) 

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters dataComplex- pointer to an array of complex double-precision scalarssize- number of scalars 



<a id="aef2fe0ae45472d732a8fa1b6c3bf83a2"></a>## [◆ ](#aef2fe0ae45472d732a8fa1b6c3bf83a2)OutputComplexScalarData() \[3/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const double \*  *dataComplex*,    std::size\_t  *size*   ) 

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters dataComplex- pointer to an array of complex double-precision scalarssize- number of scalars 



<a id="a883a5a886f1ec85c866f73d93bb170bf"></a>## [◆ ](#a883a5a886f1ec85c866f73d93bb170bf)OutputComplexScalarData() \[4/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const std::vector&lt; double &gt; &amp;  *dataReal*,    const std::vector&lt; double &gt; &amp;  *dataImaginary*   ) 

Create an output complex scalar data access object with split storage for compex components.

Parameters dataReal- reference to an STL vector of double-precision data, that stores the real components of the complex scalars.dataImaginary- reference to an STL vector of double-precision data, that stores the imaginary components of the complex scalars. 



<a id="a76a7cea2727d9cfad5419c65265e507e"></a>## [◆ ](#a76a7cea2727d9cfad5419c65265e507e)OutputComplexScalarData() \[5/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const double \*  *dataReal*,    const double \*  *dataImaginary*,    std::size\_t  *size*   ) 

Create an output complex scalar data access object with split storage for compex components.

Parameters dataReal- pointer to an array of double-precision data, that stores the real components of the complex scalars.dataImaginary- pointer to an array of double-precision data, that stores the imaginary components of the complex scalars.size- number of complex scalars 



<a id="a1da27e8572b96fb4687735b8a32a3aa6"></a>## [◆ ](#a1da27e8572b96fb4687735b8a32a3aa6)OutputComplexScalarData() \[6/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const std::vector&lt; std::complex&lt; float &gt;&gt; &amp;  *dataComplex*) 

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters dataComplex- reference to the STL vector of complex single-precision data 



<a id="a723362aff534d9a651bb9ce11cd82f7a"></a>## [◆ ](#a723362aff534d9a651bb9ce11cd82f7a)OutputComplexScalarData() \[7/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const std::complex&lt; float &gt; \*  *dataComplex*,    std::size\_t  *size*   ) 

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters dataComplex- pointer to an array of complex single-precision scalarssize- number of scalars 



<a id="a684da76ee59e2dcae970dfc34e89f9aa"></a>## [◆ ](#a684da76ee59e2dcae970dfc34e89f9aa)OutputComplexScalarData() \[8/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const float \*  *dataComplex*,    std::size\_t  *size*   ) 

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters dataComplex- pointer to an array of complex single-precision scalarssize- number of scalars 



<a id="a509c85873eece0980798e7d0263b1552"></a>## [◆ ](#a509c85873eece0980798e7d0263b1552)OutputComplexScalarData() \[9/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const std::vector&lt; float &gt; &amp;  *dataReal*,    const std::vector&lt; float &gt; &amp;  *dataImaginary*   ) 

Create an output complex scalar data access object with split storage for compex components.

Parameters dataReal- reference to an STL vector of single-precision data, that stores the real components of the complex scalars.dataImaginary- reference to an STL vector of single-precision data, that stores the imaginary components of the complex scalars. 



<a id="acc8f1a93aaf429db11baf9043ea34bf9"></a>## [◆ ](#acc8f1a93aaf429db11baf9043ea34bf9)OutputComplexScalarData() \[10/10\]

 sysc::OutputComplexScalarData::OutputComplexScalarData  ( const float \*  *dataReal*,    const float \*  *dataImaginary*,    std::size\_t  *size*   ) 

Create an output complex scalar data access object with split storage for compex components.

Parameters dataReal- pointer to an array of single-precision data, that stores the real components of the complex scalars.dataImaginary- pointer to an array of single-precision data, that stores the imaginary components of the complex scalars.size- number of complex scalars 



## Member Function Documentation

<a id="afc4cf635f16255debd5367c71e2eeebb"></a>## [◆ ](#afc4cf635f16255debd5367c71e2eeebb)getData1()

 const void\* sysc::OutputComplexScalarData::getData1  ( )  const  noexcept 

Get pointer to data1.

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





<a id="a7bb7e81085550fad868b9dc8927160e6"></a>## [◆ ](#a7bb7e81085550fad868b9dc8927160e6)getData2()

 const void\* sysc::OutputComplexScalarData::getData2  ( )  const  noexcept 

Get pointer to data2.

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

References [sysc::Double](CommonTypes_8hpp_source.xhtml#l00222).





<a id="aa9fde7656420e140ec4b575dc27e3ed1"></a>## [◆ ](#aa9fde7656420e140ec4b575dc27e3ed1)getDataType()

 [sysc::PrimitiveType](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844) sysc::OutputComplexScalarData::getDataType  ( )  const  noexcept 

Get the primitive type of data.

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





<a id="a2d9a5cce0e6fcb99344276db9b0d1030"></a>## [◆ ](#a2d9a5cce0e6fcb99344276db9b0d1030)isSplitComplex()

 bool sysc::OutputComplexScalarData::isSplitComplex  ( )  const  noexcept 

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

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