PeriodicPosition Class Reference

#include <PeriodicPosition.hh>

Inheritance diagram for PeriodicPosition:

Collaboration diagram for PeriodicPosition:

List of all members.

Public Member Functions
	PeriodicPosition (void)
	PeriodicPosition (int newsize)
int	pos (int pos, int start, int end, int &sign)

---

Detailed Description

A Periodic index (abstract). Performs symmetric, periodic and whatever extensions to a vector or a part of it.

Definition at line 23 of file PeriodicPosition.hh.

---

Constructor & Destructor Documentation

PeriodicPosition::PeriodicPosition

(

void

)

[inline]

Constructor. Calls the superclass' constructor.

Definition at line 28 of file PeriodicPosition.hh.

PeriodicPosition::PeriodicPosition

(

int

newsize

)

[inline]

Constructor. Calls the superclass' constructor.

Definition at line 31 of file PeriodicPosition.hh.

---

Member Function Documentation

int PeriodicPosition::pos	(	int	pos,
		int	start,
		int	end,
		int &	sign
	)		[virtual]

Calculate real position assuming a given vector start and length. If a position is greater than the assumed size or less than the assumed start position we mirror the position back into range.

Parameters:

pos	the requested position
start	the assumed start
end	the assumed end point
sign	always 1

Returns:

the new position

Implements VectorPosition.

---

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

• PeriodicPosition.hh