Concurrency::graphics::norm Class Reference

Represent a norm number. Each element is a floating point number in the range of [-1.0f, 1.0f]. More...

#include <amp_short_vectors.h>

Public Member Functions
	norm (void) __GPU
	Default constructor. Initialize to 0.0f. More...
	norm (float _V) __GPU
	Constructor. Initialize by clamping _V to the range of [-1.0f, 1.0f]. More...
	norm (unsigned int _V) __GPU
	Constructor. Initialize by casting _V to float, then clamping to the range of [-1.0f, 1.0f]. More...
	norm (int _V) __GPU
	Constructor. Initialize by casting _V to float, then clamping to the range of [-1.0f, 1.0f]. More...
	norm (double _V) __GPU
	Constructor. Initialize by casting _V to float, then clamping to the range of [-1.0f, 1.0f]. More...
	norm (const norm &_Other) __GPU
	Copy constructor. More...
	norm (const unorm &_Other) __GPU
	Constructor. More...
norm &	operator= (const norm &_Other) __GPU
	operator float (void) const __GPU
	Conversion operator. Convert the norm number to a floating point value. More...
norm &	operator+= (const norm &_Other) __GPU
norm &	operator-= (const norm &_Other) __GPU
norm &	operator*= (const norm &_Other) __GPU
norm &	operator/= (const norm &_Other) __GPU
norm &	operator++ () __GPU
norm	operator++ (int) __GPU
norm &	operator-- () __GPU
norm	operator-- (int) __GPU
norm	operator- (void) const __GPU

Private Member Functions
void	_Set (float _Val) __CPU_ONLY
void	_Set (float _Val) __GPU_ONLY

Private Attributes
float	_Value

Friends
class	unorm

Detailed Description

Represent a norm number. Each element is a floating point number in the range of [-1.0f, 1.0f].

Constructor & Destructor Documentation

Concurrency::graphics::norm::norm ( void  )

inline

Default constructor. Initialize to 0.0f.

            {
                _Value = 0.0f;
            }

Concurrency::graphics::norm::norm ( float  _V )

inlineexplicit

Constructor. Initialize by clamping _V to the range of [-1.0f, 1.0f].

Parameters

_V	The value used to initialize.

            {
                _Set(_V);
            }

Concurrency::graphics::norm::norm ( unsigned int  _V )

inlineexplicit

Constructor. Initialize by casting _V to float, then clamping to the range of [-1.0f, 1.0f].

Parameters

_V	The value used to initialize.

            {
                _Set(static_cast<float>(_V));
            }

Concurrency::graphics::norm::norm ( int  _V )

inlineexplicit

Constructor. Initialize by casting _V to float, then clamping to the range of [-1.0f, 1.0f].

Parameters

_V	The value used to initialize.

            {
                _Set(static_cast<float>(_V));
            }

Concurrency::graphics::norm::norm ( double  _V )

inlineexplicit

Constructor. Initialize by casting _V to float, then clamping to the range of [-1.0f, 1.0f].

Parameters

_V	The value used to initialize.

            {
                _Set(static_cast<float>(_V));
            }

Concurrency::graphics::norm::norm ( const norm &  _Other )

inline

Copy constructor.

Parameters

_Other

The object to copy from.

            {
                _Value = _Other._Value;
            }

Concurrency::graphics::norm::norm ( const unorm &  _Other )

inline

Constructor.

Parameters

_Other

The object used to initialize.

            {
                _Value = _Other._Value;
            }

Member Function Documentation

void Concurrency::graphics::norm::_Set ( float  _Val )

inlineprivate

            {
                _Val = _Val < -1.0f ? -1.0f : _Val;
                _Val = _Val > 1.0f ? 1.0f : _Val;
                _Value = _Val;
            }

void Concurrency::graphics::norm::_Set ( float  _Val )

inlineprivate

            {
                _Value = Concurrency::direct3d::clamp(_Val, -1.0f, 1.0f);
            }

Concurrency::graphics::norm::operator float ( void  ) const

inline

Conversion operator. Convert the norm number to a floating point value.

            {
                return _Value;
            }

norm& Concurrency::graphics::norm::operator*= ( const norm &  _Other )

inline

            {
                float _Res = _Value;
                _Res *= _Other._Value;
                _Set(_Res);
                return *this;
            }

norm& Concurrency::graphics::norm::operator++ ( )

inline

            {
                float _Res = _Value;
                ++_Res;
                _Set(_Res);
                return *this;
            }

norm Concurrency::graphics::norm::operator++ ( int  )

inline

            {
                norm _Res = *this;
                ++(*this);
                return _Res;
            }

norm& Concurrency::graphics::norm::operator+= ( const norm &  _Other )

inline

            {
                float _Res = _Value;
                _Res += _Other._Value;
                _Set(_Res);
                return *this;
            }

norm Concurrency::graphics::norm::operator- ( void  ) const

inline

            {
                norm _Ret;
                _Ret._Value = -_Value;
                return _Ret;
            }

norm& Concurrency::graphics::norm::operator-- ( )

inline

            {
                float _Res = _Value;
                --_Res;
                _Set(_Res);
                return *this;
            }

norm Concurrency::graphics::norm::operator-- ( int  )

inline

            {
                norm _Res = *this;
                --(*this);
                return _Res;
            }

norm& Concurrency::graphics::norm::operator-= ( const norm &  _Other )

inline

            {
                float _Res = _Value;
                _Res -= _Other._Value;
                _Set(_Res);
                return *this;
            }

norm& Concurrency::graphics::norm::operator/= ( const norm &  _Other )

inline

            {
                float _Res = _Value;
                _Res /= _Other._Value;
                _Set(_Res);
                return *this;
            }

norm& Concurrency::graphics::norm::operator= ( const norm &  _Other )

inline

            {
                _Value = _Other._Value;
                return *this;
            }

Friends And Related Function Documentation

friend class unorm

friend

Member Data Documentation

float Concurrency::graphics::norm::_Value

private

---

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

• VS2015/inc/amp_short_vectors.h