helios::uint4 Struct Reference

Vector of four elements of type 'unsigned int'. More...

#include <helios_vector_types.h>

Public Member Functions
constexpr	uint4 ()
	Default constructor.
	uint4 (const std::vector< unsigned int > &v)
	Construct uint4 from a vector of unsigned ints.
constexpr	uint4 (const unsigned int v[4])
	Construct uint4 from an array of unsigned ints.
constexpr	uint4 (unsigned int v0, unsigned int v1, unsigned int v2, unsigned int v3)
	Construct uint4 from four unsigned ints.
constexpr uint4	operator+ (const uint4 &a) const noexcept
	Add two uint4 vectors.
uint4 &	operator+= (const uint4 &a) noexcept
	Increment uint4 vector.
uint4 &	operator-= (const uint4 &a) noexcept
	Decrement uint4 vector.
constexpr uint4	operator- (const uint4 &a) const noexcept
	Subtract two uint4 vectors.
constexpr bool	operator== (const uint4 &a) const noexcept
	Equality for all elements.
constexpr bool	operator!= (const uint4 &a) const noexcept
	Inequality for all elements.
constexpr uint4	operator- () const noexcept
	Multiply each element by zero minus itself (wraps)

Data Fields
unsigned int	x
	First element in vector.
unsigned int	y
	Second element in vector.
unsigned int	z
	Third element in vector.
unsigned int	w
	Fourth element in vector.

Friends
std::ostream &	operator<< (std::ostream &os, const helios::uint4 &vec)
	Write uint4 to output stream.

Detailed Description

Vector of four elements of type 'unsigned int'.

Definition at line 573 of file helios_vector_types.h.

Constructor & Destructor Documentation

uint4() [1/4]

constexpr helios::uint4::uint4 ( )

inlineconstexpr

Default constructor.

initializes to zero

Definition at line 588 of file helios_vector_types.h.

uint4() [2/4]

helios::uint4::uint4 ( const std::vector< unsigned int > &  v )

inlineexplicit

Construct uint4 from a vector of unsigned ints.

Definition at line 592 of file helios_vector_types.h.

uint4() [3/4]

constexpr helios::uint4::uint4 ( const unsigned int  v[4] )

inlineexplicitconstexpr

Construct uint4 from an array of unsigned ints.

Definition at line 603 of file helios_vector_types.h.

uint4() [4/4]

constexpr helios::uint4::uint4 ( unsigned int  v0, unsigned int  v1, unsigned int  v2, unsigned int  v3  )

inlineconstexpr

Construct uint4 from four unsigned ints.

Definition at line 607 of file helios_vector_types.h.

Member Function Documentation

operator!=()

constexpr bool helios::uint4::operator!= ( const uint4 &  a ) const

constexprnoexcept

Inequality for all elements.

Definition at line 680 of file helios_vector_types.h.

operator+()

constexpr uint4 helios::uint4::operator+ ( const uint4 &  a ) const

constexprnoexcept

Add two uint4 vectors.

Definition at line 652 of file helios_vector_types.h.

operator+=()

uint4 & helios::uint4::operator+= ( const uint4 &  a )

inlinenoexcept

Increment uint4 vector.

Definition at line 656 of file helios_vector_types.h.

operator-() [1/2]

constexpr uint4 helios::uint4::operator- ( ) const

constexprnoexcept

Multiply each element by zero minus itself (wraps)

Definition at line 684 of file helios_vector_types.h.

operator-() [2/2]

constexpr uint4 helios::uint4::operator- ( const uint4 &  a ) const

constexprnoexcept

Subtract two uint4 vectors.

Definition at line 672 of file helios_vector_types.h.

operator-=()

uint4 & helios::uint4::operator-= ( const uint4 &  a )

inlinenoexcept

Decrement uint4 vector.

Definition at line 664 of file helios_vector_types.h.

operator==()

constexpr bool helios::uint4::operator== ( const uint4 &  a ) const

constexprnoexcept

Equality for all elements.

Definition at line 676 of file helios_vector_types.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const helios::uint4 &  vec  )

friend

Write uint4 to output stream.

Definition at line 626 of file helios_vector_types.h.

Field Documentation

w

unsigned int helios::uint4::w

Fourth element in vector.

Definition at line 582 of file helios_vector_types.h.

x

unsigned int helios::uint4::x

First element in vector.

Definition at line 576 of file helios_vector_types.h.

y

unsigned int helios::uint4::y

Second element in vector.

Definition at line 578 of file helios_vector_types.h.

z

unsigned int helios::uint4::z

Third element in vector.

Definition at line 580 of file helios_vector_types.h.

---

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

• core/include/helios_vector_types.h