VectorPosition Class Reference

#include <VectorPosition.hh>

Inheritance diagram for VectorPosition:

List of all members.

Public Member Functions
	VectorPosition (void)
	VectorPosition (int newsize)
virtual	~VectorPosition (void)
void	size (int newsize)
int	size (void)
int	pos (int position)
int	pos (int position, int length)
int	pos (int position, int start, int length)
virtual int	pos (int position, int start, int end, int &sign)=0
void	setsymm (bool symm)
bool	issymm (void)
Protected Attributes
int	m_vsize
bool	m_symmetry

---

Detailed Description

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

Definition at line 23 of file VectorPosition.hh.

---

Constructor & Destructor Documentation

VectorPosition::VectorPosition

(

void

)

Constructor. Sets standard values.

VectorPosition::VectorPosition

(

int

newsize

)

Constructor. Sets the real vector size to be used if not passed on to pos () method.

Parameters:

newsize

the size

virtual VectorPosition::~VectorPosition

(

void

)

[inline, virtual]

Destructor. Does nothing.

Definition at line 36 of file VectorPosition.hh.

---

Member Function Documentation

bool VectorPosition::issymm

(

void

)

[inline]

Return the symmetry settings.

Returns:

if symmetric sign change occurs: {true} else {false}

Definition at line 110 of file VectorPosition.hh.

References m_symmetry.

int VectorPosition::pos

(

int

position

)

[inline]

Calculate real position. If a position is greater than the size or less than zero we mirror the position back into range.

Parameters:

position

the requested position

Returns:

the new position

Definition at line 54 of file VectorPosition.hh.

References m_vsize.

Referenced by pos().

int VectorPosition::pos	(	int	position,
		int	length
	)		[inline]

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

Parameters:

position	the requested position
length	the assumed length

Returns:

the new position

Definition at line 67 of file VectorPosition.hh.

References pos().

int VectorPosition::pos	(	int	position,
		int	start,
		int	length
	)		[inline]

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:

position	the requested position
start	the assumed start
length	the assumed length

Returns:

the new position

Definition at line 82 of file VectorPosition.hh.

References pos().

virtual int VectorPosition::pos	(	int	position,
		int	start,
		int	end,
		int &	sign
	)		[pure 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:

position	the requested position
start	the assumed start
end	the assumed end point
sign	set to -1 if a sign change has taken place

Returns:

the new position

Implemented in MirrorPosition, and PeriodicPosition.

void VectorPosition::setsymm

(

bool

symm

)

[inline]

Set symmetry property. If set we get a sign change with every half period.

Parameters:

symm	if symmetric: {true}

Definition at line 105 of file VectorPosition.hh.

References m_symmetry.

void VectorPosition::size

(

int

newsize

)

[inline]

Set a new size.

Parameters:

newsize

the new size

Definition at line 41 of file VectorPosition.hh.

References m_vsize.

int VectorPosition::size

(

void

)

[inline]

Return the current size.

Returns:

the current size

Definition at line 46 of file VectorPosition.hh.

References m_vsize.

---

Member Data Documentation

bool VectorPosition::m_symmetry [protected]

The symmetric sign change setting.

Definition at line 116 of file VectorPosition.hh.

Referenced by issymm(), and setsymm().

int VectorPosition::m_vsize [protected]

The default vector size.

Definition at line 114 of file VectorPosition.hh.

Referenced by pos(), and size().

---

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

• VectorPosition.hh