A transparent type storing the local sizes, strides, and storage when the data is long in a particular direction n0, n1, or n2. More...

Detailed Description

A transparent type storing the local sizes, strides, and storage when the data is long in a particular direction n0, n1, or n2.

The global data stored locally in direction i in {0,1,2,3,4} is [start[i],start[i] + size[i]) where the lower index is inclusive and the upper index exclusive. If both indices are the same then no data is stored locally in the given direction.

Indices {0,1,2} correspond to information about directions n{0,1,2}, respectively. Index 3 gives information regarding the interleaved data fields whose number is determined by the howmany parameter to underling_problem_create. Index 4 gives information about the scalar components that comprise index 3. It always has size two for a complex-valued field and size one for a real-valued field.

Public Attributes
int	start [5]
	The inclusive global data starting offset in directions `n{0,1,2}`. More...

int	size [5]
	The amount of global data stored locally in directions `n{0,1,2}`. More...

int	stride [5]
	The stride between adjacent elements in directions `n{0,1,2}`. More...

int	order [5]
	The storage order from the fastest index to the slowest. More...

Member Data Documentation

◆ order

int underling_fftw_extents::order[5]

The storage order from the fastest index to the slowest.

That is, order[0] gives the index in {0,1,2,3,4} of the fastest direction, order[1] gives the index of the next fastest direction, etc. Useful in generic algorithms which are independent of which direction is long but in which you need to walk memory optimally.

◆ size

int underling_fftw_extents::size[5]

The amount of global data stored locally in directions n{0,1,2}.

Index 3 gives information on the interleaved data fields and is always equal to the howmany/2 parameter provided to underling_problem_create. Index 4 is 2 for a complex-valued field and 1 for a real-valued field.

◆ start

int underling_fftw_extents::start[5]

The inclusive global data starting offset in directions n{0,1,2}.

Indices 3 and 4 give information on the interleaved data fields and are always equal to zero.

◆ stride

int underling_fftw_extents::stride[5]

The stride between adjacent elements in directions n{0,1,2}.

Indices 3 and 4 give information on the interleaved data fields.

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