FftwReal2dDftData< F > Class Template Reference

#include <FftwReal2dDftData.h>

Inheritance diagram for FftwReal2dDftData< F >:

Public Types
using	IndexArrayVector = std::vector< IndexArray >
using	ComplexVector = std::vector< Complex >
Public Types inherited from Real2dDftData< F >
using	Float = F
using	Index = unsigned int
using	IndexArray = std::array< Index, 2 >
using	Norm = RealDftNormalization
using	Complex = std::complex< Float >

Public Member Functions
	FftwReal2dDftData (Norm norm, const IndexArray &nsams)
Norm	normalization () const override
Index	rank () const
void	clear () override
void	reset (const IndexArray &nsams) override
const IndexArray &	nSamples () const override
Index	size () const
Index	nSamples (Index idim) const
Index	size (Index idim) const
Complex *	data ()
const Complex *	data () const
Float *	floatData ()
const Float *	floatData () const
Index	globalIndex (const IndexArray &ifrqs) const
IndexArrayVector	indexArrays (Index idat) const
Complex	value (Index idat) const
Complex	value (const IndexArray &isams) const override
int	moveIn (const IndexArray nsams, ComplexVector &data)
int	copyIn (const IndexArray nsams, const ComplexVector &data)
int	moveOut (ComplexVector &data)
int	copyOut (ComplexVector &data) const
Public Member Functions inherited from Real2dDftData< F >
virtual	~Real2dDftData ()=default
Index	rank () const
virtual Index	nSample (Index idim) const
Index	size (Index idim) const
bool	inRange (Index idim, Index ifrq) const
bool	isZero (Index ifrq) const
bool	isNyquist (Index idim, Index ifrq) const
virtual bool	isValid () const
Complex	badValue () const
virtual F	power (const IndexArray &ifrqs) const
virtual F	amplitude (const IndexArray &ifrqs) const
virtual F	phase (const IndexArray &ifrqs) const
virtual F	real (const IndexArray &ifrqs) const
virtual F	imag (const IndexArray &ifrqs) const
F	power () const

Static Public Member Functions
template<std::size_t N>
static Index	dftComplexDataSize (const std::array< Index, N > &nsams)
template<std::size_t N>
static Index	dftFloatDataSize (const std::array< Index, N > &nsams)
Static Public Member Functions inherited from Real2dDftData< F >
template<std::size_t N>
static Index	dataSize (const std::array< Index, N > &nsams)

Private Attributes
Norm	m_norm
IndexArray	m_nsams
ComplexVector	m_data

Detailed Description

template<typename F>
class FftwReal2dDftData< F >

Definition at line 23 of file FftwReal2dDftData.h.

Member Typedef Documentation

template<typename F >

using FftwReal2dDftData< F >::ComplexVector = std::vector<Complex>

Definition at line 39 of file FftwReal2dDftData.h.

template<typename F >

using FftwReal2dDftData< F >::IndexArrayVector = std::vector<IndexArray>

Definition at line 36 of file FftwReal2dDftData.h.

Constructor & Destructor Documentation

template<typename F >

FftwReal2dDftData< F >::FftwReal2dDftData ( Norm  norm, const IndexArray &  nsams  )

inline

Definition at line 64 of file FftwReal2dDftData.h.

  : m_norm(norm) {
    reset(nsams);
  }

Member Function Documentation

template<typename F >

void FftwReal2dDftData< F >::clear ( )

inlineoverridevirtual

Implements Real2dDftData< F >.

Definition at line 76 of file FftwReal2dDftData.h.

                        {
    for ( Index& nsam : m_nsams ) nsam = 0;
    m_data.clear();
  }

template<typename F >

int FftwReal2dDftData< F >::copyIn ( const IndexArray  nsams, const ComplexVector &  data  )

inline

Definition at line 172 of file FftwReal2dDftData.h.

                                                                {
    m_nsams = nsams;
    m_data = data;
    return 0;
  }

template<typename F >

int FftwReal2dDftData< F >::copyOut ( ComplexVector &  data ) const

inline

Definition at line 186 of file FftwReal2dDftData.h.

                                         {
    data = m_data;
    return 0;
  }

template<typename F >

Complex* FftwReal2dDftData< F >::data ( )

inline

Definition at line 101 of file FftwReal2dDftData.h.

{ return m_data.data(); }

template<typename F >

const Complex* FftwReal2dDftData< F >::data ( ) const

inline

Definition at line 102 of file FftwReal2dDftData.h.

{ return m_data.data(); }

template<typename F >

template<std::size_t N>

static Index FftwReal2dDftData< F >::dftComplexDataSize ( const std::array< Index, N > &  nsams )

inlinestatic

Definition at line 45 of file FftwReal2dDftData.h.

                                                                   {
    Index ndat = 1;
    Index ndim = nsams.size();
    for ( Index idim=0; idim<ndim; ++idim ) {
      Index nsam = nsams[idim];
      Index fac = idim == ndim - 1 ? nsam/2 + 1 : nsam;
      ndat *= fac;
    }
    return ndat;
  }

template<typename F >

template<std::size_t N>

static Index FftwReal2dDftData< F >::dftFloatDataSize ( const std::array< Index, N > &  nsams )

inlinestatic

Definition at line 59 of file FftwReal2dDftData.h.

                                                                 {
    return 2*dftComplexDataSize(nsams);
  }

template<typename F >

Float* FftwReal2dDftData< F >::floatData ( )

inline

Definition at line 105 of file FftwReal2dDftData.h.

