ColumnPosition Class Reference

#include <Keccak-fPositions.h>

Inheritance diagram for ColumnPosition:

List of all members.

Public Member Functions
	ColumnPosition ()
	ColumnPosition (unsigned int ax, unsigned int az)
	ColumnPosition (const BitPosition &ap)
unsigned int	getXplus5Z () const
Public Attributes
unsigned int	x
unsigned int	z
Friends
bool	operator< (const ColumnPosition &aCP, const ColumnPosition &bCP)
ostream &	operator<< (ostream &fout, const ColumnPosition &aCP)

---

Detailed Description

Class containing the x, z coordinates of a column.

---

Constructor & Destructor Documentation

ColumnPosition::ColumnPosition

(

)

[inline]

The default constructor.

ColumnPosition::ColumnPosition	(	unsigned int	ax,
		unsigned int	az
	)		[inline]

The constructor.

Parameters:

ax	The x-coordinate.
az	The z-coordinate.

ColumnPosition::ColumnPosition

(

const BitPosition &

ap

)

[inline]

A constructor taking a bit position.

Parameters:

ap	The bit position.

---

Member Function Documentation

unsigned int ColumnPosition::getXplus5Z

(

)

const [inline]

This function returns an integer between 0 and 5*laneSize.

Returns:

x + 5*z

---

Friends And Related Function Documentation

bool operator<	(	const ColumnPosition &	aCP,
		const ColumnPosition &	bCP
	)		[friend]

An ordering operator, required when storing a ColumnPosition object in a set or as the first member in maps.

Parameters:

a	The column position at the left of the operator.
az	The column position at the right of the operator.

ostream& operator<<	(	ostream &	fout,
		const ColumnPosition &	aCP
	)		[friend]

A display function, for use with the << operator.

Parameters:

fout	The output stream to write to.
aCP	The column position to display.

---

Member Data Documentation

unsigned int ColumnPosition::x

The x-coordinate of the column, 0 ≤ x < 5.

unsigned int ColumnPosition::z

The z-coordinate of the column, 0 ≤ z < laneSize.

---

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

• Keccak-fPositions.h