spiralindex3D< T > Class Template Reference

Spiral in 3D moving along the z-axis. More...

#include <spiralindex.h>

Collaboration diagram for spiralindex3D< T >:

List of all members.

Public Member Functions
	spiralindex3D (T const _rows, T const _columns, T const _rectanglelength, boolc anticlockwise=true)
	Define a 3D matrix.
	~spiralindex3D ()
	Memory cleanup.
void	reset ()
	Reset the iterator.
boolc	operator! () const
	Is the iterator valid?
void	pos (T &row, T &col, T &z) const
	The current position as a 3D indexed point.
void	pos (T &k2) const
	The current position as an index from the start.
void	operator++ ()
	Increment the iterator.
Public Attributes
T const	rows
	The number of rows.
T const	columns
	The number of columns.
T const	rectanglelength
	The length from the x-y plane.

---

Detailed Description

template<typename T = int>
class spiralindex3D< T >

Spiral in 3D moving along the z-axis.

This is a interator though a 3D matrix. Every elements neighbors are next to each other in the iteration.

The reverse iterator may be implemented in the future, as well as a matrix without the full indexes as the last slice is not full, similar to snakeindex.

Definition at line 93 of file spiralindex.h.

---

Constructor & Destructor Documentation

template<typename T >

spiralindex3D< T >::spiralindex3D	(	T const	_rows,
		T const	_columns,
		T const	_rectanglelength,
		boolc	anticlockwise = true
	)			[inline]

Define a 3D matrix.

Definition at line 201 of file spiralindex.h.

References spiralindex< T >::indexsequence().

  : rows(_rows), columns(_columns),
  rectanglelength(_rectanglelength)
{
  assert(rows>0);
  assert(columns>0);

  square0 = new T[rows*columns];
  square1 = square0 + rows*columns;
  spiralindex<T> spi(rows,columns,anticlockwise);
  spi.indexsequence(square0);

/*
cout << "square" << endl;
for (int i=0; i<rows*columns; ++i)
  cout << square0[i] << " ";
cout << endl << endl;
*/
}

template<typename T >

spiralindex3D< T >::~spiralindex3D

(

)

[inline]

Memory cleanup.

Definition at line 193 of file spiralindex.h.

{
  delete[] square0;
}

---

Member Function Documentation

template<typename T = int>

boolc spiralindex3D< T >::operator!

(

)

const [inline]

Is the iterator valid?

Definition at line 129 of file spiralindex.h.

References spiralindex3D< T >::rectanglelength.

    { if (zcount<rectanglelength) return true; return false; }

template<typename T >

void spiralindex3D< T >::operator++

(

)

[inline]

Increment the iterator.

Definition at line 156 of file spiralindex.h.

{
  ++icount;

  // Reverse spiral incrementation.
  if ((zcount % 2)==1)
  {
    --squarei;
    if (squarei+1==square0)
    {
      ++zcount;
      icount=0;
      ++squarei;
    }

    return;
  }

  ++squarei;
  if (squarei==square1)
  {
    ++zcount;
    icount=0;
    --squarei;
  }
}

template<typename T = int>

void spiralindex3D< T >::pos

(

T &

k2

)

const [inline]

The current position as an index from the start.

Definition at line 134 of file spiralindex.h.

References spiralindex3D< T >::columns, and spiralindex3D< T >::rows.

    { k2 = zcount*rows*columns + icount; }

template<typename T >

void spiralindex3D< T >::pos	(	T &	row,
		T &	col,
		T &	z
	)			const [inline]

The current position as a 3D indexed point.

Definition at line 147 of file spiralindex.h.

References spiralindex3D< T >::columns.

Referenced by spiralindextest::test03(), and spiralindextest::test04().

{
  T k(*squarei);
  col = k % columns;
  row = (k-col)/columns;
  z = zcount;
}

template<typename T >

void spiralindex3D< T >::reset

(

)

[inline]

Reset the iterator.

Definition at line 185 of file spiralindex.h.

Referenced by spiralindextest::test03(), and spiralindextest::test04().

{
  icount=0;
  zcount=0;
  squarei = square0;
}

---

Member Data Documentation

template<typename T = int>

T const spiralindex3D< T >::columns

The number of columns.

Definition at line 111 of file spiralindex.h.

Referenced by spiralindex3D< T >::pos().

template<typename T = int>

T const spiralindex3D< T >::rectanglelength

The length from the x-y plane.

Definition at line 113 of file spiralindex.h.

Referenced by spiralindex3D< T >::operator!().

template<typename T = int>

T const spiralindex3D< T >::rows

The number of rows.

Definition at line 109 of file spiralindex.h.

Referenced by spiralindex3D< T >::pos().

---

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

• sortsimple/spiralindex.h