helios::uint2 Struct Reference

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

#include <helios_vector_types.h>

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

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

Detailed Description

Vector of two elements of type 'unsigned int'.

Definition at line 352 of file helios_vector_types.h.

Constructor & Destructor Documentation

uint2() [1/4]

constexpr helios::uint2::uint2 ( )

inlineconstexpr

Default constructor.

Definition at line 362 of file helios_vector_types.h.

uint2() [2/4]

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

inlineexplicit

Construct uint2 from a vector of unsigned ints.

Definition at line 366 of file helios_vector_types.h.

uint2() [3/4]

constexpr helios::uint2::uint2 ( const unsigned int  v[2] )

inlineexplicitconstexpr

Construct uint2 from an array of unsigned ints.

Definition at line 374 of file helios_vector_types.h.

uint2() [4/4]

constexpr helios::uint2::uint2 ( unsigned int  v0, unsigned int  v1  )

inlineconstexpr

Construct uint2 from two unsigned ints.

Definition at line 378 of file helios_vector_types.h.

Member Function Documentation

operator!=()

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

constexprnoexcept

Inequality for all elements.

Definition at line 446 of file helios_vector_types.h.

operator+()

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

constexprnoexcept

Add two uint2 vectors.

Definition at line 422 of file helios_vector_types.h.

operator+=()

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

inlinenoexcept

Increment uint2 vector.

Definition at line 426 of file helios_vector_types.h.

operator-() [1/2]

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

constexprnoexcept

Multiply each element by zero minus itself (wraps)

Definition at line 450 of file helios_vector_types.h.

operator-() [2/2]

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

constexprnoexcept

Subtract two uint2 vectors.

Definition at line 438 of file helios_vector_types.h.

operator-=()

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

inlinenoexcept

Decrement uint2 vector.

Definition at line 432 of file helios_vector_types.h.

operator==()

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

constexprnoexcept

Equality for all elements.

Definition at line 442 of file helios_vector_types.h.

Friends And Related Symbol Documentation

operator<<

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

friend

Write uint2 to output stream.

Definition at line 398 of file helios_vector_types.h.

Field Documentation

x

unsigned int helios::uint2::x

First element in vector.

Definition at line 356 of file helios_vector_types.h.

y

unsigned int helios::uint2::y

Second element in vector.

Definition at line 358 of file helios_vector_types.h.

---

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

• core/include/helios_vector_types.h