Package etomica.lattice

Class IndexIteratorReflecting

java.lang.Object

etomica.lattice.IndexIteratorReflecting

All Implemented Interfaces:

IndexIterator

public class IndexIteratorReflecting
extends java.lang.Object
implements IndexIterator

Generates iterates by alternately keeping or flipping the sign of each element of iterates generated by another iterator. Index of elements subject to iteration over sign can be selected via the setReflecting method. Care is taken not to generate additional elements by attempting to flip the sign of an element that is zero. For example, if core iterator is an instance of IndexIteratorTriangularPermutations with D set to 2 at construction and maxElement equal to 1, then this iterator returns the following iterates: {0,0}
{0,1}
{0,-1}
{1,0}
{-1,0}
{1,1}
{1,-1}
{-1,1}
{-1,-1}

Constructor Summary

Constructors

Constructor	Description
IndexIteratorReflecting(IndexIterator iterator)	Constructs iterator to generate reflections from iterates of given iterator.

Method Summary

Modifier and Type	Method	Description
int	getD()
boolean	hasNext()
static void	main(java.lang.String[] args)	Method to test and demonstrate class.
int[]	next()
void	reset()
void	setReflecting(boolean[] doReflect)	Indicates the indexes of the elements that are subject to reflection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexIteratorReflecting

public IndexIteratorReflecting(IndexIterator iterator)

Constructs iterator to generate reflections from iterates of given iterator. Default has all indexes subject to reflection.

Method Detail

getD

public int getD()

Specified by:

getD in interface IndexIterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface IndexIterator

reset

public void reset()

Specified by:

reset in interface IndexIterator

next

public int[] next()

Specified by:

next in interface IndexIterator

setReflecting

public void setReflecting(boolean[] doReflect)

Indicates the indexes of the elements that are subject to reflection. A value of "true" in the given array indicates that the element with the corresponding index should be reflected; a value of "false" indicates otherwise. Default is all true.

Throws:

java.lang.IllegalArgumentException - if the length of the given array is not equal to the getD();

main

public static void main(java.lang.String[] args)

Method to test and demonstrate class.