fieldorder_wrapper is an internal class that is used to wrap instances of FieldOrder accessors, currying in the specific location on the field. This is used as a helper class for fixed-point accessors providing the necessary conversion and scaling when writing to a fixed-point field. More...

#include <gauge_field_order.h>

Public Types
using	type = Float

using	store_type = storeFloat

Public Member Functions
__device__ __host__	fieldorder_wrapper (complex< storeFloat > *v, int idx, Float scale, Float scale_inv)
	fieldorder_wrapper constructor More...

__device__ __host__ Float	real () const

__device__ __host__ Float	imag () const

__device__ __host__ auto	data ()
	returns the pointor of this wrapper object More...

__device__ __host__ const auto	data () const

__device__ __host__ complex< Float >	operator- () const
	negation operator More...

__device__ __host__ void	operator= (const fieldorder_wrapper< Float, storeFloat > &a)
	Assignment operator with fieldorder_wrapper instance as input. More...

template<typename theirFloat >
__device__ __host__ void	operator= (const complex< theirFloat > &a)
	Assignment operator with complex number instance as input. More...

template<typename theirFloat >
__device__ __host__ void	operator+= (const complex< theirFloat > &a)
	Operator+= with complex number instance as input. More...

template<typename theirFloat >
__device__ __host__ void	operator-= (const complex< theirFloat > &a)
	Operator-= with complex number instance as input. More...

Public Attributes
complex< storeFloat > *	v

const int	idx

const Float	scale

const Float	scale_inv

Static Public Attributes
static constexpr bool	fixed = fixed_point<Float, storeFloat>()

Detailed Description

template<typename Float, typename storeFloat>
struct quda::gauge::fieldorder_wrapper< Float, storeFloat >

fieldorder_wrapper is an internal class that is used to wrap instances of FieldOrder accessors, currying in the specific location on the field. This is used as a helper class for fixed-point accessors providing the necessary conversion and scaling when writing to a fixed-point field.

Definition at line 235 of file gauge_field_order.h.

Member Typedef Documentation

◆ store_type

template<typename Float , typename storeFloat >

using quda::gauge::fieldorder_wrapper< Float, storeFloat >::store_type = storeFloat

Definition at line 241 of file gauge_field_order.h.

◆ type

template<typename Float , typename storeFloat >

using quda::gauge::fieldorder_wrapper< Float, storeFloat >::type = Float

Computing type and storage types that can be inferred from this object.

Definition at line 240 of file gauge_field_order.h.

Constructor & Destructor Documentation

◆ fieldorder_wrapper()

template<typename Float , typename storeFloat >

__device__ __host__ quda::gauge::fieldorder_wrapper< Float, storeFloat >::fieldorder_wrapper	(	complex< storeFloat > *	v,
		int	idx,
		Float	scale,
		Float	scale_inv
	)

inline

fieldorder_wrapper constructor

Parameters

idx	Field index

Definition at line 252 of file gauge_field_order.h.

Member Function Documentation

◆ data() [1/2]

template<typename Float , typename storeFloat >

__device__ __host__ auto quda::gauge::fieldorder_wrapper< Float, storeFloat >::data ( )

inline

returns the pointor of this wrapper object

Definition at line 281 of file gauge_field_order.h.

◆ data() [2/2]

template<typename Float , typename storeFloat >

__device__ __host__ const auto quda::gauge::fieldorder_wrapper< Float, storeFloat >::data ( ) const

inline

Definition at line 283 of file gauge_field_order.h.

◆ imag()

template<typename Float , typename storeFloat >

__device__ __host__ Float quda::gauge::fieldorder_wrapper< Float, storeFloat >::imag ( ) const

inline

Definition at line 269 of file gauge_field_order.h.

◆ operator+=()

template<typename Float , typename storeFloat >

template<typename theirFloat >

__device__ __host__ void quda::gauge::fieldorder_wrapper< Float, storeFloat >::operator+= ( const complex< theirFloat > & a )

inline

Operator+= with complex number instance as input.

Parameters

a	Complex number we want to add to this accessor

Definition at line 320 of file gauge_field_order.h.

◆ operator-()

template<typename Float , typename storeFloat >

__device__ __host__ complex<Float> quda::gauge::fieldorder_wrapper< Float, storeFloat >::operator- ( ) const

inline

negation operator

Returns: negation of this complex number

Definition at line 289 of file gauge_field_order.h.

◆ operator-=()

template<typename Float , typename storeFloat >

template<typename theirFloat >

__device__ __host__ void quda::gauge::fieldorder_wrapper< Float, storeFloat >::operator-= ( const complex< theirFloat > & a )

inline

Operator-= with complex number instance as input.

Parameters

a	Complex number we want to subtract from this accessor

Definition at line 333 of file gauge_field_order.h.

◆ operator=() [1/2]

template<typename Float , typename storeFloat >

template<typename theirFloat >

__device__ __host__ void quda::gauge::fieldorder_wrapper< Float, storeFloat >::operator= ( const complex< theirFloat > & a )

inline

Assignment operator with complex number instance as input.

Parameters

a	Complex number we want to store in this accessor

Definition at line 307 of file gauge_field_order.h.

◆ operator=() [2/2]

template<typename Float , typename storeFloat >

__device__ __host__ void quda::gauge::fieldorder_wrapper< Float, storeFloat >::operator= ( const fieldorder_wrapper< Float, storeFloat > & a )

inline

Assignment operator with fieldorder_wrapper instance as input.

Parameters

a	fieldorder_wrapper we are copying from

Definition at line 298 of file gauge_field_order.h.

◆ real()

template<typename Float , typename storeFloat >

__device__ __host__ Float quda::gauge::fieldorder_wrapper< Float, storeFloat >::real ( ) const

inline

Definition at line 260 of file gauge_field_order.h.

Member Data Documentation

◆ fixed

template<typename Float , typename storeFloat >

constexpr bool quda::gauge::fieldorder_wrapper< Float, storeFloat >::fixed = fixed_point<Float, storeFloat>()

staticconstexpr

Definition at line 246 of file gauge_field_order.h.

◆ idx

template<typename Float , typename storeFloat >

const int quda::gauge::fieldorder_wrapper< Float, storeFloat >::idx

Definition at line 243 of file gauge_field_order.h.

◆ scale

template<typename Float , typename storeFloat >

const Float quda::gauge::fieldorder_wrapper< Float, storeFloat >::scale

Definition at line 244 of file gauge_field_order.h.

◆ scale_inv

template<typename Float , typename storeFloat >

const Float quda::gauge::fieldorder_wrapper< Float, storeFloat >::scale_inv

Definition at line 245 of file gauge_field_order.h.

◆ v

template<typename Float , typename storeFloat >

complex<storeFloat>* quda::gauge::fieldorder_wrapper< Float, storeFloat >::v

Definition at line 242 of file gauge_field_order.h.

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

quda/include/complex_quda.h
quda/include/gauge_field_order.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

template<typename Float, typename storeFloat> struct quda::gauge::fieldorder_wrapper< Float, storeFloat >

Member Typedef Documentation

◆ store_type

◆ type

Constructor & Destructor Documentation

◆ fieldorder_wrapper()

Member Function Documentation

◆ data() [1/2]

◆ data() [2/2]

◆ imag()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ real()

Member Data Documentation

◆ fixed

◆ idx

◆ scale

◆ scale_inv

◆ v

template<typename Float, typename storeFloat>
struct quda::gauge::fieldorder_wrapper< Float, storeFloat >