This class defines an two-dimensional IndexPoint, i.e. a pair of unsigned integers representing a value in a two-dimensional index space. More...

#include <Index.h>

Public Types
typedef std::pair< Index, Index >	indexPoint_type
	Actual type used to store the pair of unsigned integers representing the IndexPoint.

Public Member Functions
	IndexPoint ()
	Creates an IndexPoint with the values {0,0}.

	IndexPoint (const indexPoint_type &indexPoint)
	Creates an IndexPoint with the same values as the given IndexPoint. More...

	IndexPoint (const IndexPoint &rhs)=default
	Default copy constructor. More...

	IndexPoint (const Index &row, const Index &column)
	Creates an IndexPoint with the given values so that the IndexPoint {row,column} is created. More...

	IndexPoint (IndexPoint &&indexPoint)
	Move constructor. Creates an IndexPoint with the same values as the given IndexPoint. More...

IndexPoint &	operator= (IndexPoint &&rhs)
	Move assignment operator. Assign IndexPoint rhs to this. More...

IndexPoint &	operator= (const IndexPoint &rhs)
	Copy assignment operator. Assign rhs to this. More...

bool	operator== (const IndexPoint &rhs) const
	Equality operator. Two IndexPoint objects are equal if and only if the two underlying pairs of unsigned integer are equal. More...

bool	operator!= (const IndexPoint &rhs) const
	Inequality operator. Two IndexPoint objects are not equal if and only if the two underlying pairs of unsigned integer are not equal. More...

	operator indexPoint_type () const
	Conversion operator. The IndexPoint object is automatically converted in the underlying pair of unsigned integer representing this IndexPoint object. More...

indexPoint_type	get () const
	Explicit function to access the underlying pair of unsigned integer representing this IndexPoint object. More...

const Index &	rowID () const
	Function to access the first component of the underlying pair of unsigned integers representing this IndexPoint object. More...

const Index &	y () const
	Function to access the first component of the underlying pair of unsigned integers representing this IndexPoint object. More...

const Index &	columnID () const
	Function to access the second component of the underlying pair of unsigned integers representing this IndexPoint object. More...

const Index &	x () const
	Function to access the second component of the underlying pair of unsigned integers representing this IndexPoint object. More...

Detailed Description

This class defines an two-dimensional IndexPoint, i.e. a pair of unsigned integers representing a value in a two-dimensional index space.

Definition at line 128 of file Index.h.

Constructor & Destructor Documentation

skelcl::IndexPoint::IndexPoint ( const indexPoint_type & indexPoint )

Creates an IndexPoint with the same values as the given IndexPoint.

Parameters

indexPoint The IndexPoint from with the values are used to create the new IndexPoint.

Definition at line 79 of file Index.cpp.

skelcl::IndexPoint::IndexPoint ( const IndexPoint & rhs )

default

Default copy constructor.

Parameters

rhs	The IndexPoint to copy from.

skelcl::IndexPoint::IndexPoint	(	const Index &	row,
		const Index &	column
	)

Creates an IndexPoint with the given values so that the IndexPoint {row,column} is created.

Parameters

row	The value is used as first value of the pair.
column	The value is used as second value of the pair.

Definition at line 84 of file Index.cpp.

skelcl::IndexPoint::IndexPoint ( IndexPoint && indexPoint )

Move constructor. Creates an IndexPoint with the same values as the given IndexPoint.

Parameters

indexPoint The IndexPoint which values are used to create the new IndexPoint.

Definition at line 89 of file Index.cpp.

Member Function Documentation

const Index & skelcl::IndexPoint::columnID ( ) const

Function to access the second component of the underlying pair of unsigned integers representing this IndexPoint object.

Returns: The second component of the pair of unsigned integers representing this IndexPoint object.

Definition at line 133 of file Index.cpp.

IndexPoint::indexPoint_type skelcl::IndexPoint::get ( ) const

Explicit function to access the underlying pair of unsigned integer representing this IndexPoint object.

Returns: The pair of unsigned integer representing this IndexPoint object.

Definition at line 118 of file Index.cpp.

skelcl::IndexPoint::operator indexPoint_type ( ) const

Conversion operator. The IndexPoint object is automatically converted in the underlying pair of unsigned integer representing this IndexPoint object.

Returns: The pair of unsigned integer representing this IndexPoint object.

Definition at line 113 of file Index.cpp.

bool skelcl::IndexPoint::operator!= ( const IndexPoint & rhs ) const

Inequality operator. Two IndexPoint objects are not equal if and only if the two underlying pairs of unsigned integer are not equal.

Parameters

rhs	The IndexPoint to be compared with.

Returns: True if and only if the two underlying pairs of unsigned integers are not equal. False otherwise.

Definition at line 108 of file Index.cpp.

IndexPoint & skelcl::IndexPoint::operator= ( IndexPoint && rhs )

Move assignment operator. Assign IndexPoint rhs to this.

Parameters

rhs	The IndexPoint which values are assigned to this.

Definition at line 95 of file Index.cpp.

IndexPoint& skelcl::IndexPoint::operator= ( const IndexPoint & rhs )

Copy assignment operator. Assign rhs to this.

Parameters

rhs	The IndexPoint which values are assigned to this.

bool skelcl::IndexPoint::operator== ( const IndexPoint & rhs ) const

Equality operator. Two IndexPoint objects are equal if and only if the two underlying pairs of unsigned integer are equal.

Parameters

rhs	The IndexPoint to be compared with.

Returns: True if and only if the two underlying pairs of unsigned integers are equal (i.e. both components are equal). False otherwise.

Definition at line 103 of file Index.cpp.

const Index & skelcl::IndexPoint::rowID ( ) const

Function to access the first component of the underlying pair of unsigned integers representing this IndexPoint object.

Returns: The first component of the pair of unsigned integers representing this IndexPoint object.

Definition at line 123 of file Index.cpp.

const Index & skelcl::IndexPoint::x ( ) const

Function to access the second component of the underlying pair of unsigned integers representing this IndexPoint object.

Returns: The second component of the pair of unsigned integers representing this IndexPoint object.

Definition at line 138 of file Index.cpp.

const Index & skelcl::IndexPoint::y ( ) const

Function to access the first component of the underlying pair of unsigned integers representing this IndexPoint object.

Returns: The first component of the pair of unsigned integers representing this IndexPoint object.

Definition at line 128 of file Index.cpp.

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

include/SkelCL/Index.h
src/Index.cpp

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation