helios::uint3 Struct Reference

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

#include <helios_vector_types.h>

Public Member Functions
constexpr	uint3 ()
	Default constructor.
	uint3 (const std::vector< unsigned int > &v)
	Construct uint3 from a vector of unsigned ints.
constexpr	uint3 (const unsigned int v[3])
	Construct uint3 from an array of unsigned ints.
constexpr	uint3 (unsigned int v0, unsigned int v1, unsigned int v2)
	Construct uint3 from three unsigned ints.
constexpr uint3	operator+ (const uint3 &a) const noexcept
	Add two uint3 vectors.
uint3 &	operator+= (const uint3 &a) noexcept
	Increment uint3 vector.
uint3 &	operator-= (const uint3 &a) noexcept
	Decrement uint3 vector.
constexpr uint3	operator- (const uint3 &a) const noexcept
	Subtract two uint3 vectors.
constexpr bool	operator== (const uint3 &a) const noexcept
	Equality for all elements.
constexpr bool	operator!= (const uint3 &a) const noexcept
	Inequality for all elements.
constexpr uint3	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.

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

Detailed Description

Vector of three elements of type 'unsigned int'.

Definition at line 459 of file helios_vector_types.h.

Constructor & Destructor Documentation

uint3() [1/4]

constexpr helios::uint3::uint3 ( )

inlineconstexpr

Default constructor.

initializes to zero

Definition at line 473 of file helios_vector_types.h.

uint3() [2/4]

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

inlineexplicit

Construct uint3 from a vector of unsigned ints.

Definition at line 477 of file helios_vector_types.h.

uint3() [3/4]

constexpr helios::uint3::uint3 ( const unsigned int  v[3] )

inlineexplicitconstexpr

Construct uint3 from an array of unsigned ints.

Definition at line 486 of file helios_vector_types.h.

uint3() [4/4]

constexpr helios::uint3::uint3 ( unsigned int  v0, unsigned int  v1, unsigned int  v2  )

inlineconstexpr

Construct uint3 from three unsigned ints.

Definition at line 490 of file helios_vector_types.h.

Member Function Documentation

operator!=()

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

constexprnoexcept

Inequality for all elements.

Definition at line 560 of file helios_vector_types.h.

operator+()

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

constexprnoexcept

Add two uint3 vectors.

Definition at line 534 of file helios_vector_types.h.

operator+=()

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

inlinenoexcept

Increment uint3 vector.

Definition at line 538 of file helios_vector_types.h.

operator-() [1/2]

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

constexprnoexcept

Multiply each element by zero minus itself (wraps)

Definition at line 564 of file helios_vector_types.h.

operator-() [2/2]

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

constexprnoexcept

Subtract two uint3 vectors.

Definition at line 552 of file helios_vector_types.h.

operator-=()

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

inlinenoexcept

Decrement uint3 vector.

Definition at line 545 of file helios_vector_types.h.

operator==()

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

constexprnoexcept

Equality for all elements.

Definition at line 556 of file helios_vector_types.h.

Friends And Related Symbol Documentation

operator<<

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

friend

Write uint3 to output stream.

Definition at line 509 of file helios_vector_types.h.

Field Documentation

x

unsigned int helios::uint3::x

First element in vector.

Definition at line 463 of file helios_vector_types.h.

y

unsigned int helios::uint3::y

Second element in vector.

Definition at line 465 of file helios_vector_types.h.

z

unsigned int helios::uint3::z

Third element in vector.

Definition at line 467 of file helios_vector_types.h.

---

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

• core/include/helios_vector_types.h