{ return reinterpret_cast<Float*>(m_data.data()); }

template<typename F >

const Float* FftwReal2dDftData< F >::floatData ( ) const

inline

Definition at line 106 of file FftwReal2dDftData.h.

{ return reinterpret_cast<const Float*>(m_data.data()); }

template<typename F >

Index FftwReal2dDftData< F >::globalIndex ( const IndexArray &  ifrqs ) const

inline

Definition at line 110 of file FftwReal2dDftData.h.

                                                   {
    Index ifrq0 = ifrqs[0];
    Index ifrq1 = ifrqs[1];
    Index nfrq0 = m_nsams[0];
    Index nfrq1 = m_nsams[1];
    Index n1 = nfrq1/2 + 1;
    if ( ifrq0 >= nfrq0 ) {
      return size();
    }
    if ( ifrq1 >= nfrq1 ) {
      return size();
    }
    if ( ifrq1 >= n1 ) {
      if ( ifrq0 > 0 ) ifrq0 = nfrq0 - ifrq0;
      ifrq1 = nfrq1 - ifrq1;
    }
    return n1*ifrq0 + ifrq1;
  }

template<typename F >

IndexArrayVector FftwReal2dDftData< F >::indexArrays ( Index  idat ) const

inline

Definition at line 132 of file FftwReal2dDftData.h.

                                                  {
    IndexArrayVector arrs;
    Index nfrq0 = m_nsams[0];
    Index nfrq1 = m_nsams[1];
    Index n1 = nfrq1/2 + 1;
    Index ifrq0 = idat/n1;
    if ( ifrq0 >= nfrq0 ) return arrs;
    Index ifrq1 = idat%n1;
    arrs.push_back(IndexArray({ifrq0, ifrq1}));
    Index jfrq0 = ifrq0 > 0 ? nfrq0 - ifrq0 : 0;
    if ( ifrq1 == 0 ) return arrs;
    Index jfrq1 = nfrq1 - ifrq1;
    if ( jfrq1 == ifrq1 ) return arrs;
    arrs.push_back(IndexArray({jfrq0, jfrq1}));
    return arrs;
  }

template<typename F >

int FftwReal2dDftData< F >::moveIn ( const IndexArray  nsams, ComplexVector &  data  )

inline

Definition at line 165 of file FftwReal2dDftData.h.

                                                          {
    m_nsams = nsams;
    m_data = std::move(data);
    return 0;
  }

template<typename F >

int FftwReal2dDftData< F >::moveOut ( ComplexVector &  data )

inline

Definition at line 179 of file FftwReal2dDftData.h.

                                   {
    data = m_data;
    clear();
    return 0;
  }

template<typename F >

Norm FftwReal2dDftData< F >::normalization ( ) const

inlineoverridevirtual

Implements Real2dDftData< F >.

Definition at line 70 of file FftwReal2dDftData.h.

{ return m_norm; }

template<typename F >

const IndexArray& FftwReal2dDftData< F >::nSamples ( ) const

inlineoverridevirtual

Implements Real2dDftData< F >.

Definition at line 90 of file FftwReal2dDftData.h.

                                              {
    return m_nsams;
  }

template<typename F >

Index FftwReal2dDftData< F >::nSamples ( Index  idim ) const

inline

Definition at line 94 of file FftwReal2dDftData.h.

                                   {
    if ( idim > rank() ) return 0;
    return nSamples()[idim];
  }

template<typename F >

Index FftwReal2dDftData< F >::rank ( ) const

inline

Definition at line 73 of file FftwReal2dDftData.h.

{ return 2; }

template<typename F >

void FftwReal2dDftData< F >::reset ( const IndexArray &  nsams )

inlineoverridevirtual

Implements Real2dDftData< F >.

Definition at line 82 of file FftwReal2dDftData.h.

                                               {
    clear();
    m_nsams = nsams;
    Index ndat = dftComplexDataSize(nsams);
    m_data.resize(ndat, 0.0);
  }

template<typename F >

Index FftwReal2dDftData< F >::size ( ) const

inline

Definition at line 93 of file FftwReal2dDftData.h.

{ return m_data.size(); }

template<typename F >

Index FftwReal2dDftData< F >::size ( Index  idim ) const

inline

Definition at line 98 of file FftwReal2dDftData.h.

{ return nSamples(idim); }

template<typename F >

Complex FftwReal2dDftData< F >::value ( Index  idat ) const

inline

Definition at line 150 of file FftwReal2dDftData.h.

                                  {
    if ( idat >= size() ) return this->badValue();
    return m_data[idat];
  }

template<typename F >

Complex FftwReal2dDftData< F >::value ( const IndexArray &  isams ) const

inlineoverridevirtual

Implements Real2dDftData< F >.

Definition at line 159 of file FftwReal2dDftData.h.

                                                        {
    Index idat = globalIndex(isams);
    return value(idat);
  }

Member Data Documentation

template<typename F >

ComplexVector FftwReal2dDftData< F >::m_data

private

Definition at line 196 of file FftwReal2dDftData.h.

template<typename F >

Norm FftwReal2dDftData< F >::m_norm

private

Definition at line 194 of file FftwReal2dDftData.h.

template<typename F >

IndexArray FftwReal2dDftData< F >::m_nsams

private

Definition at line 195 of file FftwReal2dDftData.h.

---

The documentation for this class was generated from the following file:

• dunecore/dunecore/DuneInterface/Data/FftwReal2dDftData.h