edu.rice.hj.runtime.region

Class RectangularRegion3D

java.lang.Object

edu.rice.hj.runtime.region.AbstractRectangularRegion

edu.rice.hj.runtime.region.RectangularRegion3D

All Implemented Interfaces:

HjRegion, HjRegion.HjRegion3D

public final class RectangularRegion3D
extends AbstractRectangularRegion
implements HjRegion.HjRegion3D

RectangularRegion3D class.

Author:

Shams Imam (shams@rice.edu)

Nested Class Summary

Nested classes/interfaces inherited from interface edu.rice.hj.api.HjRegion

HjRegion.HjRegion1D, HjRegion.HjRegion2D, HjRegion.HjRegion3D

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxInc0
protected int	maxInc1
protected int	maxInc2
protected int	minInc0
protected int	minInc1
protected int	minInc2
protected int	range0
protected int	range1
protected int	range2

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RectangularRegion3D(int pMinInc0, int pMaxInc0, int pMinInc1, int pMaxInc1, int pMinInc2, int pMaxInc2) Constructor.

Method Summary

Modifier and Type	Method and Description
Iterator<HjPoint>	iterator() Returns an iterator over an int array whose length is specified by the rank.
Iterator<HjPoint>	iterator(int startLinearIndex, int maxNumItems) Returns an iterator over an int array whose length is specified by the rank.
int	lowerLimit(int index) Returns the lower limit of the region at the specified dimension.
int[]	lowerLimits()
int	numElements() Returns the number of elements in the iteration space defined by the region.
int	rank() Returns the rank of the region.
int	toLinearIndex(int[] regionIndices) Returns the zero-based linear index in the 1D array.
int	toLinearIndex(int regionIndex0, int regionIndex1, int regionIndex2)
int[]	toRegionIndex(int linearIndex) Return the region based index of the linear index.
Iterable<HjPoint>	toSeqIterable() The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().
String	toString()
int	upperLimit(int index) Returns the upper limits of the region at the specified dimension.
int[]	upperLimits()

Methods inherited from class edu.rice.hj.runtime.region.AbstractRectangularRegion

createIterator

Methods inherited from class java.lang.Object

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

Field Detail

minInc0

protected final int minInc0

maxInc0

protected final int maxInc0

minInc1

protected final int minInc1

maxInc1

protected final int maxInc1

minInc2

protected final int minInc2

maxInc2

protected final int maxInc2

range0

protected final int range0

range1

protected final int range1

range2

protected final int range2

Constructor Detail

RectangularRegion3D

protected RectangularRegion3D(int pMinInc0,
                              int pMaxInc0,
                              int pMinInc1,
                              int pMaxInc1,
                              int pMinInc2,
                              int pMaxInc2)

Constructor.

Parameters:

pMinInc0 - a int.

pMaxInc0 - a int.

pMinInc1 - a int.

pMaxInc1 - a int.

pMinInc2 - a int.

pMaxInc2 - a int.

Method Detail

toSeqIterable

public Iterable<HjPoint> toSeqIterable()

The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().

Specified by:

toSeqIterable in interface HjRegion

Returns:

an Iterable instance which is safe to use in sequential manner.

iterator

public Iterator<HjPoint> iterator()

Returns an iterator over an int array whose length is specified by the rank. The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().

Specified by:

iterator in interface HjRegion

Returns:

an Iterator.

iterator

public Iterator<HjPoint> iterator(int startLinearIndex,
                                  int maxNumItems)

Returns an iterator over an int array whose length is specified by the rank. The HjPoint object returned by the iterator may be reused by the iterator in subsequent calls to next().

Specified by:

iterator in interface HjRegion

Parameters:

startLinearIndex - The starting linear index of the array.

maxNumItems - The maximum number of items in the returned iterator.

Returns:

an Iterator.

rank

public int rank()

Returns the rank of the region.

Specified by:

rank in interface HjRegion

Returns:

the rank of the region.

numElements

public int numElements()

Returns the number of elements in the iteration space defined by the region.

Specified by:

numElements in interface HjRegion

Returns:

the number of elements in the iteration space defined by the region.

lowerLimit

public int lowerLimit(int index)

Returns the lower limit of the region at the specified dimension.

Specified by:

lowerLimit in interface HjRegion

Returns:

the lower limit of the region at the specified dimension.

upperLimit

public int upperLimit(int index)

Returns the upper limits of the region at the specified dimension.

Specified by:

upperLimit in interface HjRegion

Returns:

the upper limits of the region at the specified dimension.

toRegionIndex

public int[] toRegionIndex(int linearIndex)

Return the region based index of the linear index. The returned array has the same length as the rank.

Specified by:

toRegionIndex in interface HjRegion

Parameters:

linearIndex - The zero-based linear index in the 1D array

Returns:

the region based index of the linear index.

toLinearIndex

public int toLinearIndex(int[] regionIndices)

Returns the zero-based linear index in the 1D array.

Specified by:

toLinearIndex in interface HjRegion

Specified by:

toLinearIndex in interface HjRegion.HjRegion3D

Parameters:

regionIndices - The region based index.

Returns:

the zero-based linear index in the 1D array.

toLinearIndex

public int toLinearIndex(int regionIndex0,
                         int regionIndex1,
                         int regionIndex2)

Specified by:

toLinearIndex in interface HjRegion.HjRegion3D

Parameters:

regionIndex0 - The region index for the first dimension.

regionIndex1 - The region index for the second dimension.

regionIndex2 - The region index for the third dimension.

Returns:

the zero-based linear index in the 1D array.

lowerLimits

public int[] lowerLimits()

Specified by:

lowerLimits in interface HjRegion.HjRegion3D

Returns:

the lower limits of the region.

upperLimits

public int[] upperLimits()

Specified by:

upperLimits in interface HjRegion.HjRegion3D

Returns:

the upper limits of the region.

toString

public String toString()

Overrides:

toString in class Object